da46d290cbfa6eaac47920bcbf0348eaea1e9234
[babeltrace.git] / include / babeltrace2 / graph / component-class-const.h
1 #ifndef BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H
2 #define BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H
3
4 /*
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
28 #endif
29
30 #include <babeltrace2/types.h>
31
32 #ifdef __cplusplus
33 extern "C" {
34 #endif
35
36 typedef enum bt_component_class_type {
37 BT_COMPONENT_CLASS_TYPE_SOURCE = 1 << 0,
38 BT_COMPONENT_CLASS_TYPE_FILTER = 1 << 1,
39 BT_COMPONENT_CLASS_TYPE_SINK = 1 << 2,
40 } bt_component_class_type;
41
42 extern const char *bt_component_class_get_name(
43 const bt_component_class *component_class);
44
45 extern const char *bt_component_class_get_description(
46 const bt_component_class *component_class);
47
48 extern const char *bt_component_class_get_help(
49 const bt_component_class *component_class);
50
51 extern bt_component_class_type bt_component_class_get_type(
52 const bt_component_class *component_class);
53
54 static inline
55 bt_bool bt_component_class_is_source(
56 const bt_component_class *component_class)
57 {
58 return bt_component_class_get_type(component_class) ==
59 BT_COMPONENT_CLASS_TYPE_SOURCE;
60 }
61
62 static inline
63 bt_bool bt_component_class_is_filter(
64 const bt_component_class *component_class)
65 {
66 return bt_component_class_get_type(component_class) ==
67 BT_COMPONENT_CLASS_TYPE_FILTER;
68 }
69
70 static inline
71 bt_bool bt_component_class_is_sink(
72 const bt_component_class *component_class)
73 {
74 return bt_component_class_get_type(component_class) ==
75 BT_COMPONENT_CLASS_TYPE_SINK;
76 }
77
78 extern void bt_component_class_get_ref(
79 const bt_component_class *component_class);
80
81 extern void bt_component_class_put_ref(
82 const 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
97 #ifdef __cplusplus
98 }
99 #endif
100
101 #endif /* BABELTRACE2_GRAPH_COMPONENT_CLASS_CONST_H */
This page took 0.041957 seconds and 3 git commands to generate.