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