Commit | Line | Data |
---|---|---|
0d72b8c3 PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H |
2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H | |
43de0e13 JG |
3 | |
4 | /* | |
e2f7325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
0d72b8c3 | 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 | ||
b19ff26f | 27 | /* For bt_bool, bt_component_class */ |
c55a9f58 | 28 | #include <babeltrace/types.h> |
30d619df | 29 | |
43de0e13 JG |
30 | #ifdef __cplusplus |
31 | extern "C" { | |
32 | #endif | |
33 | ||
d0cf29ee PP |
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 | ||
4cdfc5e8 PP |
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; | |
8738a040 | 44 | |
0d72b8c3 | 45 | extern const char *bt_component_class_get_name( |
b19ff26f | 46 | const bt_component_class *component_class); |
0d72b8c3 PP |
47 | |
48 | extern const char *bt_component_class_get_description( | |
b19ff26f | 49 | const bt_component_class *component_class); |
47e5a032 | 50 | |
0d72b8c3 | 51 | extern const char *bt_component_class_get_help( |
b19ff26f | 52 | const bt_component_class *component_class); |
0d72b8c3 | 53 | |
4cdfc5e8 | 54 | extern bt_component_class_type bt_component_class_get_type( |
b19ff26f | 55 | const bt_component_class *component_class); |
d3e4dcd8 | 56 | |
543147fa | 57 | static inline |
0d72b8c3 | 58 | bt_bool bt_component_class_is_source( |
b19ff26f | 59 | const bt_component_class *component_class) |
543147fa | 60 | { |
0d72b8c3 | 61 | return bt_component_class_get_type(component_class) == |
543147fa PP |
62 | BT_COMPONENT_CLASS_TYPE_SOURCE; |
63 | } | |
64 | ||
65 | static inline | |
0d72b8c3 | 66 | bt_bool bt_component_class_is_filter( |
b19ff26f | 67 | const bt_component_class *component_class) |
543147fa | 68 | { |
0d72b8c3 | 69 | return bt_component_class_get_type(component_class) == |
543147fa PP |
70 | BT_COMPONENT_CLASS_TYPE_FILTER; |
71 | } | |
72 | ||
73 | static inline | |
0d72b8c3 | 74 | bt_bool bt_component_class_is_sink( |
b19ff26f | 75 | const bt_component_class *component_class) |
543147fa | 76 | { |
0d72b8c3 | 77 | return bt_component_class_get_type(component_class) == |
543147fa PP |
78 | BT_COMPONENT_CLASS_TYPE_SINK; |
79 | } | |
80 | ||
c5b9b441 | 81 | extern void bt_component_class_get_ref( |
b19ff26f | 82 | const bt_component_class *component_class); |
c5b9b441 PP |
83 | |
84 | extern void bt_component_class_put_ref( | |
b19ff26f | 85 | const bt_component_class *component_class); |
c5b9b441 PP |
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 | ||
43de0e13 JG |
100 | #ifdef __cplusplus |
101 | } | |
102 | #endif | |
103 | ||
0d72b8c3 | 104 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */ |