lib: add bt_field_class_variant_borrow_option_by_{index,name}()
[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
5cebbe7f
PP
40extern bt_field_class *bt_field_class_bool_create(
41 bt_trace_class *trace_class);
42
1094efa4
PP
43extern bt_field_class *bt_field_class_bit_array_create(
44 bt_trace_class *trace_class, uint64_t length);
45
9c08c816 46extern bt_field_class *bt_field_class_integer_unsigned_create(
1122a43a 47 bt_trace_class *trace_class);
5cd6d0e5 48
9c08c816 49extern bt_field_class *bt_field_class_integer_signed_create(
1122a43a 50 bt_trace_class *trace_class);
40f4ba76
PP
51
52extern void bt_field_class_integer_set_field_value_range(
b19ff26f 53 bt_field_class *field_class, uint64_t size);
40f4ba76
PP
54
55extern void bt_field_class_integer_set_preferred_display_base(
b19ff26f 56 bt_field_class *field_class,
4cdfc5e8 57 bt_field_class_integer_preferred_display_base base);
40f4ba76 58
1122a43a 59extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
40f4ba76
PP
60
61extern void bt_field_class_real_set_is_single_precision(
b19ff26f 62 bt_field_class *field_class,
40f4ba76
PP
63 bt_bool is_single_precision);
64
9c08c816 65extern bt_field_class *bt_field_class_enumeration_unsigned_create(
1122a43a 66 bt_trace_class *trace_class);
40f4ba76 67
9c08c816 68extern bt_field_class *bt_field_class_enumeration_signed_create(
1122a43a 69 bt_trace_class *trace_class);
40f4ba76 70
45c51519
PP
71typedef enum bt_field_class_enumeration_add_mapping_status {
72 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
73 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK = __BT_FUNC_STATUS_OK,
74} bt_field_class_enumeration_add_mapping_status;
d24d5663 75
45c51519 76extern bt_field_class_enumeration_add_mapping_status
9c08c816 77bt_field_class_enumeration_unsigned_add_mapping(
b19ff26f 78 bt_field_class *field_class, const char *label,
45c51519 79 const bt_integer_range_set_unsigned *range_set);
40f4ba76 80
45c51519 81extern bt_field_class_enumeration_add_mapping_status
9c08c816 82bt_field_class_enumeration_signed_add_mapping(
b19ff26f 83 bt_field_class *field_class, const char *label,
45c51519 84 const bt_integer_range_set_signed *range_set);
40f4ba76 85
1122a43a
PP
86extern bt_field_class *bt_field_class_string_create(
87 bt_trace_class *trace_class);
40f4ba76 88
1122a43a
PP
89extern bt_field_class *bt_field_class_structure_create(
90 bt_trace_class *trace_class);
40f4ba76 91
d24d5663
PP
92typedef enum bt_field_class_structure_append_member_status {
93 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
94 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK,
95} bt_field_class_structure_append_member_status;
96
97extern bt_field_class_structure_append_member_status
98bt_field_class_structure_append_member(
b19ff26f
PP
99 bt_field_class *struct_field_class,
100 const char *name, bt_field_class *field_class);
40f4ba76 101
1e6fd1d7
PP
102extern bt_field_class_structure_member *
103bt_field_class_structure_borrow_member_by_index(
104 bt_field_class *field_class, uint64_t index);
740faaf4 105
1e6fd1d7
PP
106extern bt_field_class_structure_member *
107bt_field_class_structure_borrow_member_by_name(
740faaf4
PP
108 bt_field_class *field_class, const char *name);
109
9c08c816 110extern bt_field_class *bt_field_class_array_static_create(
1122a43a 111 bt_trace_class *trace_class,
b19ff26f 112 bt_field_class *elem_field_class, uint64_t length);
40f4ba76 113
9c08c816 114extern bt_field_class *bt_field_class_array_dynamic_create(
1122a43a 115 bt_trace_class *trace_class,
1367bc7c
PP
116 bt_field_class *elem_field_class,
117 bt_field_class *length_field_class);
40f4ba76 118
740faaf4
PP
119extern bt_field_class *bt_field_class_array_borrow_element_field_class(
120 bt_field_class *field_class);
121
b38aea74
PP
122extern bt_field_class *bt_field_class_option_create(
123 bt_trace_class *trace_class,
124 bt_field_class *content_field_class,
125 bt_field_class *selector_field_class);
126
1122a43a 127extern bt_field_class *bt_field_class_variant_create(
45c51519 128 bt_trace_class *trace_class,
b19ff26f 129 bt_field_class *selector_field_class);
40f4ba76 130
45c51519
PP
131typedef enum bt_field_class_variant_without_selector_append_option_status {
132 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
133 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
134} bt_field_class_variant_without_selector_append_option_status;
d24d5663 135
45c51519
PP
136extern bt_field_class_variant_without_selector_append_option_status
137bt_field_class_variant_without_selector_append_option(
138 bt_field_class *var_field_class, const char *name,
139 bt_field_class *field_class);
5cd6d0e5 140
45c51519
PP
141typedef enum bt_field_class_variant_with_selector_append_option_status {
142 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
143 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
144} bt_field_class_variant_with_selector_append_option_status;
740faaf4 145
45c51519 146extern bt_field_class_variant_with_selector_append_option_status
9c08c816 147bt_field_class_variant_with_selector_unsigned_append_option(
45c51519
PP
148 bt_field_class *var_field_class, const char *name,
149 bt_field_class *field_class,
150 const bt_integer_range_set_unsigned *range_set);
1e6fd1d7 151
45c51519 152extern bt_field_class_variant_with_selector_append_option_status
9c08c816 153bt_field_class_variant_with_selector_signed_append_option(
45c51519
PP
154 bt_field_class *var_field_class, const char *name,
155 bt_field_class *field_class,
156 const bt_integer_range_set_signed *range_set);
740faaf4 157
c6fe8c40
PP
158extern bt_field_class_variant_option *
159bt_field_class_variant_borrow_option_by_index(
160 bt_field_class *field_class, uint64_t index);
161
162extern bt_field_class_variant_option *
163bt_field_class_variant_borrow_option_by_name(
164 bt_field_class *field_class, const char *name);
165
5cd6d0e5
PP
166#ifdef __cplusplus
167}
168#endif
169
924dc299 170#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */
This page took 0.044523 seconds and 4 git commands to generate.