Local file implementation of GFileIOStream and ops
[platform/upstream/glib.git] / gio / glocalfileoutputstream.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_LOCAL_FILE_OUTPUT_STREAM_H__
24 #define __G_LOCAL_FILE_OUTPUT_STREAM_H__
25
26 #include <gio/gfileoutputstream.h>
27
28 G_BEGIN_DECLS
29
30 #define G_TYPE_LOCAL_FILE_OUTPUT_STREAM         (_g_local_file_output_stream_get_type ())
31 #define G_LOCAL_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStream))
32 #define G_LOCAL_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStreamClass))
33 #define G_IS_LOCAL_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM))
34 #define G_IS_LOCAL_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_LOCAL_FILE_OUTPUT_STREAM))
35 #define G_LOCAL_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStreamClass))
36
37 typedef struct _GLocalFileOutputStream         GLocalFileOutputStream;
38 typedef struct _GLocalFileOutputStreamClass    GLocalFileOutputStreamClass;
39 typedef struct _GLocalFileOutputStreamPrivate  GLocalFileOutputStreamPrivate;
40
41 struct _GLocalFileOutputStream
42 {
43   GFileOutputStream parent_instance;
44
45   /*< private >*/
46   GLocalFileOutputStreamPrivate *priv;
47 };
48
49 struct _GLocalFileOutputStreamClass
50 {
51   GFileOutputStreamClass parent_class;
52 };
53
54 GType               _g_local_file_output_stream_get_type (void) G_GNUC_CONST;
55
56 int      _g_local_file_output_stream_get_fd       (GLocalFileOutputStream *out);
57 void     _g_local_file_output_stream_set_do_close (GLocalFileOutputStream *out,
58                                                    gboolean do_close);
59 gboolean _g_local_file_output_stream_really_close (GLocalFileOutputStream *out,
60                                                    GCancellable   *cancellable,
61                                                    GError        **error);
62
63 GFileOutputStream * _g_local_file_output_stream_open     (const char       *filename,
64                                                           gboolean          readable,
65                                                           GCancellable     *cancellable,
66                                                           GError          **error);
67 GFileOutputStream * _g_local_file_output_stream_create   (const char       *filename,
68                                                           gboolean          readable,
69                                                           GFileCreateFlags  flags,
70                                                           GCancellable     *cancellable,
71                                                           GError          **error);
72 GFileOutputStream * _g_local_file_output_stream_append   (const char       *filename,
73                                                           GFileCreateFlags  flags,
74                                                           GCancellable     *cancellable,
75                                                           GError          **error);
76 GFileOutputStream * _g_local_file_output_stream_replace  (const char       *filename,
77                                                           gboolean          readable,
78                                                           const char       *etag,
79                                                           gboolean          create_backup,
80                                                           GFileCreateFlags  flags,
81                                                           GCancellable     *cancellable,
82                                                           GError          **error);
83
84 G_END_DECLS
85
86 #endif /* __G_LOCAL_FILE_OUTPUT_STREAM_H__ */