Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_VALUE_CONST_H |
2 | #define BABELTRACE2_VALUE_CONST_H | |
05e21286 PP |
3 | |
4 | /* | |
bbb7b5f0 | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
05e21286 PP |
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 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
05e21286 PP |
30 | #include <stdint.h> |
31 | #include <stddef.h> | |
32 | ||
3fadfbc0 | 33 | #include <babeltrace2/types.h> |
05e21286 | 34 | |
05e21286 PP |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
38 | ||
4cdfc5e8 | 39 | typedef enum bt_value_type { |
40f4ba76 | 40 | /// Null value object. |
fdd3a2da | 41 | BT_VALUE_TYPE_NULL = 0, |
40f4ba76 PP |
42 | |
43 | /// Boolean value object (holds #BT_TRUE or #BT_FALSE). | |
fdd3a2da | 44 | BT_VALUE_TYPE_BOOL = 1, |
40f4ba76 | 45 | |
fdd3a2da PP |
46 | /// Unsigned integer value object (holds an unsigned 64-bit integer raw value). |
47 | BT_VALUE_TYPE_UNSIGNED_INTEGER = 2, | |
48 | ||
49 | /// Signed integer value object (holds a signed 64-bit integer raw value). | |
50 | BT_VALUE_TYPE_SIGNED_INTEGER = 3, | |
40f4ba76 PP |
51 | |
52 | /// Floating point number value object (holds a \c double raw value). | |
fdd3a2da | 53 | BT_VALUE_TYPE_REAL = 4, |
40f4ba76 PP |
54 | |
55 | /// String value object. | |
fdd3a2da | 56 | BT_VALUE_TYPE_STRING = 5, |
40f4ba76 PP |
57 | |
58 | /// Array value object. | |
fdd3a2da | 59 | BT_VALUE_TYPE_ARRAY = 6, |
40f4ba76 PP |
60 | |
61 | /// Map value object. | |
fdd3a2da | 62 | BT_VALUE_TYPE_MAP = 7, |
4cdfc5e8 | 63 | } bt_value_type; |
40f4ba76 | 64 | |
4cdfc5e8 | 65 | extern bt_value_type bt_value_get_type(const bt_value *object); |
05e21286 PP |
66 | |
67 | static inline | |
b19ff26f | 68 | bt_bool bt_value_is_null(const bt_value *object) |
05e21286 PP |
69 | { |
70 | return bt_value_get_type(object) == BT_VALUE_TYPE_NULL; | |
71 | } | |
72 | ||
73 | static inline | |
b19ff26f | 74 | bt_bool bt_value_is_bool(const bt_value *object) |
05e21286 PP |
75 | { |
76 | return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL; | |
77 | } | |
78 | ||
79 | static inline | |
fdd3a2da PP |
80 | bt_bool bt_value_is_unsigned_integer(const bt_value *object) |
81 | { | |
82 | return bt_value_get_type(object) == BT_VALUE_TYPE_UNSIGNED_INTEGER; | |
83 | } | |
84 | ||
85 | static inline | |
86 | bt_bool bt_value_is_signed_integer(const bt_value *object) | |
05e21286 | 87 | { |
fdd3a2da | 88 | return bt_value_get_type(object) == BT_VALUE_TYPE_SIGNED_INTEGER; |
05e21286 PP |
89 | } |
90 | ||
91 | static inline | |
b19ff26f | 92 | bt_bool bt_value_is_real(const bt_value *object) |
05e21286 PP |
93 | { |
94 | return bt_value_get_type(object) == BT_VALUE_TYPE_REAL; | |
95 | } | |
96 | ||
97 | static inline | |
b19ff26f | 98 | bt_bool bt_value_is_string(const bt_value *object) |
05e21286 PP |
99 | { |
100 | return bt_value_get_type(object) == BT_VALUE_TYPE_STRING; | |
101 | } | |
102 | ||
103 | static inline | |
b19ff26f | 104 | bt_bool bt_value_is_array(const bt_value *object) |
05e21286 PP |
105 | { |
106 | return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY; | |
107 | } | |
108 | ||
109 | static inline | |
b19ff26f | 110 | bt_bool bt_value_is_map(const bt_value *object) |
05e21286 PP |
111 | { |
112 | return bt_value_get_type(object) == BT_VALUE_TYPE_MAP; | |
113 | } | |
114 | ||
d24d5663 PP |
115 | typedef enum bt_value_copy_status { |
116 | BT_VALUE_COPY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
117 | BT_VALUE_COPY_STATUS_OK = __BT_FUNC_STATUS_OK, | |
118 | } bt_value_copy_status; | |
119 | ||
120 | extern bt_value_copy_status bt_value_copy(const bt_value *object, | |
b19ff26f | 121 | bt_value **copy); |
05e21286 | 122 | |
b19ff26f PP |
123 | extern bt_bool bt_value_compare(const bt_value *object_a, |
124 | const bt_value *object_b); | |
05e21286 | 125 | |
b19ff26f | 126 | extern bt_bool bt_value_bool_get(const bt_value *bool_obj); |
05e21286 | 127 | |
9c08c816 | 128 | extern uint64_t bt_value_integer_unsigned_get(const bt_value *integer_obj); |
fdd3a2da | 129 | |
9c08c816 | 130 | extern int64_t bt_value_integer_signed_get(const bt_value *integer_obj); |
05e21286 | 131 | |
b19ff26f | 132 | extern double bt_value_real_get(const bt_value *real_obj); |
05e21286 | 133 | |
b19ff26f | 134 | extern const char *bt_value_string_get(const bt_value *string_obj); |
05e21286 | 135 | |
b19ff26f | 136 | extern uint64_t bt_value_array_get_size(const bt_value *array_obj); |
05e21286 PP |
137 | |
138 | static inline | |
b19ff26f | 139 | bt_bool bt_value_array_is_empty(const bt_value *array_obj) |
05e21286 PP |
140 | { |
141 | return bt_value_array_get_size(array_obj) == 0; | |
142 | } | |
143 | ||
b19ff26f PP |
144 | extern const bt_value *bt_value_array_borrow_element_by_index_const( |
145 | const bt_value *array_obj, uint64_t index); | |
05e21286 | 146 | |
b19ff26f | 147 | extern uint64_t bt_value_map_get_size(const bt_value *map_obj); |
05e21286 PP |
148 | |
149 | static inline | |
b19ff26f | 150 | bt_bool bt_value_map_is_empty(const bt_value *map_obj) |
05e21286 PP |
151 | { |
152 | return bt_value_map_get_size(map_obj) == 0; | |
153 | } | |
154 | ||
b19ff26f PP |
155 | extern const bt_value *bt_value_map_borrow_entry_value_const( |
156 | const bt_value *map_obj, const char *key); | |
05e21286 | 157 | |
40f4ba76 | 158 | typedef bt_bool (* bt_value_map_foreach_entry_const_func)(const char *key, |
b19ff26f | 159 | const bt_value *object, void *data); |
05e21286 | 160 | |
d24d5663 PP |
161 | typedef enum bt_value_map_foreach_entry_const_status { |
162 | BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
163 | BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK = __BT_FUNC_STATUS_OK, | |
9b4f9b42 | 164 | BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_INTERRUPTED = __BT_FUNC_STATUS_INTERRUPTED, |
d24d5663 PP |
165 | } bt_value_map_foreach_entry_const_status; |
166 | ||
167 | extern bt_value_map_foreach_entry_const_status bt_value_map_foreach_entry_const( | |
b19ff26f | 168 | const bt_value *map_obj, |
40f4ba76 | 169 | bt_value_map_foreach_entry_const_func func, void *data); |
05e21286 | 170 | |
b19ff26f | 171 | extern bt_bool bt_value_map_has_entry(const bt_value *map_obj, |
05e21286 PP |
172 | const char *key); |
173 | ||
d24d5663 PP |
174 | typedef enum bt_value_map_extend_status { |
175 | BT_VALUE_MAP_EXTEND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
176 | BT_VALUE_MAP_EXTEND_STATUS_OK = __BT_FUNC_STATUS_OK, | |
177 | } bt_value_map_extend_status; | |
178 | ||
179 | extern bt_value_map_extend_status bt_value_map_extend( | |
b19ff26f PP |
180 | const bt_value *base_map_obj, |
181 | const bt_value *extension_map_obj, | |
182 | bt_value **extended_map_obj); | |
05e21286 | 183 | |
b19ff26f | 184 | extern void bt_value_get_ref(const bt_value *value); |
c5b9b441 | 185 | |
b19ff26f | 186 | extern void bt_value_put_ref(const bt_value *value); |
c5b9b441 PP |
187 | |
188 | #define BT_VALUE_PUT_REF_AND_RESET(_var) \ | |
189 | do { \ | |
190 | bt_value_put_ref(_var); \ | |
191 | (_var) = NULL; \ | |
192 | } while (0) | |
193 | ||
194 | #define BT_VALUE_MOVE_REF(_var_dst, _var_src) \ | |
195 | do { \ | |
196 | bt_value_put_ref(_var_dst); \ | |
197 | (_var_dst) = (_var_src); \ | |
198 | (_var_src) = NULL; \ | |
199 | } while (0) | |
200 | ||
05e21286 PP |
201 | #ifdef __cplusplus |
202 | } | |
203 | #endif | |
204 | ||
924dc299 | 205 | #endif /* BABELTRACE2_VALUE_CONST_H */ |