1 #ifndef BABELTRACE_TRACE_IR_FIELDS_CONST_H
2 #define BABELTRACE_TRACE_IR_FIELDS_CONST_H
5 * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
26 * The Common Trace Format (CTF) Specification is available at
27 * http://www.efficios.com/ctf
32 /* For bt_field_class_type */
33 #include <babeltrace2/trace-ir/field-class.h>
35 /* For bt_field, bt_field_class */
36 #include <babeltrace2/types.h>
38 /* For __BT_FUNC_STATUS_* */
39 #define __BT_FUNC_STATUS_ENABLE
40 #include <babeltrace2/func-status.h>
41 #undef __BT_FUNC_STATUS_ENABLE
47 extern const bt_field_class
*bt_field_borrow_class_const(
48 const bt_field
*field
);
50 extern bt_field_class_type
bt_field_get_class_type(
51 const bt_field
*field
);
53 extern int64_t bt_field_signed_integer_get_value(const bt_field
*field
);
55 extern uint64_t bt_field_unsigned_integer_get_value(
56 const bt_field
*field
);
58 extern double bt_field_real_get_value(const bt_field
*field
);
60 typedef enum bt_field_enumeration_get_mapping_labels_status
{
61 BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_MEMORY_ERROR
= __BT_FUNC_STATUS_MEMORY_ERROR
,
62 BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_OK
= __BT_FUNC_STATUS_OK
,
63 } bt_field_enumeration_get_mapping_labels_status
;
65 extern bt_field_enumeration_get_mapping_labels_status
66 bt_field_unsigned_enumeration_get_mapping_labels(const bt_field
*field
,
67 bt_field_class_enumeration_mapping_label_array
*label_array
,
70 extern bt_field_enumeration_get_mapping_labels_status
71 bt_field_signed_enumeration_get_mapping_labels(const bt_field
*field
,
72 bt_field_class_enumeration_mapping_label_array
*label_array
,
75 extern const char *bt_field_string_get_value(const bt_field
*field
);
77 extern uint64_t bt_field_string_get_length(const bt_field
*field
);
79 extern const bt_field
*
80 bt_field_structure_borrow_member_field_by_index_const(
81 const bt_field
*field
, uint64_t index
);
83 extern const bt_field
*
84 bt_field_structure_borrow_member_field_by_name_const(
85 const bt_field
*field
, const char *name
);
87 extern uint64_t bt_field_array_get_length(const bt_field
*field
);
89 extern const bt_field
*
90 bt_field_array_borrow_element_field_by_index_const(
91 const bt_field
*field
, uint64_t index
);
93 extern uint64_t bt_field_variant_get_selected_option_field_index(
94 const bt_field
*field
);
96 extern const bt_field
*
97 bt_field_variant_borrow_selected_option_field_const(
98 const bt_field
*field
);
104 #include <babeltrace2/undef-func-status.h>
106 #endif /* BABELTRACE_TRACE_IR_FIELDS_CONST_H */