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

#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
#define BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_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.
 */

/* For bt_bool, bt_component_class */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

typedef enum bt_component_class_status {
	BT_COMPONENT_CLASS_STATUS_OK = 0,
	BT_COMPONENT_CLASS_STATUS_NOMEM = -12,
} bt_component_class_status;

typedef enum bt_component_class_type {
	BT_COMPONENT_CLASS_TYPE_SOURCE = 0,
	BT_COMPONENT_CLASS_TYPE_FILTER = 1,
	BT_COMPONENT_CLASS_TYPE_SINK = 2,
} bt_component_class_type;

extern const char *bt_component_class_get_name(
		const bt_component_class *component_class);

extern const char *bt_component_class_get_description(
		const bt_component_class *component_class);

extern const char *bt_component_class_get_help(
		const bt_component_class *component_class);

extern bt_component_class_type bt_component_class_get_type(
		const bt_component_class *component_class);

static inline
bt_bool bt_component_class_is_source(
		const bt_component_class *component_class)
{
	return bt_component_class_get_type(component_class) ==
		BT_COMPONENT_CLASS_TYPE_SOURCE;
}

static inline
bt_bool bt_component_class_is_filter(
		const bt_component_class *component_class)
{
	return bt_component_class_get_type(component_class) ==
		BT_COMPONENT_CLASS_TYPE_FILTER;
}

static inline
bt_bool bt_component_class_is_sink(
		const bt_component_class *component_class)
{
	return bt_component_class_get_type(component_class) ==
		BT_COMPONENT_CLASS_TYPE_SINK;
}

extern void bt_component_class_get_ref(
		const bt_component_class *component_class);

extern void bt_component_class_put_ref(
		const bt_component_class *component_class);

#define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_var)	\
	do {						\
		bt_component_class_put_ref(_var);	\
		(_var) = NULL;				\
	} while (0)

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
	2	#define BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_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	/* For bt_bool, bt_component_class */
	28	#include <babeltrace/types.h>
	29
	30	#ifdef __cplusplus
	31	extern "C" {
	32	#endif
	33
	34	typedef enum bt_component_class_status {
	35	BT_COMPONENT_CLASS_STATUS_OK = 0,
	36	BT_COMPONENT_CLASS_STATUS_NOMEM = -12,
	37	} bt_component_class_status;
	38
	39	typedef enum bt_component_class_type {
	40	BT_COMPONENT_CLASS_TYPE_SOURCE = 0,
	41	BT_COMPONENT_CLASS_TYPE_FILTER = 1,
	42	BT_COMPONENT_CLASS_TYPE_SINK = 2,
	43	} bt_component_class_type;
	44
	45	extern const char *bt_component_class_get_name(
	46	const bt_component_class *component_class);
	47
	48	extern const char *bt_component_class_get_description(
	49	const bt_component_class *component_class);
	50
	51	extern const char *bt_component_class_get_help(
	52	const bt_component_class *component_class);
	53
	54	extern bt_component_class_type bt_component_class_get_type(
	55	const bt_component_class *component_class);
	56
	57	static inline
	58	bt_bool bt_component_class_is_source(
	59	const bt_component_class *component_class)
	60	{
	61	return bt_component_class_get_type(component_class) ==
	62	BT_COMPONENT_CLASS_TYPE_SOURCE;
	63	}
	64
	65	static inline
	66	bt_bool bt_component_class_is_filter(
	67	const bt_component_class *component_class)
	68	{
	69	return bt_component_class_get_type(component_class) ==
	70	BT_COMPONENT_CLASS_TYPE_FILTER;
	71	}
	72
	73	static inline
	74	bt_bool bt_component_class_is_sink(
	75	const bt_component_class *component_class)
	76	{
	77	return bt_component_class_get_type(component_class) ==
	78	BT_COMPONENT_CLASS_TYPE_SINK;
	79	}
	80
	81	extern void bt_component_class_get_ref(
	82	const bt_component_class *component_class);
	83
	84	extern void bt_component_class_put_ref(
	85	const bt_component_class *component_class);
	86
	87	#define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_var) \
	88	do { \
	89	bt_component_class_put_ref(_var); \
	90	(_var) = NULL; \
	91	} while (0)
	92
	93	#define BT_COMPONENT_CLASS_MOVE_REF(_var_dst, _var_src) \
	94	do { \
	95	bt_component_class_put_ref(_var_dst); \
	96	(_var_dst) = (_var_src); \
	97	(_var_src) = NULL; \
	98	} while (0)
	99
	100	#ifdef __cplusplus
	101	}
	102	#endif
	103
	104	#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */