Commit | Line | Data |
---|---|---|
1ca80abd PP |
1 | #ifndef BABELTRACE_VALUES_H |
2 | #define BABELTRACE_VALUES_H | |
dac5c838 PP |
3 | |
4 | /* | |
5 | * Babeltrace - Value objects | |
6 | * | |
de079588 PP |
7 | * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation |
8 | * Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com> | |
dac5c838 PP |
9 | * |
10 | * Permission is hereby granted, free of charge, to any person obtaining a copy | |
11 | * of this software and associated documentation files (the "Software"), to deal | |
12 | * in the Software without restriction, including without limitation the rights | |
13 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
14 | * copies of the Software, and to permit persons to whom the Software is | |
15 | * furnished to do so, subject to the following conditions: | |
16 | * | |
17 | * The above copyright notice and this permission notice shall be included in | |
18 | * all copies or substantial portions of the Software. | |
19 | * | |
20 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
21 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
22 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
23 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
24 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
25 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
26 | * SOFTWARE. | |
27 | */ | |
28 | ||
dac5c838 | 29 | #include <stdint.h> |
dac5c838 | 30 | #include <stddef.h> |
e0831b38 PP |
31 | |
32 | /* For bt_bool */ | |
c55a9f58 | 33 | #include <babeltrace/types.h> |
dac5c838 PP |
34 | |
35 | #ifdef __cplusplus | |
36 | extern "C" { | |
37 | #endif | |
38 | ||
dac5c838 | 39 | /** |
de079588 PP |
40 | @brief Status codes. |
41 | */ | |
dac5c838 | 42 | enum bt_value_status { |
8b45963b PP |
43 | /// Operation canceled. |
44 | BT_VALUE_STATUS_CANCELED = -3, | |
dac5c838 | 45 | |
de079588 PP |
46 | /// General error. |
47 | BT_VALUE_STATUS_ERROR = -1, | |
dac5c838 | 48 | |
de079588 | 49 | /// Okay, no error. |
dac5c838 PP |
50 | BT_VALUE_STATUS_OK = 0, |
51 | }; | |
52 | ||
dac5c838 | 53 | struct bt_value; |
17582c6d | 54 | struct bt_private_value; |
dac5c838 | 55 | |
dac5c838 PP |
56 | extern struct bt_value *bt_value_null; |
57 | ||
de079588 | 58 | enum bt_value_type { |
de079588 PP |
59 | /// Null value object. |
60 | BT_VALUE_TYPE_NULL = 0, | |
61 | ||
c55a9f58 | 62 | /// Boolean value object (holds #BT_TRUE or #BT_FALSE). |
de079588 PP |
63 | BT_VALUE_TYPE_BOOL = 1, |
64 | ||
65 | /// Integer value object (holds a signed 64-bit integer raw value). | |
66 | BT_VALUE_TYPE_INTEGER = 2, | |
67 | ||
68 | /// Floating point number value object (holds a \c double raw value). | |
944421ed | 69 | BT_VALUE_TYPE_REAL = 3, |
de079588 PP |
70 | |
71 | /// String value object. | |
72 | BT_VALUE_TYPE_STRING = 4, | |
73 | ||
74 | /// Array value object. | |
75 | BT_VALUE_TYPE_ARRAY = 5, | |
76 | ||
77 | /// Map value object. | |
78 | BT_VALUE_TYPE_MAP = 6, | |
79 | }; | |
dac5c838 | 80 | |
dac5c838 PP |
81 | extern enum bt_value_type bt_value_get_type(const struct bt_value *object); |
82 | ||
dac5c838 | 83 | static inline |
c55a9f58 | 84 | bt_bool bt_value_is_null(const struct bt_value *object) |
dac5c838 PP |
85 | { |
86 | return bt_value_get_type(object) == BT_VALUE_TYPE_NULL; | |
87 | } | |
88 | ||
dac5c838 | 89 | static inline |
c55a9f58 | 90 | bt_bool bt_value_is_bool(const struct bt_value *object) |
dac5c838 PP |
91 | { |
92 | return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL; | |
93 | } | |
94 | ||
dac5c838 | 95 | static inline |
c55a9f58 | 96 | bt_bool bt_value_is_integer(const struct bt_value *object) |
dac5c838 PP |
97 | { |
98 | return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER; | |
99 | } | |
100 | ||
dac5c838 | 101 | static inline |
944421ed | 102 | bt_bool bt_value_is_real(const struct bt_value *object) |
dac5c838 | 103 | { |
944421ed | 104 | return bt_value_get_type(object) == BT_VALUE_TYPE_REAL; |
dac5c838 PP |
105 | } |
106 | ||
dac5c838 | 107 | static inline |
c55a9f58 | 108 | bt_bool bt_value_is_string(const struct bt_value *object) |
dac5c838 PP |
109 | { |
110 | return bt_value_get_type(object) == BT_VALUE_TYPE_STRING; | |
111 | } | |
112 | ||
dac5c838 | 113 | static inline |
c55a9f58 | 114 | bt_bool bt_value_is_array(const struct bt_value *object) |
dac5c838 PP |
115 | { |
116 | return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY; | |
117 | } | |
118 | ||
dac5c838 | 119 | static inline |
c55a9f58 | 120 | bt_bool bt_value_is_map(const struct bt_value *object) |
dac5c838 PP |
121 | { |
122 | return bt_value_get_type(object) == BT_VALUE_TYPE_MAP; | |
123 | } | |
124 | ||
17582c6d | 125 | extern struct bt_private_value *bt_value_copy(const struct bt_value *object); |
de079588 | 126 | |
c55a9f58 | 127 | extern bt_bool bt_value_compare(const struct bt_value *object_a, |
de079588 PP |
128 | const struct bt_value *object_b); |
129 | ||
dac5c838 | 130 | extern enum bt_value_status bt_value_bool_get( |
c55a9f58 | 131 | const struct bt_value *bool_obj, bt_bool *val); |
dac5c838 | 132 | |
dac5c838 | 133 | extern enum bt_value_status bt_value_integer_get( |
364747d6 | 134 | const struct bt_value *integer_obj, int64_t *val); |
dac5c838 | 135 | |
944421ed PP |
136 | extern enum bt_value_status bt_value_real_get( |
137 | const struct bt_value *real_obj, double *val); | |
dac5c838 | 138 | |
dac5c838 | 139 | extern enum bt_value_status bt_value_string_get( |
364747d6 | 140 | const struct bt_value *string_obj, const char **val); |
dac5c838 | 141 | |
44514773 | 142 | extern int64_t bt_value_array_get_size(const struct bt_value *array_obj); |
de079588 | 143 | |
c55a9f58 | 144 | extern bt_bool bt_value_array_is_empty(const struct bt_value *array_obj); |
dac5c838 | 145 | |
44514773 PP |
146 | extern struct bt_value *bt_value_array_borrow_element_by_index( |
147 | const struct bt_value *array_obj, uint64_t index); | |
dac5c838 | 148 | |
44514773 | 149 | extern int64_t bt_value_map_get_size(const struct bt_value *map_obj); |
dac5c838 | 150 | |
c55a9f58 | 151 | extern bt_bool bt_value_map_is_empty(const struct bt_value *map_obj); |
dac5c838 | 152 | |
44514773 PP |
153 | extern struct bt_value *bt_value_map_borrow_entry_value( |
154 | const struct bt_value *map_obj, const char *key); | |
dac5c838 | 155 | |
44514773 | 156 | typedef bt_bool (* bt_value_map_foreach_entry_cb)(const char *key, |
de079588 PP |
157 | struct bt_value *object, void *data); |
158 | ||
44514773 PP |
159 | extern enum bt_value_status bt_value_map_foreach_entry( |
160 | const struct bt_value *map_obj, | |
161 | bt_value_map_foreach_entry_cb cb, void *data); | |
dac5c838 | 162 | |
44514773 | 163 | extern bt_bool bt_value_map_has_entry(const struct bt_value *map_obj, |
364747d6 | 164 | const char *key); |
dac5c838 | 165 | |
17582c6d PP |
166 | extern struct bt_private_value *bt_value_map_extend( |
167 | struct bt_value *base_map_obj, | |
770750d3 PP |
168 | struct bt_value *extension_map_obj); |
169 | ||
dac5c838 PP |
170 | #ifdef __cplusplus |
171 | } | |
172 | #endif | |
173 | ||
1ca80abd | 174 | #endif /* BABELTRACE_VALUES_H */ |