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