Add missing permission notice in each source file

[babeltrace.git] / include / babeltrace / iterator-internal.h

diff --git a/include/babeltrace/iterator-internal.h b/include/babeltrace/iterator-internal.h
index 511e9a92e291caa955af5ddd8c1f6323802dad58..2b0b2f23c2b5460b55ce86e9b5ad78a7c15af0a2 100644 (file)
--- a/include/babeltrace/iterator-internal.h
+++ b/include/babeltrace/iterator-internal.h
@@ -19,33 +19,53 @@
  *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
  */
 
+#include <babeltrace/ctf/events.h>
+
 /*
- * struct babeltrace_iter: data structure representing an iterator on a trace
+ * struct bt_iter: data structure representing an iterator on a trace
  * collection.
  */
-struct babeltrace_iter {
+struct bt_iter {
        struct ptr_heap *stream_heap;
-       struct trace_collection *tc;
-       struct trace_collection_pos *end_pos;
-       GArray *callbacks;                              /* Array of struct bt_stream_callbacks */
-       struct bt_callback_chain main_callbacks;        /* For all events */
-       /*
-        * Flag indicating if dependency graph needs to be recalculated.
-        * Set by babeltrace_iter_add_callback(), and checked (and
-        * cleared) by upon entry into babeltrace_iter_read_event().
-        * babeltrace_iter_read_event() is responsible for calling dep
-        * graph calculation if it sees this flag set.
-        */
-       int recalculate_dep_graph;
-       /*
-        * Array of pointers to struct bt_dependencies, for garbage
-        * collection. We're not using a linked list here because each
-        * struct bt_dependencies can belong to more than one
-        * babeltrace_iter.
-        */
-       GPtrArray *dep_gc;
+       struct bt_context *ctx;
+       const struct bt_iter_pos *end_pos;
 };
 
+/*
+ * bt_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 bt_iter *bt_iter_create(struct bt_context *ctx,
+               const struct bt_iter_pos *begin_pos,
+               const struct bt_iter_pos *end_pos);
+
+/*
+ * bt_iter_destroy - Free a trace collection iterator.
+ */
+void bt_iter_destroy(struct bt_iter *iter);
+
+int bt_iter_init(struct bt_iter *iter,
+               struct bt_context *ctx,
+               const struct bt_iter_pos *begin_pos,
+               const struct bt_iter_pos *end_pos);
+void bt_iter_fini(struct bt_iter *iter);
+
 #endif /* _BABELTRACE_ITERATOR_INTERNAL_H */