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

   1 #ifndef BABELTRACE2_TRACE_IR_FIELD_CONST_H
   2 #define BABELTRACE2_TRACE_IR_FIELD_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
  32 #include <babeltrace2/trace-ir/field-class.h>
  33 #include <babeltrace2/types.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 extern const bt_field_class *bt_field_borrow_class_const(
  40                 const bt_field *field);
  41
  42 extern bt_field_class_type bt_field_get_class_type(
  43                 const bt_field *field);
  44
  45 extern bt_bool bt_field_bool_get_value(const bt_field *field);
  46
  47 extern uint64_t bt_field_bit_array_get_value_as_integer(
  48                 const bt_field *field);
  49
  50 extern int64_t bt_field_integer_signed_get_value(const bt_field *field);
  51
  52 extern uint64_t bt_field_integer_unsigned_get_value(
  53                 const bt_field *field);
  54
  55 extern double bt_field_real_get_value(const bt_field *field);
  56
  57 typedef enum bt_field_enumeration_get_mapping_labels_status {
  58         BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  59         BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_OK               = __BT_FUNC_STATUS_OK,
  60 } bt_field_enumeration_get_mapping_labels_status;
  61
  62 extern bt_field_enumeration_get_mapping_labels_status
  63 bt_field_enumeration_unsigned_get_mapping_labels(const bt_field *field,
  64                 bt_field_class_enumeration_mapping_label_array *label_array,
  65                 uint64_t *count);
  66
  67 extern bt_field_enumeration_get_mapping_labels_status
  68 bt_field_enumeration_signed_get_mapping_labels(const bt_field *field,
  69                 bt_field_class_enumeration_mapping_label_array *label_array,
  70                 uint64_t *count);
  71
  72 extern const char *bt_field_string_get_value(const bt_field *field);
  73
  74 extern uint64_t bt_field_string_get_length(const bt_field *field);
  75
  76 extern const bt_field *
  77 bt_field_structure_borrow_member_field_by_index_const(
  78                 const bt_field *field, uint64_t index);
  79
  80 extern const bt_field *
  81 bt_field_structure_borrow_member_field_by_name_const(
  82                 const bt_field *field, const char *name);
  83
  84 extern uint64_t bt_field_array_get_length(const bt_field *field);
  85
  86 extern const bt_field *
  87 bt_field_array_borrow_element_field_by_index_const(
  88                 const bt_field *field, uint64_t index);
  89
  90 extern const bt_field *
  91 bt_field_option_borrow_field_const(const bt_field *field);
  92
  93 extern uint64_t bt_field_variant_get_selected_option_field_index(
  94                 const bt_field *field);
  95
  96 extern const bt_field *
  97 bt_field_variant_borrow_selected_option_field_const(
  98                 const bt_field *field);
  99
 100 extern const bt_field_class_variant_option *
 101 bt_field_variant_borrow_selected_class_option_const(
 102                 const bt_field *field);
 103
 104 extern const bt_field_class_variant_with_selector_unsigned_option *
 105 bt_field_variant_with_unsigned_selector_borrow_selected_class_option_const(
 106                 const bt_field *field);
 107
 108 extern const bt_field_class_variant_with_selector_signed_option *
 109 bt_field_variant_with_signed_selector_borrow_selected_class_option_const(
 110                 const bt_field *field);
 111
 112 #ifdef __cplusplus
 113 }
 114 #endif
 115
 116 #endif /* BABELTRACE2_TRACE_IR_FIELD_CONST_H */