1 #ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
2 #define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #include "common/macros.h"
32 #include <babeltrace2/babeltrace.h>
40 enum pretty_color_option
{
41 PRETTY_COLOR_OPT_NEVER
,
42 PRETTY_COLOR_OPT_AUTO
,
43 PRETTY_COLOR_OPT_ALWAYS
,
46 struct pretty_options
{
49 enum pretty_default name_default
;
50 enum pretty_default field_default
;
52 bool print_scope_field_names
;
53 bool print_header_field_names
;
54 bool print_context_field_names
;
55 bool print_payload_field_names
;
57 bool print_delta_field
;
58 bool print_loglevel_field
;
60 bool print_callsite_field
;
61 bool print_trace_field
;
62 bool print_trace_domain_field
;
63 bool print_trace_procname_field
;
64 bool print_trace_vpid_field
;
65 bool print_trace_hostname_field
;
67 bool print_timestamp_cycles
;
71 enum pretty_color_option color
;
75 struct pretty_component
{
76 struct pretty_options options
;
77 bt_self_component_port_input_message_iterator
*iterator
;
79 int depth
; /* nesting, used for tabulation alignment. */
83 bt_value
*plugin_opt_map
; /* Temporary parameter map. */
86 uint64_t last_cycles_timestamp
;
87 uint64_t delta_cycles
;
89 uint64_t last_real_timestamp
;
90 uint64_t delta_real_timestamp
;
92 bool negative_timestamp_warning_done
;
96 bt_component_class_initialize_method_status
pretty_init(
97 bt_self_component_sink
*component
,
98 bt_self_component_sink_configuration
*config
,
99 const bt_value
*params
,
100 void *init_method_data
);
103 bt_component_class_sink_consume_method_status
pretty_consume(
104 bt_self_component_sink
*component
);
107 bt_component_class_sink_graph_is_configured_method_status
pretty_graph_is_configured(
108 bt_self_component_sink
*component
);
111 void pretty_finalize(bt_self_component_sink
*component
);
114 int pretty_print_event(struct pretty_component
*pretty
,
115 const bt_message
*event_msg
);
118 int pretty_print_discarded_items(struct pretty_component
*pretty
,
119 const bt_message
*msg
);
121 #endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */