Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_GRAPH_COMPONENT_CONST_H |
2 | #define BABELTRACE2_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 | ||
9df34b44 PP |
27 | #ifndef __BT_IN_BABELTRACE_H |
28 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
29 | #endif | |
30 | ||
ee78f405 | 31 | /* For bt_component_class_type */ |
71c5da58 | 32 | #include <babeltrace2/graph/component-class-const.h> |
e0831b38 | 33 | |
8eee8ea2 PP |
34 | /* |
35 | * For bt_bool, bt_component_class, bt_component_graph, bt_component, | |
36 | * bt_value, bt_port | |
37 | */ | |
71c5da58 | 38 | #include <babeltrace2/types.h> |
30d619df | 39 | |
cc81b5ab 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 |
51 | * @returns Returns a pointer to the component's name | |
d97bac96 | 52 | */ |
8eee8ea2 | 53 | extern const char *bt_component_get_name(const bt_component *component); |
8738a040 | 54 | |
cc81b5ab 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 |
62 | * @returns The component's class | |
d97bac96 | 63 | */ |
8eee8ea2 PP |
64 | extern const bt_component_class *bt_component_borrow_class_const( |
65 | const bt_component *component); | |
47e5a032 | 66 | |
ee78f405 | 67 | extern bt_component_class_type bt_component_get_class_type( |
8eee8ea2 | 68 | const bt_component *component); |
d3e4dcd8 | 69 | |
543147fa | 70 | static inline |
8eee8ea2 | 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 | |
8eee8ea2 | 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 | |
8eee8ea2 | 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 | ||
7b53201c | 91 | extern bt_bool bt_component_graph_is_canceled( |
8eee8ea2 | 92 | const bt_component *component); |
f60c8b34 | 93 | |
8eee8ea2 | 94 | extern void bt_component_get_ref(const bt_component *component); |
8c6884d9 | 95 | |
8eee8ea2 | 96 | extern void bt_component_put_ref(const bt_component *component); |
8c6884d9 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 | ||
3fd40f46 | 115 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CONST_H */ |