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

#ifndef BABELTRACE2_GRAPH_COMPONENT_CONST_H
#define BABELTRACE2_GRAPH_COMPONENT_CONST_H

/*
 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
 * Copyright 2015 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.
 */

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

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

/*
 * For bt_bool, bt_component_class, bt_component_graph, bt_component,
 * bt_value, bt_port
 */
#include <babeltrace2/types.h>

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

#ifdef __cplusplus
extern "C" {
#endif

/**
 * Get component's name.
 *
 * @param component	Component instance of which to get the name
 * @returns		Returns a pointer to the component's name
 */
extern const char *bt_component_get_name(const bt_component *component);

extern bt_logging_level bt_component_get_logging_level(
		const bt_component *component);

/**
 * Get component's class.
 *
 * @param component	Component instance of which to get the class
 * @returns		The component's class
 */
extern const bt_component_class *bt_component_borrow_class_const(
		const bt_component *component);

extern bt_component_class_type bt_component_get_class_type(
		const bt_component *component);

static inline
bt_bool bt_component_is_source(const bt_component *component)
{
	return bt_component_get_class_type(component) ==
		BT_COMPONENT_CLASS_TYPE_SOURCE;
}

static inline
bt_bool bt_component_is_filter(const bt_component *component)
{
	return bt_component_get_class_type(component) ==
		BT_COMPONENT_CLASS_TYPE_FILTER;
}

static inline
bt_bool bt_component_is_sink(const bt_component *component)
{
	return bt_component_get_class_type(component) ==
		BT_COMPONENT_CLASS_TYPE_SINK;
}

extern bt_bool bt_component_graph_is_canceled(
		const bt_component *component);

extern void bt_component_get_ref(const bt_component *component);

extern void bt_component_put_ref(const bt_component *component);

#define BT_COMPONENT_PUT_REF_AND_RESET(_var)		\
	do {						\
		bt_component_put_ref(_var);		\
		(_var) = NULL;				\
	} while (0)

#define BT_COMPONENT_MOVE_REF(_var_dst, _var_src)	\
	do {						\
		bt_component_put_ref(_var_dst);		\
		(_var_dst) = (_var_src);		\
		(_var_src) = NULL;			\
	} while (0)

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE2_GRAPH_COMPONENT_CONST_H */
Commit	Line	Data
924dc299 PP	1	#ifndef BABELTRACE2_GRAPH_COMPONENT_CONST_H
924dc299 PP	2	#define BABELTRACE2_GRAPH_COMPONENT_CONST_H
43de0e13 JG	3
43de0e13 JG	4	/*
e2f7325d	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
43de0e13 JG	6	* Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com>
43de0e13 JG	7	*
43de0e13 JG	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
4fa90f32 PP	27	#ifndef __BT_IN_BABELTRACE_H
	28	# error "Please include <babeltrace2/babeltrace.h> instead."
	29	#endif
	30
4cdfc5e8	31	/* For bt_component_class_type */
3fadfbc0	32	#include <babeltrace2/graph/component-class-const.h>
9d408fca	33
b19ff26f PP	34	/*
	35	* For bt_bool, bt_component_class, bt_component_graph, bt_component,
	36	* bt_value, bt_port
	37	*/
3fadfbc0	38	#include <babeltrace2/types.h>
30d619df	39
e874da19 PP	40	/* For bt_logging_level */
	41	#include <babeltrace2/logging.h>
	42
43de0e13 JG	43	#ifdef __cplusplus
	44	extern "C" {
	45	#endif
	46
d97bac96	47	/**
33b34c43	48	* Get component's name.
d97bac96	49	*
33b34c43 PP	50	* @param component Component instance of which to get the name
33b34c43 PP	51	* @returns Returns a pointer to the component's name
d97bac96	52	*/
b19ff26f	53	extern const char bt_component_get_name(const bt_component component);
8738a040	54
e874da19 PP	55	extern bt_logging_level bt_component_get_logging_level(
	56	const bt_component *component);
	57
d97bac96	58	/**
33b34c43	59	* Get component's class.
d97bac96	60	*
33b34c43 PP	61	* @param component Component instance of which to get the class
33b34c43 PP	62	* @returns The component's class
d97bac96	63	*/
b19ff26f PP	64	extern const bt_component_class *bt_component_borrow_class_const(
b19ff26f PP	65	const bt_component *component);
47e5a032	66
4cdfc5e8	67	extern bt_component_class_type bt_component_get_class_type(
b19ff26f	68	const bt_component *component);
d3e4dcd8	69
543147fa	70	static inline
b19ff26f	71	bt_bool bt_component_is_source(const bt_component *component)
543147fa PP	72	{
	73	return bt_component_get_class_type(component) ==
	74	BT_COMPONENT_CLASS_TYPE_SOURCE;
	75	}
	76
	77	static inline
b19ff26f	78	bt_bool bt_component_is_filter(const bt_component *component)
543147fa PP	79	{
	80	return bt_component_get_class_type(component) ==
	81	BT_COMPONENT_CLASS_TYPE_FILTER;
	82	}
	83
	84	static inline
b19ff26f	85	bt_bool bt_component_is_sink(const bt_component *component)
543147fa PP	86	{
	87	return bt_component_get_class_type(component) ==
	88	BT_COMPONENT_CLASS_TYPE_SINK;
	89	}
	90
0d72b8c3	91	extern bt_bool bt_component_graph_is_canceled(
b19ff26f	92	const bt_component *component);
f60c8b34	93
b19ff26f	94	extern void bt_component_get_ref(const bt_component *component);
c5b9b441	95
b19ff26f	96	extern void bt_component_put_ref(const bt_component *component);
c5b9b441 PP	97
	98	#define BT_COMPONENT_PUT_REF_AND_RESET(_var) \
	99	do { \
	100	bt_component_put_ref(_var); \
	101	(_var) = NULL; \
	102	} while (0)
	103
	104	#define BT_COMPONENT_MOVE_REF(_var_dst, _var_src) \
	105	do { \
	106	bt_component_put_ref(_var_dst); \
	107	(_var_dst) = (_var_src); \
	108	(_var_src) = NULL; \
	109	} while (0)
	110
43de0e13 JG	111	#ifdef __cplusplus
	112	}
	113	#endif
	114
924dc299	115	#endif /* BABELTRACE2_GRAPH_COMPONENT_CONST_H */