1 #ifndef BABELTRACE2_VALUE_CONST_H
2 #define BABELTRACE2_VALUE_CONST_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
33 #include <babeltrace2/types.h>
39 typedef enum bt_value_type
{
40 /// Null value object.
41 BT_VALUE_TYPE_NULL
= 1 << 0,
43 /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
44 BT_VALUE_TYPE_BOOL
= 1 << 1,
46 BT_VALUE_TYPE_INTEGER
= 1 << 2,
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
,
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
,
54 /// Floating point number value object (holds a \c double raw value).
55 BT_VALUE_TYPE_REAL
= 1 << 5,
57 /// String value object.
58 BT_VALUE_TYPE_STRING
= 1 << 6,
60 /// Array value object.
61 BT_VALUE_TYPE_ARRAY
= 1 << 7,
64 BT_VALUE_TYPE_MAP
= 1 << 8,
67 extern bt_value_type
bt_value_get_type(const bt_value
*object
);
70 bt_bool
bt_value_type_is(const bt_value_type type
,
71 const bt_value_type type_to_check
)
73 return (type
& type_to_check
) == type_to_check
;
77 bt_bool
bt_value_is_null(const bt_value
*object
)
79 return bt_value_get_type(object
) == BT_VALUE_TYPE_NULL
;
83 bt_bool
bt_value_is_bool(const bt_value
*object
)
85 return bt_value_get_type(object
) == BT_VALUE_TYPE_BOOL
;
89 bt_bool
bt_value_is_unsigned_integer(const bt_value
*object
)
91 return bt_value_get_type(object
) == BT_VALUE_TYPE_UNSIGNED_INTEGER
;
95 bt_bool
bt_value_is_signed_integer(const bt_value
*object
)
97 return bt_value_get_type(object
) == BT_VALUE_TYPE_SIGNED_INTEGER
;
101 bt_bool
bt_value_is_real(const bt_value
*object
)
103 return bt_value_get_type(object
) == BT_VALUE_TYPE_REAL
;
107 bt_bool
bt_value_is_string(const bt_value
*object
)
109 return bt_value_get_type(object
) == BT_VALUE_TYPE_STRING
;
113 bt_bool
bt_value_is_array(const bt_value
*object
)
115 return bt_value_get_type(object
) == BT_VALUE_TYPE_ARRAY
;
119 bt_bool
bt_value_is_map(const bt_value
*object
)
121 return bt_value_get_type(object
) == BT_VALUE_TYPE_MAP
;
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
;
129 extern bt_value_copy_status
bt_value_copy(const bt_value
*object
,
132 extern bt_bool
bt_value_is_equal(const bt_value
*object_a
,
133 const bt_value
*object_b
);
135 extern bt_bool
bt_value_bool_get(const bt_value
*bool_obj
);
137 extern uint64_t bt_value_integer_unsigned_get(const bt_value
*integer_obj
);
139 extern int64_t bt_value_integer_signed_get(const bt_value
*integer_obj
);
141 extern double bt_value_real_get(const bt_value
*real_obj
);
143 extern const char *bt_value_string_get(const bt_value
*string_obj
);
145 extern uint64_t bt_value_array_get_length(const bt_value
*array_obj
);
148 bt_bool
bt_value_array_is_empty(const bt_value
*array_obj
)
150 return bt_value_array_get_length(array_obj
) == 0;
153 extern const bt_value
*bt_value_array_borrow_element_by_index_const(
154 const bt_value
*array_obj
, uint64_t index
);
156 extern uint64_t bt_value_map_get_size(const bt_value
*map_obj
);
159 bt_bool
bt_value_map_is_empty(const bt_value
*map_obj
)
161 return bt_value_map_get_size(map_obj
) == 0;
164 extern const bt_value
*bt_value_map_borrow_entry_value_const(
165 const bt_value
*map_obj
, const char *key
);
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
;
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
);
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
;
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
);
190 extern bt_bool
bt_value_map_has_entry(const bt_value
*map_obj
,
193 extern void bt_value_get_ref(const bt_value
*value
);
195 extern void bt_value_put_ref(const bt_value
*value
);
197 #define BT_VALUE_PUT_REF_AND_RESET(_var) \
199 bt_value_put_ref(_var); \
203 #define BT_VALUE_MOVE_REF(_var_dst, _var_src) \
205 bt_value_put_ref(_var_dst); \
206 (_var_dst) = (_var_src); \
214 #endif /* BABELTRACE2_VALUE_CONST_H */