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 (c) 2010-2019 EfficiOS Inc. and Linux Foundation
   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.
  24  */
  25
  26 #ifndef __BT_IN_BABELTRACE_H
  27 # error "Please include <babeltrace2/babeltrace.h> instead."
  28 #endif
  29
  30 #include <stdint.h>
  31 #include <stddef.h>
  32
  33 #include <babeltrace2/types.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 typedef enum bt_field_class_type {
  40         BT_FIELD_CLASS_TYPE_BOOL,
  41         BT_FIELD_CLASS_TYPE_BIT_ARRAY,
  42         BT_FIELD_CLASS_TYPE_UNSIGNED_INTEGER,
  43         BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
  44         BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
  45         BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
  46         BT_FIELD_CLASS_TYPE_REAL,
  47         BT_FIELD_CLASS_TYPE_STRING,
  48         BT_FIELD_CLASS_TYPE_STRUCTURE,
  49         BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
  50         BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
  51         BT_FIELD_CLASS_TYPE_OPTION,
  52         BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR,
  53         BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR,
  54         BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR,
  55 } bt_field_class_type;
  56
  57 typedef enum bt_field_class_integer_preferred_display_base {
  58         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
  59         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
  60         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
  61         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
  62 } bt_field_class_integer_preferred_display_base;
  63
  64 extern bt_field_class_type bt_field_class_get_type(
  65                 const bt_field_class *field_class);
  66
  67 extern uint64_t bt_field_class_bit_array_get_length(
  68                 const bt_field_class *field_class);
  69
  70 extern uint64_t bt_field_class_integer_get_field_value_range(
  71                 const bt_field_class *field_class);
  72
  73 extern bt_field_class_integer_preferred_display_base
  74 bt_field_class_integer_get_preferred_display_base(
  75                 const bt_field_class *field_class);
  76
  77 extern bt_bool bt_field_class_real_is_single_precision(
  78                 const bt_field_class *field_class);
  79
  80 extern uint64_t bt_field_class_enumeration_get_mapping_count(
  81                 const bt_field_class *field_class);
  82
  83 extern const bt_field_class_enumeration_unsigned_mapping *
  84 bt_field_class_enumeration_unsigned_borrow_mapping_by_index_const(
  85                 const bt_field_class *field_class, uint64_t index);
  86
  87 extern const bt_field_class_enumeration_unsigned_mapping *
  88 bt_field_class_enumeration_unsigned_borrow_mapping_by_label_const(
  89                 const bt_field_class *field_class, const char *label);
  90
  91 extern const bt_field_class_enumeration_signed_mapping *
  92 bt_field_class_enumeration_signed_borrow_mapping_by_index_const(
  93                 const bt_field_class *field_class, uint64_t index);
  94
  95 extern const bt_field_class_enumeration_signed_mapping *
  96 bt_field_class_enumeration_signed_borrow_mapping_by_label_const(
  97                 const bt_field_class *field_class, const char *label);
  98
  99 static inline
 100 const bt_field_class_enumeration_mapping *
 101 bt_field_class_enumeration_unsigned_mapping_as_mapping_const(
 102                 const bt_field_class_enumeration_unsigned_mapping *mapping)
 103 {
 104         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
 105 }
 106
 107 static inline
 108 const bt_field_class_enumeration_mapping *
 109 bt_field_class_enumeration_signed_mapping_as_mapping_const(
 110                 const bt_field_class_enumeration_signed_mapping *mapping)
 111 {
 112         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
 113 }
 114
 115 extern const char *bt_field_class_enumeration_mapping_get_label(
 116                 const bt_field_class_enumeration_mapping *mapping);
 117
 118 extern const bt_integer_range_set_unsigned *
 119 bt_field_class_enumeration_unsigned_mapping_borrow_ranges_const(
 120                 const bt_field_class_enumeration_unsigned_mapping *mapping);
 121
 122 extern const bt_integer_range_set_signed *
 123 bt_field_class_enumeration_signed_mapping_borrow_ranges_const(
 124                 const bt_field_class_enumeration_signed_mapping *mapping);
 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_enumeration_unsigned_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_enumeration_signed_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_array_static_get_length(
 166                 const bt_field_class *field_class);
 167
 168 extern const bt_field_path *
 169 bt_field_class_array_dynamic_borrow_length_field_path_const(
 170                 const bt_field_class *field_class);
 171
 172 extern const bt_field_class *
 173 bt_field_class_option_borrow_field_class_const(
 174                 const bt_field_class *field_class);
 175
 176 extern const bt_field_path *
 177 bt_field_class_option_borrow_selector_field_path_const(
 178                 const bt_field_class *field_class);
 179
 180 extern uint64_t bt_field_class_variant_get_option_count(
 181                 const bt_field_class *field_class);
 182
 183 extern const bt_field_class_variant_option *
 184 bt_field_class_variant_borrow_option_by_index_const(
 185                 const bt_field_class *field_class, uint64_t index);
 186
 187 extern const bt_field_class_variant_option *
 188 bt_field_class_variant_borrow_option_by_name_const(
 189                 const bt_field_class *field_class, const char *name);
 190
 191 extern const bt_field_class_variant_with_selector_unsigned_option *
 192 bt_field_class_variant_with_selector_unsigned_borrow_option_by_index_const(
 193                 const bt_field_class *field_class, uint64_t index);
 194
 195 extern const bt_field_class_variant_with_selector_unsigned_option *
 196 bt_field_class_variant_with_selector_unsigned_borrow_option_by_name_const(
 197                 const bt_field_class *field_class, const char *name);
 198
 199 extern const bt_field_class_variant_with_selector_signed_option *
 200 bt_field_class_variant_with_selector_signed_borrow_option_by_index_const(
 201                 const bt_field_class *field_class, uint64_t index);
 202
 203 extern const bt_field_class_variant_with_selector_signed_option *
 204 bt_field_class_variant_with_selector_signed_borrow_option_by_name_const(
 205                 const bt_field_class *field_class, const char *name);
 206
 207 extern const char *bt_field_class_variant_option_get_name(
 208                 const bt_field_class_variant_option *option);
 209
 210 extern const bt_field_class *
 211 bt_field_class_variant_option_borrow_field_class_const(
 212                 const bt_field_class_variant_option *option);
 213
 214 extern const bt_field_path *
 215 bt_field_class_variant_with_selector_borrow_selector_field_path_const(
 216                 const bt_field_class *field_class);
 217
 218 extern const bt_integer_range_set_unsigned *
 219 bt_field_class_variant_with_selector_unsigned_option_borrow_ranges_const(
 220                 const bt_field_class_variant_with_selector_unsigned_option *option);
 221
 222 static inline
 223 const bt_field_class_variant_option *
 224 bt_field_class_variant_with_selector_unsigned_option_as_option_const(
 225                 const bt_field_class_variant_with_selector_unsigned_option *option)
 226 {
 227         return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
 228 }
 229
 230 extern const bt_integer_range_set_signed *
 231 bt_field_class_variant_with_selector_signed_option_borrow_ranges_const(
 232                 const bt_field_class_variant_with_selector_signed_option *option);
 233
 234 static inline
 235 const bt_field_class_variant_option *
 236 bt_field_class_variant_with_selector_signed_option_as_option_const(
 237                 const bt_field_class_variant_with_selector_signed_option *option)
 238 {
 239         return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
 240 }
 241
 242 extern void bt_field_class_get_ref(const bt_field_class *field_class);
 243
 244 extern void bt_field_class_put_ref(const bt_field_class *field_class);
 245
 246 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var)          \
 247         do {                                            \
 248                 bt_field_class_put_ref(_var);           \
 249                 (_var) = NULL;                          \
 250         } while (0)
 251
 252 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src)     \
 253         do {                                            \
 254                 bt_field_class_put_ref(_var_dst);       \
 255                 (_var_dst) = (_var_src);                \
 256                 (_var_src) = NULL;                      \
 257         } while (0)
 258
 259
 260 #ifdef __cplusplus
 261 }
 262 #endif
 263
 264 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */