1 #ifndef BABELTRACE_VALUES_CONST_H
2 #define BABELTRACE_VALUES_CONST_H
5 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
6 * Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
31 #include <babeltrace/types.h>
33 /* For enum bt_value_status, enum bt_value_type */
34 #include <babeltrace/values.h>
42 extern enum bt_value_type
bt_value_get_type(const struct bt_value
*object
);
45 bt_bool
bt_value_is_null(const struct bt_value
*object
)
47 return bt_value_get_type(object
) == BT_VALUE_TYPE_NULL
;
51 bt_bool
bt_value_is_bool(const struct bt_value
*object
)
53 return bt_value_get_type(object
) == BT_VALUE_TYPE_BOOL
;
57 bt_bool
bt_value_is_integer(const struct bt_value
*object
)
59 return bt_value_get_type(object
) == BT_VALUE_TYPE_INTEGER
;
63 bt_bool
bt_value_is_real(const struct bt_value
*object
)
65 return bt_value_get_type(object
) == BT_VALUE_TYPE_REAL
;
69 bt_bool
bt_value_is_string(const struct bt_value
*object
)
71 return bt_value_get_type(object
) == BT_VALUE_TYPE_STRING
;
75 bt_bool
bt_value_is_array(const struct bt_value
*object
)
77 return bt_value_get_type(object
) == BT_VALUE_TYPE_ARRAY
;
81 bt_bool
bt_value_is_map(const struct bt_value
*object
)
83 return bt_value_get_type(object
) == BT_VALUE_TYPE_MAP
;
86 extern enum bt_value_status
bt_value_copy(struct bt_value
**copy
,
87 const struct bt_value
*object
);
89 extern bt_bool
bt_value_compare(const struct bt_value
*object_a
,
90 const struct bt_value
*object_b
);
92 extern bt_bool
bt_value_bool_get(const struct bt_value
*bool_obj
);
94 extern int64_t bt_value_integer_get(const struct bt_value
*integer_obj
);
96 extern double bt_value_real_get(const struct bt_value
*real_obj
);
98 extern const char *bt_value_string_get(const struct bt_value
*string_obj
);
100 extern uint64_t bt_value_array_get_size(const struct bt_value
*array_obj
);
103 bt_bool
bt_value_array_is_empty(const struct bt_value
*array_obj
)
105 return bt_value_array_get_size(array_obj
) == 0;
108 extern const struct bt_value
*bt_value_array_borrow_element_by_index_const(
109 const struct bt_value
*array_obj
, uint64_t index
);
111 extern uint64_t bt_value_map_get_size(const struct bt_value
*map_obj
);
114 bt_bool
bt_value_map_is_empty(const struct bt_value
*map_obj
)
116 return bt_value_map_get_size(map_obj
) == 0;
119 extern const struct bt_value
*bt_value_map_borrow_entry_value_const(
120 const struct bt_value
*map_obj
, const char *key
);
122 typedef bt_bool (* bt_value_map_foreach_entry_const_cb
)(const char *key
,
123 const struct bt_value
*object
, void *data
);
125 extern enum bt_value_status
bt_value_map_foreach_entry_const(
126 const struct bt_value
*map_obj
,
127 bt_value_map_foreach_entry_const_cb cb
, void *data
);
129 extern bt_bool
bt_value_map_has_entry(const struct bt_value
*map_obj
,
132 extern enum bt_value_status
bt_value_map_extend(
133 struct bt_value
**extended_map_obj
,
134 const struct bt_value
*base_map_obj
,
135 const struct bt_value
*extension_map_obj
);
141 #endif /* BABELTRACE_VALUES_CONST_H */