projects / babeltrace.git / blame
? search:
summary | shortlog | log | commit | commitdiff | tree
blob | blame (incremental) | history | HEAD
lib: remove "For *" comments in public headers
[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/*
f2b0325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
939190b3
PP		 6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
939190b3
PP		 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
9df34b44
PP		 30#ifndef __BT_IN_BABELTRACE_H
31# error "Please include <babeltrace2/babeltrace.h> instead."
32#endif
33
fb25b9e3
PP		 34#include <stdint.h>
35#include <stddef.h>
36
71c5da58 37#include <babeltrace2/types.h>
71c5da58 38#include <babeltrace2/trace-ir/field-class-const.h>
78cf9df6 39
939190b3
PP		 40#ifdef __cplusplus
41extern "C" {
42#endif
43
b7396828
PP		 44extern bt_field_class *bt_field_class_unsigned_integer_create(
45 bt_trace_class *trace_class);
939190b3 46
b7396828
PP		 47extern bt_field_class *bt_field_class_signed_integer_create(
48 bt_trace_class *trace_class);
78cf9df6
PP		 49
50extern void bt_field_class_integer_set_field_value_range(
8eee8ea2 51 bt_field_class *field_class, uint64_t size);
78cf9df6
PP		 52
53extern void bt_field_class_integer_set_preferred_display_base(
8eee8ea2 54 bt_field_class *field_class,
ee78f405 55 bt_field_class_integer_preferred_display_base base);
78cf9df6 56
b7396828 57extern bt_field_class *bt_field_class_real_create(bt_trace_class *trace_class);
78cf9df6
PP		 58
59extern void bt_field_class_real_set_is_single_precision(
8eee8ea2 60 bt_field_class *field_class,
78cf9df6
PP		 61 bt_bool is_single_precision);
62
b7396828
PP		 63extern bt_field_class *bt_field_class_unsigned_enumeration_create(
64 bt_trace_class *trace_class);
78cf9df6 65
b7396828
PP		 66extern bt_field_class *bt_field_class_signed_enumeration_create(
67 bt_trace_class *trace_class);
78cf9df6 68
fb25b9e3
PP		 69typedef enum bt_field_class_enumeration_map_range_status {
70 BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
71 BT_FIELD_CLASS_ENUMERATION_MAP_RANGE_STATUS_OK = __BT_FUNC_STATUS_OK,
72} bt_field_class_enumeration_map_range_status;
73
74extern bt_field_class_enumeration_map_range_status
75bt_field_class_unsigned_enumeration_map_range(
8eee8ea2 76 bt_field_class *field_class, const char *label,
78cf9df6
PP		 77 uint64_t range_lower, uint64_t range_upper);
78
fb25b9e3
PP		 79extern bt_field_class_enumeration_map_range_status
80bt_field_class_signed_enumeration_map_range(
8eee8ea2 81 bt_field_class *field_class, const char *label,
78cf9df6
PP		 82 int64_t range_lower, int64_t range_upper);
83
b7396828
PP		 84extern bt_field_class *bt_field_class_string_create(
85 bt_trace_class *trace_class);
78cf9df6 86
b7396828
PP		 87extern bt_field_class *bt_field_class_structure_create(
88 bt_trace_class *trace_class);
78cf9df6 89
fb25b9e3
PP		 90typedef enum bt_field_class_structure_append_member_status {
91 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
92 BT_FIELD_CLASS_STRUCTURE_APPEND_MEMBER_STATUS_OK = __BT_FUNC_STATUS_OK,
93} bt_field_class_structure_append_member_status;
94
95extern bt_field_class_structure_append_member_status
96bt_field_class_structure_append_member(
8eee8ea2
PP		 97 bt_field_class *struct_field_class,
98 const char *name, bt_field_class *field_class);
78cf9df6 99
e24f271a
PP		 100extern bt_field_class_structure_member *
101bt_field_class_structure_borrow_member_by_index(
102 bt_field_class *field_class, uint64_t index);
909d0a89 103
e24f271a
PP		 104extern bt_field_class_structure_member *
105bt_field_class_structure_borrow_member_by_name(
909d0a89
PP		 106 bt_field_class *field_class, const char *name);
107
8eee8ea2 108extern bt_field_class *bt_field_class_static_array_create(
b7396828 109 bt_trace_class *trace_class,
8eee8ea2 110 bt_field_class *elem_field_class, uint64_t length);
78cf9df6 111
8eee8ea2 112extern bt_field_class *bt_field_class_dynamic_array_create(
b7396828 113 bt_trace_class *trace_class,
8eee8ea2 114 bt_field_class *elem_field_class);
78cf9df6 115
909d0a89
PP		 116extern bt_field_class *bt_field_class_array_borrow_element_field_class(
117 bt_field_class *field_class);
118
fb25b9e3
PP		 119typedef enum bt_field_class_dynamic_array_set_length_field_class_status {
120 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
121 BT_FIELD_CLASS_DYNAMIC_ARRAY_SET_LENGTH_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
122} bt_field_class_dynamic_array_set_length_field_class_status;
123
124extern bt_field_class_dynamic_array_set_length_field_class_status
4b514ab3 125bt_field_class_dynamic_array_set_length_field_class(
8eee8ea2
PP		 126 bt_field_class *field_class,
127 bt_field_class *length_field_class);
78cf9df6 128
b7396828
PP		 129extern bt_field_class *bt_field_class_variant_create(
130 bt_trace_class *trace_class);
78cf9df6 131
fb25b9e3
PP		 132typedef enum bt_field_class_variant_set_selector_field_class_status {
133 BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
134 BT_FIELD_CLASS_VARIANT_SET_SELECTOR_FIELD_CLASS_STATUS_OK = __BT_FUNC_STATUS_OK,
135} bt_field_class_variant_set_selector_field_class_status;
136
137extern bt_field_class_variant_set_selector_field_class_status
4b514ab3 138bt_field_class_variant_set_selector_field_class(bt_field_class *field_class,
8eee8ea2 139 bt_field_class *selector_field_class);
78cf9df6 140
fb25b9e3
PP		 141typedef enum bt_field_class_variant_append_option_status {
142 BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
143 BT_FIELD_CLASS_VARIANT_APPEND_OPTION_STATUS_OK = __BT_FUNC_STATUS_OK,
144} bt_field_class_variant_append_option_status;
145
146extern bt_field_class_variant_append_option_status
147bt_field_class_variant_append_option(
8eee8ea2
PP		 148 bt_field_class *var_field_class,
149 const char *name, bt_field_class *field_class);
939190b3 150
e24f271a
PP		 151extern bt_field_class_variant_option *
152bt_field_class_variant_borrow_option_by_index(
153 bt_field_class *field_class, uint64_t index);
909d0a89 154
e24f271a
PP		 155extern bt_field_class_variant_option *
156bt_field_class_variant_borrow_option_by_name(
c0db9072 157 bt_field_class *field_class, const char *name);
e24f271a
PP		 158
159extern bt_field_class *bt_field_class_variant_option_borrow_field_class(
160 bt_field_class_variant_option *option);
909d0a89 161
939190b3
PP		 162#ifdef __cplusplus
163}
164#endif
165
3fd40f46 166#endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_H */
BabelTrace - Trace Format Babel Tower
This page took 0.040085 seconds and 4 git commands to generate.