src/{ctfser,fd-cache}/Makefile.am: remove unneeded `AM_CPPFLAGS`
[babeltrace.git] / include / babeltrace2 / trace-ir / field.h
CommitLineData
108b91d0
PP
1#ifndef BABELTRACE_TRACE_IR_FIELDS_H
2#define BABELTRACE_TRACE_IR_FIELDS_H
3
4/*
f2b0325d 5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
108b91d0
PP
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 *
108b91d0
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
30#include <stdint.h>
31
8eee8ea2 32/* For bt_field, bt_field_class */
71c5da58 33#include <babeltrace2/types.h>
8eee8ea2 34
fb25b9e3
PP
35/* For __BT_FUNC_STATUS_* */
36#define __BT_FUNC_STATUS_ENABLE
37#include <babeltrace2/func-status.h>
38#undef __BT_FUNC_STATUS_ENABLE
937c4e48 39
108b91d0
PP
40#ifdef __cplusplus
41extern "C" {
42#endif
43
8eee8ea2 44extern void bt_field_signed_integer_set_value(bt_field *field,
78cf9df6 45 int64_t value);
108b91d0 46
8eee8ea2 47extern void bt_field_unsigned_integer_set_value(bt_field *field,
78cf9df6 48 uint64_t value);
108b91d0 49
8eee8ea2 50extern void bt_field_real_set_value(bt_field *field, double value);
108b91d0 51
fb25b9e3
PP
52typedef enum bt_field_string_set_value_status {
53 BT_FIELD_STRING_SET_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
54 BT_FIELD_STRING_SET_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK,
55} bt_field_string_set_value_status;
108b91d0 56
fb25b9e3
PP
57extern bt_field_string_set_value_status bt_field_string_set_value(
58 bt_field *field, const char *value);
108b91d0 59
fb25b9e3
PP
60typedef enum bt_field_string_append_status {
61 BT_FIELD_STRING_APPEND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
62 BT_FIELD_STRING_APPEND_STATUS_OK = __BT_FUNC_STATUS_OK,
63} bt_field_string_append_status;
108b91d0 64
fb25b9e3
PP
65extern bt_field_string_append_status bt_field_string_append(
66 bt_field *field, const char *value);
67
68extern bt_field_string_append_status bt_field_string_append_with_length(
69 bt_field *field, const char *value, uint64_t length);
70
71extern void bt_field_string_clear(bt_field *field);
108b91d0 72
8eee8ea2
PP
73extern bt_field *bt_field_structure_borrow_member_field_by_index(
74 bt_field *field, uint64_t index);
108b91d0 75
8eee8ea2
PP
76extern bt_field *bt_field_structure_borrow_member_field_by_name(
77 bt_field *field, const char *name);
108b91d0 78
8eee8ea2
PP
79extern bt_field *bt_field_array_borrow_element_field_by_index(
80 bt_field *field, uint64_t index);
108b91d0 81
fb25b9e3
PP
82typedef enum bt_field_dynamic_array_set_length_status {
83 BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
84 BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK = __BT_FUNC_STATUS_OK,
85} bt_field_dynamic_array_set_length_status;
86
87extern bt_field_dynamic_array_set_length_status
88bt_field_dynamic_array_set_length(
89 bt_field *field, uint64_t length);
78cf9df6 90
fb25b9e3
PP
91typedef enum bt_field_variant_select_option_field_status {
92 BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK = __BT_FUNC_STATUS_OK,
93} bt_field_variant_select_option_field_status;
94
95extern bt_field_variant_select_option_field_status
96bt_field_variant_select_option_field(
937c4e48 97 bt_field *field, uint64_t index);
108b91d0 98
8eee8ea2
PP
99extern bt_field *bt_field_variant_borrow_selected_option_field(
100 bt_field *field);
108b91d0
PP
101
102#ifdef __cplusplus
103}
104#endif
105
fb25b9e3
PP
106#include <babeltrace2/undef-func-status.h>
107
108b91d0 108#endif /* BABELTRACE_TRACE_IR_FIELDS_H */
This page took 0.036651 seconds and 4 git commands to generate.