tap-driver.sh: flush stdout after each test result
[babeltrace.git] / plugins / text / pretty / pretty.h
1 #ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
2 #define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
3
4 /*
5 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
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:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
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
25 * SOFTWARE.
26 */
27
28 #include <stdbool.h>
29 #include <babeltrace2/babeltrace-internal.h>
30 #include <babeltrace2/babeltrace.h>
31
32 enum pretty_default {
33 PRETTY_DEFAULT_UNSET,
34 PRETTY_DEFAULT_SHOW,
35 PRETTY_DEFAULT_HIDE,
36 };
37
38 enum pretty_color_option {
39 PRETTY_COLOR_OPT_NEVER,
40 PRETTY_COLOR_OPT_AUTO,
41 PRETTY_COLOR_OPT_ALWAYS,
42 };
43
44 struct pretty_options {
45 char *output_path;
46
47 enum pretty_default name_default;
48 enum pretty_default field_default;
49
50 bool print_scope_field_names;
51 bool print_header_field_names;
52 bool print_context_field_names;
53 bool print_payload_field_names;
54
55 bool print_delta_field;
56 bool print_loglevel_field;
57 bool print_emf_field;
58 bool print_callsite_field;
59 bool print_trace_field;
60 bool print_trace_domain_field;
61 bool print_trace_procname_field;
62 bool print_trace_vpid_field;
63 bool print_trace_hostname_field;
64
65 bool print_timestamp_cycles;
66 bool clock_seconds;
67 bool clock_date;
68 bool clock_gmt;
69 enum pretty_color_option color;
70 bool verbose;
71 };
72
73 struct pretty_component {
74 struct pretty_options options;
75 bt_self_component_port_input_message_iterator *iterator;
76 FILE *out, *err;
77 int depth; /* nesting, used for tabulation alignment. */
78 bool start_line;
79 GString *string;
80 GString *tmp_string;
81 bt_value *plugin_opt_map; /* Temporary parameter map. */
82 bool use_colors;
83
84 uint64_t last_cycles_timestamp;
85 uint64_t delta_cycles;
86
87 uint64_t last_real_timestamp;
88 uint64_t delta_real_timestamp;
89
90 bool negative_timestamp_warning_done;
91 };
92
93 enum stream_packet_context_quarks_enum {
94 Q_TIMESTAMP_BEGIN,
95 Q_TIMESTAMP_END,
96 Q_EVENTS_DISCARDED,
97 Q_CONTENT_SIZE,
98 Q_PACKET_SIZE,
99 Q_PACKET_SEQ_NUM,
100 STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
101 };
102
103 extern
104 GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
105
106 BT_HIDDEN
107 bt_self_component_status pretty_init(
108 bt_self_component_sink *component,
109 const bt_value *params,
110 void *init_method_data);
111
112 BT_HIDDEN
113 bt_self_component_status pretty_consume(
114 bt_self_component_sink *component);
115
116 BT_HIDDEN
117 bt_self_component_status pretty_graph_is_configured(
118 bt_self_component_sink *component);
119
120 BT_HIDDEN
121 void pretty_finalize(bt_self_component_sink *component);
122
123 BT_HIDDEN
124 int pretty_print_event(struct pretty_component *pretty,
125 const bt_message *event_msg);
126
127 BT_HIDDEN
128 int pretty_print_discarded_items(struct pretty_component *pretty,
129 const bt_message *msg);
130
131 #endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */
This page took 0.031826 seconds and 4 git commands to generate.