-/** @} */
-
-/**
-@name Misc. functions
-@{
-*/
-
-/** @} */
-
-/** @} */
-
-/**
-@defgroup ctfirintfield CTF IR integer field
-@ingroup ctfirfields
-@brief CTF IR integer field.
-
-@code
-#include <babeltrace/ctf-ir/fields.h>
-@endcode
-
-A CTF IR <strong><em>integer field</em></strong> is a @field which
-holds a signed or unsigned integral value, and which is described by
-a @intft.
-
-An integer field object is considered \em unsigned if
-bt_field_type_integer_get_signed() on its parent field type returns
-0. Otherwise it is considered \em signed. You \em must use
-bt_field_integer_unsigned_get_value() and
-bt_field_integer_unsigned_set_value() with an unsigned integer
-field, and bt_field_integer_signed_get_value() and
-bt_field_integer_signed_set_value() with a signed integer field.
-
-After you create an integer field with bt_field_create(), you
-\em must set an integral value with
-bt_field_integer_unsigned_set_value() or
-bt_field_integer_signed_set_value() before you can get the
-field's value with bt_field_integer_unsigned_get_value() or
-bt_field_integer_signed_get_value().
-
-@sa ctfirintfieldtype
-@sa ctfirfields
-
-@addtogroup ctfirintfield
-@{
-*/
-
-/**
-@brief Returns the signed integral value of the @intfield
- \p integer_field.
-
-@param[in] integer_field Integer field of which to get the
- signed integral value.
-@param[out] value Returned signed integral value of
- \p integer_field.
-@returns 0 on success, or a negative value on
- error, including if \p integer_field
- has no integral value yet.
-
-@prenotnull{integer_field}
-@prenotnull{value}
-@preisintfield{integer_field}
-@pre bt_field_type_integer_get_signed() returns 1 for the parent
- @ft of \p integer_field.
-@pre \p integer_field contains a signed integral value previously
- set with bt_field_integer_signed_set_value().
-@postrefcountsame{integer_field}
-
-@sa bt_field_integer_signed_set_value(): Sets the signed integral
- value of a given integer field.
-*/
-extern int bt_field_integer_signed_get_value(
- struct bt_field *integer_field, int64_t *value);
-
-/**
-@brief Sets the signed integral value of the @intfield
- \p integer_field to \p value.
-
-@param[in] integer_field Integer field of which to set
- the signed integral value.
-@param[in] value New signed integral value of
- \p integer_field.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{integer_field}
-@preisintfield{integer_field}
-@prehot{integer_field}
-@pre bt_field_type_integer_get_signed() returns 1 for the parent
- @ft of \p integer_field.
-@postrefcountsame{integer_field}
-
-@sa bt_field_integer_signed_get_value(): Returns the signed integral
- value of a given integer field.
-*/
-extern int bt_field_integer_signed_set_value(
- struct bt_field *integer_field, int64_t value);
-
-/**
-@brief Returns the unsigned integral value of the @intfield
- \p integer_field.
-
-@param[in] integer_field Integer field of which to get the
- unsigned integral value.
-@param[out] value Returned unsigned integral value of
- \p integer_field.
-@returns 0 on success, or a negative value on
- error, including if \p integer_field
- has no integral value yet.
-
-@prenotnull{integer_field}
-@prenotnull{value}
-@preisintfield{integer_field}
-@pre bt_field_type_integer_get_signed() returns 0 for the parent
- @ft of \p integer_field.
-@pre \p integer_field contains an unsigned integral value previously
- set with bt_field_integer_unsigned_set_value().
-@postrefcountsame{integer_field}
-
-@sa bt_field_integer_unsigned_set_value(): Sets the unsigned
- integral value of a given integer field.
-*/
-extern int bt_field_integer_unsigned_get_value(
- struct bt_field *integer_field, uint64_t *value);
-
-/**
-@brief Sets the unsigned integral value of the @intfield
- \p integer_field to \p value.
-
-@param[in] integer_field Integer field of which to set
- the unsigned integral value.
-@param[in] value New unsigned integral value of
- \p integer_field.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{integer_field}
-@preisintfield{integer_field}
-@prehot{integer_field}
-@pre bt_field_type_integer_get_signed() returns 0 for the parent
- @ft of \p integer_field.
-@postrefcountsame{integer_field}
-
-@sa bt_field_integer_unsigned_get_value(): Returns the unsigned
- integral value of a given integer field.
-*/
-extern int bt_field_integer_unsigned_set_value(
- struct bt_field *integer_field, uint64_t value);
-
-/** @} */
-
-/**
-@defgroup ctfirfloatfield CTF IR floating point number field
-@ingroup ctfirfields
-@brief CTF IR floating point number field.
-
-@code
-#include <babeltrace/ctf-ir/fields.h>
-@endcode
-
-A CTF IR <strong><em>floating point number field</em></strong> is a
-@field which holds a floating point number value, and which is
-described by a @floatft.
-
-After you create a floating point number field with bt_field_create(), you
-\em must set a floating point number value with
-bt_field_floating_point_set_value() before you can get the
-field's value with bt_field_floating_point_get_value().
-
-@sa ctfirfloatfieldtype
-@sa ctfirfields
-
-@addtogroup ctfirfloatfield
-@{
-*/
-
-/**
-@brief Returns the floating point number value of the @floatfield
- \p float_field.
-
-@param[in] float_field Floating point number field of which to get the
- floating point number value.
-@param[out] value Returned floating point number value of
- \p float_field.
-@returns 0 on success, or a negative value on error,
- including if \p float_field has no floating
- point number value yet.
-
-@prenotnull{float_field}
-@prenotnull{value}
-@preisfloatfield{float_field}
-@pre \p float_field contains a floating point number value previously
- set with bt_field_floating_point_set_value().
-@postrefcountsame{float_field}
-
-@sa bt_field_floating_point_set_value(): Sets the floating point
- number value of a given floating point number field.
-*/
-extern int bt_field_floating_point_get_value(
- struct bt_field *float_field, double *value);
-
-/**
-@brief Sets the floating point number value of the @floatfield
- \p float_field to \p value.
-
-@param[in] float_field Floating point number field of which to set
- the floating point number value.
-@param[in] value New floating point number value of
- \p float_field.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{float_field}
-@preisfloatfield{float_field}
-@prehot{float_field}
-@postrefcountsame{float_field}
-
-@sa bt_field_floating_point_get_value(): Returns the floating point
- number value of a given floating point number field.
-*/
-extern int bt_field_floating_point_set_value(
- struct bt_field *float_field, double value);
-
-/** @} */
-
-/**
-@brief Returns a @enumftiter on all the mappings of the field type of
- \p enum_field which contain the current integral value of the
- @enumfield \p enum_field in their range.
-
-This function is the equivalent of using
-bt_field_type_enumeration_find_mappings_by_unsigned_value() or
-bt_field_type_enumeration_find_mappings_by_signed_value() with the
-current integral value of \p enum_field.
-
-@param[in] enum_field Enumeration field of which to get the mappings
- containing the current integral value of \p
- enum_field in their range.
-@returns @enumftiter on the set of mappings of the field
- type of \p enum_field which contain the current
- integral value of \p enum_field in their range,
- or \c NULL if no mappings were found or on
- error.
-
-@prenotnull{enum_field}
-@preisenumfield{enum_field}
-@pre The wrapped integer field of \p enum_field contains an integral
- value.
-@postrefcountsame{enum_field}
-@postsuccessrefcountret1
-@post <strong>On success</strong>, the returned @enumftiter can iterate
- on at least one mapping.
-*/
-extern struct bt_field_type_enumeration_mapping_iterator *
-bt_field_enumeration_get_mappings(struct bt_field *enum_field);
-
-/** @} */
-
-/**
-@defgroup ctfirstringfield CTF IR string field
-@ingroup ctfirfields
-@brief CTF IR string field.
-
-@code
-#include <babeltrace/ctf-ir/fields.h>
-@endcode
-
-A CTF IR <strong><em>string field</em></strong> is a @field which holds
-a string value, and which is described by a @stringft.
-
-Use bt_field_string_set_value() to set the current string value
-of a string field object. You can also use bt_field_string_append()
-and bt_field_string_append_len() to append a string to the current
-value of a string field.
-
-After you create a string field with bt_field_create(), you
-\em must set a string value with
-bt_field_string_set_value(), bt_field_string_append(), or
-bt_field_string_append_len() before you can get the
-field's value with bt_field_string_get_value().
-
-@sa ctfirstringfieldtype
-@sa ctfirfields
-
-@addtogroup ctfirstringfield
-@{
-*/
-
-/**
-@brief Returns the string value of the @stringfield \p string_field.
-
-On success, \p string_field remains the sole owner of the returned
-value.
-
-@param[in] string_field String field field of which to get the
- string value.
-@returns String value, or \c NULL on error.
-
-@prenotnull{string_field}
-@prenotnull{value}
-@preisstringfield{string_field}
-@pre \p string_field contains a string value previously
- set with bt_field_string_set_value(),
- bt_field_string_append(), or
- bt_field_string_append_len().
-@postrefcountsame{string_field}
-
-@sa bt_field_string_set_value(): Sets the string value of a given
- string field.
-*/
-extern const char *bt_field_string_get_value(struct bt_field *string_field);
-
-/**
-@brief Sets the string value of the @stringfield \p string_field to
- \p value.
-
-@param[in] string_field String field of which to set
- the string value.
-@param[in] value New string value of \p string_field (copied
- on success).
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{string_field}
-@prenotnull{value}
-@preisstringfield{string_field}
-@prehot{string_field}
-@postrefcountsame{string_field}
-
-@sa bt_field_string_get_value(): Returns the string value of a
- given string field.
-*/
-extern int bt_field_string_set_value(struct bt_field *string_field,
- const char *value);
-
-/**
-@brief Appends the string \p value to the current string value of
- the @stringfield \p string_field.
-
-This function is the equivalent of:
-
-@code
-bt_field_string_append_len(string_field, value, strlen(value));
-@endcode
-
-@param[in] string_field String field of which to append \p value to
- its current value.
-@param[in] value String to append to the current string value
- of \p string_field (copied on success).
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{string_field}
-@prenotnull{value}
-@preisstringfield{string_field}
-@prehot{string_field}
-@postrefcountsame{string_field}
-
-@sa bt_field_string_set_value(): Sets the string value of a given
- string field.
-*/
-extern int bt_field_string_append(struct bt_field *string_field,
- const char *value);
-
-/**
-@brief Appends the first \p length characters of \p value to the
- current string value of the @stringfield \p string_field.
-
-If \p string_field has no current string value, this function first
-sets an empty string as the string value of \p string_field and then
-appends the first \p length characters of \p value.
-
-@param[in] string_field String field of which to append the first
- \p length characters of \p value to
- its current value.
-@param[in] value String containing the characters to append to
- the current string value of \p string_field
- (copied on success).
-@param[in] length Number of characters of \p value to append to
- the current string value of \p string_field.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{string_field}
-@prenotnull{value}
-@preisstringfield{string_field}
-@prehot{string_field}
-@postrefcountsame{string_field}
-
-@sa bt_field_string_set_value(): Sets the string value of a given
- string field.
-*/
-extern int bt_field_string_append_len(
- struct bt_field *string_field, const char *value,
- unsigned int length);
-
-extern int bt_field_string_clear(struct bt_field *string_field);
-
-/** @} */
-
-/**
-@defgroup ctfirstructfield CTF IR structure field
-@ingroup ctfirfields
-@brief CTF IR structure field.
-
-@code
-#include <babeltrace/ctf-ir/fields.h>
-@endcode
-
-A CTF IR <strong><em>structure field</em></strong> is a @field which
-contains an ordered list of zero or more named @fields which can be
-different @fts, and which is described by a @structft.
-
-To set the value of a specific field of a structure field, you need to
-first get the field with bt_field_structure_get_field_by_name() or
-bt_field_structure_get_field_by_index(). If you already have a
-field object, you can assign it to a specific name within a structure
-field with bt_field_structure_set_field_by_name().
-
-@sa ctfirstructfieldtype
-@sa ctfirfields
-
-@addtogroup ctfirstructfield
-@{
-*/
-
-extern struct bt_field *bt_field_structure_borrow_field_by_name(
- struct bt_field *struct_field, const char *name);
-
-extern struct bt_field *bt_field_structure_borrow_field_by_index(
- struct bt_field *struct_field, uint64_t index);
-
-/** @} */
-
-/**
-@defgroup ctfirarrayfield CTF IR array field
-@ingroup ctfirfields
-@brief CTF IR array field.
-
-@code
-#include <babeltrace/ctf-ir/fields.h>
-@endcode
-
-A CTF IR <strong><em>array field</em></strong> is a @field which
-contains an ordered list of zero or more @fields sharing the same @ft,
-and which is described by a @arrayft.
-
-To set the value of a specific field of an array field, you need to
-first get the field with bt_field_array_get_field().
-
-@sa ctfirarrayfieldtype
-@sa ctfirfields
-
-@addtogroup ctfirarrayfield
-@{
-*/
-
-extern struct bt_field *bt_field_array_borrow_field(
- struct bt_field *array_field, uint64_t index);
-
-/** @} */
-
-/**
-@defgroup ctfirseqfield CTF IR sequence field
-@ingroup ctfirfields
-@brief CTF IR sequence field.
-
-@code
-#include <babeltrace/ctf-ir/fields.h>
-@endcode
-
-A CTF IR <strong><em>sequence field</em></strong> is a @field which
-contains an ordered list of zero or more @fields sharing the same @ft,
-and which is described by a @seqft.
-
-Before you can get a specific field of a sequence field with
-bt_field_sequence_get_field(), you need to set its current length
-@intfield with bt_field_sequence_set_length(). The integral value of
-the length field of a sequence field indicates the number of fields
-it contains.