include/babeltrace2/trace-ir/field-class-const.h

   1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
   2 #define BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H
   3
   4 /*
   5  * Copyright 2017-2018 Philippe Proulx <pproulx@efficios.com>
   6  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   7  *
   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:
  14  *
  15  * The above copyright notice and this permission notice shall be included in
  16  * all copies or substantial portions of the Software.
  17  *
  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
  24  * SOFTWARE.
  25  *
  26  * The Common Trace Format (CTF) Specification is available at
  27  * http://www.efficios.com/ctf
  28  */
  29
  30 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 /*
  35  * For bt_bool, bt_field_class, bt_field_path,
  36  * bt_field_class_enumeration_mapping,
  37  * bt_field_class_unsigned_enumeration_mapping,
  38  * bt_field_class_signed_enumeration_mapping,
  39  * bt_field_class_enumeration_mapping_label_array, __BT_UPCAST_CONST
  40  */
  41 #include <babeltrace2/types.h>
  42
  43 #include <stdint.h>
  44 #include <stddef.h>
  45
  46 #ifdef __cplusplus
  47 extern "C" {
  48 #endif
  49
  50 typedef enum bt_field_class_type {
  51         BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
  52         BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
  53         BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
  54         BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
  55         BT_FIELD_CLASS_TYPE_REAL,
  56         BT_FIELD_CLASS_TYPE_STRING,
  57         BT_FIELD_CLASS_TYPE_STRUCTURE,
  58         BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
  59         BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
  60         BT_FIELD_CLASS_TYPE_VARIANT,
  61 } bt_field_class_type;
  62
  63 typedef enum bt_field_class_integer_preferred_display_base {
  64         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
  65         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
  66         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
  67         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
  68 } bt_field_class_integer_preferred_display_base;
  69
  70 extern bt_field_class_type bt_field_class_get_type(
  71                 const bt_field_class *field_class);
  72
  73 extern uint64_t bt_field_class_integer_get_field_value_range(
  74                 const bt_field_class *field_class);
  75
  76 extern bt_field_class_integer_preferred_display_base
  77 bt_field_class_integer_get_preferred_display_base(
  78                 const bt_field_class *field_class);
  79
  80 extern bt_bool bt_field_class_real_is_single_precision(
  81                 const bt_field_class *field_class);
  82
  83 extern uint64_t bt_field_class_enumeration_get_mapping_count(
  84                 const bt_field_class *field_class);
  85
  86 extern const bt_field_class_unsigned_enumeration_mapping *
  87 bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
  88                 const bt_field_class *field_class, uint64_t index);
  89
  90 extern const bt_field_class_signed_enumeration_mapping *
  91 bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
  92                 const bt_field_class *field_class, uint64_t index);
  93
  94 static inline
  95 const bt_field_class_enumeration_mapping *
  96 bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
  97                 const bt_field_class_unsigned_enumeration_mapping *mapping)
  98 {
  99         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
 100 }
 101
 102 static inline
 103 const bt_field_class_enumeration_mapping *
 104 bt_field_class_signed_enumeration_mapping_as_mapping_const(
 105                 const bt_field_class_signed_enumeration_mapping *mapping)
 106 {
 107         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
 108 }
 109
 110 extern const char *bt_field_class_enumeration_mapping_get_label(
 111                 const bt_field_class_enumeration_mapping *mapping);
 112
 113 extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
 114                 const bt_field_class_enumeration_mapping *mapping);
 115
 116 extern void
 117 bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
 118                 const bt_field_class_unsigned_enumeration_mapping *mapping,
 119                 uint64_t index, uint64_t *lower, uint64_t *upper);
 120
 121 extern void
 122 bt_field_class_signed_enumeration_mapping_get_range_by_index(
 123                 const bt_field_class_signed_enumeration_mapping *mapping,
 124                 uint64_t index, int64_t *lower, int64_t *upper);
 125
 126 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
 127         BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
 128         BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK                = __BT_FUNC_STATUS_OK,
 129 } bt_field_class_enumeration_get_mapping_labels_for_value_status;
 130
 131 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
 132 bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
 133                 const bt_field_class *field_class, uint64_t value,
 134                 bt_field_class_enumeration_mapping_label_array *label_array,
 135                 uint64_t *count);
 136
 137 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
 138 bt_field_class_signed_enumeration_get_mapping_labels_for_value(
 139                 const bt_field_class *field_class, int64_t value,
 140                 bt_field_class_enumeration_mapping_label_array *label_array,
 141                 uint64_t *count);
 142
 143 extern uint64_t bt_field_class_structure_get_member_count(
 144                 const bt_field_class *field_class);
 145
 146 extern const bt_field_class_structure_member *
 147 bt_field_class_structure_borrow_member_by_index_const(
 148                 const bt_field_class *field_class, uint64_t index);
 149
 150 extern const bt_field_class_structure_member *
 151 bt_field_class_structure_borrow_member_by_name_const(
 152                 const bt_field_class *field_class, const char *name);
 153
 154 extern const char *bt_field_class_structure_member_get_name(
 155                 const bt_field_class_structure_member *member);
 156
 157 extern const bt_field_class *
 158 bt_field_class_structure_member_borrow_field_class_const(
 159                 const bt_field_class_structure_member *member);
 160
 161 extern const bt_field_class *
 162 bt_field_class_array_borrow_element_field_class_const(
 163                 const bt_field_class *field_class);
 164
 165 extern uint64_t bt_field_class_static_array_get_length(
 166                 const bt_field_class *field_class);
 167
 168 extern const bt_field_path *
 169 bt_field_class_dynamic_array_borrow_length_field_path_const(
 170                 const bt_field_class *field_class);
 171
 172 extern const bt_field_path *
 173 bt_field_class_variant_borrow_selector_field_path_const(
 174                 const bt_field_class *field_class);
 175
 176 extern uint64_t bt_field_class_variant_get_option_count(
 177                 const bt_field_class *field_class);
 178
 179 extern const bt_field_class_variant_option *
 180 bt_field_class_variant_borrow_option_by_index_const(
 181                 const bt_field_class *field_class, uint64_t index);
 182
 183 extern const bt_field_class_variant_option *
 184 bt_field_class_variant_borrow_option_by_name_const(
 185                 const bt_field_class *field_class, const char *name);
 186
 187 extern const char *bt_field_class_variant_option_get_name(
 188                 const bt_field_class_variant_option *option);
 189
 190 extern const bt_field_class *
 191 bt_field_class_variant_option_borrow_field_class_const(
 192                 const bt_field_class_variant_option *option);
 193
 194 extern void bt_field_class_get_ref(const bt_field_class *field_class);
 195
 196 extern void bt_field_class_put_ref(const bt_field_class *field_class);
 197
 198 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var)          \
 199         do {                                            \
 200                 bt_field_class_put_ref(_var);           \
 201                 (_var) = NULL;                          \
 202         } while (0)
 203
 204 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src)     \
 205         do {                                            \
 206                 bt_field_class_put_ref(_var_dst);       \
 207                 (_var_dst) = (_var_src);                \
 208                 (_var_src) = NULL;                      \
 209         } while (0)
 210
 211
 212 #ifdef __cplusplus
 213 }
 214 #endif
 215
 216 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */