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