plugins/text/text.h

   1 #ifndef BABELTRACE_PLUGIN_TEXT_H
   2 #define BABELTRACE_PLUGIN_TEXT_H
   3
   4 /*
   5  * BabelTrace - CTF Text Output Plug-in
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  10  *
  11  * Permission is hereby granted, free of charge, to any person obtaining a copy
  12  * of this software and associated documentation files (the "Software"), to deal
  13  * in the Software without restriction, including without limitation the rights
  14  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  15  * copies of the Software, and to permit persons to whom the Software is
  16  * furnished to do so, subject to the following conditions:
  17  *
  18  * The above copyright notice and this permission notice shall be included in
  19  * all copies or substantial portions of the Software.
  20  *
  21  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  22  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  23  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  24  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  25  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  26  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  27  * SOFTWARE.
  28  */
  29
  30 #include <stdbool.h>
  31 #include <babeltrace/babeltrace-internal.h>
  32 #include <babeltrace/plugin/component.h>
  33
  34 enum loglevel {
  35         LOGLEVEL_EMERG                  = 0,
  36         LOGLEVEL_ALERT                  = 1,
  37         LOGLEVEL_CRIT                   = 2,
  38         LOGLEVEL_ERR                    = 3,
  39         LOGLEVEL_WARNING                = 4,
  40         LOGLEVEL_NOTICE                 = 5,
  41         LOGLEVEL_INFO                   = 6,
  42         LOGLEVEL_DEBUG_SYSTEM           = 7,
  43         LOGLEVEL_DEBUG_PROGRAM          = 8,
  44         LOGLEVEL_DEBUG_PROCESS          = 9,
  45         LOGLEVEL_DEBUG_MODULE           = 10,
  46         LOGLEVEL_DEBUG_UNIT             = 11,
  47         LOGLEVEL_DEBUG_FUNCTION         = 12,
  48         LOGLEVEL_DEBUG_LINE             = 13,
  49         LOGLEVEL_DEBUG                  = 14,
  50 };
  51
  52 enum text_default {
  53         TEXT_DEFAULT_UNSET,
  54         TEXT_DEFAULT_SHOW,
  55         TEXT_DEFAULT_HIDE,
  56 };
  57
  58 struct text_options {
  59         char *output_path;
  60         char *debug_info_dir;
  61         char *debug_info_target_prefix;
  62
  63         enum text_default name_default;
  64         enum text_default field_default;
  65
  66         bool print_scope_field_names;
  67         bool print_header_field_names;
  68         bool print_context_field_names;
  69         bool print_payload_field_names;
  70
  71         bool print_delta_field;
  72         bool print_loglevel_field;
  73         bool print_emf_field;
  74         bool print_callsite_field;
  75         bool print_trace_field;
  76         bool print_trace_domain_field;
  77         bool print_trace_procname_field;
  78         bool print_trace_vpid_field;
  79         bool print_trace_hostname_field;
  80
  81         bool print_timestamp_cycles;
  82         bool clock_seconds;
  83         bool clock_date;
  84         bool clock_gmt;
  85         bool debug_info_full_path;
  86 };
  87
  88 struct text_component {
  89         struct text_options options;
  90         FILE *out, *err;
  91         bool processed_first_event;
  92         uint64_t last_real_timestamp;
  93         int depth;      /* nesting, used for tabulation alignment. */
  94         bool start_line;
  95         GString *string;
  96         struct bt_value *plugin_opt_map;        /* Temporary parameter map. */
  97 };
  98
  99 BT_HIDDEN
 100 enum bt_component_status text_print_event(struct text_component *text,
 101                 struct bt_ctf_event *event);
 102
 103 #endif /* BABELTRACE_PLUGIN_TEXT_H */