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