Commit | Line | Data |
---|---|---|
3fd40f46 PP |
1 | #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H |
2 | #define BABELTRACE2_TRACE_IR_FIELD_CLASS_H | |
939190b3 PP |
3 | |
4 | /* | |
f2b0325d | 5 | * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com> |
939190b3 PP |
6 | * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com> |
7 | * | |
939190b3 PP |
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: | |
14 | * | |
15 | * The above copyright notice and this permission notice shall be included in | |
16 | * all copies or substantial portions of the Software. | |
17 | * | |
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 | |
24 | * SOFTWARE. | |
25 | * | |
26 | * The Common Trace Format (CTF) Specification is available at | |
27 | * http://www.efficios.com/ctf | |
28 | */ | |
29 | ||
9df34b44 PP |
30 | #ifndef __BT_IN_BABELTRACE_H |
31 | # error "Please include <babeltrace2/babeltrace.h> instead." | |
32 | #endif | |
33 | ||
fb25b9e3 PP |
34 | #include <stdint.h> |
35 | #include <stddef.h> | |
36 | ||
b7396828 | 37 | /* For bt_bool, bt_field_class, bt_trace_class */ |
71c5da58 | 38 | #include <babeltrace2/types.h> |
939190b3 | 39 | |
fb25b9e3 | 40 | /* For bt_field_class_integer_preferred_display_base */ |
71c5da58 | 41 | #include <babeltrace2/trace-ir/field-class-const.h> |
78cf9df6 | 42 | |
939190b3 PP |
43 | #ifdef __cplusplus |
44 | extern "C" { | |
45 | #endif | |
46 | ||
b7396828 PP |
47 | extern bt_field_class *bt_field_class_unsigned_integer_create( |
48 | bt_trace_class *trace_class); | |
939190b3 | 49 | |
b7396828 PP |
50 | extern bt_field_class *bt_field_class_signed_integer_create( |
51 | bt_trace_class *trace_class); | |
78cf9df6 PP |
52 | |
53 | extern void bt_field_class_integer_set_field_value_range( | |
8eee8ea2 | 54 | bt_field_class *field_class, uint64_t size); |
78cf9df6 PP |
55 | |
56 | extern void bt_field_class_integer_set_preferred_display_base( | |
8eee8ea2 | 57 | bt_field_class *field_class, |
ee78f405 | 58 | bt_field_class_integer_preferred_display_base base); |
78cf9df6 | 59 | |
b7396828 | 60 | extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class); |
78cf9df6 PP |
61 | |
62 | extern void bt_field_class_real_set_is_single_precision( | |
8eee8ea2 | 63 | bt_field_class *field_class, |
78cf9df6 PP |
64 | bt_bool is_single_precision); |
65 | ||
b7396828 PP |
66 | extern bt_field_class *bt_field_class_unsigned_enumeration_create( |
67 | bt_trace_class *trace_class); | |
78cf9df6 | 68 | |
b7396828 PP |
69 | extern bt_field_class *bt_field_class_signed_enumeration_create( |
70 | bt_trace_class *trace_class); | |
78cf9df6 | 71 | |
fb25b9e3 PP |
72 | typedef enum bt_field_class_enumeration_map_range_status { |
73 | BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
74 | BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_OK = __BT_FUNC_STATUS_OK, | |
75 | } bt_field_class_enumeration_map_range_status; | |
76 | ||
77 | extern bt_field_class_enumeration_map_range_status | |
78 | bt_field_class_unsigned_enumeration_map_range( | |
8eee8ea2 | 79 | bt_field_class *field_class, const char *label, |
78cf9df6 PP |
80 | uint64_t range_lower, uint64_t range_upper); |
81 | ||
fb25b9e3 PP |
82 | extern bt_field_class_enumeration_map_range_status |
83 | bt_field_class_signed_enumeration_map_range( | |
8eee8ea2 | 84 | bt_field_class *field_class, const char *label, |
78cf9df6 PP |
85 | int64_t range_lower, int64_t range_upper); |
86 | ||
b7396828 PP |
87 | extern bt_field_class *bt_field_class_string_create( |
88 | bt_trace_class *trace_class); | |
78cf9df6 | 89 | |
b7396828 PP |
90 | extern bt_field_class *bt_field_class_structure_create( |
91 | bt_trace_class *trace_class); | |
78cf9df6 | 92 | |
fb25b9e3 PP |
93 | typedef enum bt_field_class_structure_append_member_status { |
94 | BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
95 | BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK, | |
96 | } bt_field_class_structure_append_member_status; | |
97 | ||
98 | extern bt_field_class_structure_append_member_status | |
99 | bt_field_class_structure_append_member( | |
8eee8ea2 PP |
100 | bt_field_class *struct_field_class, |
101 | const char *name, bt_field_class *field_class); | |
78cf9df6 | 102 | |
e24f271a PP |
103 | extern bt_field_class_structure_member * |
104 | bt_field_class_structure_borrow_member_by_index( | |
105 | bt_field_class *field_class, uint64_t index); | |
909d0a89 | 106 | |
e24f271a PP |
107 | extern bt_field_class_structure_member * |
108 | bt_field_class_structure_borrow_member_by_name( | |
909d0a89 PP |
109 | bt_field_class *field_class, const char *name); |
110 | ||
8eee8ea2 | 111 | extern bt_field_class *bt_field_class_static_array_create( |
b7396828 | 112 | bt_trace_class *trace_class, |
8eee8ea2 | 113 | bt_field_class *elem_field_class, uint64_t length); |
78cf9df6 | 114 | |
8eee8ea2 | 115 | extern bt_field_class *bt_field_class_dynamic_array_create( |
b7396828 | 116 | bt_trace_class *trace_class, |
8eee8ea2 | 117 | bt_field_class *elem_field_class); |
78cf9df6 | 118 | |
909d0a89 PP |
119 | extern bt_field_class *bt_field_class_array_borrow_element_field_class( |
120 | bt_field_class *field_class); | |
121 | ||
fb25b9e3 PP |
122 | typedef enum bt_field_class_dynamic_array_set_length_field_class_status { |
123 | BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
124 | BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK, | |
125 | } bt_field_class_dynamic_array_set_length_field_class_status; | |
126 | ||
127 | extern bt_field_class_dynamic_array_set_length_field_class_status | |
4b514ab3 | 128 | bt_field_class_dynamic_array_set_length_field_class( |
8eee8ea2 PP |
129 | bt_field_class *field_class, |
130 | bt_field_class *length_field_class); | |
78cf9df6 | 131 | |
b7396828 PP |
132 | extern bt_field_class *bt_field_class_variant_create( |
133 | bt_trace_class *trace_class); | |
78cf9df6 | 134 | |
fb25b9e3 PP |
135 | typedef enum bt_field_class_variant_set_selector_field_class_status { |
136 | BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
137 | BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK, | |
138 | } bt_field_class_variant_set_selector_field_class_status; | |
139 | ||
140 | extern bt_field_class_variant_set_selector_field_class_status | |
4b514ab3 | 141 | bt_field_class_variant_set_selector_field_class(bt_field_class *field_class, |
8eee8ea2 | 142 | bt_field_class *selector_field_class); |
78cf9df6 | 143 | |
fb25b9e3 PP |
144 | typedef enum bt_field_class_variant_append_option_status { |
145 | BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR, | |
146 | BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK, | |
147 | } bt_field_class_variant_append_option_status; | |
148 | ||
149 | extern bt_field_class_variant_append_option_status | |
150 | bt_field_class_variant_append_option( | |
8eee8ea2 PP |
151 | bt_field_class *var_field_class, |
152 | const char *name, bt_field_class *field_class); | |
939190b3 | 153 | |
e24f271a PP |
154 | extern bt_field_class_variant_option * |
155 | bt_field_class_variant_borrow_option_by_index( | |
156 | bt_field_class *field_class, uint64_t index); | |
909d0a89 | 157 | |
e24f271a PP |
158 | extern bt_field_class_variant_option * |
159 | bt_field_class_variant_borrow_option_by_name( | |
c0db9072 | 160 | bt_field_class *field_class, const char *name); |
e24f271a PP |
161 | |
162 | extern bt_field_class *bt_field_class_variant_option_borrow_field_class( | |
163 | bt_field_class_variant_option *option); | |
909d0a89 | 164 | |
939190b3 PP |
165 | #ifdef __cplusplus |
166 | } | |
167 | #endif | |
168 | ||
3fd40f46 | 169 | #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */ |