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

#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
#define BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H

/*
 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
 *
 * 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.
 */

#ifndef __BT_IN_BABELTRACE_H
# error "Please include <babeltrace2/babeltrace.h> instead."
#endif

#include <stdint.h>

#include <babeltrace2/graph/component-class.h>
#include <babeltrace2/types.h>
#include <babeltrace2/logging.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef bt_component_class_get_supported_mip_versions_method_status
(*bt_component_class_filter_get_supported_mip_versions_method)(
		bt_self_component_class_filter *comp_class,
		const bt_value *params, void *init_method_data,
		bt_logging_level log_level,
		bt_integer_range_set_unsigned *supported_versions);

typedef bt_component_class_initialize_method_status
(*bt_component_class_filter_initialize_method)(
		bt_self_component_filter *self_component,
		bt_self_component_filter_configuration *config,
		const bt_value *params, void *init_method_data);

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

typedef bt_component_class_message_iterator_initialize_method_status
(*bt_component_class_filter_message_iterator_initialize_method)(
		bt_self_message_iterator *message_iterator,
		bt_self_message_iterator_configuration *config,
		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_component_class_message_iterator_next_method_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_component_class_message_iterator_seek_ns_from_origin_method_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_component_class_message_iterator_seek_beginning_method_status
(*bt_component_class_filter_message_iterator_seek_beginning_method)(
		bt_self_message_iterator *message_iterator);

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

typedef bt_component_class_message_iterator_can_seek_beginning_method_status
(*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
		bt_self_message_iterator *message_iterator, bt_bool *can_seek);

typedef bt_component_class_query_method_status
(*bt_component_class_filter_query_method)(
		bt_self_component_class_filter *comp_class,
		bt_private_query_executor *query_executor,
		const char *object, const bt_value *params,
		void *method_data, const bt_value **result);

typedef bt_component_class_port_connected_method_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_component_class_port_connected_method_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_set_method_status
bt_component_class_filter_set_get_supported_mip_versions_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_get_supported_mip_versions_method method);

extern bt_component_class_set_method_status
bt_component_class_filter_set_initialize_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_initialize_method method);

extern bt_component_class_set_method_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_set_method_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_set_method_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_set_method_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_set_method_status
bt_component_class_filter_set_message_iterator_initialize_method(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_initialize_method method);

extern bt_component_class_set_method_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_set_method_status
bt_component_class_filter_set_message_iterator_seek_ns_from_origin_methods(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_seek_ns_from_origin_method seek_method,
		bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method can_seek_method);

extern bt_component_class_set_method_status
bt_component_class_filter_set_message_iterator_seek_beginning_methods(
		bt_component_class_filter *comp_class,
		bt_component_class_filter_message_iterator_seek_beginning_method seek_method,
		bt_component_class_filter_message_iterator_can_seek_beginning_method can_seek_method);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H */
Commit	Line	Data
	1	#ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
	2	#define BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H
	3
	4	/*
	5	* Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
	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
	26	#ifndef __BT_IN_BABELTRACE_H
	27	# error "Please include <babeltrace2/babeltrace.h> instead."
	28	#endif
	29
	30	#include <stdint.h>
	31
	32	#include <babeltrace2/graph/component-class.h>
	33	#include <babeltrace2/types.h>
	34	#include <babeltrace2/logging.h>
	35
	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
	40	typedef bt_component_class_get_supported_mip_versions_method_status
	41	(*bt_component_class_filter_get_supported_mip_versions_method)(
	42	bt_self_component_class_filter *comp_class,
	43	const bt_value params, void init_method_data,
	44	bt_logging_level log_level,
	45	bt_integer_range_set_unsigned *supported_versions);
	46
	47	typedef bt_component_class_initialize_method_status
	48	(*bt_component_class_filter_initialize_method)(
	49	bt_self_component_filter *self_component,
	50	bt_self_component_filter_configuration *config,
	51	const bt_value params, void init_method_data);
	52
	53	typedef void (*bt_component_class_filter_finalize_method)(
	54	bt_self_component_filter *self_component);
	55
	56	typedef bt_component_class_message_iterator_initialize_method_status
	57	(*bt_component_class_filter_message_iterator_initialize_method)(
	58	bt_self_message_iterator *message_iterator,
	59	bt_self_message_iterator_configuration *config,
	60	bt_self_component_filter *self_component,
	61	bt_self_component_port_output *port);
	62
	63	typedef void
	64	(*bt_component_class_filter_message_iterator_finalize_method)(
	65	bt_self_message_iterator *message_iterator);
	66
	67	typedef bt_component_class_message_iterator_next_method_status
	68	(*bt_component_class_filter_message_iterator_next_method)(
	69	bt_self_message_iterator *message_iterator,
	70	bt_message_array_const msgs, uint64_t capacity,
	71	uint64_t *count);
	72
	73	typedef bt_component_class_message_iterator_seek_ns_from_origin_method_status
	74	(*bt_component_class_filter_message_iterator_seek_ns_from_origin_method)(
	75	bt_self_message_iterator *message_iterator,
	76	int64_t ns_from_origin);
	77
	78	typedef bt_component_class_message_iterator_seek_beginning_method_status
	79	(*bt_component_class_filter_message_iterator_seek_beginning_method)(
	80	bt_self_message_iterator *message_iterator);
	81
	82	typedef bt_component_class_message_iterator_can_seek_ns_from_origin_method_status
	83	(*bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method)(
	84	bt_self_message_iterator *message_iterator,
	85	int64_t ns_from_origin, bt_bool *can_seek);
	86
	87	typedef bt_component_class_message_iterator_can_seek_beginning_method_status
	88	(*bt_component_class_filter_message_iterator_can_seek_beginning_method)(
	89	bt_self_message_iterator message_iterator, bt_bool can_seek);
	90
	91	typedef bt_component_class_query_method_status
	92	(*bt_component_class_filter_query_method)(
	93	bt_self_component_class_filter *comp_class,
	94	bt_private_query_executor *query_executor,
	95	const char object, const bt_value params,
	96	void method_data, const bt_value *result);
	97
	98	typedef bt_component_class_port_connected_method_status
	99	(*bt_component_class_filter_input_port_connected_method)(
	100	bt_self_component_filter *self_component,
	101	bt_self_component_port_input *self_port,
	102	const bt_port_output *other_port);
	103
	104	typedef bt_component_class_port_connected_method_status
	105	(*bt_component_class_filter_output_port_connected_method)(
	106	bt_self_component_filter *self_component,
	107	bt_self_component_port_output *self_port,
	108	const bt_port_input *other_port);
	109
	110	static inline
	111	bt_component_class *bt_component_class_filter_as_component_class(
	112	bt_component_class_filter *comp_cls_filter)
	113	{
	114	return __BT_UPCAST(bt_component_class, comp_cls_filter);
	115	}
	116
	117	extern
	118	bt_component_class_filter *bt_component_class_filter_create(
	119	const char *name,
	120	bt_component_class_filter_message_iterator_next_method method);
	121
	122	extern bt_component_class_set_method_status
	123	bt_component_class_filter_set_get_supported_mip_versions_method(
	124	bt_component_class_filter *comp_class,
	125	bt_component_class_filter_get_supported_mip_versions_method method);
	126
	127	extern bt_component_class_set_method_status
	128	bt_component_class_filter_set_initialize_method(
	129	bt_component_class_filter *comp_class,
	130	bt_component_class_filter_initialize_method method);
	131
	132	extern bt_component_class_set_method_status
	133	bt_component_class_filter_set_finalize_method(
	134	bt_component_class_filter *comp_class,
	135	bt_component_class_filter_finalize_method method);
	136
	137	extern bt_component_class_set_method_status
	138	bt_component_class_filter_set_input_port_connected_method(
	139	bt_component_class_filter *comp_class,
	140	bt_component_class_filter_input_port_connected_method method);
	141
	142	extern bt_component_class_set_method_status
	143	bt_component_class_filter_set_output_port_connected_method(
	144	bt_component_class_filter *comp_class,
	145	bt_component_class_filter_output_port_connected_method method);
	146
	147	extern bt_component_class_set_method_status
	148	bt_component_class_filter_set_query_method(
	149	bt_component_class_filter *comp_class,
	150	bt_component_class_filter_query_method method);
	151
	152	extern bt_component_class_set_method_status
	153	bt_component_class_filter_set_message_iterator_initialize_method(
	154	bt_component_class_filter *comp_class,
	155	bt_component_class_filter_message_iterator_initialize_method method);
	156
	157	extern bt_component_class_set_method_status
	158	bt_component_class_filter_set_message_iterator_finalize_method(
	159	bt_component_class_filter *comp_class,
	160	bt_component_class_filter_message_iterator_finalize_method method);
	161
	162	extern bt_component_class_set_method_status
	163	bt_component_class_filter_set_message_iterator_seek_ns_from_origin_methods(
	164	bt_component_class_filter *comp_class,
	165	bt_component_class_filter_message_iterator_seek_ns_from_origin_method seek_method,
	166	bt_component_class_filter_message_iterator_can_seek_ns_from_origin_method can_seek_method);
	167
	168	extern bt_component_class_set_method_status
	169	bt_component_class_filter_set_message_iterator_seek_beginning_methods(
	170	bt_component_class_filter *comp_class,
	171	bt_component_class_filter_message_iterator_seek_beginning_method seek_method,
	172	bt_component_class_filter_message_iterator_can_seek_beginning_method can_seek_method);
	173
	174	#ifdef __cplusplus
	175	}
	176	#endif
	177
	178	#endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_FILTER_H */