include/babeltrace2/value-const.h

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