Commit | Line | Data |
---|---|---|
78cf9df6 PP |
1 | #ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H |
2 | #define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H | |
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 | ||
8eee8ea2 PP |
30 | /* |
31 | * For bt_bool, bt_field_class bt_field_path | |
32 | * bt_field_class_signed_enumeration_mapping_ranges | |
33 | * bt_field_class_unsigned_enumeration_mapping_ranges, | |
34 | * bt_field_class_enumeration_mapping_label_array | |
35 | */ | |
78cf9df6 PP |
36 | #include <babeltrace/types.h> |
37 | ||
38 | #include <stdint.h> | |
39 | #include <stddef.h> | |
40 | ||
41 | #ifdef __cplusplus | |
42 | extern "C" { | |
43 | #endif | |
44 | ||
ee78f405 | 45 | typedef enum bt_field_class_status { |
4b514ab3 PP |
46 | BT_FIELD_CLASS_STATUS_OK = 0, |
47 | BT_FIELD_CLASS_STATUS_NOMEM = -12, | |
ee78f405 | 48 | } bt_field_class_status; |
4b514ab3 | 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 PP |
85 | |
86 | extern void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const( | |
8eee8ea2 | 87 | const bt_field_class *field_class, uint64_t index, |
78cf9df6 | 88 | const char **label, |
8eee8ea2 | 89 | const bt_field_class_unsigned_enumeration_mapping_ranges **ranges); |
78cf9df6 PP |
90 | |
91 | extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const( | |
8eee8ea2 | 92 | const bt_field_class *field_class, uint64_t index, |
78cf9df6 | 93 | const char **label, |
8eee8ea2 | 94 | const bt_field_class_signed_enumeration_mapping_ranges **ranges); |
78cf9df6 PP |
95 | |
96 | extern uint64_t | |
97 | bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count( | |
8eee8ea2 | 98 | const bt_field_class_unsigned_enumeration_mapping_ranges *ranges); |
78cf9df6 PP |
99 | |
100 | extern uint64_t | |
101 | bt_field_class_signed_enumeration_mapping_ranges_get_range_count( | |
8eee8ea2 | 102 | const bt_field_class_signed_enumeration_mapping_ranges *ranges); |
78cf9df6 PP |
103 | |
104 | extern void | |
105 | bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index( | |
8eee8ea2 | 106 | const bt_field_class_unsigned_enumeration_mapping_ranges *ranges, |
78cf9df6 PP |
107 | uint64_t index, uint64_t *lower, uint64_t *upper); |
108 | ||
109 | extern void | |
110 | bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index( | |
2d95225e | 111 | const bt_field_class_signed_enumeration_mapping_ranges *ranges, |
78cf9df6 PP |
112 | uint64_t index, int64_t *lower, int64_t *upper); |
113 | ||
ee78f405 | 114 | extern bt_field_class_status |
4b514ab3 | 115 | bt_field_class_unsigned_enumeration_get_mapping_labels_by_value( |
8eee8ea2 | 116 | const bt_field_class *field_class, uint64_t value, |
78cf9df6 PP |
117 | bt_field_class_enumeration_mapping_label_array *label_array, |
118 | uint64_t *count); | |
119 | ||
ee78f405 | 120 | extern bt_field_class_status |
4b514ab3 | 121 | bt_field_class_signed_enumeration_get_mapping_labels_by_value( |
8eee8ea2 | 122 | const bt_field_class *field_class, int64_t value, |
78cf9df6 PP |
123 | bt_field_class_enumeration_mapping_label_array *label_array, |
124 | uint64_t *count); | |
125 | ||
126 | extern uint64_t bt_field_class_structure_get_member_count( | |
8eee8ea2 | 127 | const bt_field_class *field_class); |
78cf9df6 | 128 | |
e24f271a PP |
129 | extern const bt_field_class_structure_member * |
130 | bt_field_class_structure_borrow_member_by_index_const( | |
131 | const bt_field_class *field_class, uint64_t index); | |
78cf9df6 | 132 | |
e24f271a PP |
133 | extern const bt_field_class_structure_member * |
134 | bt_field_class_structure_borrow_member_by_name_const( | |
8eee8ea2 | 135 | const bt_field_class *field_class, const char *name); |
78cf9df6 | 136 | |
e24f271a PP |
137 | extern const char *bt_field_class_structure_member_get_name( |
138 | const bt_field_class_structure_member *member); | |
139 | ||
140 | extern const bt_field_class * | |
141 | bt_field_class_structure_member_borrow_field_class_const( | |
142 | const bt_field_class_structure_member *member); | |
143 | ||
8eee8ea2 | 144 | extern const bt_field_class * |
78cf9df6 | 145 | bt_field_class_array_borrow_element_field_class_const( |
8eee8ea2 | 146 | const bt_field_class *field_class); |
78cf9df6 PP |
147 | |
148 | extern uint64_t bt_field_class_static_array_get_length( | |
8eee8ea2 | 149 | const bt_field_class *field_class); |
78cf9df6 | 150 | |
8eee8ea2 | 151 | extern const bt_field_path * |
78cf9df6 | 152 | bt_field_class_dynamic_array_borrow_length_field_path_const( |
8eee8ea2 | 153 | const bt_field_class *field_class); |
78cf9df6 | 154 | |
8eee8ea2 | 155 | extern const bt_field_path * |
78cf9df6 | 156 | bt_field_class_variant_borrow_selector_field_path_const( |
8eee8ea2 | 157 | const bt_field_class *field_class); |
78cf9df6 PP |
158 | |
159 | extern uint64_t bt_field_class_variant_get_option_count( | |
8eee8ea2 | 160 | const bt_field_class *field_class); |
78cf9df6 | 161 | |
e24f271a PP |
162 | extern const bt_field_class_variant_option * |
163 | bt_field_class_variant_borrow_option_by_index_const( | |
164 | const bt_field_class *field_class, uint64_t index); | |
78cf9df6 | 165 | |
e24f271a PP |
166 | extern const bt_field_class_variant_option * |
167 | bt_field_class_variant_borrow_option_by_name_const( | |
168 | const bt_field_class *field_class, const char *name); | |
169 | ||
170 | extern const char *bt_field_class_variant_option_get_name( | |
171 | const bt_field_class_variant_option *option); | |
172 | ||
173 | extern const bt_field_class * | |
174 | bt_field_class_variant_option_borrow_field_class_const( | |
175 | const bt_field_class_variant_option *option); | |
78cf9df6 | 176 | |
8eee8ea2 | 177 | extern void bt_field_class_get_ref(const bt_field_class *field_class); |
8c6884d9 | 178 | |
8eee8ea2 | 179 | extern void bt_field_class_put_ref(const bt_field_class *field_class); |
8c6884d9 PP |
180 | |
181 | #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \ | |
182 | do { \ | |
183 | bt_field_class_put_ref(_var); \ | |
184 | (_var) = NULL; \ | |
185 | } while (0) | |
186 | ||
187 | #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
188 | do { \ | |
189 | bt_field_class_put_ref(_var_dst); \ | |
190 | (_var_dst) = (_var_src); \ | |
191 | (_var_src) = NULL; \ | |
192 | } while (0) | |
193 | ||
194 | ||
78cf9df6 PP |
195 | #ifdef __cplusplus |
196 | } | |
197 | #endif | |
198 | ||
199 | #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */ |