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

#ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H
#define BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H

/*
 * BabelTrace - Component Class Internal
 *
 * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
 * Copyright 2017 Philippe Proulx <pproulx@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 <babeltrace/graph/component.h>
#include <babeltrace/graph/component-class.h>
#include <babeltrace/graph/component-class-source.h>
#include <babeltrace/graph/component-class-filter.h>
#include <babeltrace/graph/component-class-sink.h>
#include <babeltrace/babeltrace-internal.h>
#include <babeltrace/object-internal.h>
#include <babeltrace/list-internal.h>
#include <babeltrace/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;
	struct {
		bt_component_class_init_method init;
		bt_component_class_finalize_method finalize;
		bt_component_class_query_method query;
		bt_component_class_accept_port_connection_method accept_port_connection;
		bt_component_class_port_connected_method port_connected;
		bt_component_class_port_disconnected_method port_disconnected;
	} methods;
	/* Array of struct bt_component_class_destroy_listener */
	GArray *destroy_listeners;
	bt_bool frozen;
	struct bt_list_head node;
	struct bt_plugin_so_shared_lib_handle *so_handle;
};

struct bt_component_class_notification_iterator_methods {
	bt_component_class_notification_iterator_init_method init;
	bt_component_class_notification_iterator_finalize_method finalize;
	bt_component_class_notification_iterator_next_method next;
};

struct bt_component_class_source {
	struct bt_component_class parent;
	struct {
		struct bt_component_class_notification_iterator_methods iterator;
	} methods;
};

struct bt_component_class_sink {
	struct bt_component_class parent;
	struct {
		bt_component_class_sink_consume_method consume;
	} methods;
};

struct bt_component_class_filter {
	struct bt_component_class parent;
	struct {
		struct bt_component_class_notification_iterator_methods iterator;
	} methods;
};

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

static inline
const char *bt_component_class_type_string(enum bt_component_class_type type)
{
	switch (type) {
	case BT_COMPONENT_CLASS_TYPE_UNKNOWN:
		return "BT_COMPONENT_CLASS_TYPE_UNKNOWN";
	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_COMPONENT_COMPONENT_CLASS_INTERNAL_H */
Commit	Line	Data
33b34c43 PP	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H
33b34c43 PP	2	#define BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H
fb2dcc52 JG	3
	4	/*
	5	* BabelTrace - Component Class Internal
	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
33b34c43	8	* Copyright 2017 Philippe Proulx <pproulx@efficios.com>
fb2dcc52 JG	9	*
	10	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	11	*
	12	* Permission is hereby granted, free of charge, to any person obtaining a copy
	13	* of this software and associated documentation files (the "Software"), to deal
	14	* in the Software without restriction, including without limitation the rights
	15	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	16	* copies of the Software, and to permit persons to whom the Software is
	17	* furnished to do so, subject to the following conditions:
	18	*
	19	* The above copyright notice and this permission notice shall be included in
	20	* all copies or substantial portions of the Software.
	21	*
	22	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	23	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	24	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	25	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	26	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	27	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	28	* SOFTWARE.
	29	*/
	30
b2e0c907 PP	31	#include <babeltrace/graph/component.h>
	32	#include <babeltrace/graph/component-class.h>
	33	#include <babeltrace/graph/component-class-source.h>
	34	#include <babeltrace/graph/component-class-filter.h>
	35	#include <babeltrace/graph/component-class-sink.h>
fb2dcc52	36	#include <babeltrace/babeltrace-internal.h>
b8a06801	37	#include <babeltrace/object-internal.h>
bfa9a4be	38	#include <babeltrace/list-internal.h>
c55a9f58	39	#include <babeltrace/types.h>
33b34c43 PP	40	#include <glib.h>
	41
	42	struct bt_component_class;
bfa9a4be	43	struct bt_plugin_so_shared_lib_handle;
33b34c43 PP	44
	45	typedef void (*bt_component_class_destroy_listener_func)(
	46	struct bt_component_class class, void data);
	47
d3e4dcd8	48	struct bt_component_class_destroy_listener {
33b34c43 PP	49	bt_component_class_destroy_listener_func func;
	50	void *data;
	51	};
fb2dcc52 JG	52
fb2dcc52 JG	53	struct bt_component_class {
b8a06801	54	struct bt_object base;
d3e4dcd8	55	enum bt_component_class_type type;
fb2dcc52	56	GString *name;
7c7c0433	57	GString *description;
5536d9a6	58	GString *help;
d3e4dcd8 PP	59	struct {
d3e4dcd8 PP	60	bt_component_class_init_method init;
64cadc66	61	bt_component_class_finalize_method finalize;
a67681c1	62	bt_component_class_query_method query;
72b913fb	63	bt_component_class_accept_port_connection_method accept_port_connection;
0d8b4d8e	64	bt_component_class_port_connected_method port_connected;
72b913fb	65	bt_component_class_port_disconnected_method port_disconnected;
d3e4dcd8 PP	66	} methods;
d3e4dcd8 PP	67	/* Array of struct bt_component_class_destroy_listener */
33b34c43	68	GArray *destroy_listeners;
c55a9f58	69	bt_bool frozen;
bfa9a4be MD	70	struct bt_list_head node;
bfa9a4be MD	71	struct bt_plugin_so_shared_lib_handle *so_handle;
33b34c43	72	};
92893b7b	73
90157d89	74	struct bt_component_class_notification_iterator_methods {
d3eb6e8f	75	bt_component_class_notification_iterator_init_method init;
64cadc66	76	bt_component_class_notification_iterator_finalize_method finalize;
d3eb6e8f	77	bt_component_class_notification_iterator_next_method next;
d3eb6e8f PP	78	};
d3eb6e8f PP	79
d3e4dcd8 PP	80	struct bt_component_class_source {
	81	struct bt_component_class parent;
	82	struct {
90157d89	83	struct bt_component_class_notification_iterator_methods iterator;
d3e4dcd8 PP	84	} methods;
	85	};
	86
	87	struct bt_component_class_sink {
	88	struct bt_component_class parent;
	89	struct {
	90	bt_component_class_sink_consume_method consume;
d3e4dcd8 PP	91	} methods;
	92	};
	93
	94	struct bt_component_class_filter {
	95	struct bt_component_class parent;
	96	struct {
90157d89	97	struct bt_component_class_notification_iterator_methods iterator;
d3e4dcd8 PP	98	} methods;
	99	};
	100
92893b7b	101	BT_HIDDEN
3230ee6b	102	void bt_component_class_add_destroy_listener(struct bt_component_class *class,
33b34c43	103	bt_component_class_destroy_listener_func func, void *data);
fb2dcc52	104
ab0d387b PP	105	static inline
	106	const char *bt_component_class_type_string(enum bt_component_class_type type)
	107	{
	108	switch (type) {
	109	case BT_COMPONENT_CLASS_TYPE_UNKNOWN:
	110	return "BT_COMPONENT_CLASS_TYPE_UNKNOWN";
	111	case BT_COMPONENT_CLASS_TYPE_SOURCE:
	112	return "BT_COMPONENT_CLASS_TYPE_SOURCE";
	113	case BT_COMPONENT_CLASS_TYPE_SINK:
	114	return "BT_COMPONENT_CLASS_TYPE_SINK";
	115	case BT_COMPONENT_CLASS_TYPE_FILTER:
	116	return "BT_COMPONENT_CLASS_TYPE_FILTER";
	117	default:
	118	return "(unknown)";
	119	}
	120	}
	121
33b34c43	122	#endif /* BABELTRACE_COMPONENT_COMPONENT_CLASS_INTERNAL_H */