projects / babeltrace.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
lib: add user attributes property to metadata, stream, and trace objects
[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
af90138b
PP		 40extern void bt_field_class_set_user_attributes(
41 bt_field_class *field_class, const bt_value *user_attributes);
42
43extern bt_value *bt_field_class_borrow_user_attributes(
44 bt_field_class *field_class);
45
9414b439
PP		 46extern bt_field_class *bt_field_class_bool_create(
47 bt_trace_class *trace_class);
48
6943da6a
PP		 49extern bt_field_class *bt_field_class_bit_array_create(
50 bt_trace_class *trace_class, uint64_t length);
51
60bbfc7c 52extern bt_field_class *bt_field_class_integer_unsigned_create(
b7396828 53 bt_trace_class *trace_class);
939190b3 54
60bbfc7c 55extern bt_field_class *bt_field_class_integer_signed_create(
b7396828 56 bt_trace_class *trace_class);
78cf9df6
PP		 57
58extern void bt_field_class_integer_set_field_value_range(
8eee8ea2 59 bt_field_class *field_class, uint64_t size);
78cf9df6
PP		 60
61extern void bt_field_class_integer_set_preferred_display_base(
8eee8ea2 62 bt_field_class *field_class,
ee78f405 63 bt_field_class_integer_preferred_display_base base);
78cf9df6 64
b7396828 65extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
78cf9df6
PP		 66
67extern void bt_field_class_real_set_is_single_precision(
8eee8ea2 68 bt_field_class *field_class,
78cf9df6
PP		 69 bt_bool is_single_precision);
70
60bbfc7c 71extern bt_field_class *bt_field_class_enumeration_unsigned_create(
b7396828 72 bt_trace_class *trace_class);
78cf9df6 73
60bbfc7c 74extern bt_field_class *bt_field_class_enumeration_signed_create(
b7396828 75 bt_trace_class *trace_class);
78cf9df6 76
02b61fe0
PP		 77typedef enum bt_field_class_enumeration_add_mapping_status {
78 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
79 BT_FIELD_CLASS_ENUMERATION_ADD_MAPPING_STATUS_OK = __BT_FUNC_STATUS_OK,
80} bt_field_class_enumeration_add_mapping_status;
fb25b9e3 81
02b61fe0 82extern bt_field_class_enumeration_add_mapping_status
60bbfc7c 83bt_field_class_enumeration_unsigned_add_mapping(
8eee8ea2 84 bt_field_class *field_class, const char *label,
02b61fe0 85 const bt_integer_range_set_unsigned *range_set);
78cf9df6 86
02b61fe0 87extern bt_field_class_enumeration_add_mapping_status
60bbfc7c 88bt_field_class_enumeration_signed_add_mapping(
8eee8ea2 89 bt_field_class *field_class, const char *label,
02b61fe0 90 const bt_integer_range_set_signed *range_set);
78cf9df6 91
b7396828
PP		 92extern bt_field_class *bt_field_class_string_create(
93 bt_trace_class *trace_class);
78cf9df6 94
b7396828
PP		 95extern bt_field_class *bt_field_class_structure_create(
96 bt_trace_class *trace_class);
78cf9df6 97
fb25b9e3
PP		 98typedef enum bt_field_class_structure_append_member_status {
99 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
100 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK,
101} bt_field_class_structure_append_member_status;
102
103extern bt_field_class_structure_append_member_status
104bt_field_class_structure_append_member(
8eee8ea2
PP		 105 bt_field_class *struct_field_class,
106 const char *name, bt_field_class *field_class);
78cf9df6 107
e24f271a
PP		 108extern bt_field_class_structure_member *
109bt_field_class_structure_borrow_member_by_index(
110 bt_field_class *field_class, uint64_t index);
909d0a89 111
e24f271a
PP		 112extern bt_field_class_structure_member *
113bt_field_class_structure_borrow_member_by_name(
909d0a89
PP		 114 bt_field_class *field_class, const char *name);
115
af90138b
PP		 116extern bt_value *bt_field_class_structure_member_borrow_user_attributes(
117 bt_field_class_structure_member *member);
118
119extern void bt_field_class_structure_member_set_user_attributes(
120 bt_field_class_structure_member *member,
121 const bt_value *user_attributes);
122
60bbfc7c 123extern bt_field_class *bt_field_class_array_static_create(
b7396828 124 bt_trace_class *trace_class,
8eee8ea2 125 bt_field_class *elem_field_class, uint64_t length);
78cf9df6 126
60bbfc7c 127extern bt_field_class *bt_field_class_array_dynamic_create(
b7396828 128 bt_trace_class *trace_class,
93d7d5d1
PP		 129 bt_field_class *elem_field_class,
130 bt_field_class *length_field_class);
78cf9df6 131
909d0a89
PP		 132extern bt_field_class *bt_field_class_array_borrow_element_field_class(
133 bt_field_class *field_class);
134
247fa9e3
PP		 135extern bt_field_class *bt_field_class_option_create(
136 bt_trace_class *trace_class,
137 bt_field_class *content_field_class,
138 bt_field_class *selector_field_class);
139
b7396828 140extern bt_field_class *bt_field_class_variant_create(
02b61fe0 141 bt_trace_class *trace_class,
8eee8ea2 142 bt_field_class *selector_field_class);
78cf9df6 143
02b61fe0
PP		 144typedef enum bt_field_class_variant_without_selector_append_option_status {
145 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
146 BT_FIELD_CLASS_VARIANT_WITHOUT_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
147} bt_field_class_variant_without_selector_append_option_status;
fb25b9e3 148
02b61fe0
PP		 149extern bt_field_class_variant_without_selector_append_option_status
150bt_field_class_variant_without_selector_append_option(
151 bt_field_class *var_field_class, const char *name,
152 bt_field_class *field_class);
939190b3 153
02b61fe0
PP		 154typedef enum bt_field_class_variant_with_selector_append_option_status {
155 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
156 BT_FIELD_CLASS_VARIANT_WITH_SELECTOR_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
157} bt_field_class_variant_with_selector_append_option_status;
909d0a89 158
02b61fe0 159extern bt_field_class_variant_with_selector_append_option_status
60bbfc7c 160bt_field_class_variant_with_selector_unsigned_append_option(
02b61fe0
PP		 161 bt_field_class *var_field_class, const char *name,
162 bt_field_class *field_class,
163 const bt_integer_range_set_unsigned *range_set);
e24f271a 164
02b61fe0 165extern bt_field_class_variant_with_selector_append_option_status
60bbfc7c 166bt_field_class_variant_with_selector_signed_append_option(
02b61fe0
PP		 167 bt_field_class *var_field_class, const char *name,
168 bt_field_class *field_class,
169 const bt_integer_range_set_signed *range_set);
909d0a89 170
34dd2c30
PP		 171extern bt_field_class_variant_option *
172bt_field_class_variant_borrow_option_by_index(
173 bt_field_class *field_class, uint64_t index);
174
175extern bt_field_class_variant_option *
176bt_field_class_variant_borrow_option_by_name(
177 bt_field_class *field_class, const char *name);
178
af90138b
PP		 179extern bt_value *bt_field_class_variant_option_borrow_user_attributes(
180 bt_field_class_variant_option *option);
181
182extern void bt_field_class_variant_option_set_user_attributes(
183 bt_field_class_variant_option *option,
184 const bt_value *user_attributes);
185
939190b3
PP		 186#ifdef __cplusplus
187}
188#endif
189
3fd40f46 190#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */
BabelTrace - Trace Format Babel Tower
This page took 0.044554 seconds and 4 git commands to generate.