1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
/* WirePlumber
*
* Copyright © 2020 Collabora Ltd.
* @author Julian Bouzas <julian.bouzas@collabora.com>
*
* SPDX-License-Identifier: MIT
*/
#ifndef __WIREPLUMBER_ITERATOR_H__
#define __WIREPLUMBER_ITERATOR_H__
#include <gio/gio.h>
#include "defs.h"
G_BEGIN_DECLS
/*!
* \brief A function to be passed to wp_iterator_fold()
* \param item the item to fold
* \param ret the value collecting the result
* \param data data passed to wp_iterator_fold()
* \returns TRUE if the fold should continue, FALSE if it should stop.
* \ingroup wpiterator
*/
typedef gboolean (*WpIteratorFoldFunc) (const GValue *item, GValue *ret,
gpointer data);
/*!
* \brief A function that is called by wp_iterator_foreach().
* \param item the item
* \param data the data passed to wp_iterator_foreach()
* \ingroup wpiterator
*/
typedef void (*WpIteratorForeachFunc) (const GValue *item, gpointer data);
/*!
* \brief The WpIterator GType
* \ingroup wpiterator
*/
#define WP_TYPE_ITERATOR (wp_iterator_get_type ())
WP_API
GType wp_iterator_get_type (void);
typedef struct _WpIterator WpIterator;
typedef struct _WpIteratorMethods WpIteratorMethods;
/*!
* \brief The version to set to _WpIteratorMethods::version.
* This allows future expansion of the struct
* \ingroup wpiterator
*/
#define WP_ITERATOR_METHODS_VERSION 0U
struct _WpIteratorMethods
{
guint32 version;
void (*reset) (WpIterator *self);
gboolean (*next) (WpIterator *self, GValue *item);
gboolean (*fold) (WpIterator *self, WpIteratorFoldFunc func,
GValue *ret, gpointer data);
gboolean (*foreach) (WpIterator *self, WpIteratorForeachFunc func,
gpointer data);
void (*finalize) (WpIterator *self);
};
/* ref count */
WP_API
WpIterator *wp_iterator_ref (WpIterator *self);
WP_API
void wp_iterator_unref (WpIterator *self);
/* iteration api */
WP_API
void wp_iterator_reset (WpIterator *self);
WP_API
gboolean wp_iterator_next (WpIterator *self, GValue *item);
WP_API
gboolean wp_iterator_fold (WpIterator *self, WpIteratorFoldFunc func,
GValue *ret, gpointer data);
WP_API
gboolean wp_iterator_foreach (WpIterator *self, WpIteratorForeachFunc func,
gpointer data);
/* constructors */
WP_API
WpIterator * wp_iterator_new_ptr_array (GPtrArray * items, GType item_type);
WP_API
WpIterator * wp_iterator_new (const WpIteratorMethods * methods,
size_t user_size);
/* private */
WP_API
gpointer wp_iterator_get_user_data (WpIterator * self);
G_DEFINE_AUTOPTR_CLEANUP_FUNC (WpIterator, wp_iterator_unref)
G_END_DECLS
#endif
|
