[babeltrace.git] / include / babeltrace2 / graph / component-class-internal.h

#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
#define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 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 <babeltrace2/graph/component-const.h>
#include <babeltrace2/graph/component-class.h>
#include <babeltrace2/graph/component-class-source.h>
#include <babeltrace2/graph/component-class-filter.h>
#include <babeltrace2/graph/component-class-sink.h>
#include <babeltrace2/babeltrace-internal.h>
#include <babeltrace2/object-internal.h>
#include <babeltrace2/list-internal.h>
#include <babeltrace2/types.h>
#include <glib.h>

struct bt_component_class;
struct bt_plugin_so_shared_lib_handle;

typedef void (*bt_component_class_destroy_listener_func)(
		struct bt_component_class *class, void *data);

struct bt_component_class_destroy_listener {
	bt_component_class_destroy_listener_func func;
	void *data;
};

struct bt_component_class {
	struct bt_object base;
	enum bt_component_class_type type;
	GString *name;
	GString *description;
	GString *help;

	/* Array of struct bt_component_class_destroy_listener */
	GArray *destroy_listeners;
	bool frozen;
	struct bt_list_head node;
	struct bt_plugin_so_shared_lib_handle *so_handle;
};

struct bt_component_class_source {
	struct bt_component_class parent;
	struct {
		bt_component_class_source_init_method init;
		bt_component_class_source_finalize_method finalize;
		bt_component_class_source_message_iterator_init_method msg_iter_init;
		bt_component_class_source_message_iterator_finalize_method msg_iter_finalize;
		bt_component_class_source_message_iterator_next_method msg_iter_next;
		bt_component_class_source_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin;
		bt_component_class_source_message_iterator_seek_beginning_method msg_iter_seek_beginning;
		bt_component_class_source_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin;
		bt_component_class_source_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning;
		bt_component_class_source_query_method query;
		bt_component_class_source_accept_output_port_connection_method accept_output_port_connection;
		bt_component_class_source_output_port_connected_method output_port_connected;
	} methods;
};

struct bt_component_class_sink {
	struct bt_component_class parent;
	struct {
		bt_component_class_sink_init_method init;
		bt_component_class_sink_finalize_method finalize;
		bt_component_class_sink_query_method query;
		bt_component_class_sink_accept_input_port_connection_method accept_input_port_connection;
		bt_component_class_sink_input_port_connected_method input_port_connected;
		bt_component_class_sink_graph_is_configured_method graph_is_configured;
		bt_component_class_sink_consume_method consume;
	} methods;
};

struct bt_component_class_filter {
	struct bt_component_class parent;
	struct {
		bt_component_class_filter_init_method init;
		bt_component_class_filter_finalize_method finalize;
		bt_component_class_filter_message_iterator_init_method msg_iter_init;
		bt_component_class_filter_message_iterator_finalize_method msg_iter_finalize;
		bt_component_class_filter_message_iterator_next_method msg_iter_next;
		bt_component_class_filter_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin;
		bt_component_class_filter_message_iterator_seek_beginning_method msg_iter_seek_beginning;
		bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin;
		bt_component_class_filter_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning;
		bt_component_class_filter_query_method query;
		bt_component_class_filter_accept_input_port_connection_method accept_input_port_connection;
		bt_component_class_filter_accept_output_port_connection_method accept_output_port_connection;
		bt_component_class_filter_input_port_connected_method input_port_connected;
		bt_component_class_filter_output_port_connected_method output_port_connected;
	} methods;
};

BT_HIDDEN
void bt_component_class_add_destroy_listener(struct bt_component_class *class,
		bt_component_class_destroy_listener_func func, void *data);

BT_HIDDEN
void _bt_component_class_freeze(
		const struct bt_component_class *component_class);

#ifdef BT_DEV_MODE
# define bt_component_class_freeze	_bt_component_class_freeze
#else
# define bt_component_class_freeze(_cc)
#endif

static inline
const char *bt_component_class_type_string(enum bt_component_class_type type)
{
	switch (type) {
	case BT_COMPONENT_CLASS_TYPE_SOURCE:
		return "BT_COMPONENT_CLASS_TYPE_SOURCE";
	case BT_COMPONENT_CLASS_TYPE_SINK:
		return "BT_COMPONENT_CLASS_TYPE_SINK";
	case BT_COMPONENT_CLASS_TYPE_FILTER:
		return "BT_COMPONENT_CLASS_TYPE_FILTER";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */
Commit	Line	Data
6ac74c0c PP	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
6ac74c0c PP	2	#define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
fb2dcc52 JG	3
fb2dcc52 JG	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
fb2dcc52 JG	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	7	*
	8	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	9	*
	10	* Permission is hereby granted, free of charge, to any person obtaining a copy
	11	* of this software and associated documentation files (the "Software"), to deal
	12	* in the Software without restriction, including without limitation the rights
	13	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	14	* copies of the Software, and to permit persons to whom the Software is
	15	* furnished to do so, subject to the following conditions:
	16	*
	17	* The above copyright notice and this permission notice shall be included in
	18	* all copies or substantial portions of the Software.
	19	*
	20	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	21	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	22	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	23	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	24	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	25	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	26	* SOFTWARE.
	27	*/
	28
3fadfbc0 MJ	29	#include <babeltrace2/graph/component-const.h>
	30	#include <babeltrace2/graph/component-class.h>
	31	#include <babeltrace2/graph/component-class-source.h>
	32	#include <babeltrace2/graph/component-class-filter.h>
	33	#include <babeltrace2/graph/component-class-sink.h>
	34	#include <babeltrace2/babeltrace-internal.h>
	35	#include <babeltrace2/object-internal.h>
	36	#include <babeltrace2/list-internal.h>
	37	#include <babeltrace2/types.h>
33b34c43 PP	38	#include <glib.h>
	39
	40	struct bt_component_class;
bfa9a4be	41	struct bt_plugin_so_shared_lib_handle;
33b34c43 PP	42
	43	typedef void (*bt_component_class_destroy_listener_func)(
	44	struct bt_component_class class, void data);
	45
d3e4dcd8	46	struct bt_component_class_destroy_listener {
33b34c43 PP	47	bt_component_class_destroy_listener_func func;
	48	void *data;
	49	};
fb2dcc52 JG	50
fb2dcc52 JG	51	struct bt_component_class {
b8a06801	52	struct bt_object base;
d3e4dcd8	53	enum bt_component_class_type type;
fb2dcc52	54	GString *name;
7c7c0433	55	GString *description;
5536d9a6	56	GString *help;
d94d92ac	57
d3e4dcd8	58	/* Array of struct bt_component_class_destroy_listener */
33b34c43	59	GArray *destroy_listeners;
d94d92ac	60	bool frozen;
bfa9a4be MD	61	struct bt_list_head node;
bfa9a4be MD	62	struct bt_plugin_so_shared_lib_handle *so_handle;
33b34c43	63	};
92893b7b	64
d3e4dcd8 PP	65	struct bt_component_class_source {
	66	struct bt_component_class parent;
	67	struct {
0d72b8c3 PP	68	bt_component_class_source_init_method init;
0d72b8c3 PP	69	bt_component_class_source_finalize_method finalize;
d6e69534 PP	70	bt_component_class_source_message_iterator_init_method msg_iter_init;
	71	bt_component_class_source_message_iterator_finalize_method msg_iter_finalize;
	72	bt_component_class_source_message_iterator_next_method msg_iter_next;
7474e7d3 PP	73	bt_component_class_source_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin;
	74	bt_component_class_source_message_iterator_seek_beginning_method msg_iter_seek_beginning;
	75	bt_component_class_source_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin;
	76	bt_component_class_source_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning;
0d72b8c3 PP	77	bt_component_class_source_query_method query;
	78	bt_component_class_source_accept_output_port_connection_method accept_output_port_connection;
	79	bt_component_class_source_output_port_connected_method output_port_connected;
d3e4dcd8 PP	80	} methods;
	81	};
	82
	83	struct bt_component_class_sink {
	84	struct bt_component_class parent;
	85	struct {
0d72b8c3 PP	86	bt_component_class_sink_init_method init;
	87	bt_component_class_sink_finalize_method finalize;
	88	bt_component_class_sink_query_method query;
	89	bt_component_class_sink_accept_input_port_connection_method accept_input_port_connection;
	90	bt_component_class_sink_input_port_connected_method input_port_connected;
5badd463	91	bt_component_class_sink_graph_is_configured_method graph_is_configured;
0d72b8c3	92	bt_component_class_sink_consume_method consume;
d3e4dcd8 PP	93	} methods;
	94	};
	95
	96	struct bt_component_class_filter {
	97	struct bt_component_class parent;
	98	struct {
0d72b8c3 PP	99	bt_component_class_filter_init_method init;
0d72b8c3 PP	100	bt_component_class_filter_finalize_method finalize;
d6e69534 PP	101	bt_component_class_filter_message_iterator_init_method msg_iter_init;
	102	bt_component_class_filter_message_iterator_finalize_method msg_iter_finalize;
	103	bt_component_class_filter_message_iterator_next_method msg_iter_next;
7474e7d3 PP	104	bt_component_class_filter_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin;
	105	bt_component_class_filter_message_iterator_seek_beginning_method msg_iter_seek_beginning;
	106	bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin;
	107	bt_component_class_filter_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning;
0d72b8c3 PP	108	bt_component_class_filter_query_method query;
	109	bt_component_class_filter_accept_input_port_connection_method accept_input_port_connection;
	110	bt_component_class_filter_accept_output_port_connection_method accept_output_port_connection;
	111	bt_component_class_filter_input_port_connected_method input_port_connected;
	112	bt_component_class_filter_output_port_connected_method output_port_connected;
d3e4dcd8 PP	113	} methods;
	114	};
	115
92893b7b	116	BT_HIDDEN
3230ee6b	117	void bt_component_class_add_destroy_listener(struct bt_component_class *class,
33b34c43	118	bt_component_class_destroy_listener_func func, void *data);
fb2dcc52	119
d94d92ac	120	BT_HIDDEN
0d72b8c3 PP	121	void _bt_component_class_freeze(
0d72b8c3 PP	122	const struct bt_component_class *component_class);
d94d92ac PP	123
	124	#ifdef BT_DEV_MODE
	125	# define bt_component_class_freeze _bt_component_class_freeze
	126	#else
	127	# define bt_component_class_freeze(_cc)
	128	#endif
	129
ab0d387b PP	130	static inline
	131	const char *bt_component_class_type_string(enum bt_component_class_type type)
	132	{
	133	switch (type) {
ab0d387b PP	134	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	135	return "BT_COMPONENT_CLASS_TYPE_SOURCE";
	136	case BT_COMPONENT_CLASS_TYPE_SINK:
	137	return "BT_COMPONENT_CLASS_TYPE_SINK";
	138	case BT_COMPONENT_CLASS_TYPE_FILTER:
	139	return "BT_COMPONENT_CLASS_TYPE_FILTER";
	140	default:
	141	return "(unknown)";
	142	}
	143	}
	144
6ac74c0c	145	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */