Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H |
2 | #define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H | |
78cf9df6 PP |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
78cf9df6 PP |
6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
78cf9df6 PP |
8 | * Permission is hereby granted, free of charge, to any person obtaining a copy |
9 | * of this software and associated documentation files (the "Software"), to deal | |
10 | * in the Software without restriction, including without limitation the rights | |
11 | * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | |
12 | * copies of the Software, and to permit persons to whom the Software is | |
13 | * furnished to do so, subject to the following conditions: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
18 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | |
19 | * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | |
20 | * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | |
21 | * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | |
22 | * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | |
23 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | |
24 | * SOFTWARE. | |
25 | * | |
26 | * The Common Trace Format (CTF) Specification is available at | |
27 | * http://www.efficios.com/ctf | |
28 | */ | |
29 | ||
9df34b44 PP |
30 | #ifndef __BT_IN_BABELTRACE_H |
31 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
32 | #endif | |
33 | ||
8eee8ea2 | 34 | /* |
b6baf3bb PP |
35 | * For bt_bool, bt_field_class, bt_field_path, |
36 | * bt_field_class_enumeration_mapping, | |
37 | * bt_field_class_unsigned_enumeration_mapping, | |
38 | * bt_field_class_signed_enumeration_mapping, | |
8470daa9 | 39 | * bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST |
8eee8ea2 | 40 | */ |
71c5da58 | 41 | #include <babeltrace2/types.h> |
78cf9df6 PP |
42 | |
43 | #include <stdint.h> | |
44 | #include <stddef.h> | |
45 | ||
46 | #ifdef __cplusplus | |
47 | extern "C" { | |
48 | #endif | |
49 | ||
ee78f405 | 50 | typedef enum bt_field_class_type { |
78cf9df6 PP |
51 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER, |
52 | BT_FIELD_CLASS_TYPE_SIGNED_INTEGER, | |
53 | BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, | |
54 | BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, | |
55 | BT_FIELD_CLASS_TYPE_REAL, | |
56 | BT_FIELD_CLASS_TYPE_STRING, | |
57 | BT_FIELD_CLASS_TYPE_STRUCTURE, | |
58 | BT_FIELD_CLASS_TYPE_STATIC_ARRAY, | |
59 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, | |
60 | BT_FIELD_CLASS_TYPE_VARIANT, | |
ee78f405 | 61 | } bt_field_class_type; |
78cf9df6 | 62 | |
ee78f405 | 63 | typedef enum bt_field_class_integer_preferred_display_base { |
78cf9df6 PP |
64 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY, |
65 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL, | |
66 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL, | |
67 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL, | |
ee78f405 | 68 | } bt_field_class_integer_preferred_display_base; |
78cf9df6 | 69 | |
ee78f405 | 70 | extern bt_field_class_type bt_field_class_get_type( |
8eee8ea2 | 71 | const bt_field_class *field_class); |
78cf9df6 PP |
72 | |
73 | extern uint64_t bt_field_class_integer_get_field_value_range( | |
8eee8ea2 | 74 | const bt_field_class *field_class); |
78cf9df6 | 75 | |
ee78f405 | 76 | extern bt_field_class_integer_preferred_display_base |
78cf9df6 | 77 | bt_field_class_integer_get_preferred_display_base( |
8eee8ea2 | 78 | const bt_field_class *field_class); |
78cf9df6 PP |
79 | |
80 | extern bt_bool bt_field_class_real_is_single_precision( | |
8eee8ea2 | 81 | const bt_field_class *field_class); |
78cf9df6 PP |
82 | |
83 | extern uint64_t bt_field_class_enumeration_get_mapping_count( | |
8eee8ea2 | 84 | const bt_field_class *field_class); |
78cf9df6 | 85 | |
b6baf3bb PP |
86 | extern const bt_field_class_unsigned_enumeration_mapping * |
87 | bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const( | |
88 | const bt_field_class *field_class, uint64_t index); | |
89 | ||
90 | extern const bt_field_class_signed_enumeration_mapping * | |
91 | bt_field_class_signed_enumeration_borrow_mapping_by_index_const( | |
92 | const bt_field_class *field_class, uint64_t index); | |
93 | ||
94 | static inline | |
95 | const bt_field_class_enumeration_mapping * | |
96 | bt_field_class_unsigned_enumeration_mapping_as_mapping_const( | |
97 | const bt_field_class_unsigned_enumeration_mapping *mapping) | |
98 | { | |
8470daa9 | 99 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
b6baf3bb | 100 | } |
78cf9df6 | 101 | |
b6baf3bb PP |
102 | static inline |
103 | const bt_field_class_enumeration_mapping * | |
104 | bt_field_class_signed_enumeration_mapping_as_mapping_const( | |
105 | const bt_field_class_signed_enumeration_mapping *mapping) | |
106 | { | |
8470daa9 | 107 | return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping); |
b6baf3bb | 108 | } |
78cf9df6 | 109 | |
b6baf3bb PP |
110 | extern const char *bt_field_class_enumeration_mapping_get_label( |
111 | const bt_field_class_enumeration_mapping *mapping); | |
78cf9df6 | 112 | |
b6baf3bb PP |
113 | extern uint64_t bt_field_class_enumeration_mapping_get_range_count( |
114 | const bt_field_class_enumeration_mapping *mapping); | |
78cf9df6 PP |
115 | |
116 | extern void | |
b6baf3bb PP |
117 | bt_field_class_unsigned_enumeration_mapping_get_range_by_index( |
118 | const bt_field_class_unsigned_enumeration_mapping *mapping, | |
78cf9df6 PP |
119 | uint64_t index, uint64_t *lower, uint64_t *upper); |
120 | ||
121 | extern void | |
b6baf3bb PP |
122 | bt_field_class_signed_enumeration_mapping_get_range_by_index( |
123 | const bt_field_class_signed_enumeration_mapping *mapping, | |
78cf9df6 PP |
124 | uint64_t index, int64_t *lower, int64_t *upper); |
125 | ||
1091bb60 | 126 | typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status { |
fb25b9e3 PP |
127 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, |
128 | BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
1091bb60 | 129 | } bt_field_class_enumeration_get_mapping_labels_for_value_status; |
fb25b9e3 | 130 | |
1091bb60 PP |
131 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
132 | bt_field_class_unsigned_enumeration_get_mapping_labels_for_value( | |
8eee8ea2 | 133 | const bt_field_class *field_class, uint64_t value, |
78cf9df6 PP |
134 | bt_field_class_enumeration_mapping_label_array *label_array, |
135 | uint64_t *count); | |
136 | ||
1091bb60 PP |
137 | extern bt_field_class_enumeration_get_mapping_labels_for_value_status |
138 | bt_field_class_signed_enumeration_get_mapping_labels_for_value( | |
8eee8ea2 | 139 | const bt_field_class *field_class, int64_t value, |
78cf9df6 PP |
140 | bt_field_class_enumeration_mapping_label_array *label_array, |
141 | uint64_t *count); | |
142 | ||
143 | extern uint64_t bt_field_class_structure_get_member_count( | |
8eee8ea2 | 144 | const bt_field_class *field_class); |
78cf9df6 | 145 | |
e24f271a PP |
146 | extern const bt_field_class_structure_member * |
147 | bt_field_class_structure_borrow_member_by_index_const( | |
148 | const bt_field_class *field_class, uint64_t index); | |
78cf9df6 | 149 | |
e24f271a PP |
150 | extern const bt_field_class_structure_member * |
151 | bt_field_class_structure_borrow_member_by_name_const( | |
8eee8ea2 | 152 | const bt_field_class *field_class, const char *name); |
78cf9df6 | 153 | |
e24f271a PP |
154 | extern const char *bt_field_class_structure_member_get_name( |
155 | const bt_field_class_structure_member *member); | |
156 | ||
157 | extern const bt_field_class * | |
158 | bt_field_class_structure_member_borrow_field_class_const( | |
159 | const bt_field_class_structure_member *member); | |
160 | ||
8eee8ea2 | 161 | extern const bt_field_class * |
78cf9df6 | 162 | bt_field_class_array_borrow_element_field_class_const( |
8eee8ea2 | 163 | const bt_field_class *field_class); |
78cf9df6 PP |
164 | |
165 | extern uint64_t bt_field_class_static_array_get_length( | |
8eee8ea2 | 166 | const bt_field_class *field_class); |
78cf9df6 | 167 | |
8eee8ea2 | 168 | extern const bt_field_path * |
78cf9df6 | 169 | bt_field_class_dynamic_array_borrow_length_field_path_const( |
8eee8ea2 | 170 | const bt_field_class *field_class); |
78cf9df6 | 171 | |
8eee8ea2 | 172 | extern const bt_field_path * |
78cf9df6 | 173 | bt_field_class_variant_borrow_selector_field_path_const( |
8eee8ea2 | 174 | const bt_field_class *field_class); |
78cf9df6 PP |
175 | |
176 | extern uint64_t bt_field_class_variant_get_option_count( | |
8eee8ea2 | 177 | const bt_field_class *field_class); |
78cf9df6 | 178 | |
e24f271a PP |
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); | |
78cf9df6 | 182 | |
e24f271a PP |
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); | |
186 | ||
187 | extern const char *bt_field_class_variant_option_get_name( | |
188 | const bt_field_class_variant_option *option); | |
189 | ||
190 | extern const bt_field_class * | |
191 | bt_field_class_variant_option_borrow_field_class_const( | |
192 | const bt_field_class_variant_option *option); | |
78cf9df6 | 193 | |
8eee8ea2 | 194 | extern void bt_field_class_get_ref(const bt_field_class *field_class); |
8c6884d9 | 195 | |
8eee8ea2 | 196 | extern void bt_field_class_put_ref(const bt_field_class *field_class); |
8c6884d9 PP |
197 | |
198 | #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \ | |
199 | do { \ | |
200 | bt_field_class_put_ref(_var); \ | |
201 | (_var) = NULL; \ | |
202 | } while (0) | |
203 | ||
204 | #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
205 | do { \ | |
206 | bt_field_class_put_ref(_var_dst); \ | |
207 | (_var_dst) = (_var_src); \ | |
208 | (_var_src) = NULL; \ | |
209 | } while (0) | |
210 | ||
211 | ||
78cf9df6 PP |
212 | #ifdef __cplusplus |
213 | } | |
214 | #endif | |
215 | ||
3fd40f46 | 216 | #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */ |