fix : callback type, doc and links to libbabeltrace

[babeltrace.git] / include / babeltrace / babeltrace.h

diff --git a/include/babeltrace/babeltrace.h b/include/babeltrace/babeltrace.h
index 792eeab08196b6c6b75efe39344973b2533912cf..c77ea7827614cb4d89c84d5c05f8c7c22a695bb2 100644 (file)
--- a/include/babeltrace/babeltrace.h
+++ b/include/babeltrace/babeltrace.h
@@ -17,21 +17,18 @@
  * all copies or substantial portions of the Software.
  */
 
-#include <glib.h>
-#include <stdint.h>
-#include <babeltrace/format.h>
 #include <babeltrace/context.h>
-
-typedef GQuark bt_event_name;
+#include <babeltrace/format.h>
+#include <babeltrace/iterator.h>
+#include <babeltrace/trace-collection.h>
+#include <babeltrace/trace-handle.h>
+#include <babeltrace/ctf/events.h>
 
 /* Forward declarations */
-struct babeltrace_iter;
-struct trace_collection;
+struct bt_iter;
 struct ctf_stream_event;
 struct ctf_stream;
-struct babeltrace_saved_pos;
 struct bt_dependencies;
-struct bt_context;
 
 enum bt_cb_ret {
        BT_CB_OK                = 0,
@@ -40,89 +37,6 @@ enum bt_cb_ret {
        BT_CB_ERROR_CONTINUE    = 3,
 };
 
-struct trace_collection_pos {
-       enum {
-               BT_SEEK_TIME,           /* uses u.seek_time */
-               BT_SEEK_RESTORE,        /* uses u.restore */
-               BT_SEEK_CUR,
-               BT_SEEK_BEGIN,
-               BT_SEEK_END,
-       } type;
-       union {
-               uint64_t seek_time;
-               struct babeltrace_saved_pos *restore;
-       } u;
-};
-
-struct bt_ctf_data {
-       struct ctf_stream_event *event;
-       struct ctf_stream *stream;
-};
-
-/*
- * babeltrace_iter_create - Allocate a trace collection iterator.
- *
- * begin_pos and end_pos are optional parameters to specify the position
- * at which the trace collection should be seeked upon iterator
- * creation, and the position at which iteration will start returning
- * "EOF".
- *
- * By default, if begin_pos is NULL, a BT_SEEK_CUR is performed at
- * creation. By default, if end_pos is NULL, a BT_SEEK_END (end of
- * trace) is the EOF criterion.
- */
-struct babeltrace_iter *babeltrace_iter_create(struct bt_context *ctx,
-               struct trace_collection_pos *begin_pos,
-               struct trace_collection_pos *end_pos);
-
-/*
- * babeltrace_iter_destroy - Free a trace collection iterator.
- */
-void babeltrace_iter_destroy(struct babeltrace_iter *iter);
-
-/*
- * babeltrace_iter_next: Move trace collection position to the next event.
- *
- * Returns 0 on success, a negative value on error
- */
-int babeltrace_iter_next(struct babeltrace_iter *iter);
-
-/*
- * babeltrace_iter_save_pos - Save the current trace collection position.
- *
- * The position returned by this function needs to be freed by
- * babeltrace_iter_free_pos after use.
- */
-struct trace_collection_pos *
-       babeltrace_iter_save_pos(struct babeltrace_iter *iter);
-
-/*
- * babeltrace_iter_free_pos - Free the position.
- */
-void babeltrace_iter_free_pos(struct trace_collection_pos *pos);
-
-/*
- * babeltrace_iter_seek: seek iterator to given position.
- *
- * Return EOF if position is after the last event of the trace collection.
- * Return other negative value for other errors.
- * Return 0 for success.
- */
-int babeltrace_iter_seek(struct babeltrace_iter *iter,
-               const struct trace_collection_pos *pos);
-
-/*
- * babeltrace_iter_read_event: Read the iterator's current event data.
- *
- * @iter: trace collection iterator (input)
- * @stream: stream containing event at current position (output)
- * @event: current event (output)
- * Return 0 on success, negative error value on error.
- */
-int babeltrace_iter_read_event(struct babeltrace_iter *iter,
-               struct ctf_stream **stream,
-               struct ctf_stream_event **event);
-
 /*
  * Receives a variable number of strings as parameter, ended with NULL.
  */
@@ -130,12 +44,12 @@ struct bt_dependencies *babeltrace_dependencies_create(const char *first, ...);
 
 /*
  * struct bt_dependencies must be destroyed explicitly if not passed as
- * parameter to a babeltrace_iter_add_callback().
+ * parameter to a bt_iter_add_callback().
  */
 void babeltrace_dependencies_destroy(struct bt_dependencies *dep);
 
 /*
- * babeltrace_iter_add_callback: Add a callback to iterator.
+ * bt_iter_add_callback: Add a callback to iterator.
  *
  * @iter: trace collection iterator (input)
  * @event: event to target. 0 for all events.
@@ -159,19 +73,19 @@ void babeltrace_dependencies_destroy(struct bt_dependencies *dep);
  * destroyed, but they belong to the babeltrace library.
  *
  * (note to implementor: we need to keep a gptrarray of struct
- * bt_dependencies to "garbage collect" in struct babeltrace_iter, and
+ * bt_dependencies to "garbage collect" in struct bt_iter, and
  * dependencies need to have a refcount to handle the case where they
  * would be passed to more than one iterator. Upon iterator detroy, we
  * iterate on all the gc ptrarray and decrement the refcounts, freeing
  * if we reach 0.)
  * (note to implementor: we calculate the dependency graph when
- * babeltrace_iter_read_event() is executed after a
- * babeltrace_iter_add_callback(). Beware that it is valid to create/add
+ * bt_iter_read_event() is executed after a
+ * bt_iter_add_callback(). Beware that it is valid to create/add
  * callbacks/read/add more callbacks/read some more.)
  */
-int babeltrace_iter_add_callback(struct babeltrace_iter *iter,
-               bt_event_name event, void *private_data, int flags,
-               enum bt_cb_ret (*callback)(struct bt_ctf_data *ctf_data,
+int bt_iter_add_callback(struct bt_iter *iter,
+               bt_intern_str event, void *private_data, int flags,
+               enum bt_cb_ret (*callback)(struct bt_ctf_event *ctf_data,
                                           void *caller_data),
                struct bt_dependencies *depends,
                struct bt_dependencies *weak_depends,