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