1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
2 #define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
33 #include <babeltrace2/types.h>
39 typedef enum bt_field_class_type
{
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_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_WITHOUT_SELECTOR
= 12,
53 BT_FIELD_CLASS_TYPE_OPTION_WITH_BOOL_SELECTOR
= 13,
54 BT_FIELD_CLASS_TYPE_OPTION_WITH_UNSIGNED_INTEGER_SELECTOR
= 14,
55 BT_FIELD_CLASS_TYPE_OPTION_WITH_SIGNED_INTEGER_SELECTOR
= 15,
56 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
= 16,
57 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_INTEGER_SELECTOR
= 17,
58 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_INTEGER_SELECTOR
= 18,
59 } bt_field_class_type
;
61 typedef enum bt_field_class_integer_preferred_display_base
{
62 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
= 2,
63 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
= 8,
64 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
= 10,
65 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
= 16,
66 } bt_field_class_integer_preferred_display_base
;
68 extern bt_field_class_type
bt_field_class_get_type(
69 const bt_field_class
*field_class
);
71 extern const bt_value
*bt_field_class_borrow_user_attributes_const(
72 const bt_field_class
*field_class
);
74 extern uint64_t bt_field_class_bit_array_get_length(
75 const bt_field_class
*field_class
);
77 extern uint64_t bt_field_class_integer_get_field_value_range(
78 const bt_field_class
*field_class
);
80 extern bt_field_class_integer_preferred_display_base
81 bt_field_class_integer_get_preferred_display_base(
82 const bt_field_class
*field_class
);
84 extern uint64_t bt_field_class_enumeration_get_mapping_count(
85 const bt_field_class
*field_class
);
87 extern const bt_field_class_enumeration_unsigned_mapping
*
88 bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
89 const bt_field_class
*field_class
, uint64_t index
);
91 extern const bt_field_class_enumeration_unsigned_mapping
*
92 bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
93 const bt_field_class
*field_class
, const char *label
);
95 extern const bt_field_class_enumeration_signed_mapping
*
96 bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
97 const bt_field_class
*field_class
, uint64_t index
);
99 extern const bt_field_class_enumeration_signed_mapping
*
100 bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
101 const bt_field_class
*field_class
, const char *label
);
104 const bt_field_class_enumeration_mapping
*
105 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
106 const bt_field_class_enumeration_unsigned_mapping
*mapping
)
108 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
112 const bt_field_class_enumeration_mapping
*
113 bt_field_class_enumeration_signed_mapping_as_mapping_const(
114 const bt_field_class_enumeration_signed_mapping
*mapping
)
116 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
119 extern const char *bt_field_class_enumeration_mapping_get_label(
120 const bt_field_class_enumeration_mapping
*mapping
);
122 extern const bt_integer_range_set_unsigned
*
123 bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
124 const bt_field_class_enumeration_unsigned_mapping
*mapping
);
126 extern const bt_integer_range_set_signed
*
127 bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
128 const bt_field_class_enumeration_signed_mapping
*mapping
);
130 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status
{
131 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
132 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
133 } bt_field_class_enumeration_get_mapping_labels_for_value_status
;
135 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
136 bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
137 const bt_field_class
*field_class
, uint64_t value
,
138 bt_field_class_enumeration_mapping_label_array
*label_array
,
141 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
142 bt_field_class_enumeration_signed_get_mapping_labels_for_value(
143 const bt_field_class
*field_class
, int64_t value
,
144 bt_field_class_enumeration_mapping_label_array
*label_array
,
147 extern uint64_t bt_field_class_structure_get_member_count(
148 const bt_field_class
*field_class
);
150 extern const bt_field_class_structure_member
*
151 bt_field_class_structure_borrow_member_by_index_const(
152 const bt_field_class
*field_class
, uint64_t index
);
154 extern const bt_field_class_structure_member
*
155 bt_field_class_structure_borrow_member_by_name_const(
156 const bt_field_class
*field_class
, const char *name
);
158 extern const char *bt_field_class_structure_member_get_name(
159 const bt_field_class_structure_member
*member
);
161 extern const bt_field_class
*
162 bt_field_class_structure_member_borrow_field_class_const(
163 const bt_field_class_structure_member
*member
);
165 extern const bt_value
*bt_field_class_structure_member_borrow_user_attributes_const(
166 const bt_field_class_structure_member
*member
);
168 extern const bt_field_class
*
169 bt_field_class_array_borrow_element_field_class_const(
170 const bt_field_class
*field_class
);
172 extern uint64_t bt_field_class_array_static_get_length(
173 const bt_field_class
*field_class
);
175 extern const bt_field_path
*
176 bt_field_class_array_dynamic_borrow_length_field_path_const(
177 const bt_field_class
*field_class
);
179 extern const bt_field_class
*
180 bt_field_class_option_borrow_field_class_const(
181 const bt_field_class
*field_class
);
183 extern const bt_field_path
*
184 bt_field_class_option_with_selector_borrow_selector_field_path_const(
185 const bt_field_class
*field_class
);
188 bt_field_class_option_with_selector_bool_selector_is_reversed(
189 const bt_field_class
*field_class
);
191 extern const bt_integer_range_set_unsigned
*
192 bt_field_class_option_with_selector_integer_unsigned_borrow_selector_ranges_const(
193 const bt_field_class
*field_class
);
195 extern const bt_integer_range_set_signed
*
196 bt_field_class_option_with_selector_integer_signed_borrow_selector_ranges_const(
197 const bt_field_class
*field_class
);
199 extern uint64_t bt_field_class_variant_get_option_count(
200 const bt_field_class
*field_class
);
202 extern const bt_field_class_variant_option
*
203 bt_field_class_variant_borrow_option_by_index_const(
204 const bt_field_class
*field_class
, uint64_t index
);
206 extern const bt_field_class_variant_option
*
207 bt_field_class_variant_borrow_option_by_name_const(
208 const bt_field_class
*field_class
, const char *name
);
210 extern const bt_field_class_variant_with_selector_integer_unsigned_option
*
211 bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_index_const(
212 const bt_field_class
*field_class
, uint64_t index
);
214 extern const bt_field_class_variant_with_selector_integer_unsigned_option
*
215 bt_field_class_variant_with_selector_integer_unsigned_borrow_option_by_name_const(
216 const bt_field_class
*field_class
, const char *name
);
218 extern const bt_field_class_variant_with_selector_integer_signed_option
*
219 bt_field_class_variant_with_selector_integer_signed_borrow_option_by_index_const(
220 const bt_field_class
*field_class
, uint64_t index
);
222 extern const bt_field_class_variant_with_selector_integer_signed_option
*
223 bt_field_class_variant_with_selector_integer_signed_borrow_option_by_name_const(
224 const bt_field_class
*field_class
, const char *name
);
226 extern const char *bt_field_class_variant_option_get_name(
227 const bt_field_class_variant_option
*option
);
229 extern const bt_field_class
*
230 bt_field_class_variant_option_borrow_field_class_const(
231 const bt_field_class_variant_option
*option
);
233 extern const bt_value
*bt_field_class_variant_option_borrow_user_attributes_const(
234 const bt_field_class_variant_option
*option
);
236 extern const bt_field_path
*
237 bt_field_class_variant_with_selector_borrow_selector_field_path_const(
238 const bt_field_class
*field_class
);
240 extern const bt_integer_range_set_unsigned
*
241 bt_field_class_variant_with_selector_integer_unsigned_option_borrow_ranges_const(
242 const bt_field_class_variant_with_selector_integer_unsigned_option
*option
);
245 const bt_field_class_variant_option
*
246 bt_field_class_variant_with_selector_integer_unsigned_option_as_option_const(
247 const bt_field_class_variant_with_selector_integer_unsigned_option
*option
)
249 return __BT_UPCAST_CONST(bt_field_class_variant_option
, option
);
252 extern const bt_integer_range_set_signed
*
253 bt_field_class_variant_with_selector_integer_signed_option_borrow_ranges_const(
254 const bt_field_class_variant_with_selector_integer_signed_option
*option
);
257 const bt_field_class_variant_option
*
258 bt_field_class_variant_with_selector_integer_signed_option_as_option_const(
259 const bt_field_class_variant_with_selector_integer_signed_option
*option
)
261 return __BT_UPCAST_CONST(bt_field_class_variant_option
, option
);
264 extern void bt_field_class_get_ref(const bt_field_class
*field_class
);
266 extern void bt_field_class_put_ref(const bt_field_class
*field_class
);
268 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
270 bt_field_class_put_ref(_var); \
274 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
276 bt_field_class_put_ref(_var_dst); \
277 (_var_dst) = (_var_src); \
286 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */