text output: wire up clock options, error checking
[babeltrace.git] / plugins / text / text.h
CommitLineData
af9a82eb
JG
1#ifndef BABELTRACE_PLUGIN_TEXT_H
2#define BABELTRACE_PLUGIN_TEXT_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/plugin/component.h>
33
6e1bc0df
MD
34enum text_default {
35 TEXT_DEFAULT_UNSET,
36 TEXT_DEFAULT_SHOW,
37 TEXT_DEFAULT_HIDE,
38};
39
af9a82eb 40struct text_options {
6e1bc0df
MD
41 char *output_path;
42 char *debug_info_dir;
43 char *debug_info_target_prefix;
44
45 enum text_default name_default;
46 enum text_default field_default;
47
48 bool print_scope_field_names;
49 bool print_header_field_names;
50 bool print_context_field_names;
51 bool print_payload_field_names;
52
53 bool print_delta_field;
54 bool print_loglevel_field;
55 bool print_emf_field;
6e1bc0df
MD
56 bool print_trace_field;
57 bool print_trace_domain_field;
58 bool print_trace_procname_field;
59 bool print_trace_vpid_field;
60 bool print_trace_hostname_field;
61
62 bool print_timestamp_cycles;
63 bool clock_seconds;
64 bool clock_date;
65 bool clock_gmt;
66 bool debug_info_full_path;
af9a82eb
JG
67};
68
69struct text_component {
70 struct text_options options;
71 FILE *out, *err;
72 bool processed_first_event;
73 uint64_t last_real_timestamp;
6a18b281 74 int depth; /* nesting, used for tabulation alignment. */
6e1bc0df 75 bool start_line;
6a18b281 76 GString *string;
6e1bc0df 77 struct bt_value *plugin_opt_map; /* Temporary parameter map. */
af9a82eb
JG
78};
79
80BT_HIDDEN
81enum bt_component_status text_print_event(struct text_component *text,
82 struct bt_ctf_event *event);
83
84#endif /* BABELTRACE_PLUGIN_TEXT_H */
This page took 0.025694 seconds and 4 git commands to generate.