1/* GIO - GLib Input, Output and Streaming Library
2 *
3 * Copyright (C) 2006-2007 Red Hat, Inc.
4 *
5 * SPDX-License-Identifier: LGPL-2.1-or-later
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Author: Alexander Larsson <alexl@redhat.com>
21 */
22
23#ifndef __G_FILE_ENUMERATOR_H__
24#define __G_FILE_ENUMERATOR_H__
25
26#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27#error "Only <gio/gio.h> can be included directly."
28#endif
29
30#include <gio/giotypes.h>
31
32G_BEGIN_DECLS
33
34#define G_TYPE_FILE_ENUMERATOR (g_file_enumerator_get_type ())
35#define G_FILE_ENUMERATOR(o) (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumerator))
36#define G_FILE_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
37#define G_IS_FILE_ENUMERATOR(o) (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_ENUMERATOR))
38#define G_IS_FILE_ENUMERATOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_ENUMERATOR))
39#define G_FILE_ENUMERATOR_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_ENUMERATOR, GFileEnumeratorClass))
40
41typedef struct _GFileEnumeratorClass GFileEnumeratorClass;
42typedef struct _GFileEnumeratorPrivate GFileEnumeratorPrivate;
43
44struct _GFileEnumerator
45{
46 GObject parent_instance;
47
48 /*< private >*/
49 GFileEnumeratorPrivate *priv;
50};
51
52struct _GFileEnumeratorClass
53{
54 GObjectClass parent_class;
55
56 /* Virtual Table */
57
58 GFileInfo * (* next_file) (GFileEnumerator *enumerator,
59 GCancellable *cancellable,
60 GError **error);
61 gboolean (* close_fn) (GFileEnumerator *enumerator,
62 GCancellable *cancellable,
63 GError **error);
64
65 void (* next_files_async) (GFileEnumerator *enumerator,
66 int num_files,
67 int io_priority,
68 GCancellable *cancellable,
69 GAsyncReadyCallback callback,
70 gpointer user_data);
71 GList * (* next_files_finish) (GFileEnumerator *enumerator,
72 GAsyncResult *result,
73 GError **error);
74 void (* close_async) (GFileEnumerator *enumerator,
75 int io_priority,
76 GCancellable *cancellable,
77 GAsyncReadyCallback callback,
78 gpointer user_data);
79 gboolean (* close_finish) (GFileEnumerator *enumerator,
80 GAsyncResult *result,
81 GError **error);
82
83 /*< private >*/
84 /* Padding for future expansion */
85 void (*_g_reserved1) (void);
86 void (*_g_reserved2) (void);
87 void (*_g_reserved3) (void);
88 void (*_g_reserved4) (void);
89 void (*_g_reserved5) (void);
90 void (*_g_reserved6) (void);
91 void (*_g_reserved7) (void);
92};
93
94GIO_AVAILABLE_IN_ALL
95GType g_file_enumerator_get_type (void) G_GNUC_CONST;
96
97GIO_AVAILABLE_IN_ALL
98GFileInfo *g_file_enumerator_next_file (GFileEnumerator *enumerator,
99 GCancellable *cancellable,
100 GError **error);
101GIO_AVAILABLE_IN_ALL
102gboolean g_file_enumerator_close (GFileEnumerator *enumerator,
103 GCancellable *cancellable,
104 GError **error);
105GIO_AVAILABLE_IN_ALL
106void g_file_enumerator_next_files_async (GFileEnumerator *enumerator,
107 int num_files,
108 int io_priority,
109 GCancellable *cancellable,
110 GAsyncReadyCallback callback,
111 gpointer user_data);
112GIO_AVAILABLE_IN_ALL
113GList * g_file_enumerator_next_files_finish (GFileEnumerator *enumerator,
114 GAsyncResult *result,
115 GError **error);
116GIO_AVAILABLE_IN_ALL
117void g_file_enumerator_close_async (GFileEnumerator *enumerator,
118 int io_priority,
119 GCancellable *cancellable,
120 GAsyncReadyCallback callback,
121 gpointer user_data);
122GIO_AVAILABLE_IN_ALL
123gboolean g_file_enumerator_close_finish (GFileEnumerator *enumerator,
124 GAsyncResult *result,
125 GError **error);
126GIO_AVAILABLE_IN_ALL
127gboolean g_file_enumerator_is_closed (GFileEnumerator *enumerator);
128GIO_AVAILABLE_IN_ALL
129gboolean g_file_enumerator_has_pending (GFileEnumerator *enumerator);
130GIO_AVAILABLE_IN_ALL
131void g_file_enumerator_set_pending (GFileEnumerator *enumerator,
132 gboolean pending);
133GIO_AVAILABLE_IN_ALL
134GFile * g_file_enumerator_get_container (GFileEnumerator *enumerator);
135GIO_AVAILABLE_IN_2_36
136GFile * g_file_enumerator_get_child (GFileEnumerator *enumerator,
137 GFileInfo *info);
138
139GIO_AVAILABLE_IN_2_44
140gboolean g_file_enumerator_iterate (GFileEnumerator *direnum,
141 GFileInfo **out_info,
142 GFile **out_child,
143 GCancellable *cancellable,
144 GError **error);
145
146
147G_END_DECLS
148
149#endif /* __G_FILE_ENUMERATOR_H__ */
150