include/babeltrace2/trace-ir/field.h

   1 #ifndef BABELTRACE2_TRACE_IR_FIELD_H
   2 #define BABELTRACE2_TRACE_IR_FIELD_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, bt_field_class */
  37 #include <babeltrace2/types.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 extern void bt_field_signed_integer_set_value(bt_field *field,
  44                 int64_t value);
  45
  46 extern void bt_field_unsigned_integer_set_value(bt_field *field,
  47                 uint64_t value);
  48
  49 extern void bt_field_real_set_value(bt_field *field, double value);
  50
  51 typedef enum bt_field_string_set_value_status {
  52         BT_FIELD_STRING_SET_VALUE_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
  53         BT_FIELD_STRING_SET_VALUE_STATUS_OK             = __BT_FUNC_STATUS_OK,
  54 } bt_field_string_set_value_status;
  55
  56 extern bt_field_string_set_value_status bt_field_string_set_value(
  57                 bt_field *field, const char *value);
  58
  59 typedef enum bt_field_string_append_status {
  60         BT_FIELD_STRING_APPEND_STATUS_MEMORY_ERROR      = __BT_FUNC_STATUS_MEMORY_ERROR,
  61         BT_FIELD_STRING_APPEND_STATUS_OK                = __BT_FUNC_STATUS_OK,
  62 } bt_field_string_append_status;
  63
  64 extern bt_field_string_append_status bt_field_string_append(
  65                 bt_field *field, const char *value);
  66
  67 extern bt_field_string_append_status bt_field_string_append_with_length(
  68                 bt_field *field, const char *value, uint64_t length);
  69
  70 extern void bt_field_string_clear(bt_field *field);
  71
  72 extern bt_field *bt_field_structure_borrow_member_field_by_index(
  73                 bt_field *field, uint64_t index);
  74
  75 extern bt_field *bt_field_structure_borrow_member_field_by_name(
  76                 bt_field *field, const char *name);
  77
  78 extern bt_field *bt_field_array_borrow_element_field_by_index(
  79                 bt_field *field, uint64_t index);
  80
  81 typedef enum bt_field_dynamic_array_set_length_status {
  82         BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
  83         BT_FIELD_DYNAMIC_ARRAY_SET_LENGTH_STATUS_OK             = __BT_FUNC_STATUS_OK,
  84 } bt_field_dynamic_array_set_length_status;
  85
  86 extern bt_field_dynamic_array_set_length_status
  87 bt_field_dynamic_array_set_length(
  88                 bt_field *field, uint64_t length);
  89
  90 typedef enum bt_field_variant_select_option_field_status {
  91         BT_FIELD_VARIANT_SELECT_OPTION_FIELD_STATUS_OK          = __BT_FUNC_STATUS_OK,
  92 } bt_field_variant_select_option_field_status;
  93
  94 extern bt_field_variant_select_option_field_status
  95 bt_field_variant_select_option_field(
  96                 bt_field *field, uint64_t index);
  97
  98 extern bt_field *bt_field_variant_borrow_selected_option_field(
  99                 bt_field *field);
 100
 101 #ifdef __cplusplus
 102 }
 103 #endif
 104
 105 #endif /* BABELTRACE2_TRACE_IR_FIELD_H */