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

#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H

/*
 * BabelTrace - Component internal
 *
 * 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 <babeltrace/babeltrace-internal.h>
#include <babeltrace/graph/component.h>
#include <babeltrace/graph/component-class-internal.h>
#include <babeltrace/graph/port-internal.h>
#include <babeltrace/object-internal.h>
#include <glib.h>
#include <stdio.h>

#define DEFAULT_INPUT_PORT_NAME		"default"
#define DEFAULT_OUTPUT_PORT_NAME	"default"

typedef void (*bt_component_destroy_listener_func)(
		struct bt_component *class, void *data);

struct bt_component_destroy_listener {
	bt_component_destroy_listener_func func;
	void *data;
};

struct bt_component {
	struct bt_object base;
	struct bt_component_class *class;
	GString *name;

	/*
	 * Internal destroy function specific to a source, filter, or
	 * sink component object.
	 */
	void (*destroy)(struct bt_component *);

	/* User-defined data */
	void *user_data;

	/*
	 * Used to protect operations which may only be used during
	 * a component's initialization.
	 */
	bool initializing;

	/* Input and output ports (weak references) */
	GPtrArray *input_ports;
	GPtrArray *output_ports;

	/* Array of struct bt_component_destroy_listener */
	GArray *destroy_listeners;
};

static inline
struct bt_component *bt_component_from_private(
		struct bt_private_component *private_component)
{
	return (void *) private_component;
}

static inline
struct bt_private_component *bt_private_component_from_component(
		struct bt_component *component)
{
	return (void *) component;
}

BT_HIDDEN
enum bt_component_status bt_component_accept_port_connection(
		struct bt_component *component, struct bt_port *self_port,
		struct bt_port *other_port);

BT_HIDDEN
void bt_component_port_connected(struct bt_component *comp,
		struct bt_port *self_port, struct bt_port *other_port);

BT_HIDDEN
void bt_component_port_disconnected(struct bt_component *comp,
		struct bt_port *port);

BT_HIDDEN
void bt_component_set_graph(struct bt_component *component,
		struct bt_graph *graph);

BT_HIDDEN
int64_t bt_component_get_input_port_count(struct bt_component *comp);

BT_HIDDEN
int64_t bt_component_get_output_port_count(struct bt_component *comp);

BT_HIDDEN
struct bt_port *bt_component_get_input_port_by_index(struct bt_component *comp,
		uint64_t index);

BT_HIDDEN
struct bt_port *bt_component_get_output_port_by_index(struct bt_component *comp,
		uint64_t index);

BT_HIDDEN
struct bt_port *bt_component_get_input_port_by_name(struct bt_component *comp,
		const char *name);

BT_HIDDEN
struct bt_port *bt_component_get_output_port_by_name(struct bt_component *comp,
		const char *name);

BT_HIDDEN
struct bt_port *bt_component_add_input_port(
		struct bt_component *component, const char *name,
		void *user_data);

BT_HIDDEN
struct bt_port *bt_component_add_output_port(
		struct bt_component *component, const char *name,
		void *user_data);

BT_HIDDEN
enum bt_component_status bt_component_remove_port(
		struct bt_component *component, struct bt_port *port);

BT_HIDDEN
void bt_component_add_destroy_listener(struct bt_component *component,
		bt_component_destroy_listener_func func, void *data);

BT_HIDDEN
void bt_component_remove_destroy_listener(struct bt_component *component,
		bt_component_destroy_listener_func func, void *data);

#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
	2	#define BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H
	3
	4	/*
	5	* BabelTrace - Component internal
	6	*
	7	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	8	*
	9	* Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
	10	*
	11	* Permission is hereby granted, free of charge, to any person obtaining a copy
	12	* of this software and associated documentation files (the "Software"), to deal
	13	* in the Software without restriction, including without limitation the rights
	14	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	15	* copies of the Software, and to permit persons to whom the Software is
	16	* furnished to do so, subject to the following conditions:
	17	*
	18	* The above copyright notice and this permission notice shall be included in
	19	* all copies or substantial portions of the Software.
	20	*
	21	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	22	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	23	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	24	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	25	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	26	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	27	* SOFTWARE.
	28	*/
	29
	30	#include <babeltrace/babeltrace-internal.h>
	31	#include <babeltrace/graph/component.h>
	32	#include <babeltrace/graph/component-class-internal.h>
	33	#include <babeltrace/graph/port-internal.h>
	34	#include <babeltrace/object-internal.h>
	35	#include <glib.h>
	36	#include <stdio.h>
	37
	38	#define DEFAULT_INPUT_PORT_NAME "default"
	39	#define DEFAULT_OUTPUT_PORT_NAME "default"
	40
	41	typedef void (*bt_component_destroy_listener_func)(
	42	struct bt_component class, void data);
	43
	44	struct bt_component_destroy_listener {
	45	bt_component_destroy_listener_func func;
	46	void *data;
	47	};
	48
	49	struct bt_component {
	50	struct bt_object base;
	51	struct bt_component_class *class;
	52	GString *name;
	53
	54	/*
	55	* Internal destroy function specific to a source, filter, or
	56	* sink component object.
	57	*/
	58	void (destroy)(struct bt_component );
	59
	60	/* User-defined data */
	61	void *user_data;
	62
	63	/*
	64	* Used to protect operations which may only be used during
	65	* a component's initialization.
	66	*/
	67	bool initializing;
	68
	69	/* Input and output ports (weak references) */
	70	GPtrArray *input_ports;
	71	GPtrArray *output_ports;
	72
	73	/* Array of struct bt_component_destroy_listener */
	74	GArray *destroy_listeners;
	75	};
	76
	77	static inline
	78	struct bt_component *bt_component_from_private(
	79	struct bt_private_component *private_component)
	80	{
	81	return (void *) private_component;
	82	}
	83
	84	static inline
	85	struct bt_private_component *bt_private_component_from_component(
	86	struct bt_component *component)
	87	{
	88	return (void *) component;
	89	}
	90
	91	BT_HIDDEN
	92	enum bt_component_status bt_component_accept_port_connection(
	93	struct bt_component component, struct bt_port self_port,
	94	struct bt_port *other_port);
	95
	96	BT_HIDDEN
	97	void bt_component_port_connected(struct bt_component *comp,
	98	struct bt_port self_port, struct bt_port other_port);
	99
	100	BT_HIDDEN
	101	void bt_component_port_disconnected(struct bt_component *comp,
	102	struct bt_port *port);
	103
	104	BT_HIDDEN
	105	void bt_component_set_graph(struct bt_component *component,
	106	struct bt_graph *graph);
	107
	108	BT_HIDDEN
	109	int64_t bt_component_get_input_port_count(struct bt_component *comp);
	110
	111	BT_HIDDEN
	112	int64_t bt_component_get_output_port_count(struct bt_component *comp);
	113
	114	BT_HIDDEN
	115	struct bt_port bt_component_get_input_port_by_index(struct bt_component comp,
	116	uint64_t index);
	117
	118	BT_HIDDEN
	119	struct bt_port bt_component_get_output_port_by_index(struct bt_component comp,
	120	uint64_t index);
	121
	122	BT_HIDDEN
	123	struct bt_port bt_component_get_input_port_by_name(struct bt_component comp,
	124	const char *name);
	125
	126	BT_HIDDEN
	127	struct bt_port bt_component_get_output_port_by_name(struct bt_component comp,
	128	const char *name);
	129
	130	BT_HIDDEN
	131	struct bt_port *bt_component_add_input_port(
	132	struct bt_component component, const char name,
	133	void *user_data);
	134
	135	BT_HIDDEN
	136	struct bt_port *bt_component_add_output_port(
	137	struct bt_component component, const char name,
	138	void *user_data);
	139
	140	BT_HIDDEN
	141	enum bt_component_status bt_component_remove_port(
	142	struct bt_component component, struct bt_port port);
	143
	144	BT_HIDDEN
	145	void bt_component_add_destroy_listener(struct bt_component *component,
	146	bt_component_destroy_listener_func func, void *data);
	147
	148	BT_HIDDEN
	149	void bt_component_remove_destroy_listener(struct bt_component *component,
	150	bt_component_destroy_listener_func func, void *data);
	151
	152	#endif /* BABELTRACE_COMPONENT_COMPONENT_INTERNAL_H */