1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CONST_H
2 #define BABELTRACE2_TRACE_IR_FIELD_CONST_H
5 * Copyright (c) 2010-2019 EfficiOS Inc. and Linux Foundation
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:
14 * The above copyright notice and this permission notice shall be included in
15 * all copies or substantial portions of the Software.
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
26 #ifndef __BT_IN_BABELTRACE_H
27 # error "Please include <babeltrace2/babeltrace.h> instead."
32 #include <babeltrace2/trace-ir/field-class.h>
33 #include <babeltrace2/types.h>
39 extern const bt_field_class
*bt_field_borrow_class_const(
40 const bt_field
*field
);
42 extern bt_field_class_type
bt_field_get_class_type(
43 const bt_field
*field
);
45 extern bt_bool
bt_field_bool_get_value(const bt_field
*field
);
47 extern uint64_t bt_field_bit_array_get_value_as_integer(
48 const bt_field
*field
);
50 extern int64_t bt_field_integer_signed_get_value(const bt_field
*field
);
52 extern uint64_t bt_field_integer_unsigned_get_value(
53 const bt_field
*field
);
55 extern float bt_field_real_single_precision_get_value(const bt_field
*field
);
57 extern double bt_field_real_double_precision_get_value(const bt_field
*field
);
59 typedef 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
;
64 extern bt_field_enumeration_get_mapping_labels_status
65 bt_field_enumeration_unsigned_get_mapping_labels(const bt_field
*field
,
66 bt_field_class_enumeration_mapping_label_array
*label_array
,
69 extern bt_field_enumeration_get_mapping_labels_status
70 bt_field_enumeration_signed_get_mapping_labels(const bt_field
*field
,
71 bt_field_class_enumeration_mapping_label_array
*label_array
,
74 extern const char *bt_field_string_get_value(const bt_field
*field
);
76 extern uint64_t bt_field_string_get_length(const bt_field
*field
);
78 extern const bt_field
*
79 bt_field_structure_borrow_member_field_by_index_const(
80 const bt_field
*field
, uint64_t index
);
82 extern const bt_field
*
83 bt_field_structure_borrow_member_field_by_name_const(
84 const bt_field
*field
, const char *name
);
86 extern uint64_t bt_field_array_get_length(const bt_field
*field
);
88 extern const bt_field
*
89 bt_field_array_borrow_element_field_by_index_const(
90 const bt_field
*field
, uint64_t index
);
92 extern const bt_field
*
93 bt_field_option_borrow_field_const(const bt_field
*field
);
95 extern uint64_t bt_field_variant_get_selected_option_field_index(
96 const bt_field
*field
);
98 extern const bt_field
*
99 bt_field_variant_borrow_selected_option_field_const(
100 const bt_field
*field
);
102 extern const bt_field_class_variant_option
*
103 bt_field_variant_borrow_selected_class_option_const(
104 const bt_field
*field
);
106 extern const bt_field_class_variant_with_selector_integer_unsigned_option
*
107 bt_field_variant_with_unsigned_integer_selector_borrow_selected_class_option_const(
108 const bt_field
*field
);
110 extern const bt_field_class_variant_with_selector_integer_signed_option
*
111 bt_field_variant_with_signed_integer_selector_borrow_selected_class_option_const(
112 const bt_field
*field
);
118 #endif /* BABELTRACE2_TRACE_IR_FIELD_CONST_H */