gio/gfile.c

   1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
   2
   3 /* GIO - GLib Input, Output and Streaming Library
   4  *
   5  * Copyright (C) 2006-2007 Red Hat, Inc.
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  *
  22  * Author: Alexander Larsson <alexl@redhat.com>
  23  */
  24
  25 #include "config.h"
  26
  27 #ifdef __linux__
  28 #include <sys/ioctl.h>
  29 #include <errno.h>
  30 /* See linux.git/fs/btrfs/ioctl.h */
  31 #define BTRFS_IOCTL_MAGIC 0x94
  32 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
  33 #endif
  34
  35 #ifdef HAVE_SPLICE
  36 #include <sys/stat.h>
  37 #include <unistd.h>
  38 #include <fcntl.h>
  39 #include <errno.h>
  40 #endif
  41
  42 #include <string.h>
  43 #include <sys/types.h>
  44 #ifdef HAVE_PWD_H
  45 #include <pwd.h>
  46 #endif
  47
  48 #include "gfile.h"
  49 #include "glib/gstdio.h"
  50 #ifdef G_OS_UNIX
  51 #include "glib-unix.h"
  52 #endif
  53 #include "gvfs.h"
  54 #include "gtask.h"
  55 #include "gfileattribute-priv.h"
  56 #include "gfiledescriptorbased.h"
  57 #include "gpollfilemonitor.h"
  58 #include "gappinfo.h"
  59 #include "gfileinputstream.h"
  60 #include "gfileoutputstream.h"
  61 #include "glocalfileoutputstream.h"
  62 #include "glocalfileiostream.h"
  63 #include "gcancellable.h"
  64 #include "gasyncresult.h"
  65 #include "gioerror.h"
  66 #include "glibintl.h"
  67
  68
  69 /**
  70  * SECTION:gfile
  71  * @short_description: File and Directory Handling
  72  * @include: gio/gio.h
  73  * @see_also: #GFileInfo, #GFileEnumerator
  74  *
  75  * #GFile is a high level abstraction for manipulating files on a
  76  * virtual file system. #GFiles are lightweight, immutable objects
  77  * that do no I/O upon creation. It is necessary to understand that
  78  * #GFile objects do not represent files, merely an identifier for a
  79  * file. All file content I/O is implemented as streaming operations
  80  * (see #GInputStream and #GOutputStream).
  81  *
  82  * To construct a #GFile, you can use:
  83  * <simplelist>
  84  * <member>g_file_new_for_path() if you have a path.</member>
  85  * <member>g_file_new_for_uri() if you have a URI.</member>
  86  * <member>g_file_new_for_commandline_arg() for a command line argument.</member>
  87  * <member>g_file_new_tmp() to create a temporary file from a template.</member>
  88  * <member>g_file_parse_name() from a UTF-8 string gotten from g_file_get_parse_name().</member>
  89  * </simplelist>
  90  *
  91  * One way to think of a #GFile is as an abstraction of a pathname. For
  92  * normal files the system pathname is what is stored internally, but as
  93  * #GFiles are extensible it could also be something else that corresponds
  94  * to a pathname in a userspace implementation of a filesystem.
  95  *
  96  * #GFiles make up hierarchies of directories and files that correspond to
  97  * the files on a filesystem. You can move through the file system with
  98  * #GFile using g_file_get_parent() to get an identifier for the parent
  99  * directory, g_file_get_child() to get a child within a directory,
 100  * g_file_resolve_relative_path() to resolve a relative path between two
 101  * #GFiles. There can be multiple hierarchies, so you may not end up at
 102  * the same root if you repeatedly call g_file_get_parent() on two different
 103  * files.
 104  *
 105  * All #GFiles have a basename (get with g_file_get_basename()). These names
 106  * are byte strings that are used to identify the file on the filesystem
 107  * (relative to its parent directory) and there is no guarantees that they
 108  * have any particular charset encoding or even make any sense at all. If
 109  * you want to use filenames in a user interface you should use the display
 110  * name that you can get by requesting the
 111  * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
 112  * This is guaranteed to be in UTF-8 and can be used in a user interface.
 113  * But always store the real basename or the #GFile to use to actually
 114  * access the file, because there is no way to go from a display name to
 115  * the actual name.
 116  *
 117  * Using #GFile as an identifier has the same weaknesses as using a path
 118  * in that there may be multiple aliases for the same file. For instance,
 119  * hard or soft links may cause two different #GFiles to refer to the same
 120  * file. Other possible causes for aliases are: case insensitive filesystems,
 121  * short and long names on FAT/NTFS, or bind mounts in Linux. If you want to
 122  * check if two #GFiles point to the same file you can query for the
 123  * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
 124  * canonicalization of pathnames passed in, so that trivial differences in
 125  * the path string used at creation (duplicated slashes, slash at end of
 126  * path, "." or ".." path segments, etc) does not create different #GFiles.
 127  *
 128  * Many #GFile operations have both synchronous and asynchronous versions
 129  * to suit your application. Asynchronous versions of synchronous functions
 130  * simply have _async() appended to their function names. The asynchronous
 131  * I/O functions call a #GAsyncReadyCallback which is then used to finalize
 132  * the operation, producing a GAsyncResult which is then passed to the
 133  * function's matching _finish() operation.
 134  *
 135  * Some #GFile operations do not have synchronous analogs, as they may
 136  * take a very long time to finish, and blocking may leave an application
 137  * unusable. Notable cases include:
 138  * <simplelist>
 139  * <member>g_file_mount_mountable() to mount a mountable file.</member>
 140  * <member>g_file_unmount_mountable_with_operation() to unmount a mountable file.</member>
 141  * <member>g_file_eject_mountable_with_operation() to eject a mountable file.</member>
 142  * </simplelist>
 143  *
 144  * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
 145  * One notable feature of #GFiles are entity tags, or "etags" for
 146  * short. Entity tags are somewhat like a more abstract version of the
 147  * traditional mtime, and can be used to quickly determine if the file has
 148  * been modified from the version on the file system. See the HTTP 1.1
 149  * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
 150  * for HTTP Etag headers, which are a very similar concept.
 151  * </para>
 152  **/
 153
 154 static void               g_file_real_query_info_async            (GFile                  *file,
 155                                                                    const char             *attributes,
 156                                                                    GFileQueryInfoFlags     flags,
 157                                                                    int                     io_priority,
 158                                                                    GCancellable           *cancellable,
 159                                                                    GAsyncReadyCallback     callback,
 160                                                                    gpointer                user_data);
 161 static GFileInfo *        g_file_real_query_info_finish           (GFile                  *file,
 162                                                                    GAsyncResult           *res,
 163                                                                    GError                **error);
 164 static void               g_file_real_query_filesystem_info_async (GFile                  *file,
 165                                                                    const char             *attributes,
 166                                                                    int                     io_priority,
 167                                                                    GCancellable           *cancellable,
 168                                                                    GAsyncReadyCallback     callback,
 169                                                                    gpointer                user_data);
 170 static GFileInfo *        g_file_real_query_filesystem_info_finish (GFile                  *file,
 171                                                                    GAsyncResult           *res,
 172                                                                    GError                **error);
 173 static void               g_file_real_enumerate_children_async    (GFile                  *file,
 174                                                                    const char             *attributes,
 175                                                                    GFileQueryInfoFlags     flags,
 176                                                                    int                     io_priority,
 177                                                                    GCancellable           *cancellable,
 178                                                                    GAsyncReadyCallback     callback,
 179                                                                    gpointer                user_data);
 180 static GFileEnumerator *  g_file_real_enumerate_children_finish   (GFile                  *file,
 181                                                                    GAsyncResult           *res,
 182                                                                    GError                **error);
 183 static void               g_file_real_read_async                  (GFile                  *file,
 184                                                                    int                     io_priority,
 185                                                                    GCancellable           *cancellable,
 186                                                                    GAsyncReadyCallback     callback,
 187                                                                    gpointer                user_data);
 188 static GFileInputStream * g_file_real_read_finish                 (GFile                  *file,
 189                                                                    GAsyncResult           *res,
 190                                                                    GError                **error);
 191 static void               g_file_real_append_to_async             (GFile                  *file,
 192                                                                    GFileCreateFlags        flags,
 193                                                                    int                     io_priority,
 194                                                                    GCancellable           *cancellable,
 195                                                                    GAsyncReadyCallback     callback,
 196                                                                    gpointer                user_data);
 197 static GFileOutputStream *g_file_real_append_to_finish            (GFile                  *file,
 198                                                                    GAsyncResult           *res,
 199                                                                    GError                **error);
 200 static void               g_file_real_create_async                (GFile                  *file,
 201                                                                    GFileCreateFlags        flags,
 202                                                                    int                     io_priority,
 203                                                                    GCancellable           *cancellable,
 204                                                                    GAsyncReadyCallback     callback,
 205                                                                    gpointer                user_data);
 206 static GFileOutputStream *g_file_real_create_finish               (GFile                  *file,
 207                                                                    GAsyncResult           *res,
 208                                                                    GError                **error);
 209 static void               g_file_real_replace_async               (GFile                  *file,
 210                                                                    const char             *etag,
 211                                                                    gboolean                make_backup,
 212                                                                    GFileCreateFlags        flags,
 213                                                                    int                     io_priority,
 214                                                                    GCancellable           *cancellable,
 215                                                                    GAsyncReadyCallback     callback,
 216                                                                    gpointer                user_data);
 217 static GFileOutputStream *g_file_real_replace_finish              (GFile                  *file,
 218                                                                    GAsyncResult           *res,
 219                                                                    GError                **error);
 220 static void               g_file_real_delete_async                (GFile                  *file,
 221                                                                    int                     io_priority,
 222                                                                    GCancellable           *cancellable,
 223                                                                    GAsyncReadyCallback     callback,
 224                                                                    gpointer                user_data);
 225 static gboolean           g_file_real_delete_finish               (GFile                  *file,
 226                                                                    GAsyncResult           *res,
 227                                                                    GError                **error);
 228 static void               g_file_real_open_readwrite_async        (GFile                  *file,
 229                                                                    int                  io_priority,
 230                                                                    GCancellable           *cancellable,
 231                                                                    GAsyncReadyCallback     callback,
 232                                                                    gpointer                user_data);
 233 static GFileIOStream *    g_file_real_open_readwrite_finish       (GFile                  *file,
 234                                                                    GAsyncResult           *res,
 235                                                                    GError                **error);
 236 static void               g_file_real_create_readwrite_async      (GFile                  *file,
 237                                                                    GFileCreateFlags        flags,
 238                                                                    int                     io_priority,
 239                                                                    GCancellable           *cancellable,
 240                                                                    GAsyncReadyCallback     callback,
 241                                                                    gpointer                user_data);
 242 static GFileIOStream *    g_file_real_create_readwrite_finish     (GFile                  *file,
 243                                                                    GAsyncResult           *res,
 244                                                                    GError                **error);
 245 static void               g_file_real_replace_readwrite_async     (GFile                  *file,
 246                                                                    const char             *etag,
 247                                                                    gboolean                make_backup,
 248                                                                    GFileCreateFlags        flags,
 249                                                                    int                     io_priority,
 250                                                                    GCancellable           *cancellable,
 251                                                                    GAsyncReadyCallback     callback,
 252                                                                    gpointer                user_data);
 253 static GFileIOStream *    g_file_real_replace_readwrite_finish    (GFile                  *file,
 254                                                                   GAsyncResult            *res,
 255                                                                   GError                 **error);
 256 static gboolean           g_file_real_set_attributes_from_info    (GFile                  *file,
 257                                                                    GFileInfo              *info,
 258                                                                    GFileQueryInfoFlags     flags,
 259                                                                    GCancellable           *cancellable,
 260                                                                    GError                **error);
 261 static void               g_file_real_set_display_name_async      (GFile                  *file,
 262                                                                    const char             *display_name,
 263                                                                    int                     io_priority,
 264                                                                    GCancellable           *cancellable,
 265                                                                    GAsyncReadyCallback     callback,
 266                                                                    gpointer                user_data);
 267 static GFile *            g_file_real_set_display_name_finish     (GFile                  *file,
 268                                                                    GAsyncResult           *res,
 269                                                                    GError                **error);
 270 static void               g_file_real_set_attributes_async        (GFile                  *file,
 271                                                                    GFileInfo              *info,
 272                                                                    GFileQueryInfoFlags     flags,
 273                                                                    int                     io_priority,
 274                                                                    GCancellable           *cancellable,
 275                                                                    GAsyncReadyCallback     callback,
 276                                                                    gpointer                user_data);
 277 static gboolean           g_file_real_set_attributes_finish       (GFile                  *file,
 278                                                                    GAsyncResult           *res,
 279                                                                    GFileInfo             **info,
 280                                                                    GError                **error);
 281 static void               g_file_real_find_enclosing_mount_async  (GFile                  *file,
 282                                                                    int                     io_priority,
 283                                                                    GCancellable           *cancellable,
 284                                                                    GAsyncReadyCallback     callback,
 285                                                                    gpointer                user_data);
 286 static GMount *           g_file_real_find_enclosing_mount_finish (GFile                  *file,
 287                                                                    GAsyncResult           *res,
 288                                                                    GError                **error);
 289 static void               g_file_real_copy_async                  (GFile                  *source,
 290                                                                    GFile                  *destination,
 291                                                                    GFileCopyFlags          flags,
 292                                                                    int                     io_priority,
 293                                                                    GCancellable           *cancellable,
 294                                                                    GFileProgressCallback   progress_callback,
 295                                                                    gpointer                progress_callback_data,
 296                                                                    GAsyncReadyCallback     callback,
 297                                                                    gpointer                user_data);
 298 static gboolean           g_file_real_copy_finish                 (GFile                  *file,
 299                                                                    GAsyncResult           *res,
 300                                                                    GError                **error);
 301
 302 typedef GFileIface GFileInterface;
 303 G_DEFINE_INTERFACE (GFile, g_file, G_TYPE_OBJECT)
 304
 305 static void
 306 g_file_default_init (GFileIface *iface)
 307 {
 308   iface->enumerate_children_async = g_file_real_enumerate_children_async;
 309   iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
 310   iface->set_display_name_async = g_file_real_set_display_name_async;
 311   iface->set_display_name_finish = g_file_real_set_display_name_finish;
 312   iface->query_info_async = g_file_real_query_info_async;
 313   iface->query_info_finish = g_file_real_query_info_finish;
 314   iface->query_filesystem_info_async = g_file_real_query_filesystem_info_async;
 315   iface->query_filesystem_info_finish = g_file_real_query_filesystem_info_finish;
 316   iface->set_attributes_async = g_file_real_set_attributes_async;
 317   iface->set_attributes_finish = g_file_real_set_attributes_finish;
 318   iface->read_async = g_file_real_read_async;
 319   iface->read_finish = g_file_real_read_finish;
 320   iface->append_to_async = g_file_real_append_to_async;
 321   iface->append_to_finish = g_file_real_append_to_finish;
 322   iface->create_async = g_file_real_create_async;
 323   iface->create_finish = g_file_real_create_finish;
 324   iface->replace_async = g_file_real_replace_async;
 325   iface->replace_finish = g_file_real_replace_finish;
 326   iface->delete_file_async = g_file_real_delete_async;
 327   iface->delete_file_finish = g_file_real_delete_finish;
 328   iface->open_readwrite_async = g_file_real_open_readwrite_async;
 329   iface->open_readwrite_finish = g_file_real_open_readwrite_finish;
 330   iface->create_readwrite_async = g_file_real_create_readwrite_async;
 331   iface->create_readwrite_finish = g_file_real_create_readwrite_finish;
 332   iface->replace_readwrite_async = g_file_real_replace_readwrite_async;
 333   iface->replace_readwrite_finish = g_file_real_replace_readwrite_finish;
 334   iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
 335   iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
 336   iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
 337   iface->copy_async = g_file_real_copy_async;
 338   iface->copy_finish = g_file_real_copy_finish;
 339 }
 340
 341
 342 /**
 343  * g_file_is_native:
 344  * @file: input #GFile
 345  *
 346  * Checks to see if a file is native to the platform.
 347  *
 348  * A native file s one expressed in the platform-native filename format,
 349  * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
 350  * as it might be on a locally mounted remote filesystem.
 351  *
 352  * On some systems non-native files may be available using the native
 353  * filesystem via a userspace filesystem (FUSE), in these cases this call
 354  * will return %FALSE, but g_file_get_path() will still return a native path.
 355  *
 356  * This call does no blocking I/O.
 357  *
 358  * Returns: %TRUE if @file is native
 359  */
 360 gboolean
 361 g_file_is_native (GFile *file)
 362 {
 363   GFileIface *iface;
 364
 365   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 366
 367   iface = G_FILE_GET_IFACE (file);
 368
 369   return (* iface->is_native) (file);
 370 }
 371
 372
 373 /**
 374  * g_file_has_uri_scheme:
 375  * @file: input #GFile
 376  * @uri_scheme: a string containing a URI scheme
 377  *
 378  * Checks to see if a #GFile has a given URI scheme.
 379  *
 380  * This call does no blocking I/O.
 381  *
 382  * Returns: %TRUE if #GFile's backend supports the
 383  *     given URI scheme, %FALSE if URI scheme is %NULL,
 384  *     not supported, or #GFile is invalid.
 385  */
 386 gboolean
 387 g_file_has_uri_scheme (GFile      *file,
 388                        const char *uri_scheme)
 389 {
 390   GFileIface *iface;
 391
 392   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 393   g_return_val_if_fail (uri_scheme != NULL, FALSE);
 394
 395   iface = G_FILE_GET_IFACE (file);
 396
 397   return (* iface->has_uri_scheme) (file, uri_scheme);
 398 }
 399
 400
 401 /**
 402  * g_file_get_uri_scheme:
 403  * @file: input #GFile
 404  *
 405  * Gets the URI scheme for a #GFile.
 406  * RFC 3986 decodes the scheme as:
 407  * <programlisting>
 408  * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
 409  * </programlisting>
 410  * Common schemes include "file", "http", "ftp", etc.
 411  *
 412  * This call does no blocking I/O.
 413  *
 414  * Returns: a string containing the URI scheme for the given
 415  *     #GFile. The returned string should be freed with g_free()
 416  *     when no longer needed.
 417  */
 418 char *
 419 g_file_get_uri_scheme (GFile *file)
 420 {
 421   GFileIface *iface;
 422
 423   g_return_val_if_fail (G_IS_FILE (file), NULL);
 424
 425   iface = G_FILE_GET_IFACE (file);
 426
 427   return (* iface->get_uri_scheme) (file);
 428 }
 429
 430
 431 /**
 432  * g_file_get_basename:
 433  * @file: input #GFile
 434  *
 435  * Gets the base name (the last component of the path) for a given #GFile.
 436  *
 437  * If called for the top level of a system (such as the filesystem root
 438  * or a uri like sftp://host/) it will return a single directory separator
 439  * (and on Windows, possibly a drive letter).
 440  *
 441  * The base name is a byte string (not UTF-8). It has no defined encoding
 442  * or rules other than it may not contain zero bytes.  If you want to use
 443  * filenames in a user interface you should use the display name that you
 444  * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
 445  * attribute with g_file_query_info().
 446  *
 447  * This call does no blocking I/O.
 448  *
 449  * Returns: string containing the #GFile's base name, or %NULL
 450  *     if given #GFile is invalid. The returned string should be
 451  *     freed with g_free() when no longer needed.
 452  */
 453 char *
 454 g_file_get_basename (GFile *file)
 455 {
 456   GFileIface *iface;
 457
 458   g_return_val_if_fail (G_IS_FILE (file), NULL);
 459
 460   iface = G_FILE_GET_IFACE (file);
 461
 462   return (* iface->get_basename) (file);
 463 }
 464
 465 /**
 466  * g_file_get_path:
 467  * @file: input #GFile
 468  *
 469  * Gets the local pathname for #GFile, if one exists.
 470  *
 471  * This call does no blocking I/O.
 472  *
 473  * Returns: string containing the #GFile's path, or %NULL if
 474  *     no such path exists. The returned string should be
 475  *     freed with g_free() when no longer needed.
 476  */
 477 char *
 478 g_file_get_path (GFile *file)
 479 {
 480   GFileIface *iface;
 481
 482   g_return_val_if_fail (G_IS_FILE (file), NULL);
 483
 484   iface = G_FILE_GET_IFACE (file);
 485
 486   return (* iface->get_path) (file);
 487 }
 488
 489 /**
 490  * g_file_get_uri:
 491  * @file: input #GFile
 492  *
 493  * Gets the URI for the @file.
 494  *
 495  * This call does no blocking I/O.
 496  *
 497  * Returns: a string containing the #GFile's URI.
 498  *     The returned string should be freed with g_free()
 499  *     when no longer needed.
 500  */
 501 char *
 502 g_file_get_uri (GFile *file)
 503 {
 504   GFileIface *iface;
 505
 506   g_return_val_if_fail (G_IS_FILE (file), NULL);
 507
 508   iface = G_FILE_GET_IFACE (file);
 509
 510   return (* iface->get_uri) (file);
 511 }
 512
 513 /**
 514  * g_file_get_parse_name:
 515  * @file: input #GFile
 516  *
 517  * Gets the parse name of the @file.
 518  * A parse name is a UTF-8 string that describes the
 519  * file such that one can get the #GFile back using
 520  * g_file_parse_name().
 521  *
 522  * This is generally used to show the #GFile as a nice
 523  * full-pathname kind of string in a user interface,
 524  * like in a location entry.
 525  *
 526  * For local files with names that can safely be converted
 527  * to UTF-8 the pathname is used, otherwise the IRI is used
 528  * (a form of URI that allows UTF-8 characters unescaped).
 529  *
 530  * This call does no blocking I/O.
 531  *
 532  * Returns: a string containing the #GFile's parse name.
 533  *     The returned string should be freed with g_free()
 534  *     when no longer needed.
 535  */
 536 char *
 537 g_file_get_parse_name (GFile *file)
 538 {
 539   GFileIface *iface;
 540
 541   g_return_val_if_fail (G_IS_FILE (file), NULL);
 542
 543   iface = G_FILE_GET_IFACE (file);
 544
 545   return (* iface->get_parse_name) (file);
 546 }
 547
 548 /**
 549  * g_file_dup:
 550  * @file: input #GFile
 551  *
 552  * Duplicates a #GFile handle. This operation does not duplicate
 553  * the actual file or directory represented by the #GFile; see
 554  * g_file_copy() if attempting to copy a file.
 555  *
 556  * This call does no blocking I/O.
 557  *
 558  * Returns: (transfer full): a new #GFile that is a duplicate
 559  *     of the given #GFile.
 560  */
 561 GFile *
 562 g_file_dup (GFile *file)
 563 {
 564   GFileIface *iface;
 565
 566   g_return_val_if_fail (G_IS_FILE (file), NULL);
 567
 568   iface = G_FILE_GET_IFACE (file);
 569
 570   return (* iface->dup) (file);
 571 }
 572
 573 /**
 574  * g_file_hash:
 575  * @file: (type GFile): #gconstpointer to a #GFile
 576  *
 577  * Creates a hash value for a #GFile.
 578  *
 579  * This call does no blocking I/O.
 580  *
 581  * Virtual: hash
 582  * Returns: 0 if @file is not a valid #GFile, otherwise an
 583  *     integer that can be used as hash value for the #GFile.
 584  *     This function is intended for easily hashing a #GFile to
 585  *     add to a #GHashTable or similar data structure.
 586  */
 587 guint
 588 g_file_hash (gconstpointer file)
 589 {
 590   GFileIface *iface;
 591
 592   g_return_val_if_fail (G_IS_FILE (file), 0);
 593
 594   iface = G_FILE_GET_IFACE (file);
 595
 596   return (* iface->hash) ((GFile *)file);
 597 }
 598
 599 /**
 600  * g_file_equal:
 601  * @file1: the first #GFile
 602  * @file2: the second #GFile
 603  *
 604  * Checks equality of two given #GFiles.
 605  *
 606  * Note that two #GFiles that differ can still refer to the same
 607  * file on the filesystem due to various forms of filename
 608  * aliasing.
 609  *
 610  * This call does no blocking I/O.
 611  *
 612  * Returns: %TRUE if @file1 and @file2 are equal.
 613  *     %FALSE if either is not a #GFile.
 614  */
 615 gboolean
 616 g_file_equal (GFile *file1,
 617               GFile *file2)
 618 {
 619   GFileIface *iface;
 620
 621   g_return_val_if_fail (G_IS_FILE (file1), FALSE);
 622   g_return_val_if_fail (G_IS_FILE (file2), FALSE);
 623
 624   if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
 625     return FALSE;
 626
 627   iface = G_FILE_GET_IFACE (file1);
 628
 629   return (* iface->equal) (file1, file2);
 630 }
 631
 632
 633 /**
 634  * g_file_get_parent:
 635  * @file: input #GFile
 636  *
 637  * Gets the parent directory for the @file.
 638  * If the @file represents the root directory of the
 639  * file system, then %NULL will be returned.
 640  *
 641  * This call does no blocking I/O.
 642  *
 643  * Returns: (transfer full): a #GFile structure to the
 644  *     parent of the given #GFile or %NULL if there is
 645  *     no parent. Free the returned object with g_object_unref().
 646  */
 647 GFile *
 648 g_file_get_parent (GFile *file)
 649 {
 650   GFileIface *iface;
 651
 652   g_return_val_if_fail (G_IS_FILE (file), NULL);
 653
 654   iface = G_FILE_GET_IFACE (file);
 655
 656   return (* iface->get_parent) (file);
 657 }
 658
 659 /**
 660  * g_file_has_parent:
 661  * @file: input #GFile
 662  * @parent: (allow-none): the parent to check for, or %NULL
 663  *
 664  * Checks if @file has a parent, and optionally, if it is @parent.
 665  *
 666  * If @parent is %NULL then this function returns %TRUE if @file has any
 667  * parent at all.  If @parent is non-%NULL then %TRUE is only returned
 668  * if @file is a child of @parent.
 669  *
 670  * Returns: %TRUE if @file is a child of @parent (or any parent in the
 671  *          case that @parent is %NULL).
 672  *
 673  * Since: 2.24
 674  */
 675 gboolean
 676 g_file_has_parent (GFile *file,
 677                    GFile *parent)
 678 {
 679   GFile *actual_parent;
 680   gboolean result;
 681
 682   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 683   g_return_val_if_fail (parent == NULL || G_IS_FILE (parent), FALSE);
 684
 685   actual_parent = g_file_get_parent (file);
 686
 687   if (actual_parent != NULL)
 688     {
 689       if (parent != NULL)
 690         result = g_file_equal (parent, actual_parent);
 691       else
 692         result = TRUE;
 693
 694       g_object_unref (actual_parent);
 695     }
 696   else
 697     result = FALSE;
 698
 699   return result;
 700 }
 701
 702 /**
 703  * g_file_get_child:
 704  * @file: input #GFile
 705  * @name: string containing the child's basename
 706  *
 707  * Gets a child of @file with basename equal to @name.
 708  *
 709  * Note that the file with that specific name might not exist, but
 710  * you can still have a #GFile that points to it. You can use this
 711  * for instance to create that file.
 712  *
 713  * This call does no blocking I/O.
 714  *
 715  * Returns: (transfer full): a #GFile to a child specified by @name.
 716  *     Free the returned object with g_object_unref().
 717  */
 718 GFile *
 719 g_file_get_child (GFile      *file,
 720                   const char *name)
 721 {
 722   g_return_val_if_fail (G_IS_FILE (file), NULL);
 723   g_return_val_if_fail (name != NULL, NULL);
 724
 725   return g_file_resolve_relative_path (file, name);
 726 }
 727
 728 /**
 729  * g_file_get_child_for_display_name:
 730  * @file: input #GFile
 731  * @display_name: string to a possible child
 732  * @error: return location for an error
 733  *
 734  * Gets the child of @file for a given @display_name (i.e. a UTF-8
 735  * version of the name). If this function fails, it returns %NULL
 736  * and @error will be set. This is very useful when constructing a
 737  * #GFile for a new file and the user entered the filename in the
 738  * user interface, for instance when you select a directory and
 739  * type a filename in the file selector.
 740  *
 741  * This call does no blocking I/O.
 742  *
 743  * Returns: (transfer full): a #GFile to the specified child, or
 744  *     %NULL if the display name couldn't be converted.
 745  *     Free the returned object with g_object_unref().
 746  */
 747 GFile *
 748 g_file_get_child_for_display_name (GFile      *file,
 749                                    const char *display_name,
 750                                    GError **error)
 751 {
 752   GFileIface *iface;
 753
 754   g_return_val_if_fail (G_IS_FILE (file), NULL);
 755   g_return_val_if_fail (display_name != NULL, NULL);
 756
 757   iface = G_FILE_GET_IFACE (file);
 758
 759   return (* iface->get_child_for_display_name) (file, display_name, error);
 760 }
 761
 762 /**
 763  * g_file_has_prefix:
 764  * @file: input #GFile
 765  * @prefix: input #GFile
 766  *
 767  * Checks whether @file has the prefix specified by @prefix.
 768  *
 769  * In other words, if the names of initial elements of @file's
 770  * pathname match @prefix. Only full pathname elements are matched,
 771  * so a path like /foo is not considered a prefix of /foobar, only
 772  * of /foo/bar.
 773  *
 774  * This call does no I/O, as it works purely on names. As such it can
 775  * sometimes return %FALSE even if @file is inside a @prefix (from a
 776  * filesystem point of view), because the prefix of @file is an alias
 777  * of @prefix.
 778  *
 779  * Virtual: prefix_matches
 780  * Returns:  %TRUE if the @files's parent, grandparent, etc is @prefix,
 781  *     %FALSE otherwise.
 782  */
 783 gboolean
 784 g_file_has_prefix (GFile *file,
 785                    GFile *prefix)
 786 {
 787   GFileIface *iface;
 788
 789   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 790   g_return_val_if_fail (G_IS_FILE (prefix), FALSE);
 791
 792   if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix))
 793     return FALSE;
 794
 795   iface = G_FILE_GET_IFACE (file);
 796
 797   /* The vtable function differs in arg order since
 798    * we're using the old contains_file call
 799    */
 800   return (* iface->prefix_matches) (prefix, file);
 801 }
 802
 803 /**
 804  * g_file_get_relative_path:
 805  * @parent: input #GFile
 806  * @descendant: input #GFile
 807  *
 808  * Gets the path for @descendant relative to @parent.
 809  *
 810  * This call does no blocking I/O.
 811  *
 812  * Returns: string with the relative path from @descendant
 813  *     to @parent, or %NULL if @descendant doesn't have @parent
 814  *     as prefix. The returned string should be freed with g_free()
 815  *     when no longer needed.
 816  */
 817 char *
 818 g_file_get_relative_path (GFile *parent,
 819                           GFile *descendant)
 820 {
 821   GFileIface *iface;
 822
 823   g_return_val_if_fail (G_IS_FILE (parent), NULL);
 824   g_return_val_if_fail (G_IS_FILE (descendant), NULL);
 825
 826   if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
 827     return NULL;
 828
 829   iface = G_FILE_GET_IFACE (parent);
 830
 831   return (* iface->get_relative_path) (parent, descendant);
 832 }
 833
 834 /**
 835  * g_file_resolve_relative_path:
 836  * @file: input #GFile
 837  * @relative_path: a given relative path string
 838  *
 839  * Resolves a relative path for @file to an absolute path.
 840  *
 841  * This call does no blocking I/O.
 842  *
 843  * Returns: (transfer full): #GFile to the resolved path.
 844  *     %NULL if @relative_path is %NULL or if @file is invalid.
 845  *     Free the returned object with g_object_unref().
 846  */
 847 GFile *
 848 g_file_resolve_relative_path (GFile      *file,
 849                               const char *relative_path)
 850 {
 851   GFileIface *iface;
 852
 853   g_return_val_if_fail (G_IS_FILE (file), NULL);
 854   g_return_val_if_fail (relative_path != NULL, NULL);
 855
 856   iface = G_FILE_GET_IFACE (file);
 857
 858   return (* iface->resolve_relative_path) (file, relative_path);
 859 }
 860
 861 /**
 862  * g_file_enumerate_children:
 863  * @file: input #GFile
 864  * @attributes: an attribute query string
 865  * @flags: a set of #GFileQueryInfoFlags
 866  * @cancellable: (allow-none): optional #GCancellable object,
 867  *     %NULL to ignore
 868  * @error: #GError for error reporting
 869  *
 870  * Gets the requested information about the files in a directory.
 871  * The result is a #GFileEnumerator object that will give out
 872  * #GFileInfo objects for all the files in the directory.
 873  *
 874  * The @attributes value is a string that specifies the file
 875  * attributes that should be gathered. It is not an error if
 876  * it's not possible to read a particular requested attribute
 877  * from a file - it just won't be set. @attributes should
 878  * be a comma-separated list of attributes or attribute wildcards.
 879  * The wildcard "*" means all attributes, and a wildcard like
 880  * "standard::*" means all attributes in the standard namespace.
 881  * An example attribute query be "standard::*,owner::user".
 882  * The standard attributes are available as defines, like
 883  * #G_FILE_ATTRIBUTE_STANDARD_NAME.
 884  *
 885  * If @cancellable is not %NULL, then the operation can be cancelled
 886  * by triggering the cancellable object from another thread. If the
 887  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
 888  * returned.
 889  *
 890  * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
 891  * be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY
 892  * error will be returned. Other errors are possible too.
 893  *
 894  * Returns: (transfer full): A #GFileEnumerator if successful,
 895  *     %NULL on error. Free the returned object with g_object_unref().
 896  */
 897 GFileEnumerator *
 898 g_file_enumerate_children (GFile                *file,
 899                            const char           *attributes,
 900                            GFileQueryInfoFlags   flags,
 901                            GCancellable         *cancellable,
 902                            GError              **error)
 903 {
 904   GFileIface *iface;
 905
 906   g_return_val_if_fail (G_IS_FILE (file), NULL);
 907
 908   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 909     return NULL;
 910
 911   iface = G_FILE_GET_IFACE (file);
 912
 913   if (iface->enumerate_children == NULL)
 914     {
 915       g_set_error_literal (error, G_IO_ERROR,
 916                            G_IO_ERROR_NOT_SUPPORTED,
 917                            _("Operation not supported"));
 918       return NULL;
 919     }
 920
 921   return (* iface->enumerate_children) (file, attributes, flags,
 922                                         cancellable, error);
 923 }
 924
 925 /**
 926  * g_file_enumerate_children_async:
 927  * @file: input #GFile
 928  * @attributes: an attribute query string
 929  * @flags: a set of #GFileQueryInfoFlags
 930  * @io_priority: the <link linkend="io-priority">I/O priority</link>
 931  *     of the request
 932  * @cancellable: (allow-none): optional #GCancellable object,
 933  *     %NULL to ignore
 934  * @callback: (scope async): a #GAsyncReadyCallback to call when the
 935  *     request is satisfied
 936  * @user_data: (closure): the data to pass to callback function
 937  *
 938  * Asynchronously gets the requested information about the files
 939  * in a directory. The result is a #GFileEnumerator object that will
 940  * give out #GFileInfo objects for all the files in the directory.
 941  *
 942  * For more details, see g_file_enumerate_children() which is
 943  * the synchronous version of this call.
 944  *
 945  * When the operation is finished, @callback will be called. You can
 946  * then call g_file_enumerate_children_finish() to get the result of
 947  * the operation.
 948  */
 949 void
 950 g_file_enumerate_children_async (GFile               *file,
 951                                  const char          *attributes,
 952                                  GFileQueryInfoFlags  flags,
 953                                  int                  io_priority,
 954                                  GCancellable        *cancellable,
 955                                  GAsyncReadyCallback  callback,
 956                                  gpointer             user_data)
 957 {
 958   GFileIface *iface;
 959
 960   g_return_if_fail (G_IS_FILE (file));
 961
 962   iface = G_FILE_GET_IFACE (file);
 963   (* iface->enumerate_children_async) (file,
 964                                        attributes,
 965                                        flags,
 966                                        io_priority,
 967                                        cancellable,
 968                                        callback,
 969                                        user_data);
 970 }
 971
 972 /**
 973  * g_file_enumerate_children_finish:
 974  * @file: input #GFile
 975  * @res: a #GAsyncResult
 976  * @error: a #GError
 977  *
 978  * Finishes an async enumerate children operation.
 979  * See g_file_enumerate_children_async().
 980  *
 981  * Returns: (transfer full): a #GFileEnumerator or %NULL
 982  *     if an error occurred.
 983  *     Free the returned object with g_object_unref().
 984  */
 985 GFileEnumerator *
 986 g_file_enumerate_children_finish (GFile         *file,
 987                                   GAsyncResult  *res,
 988                                   GError       **error)
 989 {
 990   GFileIface *iface;
 991
 992   g_return_val_if_fail (G_IS_FILE (file), NULL);
 993   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
 994
 995   if (g_async_result_legacy_propagate_error (res, error))
 996     return NULL;
 997
 998   iface = G_FILE_GET_IFACE (file);
 999   return (* iface->enumerate_children_finish) (file, res, error);
1000 }
1001
1002 /**
1003  * g_file_query_exists:
1004  * @file: input #GFile
1005  * @cancellable: (allow-none): optional #GCancellable object,
1006  *     %NULL to ignore
1007  *
1008  * Utility function to check if a particular file exists. This is
1009  * implemented using g_file_query_info() and as such does blocking I/O.
1010  *
1011  * Note that in many cases it is racy to first check for file existence
1012  * and then execute something based on the outcome of that, because the
1013  * file might have been created or removed in between the operations. The
1014  * general approach to handling that is to not check, but just do the
1015  * operation and handle the errors as they come.
1016  *
1017  * As an example of race-free checking, take the case of reading a file,
1018  * and if it doesn't exist, creating it. There are two racy versions: read
1019  * it, and on error create it; and: check if it exists, if not create it.
1020  * These can both result in two processes creating the file (with perhaps
1021  * a partially written file as the result). The correct approach is to
1022  * always try to create the file with g_file_create() which will either
1023  * atomically create the file or fail with a %G_IO_ERROR_EXISTS error.
1024  *
1025  * However, in many cases an existence check is useful in a user interface,
1026  * for instance to make a menu item sensitive/insensitive, so that you don't
1027  * have to fool users that something is possible and then just show an error
1028  * dialog. If you do this, you should make sure to also handle the errors
1029  * that can happen due to races when you execute the operation.
1030  *
1031  * Returns: %TRUE if the file exists (and can be detected without error),
1032  *     %FALSE otherwise (or if cancelled).
1033  */
1034 gboolean
1035 g_file_query_exists (GFile        *file,
1036                      GCancellable *cancellable)
1037 {
1038   GFileInfo *info;
1039
1040   g_return_val_if_fail (G_IS_FILE(file), FALSE);
1041
1042   info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1043                             G_FILE_QUERY_INFO_NONE, cancellable, NULL);
1044   if (info != NULL)
1045     {
1046       g_object_unref (info);
1047       return TRUE;
1048     }
1049
1050   return FALSE;
1051 }
1052
1053 /**
1054  * g_file_query_file_type:
1055  * @file: input #GFile
1056  * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info()
1057  * @cancellable: (allow-none): optional #GCancellable object,
1058  *     %NULL to ignore
1059  *
1060  * Utility function to inspect the #GFileType of a file. This is
1061  * implemented using g_file_query_info() and as such does blocking I/O.
1062  *
1063  * The primary use case of this method is to check if a file is
1064  * a regular file, directory, or symlink.
1065  *
1066  * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN
1067  *     if the file does not exist
1068  *
1069  * Since: 2.18
1070  */
1071 GFileType
1072 g_file_query_file_type (GFile               *file,
1073                         GFileQueryInfoFlags  flags,
1074                         GCancellable        *cancellable)
1075 {
1076   GFileInfo *info;
1077   GFileType file_type;
1078
1079   g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN);
1080   info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags,
1081                             cancellable, NULL);
1082   if (info != NULL)
1083     {
1084       file_type = g_file_info_get_file_type (info);
1085       g_object_unref (info);
1086     }
1087   else
1088     file_type = G_FILE_TYPE_UNKNOWN;
1089
1090   return file_type;
1091 }
1092
1093 /**
1094  * g_file_query_info:
1095  * @file: input #GFile
1096  * @attributes: an attribute query string
1097  * @flags: a set of #GFileQueryInfoFlags
1098  * @cancellable: (allow-none): optional #GCancellable object,
1099  *     %NULL to ignore
1100  * @error: a #GError
1101  *
1102  * Gets the requested information about specified @file.
1103  * The result is a #GFileInfo object that contains key-value
1104  * attributes (such as the type or size of the file).
1105  *
1106  * The @attributes value is a string that specifies the file
1107  * attributes that should be gathered. It is not an error if
1108  * it's not possible to read a particular requested attribute
1109  * from a file - it just won't be set. @attributes should be a
1110  * comma-separated list of attributes or attribute wildcards.
1111  * The wildcard "*" means all attributes, and a wildcard like
1112  * "standard::*" means all attributes in the standard namespace.
1113  * An example attribute query be "standard::*,owner::user".
1114  * The standard attributes are available as defines, like
1115  * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1116  *
1117  * If @cancellable is not %NULL, then the operation can be cancelled
1118  * by triggering the cancellable object from another thread. If the
1119  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1120  * returned.
1121  *
1122  * For symlinks, normally the information about the target of the
1123  * symlink is returned, rather than information about the symlink
1124  * itself. However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
1125  * in @flags the information about the symlink itself will be returned.
1126  * Also, for symlinks that point to non-existing files the information
1127  * about the symlink itself will be returned.
1128  *
1129  * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1130  * returned. Other errors are possible too, and depend on what kind of
1131  * filesystem the file is on.
1132  *
1133  * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL
1134  *     on error. Free the returned object with g_object_unref().
1135  */
1136 GFileInfo *
1137 g_file_query_info (GFile                *file,
1138                    const char           *attributes,
1139                    GFileQueryInfoFlags   flags,
1140                    GCancellable         *cancellable,
1141                    GError              **error)
1142 {
1143   GFileIface *iface;
1144
1145   g_return_val_if_fail (G_IS_FILE (file), NULL);
1146
1147   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1148     return NULL;
1149
1150   iface = G_FILE_GET_IFACE (file);
1151
1152   if (iface->query_info == NULL)
1153     {
1154       g_set_error_literal (error, G_IO_ERROR,
1155                            G_IO_ERROR_NOT_SUPPORTED,
1156                            _("Operation not supported"));
1157       return NULL;
1158     }
1159
1160   return (* iface->query_info) (file, attributes, flags, cancellable, error);
1161 }
1162
1163 /**
1164  * g_file_query_info_async:
1165  * @file: input #GFile
1166  * @attributes: an attribute query string
1167  * @flags: a set of #GFileQueryInfoFlags
1168  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1169  *     of the request
1170  * @cancellable: (allow-none): optional #GCancellable object,
1171  *     %NULL to ignore
1172  * @callback: (scope async): a #GAsyncReadyCallback to call when the
1173  *     request is satisfied
1174  * @user_data: (closure): the data to pass to callback function
1175  *
1176  * Asynchronously gets the requested information about specified @file.
1177  * The result is a #GFileInfo object that contains key-value attributes
1178  * (such as type or size for the file).
1179  *
1180  * For more details, see g_file_query_info() which is the synchronous
1181  * version of this call.
1182  *
1183  * When the operation is finished, @callback will be called. You can
1184  * then call g_file_query_info_finish() to get the result of the operation.
1185  */
1186 void
1187 g_file_query_info_async (GFile               *file,
1188                          const char          *attributes,
1189                          GFileQueryInfoFlags  flags,
1190                          int                  io_priority,
1191                          GCancellable        *cancellable,
1192                          GAsyncReadyCallback  callback,
1193                          gpointer             user_data)
1194 {
1195   GFileIface *iface;
1196
1197   g_return_if_fail (G_IS_FILE (file));
1198
1199   iface = G_FILE_GET_IFACE (file);
1200   (* iface->query_info_async) (file,
1201                                attributes,
1202                                flags,
1203                                io_priority,
1204                                cancellable,
1205                                callback,
1206                                user_data);
1207 }
1208
1209 /**
1210  * g_file_query_info_finish:
1211  * @file: input #GFile
1212  * @res: a #GAsyncResult
1213  * @error: a #GError
1214  *
1215  * Finishes an asynchronous file info query.
1216  * See g_file_query_info_async().
1217  *
1218  * Returns: (transfer full): #GFileInfo for given @file
1219  *     or %NULL on error. Free the returned object with
1220  *     g_object_unref().
1221  */
1222 GFileInfo *
1223 g_file_query_info_finish (GFile         *file,
1224                           GAsyncResult  *res,
1225                           GError       **error)
1226 {
1227   GFileIface *iface;
1228
1229   g_return_val_if_fail (G_IS_FILE (file), NULL);
1230   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1231
1232   if (g_async_result_legacy_propagate_error (res, error))
1233     return NULL;
1234
1235   iface = G_FILE_GET_IFACE (file);
1236   return (* iface->query_info_finish) (file, res, error);
1237 }
1238
1239 /**
1240  * g_file_query_filesystem_info:
1241  * @file: input #GFile
1242  * @attributes:  an attribute query string
1243  * @cancellable: (allow-none): optional #GCancellable object,
1244  *     %NULL to ignore
1245  * @error: a #GError
1246  *
1247  * Similar to g_file_query_info(), but obtains information
1248  * about the filesystem the @file is on, rather than the file itself.
1249  * For instance the amount of space available and the type of
1250  * the filesystem.
1251  *
1252  * The @attributes value is a string that specifies the attributes
1253  * that should be gathered. It is not an error if it's not possible
1254  * to read a particular requested attribute from a file - it just
1255  * won't be set. @attributes should be a comma-separated list of
1256  * attributes or attribute wildcards. The wildcard "*" means all
1257  * attributes, and a wildcard like "filesystem::*" means all attributes
1258  * in the filesystem namespace. The standard namespace for filesystem
1259  * attributes is "filesystem". Common attributes of interest are
1260  * #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
1261  * in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
1262  * and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1263  *
1264  * If @cancellable is not %NULL, then the operation can be cancelled
1265  * by triggering the cancellable object from another thread. If the
1266  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1267  * returned.
1268  *
1269  * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1270  * be returned. Other errors are possible too, and depend on what
1271  * kind of filesystem the file is on.
1272  *
1273  * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1274  *     Free the returned object with g_object_unref().
1275  */
1276 GFileInfo *
1277 g_file_query_filesystem_info (GFile         *file,
1278                               const char    *attributes,
1279                               GCancellable  *cancellable,
1280                               GError       **error)
1281 {
1282   GFileIface *iface;
1283
1284   g_return_val_if_fail (G_IS_FILE (file), NULL);
1285
1286   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1287     return NULL;
1288
1289   iface = G_FILE_GET_IFACE (file);
1290
1291   if (iface->query_filesystem_info == NULL)
1292     {
1293       g_set_error_literal (error, G_IO_ERROR,
1294                            G_IO_ERROR_NOT_SUPPORTED,
1295                            _("Operation not supported"));
1296       return NULL;
1297     }
1298
1299   return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1300 }
1301
1302 /**
1303  * g_file_query_filesystem_info_async:
1304  * @file: input #GFile
1305  * @attributes: an attribute query string
1306  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1307  *     of the request
1308  * @cancellable: (allow-none): optional #GCancellable object,
1309  *     %NULL to ignore
1310  * @callback: (scope async): a #GAsyncReadyCallback to call
1311  *     when the request is satisfied
1312  * @user_data: (closure): the data to pass to callback function
1313  *
1314  * Asynchronously gets the requested information about the filesystem
1315  * that the specified @file is on. The result is a #GFileInfo object
1316  * that contains key-value attributes (such as type or size for the
1317  * file).
1318  *
1319  * For more details, see g_file_query_filesystem_info() which is the
1320  * synchronous version of this call.
1321  *
1322  * When the operation is finished, @callback will be called. You can
1323  * then call g_file_query_info_finish() to get the result of the
1324  * operation.
1325  */
1326 void
1327 g_file_query_filesystem_info_async (GFile               *file,
1328                                     const char          *attributes,
1329                                     int                  io_priority,
1330                                     GCancellable        *cancellable,
1331                                     GAsyncReadyCallback  callback,
1332                                     gpointer             user_data)
1333 {
1334   GFileIface *iface;
1335
1336   g_return_if_fail (G_IS_FILE (file));
1337
1338   iface = G_FILE_GET_IFACE (file);
1339   (* iface->query_filesystem_info_async) (file,
1340                                           attributes,
1341                                           io_priority,
1342                                           cancellable,
1343                                           callback,
1344                                           user_data);
1345 }
1346
1347 /**
1348  * g_file_query_filesystem_info_finish:
1349  * @file: input #GFile
1350  * @res: a #GAsyncResult
1351  * @error: a #GError
1352  *
1353  * Finishes an asynchronous filesystem info query.
1354  * See g_file_query_filesystem_info_async().
1355  *
1356  * Returns: (transfer full): #GFileInfo for given @file
1357  *     or %NULL on error.
1358  *     Free the returned object with g_object_unref().
1359  */
1360 GFileInfo *
1361 g_file_query_filesystem_info_finish (GFile         *file,
1362                                      GAsyncResult  *res,
1363                                      GError       **error)
1364 {
1365   GFileIface *iface;
1366
1367   g_return_val_if_fail (G_IS_FILE (file), NULL);
1368   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1369
1370   if (g_async_result_legacy_propagate_error (res, error))
1371     return NULL;
1372
1373   iface = G_FILE_GET_IFACE (file);
1374   return (* iface->query_filesystem_info_finish) (file, res, error);
1375 }
1376
1377 /**
1378  * g_file_find_enclosing_mount:
1379  * @file: input #GFile
1380  * @cancellable: (allow-none): optional #GCancellable object,
1381  *     %NULL to ignore
1382  * @error: a #GError
1383  *
1384  * Gets a #GMount for the #GFile.
1385  *
1386  * If the #GFileIface for @file does not have a mount (e.g.
1387  * possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND
1388  * and %NULL will be returned.
1389  *
1390  * If @cancellable is not %NULL, then the operation can be cancelled by
1391  * triggering the cancellable object from another thread. If the operation
1392  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1393  *
1394  * Returns: (transfer full): a #GMount where the @file is located
1395  *     or %NULL on error.
1396  *     Free the returned object with g_object_unref().
1397  */
1398 GMount *
1399 g_file_find_enclosing_mount (GFile         *file,
1400                              GCancellable  *cancellable,
1401                              GError       **error)
1402 {
1403   GFileIface *iface;
1404
1405   g_return_val_if_fail (G_IS_FILE (file), NULL);
1406
1407   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1408     return NULL;
1409
1410   iface = G_FILE_GET_IFACE (file);
1411   if (iface->find_enclosing_mount == NULL)
1412     {
1413
1414       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
1415                            /* Translators: This is an error message when
1416                             * trying to find the enclosing (user visible)
1417                             * mount of a file, but none exists.
1418                             */
1419                            _("Containing mount does not exist"));
1420       return NULL;
1421     }
1422
1423   return (* iface->find_enclosing_mount) (file, cancellable, error);
1424 }
1425
1426 /**
1427  * g_file_find_enclosing_mount_async:
1428  * @file: a #GFile
1429  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1430  *     of the request
1431  * @cancellable: (allow-none): optional #GCancellable object,
1432  *     %NULL to ignore
1433  * @callback: (scope async): a #GAsyncReadyCallback to call
1434  *     when the request is satisfied
1435  * @user_data: (closure): the data to pass to callback function
1436  *
1437  * Asynchronously gets the mount for the file.
1438  *
1439  * For more details, see g_file_find_enclosing_mount() which is
1440  * the synchronous version of this call.
1441  *
1442  * When the operation is finished, @callback will be called.
1443  * You can then call g_file_find_enclosing_mount_finish() to
1444  * get the result of the operation.
1445  */
1446 void
1447 g_file_find_enclosing_mount_async (GFile              *file,
1448                                    int                   io_priority,
1449                                    GCancellable         *cancellable,
1450                                    GAsyncReadyCallback   callback,
1451                                    gpointer              user_data)
1452 {
1453   GFileIface *iface;
1454
1455   g_return_if_fail (G_IS_FILE (file));
1456
1457   iface = G_FILE_GET_IFACE (file);
1458   (* iface->find_enclosing_mount_async) (file,
1459                                          io_priority,
1460                                          cancellable,
1461                                          callback,
1462                                          user_data);
1463 }
1464
1465 /**
1466  * g_file_find_enclosing_mount_finish:
1467  * @file: a #GFile
1468  * @res: a #GAsyncResult
1469  * @error: a #GError
1470  *
1471  * Finishes an asynchronous find mount request.
1472  * See g_file_find_enclosing_mount_async().
1473  *
1474  * Returns: (transfer full): #GMount for given @file or %NULL on error.
1475  *     Free the returned object with g_object_unref().
1476  */
1477 GMount *
1478 g_file_find_enclosing_mount_finish (GFile         *file,
1479                                     GAsyncResult  *res,
1480                                     GError       **error)
1481 {
1482   GFileIface *iface;
1483
1484   g_return_val_if_fail (G_IS_FILE (file), NULL);
1485   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1486
1487   if (g_async_result_legacy_propagate_error (res, error))
1488     return NULL;
1489
1490   iface = G_FILE_GET_IFACE (file);
1491   return (* iface->find_enclosing_mount_finish) (file, res, error);
1492 }
1493
1494
1495 /**
1496  * g_file_read:
1497  * @file: #GFile to read
1498  * @cancellable: (allow-none): a #GCancellable
1499  * @error: a #GError, or %NULL
1500  *
1501  * Opens a file for reading. The result is a #GFileInputStream that
1502  * can be used to read the contents of the file.
1503  *
1504  * If @cancellable is not %NULL, then the operation can be cancelled by
1505  * triggering the cancellable object from another thread. If the operation
1506  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1507  *
1508  * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1509  * returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1510  * error will be returned. Other errors are possible too, and depend
1511  * on what kind of filesystem the file is on.
1512  *
1513  * Virtual: read_fn
1514  * Returns: (transfer full): #GFileInputStream or %NULL on error.
1515  *     Free the returned object with g_object_unref().
1516  */
1517 GFileInputStream *
1518 g_file_read (GFile         *file,
1519              GCancellable  *cancellable,
1520              GError       **error)
1521 {
1522   GFileIface *iface;
1523
1524   g_return_val_if_fail (G_IS_FILE (file), NULL);
1525
1526   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1527     return NULL;
1528
1529   iface = G_FILE_GET_IFACE (file);
1530
1531   if (iface->read_fn == NULL)
1532     {
1533       g_set_error_literal (error, G_IO_ERROR,
1534                            G_IO_ERROR_NOT_SUPPORTED,
1535                            _("Operation not supported"));
1536       return NULL;
1537     }
1538
1539   return (* iface->read_fn) (file, cancellable, error);
1540 }
1541
1542 /**
1543  * g_file_append_to:
1544  * @file: input #GFile
1545  * @flags: a set of #GFileCreateFlags
1546  * @cancellable: (allow-none): optional #GCancellable object,
1547  *     %NULL to ignore
1548  * @error: a #GError, or %NULL
1549  *
1550  * Gets an output stream for appending data to the file.
1551  * If the file doesn't already exist it is created.
1552  *
1553  * By default files created are generally readable by everyone,
1554  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1555  * will be made readable only to the current user, to the level that
1556  * is supported on the target filesystem.
1557  *
1558  * If @cancellable is not %NULL, then the operation can be cancelled
1559  * by triggering the cancellable object from another thread. If the
1560  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1561  * returned.
1562  *
1563  * Some file systems don't allow all file names, and may return an
1564  * %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the
1565  * %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are
1566  * possible too, and depend on what kind of filesystem the file is on.
1567  *
1568  * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1569  *     Free the returned object with g_object_unref().
1570  */
1571 GFileOutputStream *
1572 g_file_append_to (GFile             *file,
1573                   GFileCreateFlags   flags,
1574                   GCancellable      *cancellable,
1575                   GError           **error)
1576 {
1577   GFileIface *iface;
1578
1579   g_return_val_if_fail (G_IS_FILE (file), NULL);
1580
1581   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1582     return NULL;
1583
1584   iface = G_FILE_GET_IFACE (file);
1585
1586   if (iface->append_to == NULL)
1587     {
1588       g_set_error_literal (error, G_IO_ERROR,
1589                            G_IO_ERROR_NOT_SUPPORTED,
1590                            _("Operation not supported"));
1591       return NULL;
1592     }
1593
1594   return (* iface->append_to) (file, flags, cancellable, error);
1595 }
1596
1597 /**
1598  * g_file_create:
1599  * @file: input #GFile
1600  * @flags: a set of #GFileCreateFlags
1601  * @cancellable: (allow-none): optional #GCancellable object,
1602  *     %NULL to ignore
1603  * @error: a #GError, or %NULL
1604  *
1605  * Creates a new file and returns an output stream for writing to it.
1606  * The file must not already exist.
1607  *
1608  * By default files created are generally readable by everyone,
1609  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1610  * will be made readable only to the current user, to the level
1611  * that is supported on the target filesystem.
1612  *
1613  * If @cancellable is not %NULL, then the operation can be cancelled
1614  * by triggering the cancellable object from another thread. If the
1615  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1616  * returned.
1617  *
1618  * If a file or directory with this name already exists the
1619  * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1620  * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1621  * error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will
1622  * be returned. Other errors are possible too, and depend on what kind
1623  * of filesystem the file is on.
1624  *
1625  * Returns: (transfer full): a #GFileOutputStream for the newly created
1626  *     file, or %NULL on error.
1627  *     Free the returned object with g_object_unref().
1628  */
1629 GFileOutputStream *
1630 g_file_create (GFile             *file,
1631                GFileCreateFlags   flags,
1632                GCancellable      *cancellable,
1633                GError           **error)
1634 {
1635   GFileIface *iface;
1636
1637   g_return_val_if_fail (G_IS_FILE (file), NULL);
1638
1639   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1640     return NULL;
1641
1642   iface = G_FILE_GET_IFACE (file);
1643
1644   if (iface->create == NULL)
1645     {
1646       g_set_error_literal (error, G_IO_ERROR,
1647                            G_IO_ERROR_NOT_SUPPORTED,
1648                            _("Operation not supported"));
1649       return NULL;
1650     }
1651
1652   return (* iface->create) (file, flags, cancellable, error);
1653 }
1654
1655 /**
1656  * g_file_replace:
1657  * @file: input #GFile
1658  * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link>
1659  *     for the current #GFile, or #NULL to ignore
1660  * @make_backup: %TRUE if a backup should be created
1661  * @flags: a set of #GFileCreateFlags
1662  * @cancellable: (allow-none): optional #GCancellable object,
1663  *     %NULL to ignore
1664  * @error: a #GError, or %NULL
1665  *
1666  * Returns an output stream for overwriting the file, possibly
1667  * creating a backup copy of the file first. If the file doesn't exist,
1668  * it will be created.
1669  *
1670  * This will try to replace the file in the safest way possible so
1671  * that any errors during the writing will not affect an already
1672  * existing copy of the file. For instance, for local files it
1673  * may write to a temporary file and then atomically rename over
1674  * the destination when the stream is closed.
1675  *
1676  * By default files created are generally readable by everyone,
1677  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1678  * will be made readable only to the current user, to the level that
1679  * is supported on the target filesystem.
1680  *
1681  * If @cancellable is not %NULL, then the operation can be cancelled
1682  * by triggering the cancellable object from another thread. If the
1683  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1684  * returned.
1685  *
1686  * If you pass in a non-%NULL @etag value, then this value is
1687  * compared to the current entity tag of the file, and if they differ
1688  * an %G_IO_ERROR_WRONG_ETAG error is returned. This generally means
1689  * that the file has been changed since you last read it. You can get
1690  * the new etag from g_file_output_stream_get_etag() after you've
1691  * finished writing and closed the #GFileOutputStream. When you load
1692  * a new file you can use g_file_input_stream_query_info() to get
1693  * the etag of the file.
1694  *
1695  * If @make_backup is %TRUE, this function will attempt to make a
1696  * backup of the current file before overwriting it. If this fails
1697  * a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
1698  * want to replace anyway, try again with @make_backup set to %FALSE.
1699  *
1700  * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will
1701  * be returned, and if the file is some other form of non-regular file
1702  * then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some
1703  * file systems don't allow all file names, and may return an
1704  * %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long
1705  * %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are
1706  * possible too, and depend on what kind of filesystem the file is on.
1707  *
1708  * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1709  *     Free the returned object with g_object_unref().
1710  */
1711 GFileOutputStream *
1712 g_file_replace (GFile             *file,
1713                 const char        *etag,
1714                 gboolean           make_backup,
1715                 GFileCreateFlags   flags,
1716                 GCancellable      *cancellable,
1717                 GError           **error)
1718 {
1719   GFileIface *iface;
1720
1721   g_return_val_if_fail (G_IS_FILE (file), NULL);
1722
1723   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1724     return NULL;
1725
1726   iface = G_FILE_GET_IFACE (file);
1727
1728   if (iface->replace == NULL)
1729     {
1730       g_set_error_literal (error, G_IO_ERROR,
1731                            G_IO_ERROR_NOT_SUPPORTED,
1732                            _("Operation not supported"));
1733       return NULL;
1734     }
1735
1736   /* Handle empty tag string as NULL in consistent way. */
1737   if (etag && *etag == 0)
1738     etag = NULL;
1739
1740   return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1741 }
1742
1743 /**
1744  * g_file_open_readwrite:
1745  * @file: #GFile to open
1746  * @cancellable: (allow-none): a #GCancellable
1747  * @error: a #GError, or %NULL
1748  *
1749  * Opens an existing file for reading and writing. The result is
1750  * a #GFileIOStream that can be used to read and write the contents
1751  * of the file.
1752  *
1753  * If @cancellable is not %NULL, then the operation can be cancelled
1754  * by triggering the cancellable object from another thread. If the
1755  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1756  * returned.
1757  *
1758  * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1759  * be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1760  * error will be returned. Other errors are possible too, and depend on
1761  * what kind of filesystem the file is on. Note that in many non-local
1762  * file cases read and write streams are not supported, so make sure you
1763  * really need to do read and write streaming, rather than just opening
1764  * for reading or writing.
1765  *
1766  * Returns: (transfer full): #GFileIOStream or %NULL on error.
1767  *     Free the returned object with g_object_unref().
1768  *
1769  * Since: 2.22
1770  */
1771 GFileIOStream *
1772 g_file_open_readwrite (GFile         *file,
1773                        GCancellable  *cancellable,
1774                        GError       **error)
1775 {
1776   GFileIface *iface;
1777
1778   g_return_val_if_fail (G_IS_FILE (file), NULL);
1779
1780   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1781     return NULL;
1782
1783   iface = G_FILE_GET_IFACE (file);
1784
1785   if (iface->open_readwrite == NULL)
1786     {
1787       g_set_error_literal (error, G_IO_ERROR,
1788                            G_IO_ERROR_NOT_SUPPORTED,
1789                            _("Operation not supported"));
1790       return NULL;
1791     }
1792
1793   return (* iface->open_readwrite) (file, cancellable, error);
1794 }
1795
1796 /**
1797  * g_file_create_readwrite:
1798  * @file: a #GFile
1799  * @flags: a set of #GFileCreateFlags
1800  * @cancellable: (allow-none): optional #GCancellable object,
1801  *     %NULL to ignore
1802  * @error: return location for a #GError, or %NULL
1803  *
1804  * Creates a new file and returns a stream for reading and
1805  * writing to it. The file must not already exist.
1806  *
1807  * By default files created are generally readable by everyone,
1808  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1809  * will be made readable only to the current user, to the level
1810  * that is supported on the target filesystem.
1811  *
1812  * If @cancellable is not %NULL, then the operation can be cancelled
1813  * by triggering the cancellable object from another thread. If the
1814  * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1815  * returned.
1816  *
1817  * If a file or directory with this name already exists, the
1818  * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1819  * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1820  * error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG
1821  * will be returned. Other errors are possible too, and depend on what
1822  * kind of filesystem the file is on.
1823  *
1824  * Note that in many non-local file cases read and write streams are
1825  * not supported, so make sure you really need to do read and write
1826  * streaming, rather than just opening for reading or writing.
1827  *
1828  * Returns: (transfer full): a #GFileIOStream for the newly created
1829  *     file, or %NULL on error.
1830  *     Free the returned object with g_object_unref().
1831  *
1832  * Since: 2.22
1833  */
1834 GFileIOStream *
1835 g_file_create_readwrite (GFile             *file,
1836                          GFileCreateFlags   flags,
1837                          GCancellable      *cancellable,
1838                          GError           **error)
1839 {
1840   GFileIface *iface;
1841
1842   g_return_val_if_fail (G_IS_FILE (file), NULL);
1843
1844   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1845     return NULL;
1846
1847   iface = G_FILE_GET_IFACE (file);
1848
1849   if (iface->create_readwrite == NULL)
1850     {
1851       g_set_error_literal (error, G_IO_ERROR,
1852                            G_IO_ERROR_NOT_SUPPORTED,
1853                            _("Operation not supported"));
1854       return NULL;
1855     }
1856
1857   return (* iface->create_readwrite) (file, flags, cancellable, error);
1858 }
1859
1860 /**
1861  * g_file_replace_readwrite:
1862  * @file: a #GFile
1863  * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link>
1864  *     for the current #GFile, or #NULL to ignore
1865  * @make_backup: %TRUE if a backup should be created
1866  * @flags: a set of #GFileCreateFlags
1867  * @cancellable: (allow-none): optional #GCancellable object,
1868  *     %NULL to ignore
1869  * @error: return location for a #GError, or %NULL
1870  *
1871  * Returns an output stream for overwriting the file in readwrite mode,
1872  * possibly creating a backup copy of the file first. If the file doesn't
1873  * exist, it will be created.
1874  *
1875  * For details about the behaviour, see g_file_replace() which does the
1876  * same thing but returns an output stream only.
1877  *
1878  * Note that in many non-local file cases read and write streams are not
1879  * supported, so make sure you really need to do read and write streaming,
1880  * rather than just opening for reading or writing.
1881  *
1882  * Returns: (transfer full): a #GFileIOStream or %NULL on error.
1883  *     Free the returned object with g_object_unref().
1884  *
1885  * Since: 2.22
1886  */
1887 GFileIOStream *
1888 g_file_replace_readwrite (GFile             *file,
1889                           const char        *etag,
1890                           gboolean           make_backup,
1891                           GFileCreateFlags   flags,
1892                           GCancellable      *cancellable,
1893                           GError           **error)
1894 {
1895   GFileIface *iface;
1896
1897   g_return_val_if_fail (G_IS_FILE (file), NULL);
1898
1899   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1900     return NULL;
1901
1902   iface = G_FILE_GET_IFACE (file);
1903
1904   if (iface->replace_readwrite == NULL)
1905     {
1906       g_set_error_literal (error, G_IO_ERROR,
1907                            G_IO_ERROR_NOT_SUPPORTED,
1908                            _("Operation not supported"));
1909       return NULL;
1910     }
1911
1912   return (* iface->replace_readwrite) (file, etag, make_backup, flags, cancellable, error);
1913 }
1914
1915 /**
1916  * g_file_read_async:
1917  * @file: input #GFile
1918  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1919  *     of the request
1920  * @cancellable: (allow-none): optional #GCancellable object,
1921  *     %NULL to ignore
1922  * @callback: (scope async): a #GAsyncReadyCallback to call
1923  *     when the request is satisfied
1924  * @user_data: (closure): the data to pass to callback function
1925  *
1926  * Asynchronously opens @file for reading.
1927  *
1928  * For more details, see g_file_read() which is
1929  * the synchronous version of this call.
1930  *
1931  * When the operation is finished, @callback will be called.
1932  * You can then call g_file_read_finish() to get the result
1933  * of the operation.
1934  */
1935 void
1936 g_file_read_async (GFile               *file,
1937                    int                  io_priority,
1938                    GCancellable        *cancellable,
1939                    GAsyncReadyCallback  callback,
1940                    gpointer             user_data)
1941 {
1942   GFileIface *iface;
1943
1944   g_return_if_fail (G_IS_FILE (file));
1945
1946   iface = G_FILE_GET_IFACE (file);
1947   (* iface->read_async) (file,
1948                          io_priority,
1949                          cancellable,
1950                          callback,
1951                          user_data);
1952 }
1953
1954 /**
1955  * g_file_read_finish:
1956  * @file: input #GFile
1957  * @res: a #GAsyncResult
1958  * @error: a #GError, or %NULL
1959  *
1960  * Finishes an asynchronous file read operation started with
1961  * g_file_read_async().
1962  *
1963  * Returns: (transfer full): a #GFileInputStream or %NULL on error.
1964  *     Free the returned object with g_object_unref().
1965  */
1966 GFileInputStream *
1967 g_file_read_finish (GFile         *file,
1968                     GAsyncResult  *res,
1969                     GError       **error)
1970 {
1971   GFileIface *iface;
1972
1973   g_return_val_if_fail (G_IS_FILE (file), NULL);
1974   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1975
1976   if (g_async_result_legacy_propagate_error (res, error))
1977     return NULL;
1978
1979   iface = G_FILE_GET_IFACE (file);
1980   return (* iface->read_finish) (file, res, error);
1981 }
1982
1983 /**
1984  * g_file_append_to_async:
1985  * @file: input #GFile
1986  * @flags: a set of #GFileCreateFlags
1987  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1988  *     of the request
1989  * @cancellable: (allow-none): optional #GCancellable object,
1990  *     %NULL to ignore
1991  * @callback: (scope async): a #GAsyncReadyCallback to call
1992  *     when the request is satisfied
1993  * @user_data: (closure): the data to pass to callback function
1994  *
1995  * Asynchronously opens @file for appending.
1996  *
1997  * For more details, see g_file_append_to() which is
1998  * the synchronous version of this call.
1999  *
2000  * When the operation is finished, @callback will be called.
2001  * You can then call g_file_append_to_finish() to get the result
2002  * of the operation.
2003  */
2004 void
2005 g_file_append_to_async (GFile               *file,
2006                         GFileCreateFlags     flags,
2007                         int                  io_priority,
2008                         GCancellable        *cancellable,
2009                         GAsyncReadyCallback  callback,
2010                         gpointer             user_data)
2011 {
2012   GFileIface *iface;
2013
2014   g_return_if_fail (G_IS_FILE (file));
2015
2016   iface = G_FILE_GET_IFACE (file);
2017   (* iface->append_to_async) (file,
2018                               flags,
2019                               io_priority,
2020                               cancellable,
2021                               callback,
2022                               user_data);
2023 }
2024
2025 /**
2026  * g_file_append_to_finish:
2027  * @file: input #GFile
2028  * @res: #GAsyncResult
2029  * @error: a #GError, or %NULL
2030  *
2031  * Finishes an asynchronous file append operation started with
2032  * g_file_append_to_async().
2033  *
2034  * Returns: (transfer full): a valid #GFileOutputStream
2035  *     or %NULL on error.
2036  *     Free the returned object with g_object_unref().
2037  */
2038 GFileOutputStream *
2039 g_file_append_to_finish (GFile         *file,
2040                          GAsyncResult  *res,
2041                          GError       **error)
2042 {
2043   GFileIface *iface;
2044
2045   g_return_val_if_fail (G_IS_FILE (file), NULL);
2046   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2047
2048   if (g_async_result_legacy_propagate_error (res, error))
2049     return NULL;
2050
2051   iface = G_FILE_GET_IFACE (file);
2052   return (* iface->append_to_finish) (file, res, error);
2053 }
2054
2055 /**
2056  * g_file_create_async:
2057  * @file: input #GFile
2058  * @flags: a set of #GFileCreateFlags
2059  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2060  *     of the request
2061  * @cancellable: (allow-none): optional #GCancellable object,
2062  *     %NULL to ignore
2063  * @callback: (scope async): a #GAsyncReadyCallback to call
2064  *     when the request is satisfied
2065  * @user_data: (closure): the data to pass to callback function
2066  *
2067  * Asynchronously creates a new file and returns an output stream
2068  * for writing to it. The file must not already exist.
2069  *
2070  * For more details, see g_file_create() which is
2071  * the synchronous version of this call.
2072  *
2073  * When the operation is finished, @callback will be called.
2074  * You can then call g_file_create_finish() to get the result
2075  * of the operation.
2076  */
2077 void
2078 g_file_create_async (GFile               *file,
2079                      GFileCreateFlags     flags,
2080                      int                  io_priority,
2081                      GCancellable        *cancellable,
2082                      GAsyncReadyCallback  callback,
2083                      gpointer             user_data)
2084 {
2085   GFileIface *iface;
2086
2087   g_return_if_fail (G_IS_FILE (file));
2088
2089   iface = G_FILE_GET_IFACE (file);
2090   (* iface->create_async) (file,
2091                            flags,
2092                            io_priority,
2093                            cancellable,
2094                            callback,
2095                            user_data);
2096 }
2097
2098 /**
2099  * g_file_create_finish:
2100  * @file: input #GFile
2101  * @res: a #GAsyncResult
2102  * @error: a #GError, or %NULL
2103  *
2104  * Finishes an asynchronous file create operation started with
2105  * g_file_create_async().
2106  *
2107  * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2108  *     Free the returned object with g_object_unref().
2109  */
2110 GFileOutputStream *
2111 g_file_create_finish (GFile         *file,
2112                       GAsyncResult  *res,
2113                       GError       **error)
2114 {
2115   GFileIface *iface;
2116
2117   g_return_val_if_fail (G_IS_FILE (file), NULL);
2118   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2119
2120   if (g_async_result_legacy_propagate_error (res, error))
2121     return NULL;
2122
2123   iface = G_FILE_GET_IFACE (file);
2124   return (* iface->create_finish) (file, res, error);
2125 }
2126
2127 /**
2128  * g_file_replace_async:
2129  * @file: input #GFile
2130  * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link>
2131  *     for the current #GFile, or NULL to ignore
2132  * @make_backup: %TRUE if a backup should be created
2133  * @flags: a set of #GFileCreateFlags
2134  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2135  *     of the request
2136  * @cancellable: (allow-none): optional #GCancellable object,
2137  *     %NULL to ignore
2138  * @callback: (scope async): a #GAsyncReadyCallback to call
2139  *     when the request is satisfied
2140  * @user_data: (closure): the data to pass to callback function
2141  *
2142  * Asynchronously overwrites the file, replacing the contents,
2143  * possibly creating a backup copy of the file first.
2144  *
2145  * For more details, see g_file_replace() which is
2146  * the synchronous version of this call.
2147  *
2148  * When the operation is finished, @callback will be called.
2149  * You can then call g_file_replace_finish() to get the result
2150  * of the operation.
2151  */
2152 void
2153 g_file_replace_async (GFile               *file,
2154                       const char          *etag,
2155                       gboolean             make_backup,
2156                       GFileCreateFlags     flags,
2157                       int                  io_priority,
2158                       GCancellable        *cancellable,
2159                       GAsyncReadyCallback  callback,
2160                       gpointer             user_data)
2161 {
2162   GFileIface *iface;
2163
2164   g_return_if_fail (G_IS_FILE (file));
2165
2166   iface = G_FILE_GET_IFACE (file);
2167   (* iface->replace_async) (file,
2168                             etag,
2169                             make_backup,
2170                             flags,
2171                             io_priority,
2172                             cancellable,
2173                             callback,
2174                             user_data);
2175 }
2176
2177 /**
2178  * g_file_replace_finish:
2179  * @file: input #GFile
2180  * @res: a #GAsyncResult
2181  * @error: a #GError, or %NULL
2182  *
2183  * Finishes an asynchronous file replace operation started with
2184  * g_file_replace_async().
2185  *
2186  * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2187  *     Free the returned object with g_object_unref().
2188  */
2189 GFileOutputStream *
2190 g_file_replace_finish (GFile         *file,
2191                        GAsyncResult  *res,
2192                        GError       **error)
2193 {
2194   GFileIface *iface;
2195
2196   g_return_val_if_fail (G_IS_FILE (file), NULL);
2197   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2198
2199   if (g_async_result_legacy_propagate_error (res, error))
2200     return NULL;
2201
2202   iface = G_FILE_GET_IFACE (file);
2203   return (* iface->replace_finish) (file, res, error);
2204 }
2205
2206 /**
2207  * g_file_open_readwrite_async
2208  * @file: input #GFile
2209  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2210  *     of the request
2211  * @cancellable: (allow-none): optional #GCancellable object,
2212  *     %NULL to ignore
2213  * @callback: (scope async): a #GAsyncReadyCallback to call
2214  *     when the request is satisfied
2215  * @user_data: (closure): the data to pass to callback function
2216  *
2217  * Asynchronously opens @file for reading and writing.
2218  *
2219  * For more details, see g_file_open_readwrite() which is
2220  * the synchronous version of this call.
2221  *
2222  * When the operation is finished, @callback will be called.
2223  * You can then call g_file_open_readwrite_finish() to get
2224  * the result of the operation.
2225  *
2226  * Since: 2.22
2227  */
2228 void
2229 g_file_open_readwrite_async (GFile               *file,
2230                              int                  io_priority,
2231                              GCancellable        *cancellable,
2232                              GAsyncReadyCallback  callback,
2233                              gpointer             user_data)
2234 {
2235   GFileIface *iface;
2236
2237   g_return_if_fail (G_IS_FILE (file));
2238
2239   iface = G_FILE_GET_IFACE (file);
2240   (* iface->open_readwrite_async) (file,
2241                                    io_priority,
2242                                    cancellable,
2243                                    callback,
2244                                    user_data);
2245 }
2246
2247 /**
2248  * g_file_open_readwrite_finish:
2249  * @file: input #GFile
2250  * @res: a #GAsyncResult
2251  * @error: a #GError, or %NULL
2252  *
2253  * Finishes an asynchronous file read operation started with
2254  * g_file_open_readwrite_async().
2255  *
2256  * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2257  *     Free the returned object with g_object_unref().
2258  *
2259  * Since: 2.22
2260  */
2261 GFileIOStream *
2262 g_file_open_readwrite_finish (GFile         *file,
2263                               GAsyncResult  *res,
2264                               GError       **error)
2265 {
2266   GFileIface *iface;
2267
2268   g_return_val_if_fail (G_IS_FILE (file), NULL);
2269   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2270
2271   if (g_async_result_legacy_propagate_error (res, error))
2272     return NULL;
2273
2274   iface = G_FILE_GET_IFACE (file);
2275   return (* iface->open_readwrite_finish) (file, res, error);
2276 }
2277
2278 /**
2279  * g_file_create_readwrite_async:
2280  * @file: input #GFile
2281  * @flags: a set of #GFileCreateFlags
2282  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2283  *     of the request
2284  * @cancellable: (allow-none): optional #GCancellable object,
2285  *     %NULL to ignore
2286  * @callback: (scope async): a #GAsyncReadyCallback to call
2287  *     when the request is satisfied
2288  * @user_data: (closure): the data to pass to callback function
2289  *
2290  * Asynchronously creates a new file and returns a stream
2291  * for reading and writing to it. The file must not already exist.
2292  *
2293  * For more details, see g_file_create_readwrite() which is
2294  * the synchronous version of this call.
2295  *
2296  * When the operation is finished, @callback will be called.
2297  * You can then call g_file_create_readwrite_finish() to get
2298  * the result of the operation.
2299  *
2300  * Since: 2.22
2301  */
2302 void
2303 g_file_create_readwrite_async (GFile               *file,
2304                                GFileCreateFlags     flags,
2305                                int                  io_priority,
2306                                GCancellable        *cancellable,
2307                                GAsyncReadyCallback  callback,
2308                                gpointer             user_data)
2309 {
2310   GFileIface *iface;
2311
2312   g_return_if_fail (G_IS_FILE (file));
2313
2314   iface = G_FILE_GET_IFACE (file);
2315   (* iface->create_readwrite_async) (file,
2316                                      flags,
2317                                      io_priority,
2318                                      cancellable,
2319                                      callback,
2320                                      user_data);
2321 }
2322
2323 /**
2324  * g_file_create_readwrite_finish:
2325  * @file: input #GFile
2326  * @res: a #GAsyncResult
2327  * @error: a #GError, or %NULL
2328  *
2329  * Finishes an asynchronous file create operation started with
2330  * g_file_create_readwrite_async().
2331  *
2332  * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2333  *     Free the returned object with g_object_unref().
2334  *
2335  * Since: 2.22
2336  */
2337 GFileIOStream *
2338 g_file_create_readwrite_finish (GFile         *file,
2339                                 GAsyncResult  *res,
2340                                 GError       **error)
2341 {
2342   GFileIface *iface;
2343
2344   g_return_val_if_fail (G_IS_FILE (file), NULL);
2345   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2346
2347   if (g_async_result_legacy_propagate_error (res, error))
2348     return NULL;
2349
2350   iface = G_FILE_GET_IFACE (file);
2351   return (* iface->create_readwrite_finish) (file, res, error);
2352 }
2353
2354 /**
2355  * g_file_replace_readwrite_async:
2356  * @file: input #GFile
2357  * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link>
2358  *     for the current #GFile, or NULL to ignore
2359  * @make_backup: %TRUE if a backup should be created
2360  * @flags: a set of #GFileCreateFlags
2361  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2362  *     of the request
2363  * @cancellable: (allow-none): optional #GCancellable object,
2364  *     %NULL to ignore
2365  * @callback: (scope async): a #GAsyncReadyCallback to call
2366  *     when the request is satisfied
2367  * @user_data: (closure): the data to pass to callback function
2368  *
2369  * Asynchronously overwrites the file in read-write mode,
2370  * replacing the contents, possibly creating a backup copy
2371  * of the file first.
2372  *
2373  * For more details, see g_file_replace_readwrite() which is
2374  * the synchronous version of this call.
2375  *
2376  * When the operation is finished, @callback will be called.
2377  * You can then call g_file_replace_readwrite_finish() to get
2378  * the result of the operation.
2379  *
2380  * Since: 2.22
2381  */
2382 void
2383 g_file_replace_readwrite_async (GFile               *file,
2384                                 const char          *etag,
2385                                 gboolean             make_backup,
2386                                 GFileCreateFlags     flags,
2387                                 int                  io_priority,
2388                                 GCancellable        *cancellable,
2389                                 GAsyncReadyCallback  callback,
2390                                 gpointer             user_data)
2391 {
2392   GFileIface *iface;
2393
2394   g_return_if_fail (G_IS_FILE (file));
2395
2396   iface = G_FILE_GET_IFACE (file);
2397   (* iface->replace_readwrite_async) (file,
2398                                       etag,
2399                                       make_backup,
2400                                       flags,
2401                                       io_priority,
2402                                       cancellable,
2403                                       callback,
2404                                       user_data);
2405 }
2406
2407 /**
2408  * g_file_replace_readwrite_finish:
2409  * @file: input #GFile
2410  * @res: a #GAsyncResult
2411  * @error: a #GError, or %NULL
2412  *
2413  * Finishes an asynchronous file replace operation started with
2414  * g_file_replace_readwrite_async().
2415  *
2416  * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2417  *     Free the returned object with g_object_unref().
2418  *
2419  * Since: 2.22
2420  */
2421 GFileIOStream *
2422 g_file_replace_readwrite_finish (GFile         *file,
2423                                  GAsyncResult  *res,
2424                                  GError       **error)
2425 {
2426   GFileIface *iface;
2427
2428   g_return_val_if_fail (G_IS_FILE (file), NULL);
2429   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2430
2431   if (g_async_result_legacy_propagate_error (res, error))
2432     return NULL;
2433
2434   iface = G_FILE_GET_IFACE (file);
2435   return (* iface->replace_readwrite_finish) (file, res, error);
2436 }
2437
2438 static gboolean
2439 copy_symlink (GFile           *destination,
2440               GFileCopyFlags   flags,
2441               GCancellable    *cancellable,
2442               const char      *target,
2443               GError         **error)
2444 {
2445   GError *my_error;
2446   gboolean tried_delete;
2447   GFileInfo *info;
2448   GFileType file_type;
2449
2450   tried_delete = FALSE;
2451
2452  retry:
2453   my_error = NULL;
2454   if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
2455     {
2456       /* Maybe it already existed, and we want to overwrite? */
2457       if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
2458           my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
2459         {
2460           g_error_free (my_error);
2461
2462           /* Don't overwrite if the destination is a directory */
2463           info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2464                                     G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2465                                     cancellable, &my_error);
2466           if (info != NULL)
2467             {
2468               file_type = g_file_info_get_file_type (info);
2469               g_object_unref (info);
2470
2471               if (file_type == G_FILE_TYPE_DIRECTORY)
2472                 {
2473                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
2474                                        _("Can't copy over directory"));
2475                   return FALSE;
2476                 }
2477             }
2478
2479           if (!g_file_delete (destination, cancellable, error))
2480             return FALSE;
2481
2482           tried_delete = TRUE;
2483           goto retry;
2484         }
2485             /* Nah, fail */
2486       g_propagate_error (error, my_error);
2487       return FALSE;
2488     }
2489
2490   return TRUE;
2491 }
2492
2493 static GInputStream *
2494 open_source_for_copy (GFile           *source,
2495                       GFile           *destination,
2496                       GFileCopyFlags   flags,
2497                       GCancellable    *cancellable,
2498                       GError         **error)
2499 {
2500   GError *my_error;
2501   GInputStream *in;
2502   GFileInfo *info;
2503   GFileType file_type;
2504
2505   my_error = NULL;
2506   in = (GInputStream *)g_file_read (source, cancellable, &my_error);
2507   if (in != NULL)
2508     return in;
2509
2510   /* There was an error opening the source, try to set a good error for it: */
2511   if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
2512     {
2513       /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2514        * as that is less useful to the app. Better check for errors on the
2515        * target instead.
2516        */
2517       g_error_free (my_error);
2518       my_error = NULL;
2519
2520       info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2521                                 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2522                                 cancellable, &my_error);
2523       if (info != NULL &&
2524           g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_TYPE))
2525         {
2526           file_type = g_file_info_get_file_type (info);
2527           g_object_unref (info);
2528
2529           if (flags & G_FILE_COPY_OVERWRITE)
2530             {
2531               if (file_type == G_FILE_TYPE_DIRECTORY)
2532                 {
2533                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
2534                                        _("Can't copy directory over directory"));
2535                   return NULL;
2536                 }
2537               /* continue to would_recurse error */
2538             }
2539           else
2540             {
2541               g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
2542                                    _("Target file exists"));
2543               return NULL;
2544             }
2545         }
2546       else
2547         {
2548           /* Error getting info from target, return that error
2549            * (except for NOT_FOUND, which is no error here)
2550            */
2551           g_clear_object (&info);
2552           if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
2553             {
2554               g_propagate_error (error, my_error);
2555               return NULL;
2556             }
2557           g_clear_error (&my_error);
2558         }
2559
2560       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
2561                            _("Can't recursively copy directory"));
2562       return NULL;
2563     }
2564
2565   g_propagate_error (error, my_error);
2566   return NULL;
2567 }
2568
2569 static gboolean
2570 should_copy (GFileAttributeInfo *info,
2571              gboolean            as_move,
2572              gboolean            skip_perms)
2573 {
2574   if (skip_perms && strcmp(info->name, "unix::mode") == 0)
2575         return FALSE;
2576
2577   if (as_move)
2578     return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
2579   return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
2580 }
2581
2582 static char *
2583 build_attribute_list_for_copy (GFileAttributeInfoList *attributes,
2584                                GFileAttributeInfoList *namespaces,
2585                                gboolean                as_move,
2586                                gboolean                skip_perms)
2587 {
2588   GString *s;
2589   gboolean first;
2590   int i;
2591
2592   first = TRUE;
2593   s = g_string_new ("");
2594
2595   if (attributes)
2596     {
2597       for (i = 0; i < attributes->n_infos; i++)
2598         {
2599           if (should_copy (&attributes->infos[i], as_move, skip_perms))
2600             {
2601               if (first)
2602                 first = FALSE;
2603               else
2604                 g_string_append_c (s, ',');
2605
2606               g_string_append (s, attributes->infos[i].name);
2607             }
2608         }
2609     }
2610
2611   if (namespaces)
2612     {
2613       for (i = 0; i < namespaces->n_infos; i++)
2614         {
2615           if (should_copy (&namespaces->infos[i], as_move, FALSE))
2616             {
2617               if (first)
2618                 first = FALSE;
2619               else
2620                 g_string_append_c (s, ',');
2621
2622               g_string_append (s, namespaces->infos[i].name);
2623               g_string_append (s, "::*");
2624             }
2625         }
2626     }
2627
2628   return g_string_free (s, FALSE);
2629 }
2630
2631 /**
2632  * g_file_copy_attributes:
2633  * @source: a #GFile with attributes
2634  * @destination: a #GFile to copy attributes to
2635  * @flags: a set of #GFileCopyFlags
2636  * @cancellable: (allow-none): optional #GCancellable object,
2637  *     %NULL to ignore
2638  * @error: a #GError, %NULL to ignore
2639  *
2640  * Copies the file attributes from @source to @destination.
2641  *
2642  * Normally only a subset of the file attributes are copied,
2643  * those that are copies in a normal file copy operation
2644  * (which for instance does not include e.g. owner). However
2645  * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2646  * all the metadata that is possible to copy is copied. This
2647  * is useful when implementing move by copy + delete source.
2648  *
2649  * Returns: %TRUE if the attributes were copied successfully,
2650  *     %FALSE otherwise.
2651  */
2652 gboolean
2653 g_file_copy_attributes (GFile           *source,
2654                         GFile           *destination,
2655                         GFileCopyFlags   flags,
2656                         GCancellable    *cancellable,
2657                         GError         **error)
2658 {
2659   GFileAttributeInfoList *attributes, *namespaces;
2660   char *attrs_to_read;
2661   gboolean res;
2662   GFileInfo *info;
2663   gboolean as_move;
2664   gboolean source_nofollow_symlinks;
2665   gboolean skip_perms;
2666
2667   as_move = flags & G_FILE_COPY_ALL_METADATA;
2668   source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
2669   skip_perms = (flags & G_FILE_COPY_TARGET_DEFAULT_PERMS) != 0;
2670
2671   /* Ignore errors here, if the target supports no attributes there is
2672    * nothing to copy
2673    */
2674   attributes = g_file_query_settable_attributes (destination, cancellable, NULL);
2675   namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL);
2676
2677   if (attributes == NULL && namespaces == NULL)
2678     return TRUE;
2679
2680   attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move, skip_perms);
2681
2682   /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2683    * we just don't copy it.
2684    */
2685   info = g_file_query_info (source, attrs_to_read,
2686                             source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
2687                             cancellable,
2688                             NULL);
2689
2690   g_free (attrs_to_read);
2691
2692   res = TRUE;
2693   if  (info)
2694     {
2695       res = g_file_set_attributes_from_info (destination,
2696                                              info,
2697                                              G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2698                                              cancellable,
2699                                              error);
2700       g_object_unref (info);
2701     }
2702
2703   g_file_attribute_info_list_unref (attributes);
2704   g_file_attribute_info_list_unref (namespaces);
2705
2706   return res;
2707 }
2708
2709 static gboolean
2710 copy_stream_with_progress (GInputStream           *in,
2711                            GOutputStream          *out,
2712                            GFile                  *source,
2713                            GCancellable           *cancellable,
2714                            GFileProgressCallback   progress_callback,
2715                            gpointer                progress_callback_data,
2716                            GError                **error)
2717 {
2718   gssize n_read, n_written;
2719   goffset current_size;
2720   char buffer[1024*64], *p;
2721   gboolean res;
2722   goffset total_size;
2723   GFileInfo *info;
2724
2725   total_size = -1;
2726   /* avoid performance impact of querying total size when it's not needed */
2727   if (progress_callback)
2728     {
2729       info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2730                                              G_FILE_ATTRIBUTE_STANDARD_SIZE,
2731                                              cancellable, NULL);
2732       if (info)
2733         {
2734           if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2735             total_size = g_file_info_get_size (info);
2736           g_object_unref (info);
2737         }
2738
2739       if (total_size == -1)
2740         {
2741           info = g_file_query_info (source,
2742                                     G_FILE_ATTRIBUTE_STANDARD_SIZE,
2743                                     G_FILE_QUERY_INFO_NONE,
2744                                     cancellable, NULL);
2745           if (info)
2746             {
2747               if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2748                 total_size = g_file_info_get_size (info);
2749               g_object_unref (info);
2750             }
2751         }
2752     }
2753
2754   if (total_size == -1)
2755     total_size = 0;
2756
2757   current_size = 0;
2758   res = TRUE;
2759   while (TRUE)
2760     {
2761       n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2762       if (n_read == -1)
2763         {
2764           res = FALSE;
2765           break;
2766         }
2767
2768       if (n_read == 0)
2769         break;
2770
2771       current_size += n_read;
2772
2773       p = buffer;
2774       while (n_read > 0)
2775         {
2776           n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2777           if (n_written == -1)
2778             {
2779               res = FALSE;
2780               break;
2781             }
2782
2783           p += n_written;
2784           n_read -= n_written;
2785         }
2786
2787       if (!res)
2788         break;
2789
2790       if (progress_callback)
2791         progress_callback (current_size, total_size, progress_callback_data);
2792     }
2793
2794   /* Make sure we send full copied size */
2795   if (progress_callback)
2796     progress_callback (current_size, total_size, progress_callback_data);
2797
2798   return res;
2799 }
2800
2801 #ifdef HAVE_SPLICE
2802
2803 static gboolean
2804 do_splice (int     fd_in,
2805            loff_t *off_in,
2806            int     fd_out,
2807            loff_t *off_out,
2808            size_t  len,
2809            long   *bytes_transferd,
2810            GError **error)
2811 {
2812   long result;
2813
2814 retry:
2815   result = splice (fd_in, off_in, fd_out, off_out, len, SPLICE_F_MORE);
2816
2817   if (result == -1)
2818     {
2819       int errsv = errno;
2820
2821       if (errsv == EINTR)
2822         goto retry;
2823       else if (errsv == ENOSYS || errsv == EINVAL)
2824         g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2825                              _("Splice not supported"));
2826       else
2827         g_set_error (error, G_IO_ERROR,
2828                      g_io_error_from_errno (errsv),
2829                      _("Error splicing file: %s"),
2830                      g_strerror (errsv));
2831
2832       return FALSE;
2833     }
2834
2835   *bytes_transferd = result;
2836   return TRUE;
2837 }
2838
2839 static gboolean
2840 splice_stream_with_progress (GInputStream           *in,
2841                              GOutputStream          *out,
2842                              GCancellable           *cancellable,
2843                              GFileProgressCallback   progress_callback,
2844                              gpointer                progress_callback_data,
2845                              GError                **error)
2846 {
2847   int buffer[2] = { -1, -1 };
2848   gboolean res;
2849   goffset total_size;
2850   loff_t offset_in;
2851   loff_t offset_out;
2852   int fd_in, fd_out;
2853
2854   fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
2855   fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
2856
2857   if (!g_unix_open_pipe (buffer, FD_CLOEXEC, error))
2858     return FALSE;
2859
2860   total_size = -1;
2861   /* avoid performance impact of querying total size when it's not needed */
2862   if (progress_callback)
2863     {
2864       struct stat sbuf;
2865
2866       if (fstat (fd_in, &sbuf) == 0)
2867         total_size = sbuf.st_size;
2868     }
2869
2870   if (total_size == -1)
2871     total_size = 0;
2872
2873   offset_in = offset_out = 0;
2874   res = FALSE;
2875   while (TRUE)
2876     {
2877       long n_read;
2878       long n_written;
2879
2880       if (g_cancellable_set_error_if_cancelled (cancellable, error))
2881         break;
2882
2883       if (!do_splice (fd_in, &offset_in, buffer[1], NULL, 1024*64, &n_read, error))
2884         break;
2885
2886       if (n_read == 0)
2887         {
2888           res = TRUE;
2889           break;
2890         }
2891
2892       while (n_read > 0)
2893         {
2894           if (g_cancellable_set_error_if_cancelled (cancellable, error))
2895             goto out;
2896
2897           if (!do_splice (buffer[0], NULL, fd_out, &offset_out, n_read, &n_written, error))
2898             goto out;
2899
2900           n_read -= n_written;
2901         }
2902
2903       if (progress_callback)
2904         progress_callback (offset_in, total_size, progress_callback_data);
2905     }
2906
2907   /* Make sure we send full copied size */
2908   if (progress_callback)
2909     progress_callback (offset_in, total_size, progress_callback_data);
2910
2911   if (!g_close (buffer[0], error))
2912     goto out;
2913   buffer[0] = -1;
2914   if (!g_close (buffer[1], error))
2915     goto out;
2916   buffer[1] = -1;
2917  out:
2918   if (buffer[0] != -1)
2919     (void) g_close (buffer[0], NULL);
2920   if (buffer[1] != -1)
2921     (void) g_close (buffer[1], NULL);
2922
2923   return res;
2924 }
2925 #endif
2926
2927 #ifdef __linux__
2928 static gboolean
2929 btrfs_reflink_with_progress (GInputStream           *in,
2930                              GOutputStream          *out,
2931                              GFileInfo              *info,
2932                              GCancellable           *cancellable,
2933                              GFileProgressCallback   progress_callback,
2934                              gpointer                progress_callback_data,
2935                              GError                **error)
2936 {
2937   goffset source_size;
2938   int fd_in, fd_out;
2939   int ret;
2940
2941   fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
2942   fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
2943
2944   if (progress_callback)
2945     source_size = g_file_info_get_size (info);
2946
2947   /* Btrfs clone ioctl properties:
2948    *  - Works at the inode level
2949    *  - Doesn't work with directories
2950    *  - Always follows symlinks (source and destination)
2951    *
2952    * By the time we get here, *in and *out are both regular files */
2953   ret = ioctl (fd_out, BTRFS_IOC_CLONE, fd_in);
2954
2955   if (ret < 0)
2956     {
2957       if (errno == EXDEV)
2958         g_set_error_literal (error, G_IO_ERROR,
2959                              G_IO_ERROR_NOT_SUPPORTED,
2960                              _("Copy (reflink/clone) between mounts is not supported"));
2961       else if (errno == EINVAL)
2962         g_set_error_literal (error, G_IO_ERROR,
2963                              G_IO_ERROR_NOT_SUPPORTED,
2964                              _("Copy (reflink/clone) is not supported or invalid"));
2965       else
2966         /* Most probably something odd happened; retry with fallback */
2967         g_set_error_literal (error, G_IO_ERROR,
2968                              G_IO_ERROR_NOT_SUPPORTED,
2969                              _("Copy (reflink/clone) is not supported or didn't work"));
2970       /* We retry with fallback for all error cases because Btrfs is currently
2971        * unstable, and so we can't trust it to do clone properly.
2972        * In addition, any hard errors here would cause the same failure in the
2973        * fallback manual copy as well. */
2974       return FALSE;
2975     }
2976
2977   /* Make sure we send full copied size */
2978   if (progress_callback)
2979     progress_callback (source_size, source_size, progress_callback_data);
2980
2981   return TRUE;
2982 }
2983 #endif
2984
2985 static gboolean
2986 file_copy_fallback (GFile                  *source,
2987                     GFile                  *destination,
2988                     GFileCopyFlags          flags,
2989                     GCancellable           *cancellable,
2990                     GFileProgressCallback   progress_callback,
2991                     gpointer                progress_callback_data,
2992                     GError                **error)
2993 {
2994   gboolean ret = FALSE;
2995   GInputStream *in = NULL;
2996   GOutputStream *out = NULL;
2997   GFileInfo *info = NULL;
2998   const char *target;
2999
3000   /* need to know the file type */
3001   info = g_file_query_info (source,
3002                             G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
3003                             G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3004                             cancellable,
3005                             error);
3006   if (!info)
3007     goto out;
3008
3009   /* Maybe copy the symlink? */
3010   if ((flags & G_FILE_COPY_NOFOLLOW_SYMLINKS) &&
3011       g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK)
3012     {
3013       target = g_file_info_get_symlink_target (info);
3014       if (target)
3015         {
3016           if (!copy_symlink (destination, flags, cancellable, target, error))
3017             goto out;
3018
3019           ret = TRUE;
3020           goto out;
3021         }
3022         /* ... else fall back on a regular file copy */
3023     }
3024   /* Handle "special" files (pipes, device nodes, ...)? */
3025   else if (g_file_info_get_file_type (info) == G_FILE_TYPE_SPECIAL)
3026     {
3027       /* FIXME: could try to recreate device nodes and others? */
3028       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3029                            _("Can't copy special file"));
3030       goto out;
3031     }
3032
3033   /* Everything else should just fall back on a regular copy. */
3034
3035   in = open_source_for_copy (source, destination, flags, cancellable, error);
3036   if (!in)
3037     goto out;
3038
3039   if (flags & G_FILE_COPY_OVERWRITE)
3040     {
3041       out = (GOutputStream *)g_file_replace (destination,
3042                                              NULL,
3043                                              flags & G_FILE_COPY_BACKUP,
3044                                              G_FILE_CREATE_REPLACE_DESTINATION,
3045                                              cancellable, error);
3046     }
3047   else
3048     {
3049       out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
3050     }
3051
3052   if (!out)
3053     goto out;
3054
3055 #ifdef __linux__
3056   if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
3057     {
3058       GError *reflink_err = NULL;
3059
3060       if (!btrfs_reflink_with_progress (in, out, info, cancellable,
3061                                         progress_callback, progress_callback_data,
3062                                         &reflink_err))
3063         {
3064           if (g_error_matches (reflink_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
3065             {
3066               g_clear_error (&reflink_err);
3067             }
3068           else
3069             {
3070               g_propagate_error (error, reflink_err);
3071               goto out;
3072             }
3073         }
3074       else
3075         {
3076           ret = TRUE;
3077           goto out;
3078         }
3079     }
3080 #endif
3081
3082 #ifdef HAVE_SPLICE
3083   if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
3084     {
3085       GError *splice_err = NULL;
3086
3087       if (!splice_stream_with_progress (in, out, cancellable,
3088                                         progress_callback, progress_callback_data,
3089                                         &splice_err))
3090         {
3091           if (g_error_matches (splice_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
3092             {
3093               g_clear_error (&splice_err);
3094             }
3095           else
3096             {
3097               g_propagate_error (error, splice_err);
3098               goto out;
3099             }
3100         }
3101       else
3102         {
3103           ret = TRUE;
3104           goto out;
3105         }
3106     }
3107
3108 #endif
3109
3110   /* A plain read/write loop */
3111   if (!copy_stream_with_progress (in, out, source, cancellable,
3112                                   progress_callback, progress_callback_data,
3113                                   error))
3114     goto out;
3115
3116   ret = TRUE;
3117  out:
3118   if (in)
3119     {
3120       /* Don't care about errors in source here */
3121       (void) g_input_stream_close (in, cancellable, NULL);
3122       g_object_unref (in);
3123     }
3124
3125   if (out)
3126     {
3127       /* But write errors on close are bad! */
3128       if (!g_output_stream_close (out, cancellable, ret ? error : NULL))
3129         ret = FALSE;
3130       g_object_unref (out);
3131     }
3132
3133   /* Ignore errors here. Failure to copy metadata is not a hard error */
3134   if (ret)
3135     (void) g_file_copy_attributes (source, destination,
3136                                    flags, cancellable, NULL);
3137
3138
3139   g_clear_object (&info);
3140
3141   return ret;
3142 }
3143
3144 /**
3145  * g_file_copy:
3146  * @source: input #GFile
3147  * @destination: destination #GFile
3148  * @flags: set of #GFileCopyFlags
3149  * @cancellable: (allow-none): optional #GCancellable object,
3150  *     %NULL to ignore
3151  * @progress_callback: (allow-none) (scope call): function to callback with
3152  *     progress information, or %NULL if progress information is not needed
3153  * @progress_callback_data: (closure): user data to pass to @progress_callback
3154  * @error: #GError to set on error, or %NULL
3155  *
3156  * Copies the file @source to the location specified by @destination.
3157  * Can not handle recursive copies of directories.
3158  *
3159  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3160  * existing @destination file is overwritten.
3161  *
3162  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3163  * will be copied as symlinks, otherwise the target of the
3164  * @source symlink will be copied.
3165  *
3166  * If @cancellable is not %NULL, then the operation can be cancelled by
3167  * triggering the cancellable object from another thread. If the operation
3168  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3169  *
3170  * If @progress_callback is not %NULL, then the operation can be monitored
3171  * by setting this to a #GFileProgressCallback function.
3172  * @progress_callback_data will be passed to this function. It is guaranteed
3173  * that this callback will be called after all data has been transferred with
3174  * the total number of bytes copied during the operation.
3175  *
3176  * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3177  * is returned, independent on the status of the @destination.
3178  *
3179  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3180  * the error %G_IO_ERROR_EXISTS is returned.
3181  *
3182  * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3183  * error is returned. If trying to overwrite a directory with a directory the
3184  * %G_IO_ERROR_WOULD_MERGE error is returned.
3185  *
3186  * If the source is a directory and the target does not exist, or
3187  * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3188  * %G_IO_ERROR_WOULD_RECURSE error is returned.
3189  *
3190  * If you are interested in copying the #GFile object itself (not the on-disk
3191  * file), see g_file_dup().
3192  *
3193  * Returns: %TRUE on success, %FALSE otherwise.
3194  */
3195 gboolean
3196 g_file_copy (GFile                  *source,
3197              GFile                  *destination,
3198              GFileCopyFlags          flags,
3199              GCancellable           *cancellable,
3200              GFileProgressCallback   progress_callback,
3201              gpointer                progress_callback_data,
3202              GError                **error)
3203 {
3204   GFileIface *iface;
3205   GError *my_error;
3206   gboolean res;
3207
3208   g_return_val_if_fail (G_IS_FILE (source), FALSE);
3209   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3210
3211   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3212     return FALSE;
3213
3214   iface = G_FILE_GET_IFACE (destination);
3215   if (iface->copy)
3216     {
3217       my_error = NULL;
3218       res = (* iface->copy) (source, destination,
3219                              flags, cancellable,
3220                              progress_callback, progress_callback_data,
3221                              &my_error);
3222
3223       if (res)
3224         return TRUE;
3225
3226       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3227         {
3228           g_propagate_error (error, my_error);
3229               return FALSE;
3230         }
3231       else
3232         g_clear_error (&my_error);
3233     }
3234
3235   /* If the types are different, and the destination method failed
3236    * also try the source method
3237    */
3238   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3239     {
3240       iface = G_FILE_GET_IFACE (source);
3241
3242       if (iface->copy)
3243         {
3244           my_error = NULL;
3245           res = (* iface->copy) (source, destination,
3246                                  flags, cancellable,
3247                                  progress_callback, progress_callback_data,
3248                                  &my_error);
3249
3250           if (res)
3251             return TRUE;
3252
3253           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3254             {
3255               g_propagate_error (error, my_error);
3256               return FALSE;
3257             }
3258           else
3259             g_clear_error (&my_error);
3260         }
3261     }
3262
3263   return file_copy_fallback (source, destination, flags, cancellable,
3264                              progress_callback, progress_callback_data,
3265                              error);
3266 }
3267
3268 /**
3269  * g_file_copy_async: (skip)
3270  * @source: input #GFile
3271  * @destination: destination #GFile
3272  * @flags: set of #GFileCopyFlags
3273  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3274  *     of the request
3275  * @cancellable: (allow-none): optional #GCancellable object,
3276  *     %NULL to ignore
3277  * @progress_callback: (allow-none): function to callback with progress
3278  *     information, or %NULL if progress information is not needed
3279  * @progress_callback_data: (closure): user data to pass to @progress_callback
3280  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3281  * @user_data: the data to pass to callback function
3282  *
3283  * Copies the file @source to the location specified by @destination
3284  * asynchronously. For details of the behaviour, see g_file_copy().
3285  *
3286  * If @progress_callback is not %NULL, then that function that will be called
3287  * just like in g_file_copy(), however the callback will run in the main loop,
3288  * not in the thread that is doing the I/O operation.
3289  *
3290  * When the operation is finished, @callback will be called. You can then call
3291  * g_file_copy_finish() to get the result of the operation.
3292  */
3293 void
3294 g_file_copy_async (GFile                  *source,
3295                    GFile                  *destination,
3296                    GFileCopyFlags          flags,
3297                    int                     io_priority,
3298                    GCancellable           *cancellable,
3299                    GFileProgressCallback   progress_callback,
3300                    gpointer                progress_callback_data,
3301                    GAsyncReadyCallback     callback,
3302                    gpointer                user_data)
3303 {
3304   GFileIface *iface;
3305
3306   g_return_if_fail (G_IS_FILE (source));
3307   g_return_if_fail (G_IS_FILE (destination));
3308
3309   iface = G_FILE_GET_IFACE (source);
3310   (* iface->copy_async) (source,
3311                          destination,
3312                          flags,
3313                          io_priority,
3314                          cancellable,
3315                          progress_callback,
3316                          progress_callback_data,
3317                          callback,
3318                          user_data);
3319 }
3320
3321 /**
3322  * g_file_copy_finish:
3323  * @file: input #GFile
3324  * @res: a #GAsyncResult
3325  * @error: a #GError, or %NULL
3326  *
3327  * Finishes copying the file started with g_file_copy_async().
3328  *
3329  * Returns: a %TRUE on success, %FALSE on error.
3330  */
3331 gboolean
3332 g_file_copy_finish (GFile         *file,
3333                     GAsyncResult  *res,
3334                     GError       **error)
3335 {
3336   GFileIface *iface;
3337
3338   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3339   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
3340
3341   if (g_async_result_legacy_propagate_error (res, error))
3342     return FALSE;
3343
3344   iface = G_FILE_GET_IFACE (file);
3345   return (* iface->copy_finish) (file, res, error);
3346 }
3347
3348 /**
3349  * g_file_move:
3350  * @source: #GFile pointing to the source location
3351  * @destination: #GFile pointing to the destination location
3352  * @flags: set of #GFileCopyFlags
3353  * @cancellable: (allow-none): optional #GCancellable object,
3354  *     %NULL to ignore
3355  * @progress_callback: (allow-none) (scope call): #GFileProgressCallback
3356  *     function for updates
3357  * @progress_callback_data: (closure): gpointer to user data for
3358  *     the callback function
3359  * @error: #GError for returning error conditions, or %NULL
3360  *
3361  * Tries to move the file or directory @source to the location specified
3362  * by @destination. If native move operations are supported then this is
3363  * used, otherwise a copy + delete fallback is used. The native
3364  * implementation may support moving directories (for instance on moves
3365  * inside the same filesystem), but the fallback code does not.
3366  *
3367  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3368  * existing @destination file is overwritten.
3369  *
3370  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3371  * will be copied as symlinks, otherwise the target of the
3372  * @source symlink will be copied.
3373  *
3374  * If @cancellable is not %NULL, then the operation can be cancelled by
3375  * triggering the cancellable object from another thread. If the operation
3376  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3377  *
3378  * If @progress_callback is not %NULL, then the operation can be monitored
3379  * by setting this to a #GFileProgressCallback function.
3380  * @progress_callback_data will be passed to this function. It is
3381  * guaranteed that this callback will be called after all data has been
3382  * transferred with the total number of bytes copied during the operation.
3383  *
3384  * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3385  * error is returned, independent on the status of the @destination.
3386  *
3387  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3388  * then the error %G_IO_ERROR_EXISTS is returned.
3389  *
3390  * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3391  * error is returned. If trying to overwrite a directory with a directory the
3392  * %G_IO_ERROR_WOULD_MERGE error is returned.
3393  *
3394  * If the source is a directory and the target does not exist, or
3395  * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3396  * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3397  * move operation isn't available).
3398  *
3399  * Returns: %TRUE on successful move, %FALSE otherwise.
3400  */
3401 gboolean
3402 g_file_move (GFile                  *source,
3403              GFile                  *destination,
3404              GFileCopyFlags          flags,
3405              GCancellable           *cancellable,
3406              GFileProgressCallback   progress_callback,
3407              gpointer                progress_callback_data,
3408              GError                **error)
3409 {
3410   GFileIface *iface;
3411   GError *my_error;
3412   gboolean res;
3413
3414   g_return_val_if_fail (G_IS_FILE (source), FALSE);
3415   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3416
3417   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3418     return FALSE;
3419
3420   iface = G_FILE_GET_IFACE (destination);
3421   if (iface->move)
3422     {
3423       my_error = NULL;
3424       res = (* iface->move) (source, destination,
3425                              flags, cancellable,
3426                              progress_callback, progress_callback_data,
3427                              &my_error);
3428
3429       if (res)
3430         return TRUE;
3431
3432       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3433         {
3434           g_propagate_error (error, my_error);
3435           return FALSE;
3436         }
3437     }
3438
3439   /* If the types are different, and the destination method failed
3440    * also try the source method
3441    */
3442   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3443     {
3444       iface = G_FILE_GET_IFACE (source);
3445
3446       if (iface->move)
3447         {
3448           my_error = NULL;
3449           res = (* iface->move) (source, destination,
3450                                  flags, cancellable,
3451                                  progress_callback, progress_callback_data,
3452                                  &my_error);
3453
3454           if (res)
3455             return TRUE;
3456
3457           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3458             {
3459               g_propagate_error (error, my_error);
3460               return FALSE;
3461             }
3462         }
3463     }
3464
3465   if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
3466     {
3467       g_set_error_literal (error, G_IO_ERROR,
3468                            G_IO_ERROR_NOT_SUPPORTED,
3469                            _("Operation not supported"));
3470       return FALSE;
3471     }
3472
3473   flags |= G_FILE_COPY_ALL_METADATA;
3474   if (!g_file_copy (source, destination, flags, cancellable,
3475                     progress_callback, progress_callback_data,
3476                     error))
3477     return FALSE;
3478
3479   return g_file_delete (source, cancellable, error);
3480 }
3481
3482 /**
3483  * g_file_make_directory:
3484  * @file: input #GFile
3485  * @cancellable: (allow-none): optional #GCancellable object,
3486  *     %NULL to ignore
3487  * @error: a #GError, or %NULL
3488  *
3489  * Creates a directory. Note that this will only create a child directory
3490  * of the immediate parent directory of the path or URI given by the #GFile.
3491  * To recursively create directories, see g_file_make_directory_with_parents().
3492  * This function will fail if the parent directory does not exist, setting
3493  * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3494  * creating directories, this function will fail, setting @error to
3495  * %G_IO_ERROR_NOT_SUPPORTED.
3496  *
3497  * For a local #GFile the newly created directory will have the default
3498  * (current) ownership and permissions of the current process.
3499  *
3500  * If @cancellable is not %NULL, then the operation can be cancelled by
3501  * triggering the cancellable object from another thread. If the operation
3502  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3503  *
3504  * Returns: %TRUE on successful creation, %FALSE otherwise.
3505  */
3506 gboolean
3507 g_file_make_directory (GFile         *file,
3508                        GCancellable  *cancellable,
3509                        GError       **error)
3510 {
3511   GFileIface *iface;
3512
3513   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3514
3515   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3516     return FALSE;
3517
3518   iface = G_FILE_GET_IFACE (file);
3519
3520   if (iface->make_directory == NULL)
3521     {
3522       g_set_error_literal (error, G_IO_ERROR,
3523                            G_IO_ERROR_NOT_SUPPORTED,
3524                            _("Operation not supported"));
3525       return FALSE;
3526     }
3527
3528   return (* iface->make_directory) (file, cancellable, error);
3529 }
3530
3531 /**
3532  * g_file_make_directory_with_parents:
3533  * @file: input #GFile
3534  * @cancellable: (allow-none): optional #GCancellable object,
3535  *     %NULL to ignore
3536  * @error: a #GError, or %NULL
3537  *
3538  * Creates a directory and any parent directories that may not
3539  * exist similar to 'mkdir -p'. If the file system does not support
3540  * creating directories, this function will fail, setting @error to
3541  * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3542  * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3543  * the similar g_mkdir_with_parents().
3544  *
3545  * For a local #GFile the newly created directories will have the default
3546  * (current) ownership and permissions of the current process.
3547  *
3548  * If @cancellable is not %NULL, then the operation can be cancelled by
3549  * triggering the cancellable object from another thread. If the operation
3550  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3551  *
3552  * Returns: %TRUE if all directories have been successfully created, %FALSE
3553  * otherwise.
3554  *
3555  * Since: 2.18
3556  */
3557 gboolean
3558 g_file_make_directory_with_parents (GFile         *file,
3559                                     GCancellable  *cancellable,
3560                                     GError       **error)
3561 {
3562   GFile *work_file = NULL;
3563   GList *list = NULL, *l;
3564   GError *my_error = NULL;
3565
3566   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3567
3568   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3569     return FALSE;
3570
3571   g_file_make_directory (file, cancellable, &my_error);
3572   if (my_error == NULL || my_error->code != G_IO_ERROR_NOT_FOUND)
3573     {
3574       if (my_error)
3575         g_propagate_error (error, my_error);
3576       return my_error == NULL;
3577     }
3578
3579   work_file = g_object_ref (file);
3580
3581   while (my_error != NULL && my_error->code == G_IO_ERROR_NOT_FOUND)
3582     {
3583       GFile *parent_file;
3584
3585       parent_file = g_file_get_parent (work_file);
3586       if (parent_file == NULL)
3587         break;
3588
3589       g_clear_error (&my_error);
3590       g_file_make_directory (parent_file, cancellable, &my_error);
3591
3592       g_object_unref (work_file);
3593       work_file = g_object_ref (parent_file);
3594
3595       if (my_error != NULL && my_error->code == G_IO_ERROR_NOT_FOUND)
3596         list = g_list_prepend (list, parent_file);  /* Transfer ownership of ref */
3597       else
3598         g_object_unref (parent_file);
3599     }
3600
3601   for (l = list; my_error == NULL && l; l = l->next)
3602     {
3603       g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
3604     }
3605
3606   if (work_file)
3607     g_object_unref (work_file);
3608
3609   /* Clean up */
3610   while (list != NULL)
3611     {
3612       g_object_unref ((GFile *) list->data);
3613       list = g_list_remove (list, list->data);
3614     }
3615
3616   if (my_error != NULL)
3617     {
3618       g_propagate_error (error, my_error);
3619       return FALSE;
3620     }
3621
3622   return g_file_make_directory (file, cancellable, error);
3623 }
3624
3625 /**
3626  * g_file_make_symbolic_link:
3627  * @file: a #GFile with the name of the symlink to create
3628  * @symlink_value: a string with the path for the target of the new symlink
3629  * @cancellable: (allow-none): optional #GCancellable object,
3630  *     %NULL to ignore
3631  * @error: a #GError
3632  *
3633  * Creates a symbolic link named @file which contains the string
3634  * @symlink_value.
3635  *
3636  * If @cancellable is not %NULL, then the operation can be cancelled by
3637  * triggering the cancellable object from another thread. If the operation
3638  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3639  *
3640  * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3641  */
3642 gboolean
3643 g_file_make_symbolic_link (GFile         *file,
3644                            const char    *symlink_value,
3645                            GCancellable  *cancellable,
3646                            GError       **error)
3647 {
3648   GFileIface *iface;
3649
3650   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3651   g_return_val_if_fail (symlink_value != NULL, FALSE);
3652
3653   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3654     return FALSE;
3655
3656   if (*symlink_value == '\0')
3657     {
3658       g_set_error_literal (error, G_IO_ERROR,
3659                            G_IO_ERROR_INVALID_ARGUMENT,
3660                            _("Invalid symlink value given"));
3661       return FALSE;
3662     }
3663
3664   iface = G_FILE_GET_IFACE (file);
3665
3666   if (iface->make_symbolic_link == NULL)
3667     {
3668       g_set_error_literal (error, G_IO_ERROR,
3669                            G_IO_ERROR_NOT_SUPPORTED,
3670                            _("Operation not supported"));
3671       return FALSE;
3672     }
3673
3674   return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
3675 }
3676
3677 /**
3678  * g_file_delete:
3679  * @file: input #GFile
3680  * @cancellable: (allow-none): optional #GCancellable object,
3681  *     %NULL to ignore
3682  * @error: a #GError, or %NULL
3683  *
3684  * Deletes a file. If the @file is a directory, it will only be
3685  * deleted if it is empty. This has the same semantics as g_unlink().
3686  *
3687  * If @cancellable is not %NULL, then the operation can be cancelled by
3688  * triggering the cancellable object from another thread. If the operation
3689  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3690  *
3691  * Virtual: delete_file
3692  * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3693  */
3694 gboolean
3695 g_file_delete (GFile         *file,
3696                GCancellable  *cancellable,
3697                GError       **error)
3698 {
3699   GFileIface *iface;
3700
3701   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3702
3703   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3704     return FALSE;
3705
3706   iface = G_FILE_GET_IFACE (file);
3707
3708   if (iface->delete_file == NULL)
3709     {
3710       g_set_error_literal (error, G_IO_ERROR,
3711                            G_IO_ERROR_NOT_SUPPORTED,
3712                            _("Operation not supported"));
3713       return FALSE;
3714     }
3715
3716   return (* iface->delete_file) (file, cancellable, error);
3717 }
3718
3719 /**
3720  * g_file_delete_async:
3721  * @file: input #GFile
3722  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3723  *     of the request
3724  * @cancellable: (allow-none): optional #GCancellable object,
3725  *     %NULL to ignore
3726  * @callback: a #GAsyncReadyCallback to call
3727  *     when the request is satisfied
3728  * @user_data: the data to pass to callback function
3729  *
3730  * Asynchronously delete a file. If the @file is a directory, it will
3731  * only be deleted if it is empty.  This has the same semantics as
3732  * g_unlink().
3733  *
3734  * Virtual: delete_file_async
3735  * Since: 2.34
3736  */
3737 void
3738 g_file_delete_async (GFile               *file,
3739                      int                  io_priority,
3740                      GCancellable        *cancellable,
3741                      GAsyncReadyCallback  callback,
3742                      gpointer             user_data)
3743 {
3744   GFileIface *iface;
3745
3746   g_return_if_fail (G_IS_FILE (file));
3747
3748   iface = G_FILE_GET_IFACE (file);
3749   (* iface->delete_file_async) (file,
3750                                 io_priority,
3751                                 cancellable,
3752                                 callback,
3753                                 user_data);
3754 }
3755
3756 /**
3757  * g_file_delete_finish:
3758  * @file: input #GFile
3759  * @result: a #GAsyncResult
3760  * @error: a #GError, or %NULL
3761  *
3762  * Finishes deleting a file started with g_file_delete_async().
3763  *
3764  * Virtual: delete_file_finish
3765  * Since: 2.34
3766  **/
3767 gboolean
3768 g_file_delete_finish (GFile         *file,
3769                       GAsyncResult  *result,
3770                       GError       **error)
3771 {
3772   GFileIface *iface;
3773
3774   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3775   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3776
3777   if (g_async_result_legacy_propagate_error (result, error))
3778     return FALSE;
3779
3780   iface = G_FILE_GET_IFACE (file);
3781   return (* iface->delete_file_finish) (file, result, error);
3782 }
3783
3784 /**
3785  * g_file_trash:
3786  * @file: #GFile to send to trash
3787  * @cancellable: (allow-none): optional #GCancellable object,
3788  *     %NULL to ignore
3789  * @error: a #GError, or %NULL
3790  *
3791  * Sends @file to the "Trashcan", if possible. This is similar to
3792  * deleting it, but the user can recover it before emptying the trashcan.
3793  * Not all file systems support trashing, so this call can return the
3794  * %G_IO_ERROR_NOT_SUPPORTED error.
3795  *
3796  * If @cancellable is not %NULL, then the operation can be cancelled by
3797  * triggering the cancellable object from another thread. If the operation
3798  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3799  *
3800  * Returns: %TRUE on successful trash, %FALSE otherwise.
3801  */
3802 gboolean
3803 g_file_trash (GFile         *file,
3804               GCancellable  *cancellable,
3805               GError       **error)
3806 {
3807   GFileIface *iface;
3808
3809   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3810
3811   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3812     return FALSE;
3813
3814   iface = G_FILE_GET_IFACE (file);
3815
3816   if (iface->trash == NULL)
3817     {
3818       g_set_error_literal (error,
3819                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3820                            _("Trash not supported"));
3821       return FALSE;
3822     }
3823
3824   return (* iface->trash) (file, cancellable, error);
3825 }
3826
3827 /**
3828  * g_file_set_display_name:
3829  * @file: input #GFile
3830  * @display_name: a string
3831  * @cancellable: (allow-none): optional #GCancellable object,
3832  *     %NULL to ignore
3833  * @error: a #GError, or %NULL
3834  *
3835  * Renames @file to the specified display name.
3836  *
3837  * The display name is converted from UTF-8 to the correct encoding
3838  * for the target filesystem if possible and the @file is renamed to this.
3839  *
3840  * If you want to implement a rename operation in the user interface the
3841  * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
3842  * initial value in the rename widget, and then the result after editing
3843  * should be passed to g_file_set_display_name().
3844  *
3845  * On success the resulting converted filename is returned.
3846  *
3847  * If @cancellable is not %NULL, then the operation can be cancelled by
3848  * triggering the cancellable object from another thread. If the operation
3849  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3850  *
3851  * Returns: (transfer full): a #GFile specifying what @file was renamed to,
3852  *     or %NULL if there was an error.
3853  *     Free the returned object with g_object_unref().
3854  */
3855 GFile *
3856 g_file_set_display_name (GFile         *file,
3857                          const gchar   *display_name,
3858                          GCancellable  *cancellable,
3859                          GError       **error)
3860 {
3861   GFileIface *iface;
3862
3863   g_return_val_if_fail (G_IS_FILE (file), NULL);
3864   g_return_val_if_fail (display_name != NULL, NULL);
3865
3866   if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
3867     {
3868       g_set_error (error,
3869                    G_IO_ERROR,
3870                    G_IO_ERROR_INVALID_ARGUMENT,
3871                    _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
3872       return NULL;
3873     }
3874
3875   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3876     return NULL;
3877
3878   iface = G_FILE_GET_IFACE (file);
3879
3880   return (* iface->set_display_name) (file, display_name, cancellable, error);
3881 }
3882
3883 /**
3884  * g_file_set_display_name_async:
3885  * @file: input #GFile
3886  * @display_name: a string
3887  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3888  *     of the request
3889  * @cancellable: (allow-none): optional #GCancellable object,
3890  *     %NULL to ignore
3891  * @callback: (scope async): a #GAsyncReadyCallback to call
3892  *     when the request is satisfied
3893  * @user_data: (closure): the data to pass to callback function
3894  *
3895  * Asynchronously sets the display name for a given #GFile.
3896  *
3897  * For more details, see g_file_set_display_name() which is
3898  * the synchronous version of this call.
3899  *
3900  * When the operation is finished, @callback will be called.
3901  * You can then call g_file_set_display_name_finish() to get
3902  * the result of the operation.
3903  */
3904 void
3905 g_file_set_display_name_async (GFile               *file,
3906                                const gchar         *display_name,
3907                                gint                 io_priority,
3908                                GCancellable        *cancellable,
3909                                GAsyncReadyCallback  callback,
3910                                gpointer             user_data)
3911 {
3912   GFileIface *iface;
3913
3914   g_return_if_fail (G_IS_FILE (file));
3915   g_return_if_fail (display_name != NULL);
3916
3917   iface = G_FILE_GET_IFACE (file);
3918   (* iface->set_display_name_async) (file,
3919                                      display_name,
3920                                      io_priority,
3921                                      cancellable,
3922                                      callback,
3923                                      user_data);
3924 }
3925
3926 /**
3927  * g_file_set_display_name_finish:
3928  * @file: input #GFile
3929  * @res: a #GAsyncResult
3930  * @error: a #GError, or %NULL
3931  *
3932  * Finishes setting a display name started with
3933  * g_file_set_display_name_async().
3934  *
3935  * Returns: (transfer full): a #GFile or %NULL on error.
3936  *     Free the returned object with g_object_unref().
3937  */
3938 GFile *
3939 g_file_set_display_name_finish (GFile         *file,
3940                                 GAsyncResult  *res,
3941                                 GError       **error)
3942 {
3943   GFileIface *iface;
3944
3945   g_return_val_if_fail (G_IS_FILE (file), NULL);
3946   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3947
3948   if (g_async_result_legacy_propagate_error (res, error))
3949     return NULL;
3950
3951   iface = G_FILE_GET_IFACE (file);
3952   return (* iface->set_display_name_finish) (file, res, error);
3953 }
3954
3955 /**
3956  * g_file_query_settable_attributes:
3957  * @file: input #GFile
3958  * @cancellable: (allow-none): optional #GCancellable object,
3959  *     %NULL to ignore
3960  * @error: a #GError, or %NULL
3961  *
3962  * Obtain the list of settable attributes for the file.
3963  *
3964  * Returns the type and full attribute name of all the attributes
3965  * that can be set on this file. This doesn't mean setting it will
3966  * always succeed though, you might get an access failure, or some
3967  * specific file may not support a specific attribute.
3968  *
3969  * If @cancellable is not %NULL, then the operation can be cancelled by
3970  * triggering the cancellable object from another thread. If the operation
3971  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3972  *
3973  * Returns: a #GFileAttributeInfoList describing the settable attributes.
3974  *     When you are done with it, release it with
3975  *     g_file_attribute_info_list_unref()
3976  */
3977 GFileAttributeInfoList *
3978 g_file_query_settable_attributes (GFile         *file,
3979                                   GCancellable  *cancellable,
3980                                   GError       **error)
3981 {
3982   GFileIface *iface;
3983   GError *my_error;
3984   GFileAttributeInfoList *list;
3985
3986   g_return_val_if_fail (G_IS_FILE (file), NULL);
3987
3988   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3989     return NULL;
3990
3991   iface = G_FILE_GET_IFACE (file);
3992
3993   if (iface->query_settable_attributes == NULL)
3994     return g_file_attribute_info_list_new ();
3995
3996   my_error = NULL;
3997   list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3998
3999   if (list == NULL)
4000     {
4001       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
4002         {
4003           list = g_file_attribute_info_list_new ();
4004           g_error_free (my_error);
4005         }
4006       else
4007         g_propagate_error (error, my_error);
4008     }
4009
4010   return list;
4011 }
4012
4013 /**
4014  * g_file_query_writable_namespaces:
4015  * @file: input #GFile
4016  * @cancellable: (allow-none): optional #GCancellable object,
4017  *     %NULL to ignore
4018  * @error: a #GError, or %NULL
4019  *
4020  * Obtain the list of attribute namespaces where new attributes
4021  * can be created by a user. An example of this is extended
4022  * attributes (in the "xattr" namespace).
4023  *
4024  * If @cancellable is not %NULL, then the operation can be cancelled by
4025  * triggering the cancellable object from another thread. If the operation
4026  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4027  *
4028  * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4029  *     When you are done with it, release it with
4030  *     g_file_attribute_info_list_unref()
4031  */
4032 GFileAttributeInfoList *
4033 g_file_query_writable_namespaces (GFile         *file,
4034                                   GCancellable  *cancellable,
4035                                   GError       **error)
4036 {
4037   GFileIface *iface;
4038   GError *my_error;
4039   GFileAttributeInfoList *list;
4040
4041   g_return_val_if_fail (G_IS_FILE (file), NULL);
4042
4043   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4044     return NULL;
4045
4046   iface = G_FILE_GET_IFACE (file);
4047
4048   if (iface->query_writable_namespaces == NULL)
4049     return g_file_attribute_info_list_new ();
4050
4051   my_error = NULL;
4052   list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
4053
4054   if (list == NULL)
4055     {
4056       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
4057         {
4058           list = g_file_attribute_info_list_new ();
4059           g_error_free (my_error);
4060         }
4061       else
4062         g_propagate_error (error, my_error);
4063     }
4064
4065   return list;
4066 }
4067
4068 /**
4069  * g_file_set_attribute:
4070  * @file: input #GFile
4071  * @attribute: a string containing the attribute's name
4072  * @type: The type of the attribute
4073  * @value_p: (allow-none): a pointer to the value (or the pointer
4074  *     itself if the type is a pointer type)
4075  * @flags: a set of #GFileQueryInfoFlags
4076  * @cancellable: (allow-none): optional #GCancellable object,
4077  *     %NULL to ignore
4078  * @error: a #GError, or %NULL
4079  *
4080  * Sets an attribute in the file with attribute name @attribute to @value.
4081  *
4082  * Some attributes can be unset by setting @attribute to
4083  * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4084  *
4085  * If @cancellable is not %NULL, then the operation can be cancelled by
4086  * triggering the cancellable object from another thread. If the operation
4087  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4088  *
4089  * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4090  */
4091 gboolean
4092 g_file_set_attribute (GFile                *file,
4093                       const gchar          *attribute,
4094                       GFileAttributeType    type,
4095                       gpointer              value_p,
4096                       GFileQueryInfoFlags   flags,
4097                       GCancellable         *cancellable,
4098                       GError              **error)
4099 {
4100   GFileIface *iface;
4101
4102   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4103   g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
4104
4105   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4106     return FALSE;
4107
4108   iface = G_FILE_GET_IFACE (file);
4109
4110   if (iface->set_attribute == NULL)
4111     {
4112       g_set_error_literal (error, G_IO_ERROR,
4113                            G_IO_ERROR_NOT_SUPPORTED,
4114                            _("Operation not supported"));
4115       return FALSE;
4116     }
4117
4118   return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
4119 }
4120
4121 /**
4122  * g_file_set_attributes_from_info:
4123  * @file: input #GFile
4124  * @info: a #GFileInfo
4125  * @flags: #GFileQueryInfoFlags
4126  * @cancellable: (allow-none): optional #GCancellable object,
4127  *     %NULL to ignore
4128  * @error: a #GError, or %NULL
4129  *
4130  * Tries to set all attributes in the #GFileInfo on the target
4131  * values, not stopping on the first error.
4132  *
4133  * If there is any error during this operation then @error will
4134  * be set to the first error. Error on particular fields are flagged
4135  * by setting the "status" field in the attribute value to
4136  * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4137  * also detect further errors.
4138  *
4139  * If @cancellable is not %NULL, then the operation can be cancelled by
4140  * triggering the cancellable object from another thread. If the operation
4141  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4142  *
4143  * Returns: %FALSE if there was any error, %TRUE otherwise.
4144  */
4145 gboolean
4146 g_file_set_attributes_from_info (GFile                *file,
4147                                  GFileInfo            *info,
4148                                  GFileQueryInfoFlags   flags,
4149                                  GCancellable         *cancellable,
4150                                  GError              **error)
4151 {
4152   GFileIface *iface;
4153
4154   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4155   g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
4156
4157   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4158     return FALSE;
4159
4160   g_file_info_clear_status (info);
4161
4162   iface = G_FILE_GET_IFACE (file);
4163
4164   return (* iface->set_attributes_from_info) (file,
4165                                               info,
4166                                               flags,
4167                                               cancellable,
4168                                               error);
4169 }
4170
4171 static gboolean
4172 g_file_real_set_attributes_from_info (GFile                *file,
4173                                       GFileInfo            *info,
4174                                       GFileQueryInfoFlags   flags,
4175                                       GCancellable         *cancellable,
4176                                       GError              **error)
4177 {
4178   char **attributes;
4179   int i;
4180   gboolean res;
4181   GFileAttributeValue *value;
4182
4183   res = TRUE;
4184
4185   attributes = g_file_info_list_attributes (info, NULL);
4186
4187   for (i = 0; attributes[i] != NULL; i++)
4188     {
4189       value = _g_file_info_get_attribute_value (info, attributes[i]);
4190
4191       if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
4192         continue;
4193
4194       if (!g_file_set_attribute (file, attributes[i],
4195                                  value->type, _g_file_attribute_value_peek_as_pointer (value),
4196                                  flags, cancellable, error))
4197         {
4198           value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
4199           res = FALSE;
4200           /* Don't set error multiple times */
4201           error = NULL;
4202         }
4203       else
4204         value->status = G_FILE_ATTRIBUTE_STATUS_SET;
4205     }
4206
4207   g_strfreev (attributes);
4208
4209   return res;
4210 }
4211
4212 /**
4213  * g_file_set_attributes_async:
4214  * @file: input #GFile
4215  * @info: a #GFileInfo
4216  * @flags: a #GFileQueryInfoFlags
4217  * @io_priority: the <link linkend="io-priority">I/O priority</link>
4218  *     of the request
4219  * @cancellable: (allow-none): optional #GCancellable object,
4220  *     %NULL to ignore
4221  * @callback: (scope async): a #GAsyncReadyCallback
4222  * @user_data: (closure): a #gpointer
4223  *
4224  * Asynchronously sets the attributes of @file with @info.
4225  *
4226  * For more details, see g_file_set_attributes_from_info(),
4227  * which is the synchronous version of this call.
4228  *
4229  * When the operation is finished, @callback will be called.
4230  * You can then call g_file_set_attributes_finish() to get
4231  * the result of the operation.
4232  */
4233 void
4234 g_file_set_attributes_async (GFile               *file,
4235                              GFileInfo           *info,
4236                              GFileQueryInfoFlags  flags,
4237                              int                  io_priority,
4238                              GCancellable        *cancellable,
4239                              GAsyncReadyCallback  callback,
4240                              gpointer             user_data)
4241 {
4242   GFileIface *iface;
4243
4244   g_return_if_fail (G_IS_FILE (file));
4245   g_return_if_fail (G_IS_FILE_INFO (info));
4246
4247   iface = G_FILE_GET_IFACE (file);
4248   (* iface->set_attributes_async) (file,
4249                                    info,
4250                                    flags,
4251                                    io_priority,
4252                                    cancellable,
4253                                    callback,
4254                                    user_data);
4255 }
4256
4257 /**
4258  * g_file_set_attributes_finish:
4259  * @file: input #GFile
4260  * @result: a #GAsyncResult
4261  * @info: (out) (transfer full): a #GFileInfo
4262  * @error: a #GError, or %NULL
4263  *
4264  * Finishes setting an attribute started in g_file_set_attributes_async().
4265  *
4266  * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4267  */
4268 gboolean
4269 g_file_set_attributes_finish (GFile         *file,
4270                               GAsyncResult  *result,
4271                               GFileInfo    **info,
4272                               GError       **error)
4273 {
4274   GFileIface *iface;
4275
4276   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4277   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4278
4279   /* No standard handling of errors here, as we must set info even
4280    * on errors
4281    */
4282   iface = G_FILE_GET_IFACE (file);
4283   return (* iface->set_attributes_finish) (file, result, info, error);
4284 }
4285
4286 /**
4287  * g_file_set_attribute_string:
4288  * @file: input #GFile
4289  * @attribute: a string containing the attribute's name
4290  * @value: a string containing the attribute's value
4291  * @flags: #GFileQueryInfoFlags
4292  * @cancellable: (allow-none): optional #GCancellable object,
4293  *     %NULL to ignore
4294  * @error: a #GError, or %NULL
4295  *
4296  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4297  * If @attribute is of a different type, this operation will fail.
4298  *
4299  * If @cancellable is not %NULL, then the operation can be cancelled by
4300  * triggering the cancellable object from another thread. If the operation
4301  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4302  *
4303  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4304  */
4305 gboolean
4306 g_file_set_attribute_string (GFile                *file,
4307                              const char           *attribute,
4308                              const char           *value,
4309                              GFileQueryInfoFlags   flags,
4310                              GCancellable         *cancellable,
4311                              GError              **error)
4312 {
4313   return g_file_set_attribute (file, attribute,
4314                                G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
4315                                flags, cancellable, error);
4316 }
4317
4318 /**
4319  * g_file_set_attribute_byte_string:
4320  * @file: input #GFile
4321  * @attribute: a string containing the attribute's name
4322  * @value: a string containing the attribute's new value
4323  * @flags: a #GFileQueryInfoFlags
4324  * @cancellable: (allow-none): optional #GCancellable object,
4325  *     %NULL to ignore
4326  * @error: a #GError, or %NULL
4327  *
4328  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4329  * If @attribute is of a different type, this operation will fail,
4330  * returning %FALSE.
4331  *
4332  * If @cancellable is not %NULL, then the operation can be cancelled by
4333  * triggering the cancellable object from another thread. If the operation
4334  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4335  *
4336  * Returns: %TRUE if the @attribute was successfully set to @value
4337  *     in the @file, %FALSE otherwise.
4338  */
4339 gboolean
4340 g_file_set_attribute_byte_string  (GFile                *file,
4341                                    const gchar          *attribute,
4342                                    const gchar          *value,
4343                                    GFileQueryInfoFlags   flags,
4344                                    GCancellable         *cancellable,
4345                                    GError              **error)
4346 {
4347   return g_file_set_attribute (file, attribute,
4348                                G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
4349                                flags, cancellable, error);
4350 }
4351
4352 /**
4353  * g_file_set_attribute_uint32:
4354  * @file: input #GFile
4355  * @attribute: a string containing the attribute's name
4356  * @value: a #guint32 containing the attribute's new value
4357  * @flags: a #GFileQueryInfoFlags
4358  * @cancellable: (allow-none): optional #GCancellable object,
4359  *     %NULL to ignore
4360  * @error: a #GError, or %NULL
4361  *
4362  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4363  * If @attribute is of a different type, this operation will fail.
4364  *
4365  * If @cancellable is not %NULL, then the operation can be cancelled by
4366  * triggering the cancellable object from another thread. If the operation
4367  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4368  *
4369  * Returns: %TRUE if the @attribute was successfully set to @value
4370  *     in the @file, %FALSE otherwise.
4371  */
4372 gboolean
4373 g_file_set_attribute_uint32 (GFile                *file,
4374                              const gchar          *attribute,
4375                              guint32               value,
4376                              GFileQueryInfoFlags   flags,
4377                              GCancellable         *cancellable,
4378                              GError              **error)
4379 {
4380   return g_file_set_attribute (file, attribute,
4381                                G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
4382                                flags, cancellable, error);
4383 }
4384
4385 /**
4386  * g_file_set_attribute_int32:
4387  * @file: input #GFile
4388  * @attribute: a string containing the attribute's name
4389  * @value: a #gint32 containing the attribute's new value
4390  * @flags: a #GFileQueryInfoFlags
4391  * @cancellable: (allow-none): optional #GCancellable object,
4392  *     %NULL to ignore
4393  * @error: a #GError, or %NULL
4394  *
4395  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4396  * If @attribute is of a different type, this operation will fail.
4397  *
4398  * If @cancellable is not %NULL, then the operation can be cancelled by
4399  * triggering the cancellable object from another thread. If the operation
4400  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4401  *
4402  * Returns: %TRUE if the @attribute was successfully set to @value
4403  *     in the @file, %FALSE otherwise.
4404  */
4405 gboolean
4406 g_file_set_attribute_int32 (GFile                *file,
4407                             const gchar          *attribute,
4408                             gint32                value,
4409                             GFileQueryInfoFlags   flags,
4410                             GCancellable         *cancellable,
4411                             GError              **error)
4412 {
4413   return g_file_set_attribute (file, attribute,
4414                                G_FILE_ATTRIBUTE_TYPE_INT32, &value,
4415                                flags, cancellable, error);
4416 }
4417
4418 /**
4419  * g_file_set_attribute_uint64:
4420  * @file: input #GFile
4421  * @attribute: a string containing the attribute's name
4422  * @value: a #guint64 containing the attribute's new value
4423  * @flags: a #GFileQueryInfoFlags
4424  * @cancellable: (allow-none): optional #GCancellable object,
4425  *     %NULL to ignore
4426  * @error: a #GError, or %NULL
4427  *
4428  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4429  * If @attribute is of a different type, this operation will fail.
4430  *
4431  * If @cancellable is not %NULL, then the operation can be cancelled by
4432  * triggering the cancellable object from another thread. If the operation
4433  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4434  *
4435  * Returns: %TRUE if the @attribute was successfully set to @value
4436  *     in the @file, %FALSE otherwise.
4437  */
4438 gboolean
4439 g_file_set_attribute_uint64 (GFile                *file,
4440                              const gchar          *attribute,
4441                              guint64               value,
4442                              GFileQueryInfoFlags   flags,
4443                              GCancellable         *cancellable,
4444                              GError              **error)
4445  {
4446   return g_file_set_attribute (file, attribute,
4447                                G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
4448                                flags, cancellable, error);
4449 }
4450
4451 /**
4452  * g_file_set_attribute_int64:
4453  * @file: input #GFile
4454  * @attribute: a string containing the attribute's name
4455  * @value: a #guint64 containing the attribute's new value
4456  * @flags: a #GFileQueryInfoFlags
4457  * @cancellable: (allow-none): optional #GCancellable object,
4458  *     %NULL to ignore
4459  * @error: a #GError, or %NULL
4460  *
4461  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4462  * If @attribute is of a different type, this operation will fail.
4463  *
4464  * If @cancellable is not %NULL, then the operation can be cancelled by
4465  * triggering the cancellable object from another thread. If the operation
4466  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4467  *
4468  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4469  */
4470 gboolean
4471 g_file_set_attribute_int64 (GFile                *file,
4472                             const gchar          *attribute,
4473                             gint64                value,
4474                             GFileQueryInfoFlags   flags,
4475                             GCancellable         *cancellable,
4476                             GError              **error)
4477 {
4478   return g_file_set_attribute (file, attribute,
4479                                G_FILE_ATTRIBUTE_TYPE_INT64, &value,
4480                                flags, cancellable, error);
4481 }
4482
4483 /**
4484  * g_file_mount_mountable:
4485  * @file: input #GFile
4486  * @flags: flags affecting the operation
4487  * @mount_operation: (allow-none): a #GMountOperation,
4488  *     or %NULL to avoid user interaction
4489  * @cancellable: (allow-none): optional #GCancellable object,
4490  *     %NULL to ignore
4491  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4492  *     when the request is satisfied, or %NULL
4493  * @user_data: (closure): the data to pass to callback function
4494  *
4495  * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4496  * Using @mount_operation, you can request callbacks when, for instance,
4497  * passwords are needed during authentication.
4498  *
4499  * If @cancellable is not %NULL, then the operation can be cancelled by
4500  * triggering the cancellable object from another thread. If the operation
4501  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4502  *
4503  * When the operation is finished, @callback will be called.
4504  * You can then call g_file_mount_mountable_finish() to get
4505  * the result of the operation.
4506  */
4507 void
4508 g_file_mount_mountable (GFile               *file,
4509                         GMountMountFlags     flags,
4510                         GMountOperation     *mount_operation,
4511                         GCancellable        *cancellable,
4512                         GAsyncReadyCallback  callback,
4513                         gpointer             user_data)
4514 {
4515   GFileIface *iface;
4516
4517   g_return_if_fail (G_IS_FILE (file));
4518
4519   iface = G_FILE_GET_IFACE (file);
4520
4521   if (iface->mount_mountable == NULL)
4522     {
4523       g_task_report_new_error (file, callback, user_data,
4524                                g_file_mount_mountable,
4525                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4526                                _("Operation not supported"));
4527       return;
4528     }
4529
4530   (* iface->mount_mountable) (file,
4531                               flags,
4532                               mount_operation,
4533                               cancellable,
4534                               callback,
4535                               user_data);
4536 }
4537
4538 /**
4539  * g_file_mount_mountable_finish:
4540  * @file: input #GFile
4541  * @result: a #GAsyncResult
4542  * @error: a #GError, or %NULL
4543  *
4544  * Finishes a mount operation. See g_file_mount_mountable() for details.
4545  *
4546  * Finish an asynchronous mount operation that was started
4547  * with g_file_mount_mountable().
4548  *
4549  * Returns: (transfer full): a #GFile or %NULL on error.
4550  *     Free the returned object with g_object_unref().
4551  */
4552 GFile *
4553 g_file_mount_mountable_finish (GFile         *file,
4554                                GAsyncResult  *result,
4555                                GError       **error)
4556 {
4557   GFileIface *iface;
4558
4559   g_return_val_if_fail (G_IS_FILE (file), NULL);
4560   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
4561
4562   if (g_async_result_legacy_propagate_error (result, error))
4563     return NULL;
4564   else if (g_async_result_is_tagged (result, g_file_mount_mountable))
4565     return g_task_propagate_pointer (G_TASK (result), error);
4566
4567   iface = G_FILE_GET_IFACE (file);
4568   return (* iface->mount_mountable_finish) (file, result, error);
4569 }
4570
4571 /**
4572  * g_file_unmount_mountable:
4573  * @file: input #GFile
4574  * @flags: flags affecting the operation
4575  * @cancellable: (allow-none): optional #GCancellable object,
4576  *     %NULL to ignore
4577  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4578  *     when the request is satisfied, or %NULL
4579  * @user_data: (closure): the data to pass to callback function
4580  *
4581  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4582  *
4583  * If @cancellable is not %NULL, then the operation can be cancelled by
4584  * triggering the cancellable object from another thread. If the operation
4585  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4586  *
4587  * When the operation is finished, @callback will be called.
4588  * You can then call g_file_unmount_mountable_finish() to get
4589  * the result of the operation.
4590  *
4591  * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4592  */
4593 void
4594 g_file_unmount_mountable (GFile               *file,
4595                           GMountUnmountFlags   flags,
4596                           GCancellable        *cancellable,
4597                           GAsyncReadyCallback  callback,
4598                           gpointer             user_data)
4599 {
4600   GFileIface *iface;
4601
4602   g_return_if_fail (G_IS_FILE (file));
4603
4604   iface = G_FILE_GET_IFACE (file);
4605
4606   if (iface->unmount_mountable == NULL)
4607     {
4608       g_task_report_new_error (file, callback, user_data,
4609                                g_file_unmount_mountable_with_operation,
4610                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4611                                _("Operation not supported"));
4612       return;
4613     }
4614
4615   (* iface->unmount_mountable) (file,
4616                                 flags,
4617                                 cancellable,
4618                                 callback,
4619                                 user_data);
4620 }
4621
4622 /**
4623  * g_file_unmount_mountable_finish:
4624  * @file: input #GFile
4625  * @result: a #GAsyncResult
4626  * @error: a #GError, or %NULL
4627  *
4628  * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4629  *
4630  * Finish an asynchronous unmount operation that was started
4631  * with g_file_unmount_mountable().
4632  *
4633  * Returns: %TRUE if the operation finished successfully.
4634  *     %FALSE otherwise.
4635  *
4636  * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
4637  *     instead.
4638  */
4639 gboolean
4640 g_file_unmount_mountable_finish (GFile         *file,
4641                                  GAsyncResult  *result,
4642                                  GError       **error)
4643 {
4644   GFileIface *iface;
4645
4646   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4647   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4648
4649   if (g_async_result_legacy_propagate_error (result, error))
4650     return FALSE;
4651   else if (g_async_result_is_tagged (result, g_file_unmount_mountable_with_operation))
4652     return g_task_propagate_boolean (G_TASK (result), error);
4653
4654   iface = G_FILE_GET_IFACE (file);
4655   return (* iface->unmount_mountable_finish) (file, result, error);
4656 }
4657
4658 /**
4659  * g_file_unmount_mountable_with_operation:
4660  * @file: input #GFile
4661  * @flags: flags affecting the operation
4662  * @mount_operation: (allow-none): a #GMountOperation,
4663  *     or %NULL to avoid user interaction
4664  * @cancellable: (allow-none): optional #GCancellable object,
4665  *     %NULL to ignore
4666  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4667  *     when the request is satisfied, or %NULL
4668  * @user_data: (closure): the data to pass to callback function
4669  *
4670  * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
4671  *
4672  * If @cancellable is not %NULL, then the operation can be cancelled by
4673  * triggering the cancellable object from another thread. If the operation
4674  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4675  *
4676  * When the operation is finished, @callback will be called.
4677  * You can then call g_file_unmount_mountable_finish() to get
4678  * the result of the operation.
4679  *
4680  * Since: 2.22
4681  */
4682 void
4683 g_file_unmount_mountable_with_operation (GFile               *file,
4684                                          GMountUnmountFlags   flags,
4685                                          GMountOperation     *mount_operation,
4686                                          GCancellable        *cancellable,
4687                                          GAsyncReadyCallback  callback,
4688                                          gpointer             user_data)
4689 {
4690   GFileIface *iface;
4691
4692   g_return_if_fail (G_IS_FILE (file));
4693
4694   iface = G_FILE_GET_IFACE (file);
4695
4696   if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL)
4697     {
4698       g_task_report_new_error (file, callback, user_data,
4699                                g_file_unmount_mountable_with_operation,
4700                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4701                                _("Operation not supported"));
4702       return;
4703     }
4704
4705   if (iface->unmount_mountable_with_operation != NULL)
4706     (* iface->unmount_mountable_with_operation) (file,
4707                                                  flags,
4708                                                  mount_operation,
4709                                                  cancellable,
4710                                                  callback,
4711                                                  user_data);
4712   else
4713     (* iface->unmount_mountable) (file,
4714                                   flags,
4715                                   cancellable,
4716                                   callback,
4717                                   user_data);
4718 }
4719
4720 /**
4721  * g_file_unmount_mountable_with_operation_finish:
4722  * @file: input #GFile
4723  * @result: a #GAsyncResult
4724  * @error: a #GError, or %NULL
4725  *
4726  * Finishes an unmount operation,
4727  * see g_file_unmount_mountable_with_operation() for details.
4728  *
4729  * Finish an asynchronous unmount operation that was started
4730  * with g_file_unmount_mountable_with_operation().
4731  *
4732  * Returns: %TRUE if the operation finished successfully.
4733  *     %FALSE otherwise.
4734  *
4735  * Since: 2.22
4736  */
4737 gboolean
4738 g_file_unmount_mountable_with_operation_finish (GFile         *file,
4739                                                 GAsyncResult  *result,
4740                                                 GError       **error)
4741 {
4742   GFileIface *iface;
4743
4744   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4745   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4746
4747   if (g_async_result_legacy_propagate_error (result, error))
4748     return FALSE;
4749   else if (g_async_result_is_tagged (result, g_file_unmount_mountable_with_operation))
4750     return g_task_propagate_boolean (G_TASK (result), error);
4751
4752   iface = G_FILE_GET_IFACE (file);
4753   if (iface->unmount_mountable_with_operation_finish != NULL)
4754     return (* iface->unmount_mountable_with_operation_finish) (file, result, error);
4755   else
4756     return (* iface->unmount_mountable_finish) (file, result, error);
4757 }
4758
4759 /**
4760  * g_file_eject_mountable:
4761  * @file: input #GFile
4762  * @flags: flags affecting the operation
4763  * @cancellable: (allow-none): optional #GCancellable object,
4764  *     %NULL to ignore
4765  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4766  *     when the request is satisfied, or %NULL
4767  * @user_data: (closure): the data to pass to callback function
4768  *
4769  * Starts an asynchronous eject on a mountable.
4770  * When this operation has completed, @callback will be called with
4771  * @user_user data, and the operation can be finalized with
4772  * g_file_eject_mountable_finish().
4773  *
4774  * If @cancellable is not %NULL, then the operation can be cancelled by
4775  * triggering the cancellable object from another thread. If the operation
4776  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4777  *
4778  * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
4779  */
4780 void
4781 g_file_eject_mountable (GFile               *file,
4782                         GMountUnmountFlags   flags,
4783                         GCancellable        *cancellable,
4784                         GAsyncReadyCallback  callback,
4785                         gpointer             user_data)
4786 {
4787   GFileIface *iface;
4788
4789   g_return_if_fail (G_IS_FILE (file));
4790
4791   iface = G_FILE_GET_IFACE (file);
4792
4793   if (iface->eject_mountable == NULL)
4794     {
4795       g_task_report_new_error (file, callback, user_data,
4796                                g_file_eject_mountable_with_operation,
4797                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4798                                _("Operation not supported"));
4799       return;
4800     }
4801
4802   (* iface->eject_mountable) (file,
4803                               flags,
4804                               cancellable,
4805                               callback,
4806                               user_data);
4807 }
4808
4809 /**
4810  * g_file_eject_mountable_finish:
4811  * @file: input #GFile
4812  * @result: a #GAsyncResult
4813  * @error: a #GError, or %NULL
4814  *
4815  * Finishes an asynchronous eject operation started by
4816  * g_file_eject_mountable().
4817  *
4818  * Returns: %TRUE if the @file was ejected successfully.
4819  *     %FALSE otherwise.
4820  *
4821  * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
4822  *     instead.
4823  */
4824 gboolean
4825 g_file_eject_mountable_finish (GFile         *file,
4826                                GAsyncResult  *result,
4827                                GError       **error)
4828 {
4829   GFileIface *iface;
4830
4831   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4832   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4833
4834   if (g_async_result_legacy_propagate_error (result, error))
4835     return FALSE;
4836   else if (g_async_result_is_tagged (result, g_file_eject_mountable_with_operation))
4837     return g_task_propagate_boolean (G_TASK (result), error);
4838
4839   iface = G_FILE_GET_IFACE (file);
4840   return (* iface->eject_mountable_finish) (file, result, error);
4841 }
4842
4843 /**
4844  * g_file_eject_mountable_with_operation:
4845  * @file: input #GFile
4846  * @flags: flags affecting the operation
4847  * @mount_operation: (allow-none): a #GMountOperation,
4848  *     or %NULL to avoid user interaction
4849  * @cancellable: (allow-none): optional #GCancellable object,
4850  *     %NULL to ignore
4851  * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4852  *     when the request is satisfied, or %NULL
4853  * @user_data: (closure): the data to pass to callback function
4854  *
4855  * Starts an asynchronous eject on a mountable.
4856  * When this operation has completed, @callback will be called with
4857  * @user_user data, and the operation can be finalized with
4858  * g_file_eject_mountable_with_operation_finish().
4859  *
4860  * If @cancellable is not %NULL, then the operation can be cancelled by
4861  * triggering the cancellable object from another thread. If the operation
4862  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4863  *
4864  * Since: 2.22
4865  */
4866 void
4867 g_file_eject_mountable_with_operation (GFile               *file,
4868                                        GMountUnmountFlags   flags,
4869                                        GMountOperation     *mount_operation,
4870                                        GCancellable        *cancellable,
4871                                        GAsyncReadyCallback  callback,
4872                                        gpointer             user_data)
4873 {
4874   GFileIface *iface;
4875
4876   g_return_if_fail (G_IS_FILE (file));
4877
4878   iface = G_FILE_GET_IFACE (file);
4879
4880   if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL)
4881     {
4882       g_task_report_new_error (file, callback, user_data,
4883                                g_file_eject_mountable_with_operation,
4884                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4885                                _("Operation not supported"));
4886       return;
4887     }
4888
4889   if (iface->eject_mountable_with_operation != NULL)
4890     (* iface->eject_mountable_with_operation) (file,
4891                                                flags,
4892                                                mount_operation,
4893                                                cancellable,
4894                                                callback,
4895                                                user_data);
4896   else
4897     (* iface->eject_mountable) (file,
4898                                 flags,
4899                                 cancellable,
4900                                 callback,
4901                                 user_data);
4902 }
4903
4904 /**
4905  * g_file_eject_mountable_with_operation_finish:
4906  * @file: input #GFile
4907  * @result: a #GAsyncResult
4908  * @error: a #GError, or %NULL
4909  *
4910  * Finishes an asynchronous eject operation started by
4911  * g_file_eject_mountable_with_operation().
4912  *
4913  * Returns: %TRUE if the @file was ejected successfully.
4914  *     %FALSE otherwise.
4915  *
4916  * Since: 2.22
4917  */
4918 gboolean
4919 g_file_eject_mountable_with_operation_finish (GFile         *file,
4920                                               GAsyncResult  *result,
4921                                               GError       **error)
4922 {
4923   GFileIface *iface;
4924
4925   g_return_val_if_fail (G_IS_FILE (file), FALSE);
4926   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4927
4928   if (g_async_result_legacy_propagate_error (result, error))
4929     return FALSE;
4930   else if (g_async_result_is_tagged (result, g_file_eject_mountable_with_operation))
4931     return g_task_propagate_boolean (G_TASK (result), error);
4932
4933   iface = G_FILE_GET_IFACE (file);
4934   if (iface->eject_mountable_with_operation_finish != NULL)
4935     return (* iface->eject_mountable_with_operation_finish) (file, result, error);
4936   else
4937     return (* iface->eject_mountable_finish) (file, result, error);
4938 }
4939
4940 /**
4941  * g_file_monitor_directory:
4942  * @file: input #GFile
4943  * @flags: a set of #GFileMonitorFlags
4944  * @cancellable: (allow-none): optional #GCancellable object,
4945  *     %NULL to ignore
4946  * @error: a #GError, or %NULL
4947  *
4948  * Obtains a directory monitor for the given file.
4949  * This may fail if directory monitoring is not supported.
4950  *
4951  * If @cancellable is not %NULL, then the operation can be cancelled by
4952  * triggering the cancellable object from another thread. If the operation
4953  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4954  *
4955  * It does not make sense for @flags to contain
4956  * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
4957  * directories.  It is not possible to monitor all the files in a
4958  * directory for changes made via hard links; if you want to do this then
4959  * you must register individual watches with g_file_monitor().
4960  *
4961  * Virtual: monitor_dir
4962  * Returns: (transfer full): a #GFileMonitor for the given @file,
4963  *     or %NULL on error.
4964  *     Free the returned object with g_object_unref().
4965  */
4966 GFileMonitor *
4967 g_file_monitor_directory (GFile              *file,
4968                           GFileMonitorFlags   flags,
4969                           GCancellable       *cancellable,
4970                           GError            **error)
4971 {
4972   GFileIface *iface;
4973
4974   g_return_val_if_fail (G_IS_FILE (file), NULL);
4975   g_return_val_if_fail (~flags & G_FILE_MONITOR_WATCH_HARD_LINKS, NULL);
4976
4977   if (g_cancellable_set_error_if_cancelled (cancellable, error))
4978     return NULL;
4979
4980   iface = G_FILE_GET_IFACE (file);
4981
4982   if (iface->monitor_dir == NULL)
4983     {
4984       g_set_error_literal (error, G_IO_ERROR,
4985                            G_IO_ERROR_NOT_SUPPORTED,
4986                            _("Operation not supported"));
4987       return NULL;
4988     }
4989
4990   return (* iface->monitor_dir) (file, flags, cancellable, error);
4991 }
4992
4993 /**
4994  * g_file_monitor_file:
4995  * @file: input #GFile
4996  * @flags: a set of #GFileMonitorFlags
4997  * @cancellable: (allow-none): optional #GCancellable object,
4998  *     %NULL to ignore
4999  * @error: a #GError, or %NULL
5000  *
5001  * Obtains a file monitor for the given file. If no file notification
5002  * mechanism exists, then regular polling of the file is used.
5003  *
5004  * If @cancellable is not %NULL, then the operation can be cancelled by
5005  * triggering the cancellable object from another thread. If the operation
5006  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5007  *
5008  * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5009  * will also attempt to report changes made to the file via another
5010  * filename (ie, a hard link). Without this flag, you can only rely on
5011  * changes made through the filename contained in @file to be
5012  * reported. Using this flag may result in an increase in resource
5013  * usage, and may not have any effect depending on the #GFileMonitor
5014  * backend and/or filesystem type.
5015  *
5016  * Returns: (transfer full): a #GFileMonitor for the given @file,
5017  *     or %NULL on error.
5018  *     Free the returned object with g_object_unref().
5019  */
5020 GFileMonitor *
5021 g_file_monitor_file (GFile              *file,
5022                      GFileMonitorFlags   flags,
5023                      GCancellable       *cancellable,
5024                      GError            **error)
5025 {
5026   GFileIface *iface;
5027   GFileMonitor *monitor;
5028
5029   g_return_val_if_fail (G_IS_FILE (file), NULL);
5030
5031   if (g_cancellable_set_error_if_cancelled (cancellable, error))
5032     return NULL;
5033
5034   iface = G_FILE_GET_IFACE (file);
5035
5036   monitor = NULL;
5037
5038   if (iface->monitor_file)
5039     monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
5040
5041   /* Fallback to polling */
5042   if (monitor == NULL)
5043     monitor = _g_poll_file_monitor_new (file);
5044
5045   return monitor;
5046 }
5047
5048 /**
5049  * g_file_monitor:
5050  * @file: input #GFile
5051  * @flags: a set of #GFileMonitorFlags
5052  * @cancellable: (allow-none): optional #GCancellable object,
5053  *     %NULL to ignore
5054  * @error: a #GError, or %NULL
5055  *
5056  * Obtains a file or directory monitor for the given file,
5057  * depending on the type of the file.
5058  *
5059  * If @cancellable is not %NULL, then the operation can be cancelled by
5060  * triggering the cancellable object from another thread. If the operation
5061  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5062  *
5063  * Returns: (transfer full): a #GFileMonitor for the given @file,
5064  *     or %NULL on error.
5065  *     Free the returned object with g_object_unref().
5066  *
5067  * Since: 2.18
5068  */
5069 GFileMonitor *
5070 g_file_monitor (GFile              *file,
5071                 GFileMonitorFlags   flags,
5072                 GCancellable       *cancellable,
5073                 GError            **error)
5074 {
5075   if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
5076     return g_file_monitor_directory (file,
5077                                      flags & ~G_FILE_MONITOR_WATCH_HARD_LINKS,
5078                                      cancellable, error);
5079   else
5080     return g_file_monitor_file (file, flags, cancellable, error);
5081 }
5082
5083 /********************************************
5084  *   Default implementation of async ops    *
5085  ********************************************/
5086
5087 typedef struct {
5088   char *attributes;
5089   GFileQueryInfoFlags flags;
5090 } QueryInfoAsyncData;
5091
5092 static void
5093 query_info_data_free (QueryInfoAsyncData *data)
5094 {
5095   g_free (data->attributes);
5096   g_free (data);
5097 }
5098
5099 static void
5100 query_info_async_thread (GTask         *task,
5101                          gpointer       object,
5102                          gpointer       task_data,
5103                          GCancellable  *cancellable)
5104 {
5105   QueryInfoAsyncData *data = task_data;
5106   GFileInfo *info;
5107   GError *error = NULL;
5108
5109   info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5110   if (info)
5111     g_task_return_pointer (task, info, g_object_unref);
5112   else
5113     g_task_return_error (task, error);
5114 }
5115
5116 static void
5117 g_file_real_query_info_async (GFile               *file,
5118                               const char          *attributes,
5119                               GFileQueryInfoFlags  flags,
5120                               int                  io_priority,
5121                               GCancellable        *cancellable,
5122                               GAsyncReadyCallback  callback,
5123                               gpointer             user_data)
5124 {
5125   GTask *task;
5126   QueryInfoAsyncData *data;
5127
5128   data = g_new0 (QueryInfoAsyncData, 1);
5129   data->attributes = g_strdup (attributes);
5130   data->flags = flags;
5131
5132   task = g_task_new (file, cancellable, callback, user_data);
5133   g_task_set_task_data (task, data, (GDestroyNotify)query_info_data_free);
5134   g_task_set_priority (task, io_priority);
5135   g_task_run_in_thread (task, query_info_async_thread);
5136   g_object_unref (task);
5137 }
5138
5139 static GFileInfo *
5140 g_file_real_query_info_finish (GFile         *file,
5141                                GAsyncResult  *res,
5142                                GError       **error)
5143 {
5144   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5145
5146   return g_task_propagate_pointer (G_TASK (res), error);
5147 }
5148
5149 static void
5150 query_filesystem_info_async_thread (GTask         *task,
5151                                     gpointer       object,
5152                                     gpointer       task_data,
5153                                     GCancellable  *cancellable)
5154 {
5155   const char *attributes = task_data;
5156   GFileInfo *info;
5157   GError *error = NULL;
5158
5159   info = g_file_query_filesystem_info (G_FILE (object), attributes, cancellable, &error);
5160   if (info)
5161     g_task_return_pointer (task, info, g_object_unref);
5162   else
5163     g_task_return_error (task, error);
5164 }
5165
5166 static void
5167 g_file_real_query_filesystem_info_async (GFile               *file,
5168                                          const char          *attributes,
5169                                          int                  io_priority,
5170                                          GCancellable        *cancellable,
5171                                          GAsyncReadyCallback  callback,
5172                                          gpointer             user_data)
5173 {
5174   GTask *task;
5175
5176   task = g_task_new (file, cancellable, callback, user_data);
5177   g_task_set_task_data (task, g_strdup (attributes), g_free);
5178   g_task_set_priority (task, io_priority);
5179   g_task_run_in_thread (task, query_filesystem_info_async_thread);
5180   g_object_unref (task);
5181 }
5182
5183 static GFileInfo *
5184 g_file_real_query_filesystem_info_finish (GFile         *file,
5185                                           GAsyncResult  *res,
5186                                           GError       **error)
5187 {
5188   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5189
5190   return g_task_propagate_pointer (G_TASK (res), error);
5191 }
5192
5193 static void
5194 enumerate_children_async_thread (GTask         *task,
5195                                  gpointer       object,
5196                                  gpointer       task_data,
5197                                  GCancellable  *cancellable)
5198 {
5199   QueryInfoAsyncData *data = task_data;
5200   GFileEnumerator *enumerator;
5201   GError *error = NULL;
5202
5203   enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5204   if (error)
5205     g_task_return_error (task, error);
5206   else
5207     g_task_return_pointer (task, enumerator, g_object_unref);
5208 }
5209
5210 static void
5211 g_file_real_enumerate_children_async (GFile               *file,
5212                                       const char          *attributes,
5213                                       GFileQueryInfoFlags  flags,
5214                                       int                  io_priority,
5215                                       GCancellable        *cancellable,
5216                                       GAsyncReadyCallback  callback,
5217                                       gpointer             user_data)
5218 {
5219   GTask *task;
5220   QueryInfoAsyncData *data;
5221
5222   data = g_new0 (QueryInfoAsyncData, 1);
5223   data->attributes = g_strdup (attributes);
5224   data->flags = flags;
5225
5226   task = g_task_new (file, cancellable, callback, user_data);
5227   g_task_set_task_data (task, data, (GDestroyNotify)query_info_data_free);
5228   g_task_set_priority (task, io_priority);
5229   g_task_run_in_thread (task, enumerate_children_async_thread);
5230   g_object_unref (task);
5231 }
5232
5233 static GFileEnumerator *
5234 g_file_real_enumerate_children_finish (GFile         *file,
5235                                        GAsyncResult  *res,
5236                                        GError       **error)
5237 {
5238   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5239
5240   return g_task_propagate_pointer (G_TASK (res), error);
5241 }
5242
5243 static void
5244 open_read_async_thread (GTask         *task,
5245                         gpointer       object,
5246                         gpointer       task_data,
5247                         GCancellable  *cancellable)
5248 {
5249   GFileIface *iface;
5250   GFileInputStream *stream;
5251   GError *error = NULL;
5252
5253   iface = G_FILE_GET_IFACE (object);
5254
5255   if (iface->read_fn == NULL)
5256     {
5257       g_task_return_new_error (task, G_IO_ERROR,
5258                                G_IO_ERROR_NOT_SUPPORTED,
5259                                _("Operation not supported"));
5260       return;
5261     }
5262
5263   stream = iface->read_fn (G_FILE (object), cancellable, &error);
5264   if (stream)
5265     g_task_return_pointer (task, stream, g_object_unref);
5266   else
5267     g_task_return_error (task, error);
5268 }
5269
5270 static void
5271 g_file_real_read_async (GFile               *file,
5272                         int                  io_priority,
5273                         GCancellable        *cancellable,
5274                         GAsyncReadyCallback  callback,
5275                         gpointer             user_data)
5276 {
5277   GTask *task;
5278
5279   task = g_task_new (file, cancellable, callback, user_data);
5280   g_task_set_priority (task, io_priority);
5281   g_task_run_in_thread (task, open_read_async_thread);
5282   g_object_unref (task);
5283 }
5284
5285 static GFileInputStream *
5286 g_file_real_read_finish (GFile         *file,
5287                          GAsyncResult  *res,
5288                          GError       **error)
5289 {
5290   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5291
5292   return g_task_propagate_pointer (G_TASK (res), error);
5293 }
5294
5295 static void
5296 append_to_async_thread (GTask         *task,
5297                         gpointer       source_object,
5298                         gpointer       task_data,
5299                         GCancellable  *cancellable)
5300 {
5301   GFileIface *iface;
5302   GFileCreateFlags *data = task_data;
5303   GFileOutputStream *stream;
5304   GError *error = NULL;
5305
5306   iface = G_FILE_GET_IFACE (source_object);
5307
5308   stream = iface->append_to (G_FILE (source_object), *data, cancellable, &error);
5309   if (stream)
5310     g_task_return_pointer (task, stream, g_object_unref);
5311   else
5312     g_task_return_error (task, error);
5313 }
5314
5315 static void
5316 g_file_real_append_to_async (GFile               *file,
5317                              GFileCreateFlags     flags,
5318                              int                  io_priority,
5319                              GCancellable        *cancellable,
5320                              GAsyncReadyCallback  callback,
5321                              gpointer             user_data)
5322 {
5323   GFileCreateFlags *data;
5324   GTask *task;
5325
5326   data = g_new0 (GFileCreateFlags, 1);
5327   *data = flags;
5328
5329   task = g_task_new (file, cancellable, callback, user_data);
5330   g_task_set_task_data (task, data, g_free);
5331   g_task_set_priority (task, io_priority);
5332
5333   g_task_run_in_thread (task, append_to_async_thread);
5334   g_object_unref (task);
5335 }
5336
5337 static GFileOutputStream *
5338 g_file_real_append_to_finish (GFile         *file,
5339                               GAsyncResult  *res,
5340                               GError       **error)
5341 {
5342   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5343
5344   return g_task_propagate_pointer (G_TASK (res), error);
5345 }
5346
5347 static void
5348 create_async_thread (GTask         *task,
5349                      gpointer       source_object,
5350                      gpointer       task_data,
5351                      GCancellable  *cancellable)
5352 {
5353   GFileIface *iface;
5354   GFileCreateFlags *data = task_data;
5355   GFileOutputStream *stream;
5356   GError *error = NULL;
5357
5358   iface = G_FILE_GET_IFACE (source_object);
5359
5360   stream = iface->create (G_FILE (source_object), *data, cancellable, &error);
5361   if (stream)
5362     g_task_return_pointer (task, stream, g_object_unref);
5363   else
5364     g_task_return_error (task, error);
5365 }
5366
5367 static void
5368 g_file_real_create_async (GFile               *file,
5369                           GFileCreateFlags     flags,
5370                           int                  io_priority,
5371                           GCancellable        *cancellable,
5372                           GAsyncReadyCallback  callback,
5373                           gpointer             user_data)
5374 {
5375   GFileCreateFlags *data;
5376   GTask *task;
5377
5378   data = g_new0 (GFileCreateFlags, 1);
5379   *data = flags;
5380
5381   task = g_task_new (file, cancellable, callback, user_data);
5382   g_task_set_task_data (task, data, g_free);
5383   g_task_set_priority (task, io_priority);
5384
5385   g_task_run_in_thread (task, create_async_thread);
5386   g_object_unref (task);
5387 }
5388
5389 static GFileOutputStream *
5390 g_file_real_create_finish (GFile         *file,
5391                            GAsyncResult  *res,
5392                            GError       **error)
5393 {
5394   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5395
5396   return g_task_propagate_pointer (G_TASK (res), error);
5397 }
5398
5399 typedef struct {
5400   GFileOutputStream *stream;
5401   char *etag;
5402   gboolean make_backup;
5403   GFileCreateFlags flags;
5404 } ReplaceAsyncData;
5405
5406 static void
5407 replace_async_data_free (ReplaceAsyncData *data)
5408 {
5409   if (data->stream)
5410     g_object_unref (data->stream);
5411   g_free (data->etag);
5412   g_free (data);
5413 }
5414
5415 static void
5416 replace_async_thread (GTask         *task,
5417                       gpointer       source_object,
5418                       gpointer       task_data,
5419                       GCancellable  *cancellable)
5420 {
5421   GFileIface *iface;
5422   GFileOutputStream *stream;
5423   ReplaceAsyncData *data = task_data;
5424   GError *error = NULL;
5425
5426   iface = G_FILE_GET_IFACE (source_object);
5427
5428   stream = iface->replace (G_FILE (source_object),
5429                            data->etag,
5430                            data->make_backup,
5431                            data->flags,
5432                            cancellable,
5433                            &error);
5434
5435   if (stream)
5436     g_task_return_pointer (task, stream, g_object_unref);
5437   else
5438     g_task_return_error (task, error);
5439 }
5440
5441 static void
5442 g_file_real_replace_async (GFile               *file,
5443                            const char          *etag,
5444                            gboolean             make_backup,
5445                            GFileCreateFlags     flags,
5446                            int                  io_priority,
5447                            GCancellable        *cancellable,
5448                            GAsyncReadyCallback  callback,
5449                            gpointer             user_data)
5450 {
5451   GTask *task;
5452   ReplaceAsyncData *data;
5453
5454   data = g_new0 (ReplaceAsyncData, 1);
5455   data->etag = g_strdup (etag);
5456   data->make_backup = make_backup;
5457   data->flags = flags;
5458
5459   task = g_task_new (file, cancellable, callback, user_data);
5460   g_task_set_task_data (task, data, (GDestroyNotify)replace_async_data_free);
5461   g_task_set_priority (task, io_priority);
5462
5463   g_task_run_in_thread (task, replace_async_thread);
5464   g_object_unref (task);
5465 }
5466
5467 static GFileOutputStream *
5468 g_file_real_replace_finish (GFile         *file,
5469                             GAsyncResult  *res,
5470                             GError       **error)
5471 {
5472   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5473
5474   return g_task_propagate_pointer (G_TASK (res), error);
5475 }
5476
5477 static void
5478 delete_async_thread (GTask        *task,
5479                      gpointer      object,
5480                      gpointer      task_data,
5481                      GCancellable *cancellable)
5482 {
5483   GFile *file = object;
5484   GFileIface *iface;
5485   GError *error = NULL;
5486
5487   iface = G_FILE_GET_IFACE (object);
5488
5489   if (iface->delete_file (file,
5490                           cancellable,
5491                           &error))
5492     g_task_return_boolean (task, TRUE);
5493   else
5494     g_task_return_error (task, error);
5495 }
5496
5497 static void
5498 g_file_real_delete_async (GFile               *file,
5499                           int                  io_priority,
5500                           GCancellable        *cancellable,
5501                           GAsyncReadyCallback  callback,
5502                           gpointer             user_data)
5503 {
5504   GTask *task;
5505
5506   task = g_task_new (file, cancellable, callback, user_data);
5507   g_task_set_priority (task, io_priority);
5508   g_task_run_in_thread (task, delete_async_thread);
5509   g_object_unref (task);
5510 }
5511
5512 static gboolean
5513 g_file_real_delete_finish (GFile         *file,
5514                            GAsyncResult  *res,
5515                            GError       **error)
5516 {
5517   g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
5518
5519   return g_task_propagate_boolean (G_TASK (res), error);
5520 }
5521
5522 static void
5523 open_readwrite_async_thread (GTask        *task,
5524                              gpointer      object,
5525                              gpointer      task_data,
5526                              GCancellable *cancellable)
5527 {
5528   GFileIface *iface;
5529   GFileIOStream *stream;
5530   GError *error = NULL;
5531
5532   iface = G_FILE_GET_IFACE (object);
5533
5534   if (iface->open_readwrite == NULL)
5535     {
5536       g_task_return_new_error (task, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
5537                                _("Operation not supported"));
5538       return;
5539     }
5540
5541   stream = iface->open_readwrite (G_FILE (object), cancellable, &error);
5542
5543   if (stream == NULL)
5544     g_task_return_error (task, error);
5545   else
5546     g_task_return_pointer (task, stream, g_object_unref);
5547 }
5548
5549 static void
5550 g_file_real_open_readwrite_async (GFile               *file,
5551                                   int                  io_priority,
5552                                   GCancellable        *cancellable,
5553                                   GAsyncReadyCallback  callback,
5554                                   gpointer             user_data)
5555 {
5556   GTask *task;
5557
5558   task = g_task_new (file, cancellable, callback, user_data);
5559   g_task_set_priority (task, io_priority);
5560
5561   g_task_run_in_thread (task, open_readwrite_async_thread);
5562   g_object_unref (task);
5563 }
5564
5565 static GFileIOStream *
5566 g_file_real_open_readwrite_finish (GFile         *file,
5567                                    GAsyncResult  *res,
5568                                    GError       **error)
5569 {
5570   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5571
5572   return g_task_propagate_pointer (G_TASK (res), error);
5573 }
5574
5575 static void
5576 create_readwrite_async_thread (GTask        *task,
5577                                gpointer      object,
5578                                gpointer      task_data,
5579                                GCancellable *cancellable)
5580 {
5581   GFileIface *iface;
5582   GFileCreateFlags *data = task_data;
5583   GFileIOStream *stream;
5584   GError *error = NULL;
5585
5586   iface = G_FILE_GET_IFACE (object);
5587
5588   if (iface->create_readwrite == NULL)
5589     {
5590       g_task_return_new_error (task, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
5591                                _("Operation not supported"));
5592       return;
5593     }
5594
5595   stream = iface->create_readwrite (G_FILE (object), *data, cancellable, &error);
5596
5597   if (stream == NULL)
5598     g_task_return_error (task, error);
5599   else
5600     g_task_return_pointer (task, stream, g_object_unref);
5601 }
5602
5603 static void
5604 g_file_real_create_readwrite_async (GFile               *file,
5605                                     GFileCreateFlags     flags,
5606                                     int                  io_priority,
5607                                     GCancellable        *cancellable,
5608                                     GAsyncReadyCallback  callback,
5609                                     gpointer             user_data)
5610 {
5611   GFileCreateFlags *data;
5612   GTask *task;
5613
5614   data = g_new0 (GFileCreateFlags, 1);
5615   *data = flags;
5616
5617   task = g_task_new (file, cancellable, callback, user_data);
5618   g_task_set_task_data (task, data, g_free);
5619   g_task_set_priority (task, io_priority);
5620
5621   g_task_run_in_thread (task, create_readwrite_async_thread);
5622   g_object_unref (task);
5623 }
5624
5625 static GFileIOStream *
5626 g_file_real_create_readwrite_finish (GFile         *file,
5627                                      GAsyncResult  *res,
5628                                      GError       **error)
5629 {
5630   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5631
5632   return g_task_propagate_pointer (G_TASK (res), error);
5633 }
5634
5635 typedef struct {
5636   char *etag;
5637   gboolean make_backup;
5638   GFileCreateFlags flags;
5639 } ReplaceRWAsyncData;
5640
5641 static void
5642 replace_rw_async_data_free (ReplaceRWAsyncData *data)
5643 {
5644   g_free (data->etag);
5645   g_free (data);
5646 }
5647
5648 static void
5649 replace_readwrite_async_thread (GTask        *task,
5650                                 gpointer      object,
5651                                 gpointer      task_data,
5652                                 GCancellable *cancellable)
5653 {
5654   GFileIface *iface;
5655   GFileIOStream *stream;
5656   GError *error = NULL;
5657   ReplaceRWAsyncData *data = task_data;
5658
5659   iface = G_FILE_GET_IFACE (object);
5660
5661   stream = iface->replace_readwrite (G_FILE (object),
5662                                      data->etag,
5663                                      data->make_backup,
5664                                      data->flags,
5665                                      cancellable,
5666                                      &error);
5667
5668   if (stream == NULL)
5669     g_task_return_error (task, error);
5670   else
5671     g_task_return_pointer (task, stream, g_object_unref);
5672 }
5673
5674 static void
5675 g_file_real_replace_readwrite_async (GFile               *file,
5676                                      const char          *etag,
5677                                      gboolean             make_backup,
5678                                      GFileCreateFlags     flags,
5679                                      int                  io_priority,
5680                                      GCancellable        *cancellable,
5681                                      GAsyncReadyCallback  callback,
5682                                      gpointer             user_data)
5683 {
5684   GTask *task;
5685   ReplaceRWAsyncData *data;
5686
5687   data = g_new0 (ReplaceRWAsyncData, 1);
5688   data->etag = g_strdup (etag);
5689   data->make_backup = make_backup;
5690   data->flags = flags;
5691
5692   task = g_task_new (file, cancellable, callback, user_data);
5693   g_task_set_task_data (task, data, (GDestroyNotify)replace_rw_async_data_free);
5694   g_task_set_priority (task, io_priority);
5695
5696   g_task_run_in_thread (task, replace_readwrite_async_thread);
5697   g_object_unref (task);
5698 }
5699
5700 static GFileIOStream *
5701 g_file_real_replace_readwrite_finish (GFile         *file,
5702                                       GAsyncResult  *res,
5703                                       GError       **error)
5704 {
5705   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5706
5707   return g_task_propagate_pointer (G_TASK (res), error);
5708 }
5709
5710 static void
5711 set_display_name_async_thread (GTask        *task,
5712                                gpointer      object,
5713                                gpointer      task_data,
5714                                GCancellable *cancellable)
5715 {
5716   GError *error = NULL;
5717   char *name = task_data;
5718   GFile *file;
5719
5720   file = g_file_set_display_name (G_FILE (object), name, cancellable, &error);
5721
5722   if (file == NULL)
5723     g_task_return_error (task, error);
5724   else
5725     g_task_return_pointer (task, file, g_object_unref);
5726 }
5727
5728 static void
5729 g_file_real_set_display_name_async (GFile               *file,
5730                                     const char          *display_name,
5731                                     int                  io_priority,
5732                                     GCancellable        *cancellable,
5733                                     GAsyncReadyCallback  callback,
5734                                     gpointer             user_data)
5735 {
5736   GTask *task;
5737
5738   task = g_task_new (file, cancellable, callback, user_data);
5739   g_task_set_task_data (task, g_strdup (display_name), g_free);
5740   g_task_set_priority (task, io_priority);
5741
5742   g_task_run_in_thread (task, set_display_name_async_thread);
5743   g_object_unref (task);
5744 }
5745
5746 static GFile *
5747 g_file_real_set_display_name_finish (GFile         *file,
5748                                      GAsyncResult  *res,
5749                                      GError       **error)
5750 {
5751   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5752
5753   return g_task_propagate_pointer (G_TASK (res), error);
5754 }
5755
5756 typedef struct {
5757   GFileQueryInfoFlags flags;
5758   GFileInfo *info;
5759   gboolean res;
5760   GError *error;
5761 } SetInfoAsyncData;
5762
5763 static void
5764 set_info_data_free (SetInfoAsyncData *data)
5765 {
5766   if (data->info)
5767     g_object_unref (data->info);
5768   if (data->error)
5769     g_error_free (data->error);
5770   g_free (data);
5771 }
5772
5773 static void
5774 set_info_async_thread (GTask        *task,
5775                        gpointer      object,
5776                        gpointer      task_data,
5777                        GCancellable *cancellable)
5778 {
5779   SetInfoAsyncData *data = task_data;
5780
5781   data->error = NULL;
5782   data->res = g_file_set_attributes_from_info (G_FILE (object),
5783                                                data->info,
5784                                                data->flags,
5785                                                cancellable,
5786                                                &data->error);
5787 }
5788
5789 static void
5790 g_file_real_set_attributes_async (GFile               *file,
5791                                   GFileInfo           *info,
5792                                   GFileQueryInfoFlags  flags,
5793                                   int                  io_priority,
5794                                   GCancellable        *cancellable,
5795                                   GAsyncReadyCallback  callback,
5796                                   gpointer             user_data)
5797 {
5798   GTask *task;
5799   SetInfoAsyncData *data;
5800
5801   data = g_new0 (SetInfoAsyncData, 1);
5802   data->info = g_file_info_dup (info);
5803   data->flags = flags;
5804
5805   task = g_task_new (file, cancellable, callback, user_data);
5806   g_task_set_task_data (task, data, (GDestroyNotify)set_info_data_free);
5807   g_task_set_priority (task, io_priority);
5808
5809   g_task_run_in_thread (task, set_info_async_thread);
5810   g_object_unref (task);
5811 }
5812
5813 static gboolean
5814 g_file_real_set_attributes_finish (GFile         *file,
5815                                    GAsyncResult  *res,
5816                                    GFileInfo    **info,
5817                                    GError       **error)
5818 {
5819   SetInfoAsyncData *data;
5820
5821   g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
5822
5823   data = g_task_get_task_data (G_TASK (res));
5824
5825   if (info)
5826     *info = g_object_ref (data->info);
5827
5828   if (error != NULL && data->error)
5829     *error = g_error_copy (data->error);
5830
5831   return data->res;
5832 }
5833
5834 static void
5835 find_enclosing_mount_async_thread (GTask        *task,
5836                                    gpointer      object,
5837                                    gpointer      task_data,
5838                                    GCancellable *cancellable)
5839 {
5840   GError *error = NULL;
5841   GMount *mount;
5842
5843   mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
5844
5845   if (mount == NULL)
5846     g_task_return_error (task, error);
5847   else
5848     g_task_return_pointer (task, mount, g_object_unref);
5849 }
5850
5851 static void
5852 g_file_real_find_enclosing_mount_async (GFile               *file,
5853                                         int                  io_priority,
5854                                         GCancellable        *cancellable,
5855                                         GAsyncReadyCallback  callback,
5856                                         gpointer             user_data)
5857 {
5858   GTask *task;
5859
5860   task = g_task_new (file, cancellable, callback, user_data);
5861   g_task_set_priority (task, io_priority);
5862
5863   g_task_run_in_thread (task, find_enclosing_mount_async_thread);
5864   g_object_unref (task);
5865 }
5866
5867 static GMount *
5868 g_file_real_find_enclosing_mount_finish (GFile         *file,
5869                                          GAsyncResult  *res,
5870                                          GError       **error)
5871 {
5872   g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5873
5874   return g_task_propagate_pointer (G_TASK (res), error);
5875 }
5876
5877
5878 typedef struct {
5879   GFile *source;
5880   GFile *destination;
5881   GFileCopyFlags flags;
5882   GFileProgressCallback progress_cb;
5883   gpointer progress_cb_data;
5884 } CopyAsyncData;
5885
5886 static void
5887 copy_async_data_free (CopyAsyncData *data)
5888 {
5889   g_object_unref (data->source);
5890   g_object_unref (data->destination);
5891   g_slice_free (CopyAsyncData, data);
5892 }
5893
5894 typedef struct {
5895   CopyAsyncData *data;
5896   goffset current_num_bytes;
5897   goffset total_num_bytes;
5898 } ProgressData;
5899
5900 static gboolean
5901 copy_async_progress_in_main (gpointer user_data)
5902 {
5903   ProgressData *progress = user_data;
5904   CopyAsyncData *data = progress->data;
5905
5906   data->progress_cb (progress->current_num_bytes,
5907                      progress->total_num_bytes,
5908                      data->progress_cb_data);
5909
5910   return FALSE;
5911 }
5912
5913 static void
5914 copy_async_progress_callback (goffset  current_num_bytes,
5915                               goffset  total_num_bytes,
5916                               gpointer user_data)
5917 {
5918   GTask *task = user_data;
5919   CopyAsyncData *data = g_task_get_task_data (task);
5920   ProgressData *progress;
5921
5922   progress = g_new (ProgressData, 1);
5923   progress->data = data;
5924   progress->current_num_bytes = current_num_bytes;
5925   progress->total_num_bytes = total_num_bytes;
5926
5927   g_main_context_invoke_full (g_task_get_context (task),
5928                               g_task_get_priority (task),
5929                               copy_async_progress_in_main,
5930                               progress,
5931                               g_free);
5932 }
5933
5934 static void
5935 copy_async_thread (GTask        *task,
5936                    gpointer      source,
5937                    gpointer      task_data,
5938                    GCancellable *cancellable)
5939 {
5940   CopyAsyncData *data = task_data;
5941   gboolean result;
5942   GError *error = NULL;
5943
5944   result = g_file_copy (data->source,
5945                         data->destination,
5946                         data->flags,
5947                         cancellable,
5948                         (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
5949                         task,
5950                         &error);
5951   if (result)
5952     g_task_return_boolean (task, TRUE);
5953   else
5954     g_task_return_error (task, error);
5955 }
5956
5957 static void
5958 g_file_real_copy_async (GFile                  *source,
5959                         GFile                  *destination,
5960                         GFileCopyFlags          flags,
5961                         int                     io_priority,
5962                         GCancellable           *cancellable,
5963                         GFileProgressCallback   progress_callback,
5964                         gpointer                progress_callback_data,
5965                         GAsyncReadyCallback     callback,
5966                         gpointer                user_data)
5967 {
5968   GTask *task;
5969   CopyAsyncData *data;
5970
5971   data = g_slice_new (CopyAsyncData);
5972   data->source = g_object_ref (source);
5973   data->destination = g_object_ref (destination);
5974   data->flags = flags;
5975   data->progress_cb = progress_callback;
5976   data->progress_cb_data = progress_callback_data;
5977
5978   task = g_task_new (source, cancellable, callback, user_data);
5979   g_task_set_task_data (task, data, (GDestroyNotify)copy_async_data_free);
5980   g_task_set_priority (task, io_priority);
5981   g_task_run_in_thread (task, copy_async_thread);
5982   g_object_unref (task);
5983 }
5984
5985 static gboolean
5986 g_file_real_copy_finish (GFile        *file,
5987                          GAsyncResult *res,
5988                          GError      **error)
5989 {
5990   g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
5991
5992   return g_task_propagate_boolean (G_TASK (res), error);
5993 }
5994
5995
5996 /********************************************
5997  *   Default VFS operations                 *
5998  ********************************************/
5999
6000 /**
6001  * g_file_new_for_path:
6002  * @path: a string containing a relative or absolute path.
6003  *     The string must be encoded in the glib filename encoding.
6004  *
6005  * Constructs a #GFile for a given path. This operation never
6006  * fails, but the returned object might not support any I/O
6007  * operation if @path is malformed.
6008  *
6009  * Returns: (transfer full): a new #GFile for the given @path.
6010  *   Free the returned object with g_object_unref().
6011  */
6012 GFile *
6013 g_file_new_for_path (const char *path)
6014 {
6015   g_return_val_if_fail (path != NULL, NULL);
6016
6017   return g_vfs_get_file_for_path (g_vfs_get_default (), path);
6018 }
6019
6020 /**
6021  * g_file_new_for_uri:
6022  * @uri: a UTF-8 string containing a URI
6023  *
6024  * Constructs a #GFile for a given URI. This operation never
6025  * fails, but the returned object might not support any I/O
6026  * operation if @uri is malformed or if the uri type is
6027  * not supported.
6028  *
6029  * Returns: (transfer full): a new #GFile for the given @uri.
6030  *     Free the returned object with g_object_unref().
6031  */
6032 GFile *
6033 g_file_new_for_uri (const char *uri)
6034 {
6035   g_return_val_if_fail (uri != NULL, NULL);
6036
6037   return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
6038 }
6039
6040 /**
6041  * g_file_new_tmp:
6042  * @tmpl: (type filename) (allow-none): Template for the file
6043  *   name, as in g_file_open_tmp(), or %NULL for a default template
6044  * @iostream: (out): on return, a #GFileIOStream for the created file
6045  * @error: a #GError, or %NULL
6046  *
6047  * Opens a file in the preferred directory for temporary files (as
6048  * returned by g_get_tmp_dir()) and returns a #GFile and
6049  * #GFileIOStream pointing to it.
6050  *
6051  * @tmpl should be a string in the GLib file name encoding
6052  * containing a sequence of six 'X' characters, and containing no
6053  * directory components. If it is %NULL, a default template is used.
6054  *
6055  * Unlike the other #GFile constructors, this will return %NULL if
6056  * a temporary file could not be created.
6057  *
6058  * Returns: (transfer full): a new #GFile.
6059  *     Free the returned object with g_object_unref().
6060  *
6061  * Since: 2.32
6062  */
6063 GFile *
6064 g_file_new_tmp (const char     *tmpl,
6065                 GFileIOStream **iostream,
6066                 GError        **error)
6067 {
6068   gint fd;
6069   gchar *path;
6070   GFile *file;
6071   GFileOutputStream *output;
6072
6073   g_return_val_if_fail (iostream != NULL, NULL);
6074
6075   fd = g_file_open_tmp (tmpl, &path, error);
6076   if (fd == -1)
6077     return NULL;
6078
6079   file = g_file_new_for_path (path);
6080
6081   output = _g_local_file_output_stream_new (fd);
6082   *iostream = _g_local_file_io_stream_new (G_LOCAL_FILE_OUTPUT_STREAM (output));
6083
6084   g_object_unref (output);
6085   g_free (path);
6086
6087   return file;
6088 }
6089
6090 /**
6091  * g_file_parse_name:
6092  * @parse_name: a file name or path to be parsed
6093  *
6094  * Constructs a #GFile with the given @parse_name (i.e. something
6095  * given by g_file_get_parse_name()). This operation never fails,
6096  * but the returned object might not support any I/O operation if
6097  * the @parse_name cannot be parsed.
6098  *
6099  * Returns: (transfer full): a new #GFile.
6100  */
6101 GFile *
6102 g_file_parse_name (const char *parse_name)
6103 {
6104   g_return_val_if_fail (parse_name != NULL, NULL);
6105
6106   return g_vfs_parse_name (g_vfs_get_default (), parse_name);
6107 }
6108
6109 static gboolean
6110 is_valid_scheme_character (char c)
6111 {
6112   return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
6113 }
6114
6115 /* Following RFC 2396, valid schemes are built like:
6116  *       scheme        = alpha *( alpha | digit | "+" | "-" | "." )
6117  */
6118 static gboolean
6119 has_valid_scheme (const char *uri)
6120 {
6121   const char *p;
6122
6123   p = uri;
6124
6125   if (!g_ascii_isalpha (*p))
6126     return FALSE;
6127
6128   do {
6129     p++;
6130   } while (is_valid_scheme_character (*p));
6131
6132   return *p == ':';
6133 }
6134
6135 static GFile *
6136 new_for_cmdline_arg (const gchar *arg,
6137                      const gchar *cwd)
6138 {
6139   GFile *file;
6140   char *filename;
6141
6142   if (g_path_is_absolute (arg))
6143     return g_file_new_for_path (arg);
6144
6145   if (has_valid_scheme (arg))
6146     return g_file_new_for_uri (arg);
6147
6148   if (cwd == NULL)
6149     {
6150       char *current_dir;
6151
6152       current_dir = g_get_current_dir ();
6153       filename = g_build_filename (current_dir, arg, NULL);
6154       g_free (current_dir);
6155     }
6156   else
6157     filename = g_build_filename (cwd, arg, NULL);
6158
6159   file = g_file_new_for_path (filename);
6160   g_free (filename);
6161
6162   return file;
6163 }
6164
6165 /**
6166  * g_file_new_for_commandline_arg:
6167  * @arg: a command line string
6168  *
6169  * Creates a #GFile with the given argument from the command line.
6170  * The value of @arg can be either a URI, an absolute path or a
6171  * relative path resolved relative to the current working directory.
6172  * This operation never fails, but the returned object might not
6173  * support any I/O operation if @arg points to a malformed path.
6174  *
6175  * Returns: (transfer full): a new #GFile.
6176  *    Free the returned object with g_object_unref().
6177  */
6178 GFile *
6179 g_file_new_for_commandline_arg (const char *arg)
6180 {
6181   g_return_val_if_fail (arg != NULL, NULL);
6182
6183   return new_for_cmdline_arg (arg, NULL);
6184 }
6185
6186 /**
6187  * g_file_new_for_commandline_arg_and_cwd:
6188  * @arg: a command line string
6189  * @cwd: the current working directory of the commandline
6190  *
6191  * Creates a #GFile with the given argument from the command line.
6192  *
6193  * This function is similar to g_file_new_for_commandline_arg() except
6194  * that it allows for passing the current working directory as an
6195  * argument instead of using the current working directory of the
6196  * process.
6197  *
6198  * This is useful if the commandline argument was given in a context
6199  * other than the invocation of the current process.
6200  *
6201  * See also g_application_command_line_create_file_for_arg().
6202  *
6203  * Returns: (transfer full): a new #GFile
6204  *
6205  * Since: 2.36
6206  **/
6207 GFile *
6208 g_file_new_for_commandline_arg_and_cwd (const gchar *arg,
6209                                         const gchar *cwd)
6210 {
6211   g_return_val_if_fail (arg != NULL, NULL);
6212   g_return_val_if_fail (cwd != NULL, NULL);
6213
6214   return new_for_cmdline_arg (arg, cwd);
6215 }
6216
6217 /**
6218  * g_file_mount_enclosing_volume:
6219  * @location: input #GFile
6220  * @flags: flags affecting the operation
6221  * @mount_operation: (allow-none): a #GMountOperation
6222  *     or %NULL to avoid user interaction
6223  * @cancellable: (allow-none): optional #GCancellable object,
6224  *     %NULL to ignore
6225  * @callback: (allow-none): a #GAsyncReadyCallback to call
6226  *     when the request is satisfied, or %NULL
6227  * @user_data: the data to pass to callback function
6228  *
6229  * Starts a @mount_operation, mounting the volume that contains
6230  * the file @location.
6231  *
6232  * When this operation has completed, @callback will be called with
6233  * @user_user data, and the operation can be finalized with
6234  * g_file_mount_enclosing_volume_finish().
6235  *
6236  * If @cancellable is not %NULL, then the operation can be cancelled by
6237  * triggering the cancellable object from another thread. If the operation
6238  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6239  */
6240 void
6241 g_file_mount_enclosing_volume (GFile               *location,
6242                                GMountMountFlags     flags,
6243                                GMountOperation     *mount_operation,
6244                                GCancellable        *cancellable,
6245                                GAsyncReadyCallback  callback,
6246                                gpointer             user_data)
6247 {
6248   GFileIface *iface;
6249
6250   g_return_if_fail (G_IS_FILE (location));
6251
6252   iface = G_FILE_GET_IFACE (location);
6253
6254   if (iface->mount_enclosing_volume == NULL)
6255     {
6256       g_task_report_new_error (location, callback, user_data,
6257                                g_file_mount_enclosing_volume,
6258                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
6259                                _("volume doesn't implement mount"));
6260       return;
6261     }
6262
6263   (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6264
6265 }
6266
6267 /**
6268  * g_file_mount_enclosing_volume_finish:
6269  * @location: input #GFile
6270  * @result: a #GAsyncResult
6271  * @error: a #GError, or %NULL
6272  *
6273  * Finishes a mount operation started by g_file_mount_enclosing_volume().
6274  *
6275  * Returns: %TRUE if successful. If an error has occurred,
6276  *     this function will return %FALSE and set @error
6277  *     appropriately if present.
6278  */
6279 gboolean
6280 g_file_mount_enclosing_volume_finish (GFile         *location,
6281                                       GAsyncResult  *result,
6282                                       GError       **error)
6283 {
6284   GFileIface *iface;
6285
6286   g_return_val_if_fail (G_IS_FILE (location), FALSE);
6287   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6288
6289   if (g_async_result_legacy_propagate_error (result, error))
6290     return FALSE;
6291   else if (g_async_result_is_tagged (result, g_file_mount_enclosing_volume))
6292     return g_task_propagate_boolean (G_TASK (result), error);
6293
6294   iface = G_FILE_GET_IFACE (location);
6295
6296   return (* iface->mount_enclosing_volume_finish) (location, result, error);
6297 }
6298
6299 /********************************************
6300  *   Utility functions                      *
6301  ********************************************/
6302
6303 /**
6304  * g_file_query_default_handler:
6305  * @file: a #GFile to open
6306  * @cancellable: optional #GCancellable object, %NULL to ignore
6307  * @error: a #GError, or %NULL
6308  *
6309  * Returns the #GAppInfo that is registered as the default
6310  * application to handle the file specified by @file.
6311  *
6312  * If @cancellable is not %NULL, then the operation can be cancelled by
6313  * triggering the cancellable object from another thread. If the operation
6314  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6315  *
6316  * Returns: (transfer full): a #GAppInfo if the handle was found,
6317  *     %NULL if there were errors.
6318  *     When you are done with it, release it with g_object_unref()
6319  */
6320 GAppInfo *
6321 g_file_query_default_handler (GFile         *file,
6322                               GCancellable  *cancellable,
6323                               GError       **error)
6324 {
6325   char *uri_scheme;
6326   const char *content_type;
6327   GAppInfo *appinfo;
6328   GFileInfo *info;
6329   char *path;
6330
6331   uri_scheme = g_file_get_uri_scheme (file);
6332   if (uri_scheme && uri_scheme[0] != '\0')
6333     {
6334       appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
6335       g_free (uri_scheme);
6336
6337       if (appinfo != NULL)
6338         return appinfo;
6339     }
6340
6341   info = g_file_query_info (file,
6342                             G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6343                             0,
6344                             cancellable,
6345                             error);
6346   if (info == NULL)
6347     return NULL;
6348
6349   appinfo = NULL;
6350
6351   content_type = g_file_info_get_content_type (info);
6352   if (content_type)
6353     {
6354       /* Don't use is_native(), as we want to support fuse paths if available */
6355       path = g_file_get_path (file);
6356       appinfo = g_app_info_get_default_for_type (content_type,
6357                                                  path == NULL);
6358       g_free (path);
6359     }
6360
6361   g_object_unref (info);
6362
6363   if (appinfo != NULL)
6364     return appinfo;
6365
6366   g_set_error_literal (error, G_IO_ERROR,
6367                        G_IO_ERROR_NOT_SUPPORTED,
6368                        _("No application is registered as handling this file"));
6369   return NULL;
6370 }
6371
6372 #define GET_CONTENT_BLOCK_SIZE 8192
6373
6374 /**
6375  * g_file_load_contents:
6376  * @file: input #GFile
6377  * @cancellable: optional #GCancellable object, %NULL to ignore
6378  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6379  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6380  *    or %NULL if the length is not needed
6381  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6382  *    or %NULL if the entity tag is not needed
6383  * @error: a #GError, or %NULL
6384  *
6385  * Loads the content of the file into memory. The data is always
6386  * zero-terminated, but this is not included in the resultant @length.
6387  * The returned @content should be freed with g_free() when no longer
6388  * needed.
6389  *
6390  * If @cancellable is not %NULL, then the operation can be cancelled by
6391  * triggering the cancellable object from another thread. If the operation
6392  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6393  *
6394  * Returns: %TRUE if the @file's contents were successfully loaded.
6395  *     %FALSE if there were errors.
6396  */
6397 gboolean
6398 g_file_load_contents (GFile         *file,
6399                       GCancellable  *cancellable,
6400                       char         **contents,
6401                       gsize         *length,
6402                       char         **etag_out,
6403                       GError       **error)
6404 {
6405   GFileInputStream *in;
6406   GByteArray *content;
6407   gsize pos;
6408   gssize res;
6409   GFileInfo *info;
6410
6411   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6412   g_return_val_if_fail (contents != NULL, FALSE);
6413
6414   in = g_file_read (file, cancellable, error);
6415   if (in == NULL)
6416     return FALSE;
6417
6418   content = g_byte_array_new ();
6419   pos = 0;
6420
6421   g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6422   while ((res = g_input_stream_read (G_INPUT_STREAM (in),
6423                                      content->data + pos,
6424                                      GET_CONTENT_BLOCK_SIZE,
6425                                      cancellable, error)) > 0)
6426     {
6427       pos += res;
6428       g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6429     }
6430
6431   if (etag_out)
6432     {
6433       *etag_out = NULL;
6434
6435       info = g_file_input_stream_query_info (in,
6436                                              G_FILE_ATTRIBUTE_ETAG_VALUE,
6437                                              cancellable,
6438                                              NULL);
6439       if (info)
6440         {
6441           *etag_out = g_strdup (g_file_info_get_etag (info));
6442           g_object_unref (info);
6443         }
6444     }
6445
6446   /* Ignore errors on close */
6447   g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
6448   g_object_unref (in);
6449
6450   if (res < 0)
6451     {
6452       /* error is set already */
6453       g_byte_array_free (content, TRUE);
6454       return FALSE;
6455     }
6456
6457   if (length)
6458     *length = pos;
6459
6460   /* Zero terminate (we got an extra byte allocated for this */
6461   content->data[pos] = 0;
6462
6463   *contents = (char *)g_byte_array_free (content, FALSE);
6464
6465   return TRUE;
6466 }
6467
6468 typedef struct {
6469   GTask *task;
6470   GFileReadMoreCallback read_more_callback;
6471   GByteArray *content;
6472   gsize pos;
6473   char *etag;
6474 } LoadContentsData;
6475
6476
6477 static void
6478 load_contents_data_free (LoadContentsData *data)
6479 {
6480   if (data->content)
6481     g_byte_array_free (data->content, TRUE);
6482   g_free (data->etag);
6483   g_free (data);
6484 }
6485
6486 static void
6487 load_contents_close_callback (GObject      *obj,
6488                               GAsyncResult *close_res,
6489                               gpointer      user_data)
6490 {
6491   GInputStream *stream = G_INPUT_STREAM (obj);
6492   LoadContentsData *data = user_data;
6493
6494   /* Ignore errors here, we're only reading anyway */
6495   g_input_stream_close_finish (stream, close_res, NULL);
6496   g_object_unref (stream);
6497
6498   g_task_return_boolean (data->task, TRUE);
6499   g_object_unref (data->task);
6500 }
6501
6502 static void
6503 load_contents_fstat_callback (GObject      *obj,
6504                               GAsyncResult *stat_res,
6505                               gpointer      user_data)
6506 {
6507   GInputStream *stream = G_INPUT_STREAM (obj);
6508   LoadContentsData *data = user_data;
6509   GFileInfo *info;
6510
6511   info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
6512                                                 stat_res, NULL);
6513   if (info)
6514     {
6515       data->etag = g_strdup (g_file_info_get_etag (info));
6516       g_object_unref (info);
6517     }
6518
6519   g_input_stream_close_async (stream, 0,
6520                               g_task_get_cancellable (data->task),
6521                               load_contents_close_callback, data);
6522 }
6523
6524 static void
6525 load_contents_read_callback (GObject      *obj,
6526                              GAsyncResult *read_res,
6527                              gpointer      user_data)
6528 {
6529   GInputStream *stream = G_INPUT_STREAM (obj);
6530   LoadContentsData *data = user_data;
6531   GError *error = NULL;
6532   gssize read_size;
6533
6534   read_size = g_input_stream_read_finish (stream, read_res, &error);
6535
6536   if (read_size < 0)
6537     {
6538       g_task_return_error (data->task, error);
6539       g_object_unref (data->task);
6540
6541       /* Close the file ignoring any error */
6542       g_input_stream_close_async (stream, 0, NULL, NULL, NULL);
6543       g_object_unref (stream);
6544     }
6545   else if (read_size == 0)
6546     {
6547       g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6548                                             G_FILE_ATTRIBUTE_ETAG_VALUE,
6549                                             0,
6550                                             g_task_get_cancellable (data->task),
6551                                             load_contents_fstat_callback,
6552                                             data);
6553     }
6554   else if (read_size > 0)
6555     {
6556       data->pos += read_size;
6557
6558       g_byte_array_set_size (data->content,
6559                              data->pos + GET_CONTENT_BLOCK_SIZE);
6560
6561
6562       if (data->read_more_callback &&
6563           !data->read_more_callback ((char *)data->content->data, data->pos,
6564                                      g_async_result_get_user_data (G_ASYNC_RESULT (data->task))))
6565         g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6566                                               G_FILE_ATTRIBUTE_ETAG_VALUE,
6567                                               0,
6568                                               g_task_get_cancellable (data->task),
6569                                               load_contents_fstat_callback,
6570                                               data);
6571       else
6572         g_input_stream_read_async (stream,
6573                                    data->content->data + data->pos,
6574                                    GET_CONTENT_BLOCK_SIZE,
6575                                    0,
6576                                    g_task_get_cancellable (data->task),
6577                                    load_contents_read_callback,
6578                                    data);
6579     }
6580 }
6581
6582 static void
6583 load_contents_open_callback (GObject      *obj,
6584                              GAsyncResult *open_res,
6585                              gpointer      user_data)
6586 {
6587   GFile *file = G_FILE (obj);
6588   GFileInputStream *stream;
6589   LoadContentsData *data = user_data;
6590   GError *error = NULL;
6591
6592   stream = g_file_read_finish (file, open_res, &error);
6593
6594   if (stream)
6595     {
6596       g_byte_array_set_size (data->content,
6597                              data->pos + GET_CONTENT_BLOCK_SIZE);
6598       g_input_stream_read_async (G_INPUT_STREAM (stream),
6599                                  data->content->data + data->pos,
6600                                  GET_CONTENT_BLOCK_SIZE,
6601                                  0,
6602                                  g_task_get_cancellable (data->task),
6603                                  load_contents_read_callback,
6604                                  data);
6605     }
6606   else
6607     {
6608       g_task_return_error (data->task, error);
6609       g_object_unref (data->task);
6610     }
6611 }
6612
6613 /**
6614  * g_file_load_partial_contents_async: (skip)
6615  * @file: input #GFile
6616  * @cancellable: optional #GCancellable object, %NULL to ignore
6617  * @read_more_callback: a #GFileReadMoreCallback to receive partial data
6618  *     and to specify whether further data should be read
6619  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6620  * @user_data: the data to pass to the callback functions
6621  *
6622  * Reads the partial contents of a file. A #GFileReadMoreCallback should
6623  * be used to stop reading from the file when appropriate, else this
6624  * function will behave exactly as g_file_load_contents_async(). This
6625  * operation can be finished by g_file_load_partial_contents_finish().
6626  *
6627  * Users of this function should be aware that @user_data is passed to
6628  * both the @read_more_callback and the @callback.
6629  *
6630  * If @cancellable is not %NULL, then the operation can be cancelled by
6631  * triggering the cancellable object from another thread. If the operation
6632  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6633  */
6634 void
6635 g_file_load_partial_contents_async (GFile                 *file,
6636                                     GCancellable          *cancellable,
6637                                     GFileReadMoreCallback  read_more_callback,
6638                                     GAsyncReadyCallback    callback,
6639                                     gpointer               user_data)
6640 {
6641   LoadContentsData *data;
6642
6643   g_return_if_fail (G_IS_FILE (file));
6644
6645   data = g_new0 (LoadContentsData, 1);
6646   data->read_more_callback = read_more_callback;
6647   data->content = g_byte_array_new ();
6648
6649   data->task = g_task_new (file, cancellable, callback, user_data);
6650   g_task_set_task_data (data->task, data, (GDestroyNotify)load_contents_data_free);
6651
6652   g_file_read_async (file,
6653                      0,
6654                      g_task_get_cancellable (data->task),
6655                      load_contents_open_callback,
6656                      data);
6657 }
6658
6659 /**
6660  * g_file_load_partial_contents_finish:
6661  * @file: input #GFile
6662  * @res: a #GAsyncResult
6663  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6664  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6665  *     or %NULL if the length is not needed
6666  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6667  *     or %NULL if the entity tag is not needed
6668  * @error: a #GError, or %NULL
6669  *
6670  * Finishes an asynchronous partial load operation that was started
6671  * with g_file_load_partial_contents_async(). The data is always
6672  * zero-terminated, but this is not included in the resultant @length.
6673  * The returned @content should be freed with g_free() when no longer
6674  * needed.
6675  *
6676  * Returns: %TRUE if the load was successful. If %FALSE and @error is
6677  *     present, it will be set appropriately.
6678  */
6679 gboolean
6680 g_file_load_partial_contents_finish (GFile         *file,
6681                                      GAsyncResult  *res,
6682                                      char         **contents,
6683                                      gsize         *length,
6684                                      char         **etag_out,
6685                                      GError       **error)
6686 {
6687   GTask *task;
6688   LoadContentsData *data;
6689
6690   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6691   g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
6692   g_return_val_if_fail (contents != NULL, FALSE);
6693
6694   task = G_TASK (res);
6695
6696   if (!g_task_propagate_boolean (task, error))
6697     {
6698       if (length)
6699         *length = 0;
6700       return FALSE;
6701     }
6702
6703   data = g_task_get_task_data (task);
6704
6705   if (length)
6706     *length = data->pos;
6707
6708   if (etag_out)
6709     {
6710       *etag_out = data->etag;
6711       data->etag = NULL;
6712     }
6713
6714   /* Zero terminate */
6715   g_byte_array_set_size (data->content, data->pos + 1);
6716   data->content->data[data->pos] = 0;
6717
6718   *contents = (char *)g_byte_array_free (data->content, FALSE);
6719   data->content = NULL;
6720
6721   return TRUE;
6722 }
6723
6724 /**
6725  * g_file_load_contents_async:
6726  * @file: input #GFile
6727  * @cancellable: optional #GCancellable object, %NULL to ignore
6728  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6729  * @user_data: the data to pass to callback function
6730  *
6731  * Starts an asynchronous load of the @file's contents.
6732  *
6733  * For more details, see g_file_load_contents() which is
6734  * the synchronous version of this call.
6735  *
6736  * When the load operation has completed, @callback will be called
6737  * with @user data. To finish the operation, call
6738  * g_file_load_contents_finish() with the #GAsyncResult returned by
6739  * the @callback.
6740  *
6741  * If @cancellable is not %NULL, then the operation can be cancelled by
6742  * triggering the cancellable object from another thread. If the operation
6743  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6744  */
6745 void
6746 g_file_load_contents_async (GFile               *file,
6747                            GCancellable        *cancellable,
6748                            GAsyncReadyCallback  callback,
6749                            gpointer             user_data)
6750 {
6751   g_file_load_partial_contents_async (file,
6752                                       cancellable,
6753                                       NULL,
6754                                       callback, user_data);
6755 }
6756
6757 /**
6758  * g_file_load_contents_finish:
6759  * @file: input #GFile
6760  * @res: a #GAsyncResult
6761  * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6762  * @length: (out) (allow-none): a location to place the length of the contents of the file,
6763  *     or %NULL if the length is not needed
6764  * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6765  *     or %NULL if the entity tag is not needed
6766  * @error: a #GError, or %NULL
6767  *
6768  * Finishes an asynchronous load of the @file's contents.
6769  * The contents are placed in @contents, and @length is set to the
6770  * size of the @contents string. The @content should be freed with
6771  * g_free() when no longer needed. If @etag_out is present, it will be
6772  * set to the new entity tag for the @file.
6773  *
6774  * Returns: %TRUE if the load was successful. If %FALSE and @error is
6775  *     present, it will be set appropriately.
6776  */
6777 gboolean
6778 g_file_load_contents_finish (GFile         *file,
6779                              GAsyncResult  *res,
6780                              char         **contents,
6781                              gsize         *length,
6782                              char         **etag_out,
6783                              GError       **error)
6784 {
6785   return g_file_load_partial_contents_finish (file,
6786                                               res,
6787                                               contents,
6788                                               length,
6789                                               etag_out,
6790                                               error);
6791 }
6792
6793 /**
6794  * g_file_replace_contents:
6795  * @file: input #GFile
6796  * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
6797  * @length: the length of @contents in bytes
6798  * @etag: (allow-none): the old <link linkend="gfile-etag">entity tag</link>
6799  *     for the document, or %NULL
6800  * @make_backup: %TRUE if a backup should be created
6801  * @flags: a set of #GFileCreateFlags
6802  * @new_etag: (allow-none) (out): a location to a new <link linkend="gfile-etag">entity tag</link>
6803  *      for the document. This should be freed with g_free() when no longer
6804  *      needed, or %NULL
6805  * @cancellable: optional #GCancellable object, %NULL to ignore
6806  * @error: a #GError, or %NULL
6807  *
6808  * Replaces the contents of @file with @contents of @length bytes.
6809  *
6810  * If @etag is specified (not %NULL), any existing file must have that etag,
6811  * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
6812  *
6813  * If @make_backup is %TRUE, this function will attempt to make a backup
6814  * of @file.
6815  *
6816  * If @cancellable is not %NULL, then the operation can be cancelled by
6817  * triggering the cancellable object from another thread. If the operation
6818  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6819  *
6820  * The returned @new_etag can be used to verify that the file hasn't
6821  * changed the next time it is saved over.
6822  *
6823  * Returns: %TRUE if successful. If an error has occurred, this function
6824  *     will return %FALSE and set @error appropriately if present.
6825  */
6826 gboolean
6827 g_file_replace_contents (GFile             *file,
6828                          const char        *contents,
6829                          gsize              length,
6830                          const char        *etag,
6831                          gboolean           make_backup,
6832                          GFileCreateFlags   flags,
6833                          char             **new_etag,
6834                          GCancellable      *cancellable,
6835                          GError           **error)
6836 {
6837   GFileOutputStream *out;
6838   gsize pos, remainder;
6839   gssize res;
6840   gboolean ret;
6841
6842   g_return_val_if_fail (G_IS_FILE (file), FALSE);
6843   g_return_val_if_fail (contents != NULL, FALSE);
6844
6845   out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
6846   if (out == NULL)
6847     return FALSE;
6848
6849   pos = 0;
6850   remainder = length;
6851   while (remainder > 0 &&
6852          (res = g_output_stream_write (G_OUTPUT_STREAM (out),
6853                                        contents + pos,
6854                                        MIN (remainder, GET_CONTENT_BLOCK_SIZE),
6855                                        cancellable,
6856                                        error)) > 0)
6857     {
6858       pos += res;
6859       remainder -= res;
6860     }
6861
6862   if (remainder > 0 && res < 0)
6863     {
6864       /* Ignore errors on close */
6865       g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
6866       g_object_unref (out);
6867
6868       /* error is set already */
6869       return FALSE;
6870     }
6871
6872   ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
6873
6874   if (new_etag)
6875     *new_etag = g_file_output_stream_get_etag (out);
6876
6877   g_object_unref (out);
6878
6879   return ret;
6880 }
6881
6882 typedef struct {
6883   GTask *task;
6884   const char *content;
6885   gsize length;
6886   gsize pos;
6887   char *etag;
6888   gboolean failed;
6889 } ReplaceContentsData;
6890
6891 static void
6892 replace_contents_data_free (ReplaceContentsData *data)
6893 {
6894   g_free (data->etag);
6895   g_free (data);
6896 }
6897
6898 static void
6899 replace_contents_close_callback (GObject      *obj,
6900                                  GAsyncResult *close_res,
6901                                  gpointer      user_data)
6902 {
6903   GOutputStream *stream = G_OUTPUT_STREAM (obj);
6904   ReplaceContentsData *data = user_data;
6905
6906   /* Ignore errors here, we're only reading anyway */
6907   g_output_stream_close_finish (stream, close_res, NULL);
6908   g_object_unref (stream);
6909
6910   if (!data->failed)
6911     {
6912       data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
6913       g_task_return_boolean (data->task, TRUE);
6914     }
6915   g_object_unref (data->task);
6916 }
6917
6918 static void
6919 replace_contents_write_callback (GObject      *obj,
6920                                  GAsyncResult *read_res,
6921                                  gpointer      user_data)
6922 {
6923   GOutputStream *stream = G_OUTPUT_STREAM (obj);
6924   ReplaceContentsData *data = user_data;
6925   GError *error = NULL;
6926   gssize write_size;
6927
6928   write_size = g_output_stream_write_finish (stream, read_res, &error);
6929
6930   if (write_size <= 0)
6931     {
6932       /* Error or EOF, close the file */
6933       if (write_size < 0)
6934         {
6935           data->failed = TRUE;
6936           g_task_return_error (data->task, error);
6937         }
6938       g_output_stream_close_async (stream, 0,
6939                                    g_task_get_cancellable (data->task),
6940                                    replace_contents_close_callback, data);
6941     }
6942   else if (write_size > 0)
6943     {
6944       data->pos += write_size;
6945
6946       if (data->pos >= data->length)
6947         g_output_stream_close_async (stream, 0,
6948                                      g_task_get_cancellable (data->task),
6949                                      replace_contents_close_callback, data);
6950       else
6951         g_output_stream_write_async (stream,
6952                                      data->content + data->pos,
6953                                      data->length - data->pos,
6954                                      0,
6955                                      g_task_get_cancellable (data->task),
6956                                      replace_contents_write_callback,
6957                                      data);
6958     }
6959 }
6960
6961 static void
6962 replace_contents_open_callback (GObject      *obj,
6963                                 GAsyncResult *open_res,
6964                                 gpointer      user_data)
6965 {
6966   GFile *file = G_FILE (obj);
6967   GFileOutputStream *stream;
6968   ReplaceContentsData *data = user_data;
6969   GError *error = NULL;
6970
6971   stream = g_file_replace_finish (file, open_res, &error);
6972
6973   if (stream)
6974     {
6975       g_output_stream_write_async (G_OUTPUT_STREAM (stream),
6976                                    data->content + data->pos,
6977                                    data->length - data->pos,
6978                                    0,
6979                                    g_task_get_cancellable (data->task),
6980                                    replace_contents_write_callback,
6981                                    data);
6982     }
6983   else
6984     {
6985       g_task_return_error (data->task, error);
6986       g_object_unref (data->task);
6987     }
6988 }
6989
6990 /**
6991  * g_file_replace_contents_async:
6992  * @file: input #GFile
6993  * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
6994  * @length: the length of @contents in bytes
6995  * @etag: (allow-none): a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
6996  * @make_backup: %TRUE if a backup should be created
6997  * @flags: a set of #GFileCreateFlags
6998  * @cancellable: optional #GCancellable object, %NULL to ignore
6999  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7000  * @user_data: the data to pass to callback function
7001  *
7002  * Starts an asynchronous replacement of @file with the given
7003  * @contents of @length bytes. @etag will replace the document's
7004  * current entity tag.
7005  *
7006  * When this operation has completed, @callback will be called with
7007  * @user_user data, and the operation can be finalized with
7008  * g_file_replace_contents_finish().
7009  *
7010  * If @cancellable is not %NULL, then the operation can be cancelled by
7011  * triggering the cancellable object from another thread. If the operation
7012  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7013  *
7014  * If @make_backup is %TRUE, this function will attempt to
7015  * make a backup of @file.
7016  */
7017 void
7018 g_file_replace_contents_async  (GFile               *file,
7019                                 const char          *contents,
7020                                 gsize                length,
7021                                 const char          *etag,
7022                                 gboolean             make_backup,
7023                                 GFileCreateFlags     flags,
7024                                 GCancellable        *cancellable,
7025                                 GAsyncReadyCallback  callback,
7026                                 gpointer             user_data)
7027 {
7028   ReplaceContentsData *data;
7029
7030   g_return_if_fail (G_IS_FILE (file));
7031   g_return_if_fail (contents != NULL);
7032
7033   data = g_new0 (ReplaceContentsData, 1);
7034
7035   data->content = contents;
7036   data->length = length;
7037
7038   data->task = g_task_new (file, cancellable, callback, user_data);
7039   g_task_set_task_data (data->task, data, (GDestroyNotify)replace_contents_data_free);
7040
7041   g_file_replace_async (file,
7042                         etag,
7043                         make_backup,
7044                         flags,
7045                         0,
7046                         g_task_get_cancellable (data->task),
7047                         replace_contents_open_callback,
7048                         data);
7049 }
7050
7051 /**
7052  * g_file_replace_contents_finish:
7053  * @file: input #GFile
7054  * @res: a #GAsyncResult
7055  * @new_etag: (out) (allow-none): a location of a new <link linkend="gfile-etag">entity tag</link>
7056  *     for the document. This should be freed with g_free() when it is no
7057  *     longer needed, or %NULL
7058  * @error: a #GError, or %NULL
7059  *
7060  * Finishes an asynchronous replace of the given @file. See
7061  * g_file_replace_contents_async(). Sets @new_etag to the new entity
7062  * tag for the document, if present.
7063  *
7064  * Returns: %TRUE on success, %FALSE on failure.
7065  */
7066 gboolean
7067 g_file_replace_contents_finish (GFile         *file,
7068                                 GAsyncResult  *res,
7069                                 char         **new_etag,
7070                                 GError       **error)
7071 {
7072   GTask *task;
7073   ReplaceContentsData *data;
7074
7075   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7076   g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
7077
7078   task = G_TASK (res);
7079
7080   if (!g_task_propagate_boolean (task, error))
7081     return FALSE;
7082
7083   data = g_task_get_task_data (task);
7084
7085   if (new_etag)
7086     {
7087       *new_etag = data->etag;
7088       data->etag = NULL; /* Take ownership */
7089     }
7090
7091   return TRUE;
7092 }
7093
7094 /**
7095  * g_file_start_mountable:
7096  * @file: input #GFile
7097  * @flags: flags affecting the operation
7098  * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction
7099  * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
7100  * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7101  * @user_data: the data to pass to callback function
7102  *
7103  * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7104  * Using @start_operation, you can request callbacks when, for instance,
7105  * passwords are needed during authentication.
7106  *
7107  * If @cancellable is not %NULL, then the operation can be cancelled by
7108  * triggering the cancellable object from another thread. If the operation
7109  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7110  *
7111  * When the operation is finished, @callback will be called.
7112  * You can then call g_file_mount_mountable_finish() to get
7113  * the result of the operation.
7114  *
7115  * Since: 2.22
7116  */
7117 void
7118 g_file_start_mountable (GFile               *file,
7119                         GDriveStartFlags     flags,
7120                         GMountOperation     *start_operation,
7121                         GCancellable        *cancellable,
7122                         GAsyncReadyCallback  callback,
7123                         gpointer             user_data)
7124 {
7125   GFileIface *iface;
7126
7127   g_return_if_fail (G_IS_FILE (file));
7128
7129   iface = G_FILE_GET_IFACE (file);
7130
7131   if (iface->start_mountable == NULL)
7132     {
7133       g_task_report_new_error (file, callback, user_data,
7134                                g_file_start_mountable,
7135                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7136                                _("Operation not supported"));
7137       return;
7138     }
7139
7140   (* iface->start_mountable) (file,
7141                               flags,
7142                               start_operation,
7143                               cancellable,
7144                               callback,
7145                               user_data);
7146 }
7147
7148 /**
7149  * g_file_start_mountable_finish:
7150  * @file: input #GFile
7151  * @result: a #GAsyncResult
7152  * @error: a #GError, or %NULL
7153  *
7154  * Finishes a start operation. See g_file_start_mountable() for details.
7155  *
7156  * Finish an asynchronous start operation that was started
7157  * with g_file_start_mountable().
7158  *
7159  * Returns: %TRUE if the operation finished successfully. %FALSE
7160  * otherwise.
7161  *
7162  * Since: 2.22
7163  */
7164 gboolean
7165 g_file_start_mountable_finish (GFile         *file,
7166                                GAsyncResult  *result,
7167                                GError       **error)
7168 {
7169   GFileIface *iface;
7170
7171   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7172   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7173
7174   if (g_async_result_legacy_propagate_error (result, error))
7175     return FALSE;
7176   else if (g_async_result_is_tagged (result, g_file_start_mountable))
7177     return g_task_propagate_boolean (G_TASK (result), error);
7178
7179   iface = G_FILE_GET_IFACE (file);
7180   return (* iface->start_mountable_finish) (file, result, error);
7181 }
7182
7183 /**
7184  * g_file_stop_mountable:
7185  * @file: input #GFile
7186  * @flags: flags affecting the operation
7187  * @mount_operation: (allow-none): a #GMountOperation,
7188  *     or %NULL to avoid user interaction.
7189  * @cancellable: (allow-none): optional #GCancellable object,
7190  *     %NULL to ignore
7191  * @callback: (allow-none): a #GAsyncReadyCallback to call
7192  *     when the request is satisfied, or %NULL
7193  * @user_data: the data to pass to callback function
7194  *
7195  * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
7196  *
7197  * If @cancellable is not %NULL, then the operation can be cancelled by
7198  * triggering the cancellable object from another thread. If the operation
7199  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7200  *
7201  * When the operation is finished, @callback will be called.
7202  * You can then call g_file_stop_mountable_finish() to get
7203  * the result of the operation.
7204  *
7205  * Since: 2.22
7206  */
7207 void
7208 g_file_stop_mountable (GFile               *file,
7209                        GMountUnmountFlags   flags,
7210                        GMountOperation     *mount_operation,
7211                        GCancellable        *cancellable,
7212                        GAsyncReadyCallback  callback,
7213                        gpointer             user_data)
7214 {
7215   GFileIface *iface;
7216
7217   g_return_if_fail (G_IS_FILE (file));
7218
7219   iface = G_FILE_GET_IFACE (file);
7220
7221   if (iface->stop_mountable == NULL)
7222     {
7223       g_task_report_new_error (file, callback, user_data,
7224                                g_file_stop_mountable,
7225                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7226                                _("Operation not supported"));
7227       return;
7228     }
7229
7230   (* iface->stop_mountable) (file,
7231                              flags,
7232                              mount_operation,
7233                              cancellable,
7234                              callback,
7235                              user_data);
7236 }
7237
7238 /**
7239  * g_file_stop_mountable_finish:
7240  * @file: input #GFile
7241  * @result: a #GAsyncResult
7242  * @error: a #GError, or %NULL
7243  *
7244  * Finishes an stop operation, see g_file_stop_mountable() for details.
7245  *
7246  * Finish an asynchronous stop operation that was started
7247  * with g_file_stop_mountable().
7248  *
7249  * Returns: %TRUE if the operation finished successfully.
7250  *     %FALSE otherwise.
7251  *
7252  * Since: 2.22
7253  */
7254 gboolean
7255 g_file_stop_mountable_finish (GFile         *file,
7256                               GAsyncResult  *result,
7257                               GError       **error)
7258 {
7259   GFileIface *iface;
7260
7261   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7262   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7263
7264   if (g_async_result_legacy_propagate_error (result, error))
7265     return FALSE;
7266   else if (g_async_result_is_tagged (result, g_file_stop_mountable))
7267     return g_task_propagate_boolean (G_TASK (result), error);
7268
7269   iface = G_FILE_GET_IFACE (file);
7270   return (* iface->stop_mountable_finish) (file, result, error);
7271 }
7272
7273 /**
7274  * g_file_poll_mountable:
7275  * @file: input #GFile
7276  * @cancellable: optional #GCancellable object, %NULL to ignore
7277  * @callback: (allow-none): a #GAsyncReadyCallback to call
7278  *     when the request is satisfied, or %NULL
7279  * @user_data: the data to pass to callback function
7280  *
7281  * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
7282  *
7283  * If @cancellable is not %NULL, then the operation can be cancelled by
7284  * triggering the cancellable object from another thread. If the operation
7285  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7286  *
7287  * When the operation is finished, @callback will be called.
7288  * You can then call g_file_mount_mountable_finish() to get
7289  * the result of the operation.
7290  *
7291  * Since: 2.22
7292  */
7293 void
7294 g_file_poll_mountable (GFile               *file,
7295                        GCancellable        *cancellable,
7296                        GAsyncReadyCallback  callback,
7297                        gpointer             user_data)
7298 {
7299   GFileIface *iface;
7300
7301   g_return_if_fail (G_IS_FILE (file));
7302
7303   iface = G_FILE_GET_IFACE (file);
7304
7305   if (iface->poll_mountable == NULL)
7306     {
7307       g_task_report_new_error (file, callback, user_data,
7308                                g_file_poll_mountable,
7309                                G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7310                                _("Operation not supported"));
7311       return;
7312     }
7313
7314   (* iface->poll_mountable) (file,
7315                              cancellable,
7316                              callback,
7317                              user_data);
7318 }
7319
7320 /**
7321  * g_file_poll_mountable_finish:
7322  * @file: input #GFile
7323  * @result: a #GAsyncResult
7324  * @error: a #GError, or %NULL
7325  *
7326  * Finishes a poll operation. See g_file_poll_mountable() for details.
7327  *
7328  * Finish an asynchronous poll operation that was polled
7329  * with g_file_poll_mountable().
7330  *
7331  * Returns: %TRUE if the operation finished successfully. %FALSE
7332  * otherwise.
7333  *
7334  * Since: 2.22
7335  */
7336 gboolean
7337 g_file_poll_mountable_finish (GFile         *file,
7338                               GAsyncResult  *result,
7339                               GError       **error)
7340 {
7341   GFileIface *iface;
7342
7343   g_return_val_if_fail (G_IS_FILE (file), FALSE);
7344   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7345
7346   if (g_async_result_legacy_propagate_error (result, error))
7347     return FALSE;
7348   else if (g_async_result_is_tagged (result, g_file_poll_mountable))
7349     return g_task_propagate_boolean (G_TASK (result), error);
7350
7351   iface = G_FILE_GET_IFACE (file);
7352   return (* iface->poll_mountable_finish) (file, result, error);
7353 }
7354
7355 /**
7356  * g_file_supports_thread_contexts:
7357  * @file: a #GFile
7358  *
7359  * Checks if @file supports <link
7360  * linkend="g-main-context-push-thread-default-context">thread-default
7361  * contexts</link>. If this returns %FALSE, you cannot perform
7362  * asynchronous operations on @file in a thread that has a
7363  * thread-default context.
7364  *
7365  * Returns: Whether or not @file supports thread-default contexts.
7366  *
7367  * Since: 2.22
7368  */
7369 gboolean
7370 g_file_supports_thread_contexts (GFile *file)
7371 {
7372  GFileIface *iface;
7373
7374  g_return_val_if_fail (G_IS_FILE (file), FALSE);
7375
7376  iface = G_FILE_GET_IFACE (file);
7377  return iface->supports_thread_contexts;
7378 }