[babeltrace.git] / 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 <stdbool.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/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;
};

enum stream_packet_context_quarks_enum {
	Q_TIMESTAMP_BEGIN,
	Q_TIMESTAMP_END,
	Q_EVENTS_DISCARDED,
	Q_CONTENT_SIZE,
	Q_PACKET_SIZE,
	Q_PACKET_SEQ_NUM,
	STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
};

extern
GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];

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

BT_HIDDEN
bt_self_component_status pretty_consume(
		bt_self_component_sink *component);

BT_HIDDEN
bt_self_component_status pretty_port_connected(
		bt_self_component_sink *component,
		bt_self_component_port_input *self_port,
		const bt_port_output *other_port);

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
	28	#include <stdbool.h>
	29	#include <babeltrace/babeltrace-internal.h>
9d408fca	30	#include <babeltrace/babeltrace.h>
3228cc1d PP	31
	32	enum pretty_default {
	33	PRETTY_DEFAULT_UNSET,
	34	PRETTY_DEFAULT_SHOW,
	35	PRETTY_DEFAULT_HIDE,
6e1bc0df MD	36	};
6e1bc0df MD	37
3228cc1d PP	38	enum pretty_color_option {
	39	PRETTY_COLOR_OPT_NEVER,
	40	PRETTY_COLOR_OPT_AUTO,
	41	PRETTY_COLOR_OPT_ALWAYS,
ad96d936 PP	42	};
ad96d936 PP	43
3228cc1d	44	struct pretty_options {
6e1bc0df	45	char *output_path;
6e1bc0df	46
3228cc1d PP	47	enum pretty_default name_default;
3228cc1d PP	48	enum pretty_default field_default;
6e1bc0df MD	49
	50	bool print_scope_field_names;
	51	bool print_header_field_names;
	52	bool print_context_field_names;
	53	bool print_payload_field_names;
	54
	55	bool print_delta_field;
	56	bool print_loglevel_field;
	57	bool print_emf_field;
60535549	58	bool print_callsite_field;
6e1bc0df MD	59	bool print_trace_field;
	60	bool print_trace_domain_field;
	61	bool print_trace_procname_field;
	62	bool print_trace_vpid_field;
	63	bool print_trace_hostname_field;
	64
	65	bool print_timestamp_cycles;
	66	bool clock_seconds;
	67	bool clock_date;
	68	bool clock_gmt;
3228cc1d	69	enum pretty_color_option color;
a263021c	70	bool verbose;
af9a82eb JG	71	};
af9a82eb JG	72
3228cc1d PP	73	struct pretty_component {
3228cc1d PP	74	struct pretty_options options;
d6e69534	75	bt_self_component_port_input_message_iterator *iterator;
af9a82eb	76	FILE out, err;
6a18b281	77	int depth; /* nesting, used for tabulation alignment. */
6e1bc0df	78	bool start_line;
6a18b281	79	GString *string;
5280f742	80	GString *tmp_string;
b19ff26f	81	bt_value plugin_opt_map; / Temporary parameter map. */
ad96d936	82	bool use_colors;
3af83b5a MD	83
	84	uint64_t last_cycles_timestamp;
	85	uint64_t delta_cycles;
	86
	87	uint64_t last_real_timestamp;
	88	uint64_t delta_real_timestamp;
18adbd19 MD	89
18adbd19 MD	90	bool negative_timestamp_warning_done;
af9a82eb JG	91	};
af9a82eb JG	92
2b4c4a7c JD	93	enum stream_packet_context_quarks_enum {
	94	Q_TIMESTAMP_BEGIN,
	95	Q_TIMESTAMP_END,
	96	Q_EVENTS_DISCARDED,
	97	Q_CONTENT_SIZE,
	98	Q_PACKET_SIZE,
	99	Q_PACKET_SEQ_NUM,
	100	STREAM_PACKET_CONTEXT_QUARKS_LEN, /* Always the last one of this enum. */
	101	};
	102
61d6f9b1	103	extern
2b4c4a7c JD	104	GQuark stream_packet_context_quarks[STREAM_PACKET_CONTEXT_QUARKS_LEN];
2b4c4a7c JD	105
af9a82eb	106	BT_HIDDEN
4cdfc5e8	107	bt_self_component_status pretty_init(
b19ff26f PP	108	bt_self_component_sink *component,
b19ff26f PP	109	const bt_value *params,
3228cc1d PP	110	void *init_method_data);
	111
	112	BT_HIDDEN
4cdfc5e8	113	bt_self_component_status pretty_consume(
b19ff26f	114	bt_self_component_sink *component);
3228cc1d PP	115
3228cc1d PP	116	BT_HIDDEN
4cdfc5e8	117	bt_self_component_status pretty_port_connected(
b19ff26f PP	118	bt_self_component_sink *component,
	119	bt_self_component_port_input *self_port,
	120	const bt_port_output *other_port);
3228cc1d PP	121
3228cc1d PP	122	BT_HIDDEN
b19ff26f	123	void pretty_finalize(bt_self_component_sink *component);
3228cc1d PP	124
3228cc1d PP	125	BT_HIDDEN
d94d92ac	126	int pretty_print_event(struct pretty_component *pretty,
d6e69534	127	const bt_message *event_msg);
af9a82eb	128
0f6bea4e	129	BT_HIDDEN
8e53bed4 PP	130	int pretty_print_discarded_items(struct pretty_component *pretty,
8e53bed4 PP	131	const bt_message *msg);
0f6bea4e	132
3228cc1d	133	#endif /* BABELTRACE_PLUGIN_TEXT_PRETTY_PRETTY_H */