Internalize trace listener API and bt_ctf_trace_get_metadata_string()

[babeltrace.git] / include / babeltrace / ctf-ir / trace-internal.h

diff --git a/include/babeltrace/ctf-ir/trace-internal.h b/include/babeltrace/ctf-ir/trace-internal.h
index d332a581049d9cf798af161c3597ca4be5a60a8d..f49e85bc1d09d7f7dbf1d013a8bda0ebeaf43c54 100644 (file)
--- a/include/babeltrace/ctf-ir/trace-internal.h
+++ b/include/babeltrace/ctf-ir/trace-internal.h
@@ -52,13 +52,14 @@ struct bt_ctf_trace {
        GString *name;
        int frozen;
        uuid_t uuid;
+       bool uuid_set;
        enum bt_ctf_byte_order native_byte_order;
        struct bt_value *environment;
        GPtrArray *clocks; /* Array of pointers to bt_ctf_clock_class */
        GPtrArray *stream_classes; /* Array of ptrs to bt_ctf_stream_class */
        GPtrArray *streams; /* Array of ptrs to bt_ctf_stream */
        struct bt_ctf_field_type *packet_header_type;
-       uint64_t next_stream_id;
+       int64_t next_stream_id;
        int is_created_by_writer;
 
        /*
@@ -67,6 +68,7 @@ struct bt_ctf_trace {
         */
        int valid;
        GPtrArray *listeners; /* Array of struct listener_wrapper */
+       bool is_static;
 };
 
 struct metadata_context {
@@ -89,4 +91,49 @@ BT_HIDDEN
 bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace *trace,
                struct bt_ctf_clock_class *clock_class);
 
+/**
+@brief User function type to use with bt_ctf_trace_add_listener().
+
+@param[in] obj New CTF IR object which is part of the trace
+               class hierarchy.
+@param[in] data        User data.
+
+@prenotnull{obj}
+*/
+typedef void (*bt_ctf_listener_cb)(struct bt_ctf_object *obj, void *data);
+
+/**
+@brief Adds the trace class modification listener \p listener to
+       the CTF IR trace class \p trace_class.
+
+Once you add \p listener to \p trace_class, whenever \p trace_class
+is modified, \p listener is called with the new element and with
+\p data (user data).
+
+@param[in] trace_class Trace class to which to add \p listener.
+@param[in] listener    Modification listener function.
+@param[in] data                User data.
+@returns               0 on success, or a negative value on error.
+
+@prenotnull{trace_class}
+@prenotnull{listener}
+@postrefcountsame{trace_class}
+*/
+BT_HIDDEN
+int bt_ctf_trace_add_listener(struct bt_ctf_trace *trace_class,
+               bt_ctf_listener_cb listener, void *data);
+
+/*
+ * bt_ctf_trace_get_metadata_string: get metadata string.
+ *
+ * Get the trace's TSDL metadata. The caller assumes the ownership of the
+ * returned string.
+ *
+ * @param trace Trace instance.
+ *
+ * Returns the metadata string on success, NULL on error.
+ */
+BT_HIDDEN
+char *bt_ctf_trace_get_metadata_string(struct bt_ctf_trace *trace);
+
 #endif /* BABELTRACE_CTF_IR_TRACE_INTERNAL_H */