gio/gfileenumerator.h

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