Rename: "float value" -> "real value"

[babeltrace.git] / include / babeltrace / values.h

diff --git a/include/babeltrace/values.h b/include/babeltrace/values.h
index d15256da8a9904b910adebe2d9fe8521738d32bf..0e03596ad8faef15de11d1c254c916e77c5dac82 100644 (file)
--- a/include/babeltrace/values.h
+++ b/include/babeltrace/values.h
@@ -32,6 +32,9 @@
 /* For bt_bool */
 #include <babeltrace/types.h>
 
+/* For bt_get() */
+#include <babeltrace/ref.h>
+
 #ifdef __cplusplus
 extern "C" {
 #endif
@@ -219,9 +222,6 @@ extern struct bt_value *bt_value_null;
 @brief Value object type.
 */
 enum bt_value_type {
-       /// Unknown value object, used as an error code.
-       BT_VALUE_TYPE_UNKNOWN =         -1,
-
        /// Null value object.
        BT_VALUE_TYPE_NULL =            0,
 
@@ -232,7 +232,7 @@ enum bt_value_type {
        BT_VALUE_TYPE_INTEGER =         2,
 
        /// Floating point number value object (holds a \c double raw value).
-       BT_VALUE_TYPE_FLOAT =           3,
+       BT_VALUE_TYPE_REAL =            3,
 
        /// String value object.
        BT_VALUE_TYPE_STRING =          4,
@@ -342,9 +342,9 @@ bt_bool bt_value_is_integer(const struct bt_value *object)
 @sa bt_value_get_type(): Returns the type of a given value object.
 */
 static inline
-bt_bool bt_value_is_float(const struct bt_value *object)
+bt_bool bt_value_is_real(const struct bt_value *object)
 {
-       return bt_value_get_type(object) == BT_VALUE_TYPE_FLOAT;
+       return bt_value_get_type(object) == BT_VALUE_TYPE_REAL;
 }
 
 /**
@@ -614,7 +614,7 @@ The created floating point number value object's initial raw value is 0.
 @sa bt_value_float_create_init(): Creates an initialized floating
        point number value object.
 */
-extern struct bt_value *bt_value_float_create(void);
+extern struct bt_value *bt_value_real_create(void);
 
 /**
 @brief Creates a floating point number value object with its initial raw
@@ -629,7 +629,7 @@ extern struct bt_value *bt_value_float_create(void);
 @sa bt_value_float_create(): Creates a default floating point number
        value object.
 */
-extern struct bt_value *bt_value_float_create_init(double val);
+extern struct bt_value *bt_value_real_create_init(double val);
 
 /**
 @brief Returns the floating point number raw value of the floating point
@@ -648,8 +648,8 @@ extern struct bt_value *bt_value_float_create_init(double val);
 @sa bt_value_float_set(): Sets the raw value of a given floating
        point number value object.
 */
-extern enum bt_value_status bt_value_float_get(
-               const struct bt_value *float_obj, double *val);
+extern enum bt_value_status bt_value_real_get(
+               const struct bt_value *real_obj, double *val);
 
 /**
 @brief Sets the floating point number raw value of the floating point
@@ -668,8 +668,8 @@ extern enum bt_value_status bt_value_float_get(
 @sa bt_value_float_get(): Returns the raw value of a floating point
        number value object.
 */
-extern enum bt_value_status bt_value_float_set(
-               struct bt_value *float_obj, double val);
+extern enum bt_value_status bt_value_real_set(
+               struct bt_value *real_obj, double val);
 
 /** @} */
 
@@ -811,6 +811,9 @@ extern int64_t bt_value_array_size(const struct bt_value *array_obj);
 */
 extern bt_bool bt_value_array_is_empty(const struct bt_value *array_obj);
 
+extern struct bt_value *bt_value_array_borrow(const struct bt_value *array_obj,
+               uint64_t index);
+
 /**
 @brief Returns the value object contained in the array value object
        \p array_obj at the index \p index.
@@ -828,8 +831,12 @@ extern bt_bool bt_value_array_is_empty(const struct bt_value *array_obj);
        \ref bt_value_null</strong>, its reference count is incremented.
 @postrefcountsame{array_obj}
 */
-extern struct bt_value *bt_value_array_get(const struct bt_value *array_obj,
-               uint64_t index);
+static inline
+struct bt_value *bt_value_array_get(const struct bt_value *array_obj,
+               uint64_t index)
+{
+       return bt_get(bt_value_array_borrow(array_obj, index));
+}
 
 /**
 @brief Appends the value object \p element_obj to the array value
@@ -928,7 +935,7 @@ point number value object before appending it.
 @sa bt_value_array_append(): Appends a value object to a given
        array value object.
 */
-extern enum bt_value_status bt_value_array_append_float(
+extern enum bt_value_status bt_value_array_append_real(
                struct bt_value *array_obj, double val);
 
 /**
@@ -1077,6 +1084,9 @@ extern int64_t bt_value_map_size(const struct bt_value *map_obj);
 */
 extern bt_bool bt_value_map_is_empty(const struct bt_value *map_obj);
 
+extern struct bt_value *bt_value_map_borrow(const struct bt_value *map_obj,
+               const char *key);
+
 /**
 @brief Returns the value object associated with the key \p key within
        the map value object \p map_obj.
@@ -1093,8 +1103,12 @@ extern bt_bool bt_value_map_is_empty(const struct bt_value *map_obj);
 @post <strong>On success, if the returned value object is not
        \ref bt_value_null</strong>, its reference count is incremented.
 */
-extern struct bt_value *bt_value_map_get(const struct bt_value *map_obj,
-               const char *key);
+static inline
+struct bt_value *bt_value_map_get(const struct bt_value *map_obj,
+               const char *key)
+{
+       return bt_get(bt_value_map_borrow(map_obj, key));
+}
 
 /**
 @brief User function type to use with bt_value_map_foreach().
@@ -1292,7 +1306,7 @@ On success, \p key is copied.
 @sa bt_value_map_insert(): Inserts a value object into a given map
        value object.
 */
-extern enum bt_value_status bt_value_map_insert_float(
+extern enum bt_value_status bt_value_map_insert_real(
                struct bt_value *map_obj, const char *key, double val);
 
 /**