1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
2 #define BABELTRACE2_TRACE_IR_FIELD_CLASS_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
30 #ifndef __BT_IN_BABELTRACE_H
31 # error "Please include <babeltrace2/babeltrace.h> instead."
37 #include <babeltrace2/types.h>
43 typedef enum bt_field_class_type
{
44 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER
,
45 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER
,
46 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION
,
47 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION
,
48 BT_FIELD_CLASS_TYPE_REAL
,
49 BT_FIELD_CLASS_TYPE_STRING
,
50 BT_FIELD_CLASS_TYPE_STRUCTURE
,
51 BT_FIELD_CLASS_TYPE_STATIC_ARRAY
,
52 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY
,
53 BT_FIELD_CLASS_TYPE_VARIANT
,
54 } bt_field_class_type
;
56 typedef enum bt_field_class_integer_preferred_display_base
{
57 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY
,
58 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL
,
59 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL
,
60 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL
,
61 } bt_field_class_integer_preferred_display_base
;
63 extern bt_field_class_type
bt_field_class_get_type(
64 const bt_field_class
*field_class
);
66 extern uint64_t bt_field_class_integer_get_field_value_range(
67 const bt_field_class
*field_class
);
69 extern bt_field_class_integer_preferred_display_base
70 bt_field_class_integer_get_preferred_display_base(
71 const bt_field_class
*field_class
);
73 extern bt_bool
bt_field_class_real_is_single_precision(
74 const bt_field_class
*field_class
);
76 extern uint64_t bt_field_class_enumeration_get_mapping_count(
77 const bt_field_class
*field_class
);
79 extern const bt_field_class_unsigned_enumeration_mapping
*
80 bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
81 const bt_field_class
*field_class
, uint64_t index
);
83 extern const bt_field_class_signed_enumeration_mapping
*
84 bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
85 const bt_field_class
*field_class
, uint64_t index
);
88 const bt_field_class_enumeration_mapping
*
89 bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
90 const bt_field_class_unsigned_enumeration_mapping
*mapping
)
92 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
96 const bt_field_class_enumeration_mapping
*
97 bt_field_class_signed_enumeration_mapping_as_mapping_const(
98 const bt_field_class_signed_enumeration_mapping
*mapping
)
100 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping
, mapping
);
103 extern const char *bt_field_class_enumeration_mapping_get_label(
104 const bt_field_class_enumeration_mapping
*mapping
);
106 extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
107 const bt_field_class_enumeration_mapping
*mapping
);
110 bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
111 const bt_field_class_unsigned_enumeration_mapping
*mapping
,
112 uint64_t index
, uint64_t *lower
, uint64_t *upper
);
115 bt_field_class_signed_enumeration_mapping_get_range_by_index(
116 const bt_field_class_signed_enumeration_mapping
*mapping
,
117 uint64_t index
, int64_t *lower
, int64_t *upper
);
119 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status
{
120 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
121 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK
= __BT_FUNC_STATUS_OK
,
122 } bt_field_class_enumeration_get_mapping_labels_for_value_status
;
124 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
125 bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
126 const bt_field_class
*field_class
, uint64_t value
,
127 bt_field_class_enumeration_mapping_label_array
*label_array
,
130 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
131 bt_field_class_signed_enumeration_get_mapping_labels_for_value(
132 const bt_field_class
*field_class
, int64_t value
,
133 bt_field_class_enumeration_mapping_label_array
*label_array
,
136 extern uint64_t bt_field_class_structure_get_member_count(
137 const bt_field_class
*field_class
);
139 extern const bt_field_class_structure_member
*
140 bt_field_class_structure_borrow_member_by_index_const(
141 const bt_field_class
*field_class
, uint64_t index
);
143 extern const bt_field_class_structure_member
*
144 bt_field_class_structure_borrow_member_by_name_const(
145 const bt_field_class
*field_class
, const char *name
);
147 extern const char *bt_field_class_structure_member_get_name(
148 const bt_field_class_structure_member
*member
);
150 extern const bt_field_class
*
151 bt_field_class_structure_member_borrow_field_class_const(
152 const bt_field_class_structure_member
*member
);
154 extern const bt_field_class
*
155 bt_field_class_array_borrow_element_field_class_const(
156 const bt_field_class
*field_class
);
158 extern uint64_t bt_field_class_static_array_get_length(
159 const bt_field_class
*field_class
);
161 extern const bt_field_path
*
162 bt_field_class_dynamic_array_borrow_length_field_path_const(
163 const bt_field_class
*field_class
);
165 extern const bt_field_path
*
166 bt_field_class_variant_borrow_selector_field_path_const(
167 const bt_field_class
*field_class
);
169 extern uint64_t bt_field_class_variant_get_option_count(
170 const bt_field_class
*field_class
);
172 extern const bt_field_class_variant_option
*
173 bt_field_class_variant_borrow_option_by_index_const(
174 const bt_field_class
*field_class
, uint64_t index
);
176 extern const bt_field_class_variant_option
*
177 bt_field_class_variant_borrow_option_by_name_const(
178 const bt_field_class
*field_class
, const char *name
);
180 extern const char *bt_field_class_variant_option_get_name(
181 const bt_field_class_variant_option
*option
);
183 extern const bt_field_class
*
184 bt_field_class_variant_option_borrow_field_class_const(
185 const bt_field_class_variant_option
*option
);
187 extern void bt_field_class_get_ref(const bt_field_class
*field_class
);
189 extern void bt_field_class_put_ref(const bt_field_class
*field_class
);
191 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
193 bt_field_class_put_ref(_var); \
197 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
199 bt_field_class_put_ref(_var_dst); \
200 (_var_dst) = (_var_src); \
209 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */