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.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_LOCAL_FILE_OUTPUT_STREAM_H__
  22 #define __G_LOCAL_FILE_OUTPUT_STREAM_H__
  23
  24 #include <gio/gfileoutputstream.h>
  25
  26 G_BEGIN_DECLS
  27
  28 #define G_TYPE_LOCAL_FILE_OUTPUT_STREAM         (_g_local_file_output_stream_get_type ())
  29 #define G_LOCAL_FILE_OUTPUT_STREAM(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStream))
  30 #define G_LOCAL_FILE_OUTPUT_STREAM_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStreamClass))
  31 #define G_IS_LOCAL_FILE_OUTPUT_STREAM(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM))
  32 #define G_IS_LOCAL_FILE_OUTPUT_STREAM_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_LOCAL_FILE_OUTPUT_STREAM))
  33 #define G_LOCAL_FILE_OUTPUT_STREAM_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_LOCAL_FILE_OUTPUT_STREAM, GLocalFileOutputStreamClass))
  34
  35 typedef struct _GLocalFileOutputStream         GLocalFileOutputStream;
  36 typedef struct _GLocalFileOutputStreamClass    GLocalFileOutputStreamClass;
  37 typedef struct _GLocalFileOutputStreamPrivate  GLocalFileOutputStreamPrivate;
  38
  39 struct _GLocalFileOutputStream
  40 {
  41   GFileOutputStream parent_instance;
  42
  43   /*< private >*/
  44   GLocalFileOutputStreamPrivate *priv;
  45 };
  46
  47 struct _GLocalFileOutputStreamClass
  48 {
  49   GFileOutputStreamClass parent_class;
  50 };
  51
  52 GType               _g_local_file_output_stream_get_type (void) G_GNUC_CONST;
  53
  54 void     _g_local_file_output_stream_set_do_close (GLocalFileOutputStream *out,
  55                                                    gboolean do_close);
  56 gboolean _g_local_file_output_stream_really_close (GLocalFileOutputStream *out,
  57                                                    GCancellable   *cancellable,
  58                                                    GError        **error);
  59
  60 GFileOutputStream * _g_local_file_output_stream_new      (int               fd);
  61 GFileOutputStream * _g_local_file_output_stream_open     (const char       *filename,
  62                                                           gboolean          readable,
  63                                                           GCancellable     *cancellable,
  64                                                           GError          **error);
  65 GFileOutputStream * _g_local_file_output_stream_create   (const char       *filename,
  66                                                           gboolean          readable,
  67                                                           GFileCreateFlags  flags,
  68                                                           GFileInfo        *reference_info,
  69                                                           GCancellable     *cancellable,
  70                                                           GError          **error);
  71 GFileOutputStream * _g_local_file_output_stream_append   (const char       *filename,
  72                                                           GFileCreateFlags  flags,
  73                                                           GCancellable     *cancellable,
  74                                                           GError          **error);
  75 GFileOutputStream * _g_local_file_output_stream_replace  (const char       *filename,
  76                                                           gboolean          readable,
  77                                                           const char       *etag,
  78                                                           gboolean          create_backup,
  79                                                           GFileCreateFlags  flags,
  80                                                           GFileInfo        *reference_info,
  81                                                           GCancellable     *cancellable,
  82                                                           GError          **error);
  83
  84 /* Hack to get the fd since GFileDescriptorBased (which is how you
  85  * _should_ get the fd) is only available on UNIX but things like
  86  * win32 needs this as well
  87  */
  88 gint _g_local_file_output_stream_get_fd (GLocalFileOutputStream *output_stream);
  89
  90 G_END_DECLS
  91
  92 #endif /* __G_LOCAL_FILE_OUTPUT_STREAM_H__ */