/* GStreamer
* Copyright (C) 2004 Wim Taymans <wim@fluendo.com>
+ * Copyright (C) 2011 Sebastian Dröge <sebastian.droege@collabora.co.uk>
*
* gstiterator.h: Header for GstIterator
*
*
* You should have received a copy of the GNU Library General Public
* License along with this library; if not, write to the
- * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
- * Boston, MA 02111-1307, USA.
+ * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
+ * Boston, MA 02110-1301, USA.
*/
#ifndef __GST_ITERATOR_H__
G_BEGIN_DECLS
+#define GST_TYPE_ITERATOR (gst_iterator_get_type ())
+
/**
* GstIteratorResult:
* @GST_ITERATOR_DONE: No more items in the iterator
* The result of gst_iterator_next().
*/
typedef enum {
- GST_ITERATOR_DONE = 0,
- GST_ITERATOR_OK = 1,
- GST_ITERATOR_RESYNC = 2,
- GST_ITERATOR_ERROR = 3
+ GST_ITERATOR_DONE = 0,
+ GST_ITERATOR_OK = 1,
+ GST_ITERATOR_RESYNC = 2,
+ GST_ITERATOR_ERROR = 3
} GstIteratorResult;
typedef struct _GstIterator GstIterator;
* The result of a #GstIteratorItemFunction.
*/
typedef enum {
- GST_ITERATOR_ITEM_SKIP = 0,
- GST_ITERATOR_ITEM_PASS = 1,
- GST_ITERATOR_ITEM_END = 2
+ GST_ITERATOR_ITEM_SKIP = 0,
+ GST_ITERATOR_ITEM_PASS = 1,
+ GST_ITERATOR_ITEM_END = 2
} GstIteratorItem;
/**
- * GstIteratorDisposeFunction:
- * @owner: the owner of the iterator
+ * GstIteratorCopyFunction:
+ * @it: The original iterator
+ * @copy: The copied iterator
*
- * The function that will be called when a #GList iterator is freed. The
- * owner of the #GList iterator can then clean up its resources.
+ * This function will be called when creating a copy of @it and should
+ * create a copy of all custom iterator fields or increase their
+ * reference counts.
*/
-typedef void (*GstIteratorDisposeFunction) (gpointer owner);
+typedef void (*GstIteratorCopyFunction) (const GstIterator *it, GstIterator *copy);
/**
- * GstIteratorNextFunction:
+ * GstIteratorItemFunction:
* @it: the iterator
- * @result: a pointer to hold the next item
+ * @item: the item being retrieved.
*
- * The function that will be called when the next element of the iterator
- * should be retrieved.
+ * The function that will be called after the next item of the iterator
+ * has been retrieved. This function can be used to skip items or stop
+ * the iterator.
*
- * Implementors of a #GstIterator should implement this
- * function and pass it to the constructor of the custom iterator.
* The function will be called with the iterator lock held.
*
* Returns: the result of the operation.
*/
-typedef GstIteratorResult (*GstIteratorNextFunction) (GstIterator *it, gpointer *result);
+typedef GstIteratorItem (*GstIteratorItemFunction) (GstIterator *it, const GValue * item);
+
/**
- * GstIteratorItemFunction:
+ * GstIteratorNextFunction:
* @it: the iterator
- * @item: the item being retrieved.
+ * @result: a pointer to hold the next item
*
- * The function that will be called after the next item of the iterator
- * has been retrieved. This function will typically increase the refcount
- * of the item or make a copy.
+ * The function that will be called when the next element of the iterator
+ * should be retrieved.
*
* Implementors of a #GstIterator should implement this
* function and pass it to the constructor of the custom iterator.
*
* Returns: the result of the operation.
*/
-typedef GstIteratorItem (*GstIteratorItemFunction) (GstIterator *it, gpointer item);
+typedef GstIteratorResult (*GstIteratorNextFunction) (GstIterator *it, GValue *result);
/**
* GstIteratorResyncFunction:
* @it: the iterator
* function and pass it to the constructor of the custom iterator.
* The function will be called with the iterator lock held.
*/
-typedef void (*GstIteratorResyncFunction) (GstIterator *it);
+typedef void (*GstIteratorResyncFunction) (GstIterator *it);
/**
* GstIteratorFreeFunction:
* @it: the iterator
* function and pass it to the constructor of the custom iterator.
* The function will be called with the iterator lock held.
*/
-typedef void (*GstIteratorFreeFunction) (GstIterator *it);
+typedef void (*GstIteratorFreeFunction) (GstIterator *it);
+
+/**
+ * GstIteratorForeachFunction:
+ * @item: The item
+ * @user_data: User data
+ *
+ * A function that is called by gst_iterator_foreach() for every element.
+ */
+typedef void (*GstIteratorForeachFunction) (const GValue * item, gpointer user_data);
/**
* GstIteratorFoldFunction:
*
* A function to be passed to gst_iterator_fold().
*
- * Returns: TRUE if the fold should continue, FALSE if it should stop.
- */
-typedef gboolean (*GstIteratorFoldFunction) (gpointer item, GValue *ret, gpointer user_data);
-
-/**
- * GstCopyFunction:
- * @object: The object to copy
- *
- * A function to create a copy of some object or
- * increase its reference count.
- *
- * Returns: a copy of the object or the same object with increased reference count
- *
- * Since: 0.10.25
+ * Returns: %TRUE if the fold should continue, %FALSE if it should stop.
*/
-typedef gpointer (*GstCopyFunction) (gpointer object);
+typedef gboolean (*GstIteratorFoldFunction) (const GValue * item, GValue * ret, gpointer user_data);
/**
* GST_ITERATOR:
*
* Macro to cast to a #GstIterator
*/
-#define GST_ITERATOR(it) ((GstIterator*)(it))
+#define GST_ITERATOR(it) ((GstIterator*)(it))
/**
* GST_ITERATOR_LOCK:
* @it: the #GstIterator to get the lock of
*
* Macro to get the lock protecting the datastructure being iterated.
*/
-#define GST_ITERATOR_LOCK(it) (GST_ITERATOR(it)->lock)
+#define GST_ITERATOR_LOCK(it) (GST_ITERATOR(it)->lock)
/**
* GST_ITERATOR_COOKIE:
* @it: the #GstIterator to get the cookie of
* value of the master cookie. If they are different, a concurrent
* modification happened to the iterator and a resync is needed.
*/
-#define GST_ITERATOR_COOKIE(it) (GST_ITERATOR(it)->cookie)
+#define GST_ITERATOR_COOKIE(it) (GST_ITERATOR(it)->cookie)
/**
* GST_ITERATOR_ORIG_COOKIE:
* @it: the #GstIterator to get the master cookie of
* master cookie protects the structure being iterated and gets updated
* whenever the datastructure changes.
*/
-#define GST_ITERATOR_ORIG_COOKIE(it) (GST_ITERATOR(it)->master_cookie)
+#define GST_ITERATOR_ORIG_COOKIE(it) (GST_ITERATOR(it)->master_cookie)
/**
* GstIterator:
+ * @copy: The function to copy the iterator
* @next: The function to get the next item in the iterator
* @item: The function to be called for each item retrieved
* @resync: The function to call when a resync is needed.
* @cookie: The cookie; the value of the master_cookie when this iterator was
* created.
* @master_cookie: A pointer to the master cookie.
+ * @size: the size of the iterator
*
- * #GstIterator base structure. The values of this structure are
+ * #GstIterator base structure. The values of this structure are
* protected for subclasses, use the methods to use the #GstIterator.
*/
struct _GstIterator {
/*< protected >*/
+ GstIteratorCopyFunction copy;
GstIteratorNextFunction next;
GstIteratorItemFunction item;
GstIteratorResyncFunction resync;
GstIteratorFreeFunction free;
- GstIterator *pushed; /* pushed iterator */
+ GstIterator *pushed; /* pushed iterator */
GType type;
GMutex *lock;
- guint32 cookie; /* cookie of the iterator */
- guint32 *master_cookie; /* pointer to guint32 holding the cookie when this
- iterator was created */
+ guint32 cookie; /* cookie of the iterator */
+ guint32 *master_cookie; /* pointer to guint32 holding the cookie when this
+ iterator was created */
+ guint size;
/*< private >*/
gpointer _gst_reserved[GST_PADDING];
};
-/* creating iterators */
-GstIterator* gst_iterator_new (guint size,
- GType type,
- GMutex *lock,
- guint32 *master_cookie,
- GstIteratorNextFunction next,
- GstIteratorItemFunction item,
- GstIteratorResyncFunction resync,
- GstIteratorFreeFunction free) G_GNUC_MALLOC;
+GST_API
+GType gst_iterator_get_type (void);
-GstIterator* gst_iterator_new_list (GType type,
- GMutex *lock,
- guint32 *master_cookie,
- GList **list,
- gpointer owner,
- GstIteratorItemFunction item,
- GstIteratorDisposeFunction free) G_GNUC_MALLOC;
+/* creating iterators */
+GST_API
+GstIterator* gst_iterator_new (guint size,
+ GType type,
+ GMutex *lock,
+ guint32 *master_cookie,
+ GstIteratorCopyFunction copy,
+ GstIteratorNextFunction next,
+ GstIteratorItemFunction item,
+ GstIteratorResyncFunction resync,
+ GstIteratorFreeFunction free) G_GNUC_MALLOC;
+GST_API
+GstIterator* gst_iterator_new_list (GType type,
+ GMutex *lock,
+ guint32 *master_cookie,
+ GList **list,
+ GObject * owner,
+ GstIteratorItemFunction item) G_GNUC_MALLOC;
+GST_API
GstIterator* gst_iterator_new_single (GType type,
- gpointer object,
- GstCopyFunction copy,
- GFreeFunc free) G_GNUC_MALLOC;
+ const GValue * object) G_GNUC_MALLOC;
+GST_API
+GstIterator* gst_iterator_copy (const GstIterator *it) G_GNUC_MALLOC;
/* using iterators */
-GstIteratorResult gst_iterator_next (GstIterator *it, gpointer *elem);
-void gst_iterator_resync (GstIterator *it);
-void gst_iterator_free (GstIterator *it);
-void gst_iterator_push (GstIterator *it, GstIterator *other);
+GST_API
+GstIteratorResult gst_iterator_next (GstIterator *it, GValue * elem);
+
+GST_API
+void gst_iterator_resync (GstIterator *it);
+
+GST_API
+void gst_iterator_free (GstIterator *it);
+
+GST_API
+void gst_iterator_push (GstIterator *it, GstIterator *other);
/* higher-order functions that operate on iterators */
-GstIterator* gst_iterator_filter (GstIterator *it, GCompareFunc func,
- gpointer user_data) G_GNUC_MALLOC;
-GstIteratorResult gst_iterator_fold (GstIterator *it,
+
+GST_API
+GstIterator* gst_iterator_filter (GstIterator *it, GCompareFunc func,
+ const GValue * user_data) G_GNUC_MALLOC;
+GST_API
+GstIteratorResult gst_iterator_fold (GstIterator *it,
GstIteratorFoldFunction func,
GValue *ret, gpointer user_data);
-GstIteratorResult gst_iterator_foreach (GstIterator *it,
- GFunc func, gpointer user_data);
-gpointer gst_iterator_find_custom (GstIterator *it, GCompareFunc func,
- gpointer user_data);
+GST_API
+GstIteratorResult gst_iterator_foreach (GstIterator *it,
+ GstIteratorForeachFunction func, gpointer user_data);
+GST_API
+gboolean gst_iterator_find_custom (GstIterator *it, GCompareFunc func,
+ GValue *elem, gpointer user_data);
+
+#ifdef G_DEFINE_AUTOPTR_CLEANUP_FUNC
+G_DEFINE_AUTOPTR_CLEANUP_FUNC(GstIterator, gst_iterator_free)
+#endif
G_END_DECLS
projects / platform / upstream / gstreamer.git / blobdiff