lib, bt2: rename "signed/unsigned sel." -> "integer signed/unsigned sel."
[babeltrace.git] / include / babeltrace2 / trace-ir / field-const.h
CommitLineData
3fd40f46
PP
1#ifndef BABELTRACE2_TRACE_IR_FIELD_CONST_H
2#define BABELTRACE2_TRACE_IR_FIELD_CONST_H
78cf9df6
PP
3
4/*
0dcb770f 5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
78cf9df6
PP
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.
78cf9df6
PP
24 */
25
9df34b44
PP
26#ifndef __BT_IN_BABELTRACE_H
27# error "Please include <babeltrace2/babeltrace.h> instead."
28#endif
29
78cf9df6
PP
30#include <stdint.h>
31
71c5da58 32#include <babeltrace2/trace-ir/field-class.h>
71c5da58 33#include <babeltrace2/types.h>
8eee8ea2 34
78cf9df6
PP
35#ifdef __cplusplus
36extern "C" {
37#endif
38
8eee8ea2
PP
39extern const bt_field_class *bt_field_borrow_class_const(
40 const bt_field *field);
78cf9df6 41
ee78f405 42extern bt_field_class_type bt_field_get_class_type(
8eee8ea2 43 const bt_field *field);
78cf9df6 44
9414b439
PP
45extern bt_bool bt_field_bool_get_value(const bt_field *field);
46
6943da6a
PP
47extern uint64_t bt_field_bit_array_get_value_as_integer(
48 const bt_field *field);
49
60bbfc7c 50extern int64_t bt_field_integer_signed_get_value(const bt_field *field);
78cf9df6 51
60bbfc7c 52extern uint64_t bt_field_integer_unsigned_get_value(
8eee8ea2 53 const bt_field *field);
78cf9df6 54
76276a81
FD
55extern float bt_field_real_single_precision_get_value(const bt_field *field);
56
57extern double bt_field_real_double_precision_get_value(const bt_field *field);
78cf9df6 58
fb25b9e3
PP
59typedef enum bt_field_enumeration_get_mapping_labels_status {
60 BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
61 BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_OK = __BT_FUNC_STATUS_OK,
62} bt_field_enumeration_get_mapping_labels_status;
63
64extern bt_field_enumeration_get_mapping_labels_status
60bbfc7c 65bt_field_enumeration_unsigned_get_mapping_labels(const bt_field *field,
78cf9df6
PP
66 bt_field_class_enumeration_mapping_label_array *label_array,
67 uint64_t *count);
68
fb25b9e3 69extern bt_field_enumeration_get_mapping_labels_status
60bbfc7c 70bt_field_enumeration_signed_get_mapping_labels(const bt_field *field,
78cf9df6
PP
71 bt_field_class_enumeration_mapping_label_array *label_array,
72 uint64_t *count);
73
8eee8ea2 74extern const char *bt_field_string_get_value(const bt_field *field);
78cf9df6 75
8eee8ea2 76extern uint64_t bt_field_string_get_length(const bt_field *field);
78cf9df6 77
8eee8ea2 78extern const bt_field *
78cf9df6 79bt_field_structure_borrow_member_field_by_index_const(
8eee8ea2 80 const bt_field *field, uint64_t index);
78cf9df6 81
8eee8ea2 82extern const bt_field *
78cf9df6 83bt_field_structure_borrow_member_field_by_name_const(
8eee8ea2 84 const bt_field *field, const char *name);
78cf9df6 85
8eee8ea2 86extern uint64_t bt_field_array_get_length(const bt_field *field);
78cf9df6 87
8eee8ea2 88extern const bt_field *
78cf9df6 89bt_field_array_borrow_element_field_by_index_const(
8eee8ea2 90 const bt_field *field, uint64_t index);
78cf9df6 91
247fa9e3
PP
92extern const bt_field *
93bt_field_option_borrow_field_const(const bt_field *field);
94
78cf9df6 95extern uint64_t bt_field_variant_get_selected_option_field_index(
8eee8ea2 96 const bt_field *field);
78cf9df6 97
8eee8ea2 98extern const bt_field *
78cf9df6 99bt_field_variant_borrow_selected_option_field_const(
8eee8ea2 100 const bt_field *field);
78cf9df6 101
02b61fe0
PP
102extern const bt_field_class_variant_option *
103bt_field_variant_borrow_selected_class_option_const(
104 const bt_field *field);
105
0822832b
PP
106extern const bt_field_class_variant_with_selector_integer_unsigned_option *
107bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_const(
02b61fe0
PP
108 const bt_field *field);
109
0822832b
PP
110extern const bt_field_class_variant_with_selector_integer_signed_option *
111bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const(
02b61fe0
PP
112 const bt_field *field);
113
78cf9df6
PP
114#ifdef __cplusplus
115}
116#endif
117
3fd40f46 118#endif /* BABELTRACE2_TRACE_IR_FIELD_CONST_H */
This page took 0.042115 seconds and 4 git commands to generate.