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