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.h
... / ...
CommitLineData
1#ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_H
2#define BABELTRACE_TRACE_IR_FIELD_CLASSES_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#include <stdint.h>
31#include <stddef.h>
32
33/* For bt_bool, bt_field_class, bt_trace_class */
34#include <babeltrace2/types.h>
35
36/* For bt_field_class_integer_preferred_display_base */
37#include <babeltrace2/trace-ir/field-class-const.h>
38
39/* For __BT_FUNC_STATUS_* */
40#define __BT_FUNC_STATUS_ENABLE
41#include <babeltrace2/func-status.h>
42#undef __BT_FUNC_STATUS_ENABLE
43
44#ifdef __cplusplus
45extern "C" {
46#endif
47
48extern bt_field_class *bt_field_class_unsigned_integer_create(
49 bt_trace_class *trace_class);
50
51extern bt_field_class *bt_field_class_signed_integer_create(
52 bt_trace_class *trace_class);
53
54extern void bt_field_class_integer_set_field_value_range(
55 bt_field_class *field_class, uint64_t size);
56
57extern void bt_field_class_integer_set_preferred_display_base(
58 bt_field_class *field_class,
59 bt_field_class_integer_preferred_display_base base);
60
61extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
62
63extern void bt_field_class_real_set_is_single_precision(
64 bt_field_class *field_class,
65 bt_bool is_single_precision);
66
67extern bt_field_class *bt_field_class_unsigned_enumeration_create(
68 bt_trace_class *trace_class);
69
70extern bt_field_class *bt_field_class_signed_enumeration_create(
71 bt_trace_class *trace_class);
72
73typedef enum bt_field_class_enumeration_map_range_status {
74 BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
75 BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_OK = __BT_FUNC_STATUS_OK,
76} bt_field_class_enumeration_map_range_status;
77
78extern bt_field_class_enumeration_map_range_status
79bt_field_class_unsigned_enumeration_map_range(
80 bt_field_class *field_class, const char *label,
81 uint64_t range_lower, uint64_t range_upper);
82
83extern bt_field_class_enumeration_map_range_status
84bt_field_class_signed_enumeration_map_range(
85 bt_field_class *field_class, const char *label,
86 int64_t range_lower, int64_t range_upper);
87
88extern bt_field_class *bt_field_class_string_create(
89 bt_trace_class *trace_class);
90
91extern bt_field_class *bt_field_class_structure_create(
92 bt_trace_class *trace_class);
93
94typedef enum bt_field_class_structure_append_member_status {
95 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
96 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK,
97} bt_field_class_structure_append_member_status;
98
99extern bt_field_class_structure_append_member_status
100bt_field_class_structure_append_member(
101 bt_field_class *struct_field_class,
102 const char *name, bt_field_class *field_class);
103
104extern bt_field_class_structure_member *
105bt_field_class_structure_borrow_member_by_index(
106 bt_field_class *field_class, uint64_t index);
107
108extern bt_field_class_structure_member *
109bt_field_class_structure_borrow_member_by_name(
110 bt_field_class *field_class, const char *name);
111
112extern bt_field_class *bt_field_class_static_array_create(
113 bt_trace_class *trace_class,
114 bt_field_class *elem_field_class, uint64_t length);
115
116extern bt_field_class *bt_field_class_dynamic_array_create(
117 bt_trace_class *trace_class,
118 bt_field_class *elem_field_class);
119
120extern bt_field_class *bt_field_class_array_borrow_element_field_class(
121 bt_field_class *field_class);
122
123typedef enum bt_field_class_dynamic_array_set_length_field_class_status {
124 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
125 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
126} bt_field_class_dynamic_array_set_length_field_class_status;
127
128extern bt_field_class_dynamic_array_set_length_field_class_status
129bt_field_class_dynamic_array_set_length_field_class(
130 bt_field_class *field_class,
131 bt_field_class *length_field_class);
132
133extern bt_field_class *bt_field_class_variant_create(
134 bt_trace_class *trace_class);
135
136typedef enum bt_field_class_variant_set_selector_field_class_status {
137 BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
138 BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
139} bt_field_class_variant_set_selector_field_class_status;
140
141extern bt_field_class_variant_set_selector_field_class_status
142bt_field_class_variant_set_selector_field_class(bt_field_class *field_class,
143 bt_field_class *selector_field_class);
144
145typedef enum bt_field_class_variant_append_option_status {
146 BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
147 BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
148} bt_field_class_variant_append_option_status;
149
150extern bt_field_class_variant_append_option_status
151bt_field_class_variant_append_option(
152 bt_field_class *var_field_class,
153 const char *name, bt_field_class *field_class);
154
155extern bt_field_class_variant_option *
156bt_field_class_variant_borrow_option_by_index(
157 bt_field_class *field_class, uint64_t index);
158
159extern bt_field_class_variant_option *
160bt_field_class_variant_borrow_option_by_name(
161 bt_field_class *field_class, const char *name);
162
163extern bt_field_class *bt_field_class_variant_option_borrow_field_class(
164 bt_field_class_variant_option *option);
165
166#ifdef __cplusplus
167}
168#endif
169
170#include <babeltrace2/undef-func-status.h>
171
172#endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_H */
BabelTrace - Trace Format Babel Tower
This page took 0.025362 seconds and 4 git commands to generate.