gio/gfileinputstream.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_INPUT_STREAM_H__
  24 #define __G_FILE_INPUT_STREAM_H__
  25
  26 #include <gio/ginputstream.h>
  27 #include <gio/gfileinfo.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_FILE_INPUT_STREAM         (g_file_input_stream_get_type ())
  32 #define G_FILE_INPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStream))
  33 #define G_FILE_INPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
  34 #define G_IS_FILE_INPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_INPUT_STREAM))
  35 #define G_IS_FILE_INPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_INPUT_STREAM))
  36 #define G_FILE_INPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_INPUT_STREAM, GFileInputStreamClass))
  37
  38 /**
  39  * GFileInputStream:
  40  * @parent: the parent #GInputStream instance.
  41  *
  42  * Implements #GInputStream and #GSeekable for file input operations.
  43  **/
  44 typedef struct _GFileInputStream         GFileInputStream;
  45 typedef struct _GFileInputStreamClass    GFileInputStreamClass;
  46 typedef struct _GFileInputStreamPrivate  GFileInputStreamPrivate;
  47
  48 struct _GFileInputStream
  49 {
  50   GInputStream parent;
  51
  52   /*< private >*/
  53   GFileInputStreamPrivate *priv;
  54 };
  55
  56 struct _GFileInputStreamClass
  57 {
  58   GInputStreamClass parent_class;
  59
  60   goffset    (*tell)          (GFileInputStream     *stream);
  61   gboolean   (*can_seek)      (GFileInputStream     *stream);
  62   gboolean   (*seek)          (GFileInputStream     *stream,
  63                                goffset               offset,
  64                                GSeekType             type,
  65                                GCancellable         *cancellable,
  66                                GError              **error);
  67   GFileInfo *(*query_info)    (GFileInputStream     *stream,
  68                                char                 *attributes,
  69                                GCancellable         *cancellable,
  70                                GError              **error);
  71   void       (*query_info_async)  (GFileInputStream     *stream,
  72                                    char                 *attributes,
  73                                    int                   io_priority,
  74                                    GCancellable         *cancellable,
  75                                    GAsyncReadyCallback   callback,
  76                                    gpointer              user_data);
  77   GFileInfo *(*query_info_finish) (GFileInputStream     *stream,
  78                                    GAsyncResult         *res,
  79                                    GError              **error);
  80   /*< private >*/
  81   /* Padding for future expansion */
  82   void (*_g_reserved1) (void);
  83   void (*_g_reserved2) (void);
  84   void (*_g_reserved3) (void);
  85   void (*_g_reserved4) (void);
  86   void (*_g_reserved5) (void);
  87 };
  88
  89 GType g_file_input_stream_get_type (void) G_GNUC_CONST;
  90
  91 GFileInfo *g_file_input_stream_query_info        (GFileInputStream     *stream,
  92                                                   char                 *attributes,
  93                                                   GCancellable         *cancellable,
  94                                                   GError              **error);
  95 void       g_file_input_stream_query_info_async  (GFileInputStream     *stream,
  96                                                   char                 *attributes,
  97                                                   int                   io_priority,
  98                                                   GCancellable         *cancellable,
  99                                                   GAsyncReadyCallback   callback,
 100                                                   gpointer              user_data);
 101 GFileInfo *g_file_input_stream_query_info_finish (GFileInputStream     *stream,
 102                                                   GAsyncResult         *result,
 103                                                   GError              **error);
 104 goffset    g_file_input_stream_tell              (GFileInputStream     *stream);
 105 gboolean   g_file_input_stream_can_seek          (GFileInputStream     *stream);
 106 gboolean   g_file_input_stream_seek              (GFileInputStream     *stream,
 107                                                   goffset               offset,
 108                                                   GSeekType             type,
 109                                                   GCancellable         *cancellable,
 110                                                   GError              **error);
 111
 112
 113
 114 G_END_DECLS
 115
 116 #endif /* __G_FILE_FILE_INPUT_STREAM_H__ */