Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H | |
40f4ba76 PP |
3 | |
4 | /* | |
bbb7b5f0 | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
40f4ba76 | 6 | * |
40f4ba76 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. | |
40f4ba76 PP |
24 | */ |
25 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
40f4ba76 PP |
30 | #include <stdint.h> |
31 | #include <stddef.h> | |
32 | ||
959b3d46 PP |
33 | #include <babeltrace2/types.h> |
34 | ||
40f4ba76 PP |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
38 | ||
4cdfc5e8 | 39 | typedef enum bt_field_class_type { |
7b6afccb 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_REAL = 6, | |
47 | BT_FIELD_CLASS_TYPE_STRING = 7, | |
48 | BT_FIELD_CLASS_TYPE_STRUCTURE = 8, | |
49 | BT_FIELD_CLASS_TYPE_STATIC_ARRAY = 9, | |
50 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY = 10, | |
51 | BT_FIELD_CLASS_TYPE_OPTION = 11, | |
52 | BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR = 12, | |
53 | BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR = 13, | |
54 | BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR = 14, | |
4cdfc5e8 | 55 | } bt_field_class_type; |
40f4ba76 | 56 | |
4cdfc5e8 | 57 | typedef enum bt_field_class_integer_preferred_display_base { |
7b6afccb PP |
58 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY = 2, |
59 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL = 8, | |
60 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL = 10, | |
61 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL = 16, | |
4cdfc5e8 | 62 | } bt_field_class_integer_preferred_display_base; |
40f4ba76 | 63 | |
4cdfc5e8 | 64 | extern bt_field_class_type bt_field_class_get_type( |
b19ff26f | 65 | const bt_field_class *field_class); |
40f4ba76 | 66 | |
c6962c96 PP |
67 | extern const bt_value *bt_field_class_borrow_user_attributes_const( |
68 | const bt_field_class *field_class); | |
69 | ||
1094efa4 PP |
70 | extern uint64_t bt_field_class_bit_array_get_length( |
71 | const bt_field_class *field_class); | |
72 | ||
40f4ba76 | 73 | extern uint64_t bt_field_class_integer_get_field_value_range( |
b19ff26f | 74 | const bt_field_class *field_class); |
40f4ba76 | 75 | |
4cdfc5e8 | 76 | extern bt_field_class_integer_preferred_display_base |
40f4ba76 | 77 | bt_field_class_integer_get_preferred_display_base( |
b19ff26f | 78 | const bt_field_class *field_class); |
40f4ba76 PP |
79 | |
80 | extern bt_bool bt_field_class_real_is_single_precision( | |
b19ff26f | 81 | const bt_field_class *field_class); |
40f4ba76 PP |
82 | |
83 | extern uint64_t bt_field_class_enumeration_get_mapping_count( | |
b19ff26f | 84 | const bt_field_class *field_class); |
40f4ba76 | 85 | |
9c08c816 PP |
86 | extern const bt_field_class_enumeration_unsigned_mapping * |
87 | bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const( | |
8f3ccfbc PP |
88 | const bt_field_class *field_class, uint64_t index); |
89 | ||
9c08c816 PP |
90 | extern const bt_field_class_enumeration_unsigned_mapping * |
91 | bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const( | |
45c51519 PP |
92 | const bt_field_class *field_class, const char *label); |
93 | ||
9c08c816 PP |
94 | extern const bt_field_class_enumeration_signed_mapping * |
95 | bt_field_class_enumeration_signed_borrow_mapping_by_index_const( | |
8f3ccfbc PP |
96 | const bt_field_class *field_class, uint64_t index); |
97 | ||
9c08c816 PP |
98 | extern const bt_field_class_enumeration_signed_mapping * |
99 | bt_field_class_enumeration_signed_borrow_mapping_by_label_const( | |
45c51519 PP |
100 | const bt_field_class *field_class, const char *label); |
101 | ||
8f3ccfbc PP |
102 | static inline |
103 | const bt_field_class_enumeration_mapping * | |
9c08c816 PP |
104 | bt_field_class_enumeration_unsigned_mapping_as_mapping_const( |
105 | const bt_field_class_enumeration_unsigned_mapping *mapping) | |
8f3ccfbc | 106 | { |
005f1204 | 107 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
8f3ccfbc | 108 | } |
40f4ba76 | 109 | |
8f3ccfbc PP |
110 | static inline |
111 | const bt_field_class_enumeration_mapping * | |
9c08c816 PP |
112 | bt_field_class_enumeration_signed_mapping_as_mapping_const( |
113 | const bt_field_class_enumeration_signed_mapping *mapping) | |
8f3ccfbc | 114 | { |
005f1204 | 115 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
8f3ccfbc | 116 | } |
40f4ba76 | 117 | |
8f3ccfbc PP |
118 | extern const char *bt_field_class_enumeration_mapping_get_label( |
119 | const bt_field_class_enumeration_mapping *mapping); | |
40f4ba76 | 120 | |
45c51519 | 121 | extern const bt_integer_range_set_unsigned * |
9c08c816 PP |
122 | bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const( |
123 | const bt_field_class_enumeration_unsigned_mapping *mapping); | |
40f4ba76 | 124 | |
45c51519 | 125 | extern const bt_integer_range_set_signed * |
9c08c816 PP |
126 | bt_field_class_enumeration_signed_mapping_borrow_ranges_const( |
127 | const bt_field_class_enumeration_signed_mapping *mapping); | |
40f4ba76 | 128 | |
185ecf64 | 129 | typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status { |
d24d5663 PP |
130 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
131 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
185ecf64 | 132 | } bt_field_class_enumeration_get_mapping_labels_for_value_status; |
d24d5663 | 133 | |
185ecf64 | 134 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
9c08c816 | 135 | bt_field_class_enumeration_unsigned_get_mapping_labels_for_value( |
b19ff26f | 136 | const bt_field_class *field_class, uint64_t value, |
40f4ba76 PP |
137 | bt_field_class_enumeration_mapping_label_array *label_array, |
138 | uint64_t *count); | |
139 | ||
185ecf64 | 140 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
9c08c816 | 141 | bt_field_class_enumeration_signed_get_mapping_labels_for_value( |
b19ff26f | 142 | const bt_field_class *field_class, int64_t value, |
40f4ba76 PP |
143 | bt_field_class_enumeration_mapping_label_array *label_array, |
144 | uint64_t *count); | |
145 | ||
146 | extern uint64_t bt_field_class_structure_get_member_count( | |
b19ff26f | 147 | const bt_field_class *field_class); |
40f4ba76 | 148 | |
1e6fd1d7 PP |
149 | extern const bt_field_class_structure_member * |
150 | bt_field_class_structure_borrow_member_by_index_const( | |
151 | const bt_field_class *field_class, uint64_t index); | |
40f4ba76 | 152 | |
1e6fd1d7 PP |
153 | extern const bt_field_class_structure_member * |
154 | bt_field_class_structure_borrow_member_by_name_const( | |
b19ff26f | 155 | const bt_field_class *field_class, const char *name); |
40f4ba76 | 156 | |
1e6fd1d7 PP |
157 | extern const char *bt_field_class_structure_member_get_name( |
158 | const bt_field_class_structure_member *member); | |
159 | ||
160 | extern const bt_field_class * | |
161 | bt_field_class_structure_member_borrow_field_class_const( | |
162 | const bt_field_class_structure_member *member); | |
163 | ||
c6962c96 PP |
164 | extern const bt_value *bt_field_class_structure_member_borrow_user_attributes_const( |
165 | const bt_field_class_structure_member *member); | |
166 | ||
b19ff26f | 167 | extern const bt_field_class * |
40f4ba76 | 168 | bt_field_class_array_borrow_element_field_class_const( |
b19ff26f | 169 | const bt_field_class *field_class); |
40f4ba76 | 170 | |
9c08c816 | 171 | extern uint64_t bt_field_class_array_static_get_length( |
b19ff26f | 172 | const bt_field_class *field_class); |
40f4ba76 | 173 | |
b19ff26f | 174 | extern const bt_field_path * |
9c08c816 | 175 | bt_field_class_array_dynamic_borrow_length_field_path_const( |
b19ff26f | 176 | const bt_field_class *field_class); |
40f4ba76 | 177 | |
b38aea74 PP |
178 | extern const bt_field_class * |
179 | bt_field_class_option_borrow_field_class_const( | |
180 | const bt_field_class *field_class); | |
181 | ||
182 | extern const bt_field_path * | |
183 | bt_field_class_option_borrow_selector_field_path_const( | |
184 | const bt_field_class *field_class); | |
185 | ||
40f4ba76 | 186 | extern uint64_t bt_field_class_variant_get_option_count( |
b19ff26f | 187 | const bt_field_class *field_class); |
40f4ba76 | 188 | |
1e6fd1d7 PP |
189 | extern const bt_field_class_variant_option * |
190 | bt_field_class_variant_borrow_option_by_index_const( | |
191 | const bt_field_class *field_class, uint64_t index); | |
40f4ba76 | 192 | |
1e6fd1d7 PP |
193 | extern const bt_field_class_variant_option * |
194 | bt_field_class_variant_borrow_option_by_name_const( | |
195 | const bt_field_class *field_class, const char *name); | |
196 | ||
9c08c816 PP |
197 | extern const bt_field_class_variant_with_selector_unsigned_option * |
198 | bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const( | |
45c51519 PP |
199 | const bt_field_class *field_class, uint64_t index); |
200 | ||
9c08c816 PP |
201 | extern const bt_field_class_variant_with_selector_unsigned_option * |
202 | bt_field_class_variant_with_selector_unsigned_borrow_option_by_name_const( | |
45c51519 PP |
203 | const bt_field_class *field_class, const char *name); |
204 | ||
9c08c816 PP |
205 | extern const bt_field_class_variant_with_selector_signed_option * |
206 | bt_field_class_variant_with_selector_signed_borrow_option_by_index_const( | |
45c51519 PP |
207 | const bt_field_class *field_class, uint64_t index); |
208 | ||
9c08c816 PP |
209 | extern const bt_field_class_variant_with_selector_signed_option * |
210 | bt_field_class_variant_with_selector_signed_borrow_option_by_name_const( | |
45c51519 PP |
211 | const bt_field_class *field_class, const char *name); |
212 | ||
1e6fd1d7 PP |
213 | extern const char *bt_field_class_variant_option_get_name( |
214 | const bt_field_class_variant_option *option); | |
215 | ||
216 | extern const bt_field_class * | |
217 | bt_field_class_variant_option_borrow_field_class_const( | |
218 | const bt_field_class_variant_option *option); | |
40f4ba76 | 219 | |
c6962c96 PP |
220 | extern const bt_value *bt_field_class_variant_option_borrow_user_attributes_const( |
221 | const bt_field_class_variant_option *option); | |
222 | ||
45c51519 PP |
223 | extern const bt_field_path * |
224 | bt_field_class_variant_with_selector_borrow_selector_field_path_const( | |
225 | const bt_field_class *field_class); | |
226 | ||
227 | extern const bt_integer_range_set_unsigned * | |
9c08c816 PP |
228 | bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const( |
229 | const bt_field_class_variant_with_selector_unsigned_option *option); | |
45c51519 PP |
230 | |
231 | static inline | |
232 | const bt_field_class_variant_option * | |
9c08c816 PP |
233 | bt_field_class_variant_with_selector_unsigned_option_as_option_const( |
234 | const bt_field_class_variant_with_selector_unsigned_option *option) | |
45c51519 PP |
235 | { |
236 | return __BT_UPCAST_CONST(bt_field_class_variant_option, option); | |
237 | } | |
238 | ||
239 | extern const bt_integer_range_set_signed * | |
9c08c816 PP |
240 | bt_field_class_variant_with_selector_signed_option_borrow_ranges_const( |
241 | const bt_field_class_variant_with_selector_signed_option *option); | |
45c51519 PP |
242 | |
243 | static inline | |
244 | const bt_field_class_variant_option * | |
9c08c816 PP |
245 | bt_field_class_variant_with_selector_signed_option_as_option_const( |
246 | const bt_field_class_variant_with_selector_signed_option *option) | |
45c51519 PP |
247 | { |
248 | return __BT_UPCAST_CONST(bt_field_class_variant_option, option); | |
249 | } | |
250 | ||
b19ff26f | 251 | extern void bt_field_class_get_ref(const bt_field_class *field_class); |
c5b9b441 | 252 | |
b19ff26f | 253 | extern void bt_field_class_put_ref(const bt_field_class *field_class); |
c5b9b441 PP |
254 | |
255 | #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \ | |
256 | do { \ | |
257 | bt_field_class_put_ref(_var); \ | |
258 | (_var) = NULL; \ | |
259 | } while (0) | |
260 | ||
261 | #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
262 | do { \ | |
263 | bt_field_class_put_ref(_var_dst); \ | |
264 | (_var_dst) = (_var_src); \ | |
265 | (_var_src) = NULL; \ | |
266 | } while (0) | |
267 | ||
268 | ||
40f4ba76 PP |
269 | #ifdef __cplusplus |
270 | } | |
271 | #endif | |
272 | ||
924dc299 | 273 | #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */ |