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_UNSIGNED_INTEGER,
  41         BT_FIELD_CLASS_TYPE_SIGNED_INTEGER,
  42         BT_FIELD_CLASS_TYPE_UNSIGNED_ENUMERATION,
  43         BT_FIELD_CLASS_TYPE_SIGNED_ENUMERATION,
  44         BT_FIELD_CLASS_TYPE_REAL,
  45         BT_FIELD_CLASS_TYPE_STRING,
  46         BT_FIELD_CLASS_TYPE_STRUCTURE,
  47         BT_FIELD_CLASS_TYPE_STATIC_ARRAY,
  48         BT_FIELD_CLASS_TYPE_DYNAMIC_ARRAY,
  49         BT_FIELD_CLASS_TYPE_VARIANT_WITHOUT_SELECTOR,
  50         BT_FIELD_CLASS_TYPE_VARIANT_WITH_UNSIGNED_SELECTOR,
  51         BT_FIELD_CLASS_TYPE_VARIANT_WITH_SIGNED_SELECTOR,
  52 } bt_field_class_type;
  53
  54 typedef enum bt_field_class_integer_preferred_display_base {
  55         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
  56         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
  57         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
  58         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
  59 } bt_field_class_integer_preferred_display_base;
  60
  61 extern bt_field_class_type bt_field_class_get_type(
  62                 const bt_field_class *field_class);
  63
  64 extern uint64_t bt_field_class_integer_get_field_value_range(
  65                 const bt_field_class *field_class);
  66
  67 extern bt_field_class_integer_preferred_display_base
  68 bt_field_class_integer_get_preferred_display_base(
  69                 const bt_field_class *field_class);
  70
  71 extern bt_bool bt_field_class_real_is_single_precision(
  72                 const bt_field_class *field_class);
  73
  74 extern uint64_t bt_field_class_enumeration_get_mapping_count(
  75                 const bt_field_class *field_class);
  76
  77 extern const bt_field_class_unsigned_enumeration_mapping *
  78 bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
  79                 const bt_field_class *field_class, uint64_t index);
  80
  81 extern const bt_field_class_unsigned_enumeration_mapping *
  82 bt_field_class_unsigned_enumeration_borrow_mapping_by_label_const(
  83                 const bt_field_class *field_class, const char *label);
  84
  85 extern const bt_field_class_signed_enumeration_mapping *
  86 bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
  87                 const bt_field_class *field_class, uint64_t index);
  88
  89 extern const bt_field_class_signed_enumeration_mapping *
  90 bt_field_class_signed_enumeration_borrow_mapping_by_label_const(
  91                 const bt_field_class *field_class, const char *label);
  92
  93 static inline
  94 const bt_field_class_enumeration_mapping *
  95 bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
  96                 const bt_field_class_unsigned_enumeration_mapping *mapping)
  97 {
  98         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
  99 }
 100
 101 static inline
 102 const bt_field_class_enumeration_mapping *
 103 bt_field_class_signed_enumeration_mapping_as_mapping_const(
 104                 const bt_field_class_signed_enumeration_mapping *mapping)
 105 {
 106         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
 107 }
 108
 109 extern const char *bt_field_class_enumeration_mapping_get_label(
 110                 const bt_field_class_enumeration_mapping *mapping);
 111
 112 extern const bt_integer_range_set_unsigned *
 113 bt_field_class_unsigned_enumeration_mapping_borrow_ranges_const(
 114                 const bt_field_class_unsigned_enumeration_mapping *mapping);
 115
 116 extern const bt_integer_range_set_signed *
 117 bt_field_class_signed_enumeration_mapping_borrow_ranges_const(
 118                 const bt_field_class_signed_enumeration_mapping *mapping);
 119
 120 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
 121         BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
 122         BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK                = __BT_FUNC_STATUS_OK,
 123 } bt_field_class_enumeration_get_mapping_labels_for_value_status;
 124
 125 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
 126 bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
 127                 const bt_field_class *field_class, uint64_t value,
 128                 bt_field_class_enumeration_mapping_label_array *label_array,
 129                 uint64_t *count);
 130
 131 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
 132 bt_field_class_signed_enumeration_get_mapping_labels_for_value(
 133                 const bt_field_class *field_class, int64_t value,
 134                 bt_field_class_enumeration_mapping_label_array *label_array,
 135                 uint64_t *count);
 136
 137 extern uint64_t bt_field_class_structure_get_member_count(
 138                 const bt_field_class *field_class);
 139
 140 extern const bt_field_class_structure_member *
 141 bt_field_class_structure_borrow_member_by_index_const(
 142                 const bt_field_class *field_class, uint64_t index);
 143
 144 extern const bt_field_class_structure_member *
 145 bt_field_class_structure_borrow_member_by_name_const(
 146                 const bt_field_class *field_class, const char *name);
 147
 148 extern const char *bt_field_class_structure_member_get_name(
 149                 const bt_field_class_structure_member *member);
 150
 151 extern const bt_field_class *
 152 bt_field_class_structure_member_borrow_field_class_const(
 153                 const bt_field_class_structure_member *member);
 154
 155 extern const bt_field_class *
 156 bt_field_class_array_borrow_element_field_class_const(
 157                 const bt_field_class *field_class);
 158
 159 extern uint64_t bt_field_class_static_array_get_length(
 160                 const bt_field_class *field_class);
 161
 162 extern const bt_field_path *
 163 bt_field_class_dynamic_array_borrow_length_field_path_const(
 164                 const bt_field_class *field_class);
 165
 166 extern uint64_t bt_field_class_variant_get_option_count(
 167                 const bt_field_class *field_class);
 168
 169 extern const bt_field_class_variant_option *
 170 bt_field_class_variant_borrow_option_by_index_const(
 171                 const bt_field_class *field_class, uint64_t index);
 172
 173 extern const bt_field_class_variant_option *
 174 bt_field_class_variant_borrow_option_by_name_const(
 175                 const bt_field_class *field_class, const char *name);
 176
 177 extern const bt_field_class_variant_with_unsigned_selector_option *
 178 bt_field_class_variant_with_unsigned_selector_borrow_option_by_index_const(
 179                 const bt_field_class *field_class, uint64_t index);
 180
 181 extern const bt_field_class_variant_with_unsigned_selector_option *
 182 bt_field_class_variant_with_unsigned_selector_borrow_option_by_name_const(
 183                 const bt_field_class *field_class, const char *name);
 184
 185 extern const bt_field_class_variant_with_signed_selector_option *
 186 bt_field_class_variant_with_signed_selector_borrow_option_by_index_const(
 187                 const bt_field_class *field_class, uint64_t index);
 188
 189 extern const bt_field_class_variant_with_signed_selector_option *
 190 bt_field_class_variant_with_signed_selector_borrow_option_by_name_const(
 191                 const bt_field_class *field_class, const char *name);
 192
 193 extern const char *bt_field_class_variant_option_get_name(
 194                 const bt_field_class_variant_option *option);
 195
 196 extern const bt_field_class *
 197 bt_field_class_variant_option_borrow_field_class_const(
 198                 const bt_field_class_variant_option *option);
 199
 200 extern const bt_field_path *
 201 bt_field_class_variant_with_selector_borrow_selector_field_path_const(
 202                 const bt_field_class *field_class);
 203
 204 extern const bt_integer_range_set_unsigned *
 205 bt_field_class_variant_with_unsigned_selector_option_borrow_ranges_const(
 206                 const bt_field_class_variant_with_unsigned_selector_option *option);
 207
 208 static inline
 209 const bt_field_class_variant_option *
 210 bt_field_class_variant_with_unsigned_selector_option_as_option_const(
 211                 const bt_field_class_variant_with_unsigned_selector_option *option)
 212 {
 213         return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
 214 }
 215
 216 extern const bt_integer_range_set_signed *
 217 bt_field_class_variant_with_signed_selector_option_borrow_ranges_const(
 218                 const bt_field_class_variant_with_signed_selector_option *option);
 219
 220 static inline
 221 const bt_field_class_variant_option *
 222 bt_field_class_variant_with_signed_selector_option_as_option_const(
 223                 const bt_field_class_variant_with_signed_selector_option *option)
 224 {
 225         return __BT_UPCAST_CONST(bt_field_class_variant_option, option);
 226 }
 227
 228 extern void bt_field_class_get_ref(const bt_field_class *field_class);
 229
 230 extern void bt_field_class_put_ref(const bt_field_class *field_class);
 231
 232 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var)          \
 233         do {                                            \
 234                 bt_field_class_put_ref(_var);           \
 235                 (_var) = NULL;                          \
 236         } while (0)
 237
 238 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src)     \
 239         do {                                            \
 240                 bt_field_class_put_ref(_var_dst);       \
 241                 (_var_dst) = (_var_src);                \
 242                 (_var_src) = NULL;                      \
 243         } while (0)
 244
 245
 246 #ifdef __cplusplus
 247 }
 248 #endif
 249
 250 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */