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