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

#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
#define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H

/*
 * Copyright 2016 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 <stdint.h>

/* For enum bt_notification_array_const */
#include <babeltrace/graph/notification-const.h>

/* For enum bt_self_component_status */
#include <babeltrace/graph/self-component.h>

/* For enum bt_self_notification_iterator_status */
#include <babeltrace/graph/self-notification-iterator.h>

/* For enum bt_query_status */
#include <babeltrace/graph/component-class.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component_class;
struct bt_component_class_filter;
struct bt_port_input;
struct bt_port_output;
struct bt_query_executor;
struct bt_self_component_class_filter;
struct bt_self_component_filter;
struct bt_self_component_port_input;
struct bt_self_component_port_output;
struct bt_value;

typedef enum bt_self_component_status
(*bt_component_class_filter_init_method)(
		struct bt_self_component_filter *self_component,
		const struct bt_value *params, void *init_method_data);

typedef void (*bt_component_class_filter_finalize_method)(
		struct bt_self_component_filter *self_component);

typedef enum bt_self_notification_iterator_status
(*bt_component_class_filter_notification_iterator_init_method)(
		struct bt_self_notification_iterator *notification_iterator,
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_output *port);

typedef void
(*bt_component_class_filter_notification_iterator_finalize_method)(
		struct bt_self_notification_iterator *notification_iterator);

typedef enum bt_self_notification_iterator_status
(*bt_component_class_filter_notification_iterator_next_method)(
		struct bt_self_notification_iterator *notification_iterator,
		bt_notification_array_const notifs, uint64_t capacity,
		uint64_t *count);

typedef enum bt_query_status
(*bt_component_class_filter_query_method)(
		struct bt_self_component_class_filter *comp_class,
		const struct bt_query_executor *query_executor,
		const char *object, const struct bt_value *params,
		const struct bt_value **result);

typedef enum bt_self_component_status
(*bt_component_class_filter_accept_input_port_connection_method)(
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_input *self_port,
		const struct bt_port_output *other_port);

typedef enum bt_self_component_status
(*bt_component_class_filter_accept_output_port_connection_method)(
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_output *self_port,
		const struct bt_port_input *other_port);

typedef enum bt_self_component_status
(*bt_component_class_filter_input_port_connected_method)(
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_input *self_port,
		const struct bt_port_output *other_port);

typedef enum bt_self_component_status
(*bt_component_class_filter_output_port_connected_method)(
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_output *self_port,
		const struct bt_port_input *other_port);

typedef void
(*bt_component_class_filter_input_port_disconnected_method)(
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_input *self_port);

typedef void
(*bt_component_class_filter_output_port_disconnected_method)(
		struct bt_self_component_filter *self_component,
		struct bt_self_component_port_output *self_port);

static inline
struct bt_component_class *bt_component_class_filter_as_component_class(
		struct bt_component_class_filter *comp_cls_filter)
{
	return (void *) comp_cls_filter;
}

extern
struct bt_component_class_filter *bt_component_class_filter_create(
		const char *name,
		bt_component_class_filter_notification_iterator_next_method method);

extern int bt_component_class_filter_set_init_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_init_method method);

extern int bt_component_class_filter_set_finalize_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_finalize_method method);

extern int bt_component_class_filter_set_accept_input_port_connection_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_accept_input_port_connection_method method);

extern int bt_component_class_filter_set_accept_output_port_connection_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_accept_output_port_connection_method method);

extern int bt_component_class_filter_set_input_port_connected_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_input_port_connected_method method);

extern int bt_component_class_filter_set_output_port_connected_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_output_port_connected_method method);

extern int bt_component_class_filter_set_input_port_disconnected_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_input_port_disconnected_method method);

extern int bt_component_class_filter_set_output_port_disconnected_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_output_port_disconnected_method method);

extern int bt_component_class_filter_set_query_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_query_method method);

extern int bt_component_class_filter_set_notification_iterator_init_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_notification_iterator_init_method method);

extern int bt_component_class_filter_set_notification_iterator_finalize_method(
		struct bt_component_class_filter *comp_class,
		bt_component_class_filter_notification_iterator_finalize_method method);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */
Commit	Line	Data
1ca80abd PP	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
1ca80abd PP	2	#define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
d3e4dcd8 PP	3
d3e4dcd8 PP	4	/*
d3e4dcd8 PP	5	* Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
0d72b8c3 PP	26	#include <stdint.h>
	27
	28	/* For enum bt_notification_array_const */
	29	#include <babeltrace/graph/notification-const.h>
	30
	31	/* For enum bt_self_component_status */
	32	#include <babeltrace/graph/self-component.h>
	33
	34	/* For enum bt_self_notification_iterator_status */
	35	#include <babeltrace/graph/self-notification-iterator.h>
	36
	37	/* For enum bt_query_status */
	38	#include <babeltrace/graph/component-class.h>
	39
d3e4dcd8 PP	40	#ifdef __cplusplus
	41	extern "C" {
	42	#endif
	43
	44	struct bt_component_class;
d94d92ac	45	struct bt_component_class_filter;
0d72b8c3 PP	46	struct bt_port_input;
	47	struct bt_port_output;
	48	struct bt_query_executor;
	49	struct bt_self_component_class_filter;
	50	struct bt_self_component_filter;
	51	struct bt_self_component_port_input;
	52	struct bt_self_component_port_output;
	53	struct bt_value;
	54
	55	typedef enum bt_self_component_status
	56	(*bt_component_class_filter_init_method)(
	57	struct bt_self_component_filter *self_component,
	58	const struct bt_value params, void init_method_data);
	59
	60	typedef void (*bt_component_class_filter_finalize_method)(
	61	struct bt_self_component_filter *self_component);
	62
	63	typedef enum bt_self_notification_iterator_status
	64	(*bt_component_class_filter_notification_iterator_init_method)(
	65	struct bt_self_notification_iterator *notification_iterator,
	66	struct bt_self_component_filter *self_component,
	67	struct bt_self_component_port_output *port);
	68
	69	typedef void
	70	(*bt_component_class_filter_notification_iterator_finalize_method)(
	71	struct bt_self_notification_iterator *notification_iterator);
	72
	73	typedef enum bt_self_notification_iterator_status
	74	(*bt_component_class_filter_notification_iterator_next_method)(
	75	struct bt_self_notification_iterator *notification_iterator,
	76	bt_notification_array_const notifs, uint64_t capacity,
	77	uint64_t *count);
	78
	79	typedef enum bt_query_status
	80	(*bt_component_class_filter_query_method)(
	81	struct bt_self_component_class_filter *comp_class,
	82	const struct bt_query_executor *query_executor,
	83	const char object, const struct bt_value params,
	84	const struct bt_value **result);
	85
	86	typedef enum bt_self_component_status
	87	(*bt_component_class_filter_accept_input_port_connection_method)(
	88	struct bt_self_component_filter *self_component,
	89	struct bt_self_component_port_input *self_port,
	90	const struct bt_port_output *other_port);
	91
	92	typedef enum bt_self_component_status
	93	(*bt_component_class_filter_accept_output_port_connection_method)(
	94	struct bt_self_component_filter *self_component,
	95	struct bt_self_component_port_output *self_port,
	96	const struct bt_port_input *other_port);
	97
	98	typedef enum bt_self_component_status
	99	(*bt_component_class_filter_input_port_connected_method)(
	100	struct bt_self_component_filter *self_component,
	101	struct bt_self_component_port_input *self_port,
	102	const struct bt_port_output *other_port);
	103
	104	typedef enum bt_self_component_status
	105	(*bt_component_class_filter_output_port_connected_method)(
	106	struct bt_self_component_filter *self_component,
	107	struct bt_self_component_port_output *self_port,
	108	const struct bt_port_input *other_port);
	109
110	typedef void
111	(*bt_component_class_filter_input_port_disconnected_method)(
112	struct bt_self_component_filter *self_component,
113	struct bt_self_component_port_input *self_port);
114
115	typedef void
116	(*bt_component_class_filter_output_port_disconnected_method)(
117	struct bt_self_component_filter *self_component,
118	struct bt_self_component_port_output *self_port);
d94d92ac PP	119
d94d92ac PP	120	static inline
0d72b8c3	121	struct bt_component_class *bt_component_class_filter_as_component_class(
d94d92ac PP	122	struct bt_component_class_filter *comp_cls_filter)
	123	{
	124	return (void *) comp_cls_filter;
	125	}
d3eb6e8f	126
0d72b8c3 PP	127	extern
	128	struct bt_component_class_filter *bt_component_class_filter_create(
	129	const char *name,
	130	bt_component_class_filter_notification_iterator_next_method method);
	131
	132	extern int bt_component_class_filter_set_init_method(
	133	struct bt_component_class_filter *comp_class,
	134	bt_component_class_filter_init_method method);
	135
	136	extern int bt_component_class_filter_set_finalize_method(
	137	struct bt_component_class_filter *comp_class,
	138	bt_component_class_filter_finalize_method method);
	139
	140	extern int bt_component_class_filter_set_accept_input_port_connection_method(
	141	struct bt_component_class_filter *comp_class,
	142	bt_component_class_filter_accept_input_port_connection_method method);
	143
	144	extern int bt_component_class_filter_set_accept_output_port_connection_method(
	145	struct bt_component_class_filter *comp_class,
	146	bt_component_class_filter_accept_output_port_connection_method method);
	147
	148	extern int bt_component_class_filter_set_input_port_connected_method(
	149	struct bt_component_class_filter *comp_class,
	150	bt_component_class_filter_input_port_connected_method method);
	151
	152	extern int bt_component_class_filter_set_output_port_connected_method(
	153	struct bt_component_class_filter *comp_class,
	154	bt_component_class_filter_output_port_connected_method method);
	155
	156	extern int bt_component_class_filter_set_input_port_disconnected_method(
	157	struct bt_component_class_filter *comp_class,
	158	bt_component_class_filter_input_port_disconnected_method method);
	159
	160	extern int bt_component_class_filter_set_output_port_disconnected_method(
	161	struct bt_component_class_filter *comp_class,
	162	bt_component_class_filter_output_port_disconnected_method method);
	163
	164	extern int bt_component_class_filter_set_query_method(
	165	struct bt_component_class_filter *comp_class,
	166	bt_component_class_filter_query_method method);
	167
	168	extern int bt_component_class_filter_set_notification_iterator_init_method(
	169	struct bt_component_class_filter *comp_class,
	170	bt_component_class_filter_notification_iterator_init_method method);
	171
	172	extern int bt_component_class_filter_set_notification_iterator_finalize_method(
	173	struct bt_component_class_filter *comp_class,
	174	bt_component_class_filter_notification_iterator_finalize_method method);
	175
d3eb6e8f PP	176	#ifdef __cplusplus
	177	}
	178	#endif
	179
90157d89	180	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */