1 #ifndef BABELTRACE_VALUES_CONST_H
2 #define BABELTRACE_VALUES_CONST_H
5 * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
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
30 #include <babeltrace/types.h>
38 enum bt_value_status
{
39 /// Operation canceled.
40 BT_VALUE_STATUS_CANCELED
= 125,
42 /// Cannot allocate memory.
43 BT_VALUE_STATUS_NOMEM
= -12,
46 BT_VALUE_STATUS_OK
= 0,
50 /// Null value object.
51 BT_VALUE_TYPE_NULL
= 0,
53 /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
54 BT_VALUE_TYPE_BOOL
= 1,
56 /// Integer value object (holds a signed 64-bit integer raw value).
57 BT_VALUE_TYPE_INTEGER
= 2,
59 /// Floating point number value object (holds a \c double raw value).
60 BT_VALUE_TYPE_REAL
= 3,
62 /// String value object.
63 BT_VALUE_TYPE_STRING
= 4,
65 /// Array value object.
66 BT_VALUE_TYPE_ARRAY
= 5,
69 BT_VALUE_TYPE_MAP
= 6,
72 extern enum bt_value_type
bt_value_get_type(const struct bt_value
*object
);
75 bt_bool
bt_value_is_null(const struct bt_value
*object
)
77 return bt_value_get_type(object
) == BT_VALUE_TYPE_NULL
;
81 bt_bool
bt_value_is_bool(const struct bt_value
*object
)
83 return bt_value_get_type(object
) == BT_VALUE_TYPE_BOOL
;
87 bt_bool
bt_value_is_integer(const struct bt_value
*object
)
89 return bt_value_get_type(object
) == BT_VALUE_TYPE_INTEGER
;
93 bt_bool
bt_value_is_real(const struct bt_value
*object
)
95 return bt_value_get_type(object
) == BT_VALUE_TYPE_REAL
;
99 bt_bool
bt_value_is_string(const struct bt_value
*object
)
101 return bt_value_get_type(object
) == BT_VALUE_TYPE_STRING
;
105 bt_bool
bt_value_is_array(const struct bt_value
*object
)
107 return bt_value_get_type(object
) == BT_VALUE_TYPE_ARRAY
;
111 bt_bool
bt_value_is_map(const struct bt_value
*object
)
113 return bt_value_get_type(object
) == BT_VALUE_TYPE_MAP
;
116 extern enum bt_value_status
bt_value_copy(const struct bt_value
*object
,
117 struct bt_value
**copy
);
119 extern bt_bool
bt_value_compare(const struct bt_value
*object_a
,
120 const struct bt_value
*object_b
);
122 extern bt_bool
bt_value_bool_get(const struct bt_value
*bool_obj
);
124 extern int64_t bt_value_integer_get(const struct bt_value
*integer_obj
);
126 extern double bt_value_real_get(const struct bt_value
*real_obj
);
128 extern const char *bt_value_string_get(const struct bt_value
*string_obj
);
130 extern uint64_t bt_value_array_get_size(const struct bt_value
*array_obj
);
133 bt_bool
bt_value_array_is_empty(const struct bt_value
*array_obj
)
135 return bt_value_array_get_size(array_obj
) == 0;
138 extern const struct bt_value
*bt_value_array_borrow_element_by_index_const(
139 const struct bt_value
*array_obj
, uint64_t index
);
141 extern uint64_t bt_value_map_get_size(const struct bt_value
*map_obj
);
144 bt_bool
bt_value_map_is_empty(const struct bt_value
*map_obj
)
146 return bt_value_map_get_size(map_obj
) == 0;
149 extern const struct bt_value
*bt_value_map_borrow_entry_value_const(
150 const struct bt_value
*map_obj
, const char *key
);
152 typedef bt_bool (* bt_value_map_foreach_entry_const_func
)(const char *key
,
153 const struct bt_value
*object
, void *data
);
155 extern enum bt_value_status
bt_value_map_foreach_entry_const(
156 const struct bt_value
*map_obj
,
157 bt_value_map_foreach_entry_const_func func
, void *data
);
159 extern bt_bool
bt_value_map_has_entry(const struct bt_value
*map_obj
,
162 extern enum bt_value_status
bt_value_map_extend(
163 const struct bt_value
*base_map_obj
,
164 const struct bt_value
*extension_map_obj
,
165 struct bt_value
**extended_map_obj
);
167 extern void bt_value_get_ref(const struct bt_value
*value
);
169 extern void bt_value_put_ref(const struct bt_value
*value
);
171 #define BT_VALUE_PUT_REF_AND_RESET(_var) \
173 bt_value_put_ref(_var); \
177 #define BT_VALUE_MOVE_REF(_var_dst, _var_src) \
179 bt_value_put_ref(_var_dst); \
180 (_var_dst) = (_var_src); \
188 #endif /* BABELTRACE_VALUES_CONST_H */