X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=include%2Fbabeltrace%2Fvalue-const.h;h=63368085792cd45268a5cca91cb7d6f077cea2ff;hb=2e90378a2b94006e2743b06e7fe7a1f0e691a56e;hp=6816d37d1f0a26c44d41dbbdc51b204f257b8a18;hpb=c6bd8523ba4a37b61a1591c03e23614112b155ba;p=babeltrace.git diff --git a/include/babeltrace/value-const.h b/include/babeltrace/value-const.h index 6816d37d..63368085 100644 --- a/include/babeltrace/value-const.h +++ b/include/babeltrace/value-const.h @@ -2,8 +2,7 @@ #define BABELTRACE_VALUES_CONST_H /* - * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation - * Copyright (c) 2015-2016 Philippe Proulx + * Copyright (c) 2015-2018 Philippe Proulx * * Permission is hereby granted, free of charge, to any person obtaining a copy * of this software and associated documentation files (the "Software"), to deal @@ -27,16 +26,14 @@ #include #include -/* For bt_bool */ +/* For bt_bool, bt_value */ #include #ifdef __cplusplus extern "C" { #endif -struct bt_value; - -enum bt_value_status { +typedef enum bt_value_status { /// Operation canceled. BT_VALUE_STATUS_CANCELED = 125, @@ -45,125 +42,153 @@ enum bt_value_status { /// Okay, no error. BT_VALUE_STATUS_OK = 0, -}; +} bt_value_status; -enum bt_value_type { +typedef enum bt_value_type { /// Null value object. - BT_VALUE_TYPE_NULL = 0, + BT_VALUE_TYPE_NULL = 0, /// Boolean value object (holds #BT_TRUE or #BT_FALSE). - BT_VALUE_TYPE_BOOL = 1, + BT_VALUE_TYPE_BOOL = 1, + + /// Unsigned integer value object (holds an unsigned 64-bit integer raw value). + BT_VALUE_TYPE_UNSIGNED_INTEGER = 2, - /// Integer value object (holds a signed 64-bit integer raw value). - BT_VALUE_TYPE_INTEGER = 2, + /// Signed integer value object (holds a signed 64-bit integer raw value). + BT_VALUE_TYPE_SIGNED_INTEGER = 3, /// Floating point number value object (holds a \c double raw value). - BT_VALUE_TYPE_REAL = 3, + BT_VALUE_TYPE_REAL = 4, /// String value object. - BT_VALUE_TYPE_STRING = 4, + BT_VALUE_TYPE_STRING = 5, /// Array value object. - BT_VALUE_TYPE_ARRAY = 5, + BT_VALUE_TYPE_ARRAY = 6, /// Map value object. - BT_VALUE_TYPE_MAP = 6, -}; + BT_VALUE_TYPE_MAP = 7, +} bt_value_type; -extern enum bt_value_type bt_value_get_type(const struct bt_value *object); +extern bt_value_type bt_value_get_type(const bt_value *object); static inline -bt_bool bt_value_is_null(const struct bt_value *object) +bt_bool bt_value_is_null(const bt_value *object) { return bt_value_get_type(object) == BT_VALUE_TYPE_NULL; } static inline -bt_bool bt_value_is_bool(const struct bt_value *object) +bt_bool bt_value_is_bool(const bt_value *object) { return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL; } static inline -bt_bool bt_value_is_integer(const struct bt_value *object) +bt_bool bt_value_is_unsigned_integer(const bt_value *object) +{ + return bt_value_get_type(object) == BT_VALUE_TYPE_UNSIGNED_INTEGER; +} + +static inline +bt_bool bt_value_is_signed_integer(const bt_value *object) { - return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER; + return bt_value_get_type(object) == BT_VALUE_TYPE_SIGNED_INTEGER; } static inline -bt_bool bt_value_is_real(const struct bt_value *object) +bt_bool bt_value_is_real(const bt_value *object) { return bt_value_get_type(object) == BT_VALUE_TYPE_REAL; } static inline -bt_bool bt_value_is_string(const struct bt_value *object) +bt_bool bt_value_is_string(const bt_value *object) { return bt_value_get_type(object) == BT_VALUE_TYPE_STRING; } static inline -bt_bool bt_value_is_array(const struct bt_value *object) +bt_bool bt_value_is_array(const bt_value *object) { return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY; } static inline -bt_bool bt_value_is_map(const struct bt_value *object) +bt_bool bt_value_is_map(const bt_value *object) { return bt_value_get_type(object) == BT_VALUE_TYPE_MAP; } -extern enum bt_value_status bt_value_copy(const struct bt_value *object, - struct bt_value **copy); +extern bt_value_status bt_value_copy(const bt_value *object, + bt_value **copy); -extern bt_bool bt_value_compare(const struct bt_value *object_a, - const struct bt_value *object_b); +extern bt_bool bt_value_compare(const bt_value *object_a, + const bt_value *object_b); -extern bt_bool bt_value_bool_get(const struct bt_value *bool_obj); +extern bt_bool bt_value_bool_get(const bt_value *bool_obj); -extern int64_t bt_value_integer_get(const struct bt_value *integer_obj); +extern uint64_t bt_value_unsigned_integer_get(const bt_value *integer_obj); -extern double bt_value_real_get(const struct bt_value *real_obj); +extern int64_t bt_value_signed_integer_get(const bt_value *integer_obj); -extern const char *bt_value_string_get(const struct bt_value *string_obj); +extern double bt_value_real_get(const bt_value *real_obj); -extern uint64_t bt_value_array_get_size(const struct bt_value *array_obj); +extern const char *bt_value_string_get(const bt_value *string_obj); + +extern uint64_t bt_value_array_get_size(const bt_value *array_obj); static inline -bt_bool bt_value_array_is_empty(const struct bt_value *array_obj) +bt_bool bt_value_array_is_empty(const bt_value *array_obj) { return bt_value_array_get_size(array_obj) == 0; } -extern const struct bt_value *bt_value_array_borrow_element_by_index_const( - const struct bt_value *array_obj, uint64_t index); +extern const bt_value *bt_value_array_borrow_element_by_index_const( + const bt_value *array_obj, uint64_t index); -extern uint64_t bt_value_map_get_size(const struct bt_value *map_obj); +extern uint64_t bt_value_map_get_size(const bt_value *map_obj); static inline -bt_bool bt_value_map_is_empty(const struct bt_value *map_obj) +bt_bool bt_value_map_is_empty(const bt_value *map_obj) { return bt_value_map_get_size(map_obj) == 0; } -extern const struct bt_value *bt_value_map_borrow_entry_value_const( - const struct bt_value *map_obj, const char *key); +extern const bt_value *bt_value_map_borrow_entry_value_const( + const bt_value *map_obj, const char *key); typedef bt_bool (* bt_value_map_foreach_entry_const_func)(const char *key, - const struct bt_value *object, void *data); + const bt_value *object, void *data); -extern enum bt_value_status bt_value_map_foreach_entry_const( - const struct bt_value *map_obj, +extern bt_value_status bt_value_map_foreach_entry_const( + const bt_value *map_obj, bt_value_map_foreach_entry_const_func func, void *data); -extern bt_bool bt_value_map_has_entry(const struct bt_value *map_obj, +extern bt_bool bt_value_map_has_entry(const bt_value *map_obj, const char *key); -extern enum bt_value_status bt_value_map_extend( - const struct bt_value *base_map_obj, - const struct bt_value *extension_map_obj, - struct bt_value **extended_map_obj); +extern bt_value_status bt_value_map_extend( + const bt_value *base_map_obj, + const bt_value *extension_map_obj, + bt_value **extended_map_obj); + +extern void bt_value_get_ref(const bt_value *value); + +extern void bt_value_put_ref(const bt_value *value); + +#define BT_VALUE_PUT_REF_AND_RESET(_var) \ + do { \ + bt_value_put_ref(_var); \ + (_var) = NULL; \ + } while (0) + +#define BT_VALUE_MOVE_REF(_var_dst, _var_src) \ + do { \ + bt_value_put_ref(_var_dst); \ + (_var_dst) = (_var_src); \ + (_var_src) = NULL; \ + } while (0) #ifdef __cplusplus }