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

#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
#define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * 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_self_component_status */
#include <babeltrace/graph/self-component.h>

/* For enum bt_self_message_iterator_status */
#include <babeltrace/graph/self-message-iterator.h>

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

/*
 * For bt_component_class, bt_component_class_filter, bt_port_input,
 * bt_port_output, bt_query_executor, bt_self_component_class_filter,
 * bt_self_component_filter, bt_self_component_port_input,
 * bt_self_component_port_output, bt_value, bt_message_array_const
 */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

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

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

typedef enum bt_self_message_iterator_status
(*bt_component_class_filter_message_iterator_init_method)(
		bt_self_message_iterator *message_iterator,
		bt_self_component_filter *self_component,
		bt_self_component_port_output *port);

typedef void
(*bt_component_class_filter_message_iterator_finalize_method)(
		bt_self_message_iterator *message_iterator);

typedef enum bt_self_message_iterator_status
(*bt_component_class_filter_message_iterator_next_method)(
		bt_self_message_iterator *message_iterator,
		bt_message_array_const msgs, uint64_t capacity,
		uint64_t *count);

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

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

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

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

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

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

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

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

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

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

extern int bt_component_class_filter_set_finalize_method(
		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(
		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(
		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(
		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(
		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(
		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(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_output_port_disconnected_method method);

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

extern int bt_component_class_filter_set_message_iterator_init_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_init_method method);

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