include/babeltrace2/trace-ir/field.h

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