Commit | Line | Data |
---|---|---|
924dc299 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H | |
40f4ba76 PP |
3 | |
4 | /* | |
bbb7b5f0 | 5 | * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation |
40f4ba76 | 6 | * |
40f4ba76 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. | |
40f4ba76 PP |
24 | */ |
25 | ||
4fa90f32 PP |
26 | #ifndef __BT_IN_BABELTRACE_H |
27 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
28 | #endif | |
29 | ||
40f4ba76 PP |
30 | #include <stdint.h> |
31 | #include <stddef.h> | |
32 | ||
959b3d46 PP |
33 | #include <babeltrace2/types.h> |
34 | ||
40f4ba76 PP |
35 | #ifdef __cplusplus |
36 | extern "C" { | |
37 | #endif | |
38 | ||
4cdfc5e8 | 39 | typedef enum bt_field_class_type { |
40f4ba76 PP |
40 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER, |
41 | BT_FIELD_CLASS_TYPE_SIGNED_INTEGER, | |
42 | BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, | |
43 | BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, | |
44 | BT_FIELD_CLASS_TYPE_REAL, | |
45 | BT_FIELD_CLASS_TYPE_STRING, | |
46 | BT_FIELD_CLASS_TYPE_STRUCTURE, | |
47 | BT_FIELD_CLASS_TYPE_STATIC_ARRAY, | |
48 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, | |
49 | BT_FIELD_CLASS_TYPE_VARIANT, | |
4cdfc5e8 | 50 | } bt_field_class_type; |
40f4ba76 | 51 | |
4cdfc5e8 | 52 | typedef enum bt_field_class_integer_preferred_display_base { |
40f4ba76 PP |
53 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY, |
54 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL, | |
55 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL, | |
56 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL, | |
4cdfc5e8 | 57 | } bt_field_class_integer_preferred_display_base; |
40f4ba76 | 58 | |
4cdfc5e8 | 59 | extern bt_field_class_type bt_field_class_get_type( |
b19ff26f | 60 | const bt_field_class *field_class); |
40f4ba76 PP |
61 | |
62 | extern uint64_t bt_field_class_integer_get_field_value_range( | |
b19ff26f | 63 | const bt_field_class *field_class); |
40f4ba76 | 64 | |
4cdfc5e8 | 65 | extern bt_field_class_integer_preferred_display_base |
40f4ba76 | 66 | bt_field_class_integer_get_preferred_display_base( |
b19ff26f | 67 | const bt_field_class *field_class); |
40f4ba76 PP |
68 | |
69 | extern bt_bool bt_field_class_real_is_single_precision( | |
b19ff26f | 70 | const bt_field_class *field_class); |
40f4ba76 PP |
71 | |
72 | extern uint64_t bt_field_class_enumeration_get_mapping_count( | |
b19ff26f | 73 | const bt_field_class *field_class); |
40f4ba76 | 74 | |
8f3ccfbc PP |
75 | extern const bt_field_class_unsigned_enumeration_mapping * |
76 | bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const( | |
77 | const bt_field_class *field_class, uint64_t index); | |
78 | ||
79 | extern const bt_field_class_signed_enumeration_mapping * | |
80 | bt_field_class_signed_enumeration_borrow_mapping_by_index_const( | |
81 | const bt_field_class *field_class, uint64_t index); | |
82 | ||
83 | static inline | |
84 | const bt_field_class_enumeration_mapping * | |
85 | bt_field_class_unsigned_enumeration_mapping_as_mapping_const( | |
86 | const bt_field_class_unsigned_enumeration_mapping *mapping) | |
87 | { | |
005f1204 | 88 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
8f3ccfbc | 89 | } |
40f4ba76 | 90 | |
8f3ccfbc PP |
91 | static inline |
92 | const bt_field_class_enumeration_mapping * | |
93 | bt_field_class_signed_enumeration_mapping_as_mapping_const( | |
94 | const bt_field_class_signed_enumeration_mapping *mapping) | |
95 | { | |
005f1204 | 96 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
8f3ccfbc | 97 | } |
40f4ba76 | 98 | |
8f3ccfbc PP |
99 | extern const char *bt_field_class_enumeration_mapping_get_label( |
100 | const bt_field_class_enumeration_mapping *mapping); | |
40f4ba76 | 101 | |
8f3ccfbc PP |
102 | extern uint64_t bt_field_class_enumeration_mapping_get_range_count( |
103 | const bt_field_class_enumeration_mapping *mapping); | |
40f4ba76 PP |
104 | |
105 | extern void | |
8f3ccfbc PP |
106 | bt_field_class_unsigned_enumeration_mapping_get_range_by_index( |
107 | const bt_field_class_unsigned_enumeration_mapping *mapping, | |
40f4ba76 PP |
108 | uint64_t index, uint64_t *lower, uint64_t *upper); |
109 | ||
110 | extern void | |
8f3ccfbc PP |
111 | bt_field_class_signed_enumeration_mapping_get_range_by_index( |
112 | const bt_field_class_signed_enumeration_mapping *mapping, | |
40f4ba76 PP |
113 | uint64_t index, int64_t *lower, int64_t *upper); |
114 | ||
185ecf64 | 115 | typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status { |
d24d5663 PP |
116 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
117 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
185ecf64 | 118 | } bt_field_class_enumeration_get_mapping_labels_for_value_status; |
d24d5663 | 119 | |
185ecf64 PP |
120 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
121 | bt_field_class_unsigned_enumeration_get_mapping_labels_for_value( | |
b19ff26f | 122 | const bt_field_class *field_class, uint64_t value, |
40f4ba76 PP |
123 | bt_field_class_enumeration_mapping_label_array *label_array, |
124 | uint64_t *count); | |
125 | ||
185ecf64 PP |
126 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
127 | bt_field_class_signed_enumeration_get_mapping_labels_for_value( | |
b19ff26f | 128 | const bt_field_class *field_class, int64_t value, |
40f4ba76 PP |
129 | bt_field_class_enumeration_mapping_label_array *label_array, |
130 | uint64_t *count); | |
131 | ||
132 | extern uint64_t bt_field_class_structure_get_member_count( | |
b19ff26f | 133 | const bt_field_class *field_class); |
40f4ba76 | 134 | |
1e6fd1d7 PP |
135 | extern const bt_field_class_structure_member * |
136 | bt_field_class_structure_borrow_member_by_index_const( | |
137 | const bt_field_class *field_class, uint64_t index); | |
40f4ba76 | 138 | |
1e6fd1d7 PP |
139 | extern const bt_field_class_structure_member * |
140 | bt_field_class_structure_borrow_member_by_name_const( | |
b19ff26f | 141 | const bt_field_class *field_class, const char *name); |
40f4ba76 | 142 | |
1e6fd1d7 PP |
143 | extern const char *bt_field_class_structure_member_get_name( |
144 | const bt_field_class_structure_member *member); | |
145 | ||
146 | extern const bt_field_class * | |
147 | bt_field_class_structure_member_borrow_field_class_const( | |
148 | const bt_field_class_structure_member *member); | |
149 | ||
b19ff26f | 150 | extern const bt_field_class * |
40f4ba76 | 151 | bt_field_class_array_borrow_element_field_class_const( |
b19ff26f | 152 | const bt_field_class *field_class); |
40f4ba76 PP |
153 | |
154 | extern uint64_t bt_field_class_static_array_get_length( | |
b19ff26f | 155 | const bt_field_class *field_class); |
40f4ba76 | 156 | |
b19ff26f | 157 | extern const bt_field_path * |
40f4ba76 | 158 | bt_field_class_dynamic_array_borrow_length_field_path_const( |
b19ff26f | 159 | const bt_field_class *field_class); |
40f4ba76 | 160 | |
b19ff26f | 161 | extern const bt_field_path * |
40f4ba76 | 162 | bt_field_class_variant_borrow_selector_field_path_const( |
b19ff26f | 163 | const bt_field_class *field_class); |
40f4ba76 PP |
164 | |
165 | extern uint64_t bt_field_class_variant_get_option_count( | |
b19ff26f | 166 | const bt_field_class *field_class); |
40f4ba76 | 167 | |
1e6fd1d7 PP |
168 | extern const bt_field_class_variant_option * |
169 | bt_field_class_variant_borrow_option_by_index_const( | |
170 | const bt_field_class *field_class, uint64_t index); | |
40f4ba76 | 171 | |
1e6fd1d7 PP |
172 | extern const bt_field_class_variant_option * |
173 | bt_field_class_variant_borrow_option_by_name_const( | |
174 | const bt_field_class *field_class, const char *name); | |
175 | ||
176 | extern const char *bt_field_class_variant_option_get_name( | |
177 | const bt_field_class_variant_option *option); | |
178 | ||
179 | extern const bt_field_class * | |
180 | bt_field_class_variant_option_borrow_field_class_const( | |
181 | const bt_field_class_variant_option *option); | |
40f4ba76 | 182 | |
b19ff26f | 183 | extern void bt_field_class_get_ref(const bt_field_class *field_class); |
c5b9b441 | 184 | |
b19ff26f | 185 | extern void bt_field_class_put_ref(const bt_field_class *field_class); |
c5b9b441 PP |
186 | |
187 | #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \ | |
188 | do { \ | |
189 | bt_field_class_put_ref(_var); \ | |
190 | (_var) = NULL; \ | |
191 | } while (0) | |
192 | ||
193 | #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
194 | do { \ | |
195 | bt_field_class_put_ref(_var_dst); \ | |
196 | (_var_dst) = (_var_src); \ | |
197 | (_var_src) = NULL; \ | |
198 | } while (0) | |
199 | ||
200 | ||
40f4ba76 PP |
201 | #ifdef __cplusplus |
202 | } | |
203 | #endif | |
204 | ||
924dc299 | 205 | #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */ |