Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_VALUE_H |
2 | #define BABELTRACE2_VALUE_H | |
dac5c838 PP |
3 | |
4 | /* | |
05e21286 | 5 | * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com> |
dac5c838 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 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
dac5c838 | 30 | #include <stdint.h> |
dac5c838 | 31 | #include <stddef.h> |
9d408fca | 32 | |
b19ff26f | 33 | /* For bt_bool, bt_value */ |
3fadfbc0 | 34 | #include <babeltrace2/types.h> |
dac5c838 | 35 | |
d24d5663 | 36 | /* For bt_value_type */ |
3fadfbc0 | 37 | #include <babeltrace2/value-const.h> |
40f4ba76 | 38 | |
dac5c838 PP |
39 | #ifdef __cplusplus |
40 | extern "C" { | |
41 | #endif | |
42 | ||
211796dc | 43 | extern bt_value *const bt_value_null; |
dac5c838 | 44 | |
b19ff26f | 45 | extern bt_value *bt_value_bool_create(void); |
dac5c838 | 46 | |
b19ff26f | 47 | extern bt_value *bt_value_bool_create_init(bt_bool val); |
dac5c838 | 48 | |
b19ff26f | 49 | extern void bt_value_bool_set(bt_value *bool_obj, bt_bool val); |
dac5c838 | 50 | |
fdd3a2da | 51 | extern bt_value *bt_value_unsigned_integer_create(void); |
dac5c838 | 52 | |
fdd3a2da | 53 | extern bt_value *bt_value_unsigned_integer_create_init(uint64_t val); |
dac5c838 | 54 | |
fdd3a2da PP |
55 | extern void bt_value_unsigned_integer_set(bt_value *integer_obj, uint64_t val); |
56 | ||
57 | extern bt_value *bt_value_signed_integer_create(void); | |
58 | ||
59 | extern bt_value *bt_value_signed_integer_create_init(int64_t val); | |
60 | ||
61 | extern void bt_value_signed_integer_set(bt_value *integer_obj, int64_t val); | |
de079588 | 62 | |
b19ff26f | 63 | extern bt_value *bt_value_real_create(void); |
de079588 | 64 | |
b19ff26f | 65 | extern bt_value *bt_value_real_create_init(double val); |
dac5c838 | 66 | |
b19ff26f | 67 | extern void bt_value_real_set(bt_value *real_obj, double val); |
dac5c838 | 68 | |
b19ff26f | 69 | extern bt_value *bt_value_string_create(void); |
dac5c838 | 70 | |
b19ff26f | 71 | extern bt_value *bt_value_string_create_init(const char *val); |
dac5c838 | 72 | |
d24d5663 PP |
73 | typedef enum bt_value_string_set_status { |
74 | BT_VALUE_STRING_SET_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
75 | BT_VALUE_STRING_SET_STATUS_OK = __BT_FUNC_STATUS_OK, | |
76 | } bt_value_string_set_status; | |
77 | ||
78 | extern bt_value_string_set_status bt_value_string_set(bt_value *string_obj, | |
05e21286 | 79 | const char *val); |
de079588 | 80 | |
b19ff26f | 81 | extern bt_value *bt_value_array_create(void); |
dac5c838 | 82 | |
d24d5663 PP |
83 | extern bt_value *bt_value_array_borrow_element_by_index(bt_value *array_obj, |
84 | uint64_t index); | |
dac5c838 | 85 | |
d24d5663 PP |
86 | typedef enum bt_value_array_append_element_status { |
87 | BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
88 | BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK = __BT_FUNC_STATUS_OK, | |
89 | } bt_value_array_append_element_status; | |
dac5c838 | 90 | |
d24d5663 PP |
91 | extern bt_value_array_append_element_status bt_value_array_append_element( |
92 | bt_value *array_obj, bt_value *element_obj); | |
05e21286 | 93 | |
d24d5663 PP |
94 | extern bt_value_array_append_element_status |
95 | bt_value_array_append_bool_element(bt_value *array_obj, bt_bool val); | |
fdd3a2da | 96 | |
d24d5663 PP |
97 | extern bt_value_array_append_element_status |
98 | bt_value_array_append_unsigned_integer_element(bt_value *array_obj, | |
99 | uint64_t val); | |
05e21286 | 100 | |
d24d5663 PP |
101 | extern bt_value_array_append_element_status |
102 | bt_value_array_append_signed_integer_element(bt_value *array_obj, int64_t val); | |
05e21286 | 103 | |
d24d5663 PP |
104 | extern bt_value_array_append_element_status |
105 | bt_value_array_append_real_element(bt_value *array_obj, double val); | |
05e21286 | 106 | |
d24d5663 PP |
107 | extern bt_value_array_append_element_status |
108 | bt_value_array_append_string_element(bt_value *array_obj, const char *val); | |
05e21286 | 109 | |
d24d5663 PP |
110 | extern bt_value_array_append_element_status |
111 | bt_value_array_append_empty_array_element(bt_value *array_obj); | |
05e21286 | 112 | |
d24d5663 PP |
113 | extern bt_value_array_append_element_status |
114 | bt_value_array_append_empty_map_element(bt_value *array_obj); | |
115 | ||
116 | typedef enum bt_value_array_set_element_by_index_status { | |
117 | BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
118 | BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK = __BT_FUNC_STATUS_OK, | |
119 | } bt_value_array_set_element_by_index_status; | |
120 | ||
121 | extern bt_value_array_set_element_by_index_status | |
122 | bt_value_array_set_element_by_index(bt_value *array_obj, uint64_t index, | |
b19ff26f | 123 | bt_value *element_obj); |
05e21286 | 124 | |
b19ff26f | 125 | extern bt_value *bt_value_map_create(void); |
dac5c838 | 126 | |
b19ff26f PP |
127 | extern bt_value *bt_value_map_borrow_entry_value( |
128 | bt_value *map_obj, const char *key); | |
dac5c838 | 129 | |
40f4ba76 | 130 | typedef bt_bool (* bt_value_map_foreach_entry_func)(const char *key, |
b19ff26f | 131 | bt_value *object, void *data); |
de079588 | 132 | |
d24d5663 PP |
133 | typedef enum bt_value_map_foreach_entry_status { |
134 | BT_VALUE_MAP_FOREACH_ENTRY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
135 | BT_VALUE_MAP_FOREACH_ENTRY_STATUS_OK = __BT_FUNC_STATUS_OK, | |
136 | BT_VALUE_MAP_FOREACH_ENTRY_STATUS_CANCELED = __BT_FUNC_STATUS_CANCELED, | |
137 | } bt_value_map_foreach_entry_status; | |
dac5c838 | 138 | |
d24d5663 PP |
139 | extern bt_value_map_foreach_entry_status bt_value_map_foreach_entry( |
140 | bt_value *map_obj, bt_value_map_foreach_entry_func func, | |
141 | void *data); | |
05e21286 | 142 | |
d24d5663 PP |
143 | typedef enum bt_value_map_insert_entry_status { |
144 | BT_VALUE_MAP_INSERT_ENTRY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
145 | BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK = __BT_FUNC_STATUS_OK, | |
146 | } bt_value_map_insert_entry_status; | |
147 | ||
148 | extern bt_value_map_insert_entry_status bt_value_map_insert_entry( | |
149 | bt_value *map_obj, const char *key, bt_value *element_obj); | |
150 | ||
151 | extern bt_value_map_insert_entry_status bt_value_map_insert_bool_entry( | |
b19ff26f | 152 | bt_value *map_obj, const char *key, bt_bool val); |
05e21286 | 153 | |
d24d5663 PP |
154 | extern bt_value_map_insert_entry_status |
155 | bt_value_map_insert_unsigned_integer_entry(bt_value *map_obj, const char *key, | |
156 | uint64_t val); | |
fdd3a2da | 157 | |
d24d5663 PP |
158 | extern bt_value_map_insert_entry_status |
159 | bt_value_map_insert_signed_integer_entry(bt_value *map_obj, const char *key, | |
160 | int64_t val); | |
05e21286 | 161 | |
d24d5663 | 162 | extern bt_value_map_insert_entry_status bt_value_map_insert_real_entry( |
b19ff26f | 163 | bt_value *map_obj, const char *key, double val); |
05e21286 | 164 | |
d24d5663 PP |
165 | extern bt_value_map_insert_entry_status |
166 | bt_value_map_insert_string_entry(bt_value *map_obj, const char *key, | |
05e21286 PP |
167 | const char *val); |
168 | ||
d24d5663 PP |
169 | extern bt_value_map_insert_entry_status |
170 | bt_value_map_insert_empty_array_entry(bt_value *map_obj, const char *key); | |
dac5c838 | 171 | |
d24d5663 PP |
172 | extern bt_value_map_insert_entry_status |
173 | bt_value_map_insert_empty_map_entry(bt_value *map_obj, const char *key); | |
770750d3 | 174 | |
dac5c838 PP |
175 | #ifdef __cplusplus |
176 | } | |
177 | #endif | |
178 | ||
924dc299 | 179 | #endif /* BABELTRACE2_VALUE_H */ |