1 #ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
2 #define BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
31 * For bt_bool, bt_field_class, bt_field_path,
32 * bt_field_class_enumeration_mapping,
33 * bt_field_class_unsigned_enumeration_mapping,
34 * bt_field_class_signed_enumeration_mapping,
35 * bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST
37 #include <babeltrace2/types.h>
46 typedef enum bt_field_class_status
{
47 BT_FIELD_CLASS_STATUS_OK
= 0,
48 BT_FIELD_CLASS_STATUS_NOMEM
= -12,
49 } bt_field_class_status
;
51 typedef enum bt_field_class_type
{
52 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
,
53 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
,
54 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
,
55 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
,
56 BT_FIELD_CLASS_TYPE_REAL
,
57 BT_FIELD_CLASS_TYPE_STRING
,
58 BT_FIELD_CLASS_TYPE_STRUCTURE
,
59 BT_FIELD_CLASS_TYPE_STATIC_ARRAY
,
60 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
,
61 BT_FIELD_CLASS_TYPE_VARIANT
,
62 } bt_field_class_type
;
64 typedef enum bt_field_class_integer_preferred_display_base
{
65 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
,
66 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
,
67 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
,
68 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
,
69 } bt_field_class_integer_preferred_display_base
;
71 extern bt_field_class_type
bt_field_class_get_type(
72 const bt_field_class
*field_class
);
74 extern uint64_t bt_field_class_integer_get_field_value_range(
75 const bt_field_class
*field_class
);
77 extern bt_field_class_integer_preferred_display_base
78 bt_field_class_integer_get_preferred_display_base(
79 const bt_field_class
*field_class
);
81 extern bt_bool
bt_field_class_real_is_single_precision(
82 const bt_field_class
*field_class
);
84 extern uint64_t bt_field_class_enumeration_get_mapping_count(
85 const bt_field_class
*field_class
);
87 extern const bt_field_class_unsigned_enumeration_mapping
*
88 bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
89 const bt_field_class
*field_class
, uint64_t index
);
91 extern const bt_field_class_signed_enumeration_mapping
*
92 bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
93 const bt_field_class
*field_class
, uint64_t index
);
96 const bt_field_class_enumeration_mapping
*
97 bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
98 const bt_field_class_unsigned_enumeration_mapping
*mapping
)
100 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
104 const bt_field_class_enumeration_mapping
*
105 bt_field_class_signed_enumeration_mapping_as_mapping_const(
106 const bt_field_class_signed_enumeration_mapping
*mapping
)
108 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
111 extern const char *bt_field_class_enumeration_mapping_get_label(
112 const bt_field_class_enumeration_mapping
*mapping
);
114 extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
115 const bt_field_class_enumeration_mapping
*mapping
);
118 bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
119 const bt_field_class_unsigned_enumeration_mapping
*mapping
,
120 uint64_t index
, uint64_t *lower
, uint64_t *upper
);
123 bt_field_class_signed_enumeration_mapping_get_range_by_index(
124 const bt_field_class_signed_enumeration_mapping
*mapping
,
125 uint64_t index
, int64_t *lower
, int64_t *upper
);
127 extern bt_field_class_status
128 bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
129 const bt_field_class
*field_class
, uint64_t value
,
130 bt_field_class_enumeration_mapping_label_array
*label_array
,
133 extern bt_field_class_status
134 bt_field_class_signed_enumeration_get_mapping_labels_by_value(
135 const bt_field_class
*field_class
, int64_t value
,
136 bt_field_class_enumeration_mapping_label_array
*label_array
,
139 extern uint64_t bt_field_class_structure_get_member_count(
140 const bt_field_class
*field_class
);
142 extern const bt_field_class_structure_member
*
143 bt_field_class_structure_borrow_member_by_index_const(
144 const bt_field_class
*field_class
, uint64_t index
);
146 extern const bt_field_class_structure_member
*
147 bt_field_class_structure_borrow_member_by_name_const(
148 const bt_field_class
*field_class
, const char *name
);
150 extern const char *bt_field_class_structure_member_get_name(
151 const bt_field_class_structure_member
*member
);
153 extern const bt_field_class
*
154 bt_field_class_structure_member_borrow_field_class_const(
155 const bt_field_class_structure_member
*member
);
157 extern const bt_field_class
*
158 bt_field_class_array_borrow_element_field_class_const(
159 const bt_field_class
*field_class
);
161 extern uint64_t bt_field_class_static_array_get_length(
162 const bt_field_class
*field_class
);
164 extern const bt_field_path
*
165 bt_field_class_dynamic_array_borrow_length_field_path_const(
166 const bt_field_class
*field_class
);
168 extern const bt_field_path
*
169 bt_field_class_variant_borrow_selector_field_path_const(
170 const bt_field_class
*field_class
);
172 extern uint64_t bt_field_class_variant_get_option_count(
173 const bt_field_class
*field_class
);
175 extern const bt_field_class_variant_option
*
176 bt_field_class_variant_borrow_option_by_index_const(
177 const bt_field_class
*field_class
, uint64_t index
);
179 extern const bt_field_class_variant_option
*
180 bt_field_class_variant_borrow_option_by_name_const(
181 const bt_field_class
*field_class
, const char *name
);
183 extern const char *bt_field_class_variant_option_get_name(
184 const bt_field_class_variant_option
*option
);
186 extern const bt_field_class
*
187 bt_field_class_variant_option_borrow_field_class_const(
188 const bt_field_class_variant_option
*option
);
190 extern void bt_field_class_get_ref(const bt_field_class
*field_class
);
192 extern void bt_field_class_put_ref(const bt_field_class
*field_class
);
194 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
196 bt_field_class_put_ref(_var); \
200 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
202 bt_field_class_put_ref(_var_dst); \
203 (_var_dst) = (_var_src); \
212 #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */