src/plugins/text/details/write.h

   1 #ifndef BABELTRACE_PLUGINS_TEXT_DETAILS_WRITE_H
   2 #define BABELTRACE_PLUGINS_TEXT_DETAILS_WRITE_H
   3
   4 /*
   5  * Copyright 2019 Philippe Proulx <pproulx@efficios.com>
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #include <glib.h>
  27 #include <babeltrace2/babeltrace.h>
  28 #include <stdbool.h>
  29
  30 #include "details.h"
  31
  32 /* Writing context */
  33 struct details_write_ctx {
  34         /* Weak */
  35         struct details_comp *details_comp;
  36
  37         /* Weak (belongs to `details_comp` above) */
  38         GString *str;
  39
  40         /* Current indentation level (number of actual spaces) */
  41         unsigned int indent_level;
  42 };
  43
  44 /*
  45  * Writes the message `msg` to the component's output buffer
  46  * (`details_comp->str`).
  47  */
  48 BT_HIDDEN
  49 int details_write_message(struct details_comp *details_comp,
  50                 const bt_message *msg);
  51
  52 #endif /* BABELTRACE_PLUGINS_TEXT_DETAILS_WRITE_H */