Rename: field type -> field class
[babeltrace.git] / include / babeltrace / trace-ir / fields.h
CommitLineData
56e18c4c
PP
1#ifndef BABELTRACE_TRACE_IR_FIELDS_H
2#define BABELTRACE_TRACE_IR_FIELDS_H
3
4/*
5 * Babeltrace - Trace IR: Event Fields
6 *
7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
10 *
11 * Permission is hereby granted, free of charge, to any person obtaining a copy
12 * of this software and associated documentation files (the "Software"), to deal
13 * in the Software without restriction, including without limitation the rights
14 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
15 * copies of the Software, and to permit persons to whom the Software is
16 * furnished to do so, subject to the following conditions:
17 *
18 * The above copyright notice and this permission notice shall be included in
19 * all copies or substantial portions of the Software.
20 *
21 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
22 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
23 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
24 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
25 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
26 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 * SOFTWARE.
28 *
29 * The Common Trace Format (CTF) Specification is available at
30 * http://www.efficios.com/ctf
31 */
32
33#include <stdint.h>
34
35/* For bt_bool */
36#include <babeltrace/types.h>
37
5cd6d0e5
PP
38/* For enum bt_field_class_id */
39#include <babeltrace/trace-ir/field-classes.h>
56e18c4c
PP
40
41#ifdef __cplusplus
42extern "C" {
43#endif
44
45struct bt_field;
5cd6d0e5
PP
46struct bt_field_class;
47struct bt_field_class_enumeration_mapping_iterator;
56e18c4c 48
5cd6d0e5 49extern struct bt_field_class *bt_field_borrow_class(struct bt_field *field);
56e18c4c 50
5cd6d0e5 51extern enum bt_field_class_id bt_field_get_class_id(struct bt_field *field);
56e18c4c
PP
52
53extern int64_t bt_field_signed_integer_get_value(struct bt_field *field);
54
55extern void bt_field_signed_integer_set_value(struct bt_field *field,
56 int64_t value);
57
58extern uint64_t bt_field_unsigned_integer_get_value(struct bt_field *field);
59
60extern void bt_field_unsigned_integer_set_value(struct bt_field *field,
61 uint64_t value);
62
63extern double bt_field_real_get_value(struct bt_field *field);
64
65extern void bt_field_real_set_value(struct bt_field *field, double value);
66
67extern int bt_field_unsigned_enumeration_get_mapping_labels(
68 struct bt_field *field,
5cd6d0e5 69 bt_field_class_enumeration_mapping_label_array *label_array,
56e18c4c
PP
70 uint64_t *count);
71
72extern int bt_field_signed_enumeration_get_mapping_labels(
73 struct bt_field *field,
5cd6d0e5 74 bt_field_class_enumeration_mapping_label_array *label_array,
56e18c4c
PP
75 uint64_t *count);
76
77extern const char *bt_field_string_get_value(struct bt_field *field);
78
79extern uint64_t bt_field_string_get_length(struct bt_field *field);
80
81extern int bt_field_string_set_value(struct bt_field *field, const char *value);
82
83extern int bt_field_string_append(struct bt_field *field, const char *value);
84
85extern int bt_field_string_append_with_length(struct bt_field *field,
86 const char *value, uint64_t length);
87
88extern int bt_field_string_clear(struct bt_field *field);
89
90extern struct bt_field *bt_field_structure_borrow_member_field_by_index(
91 struct bt_field *field, uint64_t index);
92
93extern struct bt_field *bt_field_structure_borrow_member_field_by_name(
94 struct bt_field *field, const char *name);
95
96extern uint64_t bt_field_array_get_length(struct bt_field *field);
97
98extern struct bt_field *bt_field_array_borrow_element_field_by_index(
99 struct bt_field *field, uint64_t index);
100
101extern int bt_field_dynamic_array_set_length(struct bt_field *field,
102 uint64_t length);
103
104extern int bt_field_variant_select_option_field(struct bt_field *field,
105 uint64_t index);
106
107extern uint64_t bt_field_variant_get_selected_option_field_index(
108 struct bt_field *field);
109
110extern struct bt_field *bt_field_variant_borrow_selected_option_field(
111 struct bt_field *field);
112
113#ifdef __cplusplus
114}
115#endif
116
117#endif /* BABELTRACE_TRACE_IR_FIELDS_H */
This page took 0.02747 seconds and 4 git commands to generate.