include/babeltrace/ctf-ir/fields.h

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