1 #ifndef BABELTRACE2_VALUE_H
2 #define BABELTRACE2_VALUE_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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
33 #include <babeltrace2/types.h>
34 #include <babeltrace2/value-const.h>
40 extern bt_value
*const bt_value_null
;
42 extern bt_value
*bt_value_bool_create(void);
44 extern bt_value
*bt_value_bool_create_init(bt_bool val
);
46 extern void bt_value_bool_set(bt_value
*bool_obj
, bt_bool val
);
48 extern bt_value
*bt_value_unsigned_integer_create(void);
50 extern bt_value
*bt_value_unsigned_integer_create_init(uint64_t val
);
52 extern void bt_value_unsigned_integer_set(bt_value
*integer_obj
, uint64_t val
);
54 extern bt_value
*bt_value_signed_integer_create(void);
56 extern bt_value
*bt_value_signed_integer_create_init(int64_t val
);
58 extern void bt_value_signed_integer_set(bt_value
*integer_obj
, int64_t val
);
60 extern bt_value
*bt_value_real_create(void);
62 extern bt_value
*bt_value_real_create_init(double val
);
64 extern void bt_value_real_set(bt_value
*real_obj
, double val
);
66 extern bt_value
*bt_value_string_create(void);
68 extern bt_value
*bt_value_string_create_init(const char *val
);
70 typedef enum bt_value_string_set_status
{
71 BT_VALUE_STRING_SET_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
72 BT_VALUE_STRING_SET_STATUS_OK
= __BT_FUNC_STATUS_OK
,
73 } bt_value_string_set_status
;
75 extern bt_value_string_set_status
bt_value_string_set(bt_value
*string_obj
,
78 extern bt_value
*bt_value_array_create(void);
80 extern bt_value
*bt_value_array_borrow_element_by_index(bt_value
*array_obj
,
83 typedef enum bt_value_array_append_element_status
{
84 BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
85 BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK
= __BT_FUNC_STATUS_OK
,
86 } bt_value_array_append_element_status
;
88 extern bt_value_array_append_element_status
bt_value_array_append_element(
89 bt_value
*array_obj
, bt_value
*element_obj
);
91 extern bt_value_array_append_element_status
92 bt_value_array_append_bool_element(bt_value
*array_obj
, bt_bool val
);
94 extern bt_value_array_append_element_status
95 bt_value_array_append_unsigned_integer_element(bt_value
*array_obj
,
98 extern bt_value_array_append_element_status
99 bt_value_array_append_signed_integer_element(bt_value
*array_obj
, int64_t val
);
101 extern bt_value_array_append_element_status
102 bt_value_array_append_real_element(bt_value
*array_obj
, double val
);
104 extern bt_value_array_append_element_status
105 bt_value_array_append_string_element(bt_value
*array_obj
, const char *val
);
107 extern bt_value_array_append_element_status
108 bt_value_array_append_empty_array_element(bt_value
*array_obj
);
110 extern bt_value_array_append_element_status
111 bt_value_array_append_empty_map_element(bt_value
*array_obj
);
113 typedef enum bt_value_array_set_element_by_index_status
{
114 BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
115 BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK
= __BT_FUNC_STATUS_OK
,
116 } bt_value_array_set_element_by_index_status
;
118 extern bt_value_array_set_element_by_index_status
119 bt_value_array_set_element_by_index(bt_value
*array_obj
, uint64_t index
,
120 bt_value
*element_obj
);
122 extern bt_value
*bt_value_map_create(void);
124 extern bt_value
*bt_value_map_borrow_entry_value(
125 bt_value
*map_obj
, const char *key
);
127 typedef bt_bool (* bt_value_map_foreach_entry_func
)(const char *key
,
128 bt_value
*object
, void *data
);
130 typedef enum bt_value_map_foreach_entry_status
{
131 BT_VALUE_MAP_FOREACH_ENTRY_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
132 BT_VALUE_MAP_FOREACH_ENTRY_STATUS_OK
= __BT_FUNC_STATUS_OK
,
133 BT_VALUE_MAP_FOREACH_ENTRY_STATUS_CANCELED
= __BT_FUNC_STATUS_CANCELED
,
134 } bt_value_map_foreach_entry_status
;
136 extern bt_value_map_foreach_entry_status
bt_value_map_foreach_entry(
137 bt_value
*map_obj
, bt_value_map_foreach_entry_func func
,
140 typedef enum bt_value_map_insert_entry_status
{
141 BT_VALUE_MAP_INSERT_ENTRY_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
142 BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK
= __BT_FUNC_STATUS_OK
,
143 } bt_value_map_insert_entry_status
;
145 extern bt_value_map_insert_entry_status
bt_value_map_insert_entry(
146 bt_value
*map_obj
, const char *key
, bt_value
*element_obj
);
148 extern bt_value_map_insert_entry_status
bt_value_map_insert_bool_entry(
149 bt_value
*map_obj
, const char *key
, bt_bool val
);
151 extern bt_value_map_insert_entry_status
152 bt_value_map_insert_unsigned_integer_entry(bt_value
*map_obj
, const char *key
,
155 extern bt_value_map_insert_entry_status
156 bt_value_map_insert_signed_integer_entry(bt_value
*map_obj
, const char *key
,
159 extern bt_value_map_insert_entry_status
bt_value_map_insert_real_entry(
160 bt_value
*map_obj
, const char *key
, double val
);
162 extern bt_value_map_insert_entry_status
163 bt_value_map_insert_string_entry(bt_value
*map_obj
, const char *key
,
166 extern bt_value_map_insert_entry_status
167 bt_value_map_insert_empty_array_entry(bt_value
*map_obj
, const char *key
);
169 extern bt_value_map_insert_entry_status
170 bt_value_map_insert_empty_map_entry(bt_value
*map_obj
, const char *key
);
176 #endif /* BABELTRACE2_VALUE_H */