lib: decouple variant FC option names from selector FC mapping names
[babeltrace.git] / include / babeltrace2 / trace-ir / field-class.h
CommitLineData
924dc299
PP
1#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
2#define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
5cd6d0e5
PP
3
4/*
bbb7b5f0 5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
5cd6d0e5 6 *
5cd6d0e5
PP
7 * Permission is hereby granted, free of charge, to any person obtaining a copy
8 * of this software and associated documentation files (the "Software"), to deal
9 * in the Software without restriction, including without limitation the rights
10 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11 * copies of the Software, and to permit persons to whom the Software is
12 * furnished to do so, subject to the following conditions:
13 *
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
16 *
17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
23 * SOFTWARE.
5cd6d0e5
PP
24 */
25
4fa90f32
PP
26#ifndef __BT_IN_BABELTRACE_H
27# error "Please include <babeltrace2/babeltrace.h> instead."
28#endif
29
d24d5663
PP
30#include <stdint.h>
31#include <stddef.h>
32
3fadfbc0 33#include <babeltrace2/types.h>
3fadfbc0 34#include <babeltrace2/trace-ir/field-class-const.h>
40f4ba76 35
5cd6d0e5
PP
36#ifdef __cplusplus
37extern "C" {
38#endif
39
1122a43a
PP
40extern bt_field_class *bt_field_class_unsigned_integer_create(
41 bt_trace_class *trace_class);
5cd6d0e5 42
1122a43a
PP
43extern bt_field_class *bt_field_class_signed_integer_create(
44 bt_trace_class *trace_class);
40f4ba76
PP
45
46extern void bt_field_class_integer_set_field_value_range(
b19ff26f 47 bt_field_class *field_class, uint64_t size);
40f4ba76
PP
48
49extern void bt_field_class_integer_set_preferred_display_base(
b19ff26f 50 bt_field_class *field_class,
4cdfc5e8 51 bt_field_class_integer_preferred_display_base base);
40f4ba76 52
1122a43a 53extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
40f4ba76
PP
54
55extern void bt_field_class_real_set_is_single_precision(
b19ff26f 56 bt_field_class *field_class,
40f4ba76
PP
57 bt_bool is_single_precision);
58
1122a43a
PP
59extern bt_field_class *bt_field_class_unsigned_enumeration_create(
60 bt_trace_class *trace_class);
40f4ba76 61
1122a43a
PP
62extern bt_field_class *bt_field_class_signed_enumeration_create(
63 bt_trace_class *trace_class);
40f4ba76 64
45c51519
PP
65typedef enum bt_field_class_enumeration_add_mapping_status {
66 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
67 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK = __BT_FUNC_STATUS_OK,
68} bt_field_class_enumeration_add_mapping_status;
d24d5663 69
45c51519
PP
70extern bt_field_class_enumeration_add_mapping_status
71bt_field_class_unsigned_enumeration_add_mapping(
b19ff26f 72 bt_field_class *field_class, const char *label,
45c51519 73 const bt_integer_range_set_unsigned *range_set);
40f4ba76 74
45c51519
PP
75extern bt_field_class_enumeration_add_mapping_status
76bt_field_class_signed_enumeration_add_mapping(
b19ff26f 77 bt_field_class *field_class, const char *label,
45c51519 78 const bt_integer_range_set_signed *range_set);
40f4ba76 79
1122a43a
PP
80extern bt_field_class *bt_field_class_string_create(
81 bt_trace_class *trace_class);
40f4ba76 82
1122a43a
PP
83extern bt_field_class *bt_field_class_structure_create(
84 bt_trace_class *trace_class);
40f4ba76 85
d24d5663
PP
86typedef enum bt_field_class_structure_append_member_status {
87 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
88 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK,
89} bt_field_class_structure_append_member_status;
90
91extern bt_field_class_structure_append_member_status
92bt_field_class_structure_append_member(
b19ff26f
PP
93 bt_field_class *struct_field_class,
94 const char *name, bt_field_class *field_class);
40f4ba76 95
1e6fd1d7
PP
96extern bt_field_class_structure_member *
97bt_field_class_structure_borrow_member_by_index(
98 bt_field_class *field_class, uint64_t index);
740faaf4 99
1e6fd1d7
PP
100extern bt_field_class_structure_member *
101bt_field_class_structure_borrow_member_by_name(
740faaf4
PP
102 bt_field_class *field_class, const char *name);
103
b19ff26f 104extern bt_field_class *bt_field_class_static_array_create(
1122a43a 105 bt_trace_class *trace_class,
b19ff26f 106 bt_field_class *elem_field_class, uint64_t length);
40f4ba76 107
b19ff26f 108extern bt_field_class *bt_field_class_dynamic_array_create(
1122a43a 109 bt_trace_class *trace_class,
b19ff26f 110 bt_field_class *elem_field_class);
40f4ba76 111
740faaf4
PP
112extern bt_field_class *bt_field_class_array_borrow_element_field_class(
113 bt_field_class *field_class);
114
d24d5663
PP
115typedef enum bt_field_class_dynamic_array_set_length_field_class_status {
116 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
45c51519 117 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
d24d5663
PP
118} bt_field_class_dynamic_array_set_length_field_class_status;
119
120extern bt_field_class_dynamic_array_set_length_field_class_status
4295b9e0 121bt_field_class_dynamic_array_set_length_field_class(
b19ff26f
PP
122 bt_field_class *field_class,
123 bt_field_class *length_field_class);
40f4ba76 124
1122a43a 125extern bt_field_class *bt_field_class_variant_create(
45c51519 126 bt_trace_class *trace_class,
b19ff26f 127 bt_field_class *selector_field_class);
40f4ba76 128
45c51519
PP
129typedef enum bt_field_class_variant_without_selector_append_option_status {
130 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
131 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
132} bt_field_class_variant_without_selector_append_option_status;
d24d5663 133
45c51519
PP
134extern bt_field_class_variant_without_selector_append_option_status
135bt_field_class_variant_without_selector_append_option(
136 bt_field_class *var_field_class, const char *name,
137 bt_field_class *field_class);
5cd6d0e5 138
45c51519
PP
139typedef enum bt_field_class_variant_with_selector_append_option_status {
140 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
141 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
142} bt_field_class_variant_with_selector_append_option_status;
740faaf4 143
45c51519
PP
144extern bt_field_class_variant_with_selector_append_option_status
145bt_field_class_variant_with_unsigned_selector_append_option(
146 bt_field_class *var_field_class, const char *name,
147 bt_field_class *field_class,
148 const bt_integer_range_set_unsigned *range_set);
1e6fd1d7 149
45c51519
PP
150extern bt_field_class_variant_with_selector_append_option_status
151bt_field_class_variant_with_signed_selector_append_option(
152 bt_field_class *var_field_class, const char *name,
153 bt_field_class *field_class,
154 const bt_integer_range_set_signed *range_set);
740faaf4 155
5cd6d0e5
PP
156#ifdef __cplusplus
157}
158#endif
159
924dc299 160#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */
This page took 0.041147 seconds and 4 git commands to generate.