include/babeltrace/value.h

   1 #ifndef BABELTRACE_VALUES_H
   2 #define BABELTRACE_VALUES_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 #include <stdint.h>
  27 #include <stddef.h>
  28
  29 /* For bt_bool */
  30 #include <babeltrace/types.h>
  31
  32 /* For enum bt_value_status, enum bt_value_type */
  33 #include <babeltrace/value-const.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 struct bt_value;
  40
  41 extern struct bt_value *bt_value_null;
  42
  43 extern struct bt_value *bt_value_bool_create(void);
  44
  45 extern struct bt_value *bt_value_bool_create_init(bt_bool val);
  46
  47 extern void bt_value_bool_set(struct bt_value *bool_obj, bt_bool val);
  48
  49 extern struct bt_value *bt_value_integer_create(void);
  50
  51 extern struct bt_value *bt_value_integer_create_init(
  52                 int64_t val);
  53
  54 extern void bt_value_integer_set(struct bt_value *integer_obj, int64_t val);
  55
  56 extern struct bt_value *bt_value_real_create(void);
  57
  58 extern struct bt_value *bt_value_real_create_init(double val);
  59
  60 extern void bt_value_real_set(struct bt_value *real_obj, double val);
  61
  62 extern struct bt_value *bt_value_string_create(void);
  63
  64 extern struct bt_value *bt_value_string_create_init(const char *val);
  65
  66 extern enum bt_value_status bt_value_string_set(struct bt_value *string_obj,
  67                 const char *val);
  68
  69 extern struct bt_value *bt_value_array_create(void);
  70
  71 extern struct bt_value *bt_value_array_borrow_element_by_index(
  72                 struct bt_value *array_obj, uint64_t index);
  73
  74 extern enum bt_value_status bt_value_array_append_element(
  75                 struct bt_value *array_obj,
  76                 struct bt_value *element_obj);
  77
  78 extern enum bt_value_status bt_value_array_append_bool_element(
  79                 struct bt_value *array_obj, bt_bool val);
  80
  81 extern enum bt_value_status bt_value_array_append_integer_element(
  82                 struct bt_value *array_obj, int64_t val);
  83
  84 extern enum bt_value_status bt_value_array_append_real_element(
  85                 struct bt_value *array_obj, double val);
  86
  87 extern enum bt_value_status bt_value_array_append_string_element(
  88                 struct bt_value *array_obj, const char *val);
  89
  90 extern enum bt_value_status bt_value_array_append_empty_array_element(
  91                 struct bt_value *array_obj);
  92
  93 extern enum bt_value_status bt_value_array_append_empty_map_element(
  94                 struct bt_value *array_obj);
  95
  96 extern enum bt_value_status bt_value_array_set_element_by_index(
  97                 struct bt_value *array_obj, uint64_t index,
  98                 struct bt_value *element_obj);
  99
 100 extern struct bt_value *bt_value_map_create(void);
 101
 102 extern struct bt_value *bt_value_map_borrow_entry_value(
 103                 struct bt_value *map_obj, const char *key);
 104
 105 typedef bt_bool (* bt_value_map_foreach_entry_func)(const char *key,
 106                 struct bt_value *object, void *data);
 107
 108 extern enum bt_value_status bt_value_map_foreach_entry(
 109                 struct bt_value *map_obj,
 110                 bt_value_map_foreach_entry_func func, void *data);
 111
 112 extern enum bt_value_status bt_value_map_insert_entry(
 113                 struct bt_value *map_obj, const char *key,
 114                 struct bt_value *element_obj);
 115
 116 extern enum bt_value_status bt_value_map_insert_bool_entry(
 117                 struct bt_value *map_obj, const char *key, bt_bool val);
 118
 119 extern enum bt_value_status bt_value_map_insert_integer_entry(
 120                 struct bt_value *map_obj, const char *key, int64_t val);
 121
 122 extern enum bt_value_status bt_value_map_insert_real_entry(
 123                 struct bt_value *map_obj, const char *key, double val);
 124
 125 extern enum bt_value_status bt_value_map_insert_string_entry(
 126                 struct bt_value *map_obj, const char *key,
 127                 const char *val);
 128
 129 extern enum bt_value_status bt_value_map_insert_empty_array_entry(
 130                 struct bt_value *map_obj, const char *key);
 131
 132 extern enum bt_value_status bt_value_map_insert_empty_map_entry(
 133                 struct bt_value *map_obj, const char *key);
 134
 135 #ifdef __cplusplus
 136 }
 137 #endif
 138
 139 #endif /* BABELTRACE_VALUES_H */