• 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_OUTPUT_STREAM_H__
28 #define __G_FILE_OUTPUT_STREAM_H__
29 
30 #include <gio/goutputstream.h>
31 
32 G_BEGIN_DECLS
33 
34 #define G_TYPE_FILE_OUTPUT_STREAM         (g_file_output_stream_get_type ())
35 #define G_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStream))
36 #define G_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
37 #define G_IS_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_FILE_OUTPUT_STREAM))
38 #define G_IS_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_FILE_OUTPUT_STREAM))
39 #define G_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_FILE_OUTPUT_STREAM, GFileOutputStreamClass))
40 
41 /**
42  * GFileOutputStream:
43  *
44  * A subclass of GOutputStream for opened files. This adds
45  * a few file-specific operations and seeking and truncating.
46  *
47  * #GFileOutputStream implements GSeekable.
48  **/
49 typedef struct _GFileOutputStreamClass    GFileOutputStreamClass;
50 typedef struct _GFileOutputStreamPrivate  GFileOutputStreamPrivate;
51 
52 struct _GFileOutputStream
53 {
54   GOutputStream parent_instance;
55 
56   /*< private >*/
57   GFileOutputStreamPrivate *priv;
58 };
59 
60 struct _GFileOutputStreamClass
61 {
62   GOutputStreamClass parent_class;
63 
64   goffset     (* tell)              (GFileOutputStream    *stream);
65   gboolean    (* can_seek)          (GFileOutputStream    *stream);
66   gboolean    (* seek)	            (GFileOutputStream    *stream,
67                                      goffset               offset,
68                                      GSeekType             type,
69                                      GCancellable         *cancellable,
70                                      GError              **error);
71   gboolean    (* can_truncate)      (GFileOutputStream    *stream);
72   gboolean    (* truncate_fn)       (GFileOutputStream    *stream,
73                                      goffset               size,
74                                      GCancellable         *cancellable,
75                                      GError              **error);
76   GFileInfo * (* query_info)        (GFileOutputStream    *stream,
77                                      const char           *attributes,
78                                      GCancellable         *cancellable,
79                                      GError              **error);
80   void        (* query_info_async)  (GFileOutputStream     *stream,
81                                      const char            *attributes,
82                                      int                   io_priority,
83                                      GCancellable         *cancellable,
84                                      GAsyncReadyCallback   callback,
85                                      gpointer              user_data);
86   GFileInfo * (* query_info_finish) (GFileOutputStream     *stream,
87                                      GAsyncResult         *res,
88                                      GError              **error);
89   char      * (* get_etag)          (GFileOutputStream    *stream);
90 
91   /* Padding for future expansion */
92   void (*_g_reserved1) (void);
93   void (*_g_reserved2) (void);
94   void (*_g_reserved3) (void);
95   void (*_g_reserved4) (void);
96   void (*_g_reserved5) (void);
97 };
98 
99 GType      g_file_output_stream_get_type          (void) G_GNUC_CONST;
100 
101 
102 GFileInfo *g_file_output_stream_query_info        (GFileOutputStream    *stream,
103                                                    const char           *attributes,
104                                                    GCancellable         *cancellable,
105                                                    GError              **error);
106 void       g_file_output_stream_query_info_async  (GFileOutputStream    *stream,
107 						   const char           *attributes,
108 						   int                   io_priority,
109 						   GCancellable         *cancellable,
110 						   GAsyncReadyCallback   callback,
111 						   gpointer              user_data);
112 GFileInfo *g_file_output_stream_query_info_finish (GFileOutputStream    *stream,
113 						   GAsyncResult         *result,
114 						   GError              **error);
115 char *     g_file_output_stream_get_etag          (GFileOutputStream    *stream);
116 
117 G_END_DECLS
118 
119 #endif /* __G_FILE_FILE_OUTPUT_STREAM_H__ */
120