Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H | |
78cf9df6 PP |
3 | |
4 | /* | |
0dcb770f | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
78cf9df6 | 6 | * |
78cf9df6 PP |
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. | |
78cf9df6 PP |
24 | */ |
25 | ||
9df34b44 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
78cf9df6 PP |
30 | #include <stdint.h> |
31 | #include <stddef.h> | |
32 | ||
e278f258 PP |
33 | #include <babeltrace2/types.h> |
34 | ||
78cf9df6 PP |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
38 | ||
ee78f405 | 39 | typedef enum bt_field_class_type { |
467673c1 PP |
40 | BT_FIELD_CLASS_TYPE_BOOL = 0, |
41 | BT_FIELD_CLASS_TYPE_BIT_ARRAY = 1, | |
42 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER = 2, | |
43 | BT_FIELD_CLASS_TYPE_SIGNED_INTEGER = 3, | |
44 | BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION = 4, | |
45 | BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION = 5, | |
46 | BT_FIELD_CLASS_TYPE_SINGLE_PRECISION_REAL = 6, | |
47 | BT_FIELD_CLASS_TYPE_DOUBLE_PRECISION_REAL = 7, | |
48 | BT_FIELD_CLASS_TYPE_STRING = 8, | |
49 | BT_FIELD_CLASS_TYPE_STRUCTURE = 9, | |
50 | BT_FIELD_CLASS_TYPE_STATIC_ARRAY = 10, | |
b8ddb4f0 PP |
51 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITHOUT_LENGTH_FIELD = 11, |
52 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY_WITH_LENGTH_FIELD = 12, | |
53 | BT_FIELD_CLASS_TYPE_OPTION_WITHOUT_SELECTOR = 13, | |
54 | BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR = 14, | |
55 | BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR = 15, | |
56 | BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR = 16, | |
57 | BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR = 17, | |
58 | BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR = 18, | |
59 | BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR = 19, | |
ee78f405 | 60 | } bt_field_class_type; |
78cf9df6 | 61 | |
ee78f405 | 62 | typedef enum bt_field_class_integer_preferred_display_base { |
a0c6c1d7 PP |
63 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY = 2, |
64 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL = 8, | |
65 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL = 10, | |
66 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL = 16, | |
ee78f405 | 67 | } bt_field_class_integer_preferred_display_base; |
78cf9df6 | 68 | |
ee78f405 | 69 | extern bt_field_class_type bt_field_class_get_type( |
8eee8ea2 | 70 | const bt_field_class *field_class); |
78cf9df6 | 71 | |
af90138b PP |
72 | extern const bt_value *bt_field_class_borrow_user_attributes_const( |
73 | const bt_field_class *field_class); | |
74 | ||
6943da6a PP |
75 | extern uint64_t bt_field_class_bit_array_get_length( |
76 | const bt_field_class *field_class); | |
77 | ||
78cf9df6 | 78 | extern uint64_t bt_field_class_integer_get_field_value_range( |
8eee8ea2 | 79 | const bt_field_class *field_class); |
78cf9df6 | 80 | |
ee78f405 | 81 | extern bt_field_class_integer_preferred_display_base |
78cf9df6 | 82 | bt_field_class_integer_get_preferred_display_base( |
8eee8ea2 | 83 | const bt_field_class *field_class); |
78cf9df6 | 84 | |
78cf9df6 | 85 | extern uint64_t bt_field_class_enumeration_get_mapping_count( |
8eee8ea2 | 86 | const bt_field_class *field_class); |
78cf9df6 | 87 | |
60bbfc7c PP |
88 | extern const bt_field_class_enumeration_unsigned_mapping * |
89 | bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const( | |
b6baf3bb PP |
90 | const bt_field_class *field_class, uint64_t index); |
91 | ||
60bbfc7c PP |
92 | extern const bt_field_class_enumeration_unsigned_mapping * |
93 | bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const( | |
02b61fe0 PP |
94 | const bt_field_class *field_class, const char *label); |
95 | ||
60bbfc7c PP |
96 | extern const bt_field_class_enumeration_signed_mapping * |
97 | bt_field_class_enumeration_signed_borrow_mapping_by_index_const( | |
b6baf3bb PP |
98 | const bt_field_class *field_class, uint64_t index); |
99 | ||
60bbfc7c PP |
100 | extern const bt_field_class_enumeration_signed_mapping * |
101 | bt_field_class_enumeration_signed_borrow_mapping_by_label_const( | |
02b61fe0 PP |
102 | const bt_field_class *field_class, const char *label); |
103 | ||
b6baf3bb PP |
104 | static inline |
105 | const bt_field_class_enumeration_mapping * | |
60bbfc7c PP |
106 | bt_field_class_enumeration_unsigned_mapping_as_mapping_const( |
107 | const bt_field_class_enumeration_unsigned_mapping *mapping) | |
b6baf3bb | 108 | { |
8470daa9 | 109 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
b6baf3bb | 110 | } |
78cf9df6 | 111 | |
b6baf3bb PP |
112 | static inline |
113 | const bt_field_class_enumeration_mapping * | |
60bbfc7c PP |
114 | bt_field_class_enumeration_signed_mapping_as_mapping_const( |
115 | const bt_field_class_enumeration_signed_mapping *mapping) | |
b6baf3bb | 116 | { |
8470daa9 | 117 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
b6baf3bb | 118 | } |
78cf9df6 | 119 | |
b6baf3bb PP |
120 | extern const char *bt_field_class_enumeration_mapping_get_label( |
121 | const bt_field_class_enumeration_mapping *mapping); | |
78cf9df6 | 122 | |
02b61fe0 | 123 | extern const bt_integer_range_set_unsigned * |
60bbfc7c PP |
124 | bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const( |
125 | const bt_field_class_enumeration_unsigned_mapping *mapping); | |
78cf9df6 | 126 | |
02b61fe0 | 127 | extern const bt_integer_range_set_signed * |
60bbfc7c PP |
128 | bt_field_class_enumeration_signed_mapping_borrow_ranges_const( |
129 | const bt_field_class_enumeration_signed_mapping *mapping); | |
78cf9df6 | 130 | |
1091bb60 | 131 | typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status { |
fb25b9e3 PP |
132 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
133 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
1091bb60 | 134 | } bt_field_class_enumeration_get_mapping_labels_for_value_status; |
fb25b9e3 | 135 | |
1091bb60 | 136 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
60bbfc7c | 137 | bt_field_class_enumeration_unsigned_get_mapping_labels_for_value( |
8eee8ea2 | 138 | const bt_field_class *field_class, uint64_t value, |
78cf9df6 PP |
139 | bt_field_class_enumeration_mapping_label_array *label_array, |
140 | uint64_t *count); | |
141 | ||
1091bb60 | 142 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
60bbfc7c | 143 | bt_field_class_enumeration_signed_get_mapping_labels_for_value( |
8eee8ea2 | 144 | const bt_field_class *field_class, int64_t value, |
78cf9df6 PP |
145 | bt_field_class_enumeration_mapping_label_array *label_array, |
146 | uint64_t *count); | |
147 | ||
148 | extern uint64_t bt_field_class_structure_get_member_count( | |
8eee8ea2 | 149 | const bt_field_class *field_class); |
78cf9df6 | 150 | |
e24f271a PP |
151 | extern const bt_field_class_structure_member * |
152 | bt_field_class_structure_borrow_member_by_index_const( | |
153 | const bt_field_class *field_class, uint64_t index); | |
78cf9df6 | 154 | |
e24f271a PP |
155 | extern const bt_field_class_structure_member * |
156 | bt_field_class_structure_borrow_member_by_name_const( | |
8eee8ea2 | 157 | const bt_field_class *field_class, const char *name); |
78cf9df6 | 158 | |
e24f271a PP |
159 | extern const char *bt_field_class_structure_member_get_name( |
160 | const bt_field_class_structure_member *member); | |
161 | ||
162 | extern const bt_field_class * | |
163 | bt_field_class_structure_member_borrow_field_class_const( | |
164 | const bt_field_class_structure_member *member); | |
165 | ||
af90138b PP |
166 | extern const bt_value *bt_field_class_structure_member_borrow_user_attributes_const( |
167 | const bt_field_class_structure_member *member); | |
168 | ||
8eee8ea2 | 169 | extern const bt_field_class * |
78cf9df6 | 170 | bt_field_class_array_borrow_element_field_class_const( |
8eee8ea2 | 171 | const bt_field_class *field_class); |
78cf9df6 | 172 | |
60bbfc7c | 173 | extern uint64_t bt_field_class_array_static_get_length( |
8eee8ea2 | 174 | const bt_field_class *field_class); |
78cf9df6 | 175 | |
8eee8ea2 | 176 | extern const bt_field_path * |
b8ddb4f0 | 177 | bt_field_class_array_dynamic_with_length_field_borrow_length_field_path_const( |
8eee8ea2 | 178 | const bt_field_class *field_class); |
78cf9df6 | 179 | |
247fa9e3 PP |
180 | extern const bt_field_class * |
181 | bt_field_class_option_borrow_field_class_const( | |
182 | const bt_field_class *field_class); | |
183 | ||
184 | extern const bt_field_path * | |
467673c1 PP |
185 | bt_field_class_option_with_selector_borrow_selector_field_path_const( |
186 | const bt_field_class *field_class); | |
187 | ||
188 | extern bt_bool | |
189 | bt_field_class_option_with_selector_bool_selector_is_reversed( | |
190 | const bt_field_class *field_class); | |
191 | ||
192 | extern const bt_integer_range_set_unsigned * | |
193 | bt_field_class_option_with_selector_integer_unsigned_borrow_selector_ranges_const( | |
194 | const bt_field_class *field_class); | |
195 | ||
196 | extern const bt_integer_range_set_signed * | |
197 | bt_field_class_option_with_selector_integer_signed_borrow_selector_ranges_const( | |
247fa9e3 PP |
198 | const bt_field_class *field_class); |
199 | ||
78cf9df6 | 200 | extern uint64_t bt_field_class_variant_get_option_count( |
8eee8ea2 | 201 | const bt_field_class *field_class); |
78cf9df6 | 202 | |
e24f271a PP |
203 | extern const bt_field_class_variant_option * |
204 | bt_field_class_variant_borrow_option_by_index_const( | |
205 | const bt_field_class *field_class, uint64_t index); | |
78cf9df6 | 206 | |
e24f271a PP |
207 | extern const bt_field_class_variant_option * |
208 | bt_field_class_variant_borrow_option_by_name_const( | |
209 | const bt_field_class *field_class, const char *name); | |
210 | ||
0822832b PP |
211 | extern const bt_field_class_variant_with_selector_integer_unsigned_option * |
212 | bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_index_const( | |
02b61fe0 PP |
213 | const bt_field_class *field_class, uint64_t index); |
214 | ||
0822832b PP |
215 | extern const bt_field_class_variant_with_selector_integer_unsigned_option * |
216 | bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_name_const( | |
02b61fe0 PP |
217 | const bt_field_class *field_class, const char *name); |
218 | ||
0822832b PP |
219 | extern const bt_field_class_variant_with_selector_integer_signed_option * |
220 | bt_field_class_variant_with_selector_integer_signed_borrow_option_by_index_const( | |
02b61fe0 PP |
221 | const bt_field_class *field_class, uint64_t index); |
222 | ||
0822832b PP |
223 | extern const bt_field_class_variant_with_selector_integer_signed_option * |
224 | bt_field_class_variant_with_selector_integer_signed_borrow_option_by_name_const( | |
02b61fe0 PP |
225 | const bt_field_class *field_class, const char *name); |
226 | ||
e24f271a PP |
227 | extern const char *bt_field_class_variant_option_get_name( |
228 | const bt_field_class_variant_option *option); | |
229 | ||
230 | extern const bt_field_class * | |
231 | bt_field_class_variant_option_borrow_field_class_const( | |
232 | const bt_field_class_variant_option *option); | |
78cf9df6 | 233 | |
af90138b PP |
234 | extern const bt_value *bt_field_class_variant_option_borrow_user_attributes_const( |
235 | const bt_field_class_variant_option *option); | |
236 | ||
02b61fe0 PP |
237 | extern const bt_field_path * |
238 | bt_field_class_variant_with_selector_borrow_selector_field_path_const( | |
239 | const bt_field_class *field_class); | |
240 | ||
241 | extern const bt_integer_range_set_unsigned * | |
0822832b PP |
242 | bt_field_class_variant_with_selector_integer_unsigned_option_borrow_ranges_const( |
243 | const bt_field_class_variant_with_selector_integer_unsigned_option *option); | |
02b61fe0 PP |
244 | |
245 | static inline | |
246 | const bt_field_class_variant_option * | |
0822832b PP |
247 | bt_field_class_variant_with_selector_integer_unsigned_option_as_option_const( |
248 | const bt_field_class_variant_with_selector_integer_unsigned_option *option) | |
02b61fe0 PP |
249 | { |
250 | return __BT_UPCAST_CONST(bt_field_class_variant_option, option); | |
251 | } | |
252 | ||
253 | extern const bt_integer_range_set_signed * | |
0822832b PP |
254 | bt_field_class_variant_with_selector_integer_signed_option_borrow_ranges_const( |
255 | const bt_field_class_variant_with_selector_integer_signed_option *option); | |
02b61fe0 PP |
256 | |
257 | static inline | |
258 | const bt_field_class_variant_option * | |
0822832b PP |
259 | bt_field_class_variant_with_selector_integer_signed_option_as_option_const( |
260 | const bt_field_class_variant_with_selector_integer_signed_option *option) | |
02b61fe0 PP |
261 | { |
262 | return __BT_UPCAST_CONST(bt_field_class_variant_option, option); | |
263 | } | |
264 | ||
8eee8ea2 | 265 | extern void bt_field_class_get_ref(const bt_field_class *field_class); |
8c6884d9 | 266 | |
8eee8ea2 | 267 | extern void bt_field_class_put_ref(const bt_field_class *field_class); |
8c6884d9 PP |
268 | |
269 | #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \ | |
270 | do { \ | |
271 | bt_field_class_put_ref(_var); \ | |
272 | (_var) = NULL; \ | |
273 | } while (0) | |
274 | ||
275 | #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
276 | do { \ | |
277 | bt_field_class_put_ref(_var_dst); \ | |
278 | (_var_dst) = (_var_src); \ | |
279 | (_var_src) = NULL; \ | |
280 | } while (0) | |
281 | ||
282 | ||
78cf9df6 PP |
283 | #ifdef __cplusplus |
284 | } | |
285 | #endif | |
286 | ||
3fd40f46 | 287 | #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */ |