lib: make values API const-correct
[babeltrace.git] / include / babeltrace / values.h
1 #ifndef BABELTRACE_VALUES_H
2 #define BABELTRACE_VALUES_H
3
4 /*
5 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
6 * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
7 *
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:
14 *
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
17 *
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
24 * SOFTWARE.
25 */
26
27 #include <stdint.h>
28 #include <stddef.h>
29
30 /* For bt_bool */
31 #include <babeltrace/types.h>
32
33 #ifdef __cplusplus
34 extern "C" {
35 #endif
36
37 enum bt_value_status {
38 /// Operation canceled.
39 BT_VALUE_STATUS_CANCELED = 125,
40
41 /// Cannot allocate memory.
42 BT_VALUE_STATUS_NOMEM = -12,
43
44 /// Okay, no error.
45 BT_VALUE_STATUS_OK = 0,
46 };
47
48 enum bt_value_type {
49 /// Null value object.
50 BT_VALUE_TYPE_NULL = 0,
51
52 /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
53 BT_VALUE_TYPE_BOOL = 1,
54
55 /// Integer value object (holds a signed 64-bit integer raw value).
56 BT_VALUE_TYPE_INTEGER = 2,
57
58 /// Floating point number value object (holds a \c double raw value).
59 BT_VALUE_TYPE_REAL = 3,
60
61 /// String value object.
62 BT_VALUE_TYPE_STRING = 4,
63
64 /// Array value object.
65 BT_VALUE_TYPE_ARRAY = 5,
66
67 /// Map value object.
68 BT_VALUE_TYPE_MAP = 6,
69 };
70
71 struct bt_value;
72
73 extern struct bt_value *bt_value_null;
74
75 extern struct bt_value *bt_value_bool_create(void);
76
77 extern struct bt_value *bt_value_bool_create_init(bt_bool val);
78
79 extern void bt_value_bool_set(struct bt_value *bool_obj, bt_bool val);
80
81 extern struct bt_value *bt_value_integer_create(void);
82
83 extern struct bt_value *bt_value_integer_create_init(
84 int64_t val);
85
86 extern void bt_value_integer_set(struct bt_value *integer_obj, int64_t val);
87
88 extern struct bt_value *bt_value_real_create(void);
89
90 extern struct bt_value *bt_value_real_create_init(double val);
91
92 extern void bt_value_real_set(struct bt_value *real_obj, double val);
93
94 extern struct bt_value *bt_value_string_create(void);
95
96 extern struct bt_value *bt_value_string_create_init(const char *val);
97
98 extern enum bt_value_status bt_value_string_set(struct bt_value *string_obj,
99 const char *val);
100
101 extern struct bt_value *bt_value_array_create(void);
102
103 extern struct bt_value *bt_value_array_borrow_element_by_index(
104 struct bt_value *array_obj, uint64_t index);
105
106 extern enum bt_value_status bt_value_array_append_element(
107 struct bt_value *array_obj,
108 struct bt_value *element_obj);
109
110 extern enum bt_value_status bt_value_array_append_bool_element(
111 struct bt_value *array_obj, bt_bool val);
112
113 extern enum bt_value_status bt_value_array_append_integer_element(
114 struct bt_value *array_obj, int64_t val);
115
116 extern enum bt_value_status bt_value_array_append_real_element(
117 struct bt_value *array_obj, double val);
118
119 extern enum bt_value_status bt_value_array_append_string_element(
120 struct bt_value *array_obj, const char *val);
121
122 extern enum bt_value_status bt_value_array_append_empty_array_element(
123 struct bt_value *array_obj);
124
125 extern enum bt_value_status bt_value_array_append_empty_map_element(
126 struct bt_value *array_obj);
127
128 extern enum bt_value_status bt_value_array_set_element_by_index(
129 struct bt_value *array_obj, uint64_t index,
130 struct bt_value *element_obj);
131
132 extern struct bt_value *bt_value_map_create(void);
133
134 extern struct bt_value *bt_value_map_borrow_entry_value(
135 struct bt_value *map_obj, const char *key);
136
137 typedef bt_bool (* bt_value_map_foreach_entry_cb)(const char *key,
138 struct bt_value *object, void *data);
139
140 extern enum bt_value_status bt_value_map_foreach_entry(
141 struct bt_value *map_obj,
142 bt_value_map_foreach_entry_cb cb, void *data);
143
144 extern enum bt_value_status bt_value_map_insert_entry(
145 struct bt_value *map_obj, const char *key,
146 struct bt_value *element_obj);
147
148 extern enum bt_value_status bt_value_map_insert_bool_entry(
149 struct bt_value *map_obj, const char *key, bt_bool val);
150
151 extern enum bt_value_status bt_value_map_insert_integer_entry(
152 struct bt_value *map_obj, const char *key, int64_t val);
153
154 extern enum bt_value_status bt_value_map_insert_real_entry(
155 struct bt_value *map_obj, const char *key, double val);
156
157 extern enum bt_value_status bt_value_map_insert_string_entry(
158 struct bt_value *map_obj, const char *key,
159 const char *val);
160
161 extern enum bt_value_status bt_value_map_insert_empty_array_entry(
162 struct bt_value *map_obj, const char *key);
163
164 extern enum bt_value_status bt_value_map_insert_empty_map_entry(
165 struct bt_value *map_obj, const char *key);
166
167 #ifdef __cplusplus
168 }
169 #endif
170
171 #endif /* BABELTRACE_VALUES_H */
This page took 0.035763 seconds and 5 git commands to generate.