lib: add option field classes with integer selectors
[babeltrace.git] / include / babeltrace2 / trace-ir / field-class-const.h
CommitLineData
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
36extern "C" {
37#endif
38
ee78f405 39typedef enum bt_field_class_type {
467673c1
PP
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_SELECTOR = 17,
58 BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR = 18,
ee78f405 59} bt_field_class_type;
78cf9df6 60
ee78f405 61typedef enum bt_field_class_integer_preferred_display_base {
a0c6c1d7
PP
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,
ee78f405 66} bt_field_class_integer_preferred_display_base;
78cf9df6 67
ee78f405 68extern bt_field_class_type bt_field_class_get_type(
8eee8ea2 69 const bt_field_class *field_class);
78cf9df6 70
af90138b
PP
71extern const bt_value *bt_field_class_borrow_user_attributes_const(
72 const bt_field_class *field_class);
73
6943da6a
PP
74extern uint64_t bt_field_class_bit_array_get_length(
75 const bt_field_class *field_class);
76
78cf9df6 77extern uint64_t bt_field_class_integer_get_field_value_range(
8eee8ea2 78 const bt_field_class *field_class);
78cf9df6 79
ee78f405 80extern bt_field_class_integer_preferred_display_base
78cf9df6 81bt_field_class_integer_get_preferred_display_base(
8eee8ea2 82 const bt_field_class *field_class);
78cf9df6 83
78cf9df6 84extern uint64_t bt_field_class_enumeration_get_mapping_count(
8eee8ea2 85 const bt_field_class *field_class);
78cf9df6 86
60bbfc7c
PP
87extern const bt_field_class_enumeration_unsigned_mapping *
88bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
b6baf3bb
PP
89 const bt_field_class *field_class, uint64_t index);
90
60bbfc7c
PP
91extern const bt_field_class_enumeration_unsigned_mapping *
92bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
02b61fe0
PP
93 const bt_field_class *field_class, const char *label);
94
60bbfc7c
PP
95extern const bt_field_class_enumeration_signed_mapping *
96bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
b6baf3bb
PP
97 const bt_field_class *field_class, uint64_t index);
98
60bbfc7c
PP
99extern const bt_field_class_enumeration_signed_mapping *
100bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
02b61fe0
PP
101 const bt_field_class *field_class, const char *label);
102
b6baf3bb
PP
103static inline
104const bt_field_class_enumeration_mapping *
60bbfc7c
PP
105bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
106 const bt_field_class_enumeration_unsigned_mapping *mapping)
b6baf3bb 107{
8470daa9 108 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
b6baf3bb 109}
78cf9df6 110
b6baf3bb
PP
111static inline
112const bt_field_class_enumeration_mapping *
60bbfc7c
PP
113bt_field_class_enumeration_signed_mapping_as_mapping_const(
114 const bt_field_class_enumeration_signed_mapping *mapping)
b6baf3bb 115{
8470daa9 116 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
b6baf3bb 117}
78cf9df6 118
b6baf3bb
PP
119extern const char *bt_field_class_enumeration_mapping_get_label(
120 const bt_field_class_enumeration_mapping *mapping);
78cf9df6 121
02b61fe0 122extern const bt_integer_range_set_unsigned *
60bbfc7c
PP
123bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
124 const bt_field_class_enumeration_unsigned_mapping *mapping);
78cf9df6 125
02b61fe0 126extern const bt_integer_range_set_signed *
60bbfc7c
PP
127bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
128 const bt_field_class_enumeration_signed_mapping *mapping);
78cf9df6 129
1091bb60 130typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
fb25b9e3
PP
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,
1091bb60 133} bt_field_class_enumeration_get_mapping_labels_for_value_status;
fb25b9e3 134
1091bb60 135extern bt_field_class_enumeration_get_mapping_labels_for_value_status
60bbfc7c 136bt_field_class_enumeration_unsigned_get_mapping_labels_for_value(
8eee8ea2 137 const bt_field_class *field_class, uint64_t value,
78cf9df6
PP
138 bt_field_class_enumeration_mapping_label_array *label_array,
139 uint64_t *count);
140
1091bb60 141extern bt_field_class_enumeration_get_mapping_labels_for_value_status
60bbfc7c 142bt_field_class_enumeration_signed_get_mapping_labels_for_value(
8eee8ea2 143 const bt_field_class *field_class, int64_t value,
78cf9df6
PP
144 bt_field_class_enumeration_mapping_label_array *label_array,
145 uint64_t *count);
146
147extern uint64_t bt_field_class_structure_get_member_count(
8eee8ea2 148 const bt_field_class *field_class);
78cf9df6 149
e24f271a
PP
150extern const bt_field_class_structure_member *
151bt_field_class_structure_borrow_member_by_index_const(
152 const bt_field_class *field_class, uint64_t index);
78cf9df6 153
e24f271a
PP
154extern const bt_field_class_structure_member *
155bt_field_class_structure_borrow_member_by_name_const(
8eee8ea2 156 const bt_field_class *field_class, const char *name);
78cf9df6 157
e24f271a
PP
158extern const char *bt_field_class_structure_member_get_name(
159 const bt_field_class_structure_member *member);
160
161extern const bt_field_class *
162bt_field_class_structure_member_borrow_field_class_const(
163 const bt_field_class_structure_member *member);
164
af90138b
PP
165extern const bt_value *bt_field_class_structure_member_borrow_user_attributes_const(
166 const bt_field_class_structure_member *member);
167
8eee8ea2 168extern const bt_field_class *
78cf9df6 169bt_field_class_array_borrow_element_field_class_const(
8eee8ea2 170 const bt_field_class *field_class);
78cf9df6 171
60bbfc7c 172extern uint64_t bt_field_class_array_static_get_length(
8eee8ea2 173 const bt_field_class *field_class);
78cf9df6 174
8eee8ea2 175extern const bt_field_path *
60bbfc7c 176bt_field_class_array_dynamic_borrow_length_field_path_const(
8eee8ea2 177 const bt_field_class *field_class);
78cf9df6 178
247fa9e3
PP
179extern const bt_field_class *
180bt_field_class_option_borrow_field_class_const(
181 const bt_field_class *field_class);
182
183extern const bt_field_path *
467673c1
PP
184bt_field_class_option_with_selector_borrow_selector_field_path_const(
185 const bt_field_class *field_class);
186
187extern bt_bool
188bt_field_class_option_with_selector_bool_selector_is_reversed(
189 const bt_field_class *field_class);
190
191extern const bt_integer_range_set_unsigned *
192bt_field_class_option_with_selector_integer_unsigned_borrow_selector_ranges_const(
193 const bt_field_class *field_class);
194
195extern const bt_integer_range_set_signed *
196bt_field_class_option_with_selector_integer_signed_borrow_selector_ranges_const(
247fa9e3
PP
197 const bt_field_class *field_class);
198
78cf9df6 199extern uint64_t bt_field_class_variant_get_option_count(
8eee8ea2 200 const bt_field_class *field_class);
78cf9df6 201
e24f271a
PP
202extern const bt_field_class_variant_option *
203bt_field_class_variant_borrow_option_by_index_const(
204 const bt_field_class *field_class, uint64_t index);
78cf9df6 205
e24f271a
PP
206extern const bt_field_class_variant_option *
207bt_field_class_variant_borrow_option_by_name_const(
208 const bt_field_class *field_class, const char *name);
209
60bbfc7c
PP
210extern const bt_field_class_variant_with_selector_unsigned_option *
211bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const(
02b61fe0
PP
212 const bt_field_class *field_class, uint64_t index);
213
60bbfc7c
PP
214extern const bt_field_class_variant_with_selector_unsigned_option *
215bt_field_class_variant_with_selector_unsigned_borrow_option_by_name_const(
02b61fe0
PP
216 const bt_field_class *field_class, const char *name);
217
60bbfc7c
PP
218extern const bt_field_class_variant_with_selector_signed_option *
219bt_field_class_variant_with_selector_signed_borrow_option_by_index_const(
02b61fe0
PP
220 const bt_field_class *field_class, uint64_t index);
221
60bbfc7c
PP
222extern const bt_field_class_variant_with_selector_signed_option *
223bt_field_class_variant_with_selector_signed_borrow_option_by_name_const(
02b61fe0
PP
224 const bt_field_class *field_class, const char *name);
225
e24f271a
PP
226extern const char *bt_field_class_variant_option_get_name(
227 const bt_field_class_variant_option *option);
228
229extern const bt_field_class *
230bt_field_class_variant_option_borrow_field_class_const(
231 const bt_field_class_variant_option *option);
78cf9df6 232
af90138b
PP
233extern const bt_value *bt_field_class_variant_option_borrow_user_attributes_const(
234 const bt_field_class_variant_option *option);
235
02b61fe0
PP
236extern const bt_field_path *
237bt_field_class_variant_with_selector_borrow_selector_field_path_const(
238 const bt_field_class *field_class);
239
240extern const bt_integer_range_set_unsigned *
60bbfc7c
PP
241bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const(
242 const bt_field_class_variant_with_selector_unsigned_option *option);
02b61fe0
PP
243
244static inline
245const bt_field_class_variant_option *
60bbfc7c
PP
246bt_field_class_variant_with_selector_unsigned_option_as_option_const(
247 const bt_field_class_variant_with_selector_unsigned_option *option)
02b61fe0
PP
248{
249 return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
250}
251
252extern const bt_integer_range_set_signed *
60bbfc7c
PP
253bt_field_class_variant_with_selector_signed_option_borrow_ranges_const(
254 const bt_field_class_variant_with_selector_signed_option *option);
02b61fe0
PP
255
256static inline
257const bt_field_class_variant_option *
60bbfc7c
PP
258bt_field_class_variant_with_selector_signed_option_as_option_const(
259 const bt_field_class_variant_with_selector_signed_option *option)
02b61fe0
PP
260{
261 return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
262}
263
8eee8ea2 264extern void bt_field_class_get_ref(const bt_field_class *field_class);
8c6884d9 265
8eee8ea2 266extern void bt_field_class_put_ref(const bt_field_class *field_class);
8c6884d9
PP
267
268#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
269 do { \
270 bt_field_class_put_ref(_var); \
271 (_var) = NULL; \
272 } while (0)
273
274#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
275 do { \
276 bt_field_class_put_ref(_var_dst); \
277 (_var_dst) = (_var_src); \
278 (_var_src) = NULL; \
279 } while (0)
280
281
78cf9df6
PP
282#ifdef __cplusplus
283}
284#endif
285
3fd40f46 286#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */
This page took 0.051202 seconds and 4 git commands to generate.