include/babeltrace2/value-const.h

   1 #ifndef BABELTRACE2_VALUE_CONST_H
   2 #define BABELTRACE2_VALUE_CONST_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 #ifdef __cplusplus
  37 extern "C" {
  38 #endif
  39
  40 typedef enum bt_value_type {
  41         /// Null value object.
  42         BT_VALUE_TYPE_NULL              = 0,
  43
  44         /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
  45         BT_VALUE_TYPE_BOOL              = 1,
  46
  47         /// Unsigned integer value object (holds an unsigned 64-bit integer raw value).
  48         BT_VALUE_TYPE_UNSIGNED_INTEGER  = 2,
  49
  50         /// Signed integer value object (holds a signed 64-bit integer raw value).
  51         BT_VALUE_TYPE_SIGNED_INTEGER    = 3,
  52
  53         /// Floating point number value object (holds a \c double raw value).
  54         BT_VALUE_TYPE_REAL              = 4,
  55
  56         /// String value object.
  57         BT_VALUE_TYPE_STRING            = 5,
  58
  59         /// Array value object.
  60         BT_VALUE_TYPE_ARRAY             = 6,
  61
  62         /// Map value object.
  63         BT_VALUE_TYPE_MAP               = 7,
  64 } bt_value_type;
  65
  66 extern bt_value_type bt_value_get_type(const bt_value *object);
  67
  68 static inline
  69 bt_bool bt_value_is_null(const bt_value *object)
  70 {
  71         return bt_value_get_type(object) == BT_VALUE_TYPE_NULL;
  72 }
  73
  74 static inline
  75 bt_bool bt_value_is_bool(const bt_value *object)
  76 {
  77         return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
  78 }
  79
  80 static inline
  81 bt_bool bt_value_is_unsigned_integer(const bt_value *object)
  82 {
  83         return bt_value_get_type(object) == BT_VALUE_TYPE_UNSIGNED_INTEGER;
  84 }
  85
  86 static inline
  87 bt_bool bt_value_is_signed_integer(const bt_value *object)
  88 {
  89         return bt_value_get_type(object) == BT_VALUE_TYPE_SIGNED_INTEGER;
  90 }
  91
  92 static inline
  93 bt_bool bt_value_is_real(const bt_value *object)
  94 {
  95         return bt_value_get_type(object) == BT_VALUE_TYPE_REAL;
  96 }
  97
  98 static inline
  99 bt_bool bt_value_is_string(const bt_value *object)
 100 {
 101         return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
 102 }
 103
 104 static inline
 105 bt_bool bt_value_is_array(const bt_value *object)
 106 {
 107         return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY;
 108 }
 109
 110 static inline
 111 bt_bool bt_value_is_map(const bt_value *object)
 112 {
 113         return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
 114 }
 115
 116 typedef enum bt_value_copy_status {
 117         BT_VALUE_COPY_STATUS_MEMORY_ERROR       = __BT_FUNC_STATUS_MEMORY_ERROR,
 118         BT_VALUE_COPY_STATUS_OK                 = __BT_FUNC_STATUS_OK,
 119 } bt_value_copy_status;
 120
 121 extern bt_value_copy_status bt_value_copy(const bt_value *object,
 122                 bt_value **copy);
 123
 124 extern bt_bool bt_value_compare(const bt_value *object_a,
 125                 const bt_value *object_b);
 126
 127 extern bt_bool bt_value_bool_get(const bt_value *bool_obj);
 128
 129 extern uint64_t bt_value_unsigned_integer_get(const bt_value *integer_obj);
 130
 131 extern int64_t bt_value_signed_integer_get(const bt_value *integer_obj);
 132
 133 extern double bt_value_real_get(const bt_value *real_obj);
 134
 135 extern const char *bt_value_string_get(const bt_value *string_obj);
 136
 137 extern uint64_t bt_value_array_get_size(const bt_value *array_obj);
 138
 139 static inline
 140 bt_bool bt_value_array_is_empty(const bt_value *array_obj)
 141 {
 142         return bt_value_array_get_size(array_obj) == 0;
 143 }
 144
 145 extern const bt_value *bt_value_array_borrow_element_by_index_const(
 146                 const bt_value *array_obj, uint64_t index);
 147
 148 extern uint64_t bt_value_map_get_size(const bt_value *map_obj);
 149
 150 static inline
 151 bt_bool bt_value_map_is_empty(const bt_value *map_obj)
 152 {
 153         return bt_value_map_get_size(map_obj) == 0;
 154 }
 155
 156 extern const bt_value *bt_value_map_borrow_entry_value_const(
 157                 const bt_value *map_obj, const char *key);
 158
 159 typedef bt_bool (* bt_value_map_foreach_entry_const_func)(const char *key,
 160                 const bt_value *object, void *data);
 161
 162 typedef enum bt_value_map_foreach_entry_const_status {
 163         BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_MEMORY_ERROR    = __BT_FUNC_STATUS_MEMORY_ERROR,
 164         BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_OK              = __BT_FUNC_STATUS_OK,
 165         BT_VALUE_MAP_FOREACH_ENTRY_CONST_STATUS_CANCELED        = __BT_FUNC_STATUS_CANCELED,
 166 } bt_value_map_foreach_entry_const_status;
 167
 168 extern bt_value_map_foreach_entry_const_status bt_value_map_foreach_entry_const(
 169                 const bt_value *map_obj,
 170                 bt_value_map_foreach_entry_const_func func, void *data);
 171
 172 extern bt_bool bt_value_map_has_entry(const bt_value *map_obj,
 173                 const char *key);
 174
 175 typedef enum bt_value_map_extend_status {
 176         BT_VALUE_MAP_EXTEND_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
 177         BT_VALUE_MAP_EXTEND_STATUS_OK           = __BT_FUNC_STATUS_OK,
 178 } bt_value_map_extend_status;
 179
 180 extern bt_value_map_extend_status bt_value_map_extend(
 181                 const bt_value *base_map_obj,
 182                 const bt_value *extension_map_obj,
 183                 bt_value **extended_map_obj);
 184
 185 extern void bt_value_get_ref(const bt_value *value);
 186
 187 extern void bt_value_put_ref(const bt_value *value);
 188
 189 #define BT_VALUE_PUT_REF_AND_RESET(_var)                \
 190         do {                                            \
 191                 bt_value_put_ref(_var);                 \
 192                 (_var) = NULL;                          \
 193         } while (0)
 194
 195 #define BT_VALUE_MOVE_REF(_var_dst, _var_src)           \
 196         do {                                            \
 197                 bt_value_put_ref(_var_dst);             \
 198                 (_var_dst) = (_var_src);                \
 199                 (_var_src) = NULL;                      \
 200         } while (0)
 201
 202 #ifdef __cplusplus
 203 }
 204 #endif
 205
 206 #endif /* BABELTRACE2_VALUE_CONST_H */