include/babeltrace2/value.h

   1 #ifndef BABELTRACE2_VALUE_H
   2 #define BABELTRACE2_VALUE_H
   3
   4 /*
   5  * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
   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 #include <stddef.h>
  32
  33 /* For bt_bool, bt_value */
  34 #include <babeltrace2/types.h>
  35
  36 /* For bt_value_type */
  37 #include <babeltrace2/value-const.h>
  38
  39 #ifdef __cplusplus
  40 extern "C" {
  41 #endif
  42
  43 extern bt_value *const bt_value_null;
  44
  45 extern bt_value *bt_value_bool_create(void);
  46
  47 extern bt_value *bt_value_bool_create_init(bt_bool val);
  48
  49 extern void bt_value_bool_set(bt_value *bool_obj, bt_bool val);
  50
  51 extern bt_value *bt_value_unsigned_integer_create(void);
  52
  53 extern bt_value *bt_value_unsigned_integer_create_init(uint64_t val);
  54
  55 extern void bt_value_unsigned_integer_set(bt_value *integer_obj, uint64_t val);
  56
  57 extern bt_value *bt_value_signed_integer_create(void);
  58
  59 extern bt_value *bt_value_signed_integer_create_init(int64_t val);
  60
  61 extern void bt_value_signed_integer_set(bt_value *integer_obj, int64_t val);
  62
  63 extern bt_value *bt_value_real_create(void);
  64
  65 extern bt_value *bt_value_real_create_init(double val);
  66
  67 extern void bt_value_real_set(bt_value *real_obj, double val);
  68
  69 extern bt_value *bt_value_string_create(void);
  70
  71 extern bt_value *bt_value_string_create_init(const char *val);
  72
  73 typedef enum bt_value_string_set_status {
  74         BT_VALUE_STRING_SET_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
  75         BT_VALUE_STRING_SET_STATUS_OK           = __BT_FUNC_STATUS_OK,
  76 } bt_value_string_set_status;
  77
  78 extern bt_value_string_set_status bt_value_string_set(bt_value *string_obj,
  79                 const char *val);
  80
  81 extern bt_value *bt_value_array_create(void);
  82
  83 extern bt_value *bt_value_array_borrow_element_by_index(bt_value *array_obj,
  84                 uint64_t index);
  85
  86 typedef enum bt_value_array_append_element_status {
  87         BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_MEMORY_ERROR       = __BT_FUNC_STATUS_MEMORY_ERROR,
  88         BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK                 = __BT_FUNC_STATUS_OK,
  89 } bt_value_array_append_element_status;
  90
  91 extern bt_value_array_append_element_status bt_value_array_append_element(
  92                 bt_value *array_obj, bt_value *element_obj);
  93
  94 extern bt_value_array_append_element_status
  95 bt_value_array_append_bool_element(bt_value *array_obj, bt_bool val);
  96
  97 extern bt_value_array_append_element_status
  98 bt_value_array_append_unsigned_integer_element(bt_value *array_obj,
  99                 uint64_t val);
 100
 101 extern bt_value_array_append_element_status
 102 bt_value_array_append_signed_integer_element(bt_value *array_obj, int64_t val);
 103
 104 extern bt_value_array_append_element_status
 105 bt_value_array_append_real_element(bt_value *array_obj, double val);
 106
 107 extern bt_value_array_append_element_status
 108 bt_value_array_append_string_element(bt_value *array_obj, const char *val);
 109
 110 extern bt_value_array_append_element_status
 111 bt_value_array_append_empty_array_element(bt_value *array_obj);
 112
 113 extern bt_value_array_append_element_status
 114 bt_value_array_append_empty_map_element(bt_value *array_obj);
 115
 116 typedef enum bt_value_array_set_element_by_index_status {
 117         BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 118         BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK           = __BT_FUNC_STATUS_OK,
 119 } bt_value_array_set_element_by_index_status;
 120
 121 extern bt_value_array_set_element_by_index_status
 122 bt_value_array_set_element_by_index(bt_value *array_obj, uint64_t index,
 123                 bt_value *element_obj);
 124
 125 extern bt_value *bt_value_map_create(void);
 126
 127 extern bt_value *bt_value_map_borrow_entry_value(
 128                 bt_value *map_obj, const char *key);
 129
 130 typedef bt_bool (* bt_value_map_foreach_entry_func)(const char *key,
 131                 bt_value *object, void *data);
 132
 133 typedef enum bt_value_map_foreach_entry_status {
 134         BT_VALUE_MAP_FOREACH_ENTRY_STATUS_MEMORY_ERROR  = __BT_FUNC_STATUS_MEMORY_ERROR,
 135         BT_VALUE_MAP_FOREACH_ENTRY_STATUS_OK            = __BT_FUNC_STATUS_OK,
 136         BT_VALUE_MAP_FOREACH_ENTRY_STATUS_CANCELED      = __BT_FUNC_STATUS_CANCELED,
 137 } bt_value_map_foreach_entry_status;
 138
 139 extern bt_value_map_foreach_entry_status bt_value_map_foreach_entry(
 140                 bt_value *map_obj, bt_value_map_foreach_entry_func func,
 141                 void *data);
 142
 143 typedef enum bt_value_map_insert_entry_status {
 144         BT_VALUE_MAP_INSERT_ENTRY_STATUS_MEMORY_ERROR   = __BT_FUNC_STATUS_MEMORY_ERROR,
 145         BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK             = __BT_FUNC_STATUS_OK,
 146 } bt_value_map_insert_entry_status;
 147
 148 extern bt_value_map_insert_entry_status bt_value_map_insert_entry(
 149                 bt_value *map_obj, const char *key, bt_value *element_obj);
 150
 151 extern bt_value_map_insert_entry_status bt_value_map_insert_bool_entry(
 152                 bt_value *map_obj, const char *key, bt_bool val);
 153
 154 extern bt_value_map_insert_entry_status
 155 bt_value_map_insert_unsigned_integer_entry(bt_value *map_obj, const char *key,
 156                 uint64_t val);
 157
 158 extern bt_value_map_insert_entry_status
 159 bt_value_map_insert_signed_integer_entry(bt_value *map_obj, const char *key,
 160                 int64_t val);
 161
 162 extern bt_value_map_insert_entry_status bt_value_map_insert_real_entry(
 163                 bt_value *map_obj, const char *key, double val);
 164
 165 extern bt_value_map_insert_entry_status
 166 bt_value_map_insert_string_entry(bt_value *map_obj, const char *key,
 167                 const char *val);
 168
 169 extern bt_value_map_insert_entry_status
 170 bt_value_map_insert_empty_array_entry(bt_value *map_obj, const char *key);
 171
 172 extern bt_value_map_insert_entry_status
 173 bt_value_map_insert_empty_map_entry(bt_value *map_obj, const char *key);
 174
 175 #ifdef __cplusplus
 176 }
 177 #endif
 178
 179 #endif /* BABELTRACE2_VALUE_H */