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

   1 #ifndef BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H
   2 #define BABELTRACE_TRACE_IR_FIELD_CLASSES_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 /*
  31  * For bt_bool, bt_field_class bt_field_path
  32  * bt_field_class_signed_enumeration_mapping_ranges
  33  * bt_field_class_unsigned_enumeration_mapping_ranges,
  34  * bt_field_class_enumeration_mapping_label_array
  35  */
  36 #include <babeltrace/types.h>
  37
  38 #include <stdint.h>
  39 #include <stddef.h>
  40
  41 #ifdef __cplusplus
  42 extern "C" {
  43 #endif
  44
  45 typedef enum bt_field_class_status {
  46         BT_FIELD_CLASS_STATUS_OK = 0,
  47         BT_FIELD_CLASS_STATUS_NOMEM = -12,
  48 } bt_field_class_status;
  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 void bt_field_class_unsigned_enumeration_borrow_mapping_by_index_const(
  87                 const bt_field_class *field_class, uint64_t index,
  88                 const char **label,
  89                 const bt_field_class_unsigned_enumeration_mapping_ranges **ranges);
  90
  91 extern void bt_field_class_signed_enumeration_borrow_mapping_by_index_const(
  92                 const bt_field_class *field_class, uint64_t index,
  93                 const char **label,
  94                 const bt_field_class_signed_enumeration_mapping_ranges **ranges);
  95
  96 extern uint64_t
  97 bt_field_class_unsigned_enumeration_mapping_ranges_get_range_count(
  98                 const bt_field_class_unsigned_enumeration_mapping_ranges *ranges);
  99
 100 extern uint64_t
 101 bt_field_class_signed_enumeration_mapping_ranges_get_range_count(
 102                 const bt_field_class_signed_enumeration_mapping_ranges *ranges);
 103
 104 extern void
 105 bt_field_class_unsigned_enumeration_mapping_ranges_get_range_by_index(
 106                 const bt_field_class_unsigned_enumeration_mapping_ranges *ranges,
 107                 uint64_t index, uint64_t *lower, uint64_t *upper);
 108
 109 extern void
 110 bt_field_class_signed_enumeration_mapping_ranges_get_range_by_index(
 111                 const bt_field_class_signed_enumeration_mapping_ranges *ranges,
 112                 uint64_t index, int64_t *lower, int64_t *upper);
 113
 114 extern bt_field_class_status
 115 bt_field_class_unsigned_enumeration_get_mapping_labels_by_value(
 116                 const bt_field_class *field_class, uint64_t value,
 117                 bt_field_class_enumeration_mapping_label_array *label_array,
 118                 uint64_t *count);
 119
 120 extern bt_field_class_status
 121 bt_field_class_signed_enumeration_get_mapping_labels_by_value(
 122                 const bt_field_class *field_class, int64_t value,
 123                 bt_field_class_enumeration_mapping_label_array *label_array,
 124                 uint64_t *count);
 125
 126 extern uint64_t bt_field_class_structure_get_member_count(
 127                 const bt_field_class *field_class);
 128
 129 extern const bt_field_class_structure_member *
 130 bt_field_class_structure_borrow_member_by_index_const(
 131                 const bt_field_class *field_class, uint64_t index);
 132
 133 extern const bt_field_class_structure_member *
 134 bt_field_class_structure_borrow_member_by_name_const(
 135                 const bt_field_class *field_class, const char *name);
 136
 137 extern const char *bt_field_class_structure_member_get_name(
 138                 const bt_field_class_structure_member *member);
 139
 140 extern const bt_field_class *
 141 bt_field_class_structure_member_borrow_field_class_const(
 142                 const bt_field_class_structure_member *member);
 143
 144 extern const bt_field_class *
 145 bt_field_class_array_borrow_element_field_class_const(
 146                 const bt_field_class *field_class);
 147
 148 extern uint64_t bt_field_class_static_array_get_length(
 149                 const bt_field_class *field_class);
 150
 151 extern const bt_field_path *
 152 bt_field_class_dynamic_array_borrow_length_field_path_const(
 153                 const bt_field_class *field_class);
 154
 155 extern const bt_field_path *
 156 bt_field_class_variant_borrow_selector_field_path_const(
 157                 const bt_field_class *field_class);
 158
 159 extern uint64_t bt_field_class_variant_get_option_count(
 160                 const bt_field_class *field_class);
 161
 162 extern const bt_field_class_variant_option *
 163 bt_field_class_variant_borrow_option_by_index_const(
 164                 const bt_field_class *field_class, uint64_t index);
 165
 166 extern const bt_field_class_variant_option *
 167 bt_field_class_variant_borrow_option_by_name_const(
 168                 const bt_field_class *field_class, const char *name);
 169
 170 extern const char *bt_field_class_variant_option_get_name(
 171                 const bt_field_class_variant_option *option);
 172
 173 extern const bt_field_class *
 174 bt_field_class_variant_option_borrow_field_class_const(
 175                 const bt_field_class_variant_option *option);
 176
 177 extern void bt_field_class_get_ref(const bt_field_class *field_class);
 178
 179 extern void bt_field_class_put_ref(const bt_field_class *field_class);
 180
 181 #define BT_FIELD_CLASS_PUT_REF_AND_RESET(_var)          \
 182         do {                                            \
 183                 bt_field_class_put_ref(_var);           \
 184                 (_var) = NULL;                          \
 185         } while (0)
 186
 187 #define BT_FIELD_CLASS_MOVE_REF(_var_dst, _var_src)     \
 188         do {                                            \
 189                 bt_field_class_put_ref(_var_dst);       \
 190                 (_var_dst) = (_var_src);                \
 191                 (_var_src) = NULL;                      \
 192         } while (0)
 193
 194
 195 #ifdef __cplusplus
 196 }
 197 #endif
 198
 199 #endif /* BABELTRACE_TRACE_IR_FIELD_CLASSES_CONST_H */