projects / babeltrace.git / blame
| Commit | Line | Data |
|---|---|---|
| 1ca80abd PP |
1 | #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_H |
| 2 | #define BABELTRACE_GRAPH_COMPONENT_CLASS_H | |
| fc11e32c JG |
3 | |
| 4 | /* | |
| fc11e32c JG |
5 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
| 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 | ||
| 9d408fca | 26 | /* For bt_bool */ |
| c55a9f58 | 27 | #include <babeltrace/types.h> |
| 33b34c43 | 28 | |
| fc11e32c JG |
29 | #ifdef __cplusplus |
| 30 | extern "C" { | |
| 31 | #endif | |
| 32 | ||
| fc11e32c JG |
33 | struct bt_component_class; |
| 34 | ||
| d3e4dcd8 | 35 | enum bt_component_class_type { |
| d3e4dcd8 | 36 | BT_COMPONENT_CLASS_TYPE_SOURCE = 0, |
| d94d92ac PP |
37 | BT_COMPONENT_CLASS_TYPE_FILTER = 1, |
| 38 | BT_COMPONENT_CLASS_TYPE_SINK = 2, | |
| d3e4dcd8 PP |
39 | }; |
| 40 | ||
| 38b48196 JG |
41 | extern const char *bt_component_class_get_name( |
| 42 | struct bt_component_class *component_class); | |
| 43 | ||
| f3bc2010 | 44 | extern const char *bt_component_class_get_description( |
| 7c7c0433 JG |
45 | struct bt_component_class *component_class); |
| 46 | ||
| 5536d9a6 PP |
47 | extern const char *bt_component_class_get_help( |
| 48 | struct bt_component_class *component_class); | |
| 49 | ||
| d3e4dcd8 | 50 | extern enum bt_component_class_type bt_component_class_get_type( |
| fc11e32c JG |
51 | struct bt_component_class *component_class); |
| 52 | ||
| 2154eb7d | 53 | static inline |
| c55a9f58 | 54 | bt_bool bt_component_class_is_source(struct bt_component_class *component_class) |
| 2154eb7d PP |
55 | { |
| 56 | return bt_component_class_get_type(component_class) == | |
| 57 | BT_COMPONENT_CLASS_TYPE_SOURCE; | |
| 58 | } | |
| 59 | ||
| 60 | static inline | |
| c55a9f58 | 61 | bt_bool bt_component_class_is_filter(struct bt_component_class *component_class) |
| 2154eb7d PP |
62 | { |
| 63 | return bt_component_class_get_type(component_class) == | |
| 64 | BT_COMPONENT_CLASS_TYPE_FILTER; | |
| 65 | } | |
| 66 | ||
| 67 | static inline | |
| c55a9f58 | 68 | bt_bool bt_component_class_is_sink(struct bt_component_class *component_class) |
| 2154eb7d PP |
69 | { |
| 70 | return bt_component_class_get_type(component_class) == | |
| 71 | BT_COMPONENT_CLASS_TYPE_SINK; | |
| 72 | } | |
| 73 | ||
| d3e4dcd8 PP |
74 | #ifdef __cplusplus |
| 75 | } | |
| 76 | #endif | |
| 77 | ||
| 1ca80abd | 78 | #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_H */ |