include/babeltrace/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 <babeltrace/types.h>
  31
  32 #ifdef __cplusplus
  33 extern "C" {
  34 #endif
  35
  36 typedef enum bt_value_status {
  37         /// Operation canceled.
  38         BT_VALUE_STATUS_CANCELED        = 125,
  39
  40         /// Cannot allocate memory.
  41         BT_VALUE_STATUS_NOMEM           = -12,
  42
  43         /// Okay, no error.
  44         BT_VALUE_STATUS_OK              = 0,
  45 } bt_value_status;
  46
  47 typedef enum bt_value_type {
  48         /// Null value object.
  49         BT_VALUE_TYPE_NULL =            0,
  50
  51         /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
  52         BT_VALUE_TYPE_BOOL =            1,
  53
  54         /// Integer value object (holds a signed 64-bit integer raw value).
  55         BT_VALUE_TYPE_INTEGER =         2,
  56
  57         /// Floating point number value object (holds a \c double raw value).
  58         BT_VALUE_TYPE_REAL =            3,
  59
  60         /// String value object.
  61         BT_VALUE_TYPE_STRING =          4,
  62
  63         /// Array value object.
  64         BT_VALUE_TYPE_ARRAY =           5,
  65
  66         /// Map value object.
  67         BT_VALUE_TYPE_MAP =             6,
  68 } bt_value_type;
  69
  70 extern bt_value_type bt_value_get_type(const bt_value *object);
  71
  72 static inline
  73 bt_bool bt_value_is_null(const bt_value *object)
  74 {
  75         return bt_value_get_type(object) == BT_VALUE_TYPE_NULL;
  76 }
  77
  78 static inline
  79 bt_bool bt_value_is_bool(const bt_value *object)
  80 {
  81         return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
  82 }
  83
  84 static inline
  85 bt_bool bt_value_is_integer(const bt_value *object)
  86 {
  87         return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER;
  88 }
  89
  90 static inline
  91 bt_bool bt_value_is_real(const bt_value *object)
  92 {
  93         return bt_value_get_type(object) == BT_VALUE_TYPE_REAL;
  94 }
  95
  96 static inline
  97 bt_bool bt_value_is_string(const bt_value *object)
  98 {
  99         return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
 100 }
 101
 102 static inline
 103 bt_bool bt_value_is_array(const bt_value *object)
 104 {
 105         return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY;
 106 }
 107
 108 static inline
 109 bt_bool bt_value_is_map(const bt_value *object)
 110 {
 111         return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
 112 }
 113
 114 extern bt_value_status bt_value_copy(const bt_value *object,
 115                 bt_value **copy);
 116
 117 extern bt_bool bt_value_compare(const bt_value *object_a,
 118                 const bt_value *object_b);
 119
 120 extern bt_bool bt_value_bool_get(const bt_value *bool_obj);
 121
 122 extern int64_t bt_value_integer_get(const bt_value *integer_obj);
 123
 124 extern double bt_value_real_get(const bt_value *real_obj);
 125
 126 extern const char *bt_value_string_get(const bt_value *string_obj);
 127
 128 extern uint64_t bt_value_array_get_size(const bt_value *array_obj);
 129
 130 static inline
 131 bt_bool bt_value_array_is_empty(const bt_value *array_obj)
 132 {
 133         return bt_value_array_get_size(array_obj) == 0;
 134 }
 135
 136 extern const bt_value *bt_value_array_borrow_element_by_index_const(
 137                 const bt_value *array_obj, uint64_t index);
 138
 139 extern uint64_t bt_value_map_get_size(const bt_value *map_obj);
 140
 141 static inline
 142 bt_bool bt_value_map_is_empty(const bt_value *map_obj)
 143 {
 144         return bt_value_map_get_size(map_obj) == 0;
 145 }
 146
 147 extern const bt_value *bt_value_map_borrow_entry_value_const(
 148                 const bt_value *map_obj, const char *key);
 149
 150 typedef bt_bool (* bt_value_map_foreach_entry_const_func)(const char *key,
 151                 const bt_value *object, void *data);
 152
 153 extern bt_value_status bt_value_map_foreach_entry_const(
 154                 const bt_value *map_obj,
 155                 bt_value_map_foreach_entry_const_func func, void *data);
 156
 157 extern bt_bool bt_value_map_has_entry(const bt_value *map_obj,
 158                 const char *key);
 159
 160 extern bt_value_status bt_value_map_extend(
 161                 const bt_value *base_map_obj,
 162                 const bt_value *extension_map_obj,
 163                 bt_value **extended_map_obj);
 164
 165 extern void bt_value_get_ref(const bt_value *value);
 166
 167 extern void bt_value_put_ref(const bt_value *value);
 168
 169 #define BT_VALUE_PUT_REF_AND_RESET(_var)                \
 170         do {                                            \
 171                 bt_value_put_ref(_var);                 \
 172                 (_var) = NULL;                          \
 173         } while (0)
 174
 175 #define BT_VALUE_MOVE_REF(_var_dst, _var_src)           \
 176         do {                                            \
 177                 bt_value_put_ref(_var_dst);             \
 178                 (_var_dst) = (_var_src);                \
 179                 (_var_src) = NULL;                      \
 180         } while (0)
 181
 182 #ifdef __cplusplus
 183 }
 184 #endif
 185
 186 #endif /* BABELTRACE_VALUES_CONST_H */