-- Adding a stream class to it with
- bt_ctf_trace_add_stream_class().
-- Adding a CTF IR clock class to it with bt_ctf_trace_add_clock_class().
-- \link refs Reference counting\endlink.
-
-You can add a custom listener with bt_ctf_trace_add_listener() to get
-notified if anything changes in a trace class, that is, if an event
-class is added to one of its stream class, if a stream class is added,
-or if a clock class is added.
-
-@sa ctfirstreamclass
-@sa ctfireventclass
-@sa ctfirclockclass
-
-@file
-@brief CTF IR trace class type and functions.
-@sa ctfirtraceclass
-
-@addtogroup ctfirtraceclass
-@{
-*/
-
-/**
-@struct bt_ctf_trace
-@brief A CTF IR trace class.
-@sa ctfirtraceclass
-*/
-struct bt_ctf_trace;
-struct bt_ctf_stream;
-struct bt_ctf_stream_class;
-struct bt_ctf_clock_class;
-
-/**
-@name Creation function
-@{
-*/
-
-/**
-@brief Creates a default CTF IR trace class.
-
-On success, the trace packet header field type of the created trace
-class has the following fields:
-
-- <code>magic</code>: a 32-bit unsigned integer field type.
-- <code>uuid</code>: an array field type of 16 8-bit unsigned integer
- field types.
-- <code>stream_id</code>: a 32-bit unsigned integer field type.
-
-You can modify this default trace packet header field type after the
-trace class is created with bt_ctf_trace_set_packet_header_type().
-
-The created trace class has the following initial properties:
-
-- <strong>Name</strong>: none. You can set a name
- with bt_ctf_trace_set_name().
-- <strong>Default byte order</strong>: #BT_CTF_BYTE_ORDER_NATIVE. You
- can set a default byte order with bt_ctf_trace_set_byte_order().
-
- Note that you \em must set the default byte order if any field type
- contained in the created trace class, in its stream classes, or in
- its event classes, has a byte order set to #BT_CTF_BYTE_ORDER_NATIVE.
-- <strong>Environment</strong>: empty. You can add environment entries
- with bt_ctf_trace_set_environment_field(),
- bt_ctf_trace_set_environment_field_integer(), and
- bt_ctf_trace_set_environment_field_string().
-
-@returns Created trace class, or \c NULL on error.
-
-@postsuccessrefcountret1
-*/
-extern struct bt_ctf_trace *bt_ctf_trace_create(void);
-
-/** @} */
-
-/**
-@name Properties functions
-@{
-*/
-
-/**
-@brief Returns the name of the CTF IR trace class \p trace_class.
-
-On success, \p trace_class remains the sole owner of the returned
-string. The returned string is valid as long as \p trace_class exists
-and is not modified.
-
-@param[in] trace_class Trace class of which to get the name.
-@returns Name of trace class \p trace_class, or
- \c NULL if \p trace_class is unnamed or
- on error.
-
-@prenotnull{trace_class}
-@postrefcountsame{trace_class}
-
-@sa bt_ctf_trace_set_name(): Sets the name of a given trace class.
-*/
-extern const char *bt_ctf_trace_get_name(struct bt_ctf_trace *trace_class);
-
-/**
-@brief Sets the name of the CTF IR trace class \p trace_class
- to \p name.
-
-@param[in] trace_class Trace class of which to set the name.
-@param[in] name Name of the trace class (copied on success).
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{trace_class}
-@prenotnull{name}
-@prehot{trace_class}
-@postrefcountsame{trace_class}
-
-@sa bt_ctf_trace_get_name(): Returns the name of a given trace class.
-*/
-extern int bt_ctf_trace_set_name(struct bt_ctf_trace *trace_class,
- const char *name);
-
-/**
-@brief Returns the default byte order of the CTF IR trace class
- \p trace_class.
-
-@param[in] trace_class Trace class of which to get the default byte
- order.
-@returns Default byte order of trace class
- \p trace_class, or #BT_CTF_BYTE_ORDER_UNKNOWN
- on error.
-
-@prenotnull{trace_class}
-@postrefcountsame{trace_class}
-
-@sa bt_ctf_trace_set_name(): Sets the name of a given trace class.
-*/
-extern enum bt_ctf_byte_order bt_ctf_trace_get_byte_order(
- struct bt_ctf_trace *trace_class);
-
-/**
-@brief Sets the default byte order of the CTF IR trace class
- \p trace_class to \p name.
-
-\p byte_order \em must be one of:
-
-- #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN
-- #BT_CTF_BYTE_ORDER_BIG_ENDIAN
-- #BT_CTF_BYTE_ORDER_NETWORK
-
-@param[in] trace_class Trace class of which to set the default byte
- order.
-@param[in] byte_order Default byte order of the trace class.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{trace_class}
-@prenotnull{name}
-@prehot{trace_class}
-@pre \p byte_order is either #BT_CTF_BYTE_ORDER_LITTLE_ENDIAN,
- #BT_CTF_BYTE_ORDER_BIG_ENDIAN, or
- #BT_CTF_BYTE_ORDER_NETWORK.
-@postrefcountsame{trace_class}
-
-@sa bt_ctf_trace_get_name(): Returns the name of a given trace class.
-*/
-extern int bt_ctf_trace_set_byte_order(struct bt_ctf_trace *trace_class,
- enum bt_ctf_byte_order byte_order);
-
-/**
-@brief Returns the number of entries contained in the environment of
- the CTF IR trace class \p trace_class.
-
-@param[in] trace_class Trace class of which to get the number
- of environment entries.
-@returns Number of environment entries
- contained in \p trace_class, or
- a negative value on error.
-
-@prenotnull{trace_class}
-@postrefcountsame{trace_class}
-*/
-extern int bt_ctf_trace_get_environment_field_count(
- struct bt_ctf_trace *trace_class);
-
-/**
-@brief Returns the field name of the environment entry at index
- \p index in the CTF IR trace class \p trace_class.
-
-On success, the returned string is valid as long as this trace class
-exists and is \em not modified. \p trace_class remains the sole owner of
-the returned string.
-
-@param[in] trace_class Trace class of which to get the name of the
- environment entry at index \p index.
-@param[in] index Index of environment entry to find.
-@returns Name of the environment entry at index \p index
- in \p trace_class, or \c NULL on error.
-
-@prenotnull{trace_class}
-@pre \p index is lesser than the number of environment entries in
- \p trace_class (see bt_ctf_trace_get_environment_field_count()).
-@postrefcountsame{trace_class}
-
-@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's
- environment entry by index.
-@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace
- class's environment entry by name.
-@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace
- class's environment entry.
-*/
-extern const char *
-bt_ctf_trace_get_environment_field_name(struct bt_ctf_trace *trace_class,
- int index);
-
-/**
-@brief Returns the value of the environment entry at index
- \p index in the CTF IR trace class \p trace_class.
-
-@param[in] trace_class Trace class of which to get the value of the
- environment entry at index \p index.
-@param[in] index Index of the environment entry to find.
-@returns Value of the environment entry at index \p index
- in \p trace_class, or \c NULL on error.
-
-@prenotnull{trace_class}
-@pre \p index is lesser than the number of environment entries in
- \p trace_class (see bt_ctf_trace_get_environment_field_count()).
-@postrefcountsame{trace_class}
-@postsuccessrefcountretinc
-
-@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace
- class's environment entry by name.
-@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace
- class's environment entry.
-*/
-extern struct bt_value *
-bt_ctf_trace_get_environment_field_value(struct bt_ctf_trace *trace_class,
- int index);
-
-/**
-@brief Returns the value of the environment entry named \p name
- in the CTF IR trace class \p trace_class.
-
-@param[in] trace_class Trace class of which to get the value of the
- environment entry named \p name.
-@param[in] name Name of the environment entry to find.
-@returns Value of the environment entry named \p name
- in \p trace_class, or \c NULL if there's no such
- entry or on error.
-
-@prenotnull{trace_class}
-@prenotnull{name}
-@postrefcountsame{trace_class}
-@postsuccessrefcountretinc
-
-@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's
- environment entry by index.
-@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace
- class's environment entry.
-*/
-extern struct bt_value *
-bt_ctf_trace_get_environment_field_value_by_name(
- struct bt_ctf_trace *trace_class, const char *name);
-
-/**
-@brief Sets the environment entry named \p name in the
- CTF IR trace class \p trace_class to \p value.
-
-If an environment entry named \p name exists in \p trace_class, its
-value is first put, and then replaced by \p value.
-
-@param[in] trace_class Trace class of which to set the environment
- entry.
-@param[in] name Name of the environment entry to set (copied
- on success).
-@param[in] value Value of the environment entry named \p name.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{trace_class}
-@prenotnull{name}
-@prenotnull{value}
-@prehot{trace_class}
-@pre \p value is an
- \link bt_value_integer_create() integer value object\endlink
- or a
- \link bt_value_string_create() string value object\endlink.
-@postrefcountsame{trace_class}
-@postsuccessrefcountinc{value}
-
-@sa bt_ctf_trace_get_environment_field_value(): Finds a trace class's
- environment entry by index.
-@sa bt_ctf_trace_get_environment_field_value_by_name(): Finds a trace
- class's environment entry by name.
-*/
-extern int bt_ctf_trace_set_environment_field(
- struct bt_ctf_trace *trace_class, const char *name,
- struct bt_value *value);
-
-/**
-@brief Sets the environment entry named \p name in the
- CTF IR trace class \p trace_class to \p value.
-
-If an environment entry named \p name exists in \p trace_class, its
-value is first put, and then replaced by a new
-\link bt_value_integer_create() integer value object\endlink
-containing \p value.
-
-@param[in] trace_class Trace class of which to set the environment
- entry.
-@param[in] name Name of the environment entry to set (copied
- on success).
-@param[in] value Value of the environment entry named \p name.
-@returns 0 on success, or a negative value on error.
-
-@prenotnull{trace_class}
-@prenotnull{name}
-@prehot{trace_class}
-@postrefcountsame{trace_class}
-
-@sa bt_ctf_trace_set_environment_field(): Sets the value of a trace
- class's environment entry.
-*/
-extern int bt_ctf_trace_set_environment_field_integer(
- struct bt_ctf_trace *trace_class, const char *name,