include/babeltrace/private-values.h

   1 #ifndef BABELTRACE_PRIVATE_VALUES_H
   2 #define BABELTRACE_PRIVATE_VALUES_H
   3
   4 /*
   5  * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
   6  * Copyright (c) 2015-2018 Philippe Proulx <pproulx@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
  27 #include <stdint.h>
  28 #include <stddef.h>
  29
  30 /* For enum bt_value_status */
  31 #include <babeltrace/values.h>
  32
  33 #ifdef __cplusplus
  34 extern "C" {
  35 #endif
  36
  37 struct bt_value;
  38 struct bt_private_value;
  39
  40 extern struct bt_private_value *bt_private_value_null;
  41
  42 extern struct bt_value *bt_value_borrow_from_private(
  43                 struct bt_private_value *priv_value);
  44
  45 extern struct bt_private_value *bt_private_value_bool_create(void);
  46
  47
  48 extern struct bt_private_value *bt_private_value_bool_create_init(bt_bool val);
  49
  50 extern enum bt_value_status bt_private_value_bool_set(struct bt_private_value *bool_obj,
  51                 bt_bool val);
  52
  53 extern struct bt_private_value *bt_private_value_integer_create(void);
  54
  55 extern struct bt_private_value *bt_private_value_integer_create_init(int64_t val);
  56
  57 extern enum bt_value_status bt_private_integer_bool_set(
  58                 struct bt_private_value *integer_obj, int64_t val);
  59
  60 extern struct bt_private_value *bt_private_value_real_create(void);
  61
  62 extern struct bt_private_value *bt_private_value_real_create_init(double val);
  63
  64 extern enum bt_value_status bt_private_value_real_set(
  65                 struct bt_private_value *real_obj, double val);
  66
  67 extern struct bt_private_value *bt_private_value_string_create(void);
  68
  69 extern struct bt_private_value *bt_private_value_string_create_init(const char *val);
  70
  71 extern enum bt_value_status bt_private_value_string_set(struct bt_private_value *string_obj,
  72                 const char *val);
  73
  74 extern struct bt_private_value *bt_private_value_array_create(void);
  75
  76 extern struct bt_private_value *bt_private_value_array_borrow_element_by_index(
  77                 const struct bt_private_value *array_obj, uint64_t index);
  78
  79 extern enum bt_value_status bt_private_value_array_append_element(
  80                 struct bt_private_value *array_obj, struct bt_value *element_obj);
  81
  82 extern enum bt_value_status bt_private_value_array_append_bool_element(
  83                 struct bt_private_value *array_obj, bt_bool val);
  84
  85 extern enum bt_value_status bt_private_value_array_append_integer_element(
  86                 struct bt_private_value *array_obj, int64_t val);
  87
  88 extern enum bt_value_status bt_private_value_array_append_real_element(
  89                 struct bt_private_value *array_obj, double val);
  90
  91 extern enum bt_value_status bt_private_value_array_append_string_element(
  92                 struct bt_private_value *array_obj, const char *val);
  93
  94 extern enum bt_value_status bt_private_value_array_append_empty_array_element(
  95                 struct bt_private_value *array_obj);
  96
  97 extern enum bt_value_status bt_private_value_array_append_empty_map_element(
  98                 struct bt_private_value *array_obj);
  99
 100 extern enum bt_value_status bt_private_value_array_set_element_by_index(
 101                 struct bt_private_value *array_obj, uint64_t index,
 102                 struct bt_value *element_obj);
 103
 104 extern struct bt_private_value *bt_private_value_map_create(void);
 105
 106 extern struct bt_private_value *bt_private_value_map_borrow_entry_value(
 107                 const struct bt_private_value *map_obj, const char *key);
 108
 109 typedef bt_bool (* bt_private_value_map_foreach_entry_cb)(const char *key,
 110         struct bt_private_value *object, void *data);
 111
 112 extern enum bt_value_status bt_private_value_map_foreach_entry(
 113                 const struct bt_private_value *map_obj,
 114                 bt_private_value_map_foreach_entry_cb cb, void *data);
 115
 116 extern enum bt_value_status bt_private_value_map_insert_entry(
 117                 struct bt_private_value *map_obj, const char *key,
 118                 struct bt_value *element_obj);
 119
 120 extern enum bt_value_status bt_private_value_map_insert_bool_entry(
 121                 struct bt_private_value *map_obj, const char *key, bt_bool val);
 122
 123 extern enum bt_value_status bt_private_value_map_insert_integer_entry(
 124                 struct bt_private_value *map_obj, const char *key, int64_t val);
 125
 126 extern enum bt_value_status bt_private_value_map_insert_real_entry(
 127                 struct bt_private_value *map_obj, const char *key, double val);
 128
 129 extern enum bt_value_status bt_private_value_map_insert_string_entry(
 130                 struct bt_private_value *map_obj, const char *key, const char *val);
 131
 132 extern enum bt_value_status bt_private_value_map_insert_empty_array_entry(
 133                 struct bt_private_value *map_obj, const char *key);
 134
 135 extern enum bt_value_status bt_private_value_map_insert_empty_map_entry(
 136                 struct bt_private_value *map_obj, const char *key);
 137
 138 #ifdef __cplusplus
 139 }
 140 #endif
 141
 142 #endif /* BABELTRACE_PRIVATE_VALUES_H */