include/babeltrace/values.h

   1 #ifndef BABELTRACE_VALUES_H
   2 #define BABELTRACE_VALUES_H
   3
   4 /*
   5  * Babeltrace - Value objects
   6  *
   7  * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
   8  * Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
   9  *
  10  * Permission is hereby granted, free of charge, to any person obtaining a copy
  11  * of this software and associated documentation files (the "Software"), to deal
  12  * in the Software without restriction, including without limitation the rights
  13  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  14  * copies of the Software, and to permit persons to whom the Software is
  15  * furnished to do so, subject to the following conditions:
  16  *
  17  * The above copyright notice and this permission notice shall be included in
  18  * all copies or substantial portions of the Software.
  19  *
  20  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  21  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  22  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  23  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  24  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  25  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  26  * SOFTWARE.
  27  */
  28
  29 #include <stdint.h>
  30 #include <stddef.h>
  31
  32 /* For bt_bool */
  33 #include <babeltrace/types.h>
  34
  35 #ifdef __cplusplus
  36 extern "C" {
  37 #endif
  38
  39 /**
  40 @brief Status codes.
  41 */
  42 enum bt_value_status {
  43         /// Operation canceled.
  44         BT_VALUE_STATUS_CANCELED =      -3,
  45
  46         /// General error.
  47         BT_VALUE_STATUS_ERROR =         -1,
  48
  49         /// Okay, no error.
  50         BT_VALUE_STATUS_OK =            0,
  51 };
  52
  53 struct bt_value;
  54 struct bt_private_value;
  55
  56 extern struct bt_value *bt_value_null;
  57
  58 enum bt_value_type {
  59         /// Null value object.
  60         BT_VALUE_TYPE_NULL =            0,
  61
  62         /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
  63         BT_VALUE_TYPE_BOOL =            1,
  64
  65         /// Integer value object (holds a signed 64-bit integer raw value).
  66         BT_VALUE_TYPE_INTEGER =         2,
  67
  68         /// Floating point number value object (holds a \c double raw value).
  69         BT_VALUE_TYPE_REAL =            3,
  70
  71         /// String value object.
  72         BT_VALUE_TYPE_STRING =          4,
  73
  74         /// Array value object.
  75         BT_VALUE_TYPE_ARRAY =           5,
  76
  77         /// Map value object.
  78         BT_VALUE_TYPE_MAP =             6,
  79 };
  80
  81 extern enum bt_value_type bt_value_get_type(const struct bt_value *object);
  82
  83 static inline
  84 bt_bool bt_value_is_null(const struct bt_value *object)
  85 {
  86         return bt_value_get_type(object) == BT_VALUE_TYPE_NULL;
  87 }
  88
  89 static inline
  90 bt_bool bt_value_is_bool(const struct bt_value *object)
  91 {
  92         return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
  93 }
  94
  95 static inline
  96 bt_bool bt_value_is_integer(const struct bt_value *object)
  97 {
  98         return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER;
  99 }
 100
 101 static inline
 102 bt_bool bt_value_is_real(const struct bt_value *object)
 103 {
 104         return bt_value_get_type(object) == BT_VALUE_TYPE_REAL;
 105 }
 106
 107 static inline
 108 bt_bool bt_value_is_string(const struct bt_value *object)
 109 {
 110         return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
 111 }
 112
 113 static inline
 114 bt_bool bt_value_is_array(const struct bt_value *object)
 115 {
 116         return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY;
 117 }
 118
 119 static inline
 120 bt_bool bt_value_is_map(const struct bt_value *object)
 121 {
 122         return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
 123 }
 124
 125 extern struct bt_private_value *bt_value_copy(const struct bt_value *object);
 126
 127 extern bt_bool bt_value_compare(const struct bt_value *object_a,
 128                 const struct bt_value *object_b);
 129
 130 extern enum bt_value_status bt_value_bool_get(
 131                 const struct bt_value *bool_obj, bt_bool *val);
 132
 133 extern enum bt_value_status bt_value_integer_get(
 134                 const struct bt_value *integer_obj, int64_t *val);
 135
 136 extern enum bt_value_status bt_value_real_get(
 137                 const struct bt_value *real_obj, double *val);
 138
 139 extern enum bt_value_status bt_value_string_get(
 140                 const struct bt_value *string_obj, const char **val);
 141
 142 extern int64_t bt_value_array_get_size(const struct bt_value *array_obj);
 143
 144 extern bt_bool bt_value_array_is_empty(const struct bt_value *array_obj);
 145
 146 extern struct bt_value *bt_value_array_borrow_element_by_index(
 147                 const struct bt_value *array_obj, uint64_t index);
 148
 149 extern int64_t bt_value_map_get_size(const struct bt_value *map_obj);
 150
 151 extern bt_bool bt_value_map_is_empty(const struct bt_value *map_obj);
 152
 153 extern struct bt_value *bt_value_map_borrow_entry_value(
 154                 const struct bt_value *map_obj, const char *key);
 155
 156 typedef bt_bool (* bt_value_map_foreach_entry_cb)(const char *key,
 157         struct bt_value *object, void *data);
 158
 159 extern enum bt_value_status bt_value_map_foreach_entry(
 160                 const struct bt_value *map_obj,
 161                 bt_value_map_foreach_entry_cb cb, void *data);
 162
 163 extern bt_bool bt_value_map_has_entry(const struct bt_value *map_obj,
 164                 const char *key);
 165
 166 extern struct bt_private_value *bt_value_map_extend(
 167                 struct bt_value *base_map_obj,
 168                 struct bt_value *extension_map_obj);
 169
 170 #ifdef __cplusplus
 171 }
 172 #endif
 173
 174 #endif /* BABELTRACE_VALUES_H */