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>
40 @defgroup values Value objects
45 #include <babeltrace/values.h>
48 This is a set of <strong><em>value objects</em></strong>. With the
49 functions documented here, you can create and modify:
51 - \link bt_value_bool_create() Boolean value objects\endlink.
52 - \link bt_value_integer_create() Integer value objects\endlink.
53 - \link bt_value_float_create() Floating point number
54 value objects\endlink.
55 - \link bt_value_string_create() String value objects\endlink.
56 - \link bt_value_array_create() Array value objects\endlink,
57 containing zero or more value objects.
58 - \link bt_value_map_create() Map value objects\endlink, mapping
59 string keys to value objects.
61 As with any Babeltrace object, value objects have
62 <a href="https://en.wikipedia.org/wiki/Reference_counting">reference
63 counts</a>. When you \link bt_value_array_append() append a value object
64 to an array value object\endlink, or when you \link bt_value_map_insert()
65 insert a value object into a map value object\endlink, its reference
66 count is incremented, as well as when you get a value object back from
67 those objects. See \ref refs to learn more about the reference counting
68 management of Babeltrace objects.
70 Most functions of this API return a <em>status code</em>, one of the
71 values of #bt_value_status.
73 You can create a deep copy of any value object with bt_value_copy(). You
74 can compare two value objects with bt_value_compare().
76 The following matrix shows some categorized value object functions
77 to use for each value object type:
81 <th>Function role →<br>
82 Value object type ↓
90 <td>Use the \ref bt_value_null variable
91 <td>bt_value_is_null()
97 <td>bt_value_bool_create()<br>
98 bt_value_bool_create_init()
99 <td>bt_value_is_bool()
100 <td>bt_value_bool_get()
101 <td>bt_value_bool_set()
105 <td>bt_value_integer_create()<br>
106 bt_value_integer_create_init()
107 <td>bt_value_is_integer()
108 <td>bt_value_integer_get()
109 <td>bt_value_integer_set()
112 <th>Floating point<br>number
113 <td>bt_value_float_create()<br>
114 bt_value_float_create_init()
115 <td>bt_value_is_float()
116 <td>bt_value_float_get()
117 <td>bt_value_float_set()
121 <td>bt_value_string_create()<br>
122 bt_value_string_create_init()
123 <td>bt_value_is_string()
124 <td>bt_value_string_get()
125 <td>bt_value_string_set()
129 <td>bt_value_array_create()
130 <td>bt_value_is_array()
131 <td>bt_value_array_get()
132 <td>bt_value_array_append()<br>
133 bt_value_array_append_bool()<br>
134 bt_value_array_append_integer()<br>
135 bt_value_array_append_float()<br>
136 bt_value_array_append_string()<br>
137 bt_value_array_append_empty_array()<br>
138 bt_value_array_append_empty_map()<br>
143 <td>bt_value_map_create()<br>
144 bt_value_map_extend()
145 <td>bt_value_is_map()
146 <td>bt_value_map_get()<br>
147 bt_value_map_foreach()
148 <td>bt_value_map_insert()<br>
149 bt_value_map_insert_bool()<br>
150 bt_value_map_insert_integer()<br>
151 bt_value_map_insert_float()<br>
152 bt_value_map_insert_string()<br>
153 bt_value_map_insert_empty_array()<br>
154 bt_value_map_insert_empty_map()
159 @brief Value object types and functions.
169 enum bt_value_status
{
170 /// Operation canceled.
171 BT_VALUE_STATUS_CANCELED
= -3,
173 /* -22 for compatibility with -EINVAL */
174 /// Invalid argument.
175 BT_VALUE_STATUS_INVAL
= -22,
178 BT_VALUE_STATUS_ERROR
= -1,
181 BT_VALUE_STATUS_OK
= 0,
186 @brief A value object.
192 @brief The null value object singleton.
194 You \em must use this variable when you need the null value object.
196 The null value object singleton has no reference count: there is only
197 one. You can compare any value object address to the null value object
198 singleton to check if it's the null value object, or otherwise with
201 You can pass \ref bt_value_null to bt_get() or bt_put(): it has
204 The null value object singleton is <em>always frozen</em> (see
205 bt_value_is_frozen()).
207 The functions of this API return this variable when the value object
208 is actually the null value object (of type #BT_VALUE_TYPE_NULL),
209 whereas \c NULL means an error of some sort.
211 extern struct bt_value
*bt_value_null
;
214 @name Type information
219 @brief Value object type.
222 /// Unknown value object, used as an error code.
223 BT_VALUE_TYPE_UNKNOWN
= -1,
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_FLOAT
= 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_float(const struct bt_value
*object
)
347 return bt_value_get_type(object
) == BT_VALUE_TYPE_FLOAT
;
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_float_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_float_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_float_get(
652 const struct bt_value
*float_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_float_set(
672 struct bt_value
*float_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_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_size(): Returns the size of a given array value
812 extern bt_bool
bt_value_array_is_empty(const struct bt_value
*array_obj
);
815 @brief Returns the value object contained in the array value object
816 \p array_obj at the index \p index.
818 @param[in] array_obj Array value object of which to get an element.
819 @param[in] index Index of value object to get.
820 @returns Value object at index \p index on
821 success, or \c NULL on error.
823 @prenotnull{array_obj}
824 @pre \p array_obj is an array value object.
825 @pre \p index is lesser than the size of \p array_obj (see
826 bt_value_array_size()).
827 @post <strong>On success, if the returned value object is not
828 \ref bt_value_null</strong>, its reference count is incremented.
829 @postrefcountsame{array_obj}
831 extern struct bt_value
*bt_value_array_get(const struct bt_value
*array_obj
,
835 @brief Appends the value object \p element_obj to the array value
838 @param[in] array_obj Array value object in which to append
840 @param[in] element_obj Value object to append.
841 @returns Status code.
843 @prenotnull{array_obj}
844 @prenotnull{element_obj}
845 @pre \p array_obj is an array value object.
847 @post <strong>On success, if \p element_obj is not
848 \ref bt_value_null</strong>, its reference count is incremented.
849 @postrefcountsame{array_obj}
851 @sa bt_value_array_append_bool(): Appends a boolean raw value to a
852 given array value object.
853 @sa bt_value_array_append_integer(): Appends an integer raw value
854 to a given array value object.
855 @sa bt_value_array_append_float(): Appends a floating point number
856 raw value to a given array value object.
857 @sa bt_value_array_append_string(): Appends a string raw value to a
858 given array value object.
859 @sa bt_value_array_append_empty_array(): Appends an empty array value
860 object to a given array value object.
861 @sa bt_value_array_append_empty_map(): Appends an empty map value
862 object to a given array value object.
864 extern enum bt_value_status
bt_value_array_append(struct bt_value
*array_obj
,
865 struct bt_value
*element_obj
);
868 @brief Appends the boolean raw value \p val to the array value object
871 This is a convenience function which creates the underlying boolean
872 value object before appending it.
874 @param[in] array_obj Array value object in which to append \p val.
875 @param[in] val Boolean raw value to append to \p array_obj.
876 @returns Status code.
878 @prenotnull{array_obj}
879 @pre \p array_obj is an array value object.
881 @postrefcountsame{array_obj}
883 @sa bt_value_array_append(): Appends a value object to a given
886 extern enum bt_value_status
bt_value_array_append_bool(
887 struct bt_value
*array_obj
, bt_bool val
);
890 @brief Appends the integer raw value \p val to the array value object
893 This is a convenience function which creates the underlying integer
894 value object before appending it.
896 @param[in] array_obj Array value object in which to append \p val.
897 @param[in] val Integer raw value to append to \p array_obj.
898 @returns Status code.
900 @prenotnull{array_obj}
901 @pre \p array_obj is an array value object.
903 @postrefcountsame{array_obj}
905 @sa bt_value_array_append(): Appends a value object to a given
908 extern enum bt_value_status
bt_value_array_append_integer(
909 struct bt_value
*array_obj
, int64_t val
);
912 @brief Appends the floating point number raw value \p val to the array
913 value object \p array_obj.
915 This is a convenience function which creates the underlying floating
916 point number value object before appending it.
918 @param[in] array_obj Array value object in which to append \p val.
919 @param[in] val Floating point number raw value to append
921 @returns Status code.
923 @prenotnull{array_obj}
924 @pre \p array_obj is an array value object.
926 @postrefcountsame{array_obj}
928 @sa bt_value_array_append(): Appends a value object to a given
931 extern enum bt_value_status
bt_value_array_append_float(
932 struct bt_value
*array_obj
, double val
);
935 @brief Appends the string raw value \p val to the array value object
938 This is a convenience function which creates the underlying string value
939 object before appending it.
941 On success, \p val is copied.
943 @param[in] array_obj Array value object in which to append \p val.
944 @param[in] val String raw value to append to \p array_obj
946 @returns Status code.
948 @prenotnull{array_obj}
949 @pre \p array_obj is an array value object.
952 @postrefcountsame{array_obj}
954 @sa bt_value_array_append(): Appends a value object to a given
957 extern enum bt_value_status
bt_value_array_append_string(
958 struct bt_value
*array_obj
, const char *val
);
961 @brief Appends an empty array value object to the array value object
964 This is a convenience function which creates the underlying array value
965 object before appending it.
967 @param[in] array_obj Array value object in which to append an
968 empty array value object
969 @returns Status code.
971 @prenotnull{array_obj}
972 @pre \p array_obj is an array value object.
974 @postrefcountsame{array_obj}
976 @sa bt_value_array_append(): Appends a value object to a given
979 extern enum bt_value_status
bt_value_array_append_empty_array(
980 struct bt_value
*array_obj
);
983 @brief Appends an empty map value object to the array value object
986 This is a convenience function which creates the underlying map value
987 object before appending it.
989 @param[in] array_obj Array value object in which to append an empty
991 @returns Status code.
993 @prenotnull{array_obj}
994 @pre \p array_obj is an array value object.
996 @postrefcountsame{array_obj}
998 @sa bt_value_array_append(): Appends a value object to a given
1001 extern enum bt_value_status
bt_value_array_append_empty_map(
1002 struct bt_value
*array_obj
);
1005 @brief Replaces the value object contained in the array value object
1006 \p array_obj at the index \p index by \p element_obj.
1008 @param[in] array_obj Array value object in which to replace
1010 @param[in] index Index of value object to replace in
1012 @param[in] element_obj New value object at position \p index of
1014 @returns Status code.
1016 @prenotnull{array_obj}
1017 @prenotnull{element_obj}
1018 @pre \p array_obj is an array value object.
1019 @pre \p index is lesser than the size of \p array_obj (see
1020 bt_value_array_size()).
1022 @post <strong>On success, if the replaced value object is not
1023 \ref bt_value_null</strong>, its reference count is decremented.
1024 @post <strong>On success, if \p element_obj is not
1025 \ref bt_value_null</strong>, its reference count is incremented.
1026 @postrefcountsame{array_obj}
1028 extern enum bt_value_status
bt_value_array_set(struct bt_value
*array_obj
,
1029 uint64_t index
, struct bt_value
*element_obj
);
1034 @name Map value object functions
1039 @brief Creates an empty map value object.
1041 @returns Created map value object on success, or \c NULL on error.
1043 @postsuccessrefcountret1
1045 extern struct bt_value
*bt_value_map_create(void);
1048 @brief Returns the size of the map value object \p map_obj, that is, the
1049 number of entries contained in \p map_obj.
1051 @param[in] map_obj Map value object of which to get the size.
1052 @returns Number of entries contained in \p map_obj if the
1053 return value is 0 (empty) or a positive value,
1054 or one of #bt_value_status negative values
1057 @prenotnull{map_obj}
1058 @pre \p map_obj is a map value object.
1059 @postrefcountsame{map_obj}
1061 @sa bt_value_map_is_empty(): Checks whether or not a given map value
1064 extern int64_t bt_value_map_size(const struct bt_value
*map_obj
);
1067 @brief Checks whether or not the map value object \p map_obj is empty.
1069 @param[in] map_obj Map value object to check.
1070 @returns #BT_TRUE if \p map_obj is empty.
1072 @prenotnull{map_obj}
1073 @pre \p map_obj is a map value object.
1074 @postrefcountsame{map_obj}
1076 @sa bt_value_map_size(): Returns the size of a given map value object.
1078 extern bt_bool
bt_value_map_is_empty(const struct bt_value
*map_obj
);
1081 @brief Returns the value object associated with the key \p key within
1082 the map value object \p map_obj.
1084 @param[in] map_obj Map value object of which to get an entry.
1085 @param[in] key Key of the value object to get.
1086 @returns Value object associated with the key \p key
1087 on success, or \c NULL on error.
1089 @prenotnull{map_obj}
1091 @pre \p map_obj is a map value object.
1092 @postrefcountsame{map_obj}
1093 @post <strong>On success, if the returned value object is not
1094 \ref bt_value_null</strong>, its reference count is incremented.
1096 extern struct bt_value
*bt_value_map_get(const struct bt_value
*map_obj
,
1100 @brief User function type to use with bt_value_map_foreach().
1102 \p object is a <em>weak reference</em>: you \em must pass it to bt_get()
1103 if you need to keep a reference after this function returns.
1105 This function \em must return #BT_TRUE to continue the map value object
1106 traversal, or #BT_FALSE to break it.
1108 @param[in] key Key of map entry.
1109 @param[in] object Value object of map entry (weak reference).
1110 @param[in] data User data.
1111 @returns #BT_TRUE to continue the loop, or #BT_FALSE to break it.
1115 @post The reference count of \p object is not lesser than what it is
1116 when the function is called.
1118 typedef bt_bool (* bt_value_map_foreach_cb
)(const char *key
,
1119 struct bt_value
*object
, void *data
);
1122 @brief Calls a provided user function \p cb for each value object of the
1123 map value object \p map_obj.
1125 The value object passed to the user function is a <b>weak reference</b>:
1126 you \em must pass it to bt_get() if you need to keep a persistent
1127 reference after the user function returns.
1129 The key passed to the user function is only valid in the scope of
1130 this user function call.
1132 The user function \em must return #BT_TRUE to continue the traversal of
1133 \p map_obj, or #BT_FALSE to break it.
1135 @param[in] map_obj Map value object on which to iterate.
1136 @param[in] cb User function to call back.
1137 @param[in] data User data passed to the user function.
1138 @returns Status code. More
1139 specifically, #BT_VALUE_STATUS_CANCELED is
1140 returned if the loop was canceled by the user
1143 @prenotnull{map_obj}
1145 @pre \p map_obj is a map value object.
1146 @postrefcountsame{map_obj}
1148 extern enum bt_value_status
bt_value_map_foreach(
1149 const struct bt_value
*map_obj
, bt_value_map_foreach_cb cb
,
1153 @brief Returns whether or not the map value object \p map_obj contains
1154 an entry mapped to the key \p key.
1156 @param[in] map_obj Map value object to check.
1157 @param[in] key Key to check.
1158 @returns #BT_TRUE if \p map_obj has an entry mapped to the
1159 key \p key, or #BT_FALSE if it does not or
1162 @prenotnull{map_obj}
1164 @pre \p map_obj is a map value object.
1165 @postrefcountsame{map_obj}
1167 extern bt_bool
bt_value_map_has_key(const struct bt_value
*map_obj
,
1171 @brief Inserts the value object \p element_obj mapped to the key
1172 \p key into the map value object \p map_obj.
1174 If a value object is already mapped to \p key in \p map_obj, the
1175 associated value object is first put, and then replaced by
1178 On success, \p key is copied.
1180 @param[in] map_obj Map value object in which to insert
1182 @param[in] key Key (copied on success) to which the
1183 value object to insert is mapped.
1184 @param[in] element_obj Value object to insert, mapped to the
1186 @returns Status code.
1188 @prenotnull{map_obj}
1190 @prenotnull{element_obj}
1191 @pre \p map_obj is a map value object.
1193 @post <strong>On success, if \p element_obj is not
1194 \ref bt_value_null</strong>, its reference count is incremented.
1195 @postrefcountsame{map_obj}
1197 @sa bt_value_map_insert_bool(): Inserts a boolean raw value into a
1198 given map value object.
1199 @sa bt_value_map_insert_integer(): Inserts an integer raw value into
1200 a given map value object.
1201 @sa bt_value_map_insert_float(): Inserts a floating point number raw
1202 value into a given map value object.
1203 @sa bt_value_map_insert_string(): Inserts a string raw value into a
1204 given map value object.
1205 @sa bt_value_map_insert_empty_array(): Inserts an empty array value
1206 object into a given map value object.
1207 @sa bt_value_map_insert_empty_map(): Inserts an empty map value
1208 object into a given map value object.
1210 extern enum bt_value_status
bt_value_map_insert(
1211 struct bt_value
*map_obj
, const char *key
,
1212 struct bt_value
*element_obj
);
1215 @brief Inserts the boolean raw value \p val mapped to the key \p key
1216 into the map value object \p map_obj.
1218 This is a convenience function which creates the underlying boolean
1219 value object before inserting it.
1221 On success, \p key is copied.
1223 @param[in] map_obj Map value object in which to insert \p val.
1224 @param[in] key Key (copied on success) to which the boolean
1225 value object to insert is mapped.
1226 @param[in] val Boolean raw value to insert, mapped to
1228 @returns Status code.
1230 @prenotnull{map_obj}
1232 @pre \p map_obj is a map value object.
1234 @postrefcountsame{map_obj}
1236 @sa bt_value_map_insert(): Inserts a value object into a given map
1239 extern enum bt_value_status
bt_value_map_insert_bool(
1240 struct bt_value
*map_obj
, const char *key
, bt_bool val
);
1243 @brief Inserts the integer raw value \p val mapped to the key \p key
1244 into the map value object \p map_obj.
1246 This is a convenience function which creates the underlying integer
1247 value object before inserting it.
1249 On success, \p key is copied.
1251 @param[in] map_obj Map value object in which to insert \p val.
1252 @param[in] key Key (copied on success) to which the integer
1253 value object to insert is mapped.
1254 @param[in] val Integer raw value to insert, mapped to
1256 @returns Status code.
1258 @prenotnull{map_obj}
1260 @pre \p map_obj is a map value object.
1262 @postrefcountsame{map_obj}
1264 @sa bt_value_map_insert(): Inserts a value object into a given map
1267 extern enum bt_value_status
bt_value_map_insert_integer(
1268 struct bt_value
*map_obj
, const char *key
, int64_t val
);
1271 @brief Inserts the floating point number raw value \p val mapped to
1272 the key \p key into the map value object \p map_obj.
1274 This is a convenience function which creates the underlying floating
1275 point number value object before inserting it.
1277 On success, \p key is copied.
1279 @param[in] map_obj Map value object in which to insert \p val.
1280 @param[in] key Key (copied on success) to which the floating
1281 point number value object to insert is mapped.
1282 @param[in] val Floating point number raw value to insert,
1283 mapped to the key \p key.
1284 @returns Status code.
1286 @prenotnull{map_obj}
1288 @pre \p map_obj is a map value object.
1290 @postrefcountsame{map_obj}
1292 @sa bt_value_map_insert(): Inserts a value object into a given map
1295 extern enum bt_value_status
bt_value_map_insert_float(
1296 struct bt_value
*map_obj
, const char *key
, double val
);
1299 @brief Inserts the string raw value \p val mapped to the key \p key
1300 into the map value object \p map_obj.
1302 This is a convenience function which creates the underlying string value
1303 object before inserting it.
1305 On success, \p val and \p key are copied.
1307 @param[in] map_obj Map value object in which to insert \p val.
1308 @param[in] key Key (copied on success) to which the string
1309 value object to insert is mapped.
1310 @param[in] val String raw value to insert (copied on success),
1311 mapped to the key \p key.
1312 @returns Status code.
1314 @prenotnull{map_obj}
1317 @pre \p map_obj is a map value object.
1319 @postrefcountsame{map_obj}
1321 @sa bt_value_map_insert(): Inserts a value object into a given map
1324 extern enum bt_value_status
bt_value_map_insert_string(
1325 struct bt_value
*map_obj
, const char *key
, const char *val
);
1328 @brief Inserts an empty array value object mapped to the key \p key
1329 into the map value object \p map_obj.
1331 This is a convenience function which creates the underlying array value
1332 object before inserting it.
1334 On success, \p key is copied.
1336 @param[in] map_obj Map value object in which to insert an empty
1338 @param[in] key Key (copied on success) to which the empty array
1339 value object to insert is mapped.
1340 @returns Status code.
1342 @prenotnull{map_obj}
1344 @pre \p map_obj is a map value object.
1346 @postrefcountsame{map_obj}
1348 @sa bt_value_map_insert(): Inserts a value object into a given map
1351 extern enum bt_value_status
bt_value_map_insert_empty_array(
1352 struct bt_value
*map_obj
, const char *key
);
1355 @brief Inserts an empty map value object mapped to the key \p key into
1356 the map value object \p map_obj.
1358 This is a convenience function which creates the underlying map value
1359 object before inserting it.
1361 On success, \p key is copied.
1363 @param[in] map_obj Map value object in which to insert an empty
1365 @param[in] key Key (copied on success) to which the empty map
1366 value object to insert is mapped.
1367 @returns Status code.
1369 @prenotnull{map_obj}
1371 @pre \p map_obj is a map value object.
1373 @postrefcountsame{map_obj}
1375 @sa bt_value_map_insert(): Inserts a value object into a given map
1378 extern enum bt_value_status
bt_value_map_insert_empty_map(
1379 struct bt_value
*map_obj
, const char *key
);
1382 @brief Creates a copy of the base map value object \p base_map_obj
1383 superficially extended with the entries of the extension map
1384 value object \p extension_map_obj.
1386 This function creates a superficial extension of \p base_map_obj with
1387 \p extension_map_obj by adding new entries to it and replacing the
1388 ones that share the keys in the extension object. The extension is
1389 \em superficial because it does not merge internal array and map
1392 For example, consider the following \p base_map_obj (JSON representation):
1399 "return": [5, 6, null]
1403 and the following \p extension_map_obj (JSON representation):
1413 The extended object is (JSON representation):
1425 @param[in] base_map_obj Base map value object with initial
1427 @param[in] extension_map_obj Extension map value object containing
1428 the entries to add to or replace in
1430 @returns Created extended map value object, or
1433 @prenotnull{base_map_obj}
1434 @prenotnull{extension_map_obj}
1435 @pre \p base_map_obj is a map value object.
1436 @pre \p extension_map_obj is a map value object.
1437 @postrefcountsame{base_map_obj}
1438 @postrefcountsame{extension_map_obj}
1439 @postsuccessrefcountret1
1441 extern struct bt_value
*bt_value_map_extend(struct bt_value
*base_map_obj
,
1442 struct bt_value
*extension_map_obj
);
1452 #endif /* BABELTRACE_VALUES_H */