27fd1539858e7956a6af508ea345039f13093526
[babeltrace.git] / include / babeltrace2 / trace-ir / field.h
1 #ifndef BABELTRACE2_TRACE_IR_FIELD_H
2 #define BABELTRACE2_TRACE_IR_FIELD_H
3
4 /*
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
6 *
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.
24 */
25
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
28 #endif
29
30 #include <stdint.h>
31
32 #include <babeltrace2/types.h>
33
34 #ifdef __cplusplus
35 extern "C" {
36 #endif
37
38 extern void bt_field_signed_integer_set_value(bt_field *field,
39 int64_t value);
40
41 extern void bt_field_unsigned_integer_set_value(bt_field *field,
42 uint64_t value);
43
44 extern void bt_field_real_set_value(bt_field *field, double value);
45
46 typedef enum bt_field_string_set_value_status {
47 BT_FIELD_STRING_SET_VALUE_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
48 BT_FIELD_STRING_SET_VALUE_STATUS_OK = __BT_FUNC_STATUS_OK,
49 } bt_field_string_set_value_status;
50
51 extern bt_field_string_set_value_status bt_field_string_set_value(
52 bt_field *field, const char *value);
53
54 typedef enum bt_field_string_append_status {
55 BT_FIELD_STRING_APPEND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
56 BT_FIELD_STRING_APPEND_STATUS_OK = __BT_FUNC_STATUS_OK,
57 } bt_field_string_append_status;
58
59 extern bt_field_string_append_status bt_field_string_append(
60 bt_field *field, const char *value);
61
62 extern bt_field_string_append_status bt_field_string_append_with_length(
63 bt_field *field, const char *value, uint64_t length);
64
65 extern void bt_field_string_clear(bt_field *field);
66
67 extern bt_field *bt_field_structure_borrow_member_field_by_index(
68 bt_field *field, uint64_t index);
69
70 extern bt_field *bt_field_structure_borrow_member_field_by_name(
71 bt_field *field, const char *name);
72
73 extern bt_field *bt_field_array_borrow_element_field_by_index(
74 bt_field *field, uint64_t index);
75
76 typedef enum bt_field_dynamic_array_set_length_status {
77 BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
78 BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK = __BT_FUNC_STATUS_OK,
79 } bt_field_dynamic_array_set_length_status;
80
81 extern bt_field_dynamic_array_set_length_status
82 bt_field_dynamic_array_set_length(
83 bt_field *field, uint64_t length);
84
85 typedef enum bt_field_variant_select_option_field_status {
86 BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK = __BT_FUNC_STATUS_OK,
87 } bt_field_variant_select_option_field_status;
88
89 extern bt_field_variant_select_option_field_status
90 bt_field_variant_select_option_field(
91 bt_field *field, uint64_t index);
92
93 extern bt_field *bt_field_variant_borrow_selected_option_field(
94 bt_field *field);
95
96 #ifdef __cplusplus
97 }
98 #endif
99
100 #endif /* BABELTRACE2_TRACE_IR_FIELD_H */
This page took 0.039623 seconds and 3 git commands to generate.