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

#ifndef BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H
#define BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H

/*
 * Copyright 2017 Philippe Proulx <pproulx@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>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component_filter;
struct bt_self_component;
struct bt_self_component_filter;
struct bt_self_component_port_input;
struct bt_self_component_port_output;

static inline
struct bt_self_component *bt_self_component_filter_as_self_component(
		struct bt_self_component_filter *self_comp_filter)
{
	return (void *) self_comp_filter;
}

static inline
const struct bt_component_filter *
bt_self_component_filter_as_component_filter(
		struct bt_self_component_filter *self_comp_filter)
{
	return (const void *) self_comp_filter;
}

extern struct bt_component_filter *bt_component_filter_borrow_from_self(
		struct bt_self_component_filter *self_component);

extern struct bt_self_component_port_output *
bt_self_component_filter_borrow_output_port_by_name(
		struct bt_self_component_filter *self_component,
		const char *name);

extern struct bt_self_component_port_output *
bt_self_component_filter_borrow_output_port_by_index(
		struct bt_self_component_filter *self_component,
		uint64_t index);

extern enum bt_self_component_status
bt_self_component_filter_add_output_port(
		struct bt_self_component_filter *self_component,
		const char *name, void *data,
		struct bt_self_component_port_output **self_component_port);

extern struct bt_self_component_port_input *
bt_self_component_filter_borrow_input_port_by_name(
		struct bt_self_component_filter *self_component,
		const char *name);

extern struct bt_self_component_port_input *
bt_self_component_filter_borrow_input_port_by_index(
		struct bt_self_component_filter *self_component,
		uint64_t index);

extern enum bt_self_component_status
bt_self_component_filter_add_input_port(
		struct bt_self_component_filter *self_component,
		const char *name, void *data,
		struct bt_self_component_port_input **self_component_port);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H */
Commit	Line	Data
d94d92ac PP	1	#ifndef BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H
	2	#define BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H
	3
	4	/*
	5	* Copyright 2017 Philippe Proulx <pproulx@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
	26	#include <stdint.h>
	27
	28	/* For enum bt_self_component_status */
	29	#include <babeltrace/graph/self-component.h>
	30
	31	#ifdef __cplusplus
	32	extern "C" {
	33	#endif
	34
	35	struct bt_component_filter;
	36	struct bt_self_component;
	37	struct bt_self_component_filter;
	38	struct bt_self_component_port_input;
	39	struct bt_self_component_port_output;
	40
	41	static inline
707b7d35	42	struct bt_self_component *bt_self_component_filter_as_self_component(
d94d92ac PP	43	struct bt_self_component_filter *self_comp_filter)
	44	{
	45	return (void *) self_comp_filter;
	46	}
	47
	48	static inline
0d72b8c3	49	const struct bt_component_filter *
707b7d35	50	bt_self_component_filter_as_component_filter(
d94d92ac PP	51	struct bt_self_component_filter *self_comp_filter)
d94d92ac PP	52	{
0d72b8c3	53	return (const void *) self_comp_filter;
d94d92ac PP	54	}
d94d92ac PP	55
d94d92ac PP	56	extern struct bt_component_filter *bt_component_filter_borrow_from_self(
	57	struct bt_self_component_filter *self_component);
	58
	59	extern struct bt_self_component_port_output *
	60	bt_self_component_filter_borrow_output_port_by_name(
	61	struct bt_self_component_filter *self_component,
	62	const char *name);
	63
	64	extern struct bt_self_component_port_output *
	65	bt_self_component_filter_borrow_output_port_by_index(
	66	struct bt_self_component_filter *self_component,
	67	uint64_t index);
	68
	69	extern enum bt_self_component_status
	70	bt_self_component_filter_add_output_port(
	71	struct bt_self_component_filter *self_component,
	72	const char name, void data,
	73	struct bt_self_component_port_output **self_component_port);
	74
	75	extern struct bt_self_component_port_input *
	76	bt_self_component_filter_borrow_input_port_by_name(
	77	struct bt_self_component_filter *self_component,
	78	const char *name);
	79
	80	extern struct bt_self_component_port_input *
	81	bt_self_component_filter_borrow_input_port_by_index(
	82	struct bt_self_component_filter *self_component,
	83	uint64_t index);
	84
	85	extern enum bt_self_component_status
	86	bt_self_component_filter_add_input_port(
	87	struct bt_self_component_filter *self_component,
	88	const char name, void data,
	89	struct bt_self_component_port_input **self_component_port);
	90
	91	#ifdef __cplusplus
	92	}
	93	#endif
	94
	95	#endif /* BABELTRACE_GRAPH_SELF_COMPONENT_FILTER_H */