lib: rename "self comp. input port message iter." -> "message iterator"
[babeltrace.git] / src / plugins / text / pretty / pretty.h
CommitLineData
3228cc1d
PP
1#ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
2#define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
af9a82eb
JG
3
4/*
af9a82eb
JG
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
91d81473
MJ
28#include <glib.h>
29#include <stdio.h>
af9a82eb 30#include <stdbool.h>
91d81473 31#include "common/macros.h"
3fadfbc0 32#include <babeltrace2/babeltrace.h>
3228cc1d
PP
33
34enum pretty_default {
35 PRETTY_DEFAULT_UNSET,
36 PRETTY_DEFAULT_SHOW,
37 PRETTY_DEFAULT_HIDE,
6e1bc0df
MD
38};
39
3228cc1d
PP
40enum pretty_color_option {
41 PRETTY_COLOR_OPT_NEVER,
42 PRETTY_COLOR_OPT_AUTO,
43 PRETTY_COLOR_OPT_ALWAYS,
ad96d936
PP
44};
45
3228cc1d 46struct pretty_options {
6e1bc0df 47 char *output_path;
6e1bc0df 48
3228cc1d
PP
49 enum pretty_default name_default;
50 enum pretty_default field_default;
6e1bc0df
MD
51
52 bool print_scope_field_names;
53 bool print_header_field_names;
54 bool print_context_field_names;
55 bool print_payload_field_names;
56
57 bool print_delta_field;
58 bool print_loglevel_field;
59 bool print_emf_field;
60535549 60 bool print_callsite_field;
6e1bc0df
MD
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;
66
67 bool print_timestamp_cycles;
68 bool clock_seconds;
69 bool clock_date;
70 bool clock_gmt;
3228cc1d 71 enum pretty_color_option color;
a263021c 72 bool verbose;
af9a82eb
JG
73};
74
3228cc1d
PP
75struct pretty_component {
76 struct pretty_options options;
9a2c8b8e 77 bt_message_iterator *iterator;
af9a82eb 78 FILE *out, *err;
6a18b281 79 int depth; /* nesting, used for tabulation alignment. */
6e1bc0df 80 bool start_line;
6a18b281 81 GString *string;
5280f742 82 GString *tmp_string;
ad96d936 83 bool use_colors;
3af83b5a
MD
84
85 uint64_t last_cycles_timestamp;
86 uint64_t delta_cycles;
87
88 uint64_t last_real_timestamp;
89 uint64_t delta_real_timestamp;
18adbd19
MD
90
91 bool negative_timestamp_warning_done;
af9a82eb
JG
92};
93
94BT_HIDDEN
21a9f056 95bt_component_class_initialize_method_status pretty_init(
59225a3e
SM
96 bt_self_component_sink *component,
97 bt_self_component_sink_configuration *config,
98 const bt_value *params,
3228cc1d
PP
99 void *init_method_data);
100
101BT_HIDDEN
d24d5663 102bt_component_class_sink_consume_method_status pretty_consume(
b19ff26f 103 bt_self_component_sink *component);
3228cc1d
PP
104
105BT_HIDDEN
d24d5663 106bt_component_class_sink_graph_is_configured_method_status pretty_graph_is_configured(
5badd463 107 bt_self_component_sink *component);
3228cc1d
PP
108
109BT_HIDDEN
b19ff26f 110void pretty_finalize(bt_self_component_sink *component);
3228cc1d
PP
111
112BT_HIDDEN
d94d92ac 113int pretty_print_event(struct pretty_component *pretty,
d6e69534 114 const bt_message *event_msg);
af9a82eb 115
0f6bea4e 116BT_HIDDEN
8e53bed4
PP
117int pretty_print_discarded_items(struct pretty_component *pretty,
118 const bt_message *msg);
0f6bea4e 119
04609487
PP
120BT_HIDDEN
121void pretty_print_init(void);
122
3228cc1d 123#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */
This page took 0.068997 seconds and 4 git commands to generate.