lib: strictly type function return status enumerations
[babeltrace.git] / include / babeltrace2 / trace-ir / trace-const.h
1 #ifndef BABELTRACE_TRACE_IR_TRACE_CONST_H
2 #define BABELTRACE_TRACE_IR_TRACE_CONST_H
3
4 /*
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
28 */
29
30 #include <stdint.h>
31
32 /*
33 * For bt_bool, bt_uuid, bt_trace, bt_stream, bt_stream_class,
34 * bt_field_class, bt_value
35 */
36 #include <babeltrace2/types.h>
37
38 /* For __BT_FUNC_STATUS_* */
39 #define __BT_FUNC_STATUS_ENABLE
40 #include <babeltrace2/func-status.h>
41 #undef __BT_FUNC_STATUS_ENABLE
42
43 #ifdef __cplusplus
44 extern "C" {
45 #endif
46
47 typedef void (* bt_trace_destruction_listener_func)(
48 const bt_trace *trace, void *data);
49
50 extern const bt_trace_class *bt_trace_borrow_class_const(
51 const bt_trace *trace);
52
53 extern const char *bt_trace_get_name(const bt_trace *trace);
54
55 extern uint64_t bt_trace_get_stream_count(const bt_trace *trace);
56
57 extern const bt_stream *bt_trace_borrow_stream_by_index_const(
58 const bt_trace *trace, uint64_t index);
59
60 extern const bt_stream *bt_trace_borrow_stream_by_id_const(
61 const bt_trace *trace, uint64_t id);
62
63 typedef enum bt_trace_add_listener_status {
64 BT_TRACE_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
65 BT_TRACE_ADD_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
66 } bt_trace_add_listener_status;
67
68 extern bt_trace_add_listener_status bt_trace_add_destruction_listener(
69 const bt_trace *trace,
70 bt_trace_destruction_listener_func listener,
71 void *data, uint64_t *listener_id);
72
73 typedef enum bt_trace_remove_listener_status {
74 BT_TRACE_REMOVE_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
75 BT_TRACE_REMOVE_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
76 } bt_trace_remove_listener_status;
77
78 extern bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
79 const bt_trace *trace, uint64_t listener_id);
80
81 extern void bt_trace_get_ref(const bt_trace *trace);
82
83 extern void bt_trace_put_ref(const bt_trace *trace);
84
85 #define BT_TRACE_PUT_REF_AND_RESET(_var) \
86 do { \
87 bt_trace_put_ref(_var); \
88 (_var) = NULL; \
89 } while (0)
90
91 #define BT_TRACE_MOVE_REF(_var_dst, _var_src) \
92 do { \
93 bt_trace_put_ref(_var_dst); \
94 (_var_dst) = (_var_src); \
95 (_var_src) = NULL; \
96 } while (0)
97
98 #ifdef __cplusplus
99 }
100 #endif
101
102 #include <babeltrace2/undef-func-status.h>
103
104 #endif /* BABELTRACE_TRACE_IR_TRACE_CONST_H */
This page took 0.0315 seconds and 4 git commands to generate.