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