[babeltrace.git] / include / babeltrace2 / value.h

#ifndef BABELTRACE_VALUES_H
#define BABELTRACE_VALUES_H

/*
 * Copyright (c) 2015-2018 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, bt_value */
#include <babeltrace2/types.h>

/* For bt_value_type */
#include <babeltrace2/value-const.h>

/* For __BT_FUNC_STATUS_* */
#define __BT_FUNC_STATUS_ENABLE
#include <babeltrace2/func-status.h>
#undef __BT_FUNC_STATUS_ENABLE

#ifdef __cplusplus
extern "C" {
#endif

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_unsigned_integer_create(void);

extern bt_value *bt_value_unsigned_integer_create_init(uint64_t val);

extern void bt_value_unsigned_integer_set(bt_value *integer_obj, uint64_t val);

extern bt_value *bt_value_signed_integer_create(void);

extern bt_value *bt_value_signed_integer_create_init(int64_t val);

extern void bt_value_signed_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);

typedef enum bt_value_string_set_status {
	BT_VALUE_STRING_SET_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_VALUE_STRING_SET_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_value_string_set_status;

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

typedef enum bt_value_array_append_element_status {
	BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK			= __BT_FUNC_STATUS_OK,
} bt_value_array_append_element_status;

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

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

extern bt_value_array_append_element_status
bt_value_array_append_unsigned_integer_element(bt_value *array_obj,
		uint64_t val);

extern bt_value_array_append_element_status
bt_value_array_append_signed_integer_element(bt_value *array_obj, int64_t val);

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

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

extern bt_value_array_append_element_status
bt_value_array_append_empty_array_element(bt_value *array_obj);

extern bt_value_array_append_element_status
bt_value_array_append_empty_map_element(bt_value *array_obj);

typedef enum bt_value_array_set_element_by_index_status {
	BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_value_array_set_element_by_index_status;

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

typedef enum bt_value_map_foreach_entry_status {
	BT_VALUE_MAP_FOREACH_ENTRY_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_VALUE_MAP_FOREACH_ENTRY_STATUS_OK		= __BT_FUNC_STATUS_OK,
	BT_VALUE_MAP_FOREACH_ENTRY_STATUS_CANCELED	= __BT_FUNC_STATUS_CANCELED,
} bt_value_map_foreach_entry_status;

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

typedef enum bt_value_map_insert_entry_status {
	BT_VALUE_MAP_INSERT_ENTRY_STATUS_MEMORY_ERROR	= __BT_FUNC_STATUS_MEMORY_ERROR,
	BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK		= __BT_FUNC_STATUS_OK,
} bt_value_map_insert_entry_status;

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

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

extern bt_value_map_insert_entry_status
bt_value_map_insert_unsigned_integer_entry(bt_value *map_obj, const char *key,
		uint64_t val);

extern bt_value_map_insert_entry_status
bt_value_map_insert_signed_integer_entry(bt_value *map_obj, const char *key,
		int64_t val);

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

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

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

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

#ifdef __cplusplus
}
#endif

#include <babeltrace2/undef-func-status.h>

#endif /* BABELTRACE_VALUES_H */
Commit	Line	Data
	1	#ifndef BABELTRACE_VALUES_H
	2	#define BABELTRACE_VALUES_H
	3
	4	/*
	5	* Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
	6	*
	7	* Permission is hereby granted, free of charge, to any person obtaining a copy
	8	* of this software and associated documentation files (the "Software"), to deal
	9	* in the Software without restriction, including without limitation the rights
	10	* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
	11	* copies of the Software, and to permit persons to whom the Software is
	12	* furnished to do so, subject to the following conditions:
	13	*
	14	* The above copyright notice and this permission notice shall be included in
	15	* all copies or substantial portions of the Software.
	16	*
	17	* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
	18	* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
	19	* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
	20	* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
	21	* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
	22	* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
	23	* SOFTWARE.
	24	*/
	25
	26	#include <stdint.h>
	27	#include <stddef.h>
	28
	29	/* For bt_bool, bt_value */
	30	#include <babeltrace2/types.h>
	31
	32	/* For bt_value_type */
	33	#include <babeltrace2/value-const.h>
	34
	35	/* For __BT_FUNC_STATUS_* */
	36	#define __BT_FUNC_STATUS_ENABLE
	37	#include <babeltrace2/func-status.h>
	38	#undef __BT_FUNC_STATUS_ENABLE
	39
	40	#ifdef __cplusplus
	41	extern "C" {
	42	#endif
	43
	44	extern bt_value *const bt_value_null;
	45
	46	extern bt_value *bt_value_bool_create(void);
	47
	48	extern bt_value *bt_value_bool_create_init(bt_bool val);
	49
	50	extern void bt_value_bool_set(bt_value *bool_obj, bt_bool val);
	51
	52	extern bt_value *bt_value_unsigned_integer_create(void);
	53
	54	extern bt_value *bt_value_unsigned_integer_create_init(uint64_t val);
	55
	56	extern void bt_value_unsigned_integer_set(bt_value *integer_obj, uint64_t val);
	57
	58	extern bt_value *bt_value_signed_integer_create(void);
	59
	60	extern bt_value *bt_value_signed_integer_create_init(int64_t val);
	61
	62	extern void bt_value_signed_integer_set(bt_value *integer_obj, int64_t val);
	63
	64	extern bt_value *bt_value_real_create(void);
	65
	66	extern bt_value *bt_value_real_create_init(double val);
	67
	68	extern void bt_value_real_set(bt_value *real_obj, double val);
	69
	70	extern bt_value *bt_value_string_create(void);
	71
	72	extern bt_value bt_value_string_create_init(const char val);
	73
	74	typedef enum bt_value_string_set_status {
	75	BT_VALUE_STRING_SET_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	76	BT_VALUE_STRING_SET_STATUS_OK = __BT_FUNC_STATUS_OK,
	77	} bt_value_string_set_status;
	78
	79	extern bt_value_string_set_status bt_value_string_set(bt_value *string_obj,
	80	const char *val);
	81
	82	extern bt_value *bt_value_array_create(void);
	83
	84	extern bt_value bt_value_array_borrow_element_by_index(bt_value array_obj,
	85	uint64_t index);
	86
	87	typedef enum bt_value_array_append_element_status {
	88	BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	89	BT_VALUE_ARRAY_APPEND_ELEMENT_STATUS_OK = __BT_FUNC_STATUS_OK,
	90	} bt_value_array_append_element_status;
	91
	92	extern bt_value_array_append_element_status bt_value_array_append_element(
	93	bt_value array_obj, bt_value element_obj);
	94
	95	extern bt_value_array_append_element_status
	96	bt_value_array_append_bool_element(bt_value *array_obj, bt_bool val);
	97
	98	extern bt_value_array_append_element_status
	99	bt_value_array_append_unsigned_integer_element(bt_value *array_obj,
	100	uint64_t val);
	101
	102	extern bt_value_array_append_element_status
	103	bt_value_array_append_signed_integer_element(bt_value *array_obj, int64_t val);
	104
	105	extern bt_value_array_append_element_status
	106	bt_value_array_append_real_element(bt_value *array_obj, double val);
	107
	108	extern bt_value_array_append_element_status
	109	bt_value_array_append_string_element(bt_value array_obj, const char val);
	110
	111	extern bt_value_array_append_element_status
	112	bt_value_array_append_empty_array_element(bt_value *array_obj);
	113
	114	extern bt_value_array_append_element_status
	115	bt_value_array_append_empty_map_element(bt_value *array_obj);
	116
	117	typedef enum bt_value_array_set_element_by_index_status {
	118	BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	119	BT_VALUE_ARRAY_SET_ELEMENT_BY_INDEX_STATUS_OK = __BT_FUNC_STATUS_OK,
	120	} bt_value_array_set_element_by_index_status;
	121
	122	extern bt_value_array_set_element_by_index_status
	123	bt_value_array_set_element_by_index(bt_value *array_obj, uint64_t index,
	124	bt_value *element_obj);
	125
	126	extern bt_value *bt_value_map_create(void);
	127
	128	extern bt_value *bt_value_map_borrow_entry_value(
	129	bt_value map_obj, const char key);
	130
	131	typedef bt_bool (* bt_value_map_foreach_entry_func)(const char *key,
	132	bt_value object, void data);
	133
	134	typedef enum bt_value_map_foreach_entry_status {
	135	BT_VALUE_MAP_FOREACH_ENTRY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	136	BT_VALUE_MAP_FOREACH_ENTRY_STATUS_OK = __BT_FUNC_STATUS_OK,
	137	BT_VALUE_MAP_FOREACH_ENTRY_STATUS_CANCELED = __BT_FUNC_STATUS_CANCELED,
	138	} bt_value_map_foreach_entry_status;
	139
	140	extern bt_value_map_foreach_entry_status bt_value_map_foreach_entry(
	141	bt_value *map_obj, bt_value_map_foreach_entry_func func,
	142	void *data);
	143
	144	typedef enum bt_value_map_insert_entry_status {
	145	BT_VALUE_MAP_INSERT_ENTRY_STATUS_MEMORY_ERROR = __BT_FUNC_STATUS_MEMORY_ERROR,
	146	BT_VALUE_MAP_INSERT_ENTRY_STATUS_OK = __BT_FUNC_STATUS_OK,
	147	} bt_value_map_insert_entry_status;
	148
	149	extern bt_value_map_insert_entry_status bt_value_map_insert_entry(
	150	bt_value map_obj, const char key, bt_value *element_obj);
	151
	152	extern bt_value_map_insert_entry_status bt_value_map_insert_bool_entry(
	153	bt_value map_obj, const char key, bt_bool val);
	154
	155	extern bt_value_map_insert_entry_status
	156	bt_value_map_insert_unsigned_integer_entry(bt_value map_obj, const char key,
	157	uint64_t val);
	158
	159	extern bt_value_map_insert_entry_status
	160	bt_value_map_insert_signed_integer_entry(bt_value map_obj, const char key,
	161	int64_t val);
	162
	163	extern bt_value_map_insert_entry_status bt_value_map_insert_real_entry(
	164	bt_value map_obj, const char key, double val);
	165
	166	extern bt_value_map_insert_entry_status
	167	bt_value_map_insert_string_entry(bt_value map_obj, const char key,
	168	const char *val);
	169
	170	extern bt_value_map_insert_entry_status
	171	bt_value_map_insert_empty_array_entry(bt_value map_obj, const char key);
	172
	173	extern bt_value_map_insert_entry_status
	174	bt_value_map_insert_empty_map_entry(bt_value map_obj, const char key);
	175
	176	#ifdef __cplusplus
	177	}
	178	#endif
	179
	180	#include <babeltrace2/undef-func-status.h>
	181
	182	#endif /* BABELTRACE_VALUES_H */