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