Rename bt_ctf_X -> bt_X, maintain backward compat. for pre-2.0 CTF writer

[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..1ea43f691267e51bcd64c37df238b4f2382047ce 100644 (file)
--- a/include/babeltrace/ctf-ir/trace-internal.h
+++ b/include/babeltrace/ctf-ir/trace-internal.h
@@ -33,9 +33,10 @@
 #include <babeltrace/object-internal.h>
 #include <babeltrace/babeltrace-internal.h>
 #include <babeltrace/values.h>
+#include <babeltrace/types.h>
 #include <glib.h>
 #include <sys/types.h>
-#include <uuid/uuid.h>
+#include <babeltrace/compat/uuid-internal.h>
 
 enum field_type_alias {
        FIELD_TYPE_ALIAS_UINT5_T = 0,
@@ -47,18 +48,19 @@ enum field_type_alias {
        NR_FIELD_TYPE_ALIAS,
 };
 
-struct bt_ctf_trace {
+struct bt_trace {
        struct bt_object base;
        GString *name;
        int frozen;
-       uuid_t uuid;
-       enum bt_ctf_byte_order native_byte_order;
+       unsigned char uuid[BABELTRACE_UUID_LEN];
+       bt_bool uuid_set;
+       enum bt_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;
+       GPtrArray *clocks; /* Array of pointers to bt_clock_class */
+       GPtrArray *stream_classes; /* Array of ptrs to bt_stream_class */
+       GPtrArray *streams; /* Array of ptrs to bt_stream */
+       struct bt_field_type *packet_header_type;
+       int64_t next_stream_id;
        int is_created_by_writer;
 
        /*
@@ -67,6 +69,9 @@ struct bt_ctf_trace {
         */
        int valid;
        GPtrArray *listeners; /* Array of struct listener_wrapper */
+       GArray *is_static_listeners;
+       bt_bool is_static;
+       bt_bool in_remove_listener;
 };
 
 struct metadata_context {
@@ -79,14 +84,59 @@ BT_HIDDEN
 const char *get_byte_order_string(int byte_order);
 
 BT_HIDDEN
-struct bt_ctf_field_type *get_field_type(enum field_type_alias alias);
+struct bt_field_type *get_field_type(enum field_type_alias alias);
 
 BT_HIDDEN
-int bt_ctf_trace_object_modification(struct bt_ctf_object *object,
+int bt_trace_object_modification(struct bt_visitor_object *object,
                void *trace_ptr);
 
 BT_HIDDEN
-bool bt_ctf_trace_has_clock_class(struct bt_ctf_trace *trace,
-               struct bt_ctf_clock_class *clock_class);
+bt_bool bt_trace_has_clock_class(struct bt_trace *trace,
+               struct bt_clock_class *clock_class);
+
+/**
+@brief User function type to use with bt_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_listener_cb)(struct bt_visitor_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_trace_add_listener(struct bt_trace *trace_class,
+               bt_listener_cb listener, void *data);
+
+/*
+ * bt_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_trace_get_metadata_string(struct bt_trace *trace);
 
 #endif /* BABELTRACE_CTF_IR_TRACE_INTERNAL_H */