bt2: Rename files to use singular form

[babeltrace.git] / bindings / python / bt2 / bt2 / native_bt_value.i

/*
 * The MIT License (MIT)
 *
 * Copyright (c) 2016 Philippe Proulx <pproulx@efficios.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */

/* From value-const.h */

typedef enum bt_value_status {
	/// Operation canceled.
	BT_VALUE_STATUS_CANCELED	= 125,

	/// Cannot allocate memory.
	BT_VALUE_STATUS_NOMEM		= -12,

	/// Okay, no error.
	BT_VALUE_STATUS_OK		= 0,
} bt_value_status;

typedef enum bt_value_type {
	/// Null value object.
	BT_VALUE_TYPE_NULL =		0,

	/// 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).
	BT_VALUE_TYPE_INTEGER =		2,

	/// Floating point number value object (holds a \c double raw value).
	BT_VALUE_TYPE_REAL =		3,

	/// String value object.
	BT_VALUE_TYPE_STRING =		4,

	/// Array value object.
	BT_VALUE_TYPE_ARRAY =		5,

	/// Map value object.
	BT_VALUE_TYPE_MAP =		6,
} bt_value_type;

extern bt_value_type bt_value_get_type(const bt_value *object);

bt_bool bt_value_is_null(const bt_value *object);

bt_bool bt_value_is_bool(const bt_value *object);

bt_bool bt_value_is_integer(const bt_value *object);

bt_bool bt_value_is_real(const bt_value *object);

bt_bool bt_value_is_string(const bt_value *object);

bt_bool bt_value_is_array(const bt_value *object);

bt_bool bt_value_is_map(const bt_value *object);

extern bt_value_status bt_value_copy(const bt_value *object,
		bt_value **OUT);

extern bt_bool bt_value_compare(const bt_value *object_a,
		const bt_value *object_b);

extern bt_bool bt_value_bool_get(const bt_value *bool_obj);

extern int64_t bt_value_integer_get(const bt_value *integer_obj);

extern double bt_value_real_get(const bt_value *real_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);

bt_bool bt_value_array_is_empty(const bt_value *array_obj);

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 bt_value *map_obj);

bt_bool bt_value_map_is_empty(const bt_value *map_obj);

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 bt_value *object, void *data);

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 bt_value *map_obj,
		const char *key);

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);

/* From value.h */

extern bt_value *const bt_value_null;

extern bt_value *bt_value_bool_create(void);

extern bt_value *bt_value_bool_create_init(bt_bool val);

extern void bt_value_bool_set(bt_value *bool_obj, bt_bool val);

extern bt_value *bt_value_integer_create(void);

extern bt_value *bt_value_integer_create_init(
		int64_t val);

extern void bt_value_integer_set(bt_value *integer_obj, int64_t val);

extern bt_value *bt_value_real_create(void);

extern bt_value *bt_value_real_create_init(double val);

extern void bt_value_real_set(bt_value *real_obj, double val);

extern bt_value *bt_value_string_create(void);

extern bt_value *bt_value_string_create_init(const char *val);

extern bt_value_status bt_value_string_set(bt_value *string_obj,
		const char *val);

extern bt_value *bt_value_array_create(void);

extern bt_value *bt_value_array_borrow_element_by_index(
		bt_value *array_obj, uint64_t index);

extern bt_value_status bt_value_array_append_element(
		bt_value *array_obj,
		bt_value *element_obj);

extern bt_value_status bt_value_array_append_bool_element(
		bt_value *array_obj, bt_bool val);

extern bt_value_status bt_value_array_append_integer_element(
		bt_value *array_obj, int64_t val);

extern bt_value_status bt_value_array_append_real_element(
		bt_value *array_obj, double val);

extern bt_value_status bt_value_array_append_string_element(
		bt_value *array_obj, const char *val);

extern bt_value_status bt_value_array_append_empty_array_element(
		bt_value *array_obj);

extern bt_value_status bt_value_array_append_empty_map_element(
		bt_value *array_obj);

extern bt_value_status bt_value_array_set_element_by_index(
		bt_value *array_obj, uint64_t index,
		bt_value *element_obj);

extern bt_value *bt_value_map_create(void);

extern bt_value *bt_value_map_borrow_entry_value(
		bt_value *map_obj, const char *key);

typedef bt_bool (* bt_value_map_foreach_entry_func)(const char *key,
		bt_value *object, void *data);

extern bt_value_status bt_value_map_foreach_entry(
		bt_value *map_obj,
		bt_value_map_foreach_entry_func func, void *data);

extern bt_value_status bt_value_map_insert_entry(
		bt_value *map_obj, const char *key,
		bt_value *element_obj);

extern bt_value_status bt_value_map_insert_bool_entry(
		bt_value *map_obj, const char *key, bt_bool val);

extern bt_value_status bt_value_map_insert_integer_entry(
		bt_value *map_obj, const char *key, int64_t val);

extern bt_value_status bt_value_map_insert_real_entry(
		bt_value *map_obj, const char *key, double val);

extern bt_value_status bt_value_map_insert_string_entry(
		bt_value *map_obj, const char *key,
		const char *val);

extern bt_value_status bt_value_map_insert_empty_array_entry(
		bt_value *map_obj, const char *key);

extern bt_value_status bt_value_map_insert_empty_map_entry(
		bt_value *map_obj, const char *key);

%{
struct bt_value_map_get_keys_data {
	struct bt_value *keys;
};

static int bt_value_map_get_keys_cb(const char *key, const struct bt_value *object, void *data)
{
	enum bt_value_status status;
	struct bt_value_map_get_keys_data *priv_data = data;

	status = bt_value_array_append_string_element(priv_data->keys, key);
	if (status != BT_VALUE_STATUS_OK) {
		return BT_FALSE;
	}

	return BT_TRUE;
}

static struct bt_value *bt_value_map_get_keys(const struct bt_value *map_obj)
{
	enum bt_value_status status;
	struct bt_value_map_get_keys_data data;

	data.keys = bt_value_array_create();
	if (!data.keys) {
		return NULL;
	}

	status = bt_value_map_foreach_entry_const(map_obj, bt_value_map_get_keys_cb,
		&data);
	if (status != BT_VALUE_STATUS_OK) {
		goto error;
	}

	goto end;

error:
	if (data.keys) {
		BT_VALUE_PUT_REF_AND_RESET(data.keys);
	}

end:
	return data.keys;
}
%}

struct bt_value *bt_value_map_get_keys(const struct bt_value *map_obj);