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
,
41 BT_FIELD_CLASS_TYPE_BIT_ARRAY
,
42 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
,
43 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
,
44 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
,
45 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
,
46 BT_FIELD_CLASS_TYPE_REAL
,
47 BT_FIELD_CLASS_TYPE_STRING
,
48 BT_FIELD_CLASS_TYPE_STRUCTURE
,
49 BT_FIELD_CLASS_TYPE_STATIC_ARRAY
,
50 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
,
51 BT_FIELD_CLASS_TYPE_OPTION
,
52 BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR
,
53 BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR
,
54 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR
,
55 } bt_field_class_type
;
57 typedef enum bt_field_class_integer_preferred_display_base
{
58 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
,
59 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
,
60 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
,
61 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
,
62 } bt_field_class_integer_preferred_display_base
;
64 extern bt_field_class_type
bt_field_class_get_type(
65 const bt_field_class
*field_class
);
67 extern const bt_value
*bt_field_class_borrow_user_attributes_const(
68 const bt_field_class
*field_class
);
70 extern uint64_t bt_field_class_bit_array_get_length(
71 const bt_field_class
*field_class
);
73 extern uint64_t bt_field_class_integer_get_field_value_range(
74 const bt_field_class
*field_class
);
76 extern bt_field_class_integer_preferred_display_base
77 bt_field_class_integer_get_preferred_display_base(
78 const bt_field_class
*field_class
);
80 extern bt_bool
bt_field_class_real_is_single_precision(
81 const bt_field_class
*field_class
);
83 extern uint64_t bt_field_class_enumeration_get_mapping_count(
84 const bt_field_class
*field_class
);
86 extern const bt_field_class_enumeration_unsigned_mapping
*
87 bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
88 const bt_field_class
*field_class
, uint64_t index
);
90 extern const bt_field_class_enumeration_unsigned_mapping
*
91 bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
92 const bt_field_class
*field_class
, const char *label
);
94 extern const bt_field_class_enumeration_signed_mapping
*
95 bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
96 const bt_field_class
*field_class
, uint64_t index
);
98 extern const bt_field_class_enumeration_signed_mapping
*
99 bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
100 const bt_field_class
*field_class
, const char *label
);
103 const bt_field_class_enumeration_mapping
*
104 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
105 const bt_field_class_enumeration_unsigned_mapping
*mapping
)
107 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
111 const bt_field_class_enumeration_mapping
*
112 bt_field_class_enumeration_signed_mapping_as_mapping_const(
113 const bt_field_class_enumeration_signed_mapping
*mapping
)
115 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
118 extern const char *bt_field_class_enumeration_mapping_get_label(
119 const bt_field_class_enumeration_mapping
*mapping
);
121 extern const bt_integer_range_set_unsigned
*
122 bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
123 const bt_field_class_enumeration_unsigned_mapping
*mapping
);
125 extern const bt_integer_range_set_signed
*
126 bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
127 const bt_field_class_enumeration_signed_mapping
*mapping
);
129 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status
{
130 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
131 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
132 } bt_field_class_enumeration_get_mapping_labels_for_value_status
;
134 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
135 bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
136 const bt_field_class
*field_class
, uint64_t value
,
137 bt_field_class_enumeration_mapping_label_array
*label_array
,
140 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
141 bt_field_class_enumeration_signed_get_mapping_labels_for_value(
142 const bt_field_class
*field_class
, int64_t value
,
143 bt_field_class_enumeration_mapping_label_array
*label_array
,
146 extern uint64_t bt_field_class_structure_get_member_count(
147 const bt_field_class
*field_class
);
149 extern const bt_field_class_structure_member
*
150 bt_field_class_structure_borrow_member_by_index_const(
151 const bt_field_class
*field_class
, uint64_t index
);
153 extern const bt_field_class_structure_member
*
154 bt_field_class_structure_borrow_member_by_name_const(
155 const bt_field_class
*field_class
, const char *name
);
157 extern const char *bt_field_class_structure_member_get_name(
158 const bt_field_class_structure_member
*member
);
160 extern const bt_field_class
*
161 bt_field_class_structure_member_borrow_field_class_const(
162 const bt_field_class_structure_member
*member
);
164 extern const bt_value
*bt_field_class_structure_member_borrow_user_attributes_const(
165 const bt_field_class_structure_member
*member
);
167 extern const bt_field_class
*
168 bt_field_class_array_borrow_element_field_class_const(
169 const bt_field_class
*field_class
);
171 extern uint64_t bt_field_class_array_static_get_length(
172 const bt_field_class
*field_class
);
174 extern const bt_field_path
*
175 bt_field_class_array_dynamic_borrow_length_field_path_const(
176 const bt_field_class
*field_class
);
178 extern const bt_field_class
*
179 bt_field_class_option_borrow_field_class_const(
180 const bt_field_class
*field_class
);
182 extern const bt_field_path
*
183 bt_field_class_option_borrow_selector_field_path_const(
184 const bt_field_class
*field_class
);
186 extern uint64_t bt_field_class_variant_get_option_count(
187 const bt_field_class
*field_class
);
189 extern const bt_field_class_variant_option
*
190 bt_field_class_variant_borrow_option_by_index_const(
191 const bt_field_class
*field_class
, uint64_t index
);
193 extern const bt_field_class_variant_option
*
194 bt_field_class_variant_borrow_option_by_name_const(
195 const bt_field_class
*field_class
, const char *name
);
197 extern const bt_field_class_variant_with_selector_unsigned_option
*
198 bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const(
199 const bt_field_class
*field_class
, uint64_t index
);
201 extern const bt_field_class_variant_with_selector_unsigned_option
*
202 bt_field_class_variant_with_selector_unsigned_borrow_option_by_name_const(
203 const bt_field_class
*field_class
, const char *name
);
205 extern const bt_field_class_variant_with_selector_signed_option
*
206 bt_field_class_variant_with_selector_signed_borrow_option_by_index_const(
207 const bt_field_class
*field_class
, uint64_t index
);
209 extern const bt_field_class_variant_with_selector_signed_option
*
210 bt_field_class_variant_with_selector_signed_borrow_option_by_name_const(
211 const bt_field_class
*field_class
, const char *name
);
213 extern const char *bt_field_class_variant_option_get_name(
214 const bt_field_class_variant_option
*option
);
216 extern const bt_field_class
*
217 bt_field_class_variant_option_borrow_field_class_const(
218 const bt_field_class_variant_option
*option
);
220 extern const bt_value
*bt_field_class_variant_option_borrow_user_attributes_const(
221 const bt_field_class_variant_option
*option
);
223 extern const bt_field_path
*
224 bt_field_class_variant_with_selector_borrow_selector_field_path_const(
225 const bt_field_class
*field_class
);
227 extern const bt_integer_range_set_unsigned
*
228 bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const(
229 const bt_field_class_variant_with_selector_unsigned_option
*option
);
232 const bt_field_class_variant_option
*
233 bt_field_class_variant_with_selector_unsigned_option_as_option_const(
234 const bt_field_class_variant_with_selector_unsigned_option
*option
)
236 return __BT_UPCAST_CONST(bt_field_class_variant_option
, option
);
239 extern const bt_integer_range_set_signed
*
240 bt_field_class_variant_with_selector_signed_option_borrow_ranges_const(
241 const bt_field_class_variant_with_selector_signed_option
*option
);
244 const bt_field_class_variant_option
*
245 bt_field_class_variant_with_selector_signed_option_as_option_const(
246 const bt_field_class_variant_with_selector_signed_option
*option
)
248 return __BT_UPCAST_CONST(bt_field_class_variant_option
, option
);
251 extern void bt_field_class_get_ref(const bt_field_class
*field_class
);
253 extern void bt_field_class_put_ref(const bt_field_class
*field_class
);
255 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
257 bt_field_class_put_ref(_var); \
261 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
263 bt_field_class_put_ref(_var_dst); \
264 (_var_dst) = (_var_src); \
273 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */