gio/gfileiostream.h

   1 /* GIO - GLib Input, Io 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.1 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, see <http://www.gnu.org/licenses/>.
  17  *
  18  * Author: Alexander Larsson <alexl@redhat.com>
  19  */
  20
  21 #ifndef __G_FILE_IO_STREAM_H__
  22 #define __G_FILE_IO_STREAM_H__
  23
  24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  25 #error "Only <gio/gio.h> can be included directly."
  26 #endif
  27
  28 #include <gio/giostream.h>
  29
  30 G_BEGIN_DECLS
  31
  32 #define G_TYPE_FILE_IO_STREAM         (g_file_io_stream_get_type ())
  33 #define G_FILE_IO_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_IO_STREAM, GFileIOStream))
  34 #define G_FILE_IO_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_IO_STREAM, GFileIOStreamClass))
  35 #define G_IS_FILE_IO_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_IO_STREAM))
  36 #define G_IS_FILE_IO_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_IO_STREAM))
  37 #define G_FILE_IO_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_IO_STREAM, GFileIOStreamClass))
  38
  39 /**
  40  * GFileIOStream:
  41  *
  42  * A subclass of GIOStream for opened files. This adds
  43  * a few file-specific operations and seeking and truncating.
  44  *
  45  * #GFileIOStream implements GSeekable.
  46  **/
  47 typedef struct _GFileIOStreamClass    GFileIOStreamClass;
  48 typedef struct _GFileIOStreamPrivate  GFileIOStreamPrivate;
  49
  50 struct _GFileIOStream
  51 {
  52   GIOStream parent_instance;
  53
  54   /*< private >*/
  55   GFileIOStreamPrivate *priv;
  56 };
  57
  58 struct _GFileIOStreamClass
  59 {
  60   GIOStreamClass parent_class;
  61
  62   goffset     (* tell)              (GFileIOStream    *stream);
  63   gboolean    (* can_seek)          (GFileIOStream    *stream);
  64   gboolean    (* seek)              (GFileIOStream    *stream,
  65                                      goffset               offset,
  66                                      GSeekType             type,
  67                                      GCancellable         *cancellable,
  68                                      GError              **error);
  69   gboolean    (* can_truncate)      (GFileIOStream    *stream);
  70   gboolean    (* truncate_fn)       (GFileIOStream    *stream,
  71                                      goffset               size,
  72                                      GCancellable         *cancellable,
  73                                      GError              **error);
  74   GFileInfo * (* query_info)        (GFileIOStream    *stream,
  75                                      const char           *attributes,
  76                                      GCancellable         *cancellable,
  77                                      GError              **error);
  78   void        (* query_info_async)  (GFileIOStream     *stream,
  79                                      const char            *attributes,
  80                                      int                   io_priority,
  81                                      GCancellable         *cancellable,
  82                                      GAsyncReadyCallback   callback,
  83                                      gpointer              user_data);
  84   GFileInfo * (* query_info_finish) (GFileIOStream     *stream,
  85                                      GAsyncResult         *result,
  86                                      GError              **error);
  87   char      * (* get_etag)          (GFileIOStream    *stream);
  88
  89   /* Padding for future expansion */
  90   void (*_g_reserved1) (void);
  91   void (*_g_reserved2) (void);
  92   void (*_g_reserved3) (void);
  93   void (*_g_reserved4) (void);
  94   void (*_g_reserved5) (void);
  95 };
  96
  97 GLIB_AVAILABLE_IN_ALL
  98 GType      g_file_io_stream_get_type          (void) G_GNUC_CONST;
  99
 100 GLIB_AVAILABLE_IN_ALL
 101 GFileInfo *g_file_io_stream_query_info        (GFileIOStream    *stream,
 102                                                const char           *attributes,
 103                                                GCancellable         *cancellable,
 104                                                GError              **error);
 105 GLIB_AVAILABLE_IN_ALL
 106 void       g_file_io_stream_query_info_async  (GFileIOStream    *stream,
 107                                                const char           *attributes,
 108                                                int                   io_priority,
 109                                                GCancellable         *cancellable,
 110                                                GAsyncReadyCallback   callback,
 111                                                gpointer              user_data);
 112 GLIB_AVAILABLE_IN_ALL
 113 GFileInfo *g_file_io_stream_query_info_finish (GFileIOStream    *stream,
 114                                                GAsyncResult         *result,
 115                                                GError              **error);
 116 GLIB_AVAILABLE_IN_ALL
 117 char *     g_file_io_stream_get_etag          (GFileIOStream    *stream);
 118
 119 G_END_DECLS
 120
 121 #endif /* __G_FILE_FILE_IO_STREAM_H__ */