Rename `init` methods to `initialize`
[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
85e7137b
MJ
28#include <glib.h>
29#include <stdio.h>
af9a82eb 30#include <stdbool.h>
85e7137b 31#include "common/macros.h"
71c5da58 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;
b09a5592 77 bt_self_component_port_input_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;
8eee8ea2 83 bt_value *plugin_opt_map; /* Temporary parameter map. */
ad96d936 84 bool use_colors;
3af83b5a
MD
85
86 uint64_t last_cycles_timestamp;
87 uint64_t delta_cycles;
88
89 uint64_t last_real_timestamp;
90 uint64_t delta_real_timestamp;
f1c99b12
MD
91
92 bool negative_timestamp_warning_done;
af9a82eb
JG
93};
94
95BT_HIDDEN
4175c1d5 96bt_component_class_initialize_method_status pretty_init(
e3250e61
SM
97 bt_self_component_sink *component,
98 bt_self_component_sink_configuration *config,
99 const bt_value *params,
3228cc1d
PP
100 void *init_method_data);
101
102BT_HIDDEN
fb25b9e3 103bt_component_class_sink_consume_method_status pretty_consume(
8eee8ea2 104 bt_self_component_sink *component);
3228cc1d
PP
105
106BT_HIDDEN
fb25b9e3 107bt_component_class_sink_graph_is_configured_method_status pretty_graph_is_configured(
1043fdea 108 bt_self_component_sink *component);
3228cc1d
PP
109
110BT_HIDDEN
8eee8ea2 111void pretty_finalize(bt_self_component_sink *component);
3228cc1d
PP
112
113BT_HIDDEN
834e9996 114int pretty_print_event(struct pretty_component *pretty,
b09a5592 115 const bt_message *event_msg);
af9a82eb 116
1e3d9900 117BT_HIDDEN
22dfa677
PP
118int pretty_print_discarded_items(struct pretty_component *pretty,
119 const bt_message *msg);
1e3d9900 120
3228cc1d 121#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */
This page took 0.053776 seconds and 4 git commands to generate.