Commit | Line | Data |
---|---|---|
ce141536 PP |
1 | #ifndef BABELTRACE_VALUES_CONST_H |
2 | #define BABELTRACE_VALUES_CONST_H | |
3 | ||
4 | /* | |
5 | * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation | |
6 | * Copyright (c) 2015-2016 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 | ||
ce141536 PP |
33 | #ifdef __cplusplus |
34 | extern "C" { | |
35 | #endif | |
36 | ||
37 | struct bt_value; | |
38 | ||
78cf9df6 PP |
39 | enum bt_value_status { |
40 | /// Operation canceled. | |
41 | BT_VALUE_STATUS_CANCELED = 125, | |
42 | ||
43 | /// Cannot allocate memory. | |
44 | BT_VALUE_STATUS_NOMEM = -12, | |
45 | ||
46 | /// Okay, no error. | |
47 | BT_VALUE_STATUS_OK = 0, | |
48 | }; | |
49 | ||
50 | enum bt_value_type { | |
51 | /// Null value object. | |
52 | BT_VALUE_TYPE_NULL = 0, | |
53 | ||
54 | /// Boolean value object (holds #BT_TRUE or #BT_FALSE). | |
55 | BT_VALUE_TYPE_BOOL = 1, | |
56 | ||
57 | /// Integer value object (holds a signed 64-bit integer raw value). | |
58 | BT_VALUE_TYPE_INTEGER = 2, | |
59 | ||
60 | /// Floating point number value object (holds a \c double raw value). | |
61 | BT_VALUE_TYPE_REAL = 3, | |
62 | ||
63 | /// String value object. | |
64 | BT_VALUE_TYPE_STRING = 4, | |
65 | ||
66 | /// Array value object. | |
67 | BT_VALUE_TYPE_ARRAY = 5, | |
68 | ||
69 | /// Map value object. | |
70 | BT_VALUE_TYPE_MAP = 6, | |
71 | }; | |
72 | ||
ce141536 PP |
73 | extern enum bt_value_type bt_value_get_type(const struct bt_value *object); |
74 | ||
75 | static inline | |
76 | bt_bool bt_value_is_null(const struct bt_value *object) | |
77 | { | |
78 | return bt_value_get_type(object) == BT_VALUE_TYPE_NULL; | |
79 | } | |
80 | ||
81 | static inline | |
82 | bt_bool bt_value_is_bool(const struct bt_value *object) | |
83 | { | |
84 | return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL; | |
85 | } | |
86 | ||
87 | static inline | |
88 | bt_bool bt_value_is_integer(const struct bt_value *object) | |
89 | { | |
90 | return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER; | |
91 | } | |
92 | ||
93 | static inline | |
94 | bt_bool bt_value_is_real(const struct bt_value *object) | |
95 | { | |
96 | return bt_value_get_type(object) == BT_VALUE_TYPE_REAL; | |
97 | } | |
98 | ||
99 | static inline | |
100 | bt_bool bt_value_is_string(const struct bt_value *object) | |
101 | { | |
102 | return bt_value_get_type(object) == BT_VALUE_TYPE_STRING; | |
103 | } | |
104 | ||
105 | static inline | |
106 | bt_bool bt_value_is_array(const struct bt_value *object) | |
107 | { | |
108 | return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY; | |
109 | } | |
110 | ||
111 | static inline | |
112 | bt_bool bt_value_is_map(const struct bt_value *object) | |
113 | { | |
114 | return bt_value_get_type(object) == BT_VALUE_TYPE_MAP; | |
115 | } | |
116 | ||
117 | extern enum bt_value_status bt_value_copy(struct bt_value **copy, | |
118 | const struct bt_value *object); | |
119 | ||
120 | extern bt_bool bt_value_compare(const struct bt_value *object_a, | |
121 | const struct bt_value *object_b); | |
122 | ||
123 | extern bt_bool bt_value_bool_get(const struct bt_value *bool_obj); | |
124 | ||
125 | extern int64_t bt_value_integer_get(const struct bt_value *integer_obj); | |
126 | ||
127 | extern double bt_value_real_get(const struct bt_value *real_obj); | |
128 | ||
129 | extern const char *bt_value_string_get(const struct bt_value *string_obj); | |
130 | ||
131 | extern uint64_t bt_value_array_get_size(const struct bt_value *array_obj); | |
132 | ||
133 | static inline | |
134 | bt_bool bt_value_array_is_empty(const struct bt_value *array_obj) | |
135 | { | |
136 | return bt_value_array_get_size(array_obj) == 0; | |
137 | } | |
138 | ||
139 | extern const struct bt_value *bt_value_array_borrow_element_by_index_const( | |
140 | const struct bt_value *array_obj, uint64_t index); | |
141 | ||
142 | extern uint64_t bt_value_map_get_size(const struct bt_value *map_obj); | |
143 | ||
144 | static inline | |
145 | bt_bool bt_value_map_is_empty(const struct bt_value *map_obj) | |
146 | { | |
147 | return bt_value_map_get_size(map_obj) == 0; | |
148 | } | |
149 | ||
150 | extern const struct bt_value *bt_value_map_borrow_entry_value_const( | |
151 | const struct bt_value *map_obj, const char *key); | |
152 | ||
78cf9df6 | 153 | typedef bt_bool (* bt_value_map_foreach_entry_const_func)(const char *key, |
ce141536 PP |
154 | const struct bt_value *object, void *data); |
155 | ||
156 | extern enum bt_value_status bt_value_map_foreach_entry_const( | |
157 | const struct bt_value *map_obj, | |
78cf9df6 | 158 | bt_value_map_foreach_entry_const_func func, void *data); |
ce141536 PP |
159 | |
160 | extern bt_bool bt_value_map_has_entry(const struct bt_value *map_obj, | |
161 | const char *key); | |
162 | ||
163 | extern enum bt_value_status bt_value_map_extend( | |
ce141536 | 164 | const struct bt_value *base_map_obj, |
7be9d1d3 PP |
165 | const struct bt_value *extension_map_obj, |
166 | struct bt_value **extended_map_obj); | |
ce141536 PP |
167 | |
168 | #ifdef __cplusplus | |
169 | } | |
170 | #endif | |
171 | ||
172 | #endif /* BABELTRACE_VALUES_CONST_H */ |