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 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 #ifndef __BT_IN_BABELTRACE_H
  31 # error "Please include <babeltrace2/babeltrace.h> instead."
  32 #endif
  33
  34 #include <stdint.h>
  35
  36 /* For bt_field_class_type */
  37 #include <babeltrace2/trace-ir/field-class.h>
  38
  39 /* For bt_field, bt_field_class */
  40 #include <babeltrace2/types.h>
  41
  42 #ifdef __cplusplus
  43 extern "C" {
  44 #endif
  45
  46 extern const bt_field_class *bt_field_borrow_class_const(
  47                 const bt_field *field);
  48
  49 extern bt_field_class_type bt_field_get_class_type(
  50                 const bt_field *field);
  51
  52 extern int64_t bt_field_signed_integer_get_value(const bt_field *field);
  53
  54 extern uint64_t bt_field_unsigned_integer_get_value(
  55                 const bt_field *field);
  56
  57 extern double bt_field_real_get_value(const bt_field *field);
  58
  59 typedef enum bt_field_enumeration_get_mapping_labels_status {
  60         BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_MEMORY_ERROR     = __BT_FUNC_STATUS_MEMORY_ERROR,
  61         BT_FIELD_ENUMERATION_GET_MAPPING_LABELS_STATUS_OK               = __BT_FUNC_STATUS_OK,
  62 } bt_field_enumeration_get_mapping_labels_status;
  63
  64 extern bt_field_enumeration_get_mapping_labels_status
  65 bt_field_unsigned_enumeration_get_mapping_labels(const bt_field *field,
  66                 bt_field_class_enumeration_mapping_label_array *label_array,
  67                 uint64_t *count);
  68
  69 extern bt_field_enumeration_get_mapping_labels_status
  70 bt_field_signed_enumeration_get_mapping_labels(const bt_field *field,
  71                 bt_field_class_enumeration_mapping_label_array *label_array,
  72                 uint64_t *count);
  73
  74 extern const char *bt_field_string_get_value(const bt_field *field);
  75
  76 extern uint64_t bt_field_string_get_length(const bt_field *field);
  77
  78 extern const bt_field *
  79 bt_field_structure_borrow_member_field_by_index_const(
  80                 const bt_field *field, uint64_t index);
  81
  82 extern const bt_field *
  83 bt_field_structure_borrow_member_field_by_name_const(
  84                 const bt_field *field, const char *name);
  85
  86 extern uint64_t bt_field_array_get_length(const bt_field *field);
  87
  88 extern const bt_field *
  89 bt_field_array_borrow_element_field_by_index_const(
  90                 const bt_field *field, uint64_t index);
  91
  92 extern uint64_t bt_field_variant_get_selected_option_field_index(
  93                 const bt_field *field);
  94
  95 extern const bt_field *
  96 bt_field_variant_borrow_selected_option_field_const(
  97                 const bt_field *field);
  98
  99 #ifdef __cplusplus
 100 }
 101 #endif
 102
 103 #endif /* BABELTRACE2_TRACE_IR_FIELD_CONST_H */