Add "port connected" component class method
[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 * 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/graph/component.h>
33 #include <babeltrace/graph/private-component.h>
34 #include <babeltrace/graph/private-port.h>
35 #include <babeltrace/ctf-ir/event.h>
36
37 enum pretty_default {
38 PRETTY_DEFAULT_UNSET,
39 PRETTY_DEFAULT_SHOW,
40 PRETTY_DEFAULT_HIDE,
41 };
42
43 enum pretty_color_option {
44 PRETTY_COLOR_OPT_NEVER,
45 PRETTY_COLOR_OPT_AUTO,
46 PRETTY_COLOR_OPT_ALWAYS,
47 };
48
49 struct pretty_options {
50 char *output_path;
51 char *debug_info_dir;
52 char *debug_info_target_prefix;
53
54 enum pretty_default name_default;
55 enum pretty_default field_default;
56
57 bool print_scope_field_names;
58 bool print_header_field_names;
59 bool print_context_field_names;
60 bool print_payload_field_names;
61
62 bool print_delta_field;
63 bool print_loglevel_field;
64 bool print_emf_field;
65 bool print_callsite_field;
66 bool print_trace_field;
67 bool print_trace_domain_field;
68 bool print_trace_procname_field;
69 bool print_trace_vpid_field;
70 bool print_trace_hostname_field;
71
72 bool print_timestamp_cycles;
73 bool clock_seconds;
74 bool clock_date;
75 bool clock_gmt;
76 bool debug_info_full_path;
77 enum pretty_color_option color;
78 bool verbose;
79 };
80
81 struct pretty_component {
82 struct pretty_options options;
83 struct bt_notification_iterator *input_iterator;
84 FILE *out, *err;
85 bool processed_first_event; /* Should be per-iterator. */
86 int depth; /* nesting, used for tabulation alignment. */
87 bool start_line;
88 GString *string;
89 struct bt_value *plugin_opt_map; /* Temporary parameter map. */
90 bool use_colors;
91 bool error;
92
93 uint64_t last_cycles_timestamp;
94 uint64_t delta_cycles;
95
96 uint64_t last_real_timestamp;
97 uint64_t delta_real_timestamp;
98 };
99
100 enum stream_packet_context_quarks_enum {
101 Q_TIMESTAMP_BEGIN,
102 Q_TIMESTAMP_END,
103 Q_EVENTS_DISCARDED,
104 Q_CONTENT_SIZE,
105 Q_PACKET_SIZE,
106 Q_PACKET_SEQ_NUM,
107 STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
108 };
109
110 GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
111
112 BT_HIDDEN
113 enum bt_component_status pretty_init(
114 struct bt_private_component *component,
115 struct bt_value *params,
116 void *init_method_data);
117
118 BT_HIDDEN
119 enum bt_component_status pretty_consume(struct bt_private_component *component);
120
121 BT_HIDDEN
122 void pretty_port_connected(
123 struct bt_private_component *component,
124 struct bt_private_port *self_port,
125 struct bt_port *other_port);
126
127 BT_HIDDEN
128 void pretty_finalize(struct bt_private_component *component);
129
130 BT_HIDDEN
131 enum bt_component_status pretty_print_event(struct pretty_component *pretty,
132 struct bt_ctf_event *event);
133
134 #endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */
This page took 0.031172 seconds and 4 git commands to generate.