1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
2 #define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
33 #include <babeltrace2/types.h>
34 #include <babeltrace2/trace-ir/field-class-const.h>
40 extern void bt_field_class_set_user_attributes(
41 bt_field_class
*field_class
, const bt_value
*user_attributes
);
43 extern bt_value
*bt_field_class_borrow_user_attributes(
44 bt_field_class
*field_class
);
46 extern bt_field_class
*bt_field_class_bool_create(
47 bt_trace_class
*trace_class
);
49 extern bt_field_class
*bt_field_class_bit_array_create(
50 bt_trace_class
*trace_class
, uint64_t length
);
52 extern bt_field_class
*bt_field_class_integer_unsigned_create(
53 bt_trace_class
*trace_class
);
55 extern bt_field_class
*bt_field_class_integer_signed_create(
56 bt_trace_class
*trace_class
);
58 extern void bt_field_class_integer_set_field_value_range(
59 bt_field_class
*field_class
, uint64_t size
);
61 extern void bt_field_class_integer_set_preferred_display_base(
62 bt_field_class
*field_class
,
63 bt_field_class_integer_preferred_display_base base
);
65 extern bt_field_class
*bt_field_class_real_single_precision_create(
66 bt_trace_class
*trace_class
);
68 extern bt_field_class
*bt_field_class_real_double_precision_create(
69 bt_trace_class
*trace_class
);
71 extern bt_field_class
*bt_field_class_enumeration_unsigned_create(
72 bt_trace_class
*trace_class
);
74 extern bt_field_class
*bt_field_class_enumeration_signed_create(
75 bt_trace_class
*trace_class
);
77 typedef enum bt_field_class_enumeration_add_mapping_status
{
78 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
79 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK
= __BT_FUNC_STATUS_OK
,
80 } bt_field_class_enumeration_add_mapping_status
;
82 extern bt_field_class_enumeration_add_mapping_status
83 bt_field_class_enumeration_unsigned_add_mapping(
84 bt_field_class
*field_class
, const char *label
,
85 const bt_integer_range_set_unsigned
*range_set
);
87 extern bt_field_class_enumeration_add_mapping_status
88 bt_field_class_enumeration_signed_add_mapping(
89 bt_field_class
*field_class
, const char *label
,
90 const bt_integer_range_set_signed
*range_set
);
92 extern bt_field_class
*bt_field_class_string_create(
93 bt_trace_class
*trace_class
);
95 extern bt_field_class
*bt_field_class_structure_create(
96 bt_trace_class
*trace_class
);
98 typedef enum bt_field_class_structure_append_member_status
{
99 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
100 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
101 } bt_field_class_structure_append_member_status
;
103 extern bt_field_class_structure_append_member_status
104 bt_field_class_structure_append_member(
105 bt_field_class
*struct_field_class
,
106 const char *name
, bt_field_class
*field_class
);
108 extern bt_field_class_structure_member
*
109 bt_field_class_structure_borrow_member_by_index(
110 bt_field_class
*field_class
, uint64_t index
);
112 extern bt_field_class_structure_member
*
113 bt_field_class_structure_borrow_member_by_name(
114 bt_field_class
*field_class
, const char *name
);
116 extern bt_field_class
*
117 bt_field_class_structure_member_borrow_field_class(
118 bt_field_class_structure_member
*member
);
120 extern bt_value
*bt_field_class_structure_member_borrow_user_attributes(
121 bt_field_class_structure_member
*member
);
123 extern void bt_field_class_structure_member_set_user_attributes(
124 bt_field_class_structure_member
*member
,
125 const bt_value
*user_attributes
);
127 extern bt_field_class
*bt_field_class_array_static_create(
128 bt_trace_class
*trace_class
,
129 bt_field_class
*elem_field_class
, uint64_t length
);
131 extern bt_field_class
*bt_field_class_array_dynamic_create(
132 bt_trace_class
*trace_class
,
133 bt_field_class
*elem_field_class
,
134 bt_field_class
*length_field_class
);
136 extern bt_field_class
*bt_field_class_array_borrow_element_field_class(
137 bt_field_class
*field_class
);
139 extern bt_field_class
*bt_field_class_option_without_selector_create(
140 bt_trace_class
*trace_class
,
141 bt_field_class
*content_field_class
);
143 extern bt_field_class
*bt_field_class_option_with_selector_field_bool_create(
144 bt_trace_class
*trace_class
,
145 bt_field_class
*content_field_class
,
146 bt_field_class
*selector_field_class
);
148 extern void bt_field_class_option_with_selector_field_bool_set_selector_is_reversed(
149 bt_field_class
*field_class
, bt_bool selector_is_reversed
);
151 extern bt_field_class
*
152 bt_field_class_option_with_selector_field_integer_unsigned_create(
153 bt_trace_class
*trace_class
,
154 bt_field_class
*content_field_class
,
155 bt_field_class
*selector_field_class
,
156 const bt_integer_range_set_unsigned
*range_set
);
158 extern bt_field_class
*
159 bt_field_class_option_with_selector_field_integer_signed_create(
160 bt_trace_class
*trace_class
,
161 bt_field_class
*content_field_class
,
162 bt_field_class
*selector_field_class
,
163 const bt_integer_range_set_signed
*range_set
);
165 extern bt_field_class
*bt_field_class_option_borrow_field_class(
166 bt_field_class
*field_class
);
168 extern bt_field_class
*bt_field_class_variant_create(
169 bt_trace_class
*trace_class
,
170 bt_field_class
*selector_field_class
);
172 typedef enum bt_field_class_variant_without_selector_append_option_status
{
173 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
174 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_FIELD_APPEND_OPTION_STATUS_OK
= __BT_FUNC_STATUS_OK
,
175 } bt_field_class_variant_without_selector_append_option_status
;
177 extern bt_field_class_variant_without_selector_append_option_status
178 bt_field_class_variant_without_selector_append_option(
179 bt_field_class
*var_field_class
, const char *name
,
180 bt_field_class
*field_class
);
182 typedef enum bt_field_class_variant_with_selector_field_integer_append_option_status
{
183 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
184 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_FIELD_APPEND_OPTION_STATUS_OK
= __BT_FUNC_STATUS_OK
,
185 } bt_field_class_variant_with_selector_field_integer_append_option_status
;
187 extern bt_field_class_variant_with_selector_field_integer_append_option_status
188 bt_field_class_variant_with_selector_field_integer_unsigned_append_option(
189 bt_field_class
*var_field_class
, const char *name
,
190 bt_field_class
*field_class
,
191 const bt_integer_range_set_unsigned
*range_set
);
193 extern bt_field_class_variant_with_selector_field_integer_append_option_status
194 bt_field_class_variant_with_selector_field_integer_signed_append_option(
195 bt_field_class
*var_field_class
, const char *name
,
196 bt_field_class
*field_class
,
197 const bt_integer_range_set_signed
*range_set
);
199 extern bt_field_class_variant_option
*
200 bt_field_class_variant_borrow_option_by_index(
201 bt_field_class
*field_class
, uint64_t index
);
203 extern bt_field_class_variant_option
*
204 bt_field_class_variant_borrow_option_by_name(
205 bt_field_class
*field_class
, const char *name
);
207 extern bt_field_class
*bt_field_class_variant_option_borrow_field_class(
208 bt_field_class_variant_option
*option
);
210 extern bt_value
*bt_field_class_variant_option_borrow_user_attributes(
211 bt_field_class_variant_option
*option
);
213 extern void bt_field_class_variant_option_set_user_attributes(
214 bt_field_class_variant_option
*option
,
215 const bt_value
*user_attributes
);
221 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */