Commit | Line | Data |
---|---|---|
dadf29b9 PP |
1 | #ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H |
2 | #define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H | |
3 | ||
4 | /* | |
0554db57 | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
dadf29b9 PP |
6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
dadf29b9 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 | ||
b9879703 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 | */ | |
dadf29b9 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 | ||
dadf29b9 PP |
45 | enum bt_field_class_type { |
46 | BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER, | |
47 | BT_FIELD_CLASS_TYPE_SIGNED_INTEGER, | |
48 | BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION, | |
49 | BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION, | |
50 | BT_FIELD_CLASS_TYPE_REAL, | |
51 | BT_FIELD_CLASS_TYPE_STRING, | |
52 | BT_FIELD_CLASS_TYPE_STRUCTURE, | |
53 | BT_FIELD_CLASS_TYPE_STATIC_ARRAY, | |
54 | BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY, | |
55 | BT_FIELD_CLASS_TYPE_VARIANT, | |
56 | }; | |
57 | ||
58 | enum bt_field_class_integer_preferred_display_base { | |
59 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY, | |
60 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL, | |
61 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL, | |
62 | BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL, | |
63 | }; | |
64 | ||
65 | extern enum bt_field_class_type bt_field_class_get_type( | |
b9879703 | 66 | const bt_field_class *field_class); |
dadf29b9 PP |
67 | |
68 | extern uint64_t bt_field_class_integer_get_field_value_range( | |
b9879703 | 69 | const bt_field_class *field_class); |
dadf29b9 PP |
70 | |
71 | extern enum bt_field_class_integer_preferred_display_base | |
72 | bt_field_class_integer_get_preferred_display_base( | |
b9879703 | 73 | const bt_field_class *field_class); |
dadf29b9 PP |
74 | |
75 | extern bt_bool bt_field_class_real_is_single_precision( | |
b9879703 | 76 | const bt_field_class *field_class); |
dadf29b9 PP |
77 | |
78 | extern uint64_t bt_field_class_enumeration_get_mapping_count( | |
b9879703 | 79 | const bt_field_class *field_class); |
dadf29b9 PP |
80 | |
81 | extern void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const( | |
b9879703 | 82 | const bt_field_class *field_class, uint64_t index, |
dadf29b9 | 83 | const char **label, |
b9879703 | 84 | const bt_field_class_unsigned_enumeration_mapping_ranges **ranges); |
dadf29b9 PP |
85 | |
86 | extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const( | |
b9879703 | 87 | const bt_field_class *field_class, uint64_t index, |
dadf29b9 | 88 | const char **label, |
b9879703 | 89 | const bt_field_class_signed_enumeration_mapping_ranges **ranges); |
dadf29b9 PP |
90 | |
91 | extern uint64_t | |
92 | bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count( | |
b9879703 | 93 | const bt_field_class_unsigned_enumeration_mapping_ranges *ranges); |
dadf29b9 PP |
94 | |
95 | extern uint64_t | |
96 | bt_field_class_signed_enumeration_mapping_ranges_get_range_count( | |
b9879703 | 97 | const bt_field_class_signed_enumeration_mapping_ranges *ranges); |
dadf29b9 PP |
98 | |
99 | extern void | |
100 | bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index( | |
b9879703 | 101 | const bt_field_class_unsigned_enumeration_mapping_ranges *ranges, |
dadf29b9 PP |
102 | uint64_t index, uint64_t *lower, uint64_t *upper); |
103 | ||
104 | extern void | |
105 | bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index( | |
b9879703 | 106 | const bt_field_class_unsigned_enumeration_mapping_ranges *ranges, |
dadf29b9 PP |
107 | uint64_t index, int64_t *lower, int64_t *upper); |
108 | ||
109 | extern int bt_field_class_unsigned_enumeration_get_mapping_labels_by_value( | |
b9879703 | 110 | const bt_field_class *field_class, uint64_t value, |
dadf29b9 PP |
111 | bt_field_class_enumeration_mapping_label_array *label_array, |
112 | uint64_t *count); | |
113 | ||
114 | extern int bt_field_class_signed_enumeration_get_mapping_labels_by_value( | |
b9879703 | 115 | const bt_field_class *field_class, int64_t value, |
dadf29b9 PP |
116 | bt_field_class_enumeration_mapping_label_array *label_array, |
117 | uint64_t *count); | |
118 | ||
119 | extern uint64_t bt_field_class_structure_get_member_count( | |
b9879703 | 120 | const bt_field_class *field_class); |
dadf29b9 PP |
121 | |
122 | extern void bt_field_class_structure_borrow_member_by_index_const( | |
b9879703 PP |
123 | const bt_field_class *struct_field_class, uint64_t index, |
124 | const char **name, const bt_field_class **field_class); | |
dadf29b9 PP |
125 | |
126 | extern | |
b9879703 | 127 | const bt_field_class * |
dadf29b9 | 128 | bt_field_class_structure_borrow_member_field_class_by_name_const( |
b9879703 | 129 | const bt_field_class *field_class, const char *name); |
dadf29b9 | 130 | |
b9879703 | 131 | extern const bt_field_class * |
dadf29b9 | 132 | bt_field_class_array_borrow_element_field_class_const( |
b9879703 | 133 | const bt_field_class *field_class); |
dadf29b9 PP |
134 | |
135 | extern uint64_t bt_field_class_static_array_get_length( | |
b9879703 | 136 | const bt_field_class *field_class); |
dadf29b9 | 137 | |
b9879703 | 138 | extern const bt_field_path * |
dadf29b9 | 139 | bt_field_class_dynamic_array_borrow_length_field_path_const( |
b9879703 | 140 | const bt_field_class *field_class); |
dadf29b9 | 141 | |
b9879703 | 142 | extern const bt_field_path * |
dadf29b9 | 143 | bt_field_class_variant_borrow_selector_field_path_const( |
b9879703 | 144 | const bt_field_class *field_class); |
dadf29b9 PP |
145 | |
146 | extern uint64_t bt_field_class_variant_get_option_count( | |
b9879703 | 147 | const bt_field_class *field_class); |
dadf29b9 PP |
148 | |
149 | extern void bt_field_class_variant_borrow_option_by_index_const( | |
b9879703 PP |
150 | const bt_field_class *variant_field_class, uint64_t index, |
151 | const char **name, const bt_field_class **field_class); | |
dadf29b9 PP |
152 | |
153 | extern | |
b9879703 | 154 | const bt_field_class * |
dadf29b9 | 155 | bt_field_class_variant_borrow_option_field_class_by_name_const( |
b9879703 | 156 | const bt_field_class *field_class, |
dadf29b9 PP |
157 | const char *name); |
158 | ||
b9879703 | 159 | extern void bt_field_class_get_ref(const bt_field_class *field_class); |
317e35ec | 160 | |
b9879703 | 161 | extern void bt_field_class_put_ref(const bt_field_class *field_class); |
317e35ec PP |
162 | |
163 | #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \ | |
164 | do { \ | |
165 | bt_field_class_put_ref(_var); \ | |
166 | (_var) = NULL; \ | |
167 | } while (0) | |
168 | ||
169 | #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \ | |
170 | do { \ | |
171 | bt_field_class_put_ref(_var_dst); \ | |
172 | (_var_dst) = (_var_src); \ | |
173 | (_var_src) = NULL; \ | |
174 | } while (0) | |
175 | ||
176 | ||
dadf29b9 PP |
177 | #ifdef __cplusplus |
178 | } | |
179 | #endif | |
180 | ||
181 | #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */ |