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,
  50 } bt_field_class_type;
  51
  52 typedef enum bt_field_class_integer_preferred_display_base {
  53         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_BINARY,
  54         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_OCTAL,
  55         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_DECIMAL,
  56         BT_FIELD_CLASS_INTEGER_PREFERRED_DISPLAY_BASE_HEXADECIMAL,
  57 } bt_field_class_integer_preferred_display_base;
  58
  59 extern bt_field_class_type bt_field_class_get_type(
  60                 const bt_field_class *field_class);
  61
  62 extern uint64_t bt_field_class_integer_get_field_value_range(
  63                 const bt_field_class *field_class);
  64
  65 extern bt_field_class_integer_preferred_display_base
  66 bt_field_class_integer_get_preferred_display_base(
  67                 const bt_field_class *field_class);
  68
  69 extern bt_bool bt_field_class_real_is_single_precision(
  70                 const bt_field_class *field_class);
  71
  72 extern uint64_t bt_field_class_enumeration_get_mapping_count(
  73                 const bt_field_class *field_class);
  74
  75 extern const bt_field_class_unsigned_enumeration_mapping *
  76 bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
  77                 const bt_field_class *field_class, uint64_t index);
  78
  79 extern const bt_field_class_signed_enumeration_mapping *
  80 bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
  81                 const bt_field_class *field_class, uint64_t index);
  82
  83 static inline
  84 const bt_field_class_enumeration_mapping *
  85 bt_field_class_unsigned_enumeration_mapping_as_mapping_const(
  86                 const bt_field_class_unsigned_enumeration_mapping *mapping)
  87 {
  88         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
  89 }
  90
  91 static inline
  92 const bt_field_class_enumeration_mapping *
  93 bt_field_class_signed_enumeration_mapping_as_mapping_const(
  94                 const bt_field_class_signed_enumeration_mapping *mapping)
  95 {
  96         return __BT_UPCAST_CONST(bt_field_class_enumeration_mapping, mapping);
  97 }
  98
  99 extern const char *bt_field_class_enumeration_mapping_get_label(
 100                 const bt_field_class_enumeration_mapping *mapping);
 101
 102 extern uint64_t bt_field_class_enumeration_mapping_get_range_count(
 103                 const bt_field_class_enumeration_mapping *mapping);
 104
 105 extern void
 106 bt_field_class_unsigned_enumeration_mapping_get_range_by_index(
 107                 const bt_field_class_unsigned_enumeration_mapping *mapping,
 108                 uint64_t index, uint64_t *lower, uint64_t *upper);
 109
 110 extern void
 111 bt_field_class_signed_enumeration_mapping_get_range_by_index(
 112                 const bt_field_class_signed_enumeration_mapping *mapping,
 113                 uint64_t index, int64_t *lower, int64_t *upper);
 114
 115 typedef enum bt_field_class_enumeration_get_mapping_labels_for_value_status {
 116         BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
 117         BT_FIELD_CLASS_ENUMERATION_GET_MAPPING_LABELS_BY_VALUE_STATUS_OK                = __BT_FUNC_STATUS_OK,
 118 } bt_field_class_enumeration_get_mapping_labels_for_value_status;
 119
 120 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
 121 bt_field_class_unsigned_enumeration_get_mapping_labels_for_value(
 122                 const bt_field_class *field_class, uint64_t value,
 123                 bt_field_class_enumeration_mapping_label_array *label_array,
 124                 uint64_t *count);
 125
 126 extern bt_field_class_enumeration_get_mapping_labels_for_value_status
 127 bt_field_class_signed_enumeration_get_mapping_labels_for_value(
 128                 const bt_field_class *field_class, int64_t value,
 129                 bt_field_class_enumeration_mapping_label_array *label_array,
 130                 uint64_t *count);
 131
 132 extern uint64_t bt_field_class_structure_get_member_count(
 133                 const bt_field_class *field_class);
 134
 135 extern const bt_field_class_structure_member *
 136 bt_field_class_structure_borrow_member_by_index_const(
 137                 const bt_field_class *field_class, uint64_t index);
 138
 139 extern const bt_field_class_structure_member *
 140 bt_field_class_structure_borrow_member_by_name_const(
 141                 const bt_field_class *field_class, const char *name);
 142
 143 extern const char *bt_field_class_structure_member_get_name(
 144                 const bt_field_class_structure_member *member);
 145
 146 extern const bt_field_class *
 147 bt_field_class_structure_member_borrow_field_class_const(
 148                 const bt_field_class_structure_member *member);
 149
 150 extern const bt_field_class *
 151 bt_field_class_array_borrow_element_field_class_const(
 152                 const bt_field_class *field_class);
 153
 154 extern uint64_t bt_field_class_static_array_get_length(
 155                 const bt_field_class *field_class);
 156
 157 extern const bt_field_path *
 158 bt_field_class_dynamic_array_borrow_length_field_path_const(
 159                 const bt_field_class *field_class);
 160
 161 extern const bt_field_path *
 162 bt_field_class_variant_borrow_selector_field_path_const(
 163                 const bt_field_class *field_class);
 164
 165 extern uint64_t bt_field_class_variant_get_option_count(
 166                 const bt_field_class *field_class);
 167
 168 extern const bt_field_class_variant_option *
 169 bt_field_class_variant_borrow_option_by_index_const(
 170                 const bt_field_class *field_class, uint64_t index);
 171
 172 extern const bt_field_class_variant_option *
 173 bt_field_class_variant_borrow_option_by_name_const(
 174                 const bt_field_class *field_class, const char *name);
 175
 176 extern const char *bt_field_class_variant_option_get_name(
 177                 const bt_field_class_variant_option *option);
 178
 179 extern const bt_field_class *
 180 bt_field_class_variant_option_borrow_field_class_const(
 181                 const bt_field_class_variant_option *option);
 182
 183 extern void bt_field_class_get_ref(const bt_field_class *field_class);
 184
 185 extern void bt_field_class_put_ref(const bt_field_class *field_class);
 186
 187 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var)          \
 188         do {                                            \
 189                 bt_field_class_put_ref(_var);           \
 190                 (_var) = NULL;                          \
 191         } while (0)
 192
 193 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src)     \
 194         do {                                            \
 195                 bt_field_class_put_ref(_var_dst);       \
 196                 (_var_dst) = (_var_src);                \
 197                 (_var_src) = NULL;                      \
 198         } while (0)
 199
 200
 201 #ifdef __cplusplus
 202 }
 203 #endif
 204
 205 #endif /* BABELTRACE2_TRACE_IR_FIELD_CLASS_CONST_H */