Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H |
2 | #define BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H | |
43de0e13 JG |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
7b53201c | 6 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
43de0e13 JG |
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 | ||
9df34b44 PP |
27 | #ifndef __BT_IN_BABELTRACE_H |
28 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
29 | #endif | |
30 | ||
71c5da58 | 31 | #include <babeltrace2/types.h> |
30d619df | 32 | |
43de0e13 JG |
33 | #ifdef __cplusplus |
34 | extern "C" { | |
35 | #endif | |
36 | ||
ee78f405 PP |
37 | typedef enum bt_component_class_type { |
38 | BT_COMPONENT_CLASS_TYPE_SOURCE = 0, | |
39 | BT_COMPONENT_CLASS_TYPE_FILTER = 1, | |
40 | BT_COMPONENT_CLASS_TYPE_SINK = 2, | |
41 | } bt_component_class_type; | |
8738a040 | 42 | |
7b53201c | 43 | extern const char *bt_component_class_get_name( |
8eee8ea2 | 44 | const bt_component_class *component_class); |
7b53201c PP |
45 | |
46 | extern const char *bt_component_class_get_description( | |
8eee8ea2 | 47 | const bt_component_class *component_class); |
47e5a032 | 48 | |
7b53201c | 49 | extern const char *bt_component_class_get_help( |
8eee8ea2 | 50 | const bt_component_class *component_class); |
7b53201c | 51 | |
ee78f405 | 52 | extern bt_component_class_type bt_component_class_get_type( |
8eee8ea2 | 53 | const bt_component_class *component_class); |
d3e4dcd8 | 54 | |
543147fa | 55 | static inline |
7b53201c | 56 | bt_bool bt_component_class_is_source( |
8eee8ea2 | 57 | const bt_component_class *component_class) |
543147fa | 58 | { |
7b53201c | 59 | return bt_component_class_get_type(component_class) == |
543147fa PP |
60 | BT_COMPONENT_CLASS_TYPE_SOURCE; |
61 | } | |
62 | ||
63 | static inline | |
7b53201c | 64 | bt_bool bt_component_class_is_filter( |
8eee8ea2 | 65 | const bt_component_class *component_class) |
543147fa | 66 | { |
7b53201c | 67 | return bt_component_class_get_type(component_class) == |
543147fa PP |
68 | BT_COMPONENT_CLASS_TYPE_FILTER; |
69 | } | |
70 | ||
71 | static inline | |
7b53201c | 72 | bt_bool bt_component_class_is_sink( |
8eee8ea2 | 73 | const bt_component_class *component_class) |
543147fa | 74 | { |
7b53201c | 75 | return bt_component_class_get_type(component_class) == |
543147fa PP |
76 | BT_COMPONENT_CLASS_TYPE_SINK; |
77 | } | |
78 | ||
8c6884d9 | 79 | extern void bt_component_class_get_ref( |
8eee8ea2 | 80 | const bt_component_class *component_class); |
8c6884d9 PP |
81 | |
82 | extern void bt_component_class_put_ref( | |
8eee8ea2 | 83 | const bt_component_class *component_class); |
8c6884d9 PP |
84 | |
85 | #define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_var) \ | |
86 | do { \ | |
87 | bt_component_class_put_ref(_var); \ | |
88 | (_var) = NULL; \ | |
89 | } while (0) | |
90 | ||
91 | #define BT_COMPONENT_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
92 | do { \ | |
93 | bt_component_class_put_ref(_var_dst); \ | |
94 | (_var_dst) = (_var_src); \ | |
95 | (_var_src) = NULL; \ | |
96 | } while (0) | |
97 | ||
43de0e13 JG |
98 | #ifdef __cplusplus |
99 | } | |
100 | #endif | |
101 | ||
3fd40f46 | 102 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H */ |