[babeltrace.git] / src / lib / graph / component-class.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 "common/macros.h"
#include "lib/object.h"
#include "common/list.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;
	GString *plugin_name;

	/* 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_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_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_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 "SOURCE";
	case BT_COMPONENT_CLASS_TYPE_SINK:
		return "SINK";
	case BT_COMPONENT_CLASS_TYPE_FILTER:
		return "FILTER";
	default:
		return "(unknown)";
	}
}

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
	2	#define BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	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
	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 "common/macros.h"
	35	#include "lib/object.h"
	36	#include "common/list.h"
	37	#include <babeltrace2/types.h>
	38	#include <glib.h>
	39
	40	struct bt_component_class;
	41	struct bt_plugin_so_shared_lib_handle;
	42
	43	typedef void (*bt_component_class_destroy_listener_func)(
	44	struct bt_component_class class, void data);
	45
	46	struct bt_component_class_destroy_listener {
	47	bt_component_class_destroy_listener_func func;
	48	void *data;
	49	};
	50
	51	struct bt_component_class {
	52	struct bt_object base;
	53	enum bt_component_class_type type;
	54	GString *name;
	55	GString *description;
	56	GString *help;
	57	GString *plugin_name;
	58
	59	/* Array of struct bt_component_class_destroy_listener */
	60	GArray *destroy_listeners;
	61	bool frozen;
	62	struct bt_list_head node;
	63	struct bt_plugin_so_shared_lib_handle *so_handle;
	64	};
	65
	66	struct bt_component_class_source {
	67	struct bt_component_class parent;
	68	struct {
	69	bt_component_class_source_init_method init;
	70	bt_component_class_source_finalize_method finalize;
	71	bt_component_class_source_message_iterator_init_method msg_iter_init;
	72	bt_component_class_source_message_iterator_finalize_method msg_iter_finalize;
	73	bt_component_class_source_message_iterator_next_method msg_iter_next;
	74	bt_component_class_source_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin;
	75	bt_component_class_source_message_iterator_seek_beginning_method msg_iter_seek_beginning;
	76	bt_component_class_source_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin;
	77	bt_component_class_source_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning;
	78	bt_component_class_source_query_method query;
	79	bt_component_class_source_output_port_connected_method output_port_connected;
	80	} methods;
	81	};
	82
	83	struct bt_component_class_sink {
	84	struct bt_component_class parent;
	85	struct {
	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_input_port_connected_method input_port_connected;
	90	bt_component_class_sink_graph_is_configured_method graph_is_configured;
	91	bt_component_class_sink_consume_method consume;
	92	} methods;
	93	};
	94
	95	struct bt_component_class_filter {
	96	struct bt_component_class parent;
	97	struct {
	98	bt_component_class_filter_init_method init;
	99	bt_component_class_filter_finalize_method finalize;
	100	bt_component_class_filter_message_iterator_init_method msg_iter_init;
	101	bt_component_class_filter_message_iterator_finalize_method msg_iter_finalize;
	102	bt_component_class_filter_message_iterator_next_method msg_iter_next;
	103	bt_component_class_filter_message_iterator_seek_ns_from_origin_method msg_iter_seek_ns_from_origin;
	104	bt_component_class_filter_message_iterator_seek_beginning_method msg_iter_seek_beginning;
	105	bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method msg_iter_can_seek_ns_from_origin;
	106	bt_component_class_filter_message_iterator_can_seek_beginning_method msg_iter_can_seek_beginning;
	107	bt_component_class_filter_query_method query;
	108	bt_component_class_filter_input_port_connected_method input_port_connected;
	109	bt_component_class_filter_output_port_connected_method output_port_connected;
	110	} methods;
	111	};
	112
	113	BT_HIDDEN
	114	void bt_component_class_add_destroy_listener(struct bt_component_class *class,
	115	bt_component_class_destroy_listener_func func, void *data);
	116
	117	BT_HIDDEN
	118	void _bt_component_class_freeze(
	119	const struct bt_component_class *component_class);
	120
	121	#ifdef BT_DEV_MODE
	122	# define bt_component_class_freeze _bt_component_class_freeze
	123	#else
	124	# define bt_component_class_freeze(_cc)
	125	#endif
	126
	127	static inline
	128	const char *bt_component_class_type_string(enum bt_component_class_type type)
	129	{
	130	switch (type) {
	131	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	132	return "SOURCE";
	133	case BT_COMPONENT_CLASS_TYPE_SINK:
	134	return "SINK";
	135	case BT_COMPONENT_CLASS_TYPE_FILTER:
	136	return "FILTER";
	137	default:
	138	return "(unknown)";
	139	}
	140	}
	141
	142	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_INTERNAL_H */