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