projects / babeltrace.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
lib: force user to include `<babeltrace2/babeltrace.h>`
[babeltrace.git] / include / babeltrace2 / trace-ir / field-class-const.h
CommitLineData
924dc299
PP		 1#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
2#define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
40f4ba76
PP		 3
4/*
e2f7325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
40f4ba76
PP		 6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
40f4ba76
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
4fa90f32
PP		 30#ifndef __BT_IN_BABELTRACE_H
31# error "Please include <babeltrace2/babeltrace.h> instead."
32#endif
33
b19ff26f 34/*
8f3ccfbc
PP		 35 * For bt_bool, bt_field_class, bt_field_path,
36 * bt_field_class_enumeration_mapping,
37 * bt_field_class_unsigned_enumeration_mapping,
38 * bt_field_class_signed_enumeration_mapping,
005f1204 39 * bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST
b19ff26f 40 */
3fadfbc0 41#include <babeltrace2/types.h>
40f4ba76
PP		 42
43#include <stdint.h>
44#include <stddef.h>
45
46#ifdef __cplusplus
47extern "C" {
48#endif
49
4cdfc5e8 50typedef enum bt_field_class_type {
40f4ba76
PP		 51 BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
52 BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
53 BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
54 BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
55 BT_FIELD_CLASS_TYPE_REAL,
56 BT_FIELD_CLASS_TYPE_STRING,
57 BT_FIELD_CLASS_TYPE_STRUCTURE,
58 BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
59 BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
60 BT_FIELD_CLASS_TYPE_VARIANT,
4cdfc5e8 61} bt_field_class_type;
40f4ba76 62
4cdfc5e8 63typedef enum bt_field_class_integer_preferred_display_base {
40f4ba76
PP		 64 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
65 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
66 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
67 BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
4cdfc5e8 68} bt_field_class_integer_preferred_display_base;
40f4ba76 69
4cdfc5e8 70extern bt_field_class_type bt_field_class_get_type(
b19ff26f 71 const bt_field_class *field_class);
40f4ba76
PP		 72
73extern uint64_t bt_field_class_integer_get_field_value_range(
b19ff26f 74 const bt_field_class *field_class);
40f4ba76 75
4cdfc5e8 76extern bt_field_class_integer_preferred_display_base
40f4ba76 77bt_field_class_integer_get_preferred_display_base(
b19ff26f 78 const bt_field_class *field_class);
40f4ba76
PP		 79
80extern bt_bool bt_field_class_real_is_single_precision(
b19ff26f 81 const bt_field_class *field_class);
40f4ba76
PP		 82
83extern uint64_t bt_field_class_enumeration_get_mapping_count(
b19ff26f 84 const bt_field_class *field_class);
40f4ba76 85
8f3ccfbc
PP		 86extern const bt_field_class_unsigned_enumeration_mapping *
87bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
88 const bt_field_class *field_class, uint64_t index);
89
90extern const bt_field_class_signed_enumeration_mapping *
91bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
92 const bt_field_class *field_class, uint64_t index);
93
94static inline
95const bt_field_class_enumeration_mapping *
96bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
97 const bt_field_class_unsigned_enumeration_mapping *mapping)
98{
005f1204 99 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
8f3ccfbc 100}
40f4ba76 101
8f3ccfbc
PP		 102static inline
103const bt_field_class_enumeration_mapping *
104bt_field_class_signed_enumeration_mapping_as_mapping_const(
105 const bt_field_class_signed_enumeration_mapping *mapping)
106{
005f1204 107 return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
8f3ccfbc 108}
40f4ba76 109
8f3ccfbc
PP		 110extern const char *bt_field_class_enumeration_mapping_get_label(
111 const bt_field_class_enumeration_mapping *mapping);
40f4ba76 112
8f3ccfbc
PP		 113extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
114 const bt_field_class_enumeration_mapping *mapping);
40f4ba76
PP		 115
116extern void
8f3ccfbc
PP		 117bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
118 const bt_field_class_unsigned_enumeration_mapping *mapping,
40f4ba76
PP		 119 uint64_t index, uint64_t *lower, uint64_t *upper);
120
121extern void
8f3ccfbc
PP		 122bt_field_class_signed_enumeration_mapping_get_range_by_index(
123 const bt_field_class_signed_enumeration_mapping *mapping,
40f4ba76
PP		 124 uint64_t index, int64_t *lower, int64_t *upper);
125
185ecf64 126typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
d24d5663
PP		 127 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
128 BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK,
185ecf64 129} bt_field_class_enumeration_get_mapping_labels_for_value_status;
d24d5663 130
185ecf64
PP		 131extern bt_field_class_enumeration_get_mapping_labels_for_value_status
132bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
b19ff26f 133 const bt_field_class *field_class, uint64_t value,
40f4ba76
PP		 134 bt_field_class_enumeration_mapping_label_array *label_array,
135 uint64_t *count);
136
185ecf64
PP		 137extern bt_field_class_enumeration_get_mapping_labels_for_value_status
138bt_field_class_signed_enumeration_get_mapping_labels_for_value(
b19ff26f 139 const bt_field_class *field_class, int64_t value,
40f4ba76
PP		 140 bt_field_class_enumeration_mapping_label_array *label_array,
141 uint64_t *count);
142
143extern uint64_t bt_field_class_structure_get_member_count(
b19ff26f 144 const bt_field_class *field_class);
40f4ba76 145
1e6fd1d7
PP		 146extern const bt_field_class_structure_member *
147bt_field_class_structure_borrow_member_by_index_const(
148 const bt_field_class *field_class, uint64_t index);
40f4ba76 149
1e6fd1d7
PP		 150extern const bt_field_class_structure_member *
151bt_field_class_structure_borrow_member_by_name_const(
b19ff26f 152 const bt_field_class *field_class, const char *name);
40f4ba76 153
1e6fd1d7
PP		 154extern const char *bt_field_class_structure_member_get_name(
155 const bt_field_class_structure_member *member);
156
157extern const bt_field_class *
158bt_field_class_structure_member_borrow_field_class_const(
159 const bt_field_class_structure_member *member);
160
b19ff26f 161extern const bt_field_class *
40f4ba76 162bt_field_class_array_borrow_element_field_class_const(
b19ff26f 163 const bt_field_class *field_class);
40f4ba76
PP		 164
165extern uint64_t bt_field_class_static_array_get_length(
b19ff26f 166 const bt_field_class *field_class);
40f4ba76 167
b19ff26f 168extern const bt_field_path *
40f4ba76 169bt_field_class_dynamic_array_borrow_length_field_path_const(
b19ff26f 170 const bt_field_class *field_class);
40f4ba76 171
b19ff26f 172extern const bt_field_path *
40f4ba76 173bt_field_class_variant_borrow_selector_field_path_const(
b19ff26f 174 const bt_field_class *field_class);
40f4ba76
PP		 175
176extern uint64_t bt_field_class_variant_get_option_count(
b19ff26f 177 const bt_field_class *field_class);
40f4ba76 178
1e6fd1d7
PP		 179extern const bt_field_class_variant_option *
180bt_field_class_variant_borrow_option_by_index_const(
181 const bt_field_class *field_class, uint64_t index);
40f4ba76 182
1e6fd1d7
PP		 183extern const bt_field_class_variant_option *
184bt_field_class_variant_borrow_option_by_name_const(
185 const bt_field_class *field_class, const char *name);
186
187extern const char *bt_field_class_variant_option_get_name(
188 const bt_field_class_variant_option *option);
189
190extern const bt_field_class *
191bt_field_class_variant_option_borrow_field_class_const(
192 const bt_field_class_variant_option *option);
40f4ba76 193
b19ff26f 194extern void bt_field_class_get_ref(const bt_field_class *field_class);
c5b9b441 195
b19ff26f 196extern void bt_field_class_put_ref(const bt_field_class *field_class);
c5b9b441
PP		 197
198#define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var) \
199 do { \
200 bt_field_class_put_ref(_var); \
201 (_var) = NULL; \
202 } while (0)
203
204#define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src) \
205 do { \
206 bt_field_class_put_ref(_var_dst); \
207 (_var_dst) = (_var_src); \
208 (_var_src) = NULL; \
209 } while (0)
210
211
40f4ba76
PP		 212#ifdef __cplusplus
213}
214#endif
215
924dc299 216#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */
BabelTrace - Trace Format Babel Tower
This page took 0.040457 seconds and 4 git commands to generate.