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

#ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H
#define BABELTRACE_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.
 */

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

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

#ifdef __cplusplus
extern "C" {
#endif

struct bt_component_class;
struct bt_component_graph;
struct bt_component;
struct bt_value;
struct bt_port;

/**
 * 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 struct bt_component *component);

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

extern enum bt_component_class_type bt_component_get_class_type(
		const struct bt_component *component);

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

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

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

extern bt_bool bt_component_graph_is_canceled(
		const struct bt_component *component);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_GRAPH_COMPONENT_CONST_H
	2	#define BABELTRACE_GRAPH_COMPONENT_CONST_H
	3
	4	/*
	5	* Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
	6	* Copyright 2015 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 enum bt_component_class_type */
	28	#include <babeltrace/graph/component-class-const.h>
	29
	30	/* For bt_bool */
	31	#include <babeltrace/types.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	struct bt_component_class;
	38	struct bt_component_graph;
	39	struct bt_component;
	40	struct bt_value;
	41	struct bt_port;
	42
	43	/**
	44	* Get component's name.
	45	*
	46	* @param component Component instance of which to get the name
	47	* @returns Returns a pointer to the component's name
	48	*/
	49	extern const char bt_component_get_name(const struct bt_component component);
	50
	51	/**
	52	* Get component's class.
	53	*
	54	* @param component Component instance of which to get the class
	55	* @returns The component's class
	56	*/
	57	extern const struct bt_component_class *bt_component_borrow_class_const(
	58	const struct bt_component *component);
	59
	60	extern enum bt_component_class_type bt_component_get_class_type(
	61	const struct bt_component *component);
	62
	63	static inline
	64	bt_bool bt_component_is_source(const struct bt_component *component)
	65	{
	66	return bt_component_get_class_type(component) ==
	67	BT_COMPONENT_CLASS_TYPE_SOURCE;
	68	}
	69
	70	static inline
	71	bt_bool bt_component_is_filter(const struct bt_component *component)
	72	{
	73	return bt_component_get_class_type(component) ==
	74	BT_COMPONENT_CLASS_TYPE_FILTER;
	75	}
	76
	77	static inline
	78	bt_bool bt_component_is_sink(const struct bt_component *component)
	79	{
	80	return bt_component_get_class_type(component) ==
	81	BT_COMPONENT_CLASS_TYPE_SINK;
	82	}
	83
	84	extern bt_bool bt_component_graph_is_canceled(
	85	const struct bt_component *component);
	86
	87	#ifdef __cplusplus
	88	}
	89	#endif
	90
	91	#endif /* BABELTRACE_GRAPH_COMPONENT_CONST_H */