Fix: src.ctf.lttng-live: emitting stream end msg with no stream
[babeltrace.git] / include / babeltrace2 / value-const.h
1 #ifndef BABELTRACE2_VALUE_CONST_H
2 #define BABELTRACE2_VALUE_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 <stdint.h>
31 #include <stddef.h>
32
33 #include <babeltrace2/types.h>
34
35 #ifdef __cplusplus
36 extern "C" {
37 #endif
38
39 typedef enum bt_value_type {
40 /// Null value object.
41 BT_VALUE_TYPE_NULL = 1 << 0,
42
43 /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
44 BT_VALUE_TYPE_BOOL = 1 << 1,
45
46 BT_VALUE_TYPE_INTEGER = 1 << 2,
47
48 /// Unsigned integer value object (holds an unsigned 64-bit integer raw value).
49 BT_VALUE_TYPE_UNSIGNED_INTEGER = (1 << 3) | BT_VALUE_TYPE_INTEGER,
50
51 /// Signed integer value object (holds a signed 64-bit integer raw value).
52 BT_VALUE_TYPE_SIGNED_INTEGER = (1 << 4) | BT_VALUE_TYPE_INTEGER,
53
54 /// Floating point number value object (holds a \c double raw value).
55 BT_VALUE_TYPE_REAL = 1 << 5,
56
57 /// String value object.
58 BT_VALUE_TYPE_STRING = 1 << 6,
59
60 /// Array value object.
61 BT_VALUE_TYPE_ARRAY = 1 << 7,
62
63 /// Map value object.
64 BT_VALUE_TYPE_MAP = 1 << 8,
65 } bt_value_type;
66
67 extern bt_value_type bt_value_get_type(const bt_value *object);
68
69 static inline
70 bt_bool bt_value_type_is(const bt_value_type type,
71 const bt_value_type type_to_check)
72 {
73 return (type & type_to_check) == type_to_check;
74 }
75
76 static inline
77 bt_bool bt_value_is_null(const bt_value *object)
78 {
79 return bt_value_get_type(object) == BT_VALUE_TYPE_NULL;
80 }
81
82 static inline
83 bt_bool bt_value_is_bool(const bt_value *object)
84 {
85 return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
86 }
87
88 static inline
89 bt_bool bt_value_is_unsigned_integer(const bt_value *object)
90 {
91 return bt_value_get_type(object) == BT_VALUE_TYPE_UNSIGNED_INTEGER;
92 }
93
94 static inline
95 bt_bool bt_value_is_signed_integer(const bt_value *object)
96 {
97 return bt_value_get_type(object) == BT_VALUE_TYPE_SIGNED_INTEGER;
98 }
99
100 static inline
101 bt_bool bt_value_is_real(const bt_value *object)
102 {
103 return bt_value_get_type(object) == BT_VALUE_TYPE_REAL;
104 }
105
106 static inline
107 bt_bool bt_value_is_string(const bt_value *object)
108 {
109 return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
110 }
111
112 static inline
113 bt_bool bt_value_is_array(const bt_value *object)
114 {
115 return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY;
116 }
117
118 static inline
119 bt_bool bt_value_is_map(const bt_value *object)
120 {
121 return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
122 }
123
124 typedef enum bt_value_copy_status {
125 BT_VALUE_COPY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
126 BT_VALUE_COPY_STATUS_OK = __BT_FUNC_STATUS_OK,
127 } bt_value_copy_status;
128
129 extern bt_value_copy_status bt_value_copy(const bt_value *object,
130 bt_value **copy);
131
132 extern bt_bool bt_value_is_equal(const bt_value *object_a,
133 const bt_value *object_b);
134
135 extern bt_bool bt_value_bool_get(const bt_value *bool_obj);
136
137 extern uint64_t bt_value_integer_unsigned_get(const bt_value *integer_obj);
138
139 extern int64_t bt_value_integer_signed_get(const bt_value *integer_obj);
140
141 extern double bt_value_real_get(const bt_value *real_obj);
142
143 extern const char *bt_value_string_get(const bt_value *string_obj);
144
145 extern uint64_t bt_value_array_get_length(const bt_value *array_obj);
146
147 static inline
148 bt_bool bt_value_array_is_empty(const bt_value *array_obj)
149 {
150 return bt_value_array_get_length(array_obj) == 0;
151 }
152
153 extern const bt_value *bt_value_array_borrow_element_by_index_const(
154 const bt_value *array_obj, uint64_t index);
155
156 extern uint64_t bt_value_map_get_size(const bt_value *map_obj);
157
158 static inline
159 bt_bool bt_value_map_is_empty(const bt_value *map_obj)
160 {
161 return bt_value_map_get_size(map_obj) == 0;
162 }
163
164 extern const bt_value *bt_value_map_borrow_entry_value_const(
165 const bt_value *map_obj, const char *key);
166
167 typedef enum bt_value_map_foreach_entry_const_func_status {
168 BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_OK = __BT_FUNC_STATUS_OK,
169 BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
170 BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
171 BT_VALUE_MAP_FOREACH_ENTRY_CONST_FUNC_STATUS_INTERRUPT = __BT_FUNC_STATUS_INTERRUPTED,
172 } bt_value_map_foreach_entry_const_func_status;
173
174 typedef bt_value_map_foreach_entry_const_func_status
175 (* bt_value_map_foreach_entry_const_func)(const char *key,
176 const bt_value *object, void *data);
177
178 typedef enum bt_value_map_foreach_entry_const_status {
179 BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK = __BT_FUNC_STATUS_OK,
180 BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_ERROR = __BT_FUNC_STATUS_ERROR,
181 BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
182 BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_USER_ERROR = __BT_FUNC_STATUS_USER_ERROR,
183 BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_INTERRUPTED = __BT_FUNC_STATUS_INTERRUPTED,
184 } bt_value_map_foreach_entry_const_status;
185
186 extern bt_value_map_foreach_entry_const_status bt_value_map_foreach_entry_const(
187 const bt_value *map_obj,
188 bt_value_map_foreach_entry_const_func func, void *data);
189
190 extern bt_bool bt_value_map_has_entry(const bt_value *map_obj,
191 const char *key);
192
193 extern void bt_value_get_ref(const bt_value *value);
194
195 extern void bt_value_put_ref(const bt_value *value);
196
197 #define BT_VALUE_PUT_REF_AND_RESET(_var) \
198 do { \
199 bt_value_put_ref(_var); \
200 (_var) = NULL; \
201 } while (0)
202
203 #define BT_VALUE_MOVE_REF(_var_dst, _var_src) \
204 do { \
205 bt_value_put_ref(_var_dst); \
206 (_var_dst) = (_var_src); \
207 (_var_src) = NULL; \
208 } while (0)
209
210 #ifdef __cplusplus
211 }
212 #endif
213
214 #endif /* BABELTRACE2_VALUE_CONST_H */
This page took 0.033432 seconds and 4 git commands to generate.