lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / graph / component-class-const.h
CommitLineData
0d72b8c3
PP
1#ifndef BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
2#define BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H
43de0e13
JG
3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
0d72b8c3 6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
43de0e13
JG
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
b19ff26f 27/* For bt_bool, bt_component_class */
3fadfbc0 28#include <babeltrace2/types.h>
30d619df 29
43de0e13
JG
30#ifdef __cplusplus
31extern "C" {
32#endif
33
4cdfc5e8
PP
34typedef 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;
8738a040 39
0d72b8c3 40extern const char *bt_component_class_get_name(
b19ff26f 41 const bt_component_class *component_class);
0d72b8c3
PP
42
43extern const char *bt_component_class_get_description(
b19ff26f 44 const bt_component_class *component_class);
47e5a032 45
0d72b8c3 46extern const char *bt_component_class_get_help(
b19ff26f 47 const bt_component_class *component_class);
0d72b8c3 48
4cdfc5e8 49extern bt_component_class_type bt_component_class_get_type(
b19ff26f 50 const bt_component_class *component_class);
d3e4dcd8 51
543147fa 52static inline
0d72b8c3 53bt_bool bt_component_class_is_source(
b19ff26f 54 const bt_component_class *component_class)
543147fa 55{
0d72b8c3 56 return bt_component_class_get_type(component_class) ==
543147fa
PP
57 BT_COMPONENT_CLASS_TYPE_SOURCE;
58}
59
60static inline
0d72b8c3 61bt_bool bt_component_class_is_filter(
b19ff26f 62 const bt_component_class *component_class)
543147fa 63{
0d72b8c3 64 return bt_component_class_get_type(component_class) ==
543147fa
PP
65 BT_COMPONENT_CLASS_TYPE_FILTER;
66}
67
68static inline
0d72b8c3 69bt_bool bt_component_class_is_sink(
b19ff26f 70 const bt_component_class *component_class)
543147fa 71{
0d72b8c3 72 return bt_component_class_get_type(component_class) ==
543147fa
PP
73 BT_COMPONENT_CLASS_TYPE_SINK;
74}
75
c5b9b441 76extern void bt_component_class_get_ref(
b19ff26f 77 const bt_component_class *component_class);
c5b9b441
PP
78
79extern void bt_component_class_put_ref(
b19ff26f 80 const bt_component_class *component_class);
c5b9b441
PP
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
43de0e13
JG
95#ifdef __cplusplus
96}
97#endif
98
0d72b8c3 99#endif /* BABELTRACE_GRAPH_COMPONENT_CLASS_CONST_H */
This page took 0.058361 seconds and 4 git commands to generate.