-#ifndef _BABELTRACE_VALUES_H
-#define _BABELTRACE_VALUES_H
+#ifndef BABELTRACE_VALUES_H
+#define BABELTRACE_VALUES_H
/*
* Babeltrace - Value objects
*/
#include <stdint.h>
-#include <stdbool.h>
#include <stddef.h>
+
+/* For bt_bool */
+#include <babeltrace/types.h>
+
+/* For bt_get() */
#include <babeltrace/ref.h>
#ifdef __cplusplus
@ingroup apiref
@brief Value objects.
+@code
+#include <babeltrace/values.h>
+@endcode
+
This is a set of <strong><em>value objects</em></strong>. With the
functions documented here, you can create and modify:
You can create a deep copy of any value object with bt_value_copy(). You
can compare two value objects with bt_value_compare().
-You can \em freeze a value object with bt_value_freeze(). You can get
-the raw value of a frozen value object, but you cannot modify it.
-Reference counting still works on frozen value objects. You can copy
-a frozen value object: the returned copy is not frozen. You can also
-compare a frozen value object to another value object (frozen or not).
-Freezing a value object is typically used to make it immutable after
-it's built by its initial owner.
-
The following matrix shows some categorized value object functions
to use for each value object type:
@brief Status codes.
*/
enum bt_value_status {
- /// Value object cannot be altered because it's frozen.
- BT_VALUE_STATUS_FROZEN = -4,
-
- /// Operation cancelled.
- BT_VALUE_STATUS_CANCELLED = -3,
+ /// Operation canceled.
+ BT_VALUE_STATUS_CANCELED = -3,
/* -22 for compatibility with -EINVAL */
- /// Invalid arguments.
+ /// Invalid argument.
BT_VALUE_STATUS_INVAL = -22,
/// General error.
/// Null value object.
BT_VALUE_TYPE_NULL = 0,
- /// Boolean value object (holds \c true or \c false).
+ /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
BT_VALUE_TYPE_BOOL = 1,
/// Integer value object (holds a signed 64-bit integer raw value).
object pointer to the \ref bt_value_null variable.
@param[in] object Value object to check.
-@returns \c true if \p object is the null value object.
+@returns #BT_TRUE if \p object is the null value object.
@prenotnull{object}
@postrefcountsame{object}
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_null(const struct bt_value *object)
+bt_bool bt_value_is_null(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_NULL;
}
value object.
@param[in] object Value object to check.
-@returns \c true if \p object is a boolean value object.
+@returns #BT_TRUE if \p object is a boolean value object.
@prenotnull{object}
@postrefcountsame{object}
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_bool(const struct bt_value *object)
+bt_bool bt_value_is_bool(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
}
value object.
@param[in] object Value object to check.
-@returns \c true if \p object is an integer value object.
+@returns #BT_TRUE if \p object is an integer value object.
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_integer(const struct bt_value *object)
+bt_bool bt_value_is_integer(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER;
}
point number value object.
@param[in] object Value object to check.
-@returns \c true if \p object is a floating point
+@returns #BT_TRUE if \p object is a floating point
number value object.
@prenotnull{object}
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_float(const struct bt_value *object)
+bt_bool bt_value_is_float(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_FLOAT;
}
value object.
@param[in] object Value object to check.
-@returns \c true if \p object is a string value object.
+@returns #BT_TRUE if \p object is a string value object.
@prenotnull{object}
@postrefcountsame{object}
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_string(const struct bt_value *object)
+bt_bool bt_value_is_string(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
}
value object.
@param[in] object Value object to check.
-@returns \c true if \p object is an array value object.
+@returns #BT_TRUE if \p object is an array value object.
@prenotnull{object}
@postrefcountsame{object}
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_array(const struct bt_value *object)
+bt_bool bt_value_is_array(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY;
}
object.
@param[in] object Value object to check.
-@returns \c true if \p object is a map value object.
+@returns #BT_TRUE if \p object is a map value object.
@prenotnull{object}
@postrefcountsame{object}
@sa bt_value_get_type(): Returns the type of a given value object.
*/
static inline
-bool bt_value_is_map(const struct bt_value *object)
+bt_bool bt_value_is_map(const struct bt_value *object)
{
return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
}
@{
*/
-/**
-@brief Recursively freezes the value object \p object.
-
-You cannot modify a frozen value object: it is considered immutable.
-Reference counting still works on a frozen value object, however: you
-can pass a frozen value object to bt_get() and bt_put().
-
-If \p object is an array value object or a map value object, this
-function also freezes all its children recursively.
-
-Freezing a value object is typically used to make it immutable after
-it's built by its initial owner.
-
-@param[in] object Value object to freeze.
-@returns Status code. If \p object
- is already frozen, however, #BT_VALUE_STATUS_OK
- is returned anyway (that is, this function never
- returns #BT_VALUE_STATUS_FROZEN).
-
-@prenotnull{object}
-@postrefcountsame{object}
-@post <strong>On success</strong>, \p object and all its children
- are frozen.
-
-@sa bt_value_is_frozen(): Returns whether or not a value object is
- frozen.
-*/
-extern enum bt_value_status bt_value_freeze(struct bt_value *object);
-
-/**
-@brief Returns whether or not the value object \p object is frozen.
-
-@param[in] object Value object to check.
-@returns \c true if \p object is frozen.
-
-@prenotnull{object}
-@postrefcountsame{object}
-*/
-extern bool bt_value_is_frozen(const struct bt_value *object);
-
/**
@brief Creates a \em deep copy of the value object \p object.
/**
@brief Recursively compares the value objects \p object_a and
- \p object_b and returns \c true if they have the same
+ \p object_b and returns #BT_TRUE if they have the same
\em content (raw values).
@param[in] object_a Value object A to compare to \p object_b.
@param[in] object_b Value object B to compare to \p object_a.
-@returns \c true if \p object_a and \p object_b have the
- same \em content, or \c false if they differ
+@returns #BT_TRUE if \p object_a and \p object_b have the
+ same \em content, or #BT_FALSE if they differ
or on error.
@postrefcountsame{object_a}
@postrefcountsame{object_b}
*/
-extern bool bt_value_compare(const struct bt_value *object_a,
+extern bt_bool bt_value_compare(const struct bt_value *object_a,
const struct bt_value *object_b);
/** @} */
/**
@brief Creates a default boolean value object.
-The created boolean value object's initial raw value is \c false.
+The created boolean value object's initial raw value is #BT_FALSE.
@returns Created boolean value object on success, or \c NULL
on error.
@sa bt_value_bool_create(): Creates a default boolean value object.
*/
-extern struct bt_value *bt_value_bool_create_init(bool val);
+extern struct bt_value *bt_value_bool_create_init(bt_bool val);
/**
@brief Returns the boolean raw value of the boolean value object
@sa bt_value_bool_set(): Sets the raw value of a boolean value object.
*/
extern enum bt_value_status bt_value_bool_get(
- const struct bt_value *bool_obj, bool *val);
+ const struct bt_value *bool_obj, bt_bool *val);
/**
@brief Sets the boolean raw value of the boolean value object
value object.
*/
extern enum bt_value_status bt_value_bool_set(struct bt_value *bool_obj,
- bool val);
+ bt_bool val);
/** @} */
@sa bt_value_array_is_empty(): Checks whether or not a given array
value object is empty.
*/
-extern int bt_value_array_size(const struct bt_value *array_obj);
+extern int64_t bt_value_array_size(const struct bt_value *array_obj);
/**
@brief Checks whether or not the array value object \p array_obj
is empty.
@param[in] array_obj Array value object to check.
-@returns \c true if \p array_obj is empty.
+@returns #BT_TRUE if \p array_obj is empty.
@prenotnull{array_obj}
@pre \p array_obj is an array value object.
@sa bt_value_array_size(): Returns the size of a given array value
object.
*/
-extern bool bt_value_array_is_empty(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
\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,
- size_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
array value object.
*/
extern enum bt_value_status bt_value_array_append_bool(
- struct bt_value *array_obj, bool val);
+ struct bt_value *array_obj, bt_bool val);
/**
@brief Appends the integer raw value \p val to the array value object
@postrefcountsame{array_obj}
*/
extern enum bt_value_status bt_value_array_set(struct bt_value *array_obj,
- size_t index, struct bt_value *element_obj);
+ uint64_t index, struct bt_value *element_obj);
/** @} */
@sa bt_value_map_is_empty(): Checks whether or not a given map value
object is empty.
*/
-extern int bt_value_map_size(const struct bt_value *map_obj);
+extern int64_t bt_value_map_size(const struct bt_value *map_obj);
/**
@brief Checks whether or not the map value object \p map_obj is empty.
@param[in] map_obj Map value object to check.
-@returns \c true if \p map_obj is empty.
+@returns #BT_TRUE if \p map_obj is empty.
@prenotnull{map_obj}
@pre \p map_obj is a map value object.
@sa bt_value_map_size(): Returns the size of a given map value object.
*/
-extern bool bt_value_map_is_empty(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
@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().
\p object is a <em>weak reference</em>: you \em must pass it to bt_get()
if you need to keep a reference after this function returns.
-This function \em must return \c true to continue the map value object
-traversal, or \c false to break it.
+This function \em must return #BT_TRUE to continue the map value object
+traversal, or #BT_FALSE to break it.
@param[in] key Key of map entry.
@param[in] object Value object of map entry (weak reference).
@param[in] data User data.
-@returns \c true to continue the loop, or \c false to break it.
+@returns #BT_TRUE to continue the loop, or #BT_FALSE to break it.
@prenotnull{key}
@prenotnull{object}
@post The reference count of \p object is not lesser than what it is
when the function is called.
*/
-typedef bool (* bt_value_map_foreach_cb)(const char *key,
+typedef bt_bool (* bt_value_map_foreach_cb)(const char *key,
struct bt_value *object, void *data);
/**
The key passed to the user function is only valid in the scope of
this user function call.
-The user function \em must return \c true to continue the traversal of
-\p map_obj, or \c false to break it.
+The user function \em must return #BT_TRUE to continue the traversal of
+\p map_obj, or #BT_FALSE to break it.
@param[in] map_obj Map value object on which to iterate.
@param[in] cb User function to call back.
@param[in] data User data passed to the user function.
@returns Status code. More
- specifically, #BT_VALUE_STATUS_CANCELLED is
- returned if the loop was cancelled by the user
+ specifically, #BT_VALUE_STATUS_CANCELED is
+ returned if the loop was canceled by the user
function.
@prenotnull{map_obj}
@param[in] map_obj Map value object to check.
@param[in] key Key to check.
-@returns \c true if \p map_obj has an entry mapped to the
- key \p key, or \c false if it does not or
+@returns #BT_TRUE if \p map_obj has an entry mapped to the
+ key \p key, or #BT_FALSE if it does not or
on error.
@prenotnull{map_obj}
@pre \p map_obj is a map value object.
@postrefcountsame{map_obj}
*/
-extern bool bt_value_map_has_key(const struct bt_value *map_obj,
+extern bt_bool bt_value_map_has_key(const struct bt_value *map_obj,
const char *key);
/**
value object.
*/
extern enum bt_value_status bt_value_map_insert_bool(
- struct bt_value *map_obj, const char *key, bool val);
+ struct bt_value *map_obj, const char *key, bt_bool val);
/**
@brief Inserts the integer raw value \p val mapped to the key \p key
}
#endif
-#endif /* _BABELTRACE_VALUES_H */
+#endif /* BABELTRACE_VALUES_H */
projects / babeltrace.git / blobdiff