[babeltrace.git] / src / plugins / text / pretty / pretty.h

#ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
#define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H

/*
 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#include <glib.h>
#include <stdio.h>
#include <stdbool.h>
#include "common/macros.h"
#include <babeltrace2/babeltrace.h>

enum pretty_default {
	PRETTY_DEFAULT_UNSET,
	PRETTY_DEFAULT_SHOW,
	PRETTY_DEFAULT_HIDE,
};

enum pretty_color_option {
	PRETTY_COLOR_OPT_NEVER,
	PRETTY_COLOR_OPT_AUTO,
	PRETTY_COLOR_OPT_ALWAYS,
};

struct pretty_options {
	char *output_path;

	enum pretty_default name_default;
	enum pretty_default field_default;

	bool print_scope_field_names;
	bool print_header_field_names;
	bool print_context_field_names;
	bool print_payload_field_names;

	bool print_delta_field;
	bool print_loglevel_field;
	bool print_emf_field;
	bool print_callsite_field;
	bool print_trace_field;
	bool print_trace_domain_field;
	bool print_trace_procname_field;
	bool print_trace_vpid_field;
	bool print_trace_hostname_field;

	bool print_timestamp_cycles;
	bool clock_seconds;
	bool clock_date;
	bool clock_gmt;
	enum pretty_color_option color;
	bool verbose;
};

struct pretty_component {
	struct pretty_options options;
	bt_self_component_port_input_message_iterator *iterator;
	FILE *out, *err;
	int depth;	/* nesting, used for tabulation alignment. */
	bool start_line;
	GString *string;
	GString *tmp_string;
	bt_value *plugin_opt_map; /* Temporary parameter map. */
	bool use_colors;

	uint64_t last_cycles_timestamp;
	uint64_t delta_cycles;

	uint64_t last_real_timestamp;
	uint64_t delta_real_timestamp;

	bool negative_timestamp_warning_done;
};

BT_HIDDEN
bt_component_class_init_method_status pretty_init(
		bt_self_component_sink *component, const bt_value *params,
		void *init_method_data);

BT_HIDDEN
bt_component_class_sink_consume_method_status pretty_consume(
		bt_self_component_sink *component);

BT_HIDDEN
bt_component_class_sink_graph_is_configured_method_status pretty_graph_is_configured(
		bt_self_component_sink *component);

BT_HIDDEN
void pretty_finalize(bt_self_component_sink *component);

BT_HIDDEN
int pretty_print_event(struct pretty_component *pretty,
		const bt_message *event_msg);

BT_HIDDEN
int pretty_print_discarded_items(struct pretty_component *pretty,
		const bt_message *msg);

#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */
Commit	Line	Data
3228cc1d PP	1	#ifndef BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
3228cc1d PP	2	#define BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H
af9a82eb JG	3
af9a82eb JG	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>
91d81473 MJ	29	#include <stdio.h>
af9a82eb	30	#include <stdbool.h>
91d81473	31	#include "common/macros.h"
3fadfbc0	32	#include <babeltrace2/babeltrace.h>
3228cc1d PP	33
	34	enum pretty_default {
	35	PRETTY_DEFAULT_UNSET,
	36	PRETTY_DEFAULT_SHOW,
	37	PRETTY_DEFAULT_HIDE,
6e1bc0df MD	38	};
6e1bc0df MD	39
3228cc1d PP	40	enum pretty_color_option {
	41	PRETTY_COLOR_OPT_NEVER,
	42	PRETTY_COLOR_OPT_AUTO,
	43	PRETTY_COLOR_OPT_ALWAYS,
ad96d936 PP	44	};
ad96d936 PP	45
3228cc1d	46	struct pretty_options {
6e1bc0df	47	char *output_path;
6e1bc0df	48
3228cc1d PP	49	enum pretty_default name_default;
3228cc1d PP	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	};
af9a82eb JG	74
3228cc1d PP	75	struct pretty_component {
3228cc1d PP	76	struct pretty_options options;
d6e69534	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;
b19ff26f	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;
18adbd19 MD	91
18adbd19 MD	92	bool negative_timestamp_warning_done;
af9a82eb JG	93	};
	94
	95	BT_HIDDEN
d24d5663 PP	96	bt_component_class_init_method_status pretty_init(
d24d5663 PP	97	bt_self_component_sink component, const bt_value params,
3228cc1d PP	98	void *init_method_data);
	99
	100	BT_HIDDEN
d24d5663	101	bt_component_class_sink_consume_method_status pretty_consume(
b19ff26f	102	bt_self_component_sink *component);
3228cc1d PP	103
3228cc1d PP	104	BT_HIDDEN
d24d5663	105	bt_component_class_sink_graph_is_configured_method_status pretty_graph_is_configured(
5badd463	106	bt_self_component_sink *component);
3228cc1d PP	107
3228cc1d PP	108	BT_HIDDEN
b19ff26f	109	void pretty_finalize(bt_self_component_sink *component);
3228cc1d PP	110
3228cc1d PP	111	BT_HIDDEN
d94d92ac	112	int pretty_print_event(struct pretty_component *pretty,
d6e69534	113	const bt_message *event_msg);
af9a82eb	114
0f6bea4e	115	BT_HIDDEN
8e53bed4 PP	116	int pretty_print_discarded_items(struct pretty_component *pretty,
8e53bed4 PP	117	const bt_message *msg);
0f6bea4e	118
3228cc1d	119	#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */