1 #ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
2 #define BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
27 /* For bt_bool, bt_component_class */
28 #include <babeltrace/types.h>
34 typedef enum bt_component_class_status
{
35 BT_COMPONENT_CLASS_STATUS_OK
= 0,
36 BT_COMPONENT_CLASS_STATUS_NOMEM
= -12,
37 } bt_component_class_status
;
39 typedef enum bt_component_class_type
{
40 BT_COMPONENT_CLASS_TYPE_SOURCE
= 0,
41 BT_COMPONENT_CLASS_TYPE_FILTER
= 1,
42 BT_COMPONENT_CLASS_TYPE_SINK
= 2,
43 } bt_component_class_type
;
45 extern const char *bt_component_class_get_name(
46 const bt_component_class
*component_class
);
48 extern const char *bt_component_class_get_description(
49 const bt_component_class
*component_class
);
51 extern const char *bt_component_class_get_help(
52 const bt_component_class
*component_class
);
54 extern bt_component_class_type
bt_component_class_get_type(
55 const bt_component_class
*component_class
);
58 bt_bool
bt_component_class_is_source(
59 const bt_component_class
*component_class
)
61 return bt_component_class_get_type(component_class
) ==
62 BT_COMPONENT_CLASS_TYPE_SOURCE
;
66 bt_bool
bt_component_class_is_filter(
67 const bt_component_class
*component_class
)
69 return bt_component_class_get_type(component_class
) ==
70 BT_COMPONENT_CLASS_TYPE_FILTER
;
74 bt_bool
bt_component_class_is_sink(
75 const bt_component_class
*component_class
)
77 return bt_component_class_get_type(component_class
) ==
78 BT_COMPONENT_CLASS_TYPE_SINK
;
81 extern void bt_component_class_get_ref(
82 const bt_component_class
*component_class
);
84 extern void bt_component_class_put_ref(
85 const bt_component_class
*component_class
);
87 #define BT_COMPONENT_CLASS_PUT_REF_AND_RESET(_var) \
89 bt_component_class_put_ref(_var); \
93 #define BT_COMPONENT_CLASS_MOVE_REF(_var_dst, _var_src) \
95 bt_component_class_put_ref(_var_dst); \
96 (_var_dst) = (_var_src); \
104 #endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */