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