[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-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 */
#include <babeltrace/types.h>

/* For enum bt_value_status, enum bt_value_type */
#include <babeltrace/values-const.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_value;

extern struct bt_value *bt_value_null;

extern struct bt_value *bt_value_bool_create(void);

extern struct bt_value *bt_value_bool_create_init(bt_bool val);

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

extern struct bt_value *bt_value_integer_create(void);

extern struct bt_value *bt_value_integer_create_init(
		int64_t val);

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

extern struct bt_value *bt_value_real_create(void);

extern struct bt_value *bt_value_real_create_init(double val);

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

extern struct bt_value *bt_value_string_create(void);

extern struct bt_value *bt_value_string_create_init(const char *val);

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

extern struct bt_value *bt_value_array_create(void);

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

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

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

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

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

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

extern enum bt_value_status bt_value_array_append_empty_array_element(
		struct bt_value *array_obj);

extern enum bt_value_status bt_value_array_append_empty_map_element(
		struct bt_value *array_obj);

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

extern struct bt_value *bt_value_map_create(void);

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

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

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

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

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

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

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

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

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

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

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_VALUES_H */
Commit	Line	Data
1ca80abd PP	1	#ifndef BABELTRACE_VALUES_H
1ca80abd PP	2	#define BABELTRACE_VALUES_H
dac5c838 PP	3
dac5c838 PP	4	/*
de079588	5	* Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
05e21286	6	* Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
dac5c838 PP	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
dac5c838	27	#include <stdint.h>
dac5c838	28	#include <stddef.h>
9d408fca PP	29
9d408fca PP	30	/* For bt_bool */
c55a9f58	31	#include <babeltrace/types.h>
dac5c838	32
40f4ba76 PP	33	/* For enum bt_value_status, enum bt_value_type */
	34	#include <babeltrace/values-const.h>
	35
dac5c838 PP	36	#ifdef __cplusplus
	37	extern "C" {
	38	#endif
	39
05e21286	40	struct bt_value;
dac5c838	41
05e21286	42	extern struct bt_value *bt_value_null;
dac5c838	43
05e21286	44	extern struct bt_value *bt_value_bool_create(void);
dac5c838	45
05e21286	46	extern struct bt_value *bt_value_bool_create_init(bt_bool val);
dac5c838	47
05e21286	48	extern void bt_value_bool_set(struct bt_value *bool_obj, bt_bool val);
dac5c838	49
05e21286	50	extern struct bt_value *bt_value_integer_create(void);
dac5c838	51
05e21286 PP	52	extern struct bt_value *bt_value_integer_create_init(
05e21286 PP	53	int64_t val);
dac5c838	54
05e21286	55	extern void bt_value_integer_set(struct bt_value *integer_obj, int64_t val);
de079588	56
05e21286	57	extern struct bt_value *bt_value_real_create(void);
de079588	58
05e21286	59	extern struct bt_value *bt_value_real_create_init(double val);
dac5c838	60
05e21286	61	extern void bt_value_real_set(struct bt_value *real_obj, double val);
dac5c838	62
05e21286	63	extern struct bt_value *bt_value_string_create(void);
dac5c838	64
05e21286	65	extern struct bt_value bt_value_string_create_init(const char val);
dac5c838	66
05e21286 PP	67	extern enum bt_value_status bt_value_string_set(struct bt_value *string_obj,
05e21286 PP	68	const char *val);
de079588	69
05e21286	70	extern struct bt_value *bt_value_array_create(void);
dac5c838	71
07208d85	72	extern struct bt_value *bt_value_array_borrow_element_by_index(
05e21286	73	struct bt_value *array_obj, uint64_t index);
dac5c838	74
05e21286 PP	75	extern enum bt_value_status bt_value_array_append_element(
	76	struct bt_value *array_obj,
	77	struct bt_value *element_obj);
dac5c838	78
05e21286 PP	79	extern enum bt_value_status bt_value_array_append_bool_element(
	80	struct bt_value *array_obj, bt_bool val);
	81
	82	extern enum bt_value_status bt_value_array_append_integer_element(
	83	struct bt_value *array_obj, int64_t val);
	84
	85	extern enum bt_value_status bt_value_array_append_real_element(
	86	struct bt_value *array_obj, double val);
	87
	88	extern enum bt_value_status bt_value_array_append_string_element(
	89	struct bt_value array_obj, const char val);
	90
	91	extern enum bt_value_status bt_value_array_append_empty_array_element(
	92	struct bt_value *array_obj);
	93
	94	extern enum bt_value_status bt_value_array_append_empty_map_element(
	95	struct bt_value *array_obj);
	96
	97	extern enum bt_value_status bt_value_array_set_element_by_index(
	98	struct bt_value *array_obj, uint64_t index,
	99	struct bt_value *element_obj);
	100
	101	extern struct bt_value *bt_value_map_create(void);
dac5c838	102
07208d85	103	extern struct bt_value *bt_value_map_borrow_entry_value(
05e21286	104	struct bt_value map_obj, const char key);
dac5c838	105
40f4ba76	106	typedef bt_bool (* bt_value_map_foreach_entry_func)(const char *key,
05e21286	107	struct bt_value object, void data);
de079588	108
07208d85	109	extern enum bt_value_status bt_value_map_foreach_entry(
05e21286	110	struct bt_value *map_obj,
40f4ba76	111	bt_value_map_foreach_entry_func func, void *data);
dac5c838	112
05e21286 PP	113	extern enum bt_value_status bt_value_map_insert_entry(
	114	struct bt_value map_obj, const char key,
	115	struct bt_value *element_obj);
	116
	117	extern enum bt_value_status bt_value_map_insert_bool_entry(
	118	struct bt_value map_obj, const char key, bt_bool val);
	119
	120	extern enum bt_value_status bt_value_map_insert_integer_entry(
	121	struct bt_value map_obj, const char key, int64_t val);
	122
	123	extern enum bt_value_status bt_value_map_insert_real_entry(
	124	struct bt_value map_obj, const char key, double val);
	125
	126	extern enum bt_value_status bt_value_map_insert_string_entry(
	127	struct bt_value map_obj, const char key,
	128	const char *val);
	129
	130	extern enum bt_value_status bt_value_map_insert_empty_array_entry(
	131	struct bt_value map_obj, const char key);
dac5c838	132
05e21286 PP	133	extern enum bt_value_status bt_value_map_insert_empty_map_entry(
05e21286 PP	134	struct bt_value map_obj, const char key);
770750d3	135
dac5c838 PP	136	#ifdef __cplusplus
	137	}
	138	#endif
	139
1ca80abd	140	#endif /* BABELTRACE_VALUES_H */