[babeltrace.git] / include / babeltrace2 / 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 bt_self_component_status */
#include <babeltrace2/graph/self-component.h>

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

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

/* For bt_component_class_status */
#include <babeltrace2/graph/component-class-const.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,
 * bt_bool, bt_self_message_iterator, __BT_UPCAST
 */
#include <babeltrace2/types.h>

/* For bt_logging_level */
#include <babeltrace2/logging.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef 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 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 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 bt_self_message_iterator_status
(*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)(
		bt_self_message_iterator *message_iterator,
		int64_t ns_from_origin);

typedef bt_self_message_iterator_status
(*bt_component_class_filter_message_iterator_seek_beginning_method)(
		bt_self_message_iterator *message_iterator);

typedef bt_bool
(*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)(
		bt_self_message_iterator *message_iterator,
		int64_t ns_from_origin);

typedef bt_bool
(*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
		bt_self_message_iterator *message_iterator);

typedef 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,
		bt_logging_level logging_level, const bt_value **result);

typedef 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 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 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 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);

static inline
bt_component_class *bt_component_class_filter_as_component_class(
		bt_component_class_filter *comp_cls_filter)
{
	return __BT_UPCAST(bt_component_class, 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 bt_component_class_status
bt_component_class_filter_set_init_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_init_method method);

extern bt_component_class_status
bt_component_class_filter_set_finalize_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_finalize_method method);

extern bt_component_class_status
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 bt_component_class_status
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 bt_component_class_status
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 bt_component_class_status
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 bt_component_class_status
bt_component_class_filter_set_query_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_query_method method);

extern bt_component_class_status
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 bt_component_class_status
bt_component_class_filter_set_message_iterator_finalize_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_finalize_method method);

extern bt_component_class_status
bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_seek_ns_from_origin_method method);

extern bt_component_class_status
bt_component_class_filter_set_message_iterator_seek_beginning_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_seek_beginning_method method);

extern bt_bool
bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method);

extern bt_bool
bt_component_class_filter_set_message_iterator_can_seek_beginning_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_can_seek_beginning_method method);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
	2	#define BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	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
	27	#include <stdint.h>
	28
	29	/* For bt_self_component_status */
	30	#include <babeltrace2/graph/self-component.h>
	31
	32	/* For bt_self_message_iterator_status */
	33	#include <babeltrace2/graph/self-message-iterator.h>
	34
	35	/* For bt_query_status */
	36	#include <babeltrace2/graph/component-class.h>
	37
	38	/* For bt_component_class_status */
	39	#include <babeltrace2/graph/component-class-const.h>
	40
	41	/*
	42	* For bt_component_class, bt_component_class_filter, bt_port_input,
	43	* bt_port_output, bt_query_executor, bt_self_component_class_filter,
	44	* bt_self_component_filter, bt_self_component_port_input,
	45	* bt_self_component_port_output, bt_value, bt_message_array_const,
	46	* bt_bool, bt_self_message_iterator, __BT_UPCAST
	47	*/
	48	#include <babeltrace2/types.h>
	49
	50	/* For bt_logging_level */
	51	#include <babeltrace2/logging.h>
	52
	53	#ifdef __cplusplus
	54	extern "C" {
	55	#endif
	56
	57	typedef bt_self_component_status
	58	(*bt_component_class_filter_init_method)(
	59	bt_self_component_filter *self_component,
	60	const bt_value params, void init_method_data);
	61
	62	typedef void (*bt_component_class_filter_finalize_method)(
	63	bt_self_component_filter *self_component);
	64
	65	typedef bt_self_message_iterator_status
	66	(*bt_component_class_filter_message_iterator_init_method)(
	67	bt_self_message_iterator *message_iterator,
	68	bt_self_component_filter *self_component,
	69	bt_self_component_port_output *port);
	70
	71	typedef void
	72	(*bt_component_class_filter_message_iterator_finalize_method)(
	73	bt_self_message_iterator *message_iterator);
	74
	75	typedef bt_self_message_iterator_status
	76	(*bt_component_class_filter_message_iterator_next_method)(
	77	bt_self_message_iterator *message_iterator,
	78	bt_message_array_const msgs, uint64_t capacity,
	79	uint64_t *count);
	80
	81	typedef bt_self_message_iterator_status
	82	(*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)(
	83	bt_self_message_iterator *message_iterator,
	84	int64_t ns_from_origin);
	85
	86	typedef bt_self_message_iterator_status
	87	(*bt_component_class_filter_message_iterator_seek_beginning_method)(
	88	bt_self_message_iterator *message_iterator);
	89
	90	typedef bt_bool
	91	(*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)(
	92	bt_self_message_iterator *message_iterator,
	93	int64_t ns_from_origin);
	94
	95	typedef bt_bool
	96	(*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
	97	bt_self_message_iterator *message_iterator);
	98
	99	typedef bt_query_status
	100	(*bt_component_class_filter_query_method)(
	101	bt_self_component_class_filter *comp_class,
	102	const bt_query_executor *query_executor,
	103	const char object, const bt_value params,
	104	bt_logging_level logging_level, const bt_value **result);
	105
	106	typedef bt_self_component_status
	107	(*bt_component_class_filter_accept_input_port_connection_method)(
	108	bt_self_component_filter *self_component,
	109	bt_self_component_port_input *self_port,
	110	const bt_port_output *other_port);
	111
	112	typedef bt_self_component_status
	113	(*bt_component_class_filter_accept_output_port_connection_method)(
	114	bt_self_component_filter *self_component,
	115	bt_self_component_port_output *self_port,
	116	const bt_port_input *other_port);
	117
	118	typedef bt_self_component_status
	119	(*bt_component_class_filter_input_port_connected_method)(
	120	bt_self_component_filter *self_component,
	121	bt_self_component_port_input *self_port,
	122	const bt_port_output *other_port);
	123
	124	typedef bt_self_component_status
	125	(*bt_component_class_filter_output_port_connected_method)(
	126	bt_self_component_filter *self_component,
	127	bt_self_component_port_output *self_port,
	128	const bt_port_input *other_port);
	129
	130	static inline
	131	bt_component_class *bt_component_class_filter_as_component_class(
	132	bt_component_class_filter *comp_cls_filter)
	133	{
	134	return __BT_UPCAST(bt_component_class, comp_cls_filter);
	135	}
	136
	137	extern
	138	bt_component_class_filter *bt_component_class_filter_create(
	139	const char *name,
	140	bt_component_class_filter_message_iterator_next_method method);
	141
	142	extern bt_component_class_status
	143	bt_component_class_filter_set_init_method(
	144	bt_component_class_filter *comp_class,
	145	bt_component_class_filter_init_method method);
	146
	147	extern bt_component_class_status
	148	bt_component_class_filter_set_finalize_method(
	149	bt_component_class_filter *comp_class,
	150	bt_component_class_filter_finalize_method method);
	151
	152	extern bt_component_class_status
	153	bt_component_class_filter_set_accept_input_port_connection_method(
	154	bt_component_class_filter *comp_class,
	155	bt_component_class_filter_accept_input_port_connection_method method);
	156
	157	extern bt_component_class_status
	158	bt_component_class_filter_set_accept_output_port_connection_method(
	159	bt_component_class_filter *comp_class,
	160	bt_component_class_filter_accept_output_port_connection_method method);
	161
	162	extern bt_component_class_status
	163	bt_component_class_filter_set_input_port_connected_method(
	164	bt_component_class_filter *comp_class,
	165	bt_component_class_filter_input_port_connected_method method);
	166
	167	extern bt_component_class_status
	168	bt_component_class_filter_set_output_port_connected_method(
	169	bt_component_class_filter *comp_class,
	170	bt_component_class_filter_output_port_connected_method method);
	171
	172	extern bt_component_class_status
	173	bt_component_class_filter_set_query_method(
	174	bt_component_class_filter *comp_class,
	175	bt_component_class_filter_query_method method);
	176
	177	extern bt_component_class_status
	178	bt_component_class_filter_set_message_iterator_init_method(
	179	bt_component_class_filter *comp_class,
	180	bt_component_class_filter_message_iterator_init_method method);
	181
	182	extern bt_component_class_status
	183	bt_component_class_filter_set_message_iterator_finalize_method(
	184	bt_component_class_filter *comp_class,
	185	bt_component_class_filter_message_iterator_finalize_method method);
	186
	187	extern bt_component_class_status
	188	bt_component_class_filter_set_message_iterator_seek_ns_from_origin_method(
	189	bt_component_class_filter *comp_class,
	190	bt_component_class_filter_message_iterator_seek_ns_from_origin_method method);
	191
	192	extern bt_component_class_status
	193	bt_component_class_filter_set_message_iterator_seek_beginning_method(
	194	bt_component_class_filter *comp_class,
	195	bt_component_class_filter_message_iterator_seek_beginning_method method);
	196
	197	extern bt_bool
	198	bt_component_class_filter_set_message_iterator_can_seek_ns_from_origin_method(
	199	bt_component_class_filter *comp_class,
	200	bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method method);
	201
	202	extern bt_bool
	203	bt_component_class_filter_set_message_iterator_can_seek_beginning_method(
	204	bt_component_class_filter *comp_class,
	205	bt_component_class_filter_message_iterator_can_seek_beginning_method method);
	206
	207	#ifdef __cplusplus
	208	}
	209	#endif
	210
	211	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_FILTER_H */