lib: bt_field_class_dynamic_array_create(): accept length FC parameter
[babeltrace.git] / include / babeltrace2 / trace-ir / field-class.h
CommitLineData
3fd40f46
PP
1#ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_H
2#define BABELTRACE2_TRACE_IR_FIELD_CLASS_H
939190b3
PP
3
4/*
0dcb770f 5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
939190b3 6 *
939190b3
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.
939190b3
PP
24 */
25
9df34b44
PP
26#ifndef __BT_IN_BABELTRACE_H
27# error "Please include <babeltrace2/babeltrace.h> instead."
28#endif
29
fb25b9e3
PP
30#include <stdint.h>
31#include <stddef.h>
32
71c5da58 33#include <babeltrace2/types.h>
71c5da58 34#include <babeltrace2/trace-ir/field-class-const.h>
78cf9df6 35
939190b3
PP
36#ifdef __cplusplus
37extern "C" {
38#endif
39
b7396828
PP
40extern bt_field_class *bt_field_class_unsigned_integer_create(
41 bt_trace_class *trace_class);
939190b3 42
b7396828
PP
43extern bt_field_class *bt_field_class_signed_integer_create(
44 bt_trace_class *trace_class);
78cf9df6
PP
45
46extern void bt_field_class_integer_set_field_value_range(
8eee8ea2 47 bt_field_class *field_class, uint64_t size);
78cf9df6
PP
48
49extern void bt_field_class_integer_set_preferred_display_base(
8eee8ea2 50 bt_field_class *field_class,
ee78f405 51 bt_field_class_integer_preferred_display_base base);
78cf9df6 52
b7396828 53extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
78cf9df6
PP
54
55extern void bt_field_class_real_set_is_single_precision(
8eee8ea2 56 bt_field_class *field_class,
78cf9df6
PP
57 bt_bool is_single_precision);
58
b7396828
PP
59extern bt_field_class *bt_field_class_unsigned_enumeration_create(
60 bt_trace_class *trace_class);
78cf9df6 61
b7396828
PP
62extern bt_field_class *bt_field_class_signed_enumeration_create(
63 bt_trace_class *trace_class);
78cf9df6 64
02b61fe0
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;
fb25b9e3 69
02b61fe0
PP
70extern bt_field_class_enumeration_add_mapping_status
71bt_field_class_unsigned_enumeration_add_mapping(
8eee8ea2 72 bt_field_class *field_class, const char *label,
02b61fe0 73 const bt_integer_range_set_unsigned *range_set);
78cf9df6 74
02b61fe0
PP
75extern bt_field_class_enumeration_add_mapping_status
76bt_field_class_signed_enumeration_add_mapping(
8eee8ea2 77 bt_field_class *field_class, const char *label,
02b61fe0 78 const bt_integer_range_set_signed *range_set);
78cf9df6 79
b7396828
PP
80extern bt_field_class *bt_field_class_string_create(
81 bt_trace_class *trace_class);
78cf9df6 82
b7396828
PP
83extern bt_field_class *bt_field_class_structure_create(
84 bt_trace_class *trace_class);
78cf9df6 85
fb25b9e3
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(
8eee8ea2
PP
93 bt_field_class *struct_field_class,
94 const char *name, bt_field_class *field_class);
78cf9df6 95
e24f271a
PP
96extern bt_field_class_structure_member *
97bt_field_class_structure_borrow_member_by_index(
98 bt_field_class *field_class, uint64_t index);
909d0a89 99
e24f271a
PP
100extern bt_field_class_structure_member *
101bt_field_class_structure_borrow_member_by_name(
909d0a89
PP
102 bt_field_class *field_class, const char *name);
103
8eee8ea2 104extern bt_field_class *bt_field_class_static_array_create(
b7396828 105 bt_trace_class *trace_class,
8eee8ea2 106 bt_field_class *elem_field_class, uint64_t length);
78cf9df6 107
8eee8ea2 108extern bt_field_class *bt_field_class_dynamic_array_create(
b7396828 109 bt_trace_class *trace_class,
93d7d5d1
PP
110 bt_field_class *elem_field_class,
111 bt_field_class *length_field_class);
78cf9df6 112
909d0a89
PP
113extern bt_field_class *bt_field_class_array_borrow_element_field_class(
114 bt_field_class *field_class);
115
b7396828 116extern bt_field_class *bt_field_class_variant_create(
02b61fe0 117 bt_trace_class *trace_class,
8eee8ea2 118 bt_field_class *selector_field_class);
78cf9df6 119
02b61fe0
PP
120typedef enum bt_field_class_variant_without_selector_append_option_status {
121 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
122 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
123} bt_field_class_variant_without_selector_append_option_status;
fb25b9e3 124
02b61fe0
PP
125extern bt_field_class_variant_without_selector_append_option_status
126bt_field_class_variant_without_selector_append_option(
127 bt_field_class *var_field_class, const char *name,
128 bt_field_class *field_class);
939190b3 129
02b61fe0
PP
130typedef enum bt_field_class_variant_with_selector_append_option_status {
131 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
132 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
133} bt_field_class_variant_with_selector_append_option_status;
909d0a89 134
02b61fe0
PP
135extern bt_field_class_variant_with_selector_append_option_status
136bt_field_class_variant_with_unsigned_selector_append_option(
137 bt_field_class *var_field_class, const char *name,
138 bt_field_class *field_class,
139 const bt_integer_range_set_unsigned *range_set);
e24f271a 140
02b61fe0
PP
141extern bt_field_class_variant_with_selector_append_option_status
142bt_field_class_variant_with_signed_selector_append_option(
143 bt_field_class *var_field_class, const char *name,
144 bt_field_class *field_class,
145 const bt_integer_range_set_signed *range_set);
909d0a89 146
939190b3
PP
147#ifdef __cplusplus
148}
149#endif
150
3fd40f46 151#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */
This page took 0.041393 seconds and 4 git commands to generate.