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_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
,
50 BT_FIELD_CLASS_TYPE_OPTION
,
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
,
54 } bt_field_class_type
;
56 typedef enum bt_field_class_integer_preferred_display_base
{
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
,
61 } bt_field_class_integer_preferred_display_base
;
63 extern bt_field_class_type
bt_field_class_get_type(
64 const bt_field_class
*field_class
);
66 extern uint64_t bt_field_class_integer_get_field_value_range(
67 const bt_field_class
*field_class
);
69 extern bt_field_class_integer_preferred_display_base
70 bt_field_class_integer_get_preferred_display_base(
71 const bt_field_class
*field_class
);
73 extern bt_bool
bt_field_class_real_is_single_precision(
74 const bt_field_class
*field_class
);
76 extern uint64_t bt_field_class_enumeration_get_mapping_count(
77 const bt_field_class
*field_class
);
79 extern const bt_field_class_enumeration_unsigned_mapping
*
80 bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
81 const bt_field_class
*field_class
, uint64_t index
);
83 extern const bt_field_class_enumeration_unsigned_mapping
*
84 bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
85 const bt_field_class
*field_class
, const char *label
);
87 extern const bt_field_class_enumeration_signed_mapping
*
88 bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
89 const bt_field_class
*field_class
, uint64_t index
);
91 extern const bt_field_class_enumeration_signed_mapping
*
92 bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
93 const bt_field_class
*field_class
, const char *label
);
96 const bt_field_class_enumeration_mapping
*
97 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
98 const bt_field_class_enumeration_unsigned_mapping
*mapping
)
100 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
104 const bt_field_class_enumeration_mapping
*
105 bt_field_class_enumeration_signed_mapping_as_mapping_const(
106 const bt_field_class_enumeration_signed_mapping
*mapping
)
108 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
111 extern const char *bt_field_class_enumeration_mapping_get_label(
112 const bt_field_class_enumeration_mapping
*mapping
);
114 extern const bt_integer_range_set_unsigned
*
115 bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
116 const bt_field_class_enumeration_unsigned_mapping
*mapping
);
118 extern const bt_integer_range_set_signed
*
119 bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
120 const bt_field_class_enumeration_signed_mapping
*mapping
);
122 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status
{
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
,
125 } bt_field_class_enumeration_get_mapping_labels_for_value_status
;
127 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
128 bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
129 const bt_field_class
*field_class
, uint64_t value
,
130 bt_field_class_enumeration_mapping_label_array
*label_array
,
133 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
134 bt_field_class_enumeration_signed_get_mapping_labels_for_value(
135 const bt_field_class
*field_class
, int64_t value
,
136 bt_field_class_enumeration_mapping_label_array
*label_array
,
139 extern uint64_t bt_field_class_structure_get_member_count(
140 const bt_field_class
*field_class
);
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
);
146 extern const bt_field_class_structure_member
*
147 bt_field_class_structure_borrow_member_by_name_const(
148 const bt_field_class
*field_class
, const char *name
);
150 extern const char *bt_field_class_structure_member_get_name(
151 const bt_field_class_structure_member
*member
);
153 extern const bt_field_class
*
154 bt_field_class_structure_member_borrow_field_class_const(
155 const bt_field_class_structure_member
*member
);
157 extern const bt_field_class
*
158 bt_field_class_array_borrow_element_field_class_const(
159 const bt_field_class
*field_class
);
161 extern uint64_t bt_field_class_array_static_get_length(
162 const bt_field_class
*field_class
);
164 extern const bt_field_path
*
165 bt_field_class_array_dynamic_borrow_length_field_path_const(
166 const bt_field_class
*field_class
);
168 extern const bt_field_class
*
169 bt_field_class_option_borrow_field_class_const(
170 const bt_field_class
*field_class
);
172 extern const bt_field_path
*
173 bt_field_class_option_borrow_selector_field_path_const(
174 const bt_field_class
*field_class
);
176 extern uint64_t bt_field_class_variant_get_option_count(
177 const bt_field_class
*field_class
);
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
);
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
);
187 extern const bt_field_class_variant_with_selector_unsigned_option
*
188 bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const(
189 const bt_field_class
*field_class
, uint64_t index
);
191 extern const bt_field_class_variant_with_selector_unsigned_option
*
192 bt_field_class_variant_with_selector_unsigned_borrow_option_by_name_const(
193 const bt_field_class
*field_class
, const char *name
);
195 extern const bt_field_class_variant_with_selector_signed_option
*
196 bt_field_class_variant_with_selector_signed_borrow_option_by_index_const(
197 const bt_field_class
*field_class
, uint64_t index
);
199 extern const bt_field_class_variant_with_selector_signed_option
*
200 bt_field_class_variant_with_selector_signed_borrow_option_by_name_const(
201 const bt_field_class
*field_class
, const char *name
);
203 extern const char *bt_field_class_variant_option_get_name(
204 const bt_field_class_variant_option
*option
);
206 extern const bt_field_class
*
207 bt_field_class_variant_option_borrow_field_class_const(
208 const bt_field_class_variant_option
*option
);
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
);
214 extern const bt_integer_range_set_unsigned
*
215 bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const(
216 const bt_field_class_variant_with_selector_unsigned_option
*option
);
219 const bt_field_class_variant_option
*
220 bt_field_class_variant_with_selector_unsigned_option_as_option_const(
221 const bt_field_class_variant_with_selector_unsigned_option
*option
)
223 return __BT_UPCAST_CONST(bt_field_class_variant_option
, option
);
226 extern const bt_integer_range_set_signed
*
227 bt_field_class_variant_with_selector_signed_option_borrow_ranges_const(
228 const bt_field_class_variant_with_selector_signed_option
*option
);
231 const bt_field_class_variant_option
*
232 bt_field_class_variant_with_selector_signed_option_as_option_const(
233 const bt_field_class_variant_with_selector_signed_option
*option
)
235 return __BT_UPCAST_CONST(bt_field_class_variant_option
, option
);
238 extern void bt_field_class_get_ref(const bt_field_class
*field_class
);
240 extern void bt_field_class_put_ref(const bt_field_class
*field_class
);
242 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
244 bt_field_class_put_ref(_var); \
248 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
250 bt_field_class_put_ref(_var_dst); \
251 (_var_dst) = (_var_src); \
260 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */