1 #ifndef BABELTRACE_TRACE_IR_PRIVATE_FIELD_CLASSES_H
2 #define BABELTRACE_TRACE_IR_PRIVATE_FIELD_CLASSES_H
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * The Common Trace Format (CTF) Specification is available at
28 * http://www.efficios.com/ctf
32 #include <babeltrace/types.h>
34 /* For enum bt_field_class_integer_preferred_display_base */
35 #include <babeltrace/trace-ir/field-classes.h>
44 struct bt_field_class
;
45 struct bt_private_field_class
;
46 struct bt_private_field_path
;
47 struct bt_private_field_class_signed_enumeration_mapping_ranges
;
48 struct bt_private_field_class_unsigned_enumeration_mapping_ranges
;
51 struct bt_field_class
*bt_private_field_class_borrow_field_class(
52 struct bt_private_field_class
*priv_field_class
)
54 return (void *) priv_field_class
;
57 extern struct bt_private_field_class
*
58 bt_private_field_class_unsigned_integer_create(void);
60 extern struct bt_private_field_class
*
61 bt_private_field_class_signed_integer_create(void);
63 extern int bt_private_field_class_integer_set_field_value_range(
64 struct bt_private_field_class
*field_class
, uint64_t size
);
66 extern int bt_private_field_class_integer_set_preferred_display_base(
67 struct bt_private_field_class
*field_class
,
68 enum bt_field_class_integer_preferred_display_base base
);
70 extern struct bt_private_field_class
*bt_private_field_class_real_create(void);
72 extern int bt_private_field_class_real_set_is_single_precision(
73 struct bt_private_field_class
*field_class
,
74 bt_bool is_single_precision
);
76 extern struct bt_private_field_class
*
77 bt_private_field_class_unsigned_enumeration_create(void);
79 extern struct bt_private_field_class
*
80 bt_private_field_class_signed_enumeration_create(void);
82 extern uint64_t bt_private_field_class_enumeration_get_mapping_count(
83 struct bt_private_field_class
*field_class
);
85 extern int bt_private_field_class_unsigned_enumeration_map_range(
86 struct bt_private_field_class
*field_class
, const char *label
,
87 uint64_t range_lower
, uint64_t range_upper
);
89 extern int bt_private_field_class_signed_enumeration_map_range(
90 struct bt_private_field_class
*field_class
, const char *label
,
91 int64_t range_lower
, int64_t range_upper
);
93 extern struct bt_private_field_class
*
94 bt_private_field_class_string_create(void);
96 extern struct bt_private_field_class
*
97 bt_private_field_class_structure_create(void);
99 extern void bt_private_field_class_structure_borrow_member_by_index(
100 struct bt_private_field_class
*struct_field_class
,
101 uint64_t index
, const char **name
,
102 struct bt_private_field_class
**field_class
);
105 struct bt_private_field_class
*
106 bt_private_field_class_structure_borrow_member_field_class_by_name(
107 struct bt_private_field_class
*field_class
, const char *name
);
109 extern int bt_private_field_class_structure_append_member(
110 struct bt_private_field_class
*struct_field_class
,
111 const char *name
, struct bt_private_field_class
*field_class
);
113 extern struct bt_private_field_class
*
114 bt_private_field_class_static_array_create(
115 struct bt_private_field_class
*elem_field_class
,
118 extern struct bt_private_field_class
*
119 bt_private_field_class_dynamic_array_create(
120 struct bt_private_field_class
*elem_field_class
);
122 extern struct bt_private_field_class
*
123 bt_private_field_class_array_borrow_element_field_class(
124 struct bt_private_field_class
*field_class
);
126 extern int bt_private_field_class_dynamic_array_set_length_field_class(
127 struct bt_private_field_class
*field_class
,
128 struct bt_private_field_class
*length_field_class
);
130 extern struct bt_private_field_class
*
131 bt_private_field_class_variant_create(void);
133 extern int bt_private_field_class_variant_set_selector_field_class(
134 struct bt_private_field_class
*field_class
,
135 struct bt_private_field_class
*selector_field_class
);
137 extern void bt_private_field_class_variant_borrow_option_by_index(
138 struct bt_private_field_class
*variant_field_class
,
139 uint64_t index
, const char **name
,
140 struct bt_private_field_class
**field_class
);
143 struct bt_private_field_class
*
144 bt_private_field_class_variant_borrow_option_field_class_by_name(
145 struct bt_private_field_class
*field_class
, const char *name
);
147 extern int bt_private_field_class_variant_append_private_option(
148 struct bt_private_field_class
*var_field_class
,
149 const char *name
, struct bt_private_field_class
*field_class
);
155 #endif /* BABELTRACE_TRACE_IR_PRIVATE_FIELD_CLASSES_H */