Make API CTF-agnostic
[babeltrace.git] / include / babeltrace / ctf-ir / fields.h
CommitLineData
2e33ac5a
PP
1#ifndef BABELTRACE_CTF_IR_FIELDS_H
2#define BABELTRACE_CTF_IR_FIELDS_H
adc315b8
JG
3
4/*
2e33ac5a 5 * Babeltrace - CTF IR: Event Fields
adc315b8 6 *
de9dd397 7 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
adc315b8
JG
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>
094ff7c0 34
9d408fca 35/* For bt_bool */
c14d64fa 36#include <babeltrace/types.h>
adc315b8 37
44c440bc 38/* For enum bt_field_type_id */
13d80369
PP
39#include <babeltrace/ctf-ir/field-types.h>
40
adc315b8
JG
41#ifdef __cplusplus
42extern "C" {
43#endif
44
50842bdc 45struct bt_field;
50842bdc
PP
46struct bt_field_type;
47struct bt_field_type_enumeration_mapping_iterator;
adc315b8 48
094ff7c0
PP
49extern struct bt_field_type *bt_field_borrow_type(struct bt_field *field);
50
3dca2276 51extern enum bt_field_type_id bt_field_get_type_id(struct bt_field *field);
96e8f959 52
44c440bc 53extern int64_t bt_field_signed_integer_get_value(struct bt_field *field);
91f379cb 54
44c440bc
PP
55extern void bt_field_signed_integer_set_value(struct bt_field *field,
56 int64_t value);
91f379cb 57
44c440bc 58extern uint64_t bt_field_unsigned_integer_get_value(struct bt_field *field);
91f379cb 59
44c440bc
PP
60extern void bt_field_unsigned_integer_set_value(struct bt_field *field,
61 uint64_t value);
91f379cb 62
44c440bc 63extern double bt_field_real_get_value(struct bt_field *field);
91f379cb 64
44c440bc 65extern void bt_field_real_set_value(struct bt_field *field, double value);
91f379cb 66
44c440bc
PP
67extern int bt_field_unsigned_enumeration_get_mapping_labels(
68 struct bt_field *field,
69 bt_field_type_enumeration_mapping_label_array *label_array,
70 uint64_t *count);
91f379cb 71
44c440bc
PP
72extern int bt_field_signed_enumeration_get_mapping_labels(
73 struct bt_field *field,
74 bt_field_type_enumeration_mapping_label_array *label_array,
75 uint64_t *count);
91f379cb 76
44c440bc 77extern const char *bt_field_string_get_value(struct bt_field *field);
91f379cb 78
44c440bc 79extern uint64_t bt_field_string_get_length(struct bt_field *field);
91f379cb 80
44c440bc 81extern int bt_field_string_set_value(struct bt_field *field, const char *value);
91f379cb 82
44c440bc 83extern int bt_field_string_append(struct bt_field *field, const char *value);
91f379cb 84
44c440bc
PP
85extern int bt_field_string_append_with_length(struct bt_field *field,
86 const char *value, uint64_t length);
91f379cb 87
44c440bc 88extern int bt_field_string_clear(struct bt_field *field);
91f379cb 89
44c440bc
PP
90extern struct bt_field *bt_field_structure_borrow_member_field_by_index(
91 struct bt_field *field, uint64_t index);
094ff7c0 92
44c440bc
PP
93extern struct bt_field *bt_field_structure_borrow_member_field_by_name(
94 struct bt_field *field, const char *name);
91f379cb 95
44c440bc 96extern uint64_t bt_field_array_get_length(struct bt_field *field);
91f379cb 97
44c440bc
PP
98extern struct bt_field *bt_field_array_borrow_element_field_by_index(
99 struct bt_field *field, uint64_t index);
91f379cb 100
44c440bc 101extern int bt_field_dynamic_array_set_length(struct bt_field *field,
312c056a 102 uint64_t length);
91f379cb 103
44c440bc
PP
104extern int bt_field_variant_select_option_field(struct bt_field *field,
105 uint64_t index);
094ff7c0 106
44c440bc
PP
107extern uint64_t bt_field_variant_get_selected_option_field_index(
108 struct bt_field *field);
91f379cb 109
44c440bc
PP
110extern struct bt_field *bt_field_variant_borrow_selected_option_field(
111 struct bt_field *field);
a39fe52e 112
adc315b8
JG
113#ifdef __cplusplus
114}
115#endif
116
2e33ac5a 117#endif /* BABELTRACE_CTF_IR_FIELDS_H */
This page took 0.054662 seconds and 4 git commands to generate.