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

#ifndef BABELTRACE_VALUES_H
#define BABELTRACE_VALUES_H

/*
 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
 * Copyright (c) 2015-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.
 */

#include <stdint.h>
#include <stddef.h>

/* For bt_bool */
#include <babeltrace/types.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
@brief Status codes.
*/
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,
};

struct bt_value;
struct bt_private_value;

extern struct bt_value *bt_value_null;

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,
};

extern enum bt_value_type bt_value_get_type(const struct bt_value *object);

static inline
bt_bool bt_value_is_null(const struct 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)
{
	return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
}

static inline
bt_bool bt_value_is_integer(const struct bt_value *object)
{
	return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER;
}

static inline
bt_bool bt_value_is_real(const struct 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)
{
	return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
}

static inline
bt_bool bt_value_is_array(const struct 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)
{
	return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
}

extern enum bt_value_status bt_value_copy(struct bt_private_value **copy,
		const struct bt_value *object);

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

extern bt_bool bt_value_bool_get(const struct bt_value *bool_obj);

extern int64_t bt_value_integer_get(const struct bt_value *integer_obj);

extern double bt_value_real_get(const struct bt_value *real_obj);

extern const char *bt_value_string_get(const struct bt_value *string_obj);

extern uint64_t bt_value_array_get_size(const struct bt_value *array_obj);

static inline
bt_bool bt_value_array_is_empty(const struct bt_value *array_obj)
{
	return bt_value_array_get_size(array_obj) == 0;
}

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

extern uint64_t bt_value_map_get_size(const struct bt_value *map_obj);

static inline
bt_bool bt_value_map_is_empty(const struct bt_value *map_obj)
{
	return bt_value_map_get_size(map_obj) == 0;
}

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

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

extern enum bt_value_status bt_value_map_foreach_entry(
		const struct bt_value *map_obj,
		bt_value_map_foreach_entry_cb cb, void *data);

extern bt_bool bt_value_map_has_entry(const struct bt_value *map_obj,
		const char *key);

extern enum bt_value_status bt_value_map_extend(
		struct bt_private_value **extended_map_obj,
		const struct bt_value *base_map_obj,
		const struct bt_value *extension_map_obj);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_VALUES_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_VALUES_H
	2	#define BABELTRACE_VALUES_H
	3
	4	/*
	5	* Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
	6	* Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
	7	*
	8	* Permission is hereby granted, free of charge, to any person obtaining a copy
	9	* of this software and associated documentation files (the "Software"), to deal
	10	* in the Software without restriction, including without limitation the rights
	11	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	12	* copies of the Software, and to permit persons to whom the Software is
	13	* furnished to do so, subject to the following conditions:
	14	*
	15	* The above copyright notice and this permission notice shall be included in
	16	* all copies or substantial portions of the Software.
	17	*
	18	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	19	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	20	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	21	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	22	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	23	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	24	* SOFTWARE.
	25	*/
	26
	27	#include <stdint.h>
	28	#include <stddef.h>
	29
	30	/* For bt_bool */
	31	#include <babeltrace/types.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	/**
	38	@brief Status codes.
	39	*/
	40	enum bt_value_status {
	41	/// Operation canceled.
	42	BT_VALUE_STATUS_CANCELED = 125,
	43
	44	/// Cannot allocate memory.
	45	BT_VALUE_STATUS_NOMEM = -12,
	46
	47	/// Okay, no error.
	48	BT_VALUE_STATUS_OK = 0,
	49	};
	50
	51	struct bt_value;
	52	struct bt_private_value;
	53
	54	extern struct bt_value *bt_value_null;
	55
	56	enum bt_value_type {
	57	/// Null value object.
	58	BT_VALUE_TYPE_NULL = 0,
	59
	60	/// Boolean value object (holds #BT_TRUE or #BT_FALSE).
	61	BT_VALUE_TYPE_BOOL = 1,
	62
	63	/// Integer value object (holds a signed 64-bit integer raw value).
	64	BT_VALUE_TYPE_INTEGER = 2,
	65
	66	/// Floating point number value object (holds a \c double raw value).
	67	BT_VALUE_TYPE_REAL = 3,
	68
	69	/// String value object.
	70	BT_VALUE_TYPE_STRING = 4,
	71
	72	/// Array value object.
	73	BT_VALUE_TYPE_ARRAY = 5,
	74
	75	/// Map value object.
	76	BT_VALUE_TYPE_MAP = 6,
	77	};
	78
	79	extern enum bt_value_type bt_value_get_type(const struct bt_value *object);
	80
	81	static inline
	82	bt_bool bt_value_is_null(const struct bt_value *object)
	83	{
	84	return bt_value_get_type(object) == BT_VALUE_TYPE_NULL;
	85	}
	86
	87	static inline
	88	bt_bool bt_value_is_bool(const struct bt_value *object)
	89	{
	90	return bt_value_get_type(object) == BT_VALUE_TYPE_BOOL;
	91	}
	92
	93	static inline
	94	bt_bool bt_value_is_integer(const struct bt_value *object)
	95	{
	96	return bt_value_get_type(object) == BT_VALUE_TYPE_INTEGER;
	97	}
	98
	99	static inline
	100	bt_bool bt_value_is_real(const struct bt_value *object)
	101	{
	102	return bt_value_get_type(object) == BT_VALUE_TYPE_REAL;
	103	}
	104
	105	static inline
	106	bt_bool bt_value_is_string(const struct bt_value *object)
	107	{
	108	return bt_value_get_type(object) == BT_VALUE_TYPE_STRING;
	109	}
	110
	111	static inline
	112	bt_bool bt_value_is_array(const struct bt_value *object)
	113	{
	114	return bt_value_get_type(object) == BT_VALUE_TYPE_ARRAY;
	115	}
	116
	117	static inline
	118	bt_bool bt_value_is_map(const struct bt_value *object)
	119	{
	120	return bt_value_get_type(object) == BT_VALUE_TYPE_MAP;
	121	}
	122
	123	extern enum bt_value_status bt_value_copy(struct bt_private_value **copy,
	124	const struct bt_value *object);
	125
	126	extern bt_bool bt_value_compare(const struct bt_value *object_a,
	127	const struct bt_value *object_b);
	128
	129	extern bt_bool bt_value_bool_get(const struct bt_value *bool_obj);
	130
	131	extern int64_t bt_value_integer_get(const struct bt_value *integer_obj);
	132
	133	extern double bt_value_real_get(const struct bt_value *real_obj);
	134
	135	extern const char bt_value_string_get(const struct bt_value string_obj);
	136
	137	extern uint64_t bt_value_array_get_size(const struct bt_value *array_obj);
	138
	139	static inline
	140	bt_bool bt_value_array_is_empty(const struct bt_value *array_obj)
	141	{
	142	return bt_value_array_get_size(array_obj) == 0;
	143	}
	144
	145	extern struct bt_value *bt_value_array_borrow_element_by_index(
	146	const struct bt_value *array_obj, uint64_t index);
	147
	148	extern uint64_t bt_value_map_get_size(const struct bt_value *map_obj);
	149
	150	static inline
	151	bt_bool bt_value_map_is_empty(const struct bt_value *map_obj)
	152	{
	153	return bt_value_map_get_size(map_obj) == 0;
	154	}
	155
	156	extern struct bt_value *bt_value_map_borrow_entry_value(
	157	const struct bt_value map_obj, const char key);
	158
	159	typedef bt_bool (* bt_value_map_foreach_entry_cb)(const char *key,
	160	struct bt_value object, void data);
	161
	162	extern enum bt_value_status bt_value_map_foreach_entry(
	163	const struct bt_value *map_obj,
	164	bt_value_map_foreach_entry_cb cb, void *data);
	165
	166	extern bt_bool bt_value_map_has_entry(const struct bt_value *map_obj,
	167	const char *key);
	168
	169	extern enum bt_value_status bt_value_map_extend(
	170	struct bt_private_value **extended_map_obj,
	171	const struct bt_value *base_map_obj,
	172	const struct bt_value *extension_map_obj);
	173
	174	#ifdef __cplusplus
	175	}
	176	#endif
	177
	178	#endif /* BABELTRACE_VALUES_H */