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

#ifndef BABELTRACE_PRIVATE_VALUES_H
#define BABELTRACE_PRIVATE_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 enum bt_value_status */
#include <babeltrace/values.h>

#ifdef __cplusplus
extern "C" {
#endif

struct bt_value;
struct bt_private_value;

extern struct bt_private_value *bt_private_value_null;

static inline
struct bt_value *bt_private_value_as_value(
		struct bt_private_value *priv_value)
{
	return (void *) priv_value;
}

extern struct bt_private_value *bt_private_value_bool_create(void);

extern struct bt_private_value *bt_private_value_bool_create_init(bt_bool val);

extern void bt_private_value_bool_set(struct bt_private_value *bool_obj,
		bt_bool val);

extern struct bt_private_value *bt_private_value_integer_create(void);

extern struct bt_private_value *bt_private_value_integer_create_init(
		int64_t val);

extern void bt_private_value_integer_set(
		struct bt_private_value *integer_obj, int64_t val);

extern struct bt_private_value *bt_private_value_real_create(void);

extern struct bt_private_value *bt_private_value_real_create_init(double val);

extern void bt_private_value_real_set(
		struct bt_private_value *real_obj, double val);

extern struct bt_private_value *bt_private_value_string_create(void);

extern struct bt_private_value *bt_private_value_string_create_init(
		const char *val);

extern enum bt_value_status bt_private_value_string_set(
		struct bt_private_value *string_obj,
		const char *val);

extern struct bt_private_value *bt_private_value_array_create(void);

extern struct bt_private_value *bt_private_value_array_borrow_element_by_index(
		const struct bt_private_value *array_obj, uint64_t index);

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

extern enum bt_value_status bt_private_value_array_append_bool_element(
		struct bt_private_value *array_obj,
		bt_bool val);

extern enum bt_value_status bt_private_value_array_append_integer_element(
		struct bt_private_value *array_obj,
		int64_t val);

extern enum bt_value_status bt_private_value_array_append_real_element(
		struct bt_private_value *array_obj,
		double val);

extern enum bt_value_status bt_private_value_array_append_string_element(
		struct bt_private_value *array_obj, const char *val);

extern enum bt_value_status bt_private_value_array_append_empty_array_element(
		struct bt_private_value *array_obj);

extern enum bt_value_status bt_private_value_array_append_empty_map_element(
		struct bt_private_value *array_obj);

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

extern struct bt_private_value *bt_private_value_map_create(void);

extern struct bt_private_value *bt_private_value_map_borrow_entry_value(
		const struct bt_private_value *map_obj, const char *key);

typedef bt_bool (* bt_private_value_map_foreach_entry_cb)(const char *key,
		struct bt_private_value *object, void *data);

extern enum bt_value_status bt_private_value_map_foreach_entry(
		const struct bt_private_value *map_obj,
		bt_private_value_map_foreach_entry_cb cb, void *data);

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

extern enum bt_value_status bt_private_value_map_insert_bool_entry(
		struct bt_private_value *map_obj, const char *key, bt_bool val);

extern enum bt_value_status bt_private_value_map_insert_integer_entry(
		struct bt_private_value *map_obj, const char *key, int64_t val);

extern enum bt_value_status bt_private_value_map_insert_real_entry(
		struct bt_private_value *map_obj, const char *key, double val);

extern enum bt_value_status bt_private_value_map_insert_string_entry(
		struct bt_private_value *map_obj, const char *key,
		const char *val);

extern enum bt_value_status bt_private_value_map_insert_empty_array_entry(
		struct bt_private_value *map_obj, const char *key);

extern enum bt_value_status bt_private_value_map_insert_empty_map_entry(
		struct bt_private_value *map_obj, const char *key);

#ifdef __cplusplus
}
#endif

#endif /* BABELTRACE_PRIVATE_VALUES_H */
Commit	Line	Data
da91b29a PP	1	#ifndef BABELTRACE_PRIVATE_VALUES_H
	2	#define BABELTRACE_PRIVATE_VALUES_H
	3
	4	/*
	5	* Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
	6	* Copyright (c) 2015-2018 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 enum bt_value_status */
	31	#include <babeltrace/values.h>
	32
	33	#ifdef __cplusplus
	34	extern "C" {
	35	#endif
	36
	37	struct bt_value;
	38	struct bt_private_value;
	39
	40	extern struct bt_private_value *bt_private_value_null;
	41
d94d92ac	42	static inline
707b7d35	43	struct bt_value *bt_private_value_as_value(
d94d92ac PP	44	struct bt_private_value *priv_value)
	45	{
	46	return (void *) priv_value;
	47	}
da91b29a PP	48
	49	extern struct bt_private_value *bt_private_value_bool_create(void);
	50
da91b29a PP	51	extern struct bt_private_value *bt_private_value_bool_create_init(bt_bool val);
da91b29a PP	52
601b0d3c	53	extern void bt_private_value_bool_set(struct bt_private_value *bool_obj,
da91b29a PP	54	bt_bool val);
	55
	56	extern struct bt_private_value *bt_private_value_integer_create(void);
	57
601b0d3c PP	58	extern struct bt_private_value *bt_private_value_integer_create_init(
601b0d3c PP	59	int64_t val);
da91b29a	60
601b0d3c	61	extern void bt_private_value_integer_set(
da91b29a PP	62	struct bt_private_value *integer_obj, int64_t val);
	63
	64	extern struct bt_private_value *bt_private_value_real_create(void);
	65
	66	extern struct bt_private_value *bt_private_value_real_create_init(double val);
	67
601b0d3c	68	extern void bt_private_value_real_set(
da91b29a PP	69	struct bt_private_value *real_obj, double val);
	70
	71	extern struct bt_private_value *bt_private_value_string_create(void);
	72
601b0d3c PP	73	extern struct bt_private_value *bt_private_value_string_create_init(
601b0d3c PP	74	const char *val);
da91b29a	75
601b0d3c PP	76	extern enum bt_value_status bt_private_value_string_set(
601b0d3c PP	77	struct bt_private_value *string_obj,
da91b29a PP	78	const char *val);
	79
	80	extern struct bt_private_value *bt_private_value_array_create(void);
	81
	82	extern struct bt_private_value *bt_private_value_array_borrow_element_by_index(
	83	const struct bt_private_value *array_obj, uint64_t index);
	84
	85	extern enum bt_value_status bt_private_value_array_append_element(
601b0d3c PP	86	struct bt_private_value *array_obj,
601b0d3c PP	87	struct bt_value *element_obj);
da91b29a PP	88
da91b29a PP	89	extern enum bt_value_status bt_private_value_array_append_bool_element(
601b0d3c PP	90	struct bt_private_value *array_obj,
601b0d3c PP	91	bt_bool val);
da91b29a PP	92
da91b29a PP	93	extern enum bt_value_status bt_private_value_array_append_integer_element(
601b0d3c PP	94	struct bt_private_value *array_obj,
601b0d3c PP	95	int64_t val);
da91b29a PP	96
da91b29a PP	97	extern enum bt_value_status bt_private_value_array_append_real_element(
601b0d3c PP	98	struct bt_private_value *array_obj,
601b0d3c PP	99	double val);
da91b29a PP	100
	101	extern enum bt_value_status bt_private_value_array_append_string_element(
	102	struct bt_private_value array_obj, const char val);
	103
	104	extern enum bt_value_status bt_private_value_array_append_empty_array_element(
	105	struct bt_private_value *array_obj);
	106
	107	extern enum bt_value_status bt_private_value_array_append_empty_map_element(
	108	struct bt_private_value *array_obj);
	109
	110	extern enum bt_value_status bt_private_value_array_set_element_by_index(
	111	struct bt_private_value *array_obj, uint64_t index,
	112	struct bt_value *element_obj);
	113
	114	extern struct bt_private_value *bt_private_value_map_create(void);
	115
	116	extern struct bt_private_value *bt_private_value_map_borrow_entry_value(
	117	const struct bt_private_value map_obj, const char key);
	118
	119	typedef bt_bool (* bt_private_value_map_foreach_entry_cb)(const char *key,
601b0d3c	120	struct bt_private_value object, void data);
da91b29a PP	121
	122	extern enum bt_value_status bt_private_value_map_foreach_entry(
	123	const struct bt_private_value *map_obj,
	124	bt_private_value_map_foreach_entry_cb cb, void *data);
	125
	126	extern enum bt_value_status bt_private_value_map_insert_entry(
	127	struct bt_private_value map_obj, const char key,
	128	struct bt_value *element_obj);
	129
	130	extern enum bt_value_status bt_private_value_map_insert_bool_entry(
	131	struct bt_private_value map_obj, const char key, bt_bool val);
	132
	133	extern enum bt_value_status bt_private_value_map_insert_integer_entry(
	134	struct bt_private_value map_obj, const char key, int64_t val);
	135
	136	extern enum bt_value_status bt_private_value_map_insert_real_entry(
	137	struct bt_private_value map_obj, const char key, double val);
	138
	139	extern enum bt_value_status bt_private_value_map_insert_string_entry(
601b0d3c PP	140	struct bt_private_value map_obj, const char key,
601b0d3c PP	141	const char *val);
da91b29a PP	142
	143	extern enum bt_value_status bt_private_value_map_insert_empty_array_entry(
	144	struct bt_private_value map_obj, const char key);
	145
	146	extern enum bt_value_status bt_private_value_map_insert_empty_map_entry(
	147	struct bt_private_value map_obj, const char key);
	148
	149	#ifdef __cplusplus
	150	}
	151	#endif
	152
	153	#endif /* BABELTRACE_PRIVATE_VALUES_H */