7 #ifndef BABELTRACE2_VALUE_H
8 #define BABELTRACE2_VALUE_H
12 #ifndef __BT_IN_BABELTRACE_H
13 # error "Please include <babeltrace2/babeltrace.h> instead."
19 #include <babeltrace2/types.h>
375 return (type & other_type) == other_type;
750 uint64_t raw_value) __BT_NOEXCEPT;
1006 const char *raw_value) __BT_NOEXCEPT;
1170 uint64_t raw_value) __BT_NOEXCEPT;
1201 int64_t raw_value) __BT_NOEXCEPT;
1295 bt_value **element_value) __BT_NOEXCEPT;
1330 bt_value **element_value) __BT_NOEXCEPT;
1389 bt_value *element_value) __BT_NOEXCEPT;
1419 uint64_t index) __BT_NOEXCEPT;
1429 const bt_value *value, uint64_t index) __BT_NOEXCEPT;
1562 bt_value *entry_value) __BT_NOEXCEPT;
1632 uint64_t raw_value) __BT_NOEXCEPT;
1667 int64_t raw_value) __BT_NOEXCEPT;
1701 bt_value *value,
const char *key,
double raw_value)
1737 const char *raw_value) __BT_NOEXCEPT;
1776 bt_value **entry_value) __BT_NOEXCEPT;
1815 bt_value **entry_value) __BT_NOEXCEPT;
1849 bt_value *value,
const char *key) __BT_NOEXCEPT;
1859 const bt_value *value,
const char *key) __BT_NOEXCEPT;
2014 void *user_data) __BT_NOEXCEPT;
2078 const bt_value *value,
void *user_data);
2129 void *user_data) __BT_NOEXCEPT;
2192 const char *key) __BT_NOEXCEPT;
2331 bt_value **copy_value) __BT_NOEXCEPT;
2354 const bt_value *b_value) __BT_NOEXCEPT;
2411 #define BT_VALUE_PUT_REF_AND_RESET(_value) \
2413 bt_value_put_ref(_value); \
2442 #define BT_VALUE_MOVE_REF(_dst, _src) \
2444 bt_value_put_ref(_dst); \
const bt_value * bt_value_map_borrow_entry_value_const(const bt_value *value, const char *key)
Borrows the value of the entry with the key key in the map value value (const version).
Out of memory.
Definition: value.h:1952
bt_value_map_foreach_entry_const_func_status
Status codes for bt_value_map_foreach_entry_const_func.
Definition: value.h:2020
bt_value_array_append_element_status bt_value_array_append_empty_map_element(bt_value *value, bt_value **element_value)
Creates an empty map value and appends it to the array value value.
Out of memory.
Definition: value.h:2209
bt_value_copy_status bt_value_copy(const bt_value *value, bt_value **copy_value)
Deep-copies a value object.
Boolean value.
Definition: value.h:245
Null value.
Definition: value.h:239
Integer value.
Definition: value.h:253
uint64_t bt_value_integer_unsigned_get(const bt_value *value)
Returns the raw value of the unsigned integer value value.
static bt_bool bt_value_is_real(const bt_value *value)
Returns whether or not the value value is a real value.
Definition: value.h:502
bt_value_map_insert_entry_status bt_value_map_insert_entry(bt_value *value, const char *key, bt_value *entry_value)
Inserts or replaces an entry with the key key and the value entry_value in the map value value...
bt_value_array_append_element_status bt_value_array_append_bool_element(bt_value *value, bt_bool raw_value)
Creates a boolean value initialized to raw_value and appends it to the array value value...
bt_value * bt_value_string_create(void)
Creates and returns an empty string value.
int64_t bt_value_integer_signed_get(const bt_value *value)
Returns the raw value of the signed integer value value.
bt_bool bt_value_map_has_entry(const bt_value *value, const char *key)
Returns whether or not the map value value has an entry with the key key.
Out of memory.
Definition: value.h:978
Array value.
Definition: value.h:287
static bt_bool bt_value_is_bool(const bt_value *value)
Returns whether or not the value value is a boolean value.
Definition: value.h:428
Success.
Definition: value.h:2203
bt_value_map_insert_entry_status bt_value_map_insert_unsigned_integer_entry(bt_value *value, const char *key, uint64_t raw_value)
Creates an unsigned integer value initialized to raw_value and inserts or replaces an entry with the ...
bt_value_array_append_element_status bt_value_array_append_element(bt_value *value, bt_value *element_value)
Appends the value element_value to the array value value.
static bt_bool bt_value_array_is_empty(const bt_value *value)
Returns whether or not the array value value is empty.
Definition: value.h:1466
uint64_t bt_value_map_get_size(const bt_value *value)
Returns the size of the map value value.
void bt_value_integer_unsigned_set(bt_value *value, uint64_t raw_value)
Sets the raw value of the unsigned integer value value to raw_value.
bt_bool bt_value_bool_get(const bt_value *value)
Returns the raw value of the boolean value value.
User function interrupted the iteration process.
Definition: value.h:2095
bt_value * bt_value_bool_create_init(bt_bool raw_value)
Creates and returns a boolean value initialized to raw_value.
User function interrupted the iteration process.
Definition: value.h:1940
bt_value * bt_value_integer_signed_create(void)
Creates and returns a signed integer value initialized to 0.
bt_value * bt_value_integer_unsigned_create_init(uint64_t raw_value)
Creates and returns an unsigned integer value initialized to raw_value.
bt_value * bt_value_real_create(void)
Creates and returns a real value initialized to 0.
const char * bt_value_string_get(const bt_value *value)
Returns the raw value of the string value value.
Interrupt the iteration process.
Definition: value.h:1876
bt_value_type
Value type enumerators.
Definition: value.h:234
bt_value * bt_value_real_create_init(double raw_value)
Creates and returns a real value initialized to raw_value.
bt_value_array_append_element_status bt_value_array_append_real_element(bt_value *value, double raw_value)
Creates a real value initialized to raw_value and appends it to the array value value.
Interrupt the iteration process.
Definition: value.h:2031
Unsigned integer value.
Definition: value.h:261
void bt_value_bool_set(bt_value *value, bt_bool raw_value)
Sets the raw value of the boolean value value to raw_value.
bt_value_map_extend_status bt_value_map_extend(bt_value *value, const bt_value *extension_value)
Extends the map value value with the map value extension_value.
bt_value_string_set_status
Status codes for bt_value_string_set().
Definition: value.h:967
bt_value * bt_value_map_borrow_entry_value(bt_value *value, const char *key)
Borrows the value of the entry with the key key in the map value value.
Out of memory.
Definition: value.h:2037
double bt_value_real_get(const bt_value *value)
Returns the raw value of the real value value.
void bt_value_put_ref(const bt_value *value)
Decrements the reference count of the value value.
bt_value_type bt_value_get_type(const bt_value *value)
Returns the type enumerator of the value value.
void bt_value_real_set(bt_value *value, double raw_value)
Sets the raw value of the real value value to raw_value.
Out of memory.
Definition: value.h:1504
bt_value_map_foreach_entry_const_status bt_value_map_foreach_entry_const(const bt_value *value, bt_value_map_foreach_entry_const_func user_func, void *user_data)
Iterates the entries of the map value value, calling user_func for each entry (const version)...
bt_value_array_append_element_status
Status codes for the bt_value_array_append_*() functions.
Definition: value.h:1053
static bt_bool bt_value_is_null(const bt_value *value)
Returns whether or not the value value is a null value.
Definition: value.h:404
Out of memory.
Definition: value.h:1064
Success.
Definition: value.h:1058
bt_value_array_append_element_status bt_value_array_append_signed_integer_element(bt_value *value, int64_t raw_value)
Creates a signed integer value initialized to raw_value and appends it to the array value value...
Out of memory.
Definition: value.h:1347
bt_value_map_insert_entry_status
Status codes for the bt_value_map_insert_*() functions.
Definition: value.h:1493
bt_value_map_foreach_entry_func_status(* bt_value_map_foreach_entry_func)(const char *key, bt_value *value, void *user_data)
User function for bt_value_map_foreach_entry().
Definition: value.h:1922
Other error.
Definition: value.h:2113
Success.
Definition: value.h:1934
bt_value_map_extend_status
Status codes for bt_value_map_extend().
Definition: value.h:2198
uint64_t bt_value_array_get_length(const bt_value *value)
Returns the length of the array value value.
Success.
Definition: value.h:972
bt_value_map_insert_entry_status bt_value_map_insert_empty_map_entry(bt_value *value, const char *key, bt_value **entry_value)
Creates an empty map value and inserts or replaces an entry with the key key and this value in the ma...
bt_value_map_insert_entry_status bt_value_map_insert_empty_array_entry(bt_value *value, const char *key, bt_value **entry_value)
Creates an empty array value and inserts or replaces an entry with the key key and this value in the ...
bt_value_array_set_element_by_index_status
Status codes for bt_value_array_set_element_by_index().
Definition: value.h:1336
bt_value * bt_value_array_create(void)
Creates and returns an empty array value.
struct bt_value bt_value
Value.
Definition: types.h:93
Out of memory.
Definition: value.h:2302
User function error.
Definition: value.h:2101
String value.
Definition: value.h:281
bt_value_map_insert_entry_status bt_value_map_insert_bool_entry(bt_value *value, const char *key, bt_bool raw_value)
Creates a boolean value initialized to raw_value and inserts or replaces an entry with the key key an...
Map value.
Definition: value.h:293
Success.
Definition: value.h:2296
bt_value_map_insert_entry_status bt_value_map_insert_real_entry(bt_value *value, const char *key, double raw_value)
Creates a real value initialized to raw_value and inserts or replaces an entry with the key key and t...
int bt_bool
Babeltrace 2 boolean type.
Definition: types.h:126
bt_value_array_set_element_by_index_status bt_value_array_set_element_by_index(bt_value *value, uint64_t index, bt_value *element_value)
Sets the element of the array value value at index index to the value element_value.
bt_value_array_append_element_status bt_value_array_append_string_element(bt_value *value, const char *raw_value)
Creates a string value initialized to a copy of raw_value and appends it to the array value value...
bt_value_map_insert_entry_status bt_value_map_insert_signed_integer_entry(bt_value *value, const char *key, int64_t raw_value)
Creates a signed integer value initialized to raw_value and inserts or replaces an entry with the key...
static bt_bool bt_value_type_is(const bt_value_type type, const bt_value_type other_type)
Returns whether or not the value type type conceptually is the value type other_type.
Definition: value.h:372
Success.
Definition: value.h:2025
bt_value_string_set_status bt_value_string_set(bt_value *value, const char *raw_value)
Sets the raw value of the string value value to a copy of raw_value.
static bt_bool bt_value_is_map(const bt_value *value)
Returns whether or not the value value is a map value.
Definition: value.h:574
void bt_value_get_ref(const bt_value *value)
Increments the reference count of the value value.
bt_value * bt_value_map_create(void)
Creates and returns an empty map value.
bt_value_map_foreach_entry_const_status
Status codes for bt_value_map_foreach_entry_const().
Definition: value.h:2084
Success.
Definition: value.h:2089
bt_value_map_insert_entry_status bt_value_map_insert_string_entry(bt_value *value, const char *key, const char *raw_value)
Creates a string value initialized to a copy of raw_value and inserts or replaces an entry with the k...
bt_value_array_append_element_status bt_value_array_append_unsigned_integer_element(bt_value *value, uint64_t raw_value)
Creates an unsigned integer value initialized to raw_value and appends it to the array value value...
bt_value * bt_value_integer_signed_create_init(int64_t raw_value)
Creates and returns a signed integer value initialized to raw_value.
Out of memory.
Definition: value.h:2107
static bt_bool bt_value_map_is_empty(const bt_value *value)
Returns whether or not the map value value is empty.
Definition: value.h:2166
bt_value * bt_value_integer_unsigned_create(void)
Creates and returns an unsigned integer value initialized to 0.
const bt_value * bt_value_array_borrow_element_by_index_const(const bt_value *value, uint64_t index)
Borrows the element at index index from the array value value (const version).
Other error.
Definition: value.h:1958
bt_value_map_foreach_entry_func_status
Status codes for bt_value_map_foreach_entry_func.
Definition: value.h:1865
bt_value * bt_value_array_borrow_element_by_index(bt_value *value, uint64_t index)
Borrows the element at index index from the array value value.
User error.
Definition: value.h:2043
Success.
Definition: value.h:1341
bt_value * bt_value_string_create_init(const char *raw_value)
Creates and returns a string value initialized to a copy of raw_value.
Out of memory.
Definition: value.h:1882
static bt_bool bt_value_is_string(const bt_value *value)
Returns whether or not the value value is a string value.
Definition: value.h:526
static bt_bool bt_value_is_signed_integer(const bt_value *value)
Returns whether or not the value value is a signed integer value.
Definition: value.h:478
bt_value * bt_value_bool_create(void)
Creates and returns a boolean value initialized to BT_FALSE.
Signed integer value.
Definition: value.h:269
bt_value_map_foreach_entry_status bt_value_map_foreach_entry(bt_value *value, bt_value_map_foreach_entry_func user_func, void *user_data)
Iterates the entries of the map value value, calling user_func for each entry.
User function error.
Definition: value.h:1946
bt_value_copy_status
Status codes for bt_value_copy().
Definition: value.h:2291
bt_value *const bt_value_null
The null value singleton.
bt_value_map_foreach_entry_const_func_status(* bt_value_map_foreach_entry_const_func)(const char *key, const bt_value *value, void *user_data)
User function for bt_value_map_foreach_entry_const_func().
Definition: value.h:2077
bt_bool bt_value_is_equal(const bt_value *a_value, const bt_value *b_value)
Returns whether or not the value a_value is equal, recursively, to b_value.
Success.
Definition: value.h:1870
static bt_bool bt_value_is_unsigned_integer(const bt_value *value)
Returns whether or not the value value is an unsigned integer value.
Definition: value.h:453
bt_value_map_foreach_entry_status
Status codes for bt_value_map_foreach_entry().
Definition: value.h:1929
void bt_value_integer_signed_set(bt_value *value, int64_t raw_value)
Sets the raw value of the signed integer value value to raw_value.
User error.
Definition: value.h:1888
bt_value_array_append_element_status bt_value_array_append_empty_array_element(bt_value *value, bt_value **element_value)
Creates an empty array value and appends it to the array value value.
Real value.
Definition: value.h:275
static bt_bool bt_value_is_array(const bt_value *value)
Returns whether or not the value value is an array value.
Definition: value.h:550
Success.
Definition: value.h:1498