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 bt_field_class
*bt_field_class_bool_create(
41 bt_trace_class
*trace_class
);
43 extern bt_field_class
*bt_field_class_bit_array_create(
44 bt_trace_class
*trace_class
, uint64_t length
);
46 extern bt_field_class
*bt_field_class_integer_unsigned_create(
47 bt_trace_class
*trace_class
);
49 extern bt_field_class
*bt_field_class_integer_signed_create(
50 bt_trace_class
*trace_class
);
52 extern void bt_field_class_integer_set_field_value_range(
53 bt_field_class
*field_class
, uint64_t size
);
55 extern void bt_field_class_integer_set_preferred_display_base(
56 bt_field_class
*field_class
,
57 bt_field_class_integer_preferred_display_base base
);
59 extern bt_field_class
*bt_field_class_real_create(bt_trace_class
*trace_class
);
61 extern void bt_field_class_real_set_is_single_precision(
62 bt_field_class
*field_class
,
63 bt_bool is_single_precision
);
65 extern bt_field_class
*bt_field_class_enumeration_unsigned_create(
66 bt_trace_class
*trace_class
);
68 extern bt_field_class
*bt_field_class_enumeration_signed_create(
69 bt_trace_class
*trace_class
);
71 typedef enum bt_field_class_enumeration_add_mapping_status
{
72 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
73 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK
= __BT_FUNC_STATUS_OK
,
74 } bt_field_class_enumeration_add_mapping_status
;
76 extern bt_field_class_enumeration_add_mapping_status
77 bt_field_class_enumeration_unsigned_add_mapping(
78 bt_field_class
*field_class
, const char *label
,
79 const bt_integer_range_set_unsigned
*range_set
);
81 extern bt_field_class_enumeration_add_mapping_status
82 bt_field_class_enumeration_signed_add_mapping(
83 bt_field_class
*field_class
, const char *label
,
84 const bt_integer_range_set_signed
*range_set
);
86 extern bt_field_class
*bt_field_class_string_create(
87 bt_trace_class
*trace_class
);
89 extern bt_field_class
*bt_field_class_structure_create(
90 bt_trace_class
*trace_class
);
92 typedef enum bt_field_class_structure_append_member_status
{
93 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
94 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK
= __BT_FUNC_STATUS_OK
,
95 } bt_field_class_structure_append_member_status
;
97 extern bt_field_class_structure_append_member_status
98 bt_field_class_structure_append_member(
99 bt_field_class
*struct_field_class
,
100 const char *name
, bt_field_class
*field_class
);
102 extern bt_field_class_structure_member
*
103 bt_field_class_structure_borrow_member_by_index(
104 bt_field_class
*field_class
, uint64_t index
);
106 extern bt_field_class_structure_member
*
107 bt_field_class_structure_borrow_member_by_name(
108 bt_field_class
*field_class
, const char *name
);
110 extern bt_field_class
*bt_field_class_array_static_create(
111 bt_trace_class
*trace_class
,
112 bt_field_class
*elem_field_class
, uint64_t length
);
114 extern bt_field_class
*bt_field_class_array_dynamic_create(
115 bt_trace_class
*trace_class
,
116 bt_field_class
*elem_field_class
,
117 bt_field_class
*length_field_class
);
119 extern bt_field_class
*bt_field_class_array_borrow_element_field_class(
120 bt_field_class
*field_class
);
122 extern bt_field_class
*bt_field_class_option_create(
123 bt_trace_class
*trace_class
,
124 bt_field_class
*content_field_class
,
125 bt_field_class
*selector_field_class
);
127 extern bt_field_class
*bt_field_class_variant_create(
128 bt_trace_class
*trace_class
,
129 bt_field_class
*selector_field_class
);
131 typedef enum bt_field_class_variant_without_selector_append_option_status
{
132 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
133 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_OK
= __BT_FUNC_STATUS_OK
,
134 } bt_field_class_variant_without_selector_append_option_status
;
136 extern bt_field_class_variant_without_selector_append_option_status
137 bt_field_class_variant_without_selector_append_option(
138 bt_field_class
*var_field_class
, const char *name
,
139 bt_field_class
*field_class
);
141 typedef enum bt_field_class_variant_with_selector_append_option_status
{
142 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
143 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_OK
= __BT_FUNC_STATUS_OK
,
144 } bt_field_class_variant_with_selector_append_option_status
;
146 extern bt_field_class_variant_with_selector_append_option_status
147 bt_field_class_variant_with_selector_unsigned_append_option(
148 bt_field_class
*var_field_class
, const char *name
,
149 bt_field_class
*field_class
,
150 const bt_integer_range_set_unsigned
*range_set
);
152 extern bt_field_class_variant_with_selector_append_option_status
153 bt_field_class_variant_with_selector_signed_append_option(
154 bt_field_class
*var_field_class
, const char *name
,
155 bt_field_class
*field_class
,
156 const bt_integer_range_set_signed
*range_set
);
162 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */