include/babeltrace/trace-ir/fields-const.h

   1 #ifndef BABELTRACE_TRACE_IR_FIELDS_CONST_H
   2 #define BABELTRACE_TRACE_IR_FIELDS_CONST_H
   3
   4 /*
   5  * Copyright 2013, 2014 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   6  *
   7  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  *
   9  * Permission is hereby granted, free of charge, to any person obtaining a copy
  10  * of this software and associated documentation files (the "Software"), to deal
  11  * in the Software without restriction, including without limitation the rights
  12  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13  * copies of the Software, and to permit persons to whom the Software is
  14  * furnished to do so, subject to the following conditions:
  15  *
  16  * The above copyright notice and this permission notice shall be included in
  17  * all copies or substantial portions of the Software.
  18  *
  19  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  25  * SOFTWARE.
  26  *
  27  * The Common Trace Format (CTF) Specification is available at
  28  * http://www.efficios.com/ctf
  29  */
  30
  31 #include <stdint.h>
  32
  33 /* For enum bt_field_class_type */
  34 #include <babeltrace/trace-ir/field-classes.h>
  35
  36 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 struct bt_field;
  41 struct bt_field_class;
  42
  43 extern const struct bt_field_class *bt_field_borrow_class_const(
  44                 const struct bt_field *field);
  45
  46 extern enum bt_field_class_type bt_field_get_class_type(
  47                 const struct bt_field *field);
  48
  49 extern int64_t bt_field_signed_integer_get_value(const struct bt_field *field);
  50
  51 extern uint64_t bt_field_unsigned_integer_get_value(
  52                 const struct bt_field *field);
  53
  54 extern double bt_field_real_get_value(const struct bt_field *field);
  55
  56 extern int bt_field_unsigned_enumeration_get_mapping_labels(
  57                 const struct bt_field *field,
  58                 bt_field_class_enumeration_mapping_label_array *label_array,
  59                 uint64_t *count);
  60
  61 extern int bt_field_signed_enumeration_get_mapping_labels(
  62                 const struct bt_field *field,
  63                 bt_field_class_enumeration_mapping_label_array *label_array,
  64                 uint64_t *count);
  65
  66 extern const char *bt_field_string_get_value(const struct bt_field *field);
  67
  68 extern uint64_t bt_field_string_get_length(const struct bt_field *field);
  69
  70 extern const struct bt_field *
  71 bt_field_structure_borrow_member_field_by_index_const(
  72                 const struct bt_field *field, uint64_t index);
  73
  74 extern const struct bt_field *
  75 bt_field_structure_borrow_member_field_by_name_const(
  76                 const struct bt_field *field, const char *name);
  77
  78 extern uint64_t bt_field_array_get_length(const struct bt_field *field);
  79
  80 extern const struct bt_field *
  81 bt_field_array_borrow_element_field_by_index_const(
  82                 const struct bt_field *field, uint64_t index);
  83
  84 extern uint64_t bt_field_variant_get_selected_option_field_index(
  85                 const struct bt_field *field);
  86
  87 extern const struct bt_field *
  88 bt_field_variant_borrow_selected_option_field_const(
  89                 const struct bt_field *field);
  90
  91 #ifdef __cplusplus
  92 }
  93 #endif
  94
  95 #endif /* BABELTRACE_TRACE_IR_FIELDS_CONST_H */