projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 7b53201c PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H |
| 2 | #define BABELTRACE_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 | ||
| e0831b38 | 27 | /* For bt_bool */ |
| c55a9f58 | 28 | #include <babeltrace/types.h> |
| 30d619df | 29 | |
| 43de0e13 JG |
30 | #ifdef __cplusplus |
| 31 | extern "C" { | |
| 32 | #endif | |
| 33 | ||
| f60c8b34 | 34 | struct bt_component_class; |
| f60c8b34 | 35 | |
| 7b53201c PP |
36 | enum bt_component_class_type { |
| 37 | BT_COMPONENT_CLASS_TYPE_SOURCE = 0, | |
| 38 | BT_COMPONENT_CLASS_TYPE_FILTER = 1, | |
| 39 | BT_COMPONENT_CLASS_TYPE_SINK = 2, | |
| 40 | }; | |
| 8738a040 | 41 | |
| 7b53201c PP |
42 | extern const char *bt_component_class_get_name( |
| 43 | const struct bt_component_class *component_class); | |
| 44 | ||
| 45 | extern const char *bt_component_class_get_description( | |
| 46 | const struct bt_component_class *component_class); | |
| 47e5a032 | 47 | |
| 7b53201c PP |
48 | extern const char *bt_component_class_get_help( |
| 49 | const struct bt_component_class *component_class); | |
| 50 | ||
| 51 | extern enum bt_component_class_type bt_component_class_get_type( | |
| 52 | const struct bt_component_class *component_class); | |
| d3e4dcd8 | 53 | |
| 543147fa | 54 | static inline |
| 7b53201c PP |
55 | bt_bool bt_component_class_is_source( |
| 56 | const struct bt_component_class *component_class) | |
| 543147fa | 57 | { |
| 7b53201c | 58 | return bt_component_class_get_type(component_class) == |
| 543147fa PP |
59 | BT_COMPONENT_CLASS_TYPE_SOURCE; |
| 60 | } | |
| 61 | ||
| 62 | static inline | |
| 7b53201c PP |
63 | bt_bool bt_component_class_is_filter( |
| 64 | const struct bt_component_class *component_class) | |
| 543147fa | 65 | { |
| 7b53201c | 66 | return bt_component_class_get_type(component_class) == |
| 543147fa PP |
67 | BT_COMPONENT_CLASS_TYPE_FILTER; |
| 68 | } | |
| 69 | ||
| 70 | static inline | |
| 7b53201c PP |
71 | bt_bool bt_component_class_is_sink( |
| 72 | const struct bt_component_class *component_class) | |
| 543147fa | 73 | { |
| 7b53201c | 74 | return bt_component_class_get_type(component_class) == |
| 543147fa PP |
75 | BT_COMPONENT_CLASS_TYPE_SINK; |
| 76 | } | |
| 77 | ||
| 8c6884d9 PP |
78 | extern void bt_component_class_get_ref( |
| 79 | const struct bt_component_class *component_class); | |
| 80 | ||
| 81 | extern void bt_component_class_put_ref( | |
| 82 | const struct bt_component_class *component_class); | |
| 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 | ||
| 7b53201c | 101 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */ |