Trace IR and notification APIs: split into private and public APIs
[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/*
56e18c4c
PP
5 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 *
7 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 *
9 * Permission is hereby granted, free of charge, to any person obtaining a copy
10 * of this software and associated documentation files (the "Software"), to deal
11 * in the Software without restriction, including without limitation the rights
12 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
13 * copies of the Software, and to permit persons to whom the Software is
14 * furnished to do so, subject to the following conditions:
15 *
16 * The above copyright notice and this permission notice shall be included in
17 * all copies or substantial portions of the Software.
18 *
19 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
20 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
21 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
22 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
23 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
24 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
25 * SOFTWARE.
26 *
27 * The Common Trace Format (CTF) Specification is available at
28 * http://www.efficios.com/ctf
29 */
30
31#include <stdint.h>
32
864cad70 33/* For enum bt_field_class_type */
5cd6d0e5 34#include <babeltrace/trace-ir/field-classes.h>
56e18c4c
PP
35
36#ifdef __cplusplus
37extern "C" {
38#endif
39
40struct bt_field;
5cd6d0e5 41struct bt_field_class;
56e18c4c 42
5cd6d0e5 43extern struct bt_field_class *bt_field_borrow_class(struct bt_field *field);
56e18c4c 44
864cad70 45extern enum bt_field_class_type bt_field_get_class_type(struct bt_field *field);
56e18c4c
PP
46
47extern int64_t bt_field_signed_integer_get_value(struct bt_field *field);
48
56e18c4c
PP
49extern uint64_t bt_field_unsigned_integer_get_value(struct bt_field *field);
50
56e18c4c
PP
51extern double bt_field_real_get_value(struct bt_field *field);
52
56e18c4c
PP
53extern int bt_field_unsigned_enumeration_get_mapping_labels(
54 struct bt_field *field,
5cd6d0e5 55 bt_field_class_enumeration_mapping_label_array *label_array,
56e18c4c
PP
56 uint64_t *count);
57
58extern int bt_field_signed_enumeration_get_mapping_labels(
59 struct bt_field *field,
5cd6d0e5 60 bt_field_class_enumeration_mapping_label_array *label_array,
56e18c4c
PP
61 uint64_t *count);
62
63extern const char *bt_field_string_get_value(struct bt_field *field);
64
65extern uint64_t bt_field_string_get_length(struct bt_field *field);
66
56e18c4c
PP
67extern struct bt_field *bt_field_structure_borrow_member_field_by_index(
68 struct bt_field *field, uint64_t index);
69
70extern struct bt_field *bt_field_structure_borrow_member_field_by_name(
71 struct bt_field *field, const char *name);
72
73extern uint64_t bt_field_array_get_length(struct bt_field *field);
74
75extern struct bt_field *bt_field_array_borrow_element_field_by_index(
76 struct bt_field *field, uint64_t index);
77
56e18c4c
PP
78extern uint64_t bt_field_variant_get_selected_option_field_index(
79 struct bt_field *field);
80
81extern struct bt_field *bt_field_variant_borrow_selected_option_field(
82 struct bt_field *field);
83
84#ifdef __cplusplus
85}
86#endif
87
88#endif /* BABELTRACE_TRACE_IR_FIELDS_H */
This page took 0.026528 seconds and 4 git commands to generate.