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