1 #ifndef BABELTRACE_VALUES_H
2 #define BABELTRACE_VALUES_H
5 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
6 * Copyright (c) 2015-2018 Philippe Proulx <pproulx@efficios.com>
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:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
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
31 #include <babeltrace/types.h>
33 /* For enum bt_value_status, enum bt_value_type */
34 #include <babeltrace/values-const.h>
42 extern struct bt_value
*bt_value_null
;
44 extern struct bt_value
*bt_value_bool_create(void);
46 extern struct bt_value
*bt_value_bool_create_init(bt_bool val
);
48 extern void bt_value_bool_set(struct bt_value
*bool_obj
, bt_bool val
);
50 extern struct bt_value
*bt_value_integer_create(void);
52 extern struct bt_value
*bt_value_integer_create_init(
55 extern void bt_value_integer_set(struct bt_value
*integer_obj
, int64_t val
);
57 extern struct bt_value
*bt_value_real_create(void);
59 extern struct bt_value
*bt_value_real_create_init(double val
);
61 extern void bt_value_real_set(struct bt_value
*real_obj
, double val
);
63 extern struct bt_value
*bt_value_string_create(void);
65 extern struct bt_value
*bt_value_string_create_init(const char *val
);
67 extern enum bt_value_status
bt_value_string_set(struct bt_value
*string_obj
,
70 extern struct bt_value
*bt_value_array_create(void);
72 extern struct bt_value
*bt_value_array_borrow_element_by_index(
73 struct bt_value
*array_obj
, uint64_t index
);
75 extern enum bt_value_status
bt_value_array_append_element(
76 struct bt_value
*array_obj
,
77 struct bt_value
*element_obj
);
79 extern enum bt_value_status
bt_value_array_append_bool_element(
80 struct bt_value
*array_obj
, bt_bool val
);
82 extern enum bt_value_status
bt_value_array_append_integer_element(
83 struct bt_value
*array_obj
, int64_t val
);
85 extern enum bt_value_status
bt_value_array_append_real_element(
86 struct bt_value
*array_obj
, double val
);
88 extern enum bt_value_status
bt_value_array_append_string_element(
89 struct bt_value
*array_obj
, const char *val
);
91 extern enum bt_value_status
bt_value_array_append_empty_array_element(
92 struct bt_value
*array_obj
);
94 extern enum bt_value_status
bt_value_array_append_empty_map_element(
95 struct bt_value
*array_obj
);
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
);
101 extern struct bt_value
*bt_value_map_create(void);
103 extern struct bt_value
*bt_value_map_borrow_entry_value(
104 struct bt_value
*map_obj
, const char *key
);
106 typedef bt_bool (* bt_value_map_foreach_entry_func
)(const char *key
,
107 struct bt_value
*object
, void *data
);
109 extern enum bt_value_status
bt_value_map_foreach_entry(
110 struct bt_value
*map_obj
,
111 bt_value_map_foreach_entry_func func
, void *data
);
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
);
117 extern enum bt_value_status
bt_value_map_insert_bool_entry(
118 struct bt_value
*map_obj
, const char *key
, bt_bool val
);
120 extern enum bt_value_status
bt_value_map_insert_integer_entry(
121 struct bt_value
*map_obj
, const char *key
, int64_t val
);
123 extern enum bt_value_status
bt_value_map_insert_real_entry(
124 struct bt_value
*map_obj
, const char *key
, double val
);
126 extern enum bt_value_status
bt_value_map_insert_string_entry(
127 struct bt_value
*map_obj
, const char *key
,
130 extern enum bt_value_status
bt_value_map_insert_empty_array_entry(
131 struct bt_value
*map_obj
, const char *key
);
133 extern enum bt_value_status
bt_value_map_insert_empty_map_entry(
134 struct bt_value
*map_obj
, const char *key
);
140 #endif /* BABELTRACE_VALUES_H */