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