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