lib: remove "For *" comments in public headers
[babeltrace.git] / include / babeltrace2 / trace-ir / trace-const.h
1 #ifndef BABELTRACE2_TRACE_IR_TRACE_CONST_H
2 #define BABELTRACE2_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 #ifndef __BT_IN_BABELTRACE_H
31 # error "Please include <babeltrace2/babeltrace.h> instead."
32 #endif
33
34 #include <stdint.h>
35
36 #include <babeltrace2/types.h>
37
38 #ifdef __cplusplus
39 extern "C" {
40 #endif
41
42 typedef void (* bt_trace_destruction_listener_func)(
43 const bt_trace *trace, void *data);
44
45 extern const bt_trace_class *bt_trace_borrow_class_const(
46 const bt_trace *trace);
47
48 extern const char *bt_trace_get_name(const bt_trace *trace);
49
50 extern bt_uuid bt_trace_get_uuid(const bt_trace *trace);
51
52 extern uint64_t bt_trace_get_environment_entry_count(const bt_trace *trace);
53
54 extern void bt_trace_borrow_environment_entry_by_index_const(
55 const bt_trace *trace, uint64_t index,
56 const char **name, const bt_value **value);
57
58 extern const bt_value *bt_trace_borrow_environment_entry_value_by_name_const(
59 const bt_trace *trace, const char *name);
60
61 extern uint64_t bt_trace_get_stream_count(const bt_trace *trace);
62
63 extern const bt_stream *bt_trace_borrow_stream_by_index_const(
64 const bt_trace *trace, uint64_t index);
65
66 extern const bt_stream *bt_trace_borrow_stream_by_id_const(
67 const bt_trace *trace, uint64_t id);
68
69 typedef enum bt_trace_add_listener_status {
70 BT_TRACE_ADD_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
71 BT_TRACE_ADD_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
72 } bt_trace_add_listener_status;
73
74 extern bt_trace_add_listener_status bt_trace_add_destruction_listener(
75 const bt_trace *trace,
76 bt_trace_destruction_listener_func listener,
77 void *data, uint64_t *listener_id);
78
79 typedef enum bt_trace_remove_listener_status {
80 BT_TRACE_REMOVE_LISTENER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
81 BT_TRACE_REMOVE_LISTENER_STATUS_OK = __BT_FUNC_STATUS_OK,
82 } bt_trace_remove_listener_status;
83
84 extern bt_trace_remove_listener_status bt_trace_remove_destruction_listener(
85 const bt_trace *trace, uint64_t listener_id);
86
87 extern void bt_trace_get_ref(const bt_trace *trace);
88
89 extern void bt_trace_put_ref(const bt_trace *trace);
90
91 #define BT_TRACE_PUT_REF_AND_RESET(_var) \
92 do { \
93 bt_trace_put_ref(_var); \
94 (_var) = NULL; \
95 } while (0)
96
97 #define BT_TRACE_MOVE_REF(_var_dst, _var_src) \
98 do { \
99 bt_trace_put_ref(_var_dst); \
100 (_var_dst) = (_var_src); \
101 (_var_src) = NULL; \
102 } while (0)
103
104 #ifdef __cplusplus
105 }
106 #endif
107
108 #endif /* BABELTRACE2_TRACE_IR_TRACE_CONST_H */
This page took 0.034198 seconds and 4 git commands to generate.