1 #ifndef BABELTRACE_VALUES_H
2 #define BABELTRACE_VALUES_H
5 * Babeltrace - Value objects
7 * Copyright (c) 2015-2016 EfficiOS Inc. and Linux Foundation
8 * Copyright (c) 2015-2016 Philippe Proulx <pproulx@efficios.com>
10 * Permission is hereby granted, free of charge, to any person obtaining a copy
11 * of this software and associated documentation files (the "Software"), to deal
12 * in the Software without restriction, including without limitation the rights
13 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
14 * copies of the Software, and to permit persons to whom the Software is
15 * furnished to do so, subject to the following conditions:
17 * The above copyright notice and this permission notice shall be included in
18 * all copies or substantial portions of the Software.
20 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
21 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
22 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
23 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
24 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
25 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
33 #include <babeltrace/types.h>
35 /* For bt_object_get_ref() */
36 #include <babeltrace/object.h>
43 @defgroup values Value objects
48 #include <babeltrace/values.h>
51 This is a set of <strong><em>value objects</em></strong>. With the
52 functions documented here, you can create and modify:
54 - \link bt_value_bool_create() Boolean value objects\endlink.
55 - \link bt_value_integer_create() Integer value objects\endlink.
56 - \link bt_value_float_create() Floating point number
57 value objects\endlink.
58 - \link bt_value_string_create() String value objects\endlink.
59 - \link bt_value_array_create() Array value objects\endlink,
60 containing zero or more value objects.
61 - \link bt_value_map_create() Map value objects\endlink, mapping
62 string keys to value objects.
64 As with any Babeltrace object, value objects have
65 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
66 counts</a>. When you \link bt_value_array_append_element() append a value object
67 to an array value object\endlink, or when you \link bt_value_map_insert_entry()
68 insert a value object into a map value object\endlink, its reference
69 count is incremented, as well as when you get a value object back from
70 those objects. See \ref refs to learn more about the reference counting
71 management of Babeltrace objects.
73 Most functions of this API return a <em>status code</em>, one of the
74 values of #bt_value_status.
76 You can create a deep copy of any value object with bt_value_copy(). You
77 can compare two value objects with bt_value_compare().
79 The following matrix shows some categorized value object functions
80 to use for each value object type:
84 <th>Function role →<br>
85 Value object type ↓
93 <td>Use the \ref bt_value_null variable
94 <td>bt_value_is_null()
100 <td>bt_value_bool_create()<br>
101 bt_value_bool_create_init()
102 <td>bt_value_is_bool()
103 <td>bt_value_bool_get()
104 <td>bt_value_bool_set()
108 <td>bt_value_integer_create()<br>
109 bt_value_integer_create_init()
110 <td>bt_value_is_integer()
111 <td>bt_value_integer_get()
112 <td>bt_value_integer_set()
115 <th>Floating point<br>number
116 <td>bt_value_float_create()<br>
117 bt_value_float_create_init()
118 <td>bt_value_is_float()
119 <td>bt_value_float_get()
120 <td>bt_value_float_set()
124 <td>bt_value_string_create()<br>
125 bt_value_string_create_init()
126 <td>bt_value_is_string()
127 <td>bt_value_string_get()
128 <td>bt_value_string_set()
132 <td>bt_value_array_create()
133 <td>bt_value_is_array()
134 <td>bt_value_array_get()
135 <td>bt_value_array_append_element()<br>
136 bt_value_array_append_bool_element()<br>
137 bt_value_array_append_integer_element()<br>
138 bt_value_array_append_element_float()<br>
139 bt_value_array_append_string_element()<br>
140 bt_value_array_append_empty_array_element()<br>
141 bt_value_array_append_empty_map_element()<br>
142 bt_value_array_set_element_by_index()
146 <td>bt_value_map_create()<br>
147 bt_value_map_extend()
148 <td>bt_value_is_map()
149 <td>bt_value_map_get()<br>
150 bt_value_map_foreach_entry()
151 <td>bt_value_map_insert_entry()<br>
152 bt_value_map_insert_bool_entry()<br>
153 bt_value_map_insert_integer_entry()<br>
154 bt_value_map_insert_float_entry()<br>
155 bt_value_map_insert_string_entry()<br>
156 bt_value_map_insert_empty_array_entry()<br>
157 bt_value_map_insert_empty_map_entry()
162 @brief Value object types and functions.
172 enum bt_value_status
{
173 /// Operation canceled.
174 BT_VALUE_STATUS_CANCELED
= -3,
176 /* -22 for compatibility with -EINVAL */
177 /// Invalid argument.
178 BT_VALUE_STATUS_INVAL
= -22,
181 BT_VALUE_STATUS_ERROR
= -1,
184 BT_VALUE_STATUS_OK
= 0,
189 @brief A value object.
195 @brief The null value object singleton.
197 You \em must use this variable when you need the null value object.
199 The null value object singleton has no reference count: there is only
200 one. You can compare any value object address to the null value object
201 singleton to check if it's the null value object, or otherwise with
204 You can pass \ref bt_value_null to bt_object_get_ref() or bt_object_put_ref(): it has
207 The null value object singleton is <em>always frozen</em> (see
208 bt_value_is_frozen()).
210 The functions of this API return this variable when the value object
211 is actually the null value object (of type #BT_VALUE_TYPE_NULL),
212 whereas \c NULL means an error of some sort.
214 extern struct bt_value
*bt_value_null
;
217 @name Type information
222 @brief Value object type.
225 /// Null value object.
226 BT_VALUE_TYPE_NULL
= 0,
228 /// Boolean value object (holds #BT_TRUE or #BT_FALSE).
229 BT_VALUE_TYPE_BOOL
= 1,
231 /// Integer value object (holds a signed 64-bit integer raw value).
232 BT_VALUE_TYPE_INTEGER
= 2,
234 /// Floating point number value object (holds a \c double raw value).
235 BT_VALUE_TYPE_REAL
= 3,
237 /// String value object.
238 BT_VALUE_TYPE_STRING
= 4,
240 /// Array value object.
241 BT_VALUE_TYPE_ARRAY
= 5,
243 /// Map value object.
244 BT_VALUE_TYPE_MAP
= 6,
248 @brief Returns the type of the value object \p object.
250 @param[in] object Value object of which to get the type.
251 @returns Type of value object \p object,
252 or #BT_VALUE_TYPE_UNKNOWN on error.
255 @postrefcountsame{object}
257 @sa #bt_value_type: Value object types.
258 @sa bt_value_is_null(): Returns whether or not a given value object
259 is the null value object.
260 @sa bt_value_is_bool(): Returns whether or not a given value object
261 is a boolean value object.
262 @sa bt_value_is_integer(): Returns whether or not a given value
263 object is an integer value object.
264 @sa bt_value_is_float(): Returns whether or not a given value object
265 is a floating point number value object.
266 @sa bt_value_is_string(): Returns whether or not a given value object
267 is a string value object.
268 @sa bt_value_is_array(): Returns whether or not a given value object
269 is an array value object.
270 @sa bt_value_is_map(): Returns whether or not a given value object
271 is a map value object.
273 extern enum bt_value_type
bt_value_get_type(const struct bt_value
*object
);
276 @brief Returns whether or not the value object \p object is the null
279 The only valid null value object is \ref bt_value_null.
281 An alternative to calling this function is to directly compare the value
282 object pointer to the \ref bt_value_null variable.
284 @param[in] object Value object to check.
285 @returns #BT_TRUE if \p object is the null value object.
288 @postrefcountsame{object}
290 @sa bt_value_get_type(): Returns the type of a given value object.
293 bt_bool
bt_value_is_null(const struct bt_value
*object
)
295 return bt_value_get_type(object
) == BT_VALUE_TYPE_NULL
;
299 @brief Returns whether or not the value object \p object is a boolean
302 @param[in] object Value object to check.
303 @returns #BT_TRUE if \p object is a boolean value object.
306 @postrefcountsame{object}
308 @sa bt_value_get_type(): Returns the type of a given value object.
311 bt_bool
bt_value_is_bool(const struct bt_value
*object
)
313 return bt_value_get_type(object
) == BT_VALUE_TYPE_BOOL
;
317 @brief Returns whether or not the value object \p object is an integer
320 @param[in] object Value object to check.
321 @returns #BT_TRUE if \p object is an integer value object.
323 @sa bt_value_get_type(): Returns the type of a given value object.
326 bt_bool
bt_value_is_integer(const struct bt_value
*object
)
328 return bt_value_get_type(object
) == BT_VALUE_TYPE_INTEGER
;
332 @brief Returns whether or not the value object \p object is a floating
333 point number value object.
335 @param[in] object Value object to check.
336 @returns #BT_TRUE if \p object is a floating point
340 @postrefcountsame{object}
342 @sa bt_value_get_type(): Returns the type of a given value object.
345 bt_bool
bt_value_is_real(const struct bt_value
*object
)
347 return bt_value_get_type(object
) == BT_VALUE_TYPE_REAL
;
351 @brief Returns whether or not the value object \p object is a string
354 @param[in] object Value object to check.
355 @returns #BT_TRUE if \p object is a string value object.
358 @postrefcountsame{object}
360 @sa bt_value_get_type(): Returns the type of a given value object.
363 bt_bool
bt_value_is_string(const struct bt_value
*object
)
365 return bt_value_get_type(object
) == BT_VALUE_TYPE_STRING
;
369 @brief Returns whether or not the value object \p object is an array
372 @param[in] object Value object to check.
373 @returns #BT_TRUE if \p object is an array value object.
376 @postrefcountsame{object}
378 @sa bt_value_get_type(): Returns the type of a given value object.
381 bt_bool
bt_value_is_array(const struct bt_value
*object
)
383 return bt_value_get_type(object
) == BT_VALUE_TYPE_ARRAY
;
387 @brief Returns whether or not the value object \p object is a map value
390 @param[in] object Value object to check.
391 @returns #BT_TRUE if \p object is a map value object.
394 @postrefcountsame{object}
396 @sa bt_value_get_type(): Returns the type of a given value object.
399 bt_bool
bt_value_is_map(const struct bt_value
*object
)
401 return bt_value_get_type(object
) == BT_VALUE_TYPE_MAP
;
407 @name Common value object functions
412 @brief Creates a \em deep copy of the value object \p object.
414 You can copy a frozen value object: the resulting copy is
417 @param[in] object Value object to copy.
418 @returns Deep copy of \p object on success, or \c NULL
422 @post <strong>On success, if the returned value object is not
423 \ref bt_value_null</strong>, its reference count is 1.
424 @postrefcountsame{object}
426 extern struct bt_value
*bt_value_copy(const struct bt_value
*object
);
429 @brief Recursively compares the value objects \p object_a and
430 \p object_b and returns #BT_TRUE if they have the same
431 \em content (raw values).
433 @param[in] object_a Value object A to compare to \p object_b.
434 @param[in] object_b Value object B to compare to \p object_a.
435 @returns #BT_TRUE if \p object_a and \p object_b have the
436 same \em content, or #BT_FALSE if they differ
439 @postrefcountsame{object_a}
440 @postrefcountsame{object_b}
442 extern bt_bool
bt_value_compare(const struct bt_value
*object_a
,
443 const struct bt_value
*object_b
);
448 @name Boolean value object functions
453 @brief Creates a default boolean value object.
455 The created boolean value object's initial raw value is #BT_FALSE.
457 @returns Created boolean value object on success, or \c NULL
460 @postsuccessrefcountret1
462 @sa bt_value_bool_create_init(): Creates an initialized boolean
465 extern struct bt_value
*bt_value_bool_create(void);
468 @brief Creates a boolean value object with its initial raw value set to
471 @param[in] val Initial raw value.
472 @returns Created boolean value object on success, or
475 @postsuccessrefcountret1
477 @sa bt_value_bool_create(): Creates a default boolean value object.
479 extern struct bt_value
*bt_value_bool_create_init(bt_bool val
);
482 @brief Returns the boolean raw value of the boolean value object
485 @param[in] bool_obj Boolean value object of which to get the
487 @param[out] val Returned boolean raw value.
488 @returns Status code.
490 @prenotnull{bool_obj}
492 @pre \p bool_obj is a boolean value object.
493 @postrefcountsame{bool_obj}
495 @sa bt_value_bool_set(): Sets the raw value of a boolean value object.
497 extern enum bt_value_status
bt_value_bool_get(
498 const struct bt_value
*bool_obj
, bt_bool
*val
);
501 @brief Sets the boolean raw value of the boolean value object
502 \p bool_obj to \p val.
504 @param[in] bool_obj Boolean value object of which to set
506 @param[in] val New boolean raw value.
507 @returns Status code.
509 @prenotnull{bool_obj}
510 @pre \p bool_obj is a boolean value object.
512 @postrefcountsame{bool_obj}
514 @sa bt_value_bool_get(): Returns the raw value of a given boolean
517 extern enum bt_value_status
bt_value_bool_set(struct bt_value
*bool_obj
,
523 @name Integer value object functions
528 @brief Creates a default integer value object.
530 The created integer value object's initial raw value is 0.
532 @returns Created integer value object on success, or \c NULL
535 @postsuccessrefcountret1
537 @sa bt_value_integer_create_init(): Creates an initialized integer
540 extern struct bt_value
*bt_value_integer_create(void);
543 @brief Creates an integer value object with its initial raw value set to
546 @param[in] val Initial raw value.
547 @returns Created integer value object on success, or
550 @postsuccessrefcountret1
552 @sa bt_value_integer_create(): Creates a default integer
555 extern struct bt_value
*bt_value_integer_create_init(int64_t val
);
558 @brief Returns the integer raw value of the integer value object
561 @param[in] integer_obj Integer value object of which to get the
563 @param[out] val Returned integer raw value.
564 @returns Status code.
566 @prenotnull{integer_obj}
568 @pre \p integer_obj is an integer value object.
569 @postrefcountsame{integer_obj}
571 @sa bt_value_integer_set(): Sets the raw value of an integer value
574 extern enum bt_value_status
bt_value_integer_get(
575 const struct bt_value
*integer_obj
, int64_t *val
);
578 @brief Sets the integer raw value of the integer value object
579 \p integer_obj to \p val.
581 @param[in] integer_obj Integer value object of which to set
583 @param[in] val New integer raw value.
584 @returns Status code.
586 @prenotnull{integer_obj}
587 @pre \p integer_obj is an integer value object.
589 @postrefcountsame{integer_obj}
591 @sa bt_value_integer_get(): Returns the raw value of a given integer
594 extern enum bt_value_status
bt_value_integer_set(
595 struct bt_value
*integer_obj
, int64_t val
);
600 @name Floating point number value object functions
605 @brief Creates a default floating point number value object.
607 The created floating point number value object's initial raw value is 0.
609 @returns Created floating point number value object on success,
612 @postsuccessrefcountret1
614 @sa bt_value_float_create_init(): Creates an initialized floating
615 point number value object.
617 extern struct bt_value
*bt_value_real_create(void);
620 @brief Creates a floating point number value object with its initial raw
623 @param[in] val Initial raw value.
624 @returns Created floating point number value object on
625 success, or \c NULL on error.
627 @postsuccessrefcountret1
629 @sa bt_value_float_create(): Creates a default floating point number
632 extern struct bt_value
*bt_value_real_create_init(double val
);
635 @brief Returns the floating point number raw value of the floating point
636 number value object \p float_obj.
638 @param[in] float_obj Floating point number value object of which to
640 @param[out] val Returned floating point number raw value
641 @returns Status code.
643 @prenotnull{float_obj}
645 @pre \p float_obj is a floating point number value object.
646 @postrefcountsame{float_obj}
648 @sa bt_value_float_set(): Sets the raw value of a given floating
649 point number value object.
651 extern enum bt_value_status
bt_value_real_get(
652 const struct bt_value
*real_obj
, double *val
);
655 @brief Sets the floating point number raw value of the floating point
656 number value object \p float_obj to \p val.
658 @param[in] float_obj Floating point number value object of which to set
660 @param[in] val New floating point number raw value.
661 @returns Status code.
663 @prenotnull{float_obj}
664 @pre \p float_obj is a floating point number value object.
666 @postrefcountsame{float_obj}
668 @sa bt_value_float_get(): Returns the raw value of a floating point
671 extern enum bt_value_status
bt_value_real_set(
672 struct bt_value
*real_obj
, double val
);
677 @name String value object functions
682 @brief Creates a default string value object.
684 The string value object is initially empty.
686 @returns Created string value object on success, or \c NULL
689 @postsuccessrefcountret1
691 @sa bt_value_string_create_init(): Creates an initialized string
694 extern struct bt_value
*bt_value_string_create(void);
697 @brief Creates a string value object with its initial raw value set to
700 On success, \p val is copied.
702 @param[in] val Initial raw value (copied on success).
703 @returns Created string value object on success, or
707 @postsuccessrefcountret1
709 @sa bt_value_float_create(): Creates a default string value object.
711 extern struct bt_value
*bt_value_string_create_init(const char *val
);
714 @brief Returns the string raw value of the string value object
717 The returned string is placed in \p *val. It is valid as long as this
718 value object exists and is \em not modified. The ownership of the
719 returned string is \em not transferred to the caller.
721 @param[in] string_obj String value object of which to get the
723 @param[out] val Returned string raw value.
724 @returns Status code.
726 @prenotnull{string_obj}
728 @pre \p string_obj is a string value object.
729 @postrefcountsame{string_obj}
731 @sa bt_value_string_set(): Sets the raw value of a string
734 extern enum bt_value_status
bt_value_string_get(
735 const struct bt_value
*string_obj
, const char **val
);
738 @brief Sets the string raw value of the string value object
739 \p string_obj to \p val.
741 On success, \p val is copied.
743 @param[in] string_obj String value object of which to set
745 @param[in] val New string raw value (copied on success).
746 @returns Status code.
748 @prenotnull{string_obj}
750 @pre \p string_obj is a string value object.
752 @postrefcountsame{string_obj}
754 @sa bt_value_string_get(): Returns the raw value of a given string
757 extern enum bt_value_status
bt_value_string_set(struct bt_value
*string_obj
,
765 * @name Array value object functions
770 @brief Creates an empty array value object.
772 @returns Created array value object on success, or \c NULL
775 @postsuccessrefcountret1
777 extern struct bt_value
*bt_value_array_create(void);
780 @brief Returns the size of the array value object \p array_obj, that is,
781 the number of value objects contained in \p array_obj.
783 @param[in] array_obj Array value object of which to get the size.
784 @returns Number of value objects contained in
785 \p array_obj if the return value is 0 (empty)
786 or a positive value, or one of
787 #bt_value_status negative values otherwise.
789 @prenotnull{array_obj}
790 @pre \p array_obj is an array value object.
791 @postrefcountsame{array_obj}
793 @sa bt_value_array_is_empty(): Checks whether or not a given array
794 value object is empty.
796 extern int64_t bt_value_array_get_size(const struct bt_value
*array_obj
);
799 @brief Checks whether or not the array value object \p array_obj
802 @param[in] array_obj Array value object to check.
803 @returns #BT_TRUE if \p array_obj is empty.
805 @prenotnull{array_obj}
806 @pre \p array_obj is an array value object.
807 @postrefcountsame{array_obj}
809 @sa bt_value_array_get_size(): Returns the size of a given array value
812 extern bt_bool
bt_value_array_is_empty(const struct bt_value
*array_obj
);
814 extern struct bt_value
*bt_value_array_borrow_element_by_index(
815 const struct bt_value
*array_obj
, uint64_t index
);
818 @brief Appends the value object \p element_obj to the array value
821 @param[in] array_obj Array value object in which to append
823 @param[in] element_obj Value object to append.
824 @returns Status code.
826 @prenotnull{array_obj}
827 @prenotnull{element_obj}
828 @pre \p array_obj is an array value object.
830 @post <strong>On success, if \p element_obj is not
831 \ref bt_value_null</strong>, its reference count is incremented.
832 @postrefcountsame{array_obj}
834 @sa bt_value_array_append_bool_element(): Appends a boolean raw value to a
835 given array value object.
836 @sa bt_value_array_append_integer_element(): Appends an integer raw value
837 to a given array value object.
838 @sa bt_value_array_append_element_float(): Appends a floating point number
839 raw value to a given array value object.
840 @sa bt_value_array_append_string_element(): Appends a string raw value to a
841 given array value object.
842 @sa bt_value_array_append_empty_array_element(): Appends an empty array value
843 object to a given array value object.
844 @sa bt_value_array_append_empty_map_element(): Appends an empty map value
845 object to a given array value object.
847 extern enum bt_value_status
bt_value_array_append_element(
848 struct bt_value
*array_obj
, struct bt_value
*element_obj
);
851 @brief Appends the boolean raw value \p val to the array value object
854 This is a convenience function which creates the underlying boolean
855 value object before appending it.
857 @param[in] array_obj Array value object in which to append \p val.
858 @param[in] val Boolean raw value to append to \p array_obj.
859 @returns Status code.
861 @prenotnull{array_obj}
862 @pre \p array_obj is an array value object.
864 @postrefcountsame{array_obj}
866 @sa bt_value_array_append_element(): Appends a value object to a given
869 extern enum bt_value_status
bt_value_array_append_bool_element(
870 struct bt_value
*array_obj
, bt_bool val
);
873 @brief Appends the integer raw value \p val to the array value object
876 This is a convenience function which creates the underlying integer
877 value object before appending it.
879 @param[in] array_obj Array value object in which to append \p val.
880 @param[in] val Integer raw value to append to \p array_obj.
881 @returns Status code.
883 @prenotnull{array_obj}
884 @pre \p array_obj is an array value object.
886 @postrefcountsame{array_obj}
888 @sa bt_value_array_append_element(): Appends a value object to a given
891 extern enum bt_value_status
bt_value_array_append_integer_element(
892 struct bt_value
*array_obj
, int64_t val
);
895 @brief Appends the floating point number raw value \p val to the array
896 value object \p array_obj.
898 This is a convenience function which creates the underlying floating
899 point number value object before appending it.
901 @param[in] array_obj Array value object in which to append \p val.
902 @param[in] val Floating point number raw value to append
904 @returns Status code.
906 @prenotnull{array_obj}
907 @pre \p array_obj is an array value object.
909 @postrefcountsame{array_obj}
911 @sa bt_value_array_append_element(): Appends a value object to a given
914 extern enum bt_value_status
bt_value_array_append_real_element(
915 struct bt_value
*array_obj
, double val
);
918 @brief Appends the string raw value \p val to the array value object
921 This is a convenience function which creates the underlying string value
922 object before appending it.
924 On success, \p val is copied.
926 @param[in] array_obj Array value object in which to append \p val.
927 @param[in] val String raw value to append to \p array_obj
929 @returns Status code.
931 @prenotnull{array_obj}
932 @pre \p array_obj is an array value object.
935 @postrefcountsame{array_obj}
937 @sa bt_value_array_append_element(): Appends a value object to a given
940 extern enum bt_value_status
bt_value_array_append_string_element(
941 struct bt_value
*array_obj
, const char *val
);
944 @brief Appends an empty array value object to the array value object
947 This is a convenience function which creates the underlying array value
948 object before appending it.
950 @param[in] array_obj Array value object in which to append an
951 empty array value object
952 @returns Status code.
954 @prenotnull{array_obj}
955 @pre \p array_obj is an array value object.
957 @postrefcountsame{array_obj}
959 @sa bt_value_array_append_element(): Appends a value object to a given
962 extern enum bt_value_status
bt_value_array_append_empty_array_element(
963 struct bt_value
*array_obj
);
966 @brief Appends an empty map value object to the array value object
969 This is a convenience function which creates the underlying map value
970 object before appending it.
972 @param[in] array_obj Array value object in which to append an empty
974 @returns Status code.
976 @prenotnull{array_obj}
977 @pre \p array_obj is an array value object.
979 @postrefcountsame{array_obj}
981 @sa bt_value_array_append_element(): Appends a value object to a given
984 extern enum bt_value_status
bt_value_array_append_empty_map_element(
985 struct bt_value
*array_obj
);
988 @brief Replaces the value object contained in the array value object
989 \p array_obj at the index \p index by \p element_obj.
991 @param[in] array_obj Array value object in which to replace
993 @param[in] index Index of value object to replace in
995 @param[in] element_obj New value object at position \p index of
997 @returns Status code.
999 @prenotnull{array_obj}
1000 @prenotnull{element_obj}
1001 @pre \p array_obj is an array value object.
1002 @pre \p index is lesser than the size of \p array_obj (see
1003 bt_value_array_get_size()).
1005 @post <strong>On success, if the replaced value object is not
1006 \ref bt_value_null</strong>, its reference count is decremented.
1007 @post <strong>On success, if \p element_obj is not
1008 \ref bt_value_null</strong>, its reference count is incremented.
1009 @postrefcountsame{array_obj}
1011 extern enum bt_value_status
bt_value_array_set_element_by_index(
1012 struct bt_value
*array_obj
, uint64_t index
,
1013 struct bt_value
*element_obj
);
1018 @name Map value object functions
1023 @brief Creates an empty map value object.
1025 @returns Created map value object on success, or \c NULL on error.
1027 @postsuccessrefcountret1
1029 extern struct bt_value
*bt_value_map_create(void);
1032 @brief Returns the size of the map value object \p map_obj, that is, the
1033 number of entries contained in \p map_obj.
1035 @param[in] map_obj Map value object of which to get the size.
1036 @returns Number of entries contained in \p map_obj if the
1037 return value is 0 (empty) or a positive value,
1038 or one of #bt_value_status negative values
1041 @prenotnull{map_obj}
1042 @pre \p map_obj is a map value object.
1043 @postrefcountsame{map_obj}
1045 @sa bt_value_map_is_empty(): Checks whether or not a given map value
1048 extern int64_t bt_value_map_get_size(const struct bt_value
*map_obj
);
1051 @brief Checks whether or not the map value object \p map_obj is empty.
1053 @param[in] map_obj Map value object to check.
1054 @returns #BT_TRUE if \p map_obj is empty.
1056 @prenotnull{map_obj}
1057 @pre \p map_obj is a map value object.
1058 @postrefcountsame{map_obj}
1060 @sa bt_value_map_get_size(): Returns the size of a given map value object.
1062 extern bt_bool
bt_value_map_is_empty(const struct bt_value
*map_obj
);
1064 extern struct bt_value
*bt_value_map_borrow_entry_value(
1065 const struct bt_value
*map_obj
, const char *key
);
1068 @brief User function type to use with bt_value_map_foreach_entry().
1070 \p object is a <em>weak reference</em>: you \em must pass it to bt_object_get_ref()
1071 if you need to keep a reference after this function returns.
1073 This function \em must return #BT_TRUE to continue the map value object
1074 traversal, or #BT_FALSE to break it.
1076 @param[in] key Key of map entry.
1077 @param[in] object Value object of map entry (weak reference).
1078 @param[in] data User data.
1079 @returns #BT_TRUE to continue the loop, or #BT_FALSE to break it.
1083 @post The reference count of \p object is not lesser than what it is
1084 when the function is called.
1086 typedef bt_bool (* bt_value_map_foreach_entry_cb
)(const char *key
,
1087 struct bt_value
*object
, void *data
);
1090 @brief Calls a provided user function \p cb for each value object of the
1091 map value object \p map_obj.
1093 The value object passed to the user function is a <b>weak reference</b>:
1094 you \em must pass it to bt_object_get_ref() if you need to keep a persistent
1095 reference after the user function returns.
1097 The key passed to the user function is only valid in the scope of
1098 this user function call.
1100 The user function \em must return #BT_TRUE to continue the traversal of
1101 \p map_obj, or #BT_FALSE to break it.
1103 @param[in] map_obj Map value object on which to iterate.
1104 @param[in] cb User function to call back.
1105 @param[in] data User data passed to the user function.
1106 @returns Status code. More
1107 specifically, #BT_VALUE_STATUS_CANCELED is
1108 returned if the loop was canceled by the user
1111 @prenotnull{map_obj}
1113 @pre \p map_obj is a map value object.
1114 @postrefcountsame{map_obj}
1116 extern enum bt_value_status
bt_value_map_foreach_entry(
1117 const struct bt_value
*map_obj
,
1118 bt_value_map_foreach_entry_cb cb
, void *data
);
1121 @brief Returns whether or not the map value object \p map_obj contains
1122 an entry mapped to the key \p key.
1124 @param[in] map_obj Map value object to check.
1125 @param[in] key Key to check.
1126 @returns #BT_TRUE if \p map_obj has an entry mapped to the
1127 key \p key, or #BT_FALSE if it does not or
1130 @prenotnull{map_obj}
1132 @pre \p map_obj is a map value object.
1133 @postrefcountsame{map_obj}
1135 extern bt_bool
bt_value_map_has_entry(const struct bt_value
*map_obj
,
1139 @brief Inserts the value object \p element_obj mapped to the key
1140 \p key into the map value object \p map_obj.
1142 If a value object is already mapped to \p key in \p map_obj, the
1143 associated value object is first put, and then replaced by
1146 On success, \p key is copied.
1148 @param[in] map_obj Map value object in which to insert
1150 @param[in] key Key (copied on success) to which the
1151 value object to insert is mapped.
1152 @param[in] element_obj Value object to insert, mapped to the
1154 @returns Status code.
1156 @prenotnull{map_obj}
1158 @prenotnull{element_obj}
1159 @pre \p map_obj is a map value object.
1161 @post <strong>On success, if \p element_obj is not
1162 \ref bt_value_null</strong>, its reference count is incremented.
1163 @postrefcountsame{map_obj}
1165 @sa bt_value_map_insert_bool_entry(): Inserts a boolean raw value into a
1166 given map value object.
1167 @sa bt_value_map_insert_integer_entry(): Inserts an integer raw value into
1168 a given map value object.
1169 @sa bt_value_map_insert_float_entry(): Inserts a floating point number raw
1170 value into a given map value object.
1171 @sa bt_value_map_insert_string_entry(): Inserts a string raw value into a
1172 given map value object.
1173 @sa bt_value_map_insert_empty_array_entry(): Inserts an empty array value
1174 object into a given map value object.
1175 @sa bt_value_map_insert_empty_map_entry(): Inserts an empty map value
1176 object into a given map value object.
1178 extern enum bt_value_status
bt_value_map_insert_entry(
1179 struct bt_value
*map_obj
, const char *key
,
1180 struct bt_value
*element_obj
);
1183 @brief Inserts the boolean raw value \p val mapped to the key \p key
1184 into the map value object \p map_obj.
1186 This is a convenience function which creates the underlying boolean
1187 value object before inserting it.
1189 On success, \p key is copied.
1191 @param[in] map_obj Map value object in which to insert \p val.
1192 @param[in] key Key (copied on success) to which the boolean
1193 value object to insert is mapped.
1194 @param[in] val Boolean raw value to insert, mapped to
1196 @returns Status code.
1198 @prenotnull{map_obj}
1200 @pre \p map_obj is a map value object.
1202 @postrefcountsame{map_obj}
1204 @sa bt_value_map_insert_entry(): Inserts a value object into a given map
1207 extern enum bt_value_status
bt_value_map_insert_bool_entry(
1208 struct bt_value
*map_obj
, const char *key
, bt_bool val
);
1211 @brief Inserts the integer raw value \p val mapped to the key \p key
1212 into the map value object \p map_obj.
1214 This is a convenience function which creates the underlying integer
1215 value object before inserting it.
1217 On success, \p key is copied.
1219 @param[in] map_obj Map value object in which to insert \p val.
1220 @param[in] key Key (copied on success) to which the integer
1221 value object to insert is mapped.
1222 @param[in] val Integer raw value to insert, mapped to
1224 @returns Status code.
1226 @prenotnull{map_obj}
1228 @pre \p map_obj is a map value object.
1230 @postrefcountsame{map_obj}
1232 @sa bt_value_map_insert_entry(): Inserts a value object into a given map
1235 extern enum bt_value_status
bt_value_map_insert_integer_entry(
1236 struct bt_value
*map_obj
, const char *key
, int64_t val
);
1239 @brief Inserts the floating point number raw value \p val mapped to
1240 the key \p key into the map value object \p map_obj.
1242 This is a convenience function which creates the underlying floating
1243 point number value object before inserting it.
1245 On success, \p key is copied.
1247 @param[in] map_obj Map value object in which to insert \p val.
1248 @param[in] key Key (copied on success) to which the floating
1249 point number value object to insert is mapped.
1250 @param[in] val Floating point number raw value to insert,
1251 mapped to the key \p key.
1252 @returns Status code.
1254 @prenotnull{map_obj}
1256 @pre \p map_obj is a map value object.
1258 @postrefcountsame{map_obj}
1260 @sa bt_value_map_insert_entry(): Inserts a value object into a given map
1263 extern enum bt_value_status
bt_value_map_insert_real_entry(
1264 struct bt_value
*map_obj
, const char *key
, double val
);
1267 @brief Inserts the string raw value \p val mapped to the key \p key
1268 into the map value object \p map_obj.
1270 This is a convenience function which creates the underlying string value
1271 object before inserting it.
1273 On success, \p val and \p key are copied.
1275 @param[in] map_obj Map value object in which to insert \p val.
1276 @param[in] key Key (copied on success) to which the string
1277 value object to insert is mapped.
1278 @param[in] val String raw value to insert (copied on success),
1279 mapped to the key \p key.
1280 @returns Status code.
1282 @prenotnull{map_obj}
1285 @pre \p map_obj is a map value object.
1287 @postrefcountsame{map_obj}
1289 @sa bt_value_map_insert_entry(): Inserts a value object into a given map
1292 extern enum bt_value_status
bt_value_map_insert_string_entry(
1293 struct bt_value
*map_obj
, const char *key
, const char *val
);
1296 @brief Inserts an empty array value object mapped to the key \p key
1297 into the map value object \p map_obj.
1299 This is a convenience function which creates the underlying array value
1300 object before inserting it.
1302 On success, \p key is copied.
1304 @param[in] map_obj Map value object in which to insert an empty
1306 @param[in] key Key (copied on success) to which the empty array
1307 value object to insert is mapped.
1308 @returns Status code.
1310 @prenotnull{map_obj}
1312 @pre \p map_obj is a map value object.
1314 @postrefcountsame{map_obj}
1316 @sa bt_value_map_insert_entry(): Inserts a value object into a given map
1319 extern enum bt_value_status
bt_value_map_insert_empty_array_entry(
1320 struct bt_value
*map_obj
, const char *key
);
1323 @brief Inserts an empty map value object mapped to the key \p key into
1324 the map value object \p map_obj.
1326 This is a convenience function which creates the underlying map value
1327 object before inserting it.
1329 On success, \p key is copied.
1331 @param[in] map_obj Map value object in which to insert an empty
1333 @param[in] key Key (copied on success) to which the empty map
1334 value object to insert is mapped.
1335 @returns Status code.
1337 @prenotnull{map_obj}
1339 @pre \p map_obj is a map value object.
1341 @postrefcountsame{map_obj}
1343 @sa bt_value_map_insert_entry(): Inserts a value object into a given map
1346 extern enum bt_value_status
bt_value_map_insert_empty_map_entry(
1347 struct bt_value
*map_obj
, const char *key
);
1350 @brief Creates a copy of the base map value object \p base_map_obj
1351 superficially extended with the entries of the extension map
1352 value object \p extension_map_obj.
1354 This function creates a superficial extension of \p base_map_obj with
1355 \p extension_map_obj by adding new entries to it and replacing the
1356 ones that share the keys in the extension object. The extension is
1357 \em superficial because it does not merge internal array and map
1360 For example, consider the following \p base_map_obj (JSON representation):
1367 "return": [5, 6, null]
1371 and the following \p extension_map_obj (JSON representation):
1381 The extended object is (JSON representation):
1393 @param[in] base_map_obj Base map value object with initial
1395 @param[in] extension_map_obj Extension map value object containing
1396 the entries to add to or replace in
1398 @returns Created extended map value object, or
1401 @prenotnull{base_map_obj}
1402 @prenotnull{extension_map_obj}
1403 @pre \p base_map_obj is a map value object.
1404 @pre \p extension_map_obj is a map value object.
1405 @postrefcountsame{base_map_obj}
1406 @postrefcountsame{extension_map_obj}
1407 @postsuccessrefcountret1
1409 extern struct bt_value
*bt_value_map_extend(struct bt_value
*base_map_obj
,
1410 struct bt_value
*extension_map_obj
);
1420 #endif /* BABELTRACE_VALUES_H */