Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H |
2 | #define BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H | |
43de0e13 JG |
3 | |
4 | /* | |
bbb7b5f0 | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
43de0e13 JG |
6 | * |
7 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
8 | * of this software and associated documentation files (the "Software"), to deal | |
9 | * in the Software without restriction, including without limitation the rights | |
10 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
11 | * copies of the Software, and to permit persons to whom the Software is | |
12 | * furnished to do so, subject to the following conditions: | |
13 | * | |
14 | * The above copyright notice and this permission notice shall be included in | |
15 | * all copies or substantial portions of the Software. | |
16 | * | |
17 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
18 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
19 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
20 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
21 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
22 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
23 | * SOFTWARE. | |
24 | */ | |
25 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
3fadfbc0 | 30 | #include <babeltrace2/types.h> |
30d619df | 31 | |
43de0e13 JG |
32 | #ifdef __cplusplus |
33 | extern "C" { | |
34 | #endif | |
35 | ||
4cdfc5e8 | 36 | typedef enum bt_component_class_type { |
9c3869a9 PP |
37 | BT_COMPONENT_CLASS_TYPE_SOURCE = 1 << 0, |
38 | BT_COMPONENT_CLASS_TYPE_FILTER = 1 << 1, | |
39 | BT_COMPONENT_CLASS_TYPE_SINK = 1 << 2, | |
4cdfc5e8 | 40 | } bt_component_class_type; |
8738a040 | 41 | |
0d72b8c3 | 42 | extern const char *bt_component_class_get_name( |
b19ff26f | 43 | const bt_component_class *component_class); |
0d72b8c3 PP |
44 | |
45 | extern const char *bt_component_class_get_description( | |
b19ff26f | 46 | const bt_component_class *component_class); |
47e5a032 | 47 | |
0d72b8c3 | 48 | extern const char *bt_component_class_get_help( |
b19ff26f | 49 | const bt_component_class *component_class); |
0d72b8c3 | 50 | |
4cdfc5e8 | 51 | extern bt_component_class_type bt_component_class_get_type( |
b19ff26f | 52 | const bt_component_class *component_class); |
d3e4dcd8 | 53 | |
543147fa | 54 | static inline |
0d72b8c3 | 55 | bt_bool bt_component_class_is_source( |
b19ff26f | 56 | const bt_component_class *component_class) |
543147fa | 57 | { |
0d72b8c3 | 58 | return bt_component_class_get_type(component_class) == |
543147fa PP |
59 | BT_COMPONENT_CLASS_TYPE_SOURCE; |
60 | } | |
61 | ||
62 | static inline | |
0d72b8c3 | 63 | bt_bool bt_component_class_is_filter( |
b19ff26f | 64 | const bt_component_class *component_class) |
543147fa | 65 | { |
0d72b8c3 | 66 | return bt_component_class_get_type(component_class) == |
543147fa PP |
67 | BT_COMPONENT_CLASS_TYPE_FILTER; |
68 | } | |
69 | ||
70 | static inline | |
0d72b8c3 | 71 | bt_bool bt_component_class_is_sink( |
b19ff26f | 72 | const bt_component_class *component_class) |
543147fa | 73 | { |
0d72b8c3 | 74 | return bt_component_class_get_type(component_class) == |
543147fa PP |
75 | BT_COMPONENT_CLASS_TYPE_SINK; |
76 | } | |
77 | ||
c5b9b441 | 78 | extern void bt_component_class_get_ref( |
b19ff26f | 79 | const bt_component_class *component_class); |
c5b9b441 PP |
80 | |
81 | extern void bt_component_class_put_ref( | |
b19ff26f | 82 | const bt_component_class *component_class); |
c5b9b441 PP |
83 | |
84 | #define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_var) \ | |
85 | do { \ | |
86 | bt_component_class_put_ref(_var); \ | |
87 | (_var) = NULL; \ | |
88 | } while (0) | |
89 | ||
90 | #define BT_COMPONENT_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
91 | do { \ | |
92 | bt_component_class_put_ref(_var_dst); \ | |
93 | (_var_dst) = (_var_src); \ | |
94 | (_var_src) = NULL; \ | |
95 | } while (0) | |
96 | ||
43de0e13 JG |
97 | #ifdef __cplusplus |
98 | } | |
99 | #endif | |
100 | ||
924dc299 | 101 | #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H */ |