| 1 | #ifndef BABELTRACE_GRAPH_COMPONENT_H |
| 2 | #define BABELTRACE_GRAPH_COMPONENT_H |
| 3 | |
| 4 | /* |
| 5 | * Copyright 2015 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 6 | * |
| 7 | * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 8 | * |
| 9 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
| 10 | * of this software and associated documentation files (the "Software"), to deal |
| 11 | * in the Software without restriction, including without limitation the rights |
| 12 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell |
| 13 | * copies of the Software, and to permit persons to whom the Software is |
| 14 | * furnished to do so, subject to the following conditions: |
| 15 | * |
| 16 | * The above copyright notice and this permission notice shall be included in |
| 17 | * all copies or substantial portions of the Software. |
| 18 | * |
| 19 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR |
| 20 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, |
| 21 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE |
| 22 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER |
| 23 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
| 24 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
| 25 | * SOFTWARE. |
| 26 | */ |
| 27 | |
| 28 | /* For BT_COMPONENT_CLASS_TYPE_* */ |
| 29 | #include <babeltrace/graph/component-class.h> |
| 30 | |
| 31 | /* For bt_bool */ |
| 32 | #include <babeltrace/types.h> |
| 33 | |
| 34 | #ifdef __cplusplus |
| 35 | extern "C" { |
| 36 | #endif |
| 37 | |
| 38 | struct bt_component_class; |
| 39 | struct bt_component_graph; |
| 40 | struct bt_component; |
| 41 | struct bt_value; |
| 42 | struct bt_port; |
| 43 | |
| 44 | /** |
| 45 | * Get component's name. |
| 46 | * |
| 47 | * @param component Component instance of which to get the name |
| 48 | * @returns Returns a pointer to the component's name |
| 49 | */ |
| 50 | extern const char *bt_component_get_name(struct bt_component *component); |
| 51 | |
| 52 | /** |
| 53 | * Get component's class. |
| 54 | * |
| 55 | * @param component Component instance of which to get the class |
| 56 | * @returns The component's class |
| 57 | */ |
| 58 | extern struct bt_component_class *bt_component_get_class( |
| 59 | struct bt_component *component); |
| 60 | |
| 61 | extern enum bt_component_class_type bt_component_get_class_type( |
| 62 | struct bt_component *component); |
| 63 | |
| 64 | static inline |
| 65 | bt_bool bt_component_is_source(struct bt_component *component) |
| 66 | { |
| 67 | return bt_component_get_class_type(component) == |
| 68 | BT_COMPONENT_CLASS_TYPE_SOURCE; |
| 69 | } |
| 70 | |
| 71 | static inline |
| 72 | bt_bool bt_component_is_filter(struct bt_component *component) |
| 73 | { |
| 74 | return bt_component_get_class_type(component) == |
| 75 | BT_COMPONENT_CLASS_TYPE_FILTER; |
| 76 | } |
| 77 | |
| 78 | static inline |
| 79 | bt_bool bt_component_is_sink(struct bt_component *component) |
| 80 | { |
| 81 | return bt_component_get_class_type(component) == |
| 82 | BT_COMPONENT_CLASS_TYPE_SINK; |
| 83 | } |
| 84 | |
| 85 | extern bt_bool bt_component_graph_is_canceled(struct bt_component *component); |
| 86 | |
| 87 | #ifdef __cplusplus |
| 88 | } |
| 89 | #endif |
| 90 | |
| 91 | #endif /* BABELTRACE_GRAPH_COMPONENT_H */ |