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 #include <string.h>
  27 #include <sys/types.h>
  28 #ifdef HAVE_PWD_H
  29 #include <pwd.h>
  30 #endif
  31 #include "gfile.h"
  32 #include "gvfs.h"
  33 #include "gioscheduler.h"
  34 #include "glocalfile.h"
  35 #include "gsimpleasyncresult.h"
  36 #include "gfileattribute-priv.h"
  37 #include "gpollfilemonitor.h"
  38 #include "gappinfo.h"
  39 #include "gfileinputstream.h"
  40 #include "gfileoutputstream.h"
  41 #include "gcancellable.h"
  42 #include "gasyncresult.h"
  43 #include "gioerror.h"
  44 #include "glibintl.h"
  45
  46 #include "gioalias.h"
  47
  48 /**
  49  * SECTION:gfile
  50  * @short_description: File and Directory Handling
  51  * @include: gio/gio.h
  52  * @see_also: #GFileInfo, #GFileEnumerator
  53  *
  54  * #GFile is a high level abstraction for manipulating files on a
  55  * virtual file system. #GFile<!-- -->s are lightweight, immutable
  56  * objects that do no I/O upon creation. It is necessary to understand that
  57  * #GFile objects do not represent files, merely an identifier for a file. All
  58  * file content I/O is implemented as streaming operations (see #GInputStream and
  59  * #GOutputStream).
  60  *
  61  * To construct a #GFile, you can use:
  62  * g_file_new_for_path() if you have a path.
  63  * g_file_new_for_uri() if you have a URI.
  64  * g_file_new_for_commandline_arg() for a command line argument.
  65  * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name().
  66  *
  67  * One way to think of a #GFile is as an abstraction of a pathname. For normal
  68  * files the system pathname is what is stored internally, but as #GFile<!-- -->s
  69  * are extensible it could also be something else that corresponds to a pathname
  70  * in a userspace implementation of a filesystem.
  71  *
  72  * #GFile<!-- -->s make up hierarchies of directories and files that correspond to the
  73  * files on a filesystem. You can move through the file system with #GFile using
  74  * g_file_get_parent() to get an identifier for the parent directory, g_file_get_child()
  75  * to get a child within a directory, g_file_resolve_relative_path() to resolve a relative
  76  * path between two #GFile<!-- -->s. There can be multiple hierarchies, so you may not
  77  * end up at the same root if you repeatedly call g_file_get_parent() on two different
  78  * files.
  79  *
  80  * All #GFile<!-- -->s have a basename (get with g_file_get_basename()). These names
  81  * are byte strings that are used to identify the file on the filesystem (relative to
  82  * its parent directory) and there is no guarantees that they have any particular charset
  83  * encoding or even make any sense at all. If you want to use filenames in a user
  84  * interface you should use the display name that you can get by requesting the
  85  * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
  86  * This is guaranteed to be in utf8 and can be used in a user interface. But always
  87  * store the real basename or the #GFile to use to actually access the file, because
  88  * there is no way to go from a display name to the actual name.
  89  *
  90  * Using #GFile as an identifier has the same weaknesses as using a path in that
  91  * there may be multiple aliases for the same file. For instance, hard or
  92  * soft links may cause two different #GFile<!-- -->s to refer to the same file.
  93  * Other possible causes for aliases are: case insensitive filesystems, short
  94  * and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if
  95  * two #GFile<!-- -->s point to the same file you can query for the
  96  * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
  97  * canonicalization of pathnames passed in, so that trivial differences in the
  98  * path string used at creation (duplicated slashes, slash at end of path, "."
  99  * or ".." path segments, etc) does not create different #GFile<!-- -->s.
 100  *
 101  * Many #GFile operations have both synchronous and asynchronous versions
 102  * to suit your application. Asynchronous versions of synchronous functions
 103  * simply have _async() appended to their function names. The asynchronous
 104  * I/O functions call a #GAsyncReadyCallback which is then used to finalize
 105  * the operation, producing a GAsyncResult which is then passed to the
 106  * function's matching _finish() operation.
 107  *
 108  * Some #GFile operations do not have synchronous analogs, as they may
 109  * take a very long time to finish, and blocking may leave an application
 110  * unusable. Notable cases include:
 111  * g_file_mount_mountable() to mount a mountable file.
 112  * g_file_unmount_mountable() to unmount a mountable file.
 113  * g_file_eject_mountable() to eject a mountable file.
 114  *
 115  * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
 116  * One notable feature of #GFile<!-- -->s are entity tags, or "etags" for
 117  * short. Entity tags are somewhat like a more abstract version of the
 118  * traditional mtime, and can be used to quickly determine if the file has
 119  * been modified from the version on the file system. See the HTTP 1.1
 120  * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
 121  * for HTTP Etag headers, which are a very similar concept.
 122  * </para>
 123  **/
 124
 125 static void g_file_base_init (gpointer g_class);
 126 static void g_file_class_init (gpointer g_class,
 127                                gpointer class_data);
 128
 129 static void               g_file_real_query_info_async            (GFile                  *file,
 130                                                                    const char             *attributes,
 131                                                                    GFileQueryInfoFlags     flags,
 132                                                                    int                     io_priority,
 133                                                                    GCancellable           *cancellable,
 134                                                                    GAsyncReadyCallback     callback,
 135                                                                    gpointer                user_data);
 136 static GFileInfo *        g_file_real_query_info_finish           (GFile                  *file,
 137                                                                    GAsyncResult           *res,
 138                                                                    GError                **error);
 139 static void               g_file_real_query_filesystem_info_async (GFile                  *file,
 140                                                                    const char             *attributes,
 141                                                                    int                     io_priority,
 142                                                                    GCancellable           *cancellable,
 143                                                                    GAsyncReadyCallback     callback,
 144                                                                    gpointer                user_data);
 145 static GFileInfo *        g_file_real_query_filesystem_info_finish (GFile                  *file,
 146                                                                    GAsyncResult           *res,
 147                                                                    GError                **error);
 148 static void               g_file_real_enumerate_children_async    (GFile                  *file,
 149                                                                    const char             *attributes,
 150                                                                    GFileQueryInfoFlags     flags,
 151                                                                    int                     io_priority,
 152                                                                    GCancellable           *cancellable,
 153                                                                    GAsyncReadyCallback     callback,
 154                                                                    gpointer                user_data);
 155 static GFileEnumerator *  g_file_real_enumerate_children_finish   (GFile                  *file,
 156                                                                    GAsyncResult           *res,
 157                                                                    GError                **error);
 158 static void               g_file_real_read_async                  (GFile                  *file,
 159                                                                    int                     io_priority,
 160                                                                    GCancellable           *cancellable,
 161                                                                    GAsyncReadyCallback     callback,
 162                                                                    gpointer                user_data);
 163 static GFileInputStream * g_file_real_read_finish                 (GFile                  *file,
 164                                                                    GAsyncResult           *res,
 165                                                                    GError                **error);
 166 static void               g_file_real_append_to_async             (GFile                  *file,
 167                                                                    GFileCreateFlags        flags,
 168                                                                    int                     io_priority,
 169                                                                    GCancellable           *cancellable,
 170                                                                    GAsyncReadyCallback     callback,
 171                                                                    gpointer                user_data);
 172 static GFileOutputStream *g_file_real_append_to_finish            (GFile                  *file,
 173                                                                    GAsyncResult           *res,
 174                                                                    GError                **error);
 175 static void               g_file_real_create_async                (GFile                  *file,
 176                                                                    GFileCreateFlags        flags,
 177                                                                    int                     io_priority,
 178                                                                    GCancellable           *cancellable,
 179                                                                    GAsyncReadyCallback     callback,
 180                                                                    gpointer                user_data);
 181 static GFileOutputStream *g_file_real_create_finish               (GFile                  *file,
 182                                                                    GAsyncResult           *res,
 183                                                                    GError                **error);
 184 static void               g_file_real_replace_async               (GFile                  *file,
 185                                                                    const char             *etag,
 186                                                                    gboolean                make_backup,
 187                                                                    GFileCreateFlags        flags,
 188                                                                    int                     io_priority,
 189                                                                    GCancellable           *cancellable,
 190                                                                    GAsyncReadyCallback     callback,
 191                                                                    gpointer                user_data);
 192 static GFileOutputStream *g_file_real_replace_finish              (GFile                  *file,
 193                                                                    GAsyncResult           *res,
 194                                                                    GError                **error);
 195 static gboolean           g_file_real_set_attributes_from_info    (GFile                  *file,
 196                                                                    GFileInfo              *info,
 197                                                                    GFileQueryInfoFlags     flags,
 198                                                                    GCancellable           *cancellable,
 199                                                                    GError                **error);
 200 static void               g_file_real_set_display_name_async      (GFile                  *file,
 201                                                                    const char             *display_name,
 202                                                                    int                     io_priority,
 203                                                                    GCancellable           *cancellable,
 204                                                                    GAsyncReadyCallback     callback,
 205                                                                    gpointer                user_data);
 206 static GFile *            g_file_real_set_display_name_finish     (GFile                  *file,
 207                                                                    GAsyncResult           *res,
 208                                                                    GError                **error);
 209 static void               g_file_real_set_attributes_async        (GFile                  *file,
 210                                                                    GFileInfo              *info,
 211                                                                    GFileQueryInfoFlags     flags,
 212                                                                    int                     io_priority,
 213                                                                    GCancellable           *cancellable,
 214                                                                    GAsyncReadyCallback     callback,
 215                                                                    gpointer                user_data);
 216 static gboolean           g_file_real_set_attributes_finish       (GFile                  *file,
 217                                                                    GAsyncResult           *res,
 218                                                                    GFileInfo             **info,
 219                                                                    GError                **error);
 220 static void               g_file_real_find_enclosing_mount_async  (GFile                  *file,
 221                                                                    int                     io_priority,
 222                                                                    GCancellable           *cancellable,
 223                                                                    GAsyncReadyCallback     callback,
 224                                                                    gpointer                user_data);
 225 static GMount *           g_file_real_find_enclosing_mount_finish (GFile                  *file,
 226                                                                    GAsyncResult           *res,
 227                                                                    GError                **error);
 228 static void               g_file_real_copy_async                  (GFile                  *source,
 229                                                                    GFile                  *destination,
 230                                                                    GFileCopyFlags          flags,
 231                                                                    int                     io_priority,
 232                                                                    GCancellable           *cancellable,
 233                                                                    GFileProgressCallback   progress_callback,
 234                                                                    gpointer                progress_callback_data,
 235                                                                    GAsyncReadyCallback     callback,
 236                                                                    gpointer                user_data);
 237 static gboolean           g_file_real_copy_finish                 (GFile                  *file,
 238                                                                    GAsyncResult           *res,
 239                                                                    GError                **error);
 240
 241 GType
 242 g_file_get_type (void)
 243 {
 244   static volatile gsize g_define_type_id__volatile = 0;
 245
 246   if (g_once_init_enter (&g_define_type_id__volatile))
 247     {
 248       const GTypeInfo file_info =
 249       {
 250         sizeof (GFileIface), /* class_size */
 251         g_file_base_init,   /* base_init */
 252         NULL,           /* base_finalize */
 253         g_file_class_init,
 254         NULL,           /* class_finalize */
 255         NULL,           /* class_data */
 256         0,
 257         0,              /* n_preallocs */
 258         NULL
 259       };
 260       GType g_define_type_id =
 261         g_type_register_static (G_TYPE_INTERFACE, I_("GFile"),
 262                                 &file_info, 0);
 263
 264       g_type_interface_add_prerequisite (g_define_type_id, G_TYPE_OBJECT);
 265
 266       g_once_init_leave (&g_define_type_id__volatile, g_define_type_id);
 267     }
 268
 269   return g_define_type_id__volatile;
 270 }
 271
 272 static void
 273 g_file_class_init (gpointer g_class,
 274                    gpointer class_data)
 275 {
 276   GFileIface *iface = g_class;
 277
 278   iface->enumerate_children_async = g_file_real_enumerate_children_async;
 279   iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
 280   iface->set_display_name_async = g_file_real_set_display_name_async;
 281   iface->set_display_name_finish = g_file_real_set_display_name_finish;
 282   iface->query_info_async = g_file_real_query_info_async;
 283   iface->query_info_finish = g_file_real_query_info_finish;
 284   iface->query_filesystem_info_async = g_file_real_query_filesystem_info_async;
 285   iface->query_filesystem_info_finish = g_file_real_query_filesystem_info_finish;
 286   iface->set_attributes_async = g_file_real_set_attributes_async;
 287   iface->set_attributes_finish = g_file_real_set_attributes_finish;
 288   iface->read_async = g_file_real_read_async;
 289   iface->read_finish = g_file_real_read_finish;
 290   iface->append_to_async = g_file_real_append_to_async;
 291   iface->append_to_finish = g_file_real_append_to_finish;
 292   iface->create_async = g_file_real_create_async;
 293   iface->create_finish = g_file_real_create_finish;
 294   iface->replace_async = g_file_real_replace_async;
 295   iface->replace_finish = g_file_real_replace_finish;
 296   iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
 297   iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
 298   iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
 299   iface->copy_async = g_file_real_copy_async;
 300   iface->copy_finish = g_file_real_copy_finish;
 301 }
 302
 303 static void
 304 g_file_base_init (gpointer g_class)
 305 {
 306 }
 307
 308
 309 /**
 310  * g_file_is_native:
 311  * @file: input #GFile.
 312  *
 313  * Checks to see if a file is native to the platform.
 314  *
 315  * A native file s one expressed in the platform-native filename format,
 316  * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
 317  * as it might be on a locally mounted remote filesystem.
 318  *
 319  * On some systems non-native files may be available using
 320  * the native filesystem via a userspace filesystem (FUSE), in
 321  * these cases this call will return %FALSE, but g_file_get_path()
 322  * will still return a native path.
 323  *
 324  * This call does no blocking i/o.
 325  *
 326  * Returns: %TRUE if file is native.
 327  **/
 328 gboolean
 329 g_file_is_native (GFile *file)
 330 {
 331   GFileIface *iface;
 332
 333   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 334
 335   iface = G_FILE_GET_IFACE (file);
 336
 337   return (* iface->is_native) (file);
 338 }
 339
 340
 341 /**
 342  * g_file_has_uri_scheme:
 343  * @file: input #GFile.
 344  * @uri_scheme: a string containing a URI scheme.
 345  *
 346  * Checks to see if a #GFile has a given URI scheme.
 347  *
 348  * This call does no blocking i/o.
 349  *
 350  * Returns: %TRUE if #GFile's backend supports the
 351  *     given URI scheme, %FALSE if URI scheme is %NULL,
 352  *     not supported, or #GFile is invalid.
 353  **/
 354 gboolean
 355 g_file_has_uri_scheme (GFile      *file,
 356                        const char *uri_scheme)
 357 {
 358   GFileIface *iface;
 359
 360   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 361   g_return_val_if_fail (uri_scheme != NULL, FALSE);
 362
 363   iface = G_FILE_GET_IFACE (file);
 364
 365   return (* iface->has_uri_scheme) (file, uri_scheme);
 366 }
 367
 368
 369 /**
 370  * g_file_get_uri_scheme:
 371  * @file: input #GFile.
 372  *
 373  * Gets the URI scheme for a #GFile.
 374  * RFC 3986 decodes the scheme as:
 375  * <programlisting>
 376  * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
 377  * </programlisting>
 378  * Common schemes include "file", "http", "ftp", etc.
 379  *
 380  * This call does no blocking i/o.
 381  *
 382  * Returns: a string containing the URI scheme for the given
 383  *     #GFile. The returned string should be freed with g_free()
 384  *     when no longer needed.
 385  **/
 386 char *
 387 g_file_get_uri_scheme (GFile *file)
 388 {
 389   GFileIface *iface;
 390
 391   g_return_val_if_fail (G_IS_FILE (file), NULL);
 392
 393   iface = G_FILE_GET_IFACE (file);
 394
 395   return (* iface->get_uri_scheme) (file);
 396 }
 397
 398
 399 /**
 400  * g_file_get_basename:
 401  * @file: input #GFile.
 402  *
 403  * Gets the base name (the last component of the path) for a given #GFile.
 404  *
 405  * If called for the top level of a system (such as the filesystem root
 406  * or a uri like sftp://host/) it will return a single directory separator
 407  * (and on Windows, possibly a drive letter).
 408  *
 409  * The base name is a byte string (*not* UTF-8). It has no defined encoding
 410  * or rules other than it may not contain zero bytes.  If you want to use
 411  * filenames in a user interface you should use the display name that you
 412  * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
 413  * attribute with g_file_query_info().
 414  *
 415  * This call does no blocking i/o.
 416  *
 417  * Returns: string containing the #GFile's base name, or %NULL
 418  *     if given #GFile is invalid. The returned string should be
 419  *     freed with g_free() when no longer needed.
 420  **/
 421 char *
 422 g_file_get_basename (GFile *file)
 423 {
 424   GFileIface *iface;
 425
 426   g_return_val_if_fail (G_IS_FILE (file), NULL);
 427
 428   iface = G_FILE_GET_IFACE (file);
 429
 430   return (* iface->get_basename) (file);
 431 }
 432
 433 /**
 434  * g_file_get_path:
 435  * @file: input #GFile.
 436  *
 437  * Gets the local pathname for #GFile, if one exists.
 438  *
 439  * This call does no blocking i/o.
 440  *
 441  * Returns: string containing the #GFile's path, or %NULL if
 442  *     no such path exists. The returned string should be
 443  *     freed with g_free() when no longer needed.
 444  **/
 445 char *
 446 g_file_get_path (GFile *file)
 447 {
 448   GFileIface *iface;
 449
 450   g_return_val_if_fail (G_IS_FILE (file), NULL);
 451
 452   iface = G_FILE_GET_IFACE (file);
 453
 454   return (* iface->get_path) (file);
 455 }
 456
 457 /**
 458  * g_file_get_uri:
 459  * @file: input #GFile.
 460  *
 461  * Gets the URI for the @file.
 462  *
 463  * This call does no blocking i/o.
 464  *
 465  * Returns: a string containing the #GFile's URI.
 466  *     The returned string should be freed with g_free() when no longer needed.
 467  **/
 468 char *
 469 g_file_get_uri (GFile *file)
 470 {
 471   GFileIface *iface;
 472
 473   g_return_val_if_fail (G_IS_FILE (file), NULL);
 474
 475   iface = G_FILE_GET_IFACE (file);
 476
 477   return (* iface->get_uri) (file);
 478 }
 479
 480 /**
 481  * g_file_get_parse_name:
 482  * @file: input #GFile.
 483  *
 484  * Gets the parse name of the @file.
 485  * A parse name is a UTF-8 string that describes the
 486  * file such that one can get the #GFile back using
 487  * g_file_parse_name().
 488  *
 489  * This is generally used to show the #GFile as a nice
 490  * full-pathname kind of string in a user interface,
 491  * like in a location entry.
 492  *
 493  * For local files with names that can safely be converted
 494  * to UTF8 the pathname is used, otherwise the IRI is used
 495  * (a form of URI that allows UTF8 characters unescaped).
 496  *
 497  * This call does no blocking i/o.
 498  *
 499  * Returns: a string containing the #GFile's parse name. The returned
 500  *     string should be freed with g_free() when no longer needed.
 501  **/
 502 char *
 503 g_file_get_parse_name (GFile *file)
 504 {
 505   GFileIface *iface;
 506
 507   g_return_val_if_fail (G_IS_FILE (file), NULL);
 508
 509   iface = G_FILE_GET_IFACE (file);
 510
 511   return (* iface->get_parse_name) (file);
 512 }
 513
 514 /**
 515  * g_file_dup:
 516  * @file: input #GFile.
 517  *
 518  * Duplicates a #GFile handle. This operation does not duplicate
 519  * the actual file or directory represented by the #GFile; see
 520  * g_file_copy() if attempting to copy a file.
 521  *
 522  * This call does no blocking i/o.
 523  *
 524  * Returns: a new #GFile that is a duplicate of the given #GFile.
 525  **/
 526 GFile *
 527 g_file_dup (GFile *file)
 528 {
 529   GFileIface *iface;
 530
 531   g_return_val_if_fail (G_IS_FILE (file), NULL);
 532
 533   iface = G_FILE_GET_IFACE (file);
 534
 535   return (* iface->dup) (file);
 536 }
 537
 538 /**
 539  * g_file_hash:
 540  * @file: #gconstpointer to a #GFile.
 541  *
 542  * Creates a hash value for a #GFile.
 543  *
 544  * This call does no blocking i/o.
 545  *
 546  * Returns: 0 if @file is not a valid #GFile, otherwise an
 547  *     integer that can be used as hash value for the #GFile.
 548  *     This function is intended for easily hashing a #GFile to
 549  *     add to a #GHashTable or similar data structure.
 550  **/
 551 guint
 552 g_file_hash (gconstpointer file)
 553 {
 554   GFileIface *iface;
 555
 556   g_return_val_if_fail (G_IS_FILE (file), 0);
 557
 558   iface = G_FILE_GET_IFACE (file);
 559
 560   return (* iface->hash) ((GFile *)file);
 561 }
 562
 563 /**
 564  * g_file_equal:
 565  * @file1: the first #GFile.
 566  * @file2: the second #GFile.
 567  *
 568  * Checks equality of two given #GFile<!-- -->s. Note that two
 569  * #GFile<!-- -->s that differ can still refer to the same
 570  * file on the filesystem due to various forms of filename
 571  * aliasing.
 572  *
 573  * This call does no blocking i/o.
 574  *
 575  * Returns: %TRUE if @file1 and @file2 are equal.
 576  *     %FALSE if either is not a #GFile.
 577  **/
 578 gboolean
 579 g_file_equal (GFile *file1,
 580               GFile *file2)
 581 {
 582   GFileIface *iface;
 583
 584   g_return_val_if_fail (G_IS_FILE (file1), FALSE);
 585   g_return_val_if_fail (G_IS_FILE (file2), FALSE);
 586
 587   if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
 588     return FALSE;
 589
 590   iface = G_FILE_GET_IFACE (file1);
 591
 592   return (* iface->equal) (file1, file2);
 593 }
 594
 595
 596 /**
 597  * g_file_get_parent:
 598  * @file: input #GFile.
 599  *
 600  * Gets the parent directory for the @file.
 601  * If the @file represents the root directory of the
 602  * file system, then %NULL will be returned.
 603  *
 604  * This call does no blocking i/o.
 605  *
 606  * Returns: a #GFile structure to the parent of the given
 607  *     #GFile or %NULL if there is no parent.
 608  *     Free the returned object with g_object_unref().
 609  **/
 610 GFile *
 611 g_file_get_parent (GFile *file)
 612 {
 613   GFileIface *iface;
 614
 615   g_return_val_if_fail (G_IS_FILE (file), NULL);
 616
 617   iface = G_FILE_GET_IFACE (file);
 618
 619   return (* iface->get_parent) (file);
 620 }
 621
 622 /**
 623  * g_file_get_child:
 624  * @file: input #GFile.
 625  * @name: string containing the child's basename.
 626  *
 627  * Gets a child of @file with basename equal to @name.
 628  *
 629  * Note that the file with that specific name might not exist, but
 630  * you can still have a #GFile that points to it. You can use this
 631  * for instance to create that file.
 632  *
 633  * This call does no blocking i/o.
 634  *
 635  * Returns: a #GFile to a child specified by @name.
 636  *     Free the returned object with g_object_unref().
 637  **/
 638 GFile *
 639 g_file_get_child (GFile      *file,
 640                   const char *name)
 641 {
 642   g_return_val_if_fail (G_IS_FILE (file), NULL);
 643   g_return_val_if_fail (name != NULL, NULL);
 644
 645   return g_file_resolve_relative_path (file, name);
 646 }
 647
 648 /**
 649  * g_file_get_child_for_display_name:
 650  * @file: input #GFile.
 651  * @display_name: string to a possible child.
 652  * @error: #GError.
 653  *
 654  * Gets the child of @file for a given @display_name (i.e. a UTF8
 655  * version of the name). If this function fails, it returns %NULL and @error will be
 656  * set. This is very useful when constructing a GFile for a new file
 657  * and the user entered the filename in the user interface, for instance
 658  * when you select a directory and type a filename in the file selector.
 659  *
 660  * This call does no blocking i/o.
 661  *
 662  * Returns: a #GFile to the specified child, or
 663  *     %NULL if the display name couldn't be converted.
 664  *     Free the returned object with g_object_unref().
 665  **/
 666 GFile *
 667 g_file_get_child_for_display_name (GFile      *file,
 668                                    const char *display_name,
 669                                    GError **error)
 670 {
 671   GFileIface *iface;
 672
 673   g_return_val_if_fail (G_IS_FILE (file), NULL);
 674   g_return_val_if_fail (display_name != NULL, NULL);
 675
 676   iface = G_FILE_GET_IFACE (file);
 677
 678   return (* iface->get_child_for_display_name) (file, display_name, error);
 679 }
 680
 681 /**
 682  * g_file_has_prefix:
 683  * @file: input #GFile.
 684  * @prefix: input #GFile.
 685  *
 686  * Checks whether @file has the prefix specified by @prefix. In other word,
 687  * if the names of inital elements of @file<!-- -->s pathname match @prefix.
 688  *
 689  * This call does no i/o, as it works purely on names. As such it can
 690  * sometimes return %FALSE even if @file is inside a @prefix (from a
 691  * filesystem point of view), because the prefix of @file is an alias
 692  * of @prefix.
 693  *
 694  * Returns:  %TRUE if the @files's parent, grandparent, etc is @prefix.
 695  *     %FALSE otherwise.
 696  **/
 697 gboolean
 698 g_file_has_prefix (GFile *file,
 699                    GFile *prefix)
 700 {
 701   GFileIface *iface;
 702
 703   g_return_val_if_fail (G_IS_FILE (file), FALSE);
 704   g_return_val_if_fail (G_IS_FILE (prefix), FALSE);
 705
 706   if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix))
 707     return FALSE;
 708
 709   iface = G_FILE_GET_IFACE (file);
 710
 711   /* The vtable function differs in arg order since we're
 712      using the old contains_file call */
 713   return (* iface->prefix_matches) (prefix, file);
 714 }
 715
 716 /**
 717  * g_file_get_relative_path:
 718  * @parent: input #GFile.
 719  * @descendant: input #GFile.
 720  *
 721  * Gets the path for @descendant relative to @parent.
 722  *
 723  * This call does no blocking i/o.
 724  *
 725  * Returns: string with the relative path from @descendant
 726  *     to @parent, or %NULL if @descendant doesn't have @parent as prefix.
 727  *     The returned string should be freed with g_free() when no longer needed.
 728  **/
 729 char *
 730 g_file_get_relative_path (GFile *parent,
 731                           GFile *descendant)
 732 {
 733   GFileIface *iface;
 734
 735   g_return_val_if_fail (G_IS_FILE (parent), NULL);
 736   g_return_val_if_fail (G_IS_FILE (descendant), NULL);
 737
 738   if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
 739     return NULL;
 740
 741   iface = G_FILE_GET_IFACE (parent);
 742
 743   return (* iface->get_relative_path) (parent, descendant);
 744 }
 745
 746 /**
 747  * g_file_resolve_relative_path:
 748  * @file: input #GFile.
 749  * @relative_path: a given relative path string.
 750  *
 751  * Resolves a relative path for @file to an absolute path.
 752  *
 753  * This call does no blocking i/o.
 754  *
 755  * Returns: #GFile to the resolved path. %NULL if @relative_path
 756  *     is %NULL or if @file is invalid.
 757  *     Free the returned object with g_object_unref().
 758  **/
 759 GFile *
 760 g_file_resolve_relative_path (GFile      *file,
 761                               const char *relative_path)
 762 {
 763   GFileIface *iface;
 764
 765   g_return_val_if_fail (G_IS_FILE (file), NULL);
 766   g_return_val_if_fail (relative_path != NULL, NULL);
 767
 768   iface = G_FILE_GET_IFACE (file);
 769
 770   return (* iface->resolve_relative_path) (file, relative_path);
 771 }
 772
 773 /**
 774  * g_file_enumerate_children:
 775  * @file: input #GFile.
 776  * @attributes: an attribute query string.
 777  * @flags: a set of #GFileQueryInfoFlags.
 778  * @cancellable: optional #GCancellable object, %NULL to ignore.
 779  * @error: #GError for error reporting.
 780  *
 781  * Gets the requested information about the files in a directory. The result
 782  * is a #GFileEnumerator object that will give out #GFileInfo objects for
 783  * all the files in the directory.
 784  *
 785  * The @attribute value is a string that specifies the file attributes that
 786  * should be gathered. It is not an error if it's not possible to read a particular
 787  * requested attribute from a file - it just won't be set. @attribute should
 788  * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
 789  * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
 790  * namespace. An example attribute query be "standard::*,owner::user".
 791  * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
 792  *
 793  * If @cancellable is not %NULL, then the operation can be cancelled by
 794  * triggering the cancellable object from another thread. If the operation
 795  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
 796  *
 797  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
 798  * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
 799  * Other errors are possible too.
 800  *
 801  * Returns: A #GFileEnumerator if successful, %NULL on error.
 802  *     Free the returned object with g_object_unref().
 803  **/
 804 GFileEnumerator *
 805 g_file_enumerate_children (GFile                *file,
 806                            const char           *attributes,
 807                            GFileQueryInfoFlags   flags,
 808                            GCancellable         *cancellable,
 809                            GError              **error)
 810
 811 {
 812   GFileIface *iface;
 813
 814   g_return_val_if_fail (G_IS_FILE (file), NULL);
 815
 816   if (g_cancellable_set_error_if_cancelled (cancellable, error))
 817     return NULL;
 818
 819   iface = G_FILE_GET_IFACE (file);
 820
 821   if (iface->enumerate_children == NULL)
 822     {
 823       g_set_error_literal (error, G_IO_ERROR,
 824                            G_IO_ERROR_NOT_SUPPORTED,
 825                            _("Operation not supported"));
 826       return NULL;
 827     }
 828
 829   return (* iface->enumerate_children) (file, attributes, flags,
 830                                         cancellable, error);
 831 }
 832
 833 /**
 834  * g_file_enumerate_children_async:
 835  * @file: input #GFile.
 836  * @attributes: an attribute query string.
 837  * @flags: a set of #GFileQueryInfoFlags.
 838  * @io_priority: the <link linkend="io-priority">I/O priority</link>
 839  *     of the request.
 840  * @cancellable: optional #GCancellable object, %NULL to ignore.
 841  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
 842  * @user_data: the data to pass to callback function
 843  *
 844  * Asynchronously gets the requested information about the files in a directory. The result
 845  * is a #GFileEnumerator object that will give out #GFileInfo objects for
 846  * all the files in the directory.
 847  *
 848  * For more details, see g_file_enumerate_children() which is
 849  * the synchronous version of this call.
 850  *
 851  * When the operation is finished, @callback will be called. You can then call
 852  * g_file_enumerate_children_finish() to get the result of the operation.
 853  **/
 854 void
 855 g_file_enumerate_children_async (GFile               *file,
 856                                  const char          *attributes,
 857                                  GFileQueryInfoFlags  flags,
 858                                  int                  io_priority,
 859                                  GCancellable        *cancellable,
 860                                  GAsyncReadyCallback  callback,
 861                                  gpointer             user_data)
 862 {
 863   GFileIface *iface;
 864
 865   g_return_if_fail (G_IS_FILE (file));
 866
 867   iface = G_FILE_GET_IFACE (file);
 868   (* iface->enumerate_children_async) (file,
 869                                        attributes,
 870                                        flags,
 871                                        io_priority,
 872                                        cancellable,
 873                                        callback,
 874                                        user_data);
 875 }
 876
 877 /**
 878  * g_file_enumerate_children_finish:
 879  * @file: input #GFile.
 880  * @res: a #GAsyncResult.
 881  * @error: a #GError.
 882  *
 883  * Finishes an async enumerate children operation.
 884  * See g_file_enumerate_children_async().
 885  *
 886  * Returns: a #GFileEnumerator or %NULL if an error occurred.
 887  *     Free the returned object with g_object_unref().
 888  **/
 889 GFileEnumerator *
 890 g_file_enumerate_children_finish (GFile         *file,
 891                                   GAsyncResult  *res,
 892                                   GError       **error)
 893 {
 894   GFileIface *iface;
 895
 896   g_return_val_if_fail (G_IS_FILE (file), NULL);
 897   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
 898
 899   if (G_IS_SIMPLE_ASYNC_RESULT (res))
 900     {
 901       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
 902       if (g_simple_async_result_propagate_error (simple, error))
 903         return NULL;
 904     }
 905
 906   iface = G_FILE_GET_IFACE (file);
 907   return (* iface->enumerate_children_finish) (file, res, error);
 908 }
 909
 910 /**
 911  * g_file_query_exists:
 912  * @file: input #GFile.
 913  * @cancellable: optional #GCancellable object, %NULL to ignore.
 914  *
 915  * Utility function to check if a particular file exists. This is
 916  * implemented using g_file_query_info() and as such does blocking I/O.
 917  *
 918  * Note that in many cases it is racy to first check for file existence
 919  * and then execute something based on the outcome of that, because the
 920  * file might have been created or removed in between the operations. The
 921  * general approach to handling that is to not check, but just do the
 922  * operation and handle the errors as they come.
 923  *
 924  * As an example of race-free checking, take the case of reading a file, and
 925  * if it doesn't exist, creating it. There are two racy versions: read it, and
 926  * on error create it; and: check if it exists, if not create it. These
 927  * can both result in two processes creating the file (with perhaps a partially
 928  * written file as the result). The correct approach is to always try to create
 929  * the file with g_file_create() which will either atomically create the file
 930  * or fail with a G_IO_ERROR_EXISTS error.
 931  *
 932  * However, in many cases an existence check is useful in a user
 933  * interface, for instance to make a menu item sensitive/insensitive, so that
 934  * you don't have to fool users that something is possible and then just show
 935  * and error dialog. If you do this, you should make sure to also handle the
 936  * errors that can happen due to races when you execute the operation.
 937  *
 938  * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
 939  */
 940 gboolean
 941 g_file_query_exists (GFile *file,
 942                      GCancellable *cancellable)
 943 {
 944   GFileInfo *info;
 945
 946   g_return_val_if_fail (G_IS_FILE(file), FALSE);
 947
 948   info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
 949                             G_FILE_QUERY_INFO_NONE, cancellable, NULL);
 950   if (info != NULL)
 951     {
 952       g_object_unref (info);
 953       return TRUE;
 954     }
 955
 956   return FALSE;
 957 }
 958
 959 /**
 960  * g_file_query_file_type:
 961  * @file: input #GFile.
 962  * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info().
 963  * @cancellable: optional #GCancellable object, %NULL to ignore.
 964  *
 965  * Utility function to inspect the #GFileType of a file. This is
 966  * implemented using g_file_query_info() and as such does blocking I/O.
 967  *
 968  * The primary use case of this method is to check if a file is a regular file,
 969  * directory, or symlink.
 970  *
 971  * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file
 972  *          does not exist
 973  *
 974  * Since: 2.18
 975  */
 976 GFileType
 977 g_file_query_file_type (GFile *file,
 978                         GFileQueryInfoFlags   flags,
 979                         GCancellable *cancellable)
 980 {
 981   GFileInfo *info;
 982   GFileType file_type;
 983
 984   g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN);
 985   info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags,
 986                             cancellable, NULL);
 987   if (info != NULL)
 988     {
 989       file_type = g_file_info_get_file_type (info);
 990       g_object_unref (info);
 991     }
 992   else
 993     file_type = G_FILE_TYPE_UNKNOWN;
 994
 995   return file_type;
 996 }
 997
 998 /**
 999  * g_file_query_info:
1000  * @file: input #GFile.
1001  * @attributes: an attribute query string.
1002  * @flags: a set of #GFileQueryInfoFlags.
1003  * @cancellable: optional #GCancellable object, %NULL to ignore.
1004  * @error: a #GError.
1005  *
1006  * Gets the requested information about specified @file. The result
1007  * is a #GFileInfo object that contains key-value attributes (such as
1008  * the type or size of the file).
1009  *
1010  * The @attribute value is a string that specifies the file attributes that
1011  * should be gathered. It is not an error if it's not possible to read a particular
1012  * requested attribute from a file - it just won't be set. @attribute should
1013  * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
1014  * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
1015  * namespace. An example attribute query be "standard::*,owner::user".
1016  * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
1017  *
1018  * If @cancellable is not %NULL, then the operation can be cancelled by
1019  * triggering the cancellable object from another thread. If the operation
1020  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1021  *
1022  * For symlinks, normally the information about the target of the
1023  * symlink is returned, rather than information about the symlink itself.
1024  * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
1025  * information about the symlink itself will be returned. Also, for symlinks
1026  * that point to non-existing files the information about the symlink itself
1027  * will be returned.
1028  *
1029  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1030  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1031  *
1032  * Returns: a #GFileInfo for the given @file, or %NULL on error.
1033  *     Free the returned object with g_object_unref().
1034  **/
1035 GFileInfo *
1036 g_file_query_info (GFile                *file,
1037                    const char           *attributes,
1038                    GFileQueryInfoFlags   flags,
1039                    GCancellable         *cancellable,
1040                    GError              **error)
1041 {
1042   GFileIface *iface;
1043
1044   g_return_val_if_fail (G_IS_FILE (file), NULL);
1045
1046   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1047     return NULL;
1048
1049   iface = G_FILE_GET_IFACE (file);
1050
1051   if (iface->query_info == NULL)
1052     {
1053       g_set_error_literal (error, G_IO_ERROR,
1054                            G_IO_ERROR_NOT_SUPPORTED,
1055                            _("Operation not supported"));
1056       return NULL;
1057     }
1058
1059   return (* iface->query_info) (file, attributes, flags, cancellable, error);
1060 }
1061
1062 /**
1063  * g_file_query_info_async:
1064  * @file: input #GFile.
1065  * @attributes: an attribute query string.
1066  * @flags: a set of #GFileQueryInfoFlags.
1067  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1068  *     of the request.
1069  * @cancellable: optional #GCancellable object, %NULL to ignore.
1070  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1071  * @user_data: the data to pass to callback function
1072  *
1073  * Asynchronously gets the requested information about specified @file. The result
1074  * is a #GFileInfo object that contains key-value attributes (such as type or size
1075  * for the file).
1076  *
1077  * For more details, see g_file_query_info() which is
1078  * the synchronous version of this call.
1079  *
1080  * When the operation is finished, @callback will be called. You can then call
1081  * g_file_query_info_finish() to get the result of the operation.
1082  **/
1083 void
1084 g_file_query_info_async (GFile               *file,
1085                          const char          *attributes,
1086                          GFileQueryInfoFlags  flags,
1087                          int                  io_priority,
1088                          GCancellable        *cancellable,
1089                          GAsyncReadyCallback  callback,
1090                          gpointer             user_data)
1091 {
1092   GFileIface *iface;
1093
1094   g_return_if_fail (G_IS_FILE (file));
1095
1096   iface = G_FILE_GET_IFACE (file);
1097   (* iface->query_info_async) (file,
1098                                attributes,
1099                                flags,
1100                                io_priority,
1101                                cancellable,
1102                                callback,
1103                                user_data);
1104 }
1105
1106 /**
1107  * g_file_query_info_finish:
1108  * @file: input #GFile.
1109  * @res: a #GAsyncResult.
1110  * @error: a #GError.
1111  *
1112  * Finishes an asynchronous file info query.
1113  * See g_file_query_info_async().
1114  *
1115  * Returns: #GFileInfo for given @file or %NULL on error.
1116  *     Free the returned object with g_object_unref().
1117  **/
1118 GFileInfo *
1119 g_file_query_info_finish (GFile         *file,
1120                           GAsyncResult  *res,
1121                           GError       **error)
1122 {
1123   GFileIface *iface;
1124
1125   g_return_val_if_fail (G_IS_FILE (file), NULL);
1126   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1127
1128   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1129     {
1130       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1131       if (g_simple_async_result_propagate_error (simple, error))
1132         return NULL;
1133     }
1134
1135   iface = G_FILE_GET_IFACE (file);
1136   return (* iface->query_info_finish) (file, res, error);
1137 }
1138
1139 /**
1140  * g_file_query_filesystem_info:
1141  * @file: input #GFile.
1142  * @attributes:  an attribute query string.
1143  * @cancellable: optional #GCancellable object, %NULL to ignore.
1144  * @error: a #GError.
1145  *
1146  * Similar to g_file_query_info(), but obtains information
1147  * about the filesystem the @file is on, rather than the file itself.
1148  * For instance the amount of space available and the type of
1149  * the filesystem.
1150  *
1151  * The @attribute value is a string that specifies the file attributes that
1152  * should be gathered. It is not an error if it's not possible to read a particular
1153  * requested attribute from a file - it just won't be set. @attribute should
1154  * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
1155  * means all attributes, and a wildcard like "fs:*" means all attributes in the fs
1156  * namespace. The standard namespace for filesystem attributes is "fs".
1157  * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
1158  * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
1159  * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1160  *
1161  * If @cancellable is not %NULL, then the operation can be cancelled by
1162  * triggering the cancellable object from another thread. If the operation
1163  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1164  *
1165  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1166  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1167  *
1168  * Returns: a #GFileInfo or %NULL if there was an error.
1169  *     Free the returned object with g_object_unref().
1170  **/
1171 GFileInfo *
1172 g_file_query_filesystem_info (GFile         *file,
1173                               const char    *attributes,
1174                               GCancellable  *cancellable,
1175                               GError       **error)
1176 {
1177   GFileIface *iface;
1178
1179   g_return_val_if_fail (G_IS_FILE (file), NULL);
1180
1181   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1182     return NULL;
1183
1184   iface = G_FILE_GET_IFACE (file);
1185
1186   if (iface->query_filesystem_info == NULL)
1187     {
1188       g_set_error_literal (error, G_IO_ERROR,
1189                            G_IO_ERROR_NOT_SUPPORTED,
1190                            _("Operation not supported"));
1191       return NULL;
1192     }
1193
1194   return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1195 }
1196
1197 /**
1198  * g_file_query_filesystem_info_async:
1199  * @file: input #GFile.
1200  * @attributes: an attribute query string.
1201  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1202  *     of the request.
1203  * @cancellable: optional #GCancellable object, %NULL to ignore.
1204  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1205  * @user_data: the data to pass to callback function
1206  *
1207  * Asynchronously gets the requested information about the filesystem
1208  * that the specified @file is on. The result is a #GFileInfo object
1209  * that contains key-value attributes (such as type or size for the
1210  * file).
1211  *
1212  * For more details, see g_file_query_filesystem_info() which is the
1213  * synchronous version of this call.
1214  *
1215  * When the operation is finished, @callback will be called. You can
1216  * then call g_file_query_info_finish() to get the result of the
1217  * operation.
1218  **/
1219 void
1220 g_file_query_filesystem_info_async (GFile               *file,
1221                                     const char          *attributes,
1222                                     int                  io_priority,
1223                                     GCancellable        *cancellable,
1224                                     GAsyncReadyCallback  callback,
1225                                     gpointer             user_data)
1226 {
1227   GFileIface *iface;
1228
1229   g_return_if_fail (G_IS_FILE (file));
1230
1231   iface = G_FILE_GET_IFACE (file);
1232   (* iface->query_filesystem_info_async) (file,
1233                                           attributes,
1234                                           io_priority,
1235                                           cancellable,
1236                                           callback,
1237                                           user_data);
1238 }
1239
1240 /**
1241  * g_file_query_filesystem_info_finish:
1242  * @file: input #GFile.
1243  * @res: a #GAsyncResult.
1244  * @error: a #GError.
1245  *
1246  * Finishes an asynchronous filesystem info query.  See
1247  * g_file_query_filesystem_info_async().
1248  *
1249  * Returns: #GFileInfo for given @file or %NULL on error.
1250  *     Free the returned object with g_object_unref().
1251  **/
1252 GFileInfo *
1253 g_file_query_filesystem_info_finish (GFile         *file,
1254                                      GAsyncResult  *res,
1255                                      GError       **error)
1256 {
1257   GFileIface *iface;
1258
1259   g_return_val_if_fail (G_IS_FILE (file), NULL);
1260   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1261
1262   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1263     {
1264       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1265       if (g_simple_async_result_propagate_error (simple, error))
1266         return NULL;
1267     }
1268
1269   iface = G_FILE_GET_IFACE (file);
1270   return (* iface->query_filesystem_info_finish) (file, res, error);
1271 }
1272
1273 /**
1274  * g_file_find_enclosing_mount:
1275  * @file: input #GFile.
1276  * @cancellable: optional #GCancellable object, %NULL to ignore.
1277  * @error: a #GError.
1278  *
1279  * Gets a #GMount for the #GFile.
1280  *
1281  * If the #GFileIface for @file does not have a mount (e.g. possibly a
1282  * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
1283  * will be returned.
1284  *
1285  * If @cancellable is not %NULL, then the operation can be cancelled by
1286  * triggering the cancellable object from another thread. If the operation
1287  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1288  *
1289  * Returns: a #GMount where the @file is located or %NULL on error.
1290  *     Free the returned object with g_object_unref().
1291  **/
1292 GMount *
1293 g_file_find_enclosing_mount (GFile         *file,
1294                              GCancellable  *cancellable,
1295                              GError       **error)
1296 {
1297   GFileIface *iface;
1298
1299   g_return_val_if_fail (G_IS_FILE (file), NULL);
1300
1301   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1302     return NULL;
1303
1304   iface = G_FILE_GET_IFACE (file);
1305   if (iface->find_enclosing_mount == NULL)
1306     {
1307
1308       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
1309                         /* Translators: This is an error message when trying to find the
1310                          * enclosing (user visible) mount of a file, but none exists. */
1311                    _("Containing mount does not exist"));
1312       return NULL;
1313     }
1314
1315   return (* iface->find_enclosing_mount) (file, cancellable, error);
1316 }
1317
1318 /**
1319  * g_file_find_enclosing_mount_async:
1320  * @file: a #GFile
1321  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1322  *     of the request.
1323  * @cancellable: optional #GCancellable object, %NULL to ignore.
1324  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1325  * @user_data: the data to pass to callback function
1326  *
1327  * Asynchronously gets the mount for the file.
1328  *
1329  * For more details, see g_file_find_enclosing_mount() which is
1330  * the synchronous version of this call.
1331  *
1332  * When the operation is finished, @callback will be called. You can then call
1333  * g_file_find_enclosing_mount_finish() to get the result of the operation.
1334  */
1335 void
1336 g_file_find_enclosing_mount_async (GFile              *file,
1337                                    int                   io_priority,
1338                                    GCancellable         *cancellable,
1339                                    GAsyncReadyCallback   callback,
1340                                    gpointer              user_data)
1341 {
1342   GFileIface *iface;
1343
1344   g_return_if_fail (G_IS_FILE (file));
1345
1346   iface = G_FILE_GET_IFACE (file);
1347   (* iface->find_enclosing_mount_async) (file,
1348                                          io_priority,
1349                                          cancellable,
1350                                          callback,
1351                                          user_data);
1352 }
1353
1354 /**
1355  * g_file_find_enclosing_mount_finish:
1356  * @file: a #GFile
1357  * @res: a #GAsyncResult
1358  * @error: a #GError
1359  *
1360  * Finishes an asynchronous find mount request.
1361  * See g_file_find_enclosing_mount_async().
1362  *
1363  * Returns: #GMount for given @file or %NULL on error.
1364  *     Free the returned object with g_object_unref().
1365  **/
1366 GMount *
1367 g_file_find_enclosing_mount_finish (GFile         *file,
1368                                     GAsyncResult  *res,
1369                                     GError       **error)
1370 {
1371   GFileIface *iface;
1372
1373   g_return_val_if_fail (G_IS_FILE (file), NULL);
1374   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1375
1376   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1377     {
1378       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1379       if (g_simple_async_result_propagate_error (simple, error))
1380         return NULL;
1381     }
1382
1383   iface = G_FILE_GET_IFACE (file);
1384   return (* iface->find_enclosing_mount_finish) (file, res, error);
1385 }
1386
1387
1388 /**
1389  * g_file_read:
1390  * @file: #GFile to read.
1391  * @cancellable: a #GCancellable
1392  * @error: a #GError, or %NULL
1393  *
1394  * Opens a file for reading. The result is a #GFileInputStream that
1395  * can be used to read the contents of the file.
1396  *
1397  * If @cancellable is not %NULL, then the operation can be cancelled by
1398  * triggering the cancellable object from another thread. If the operation
1399  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1400  *
1401  * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1402  * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1403  * Other errors are possible too, and depend on what kind of filesystem the file is on.
1404  *
1405  * Returns: #GFileInputStream or %NULL on error.
1406  *     Free the returned object with g_object_unref().
1407  **/
1408 GFileInputStream *
1409 g_file_read (GFile         *file,
1410              GCancellable  *cancellable,
1411              GError       **error)
1412 {
1413   GFileIface *iface;
1414
1415   g_return_val_if_fail (G_IS_FILE (file), NULL);
1416
1417   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1418     return NULL;
1419
1420   iface = G_FILE_GET_IFACE (file);
1421
1422   if (iface->read_fn == NULL)
1423     {
1424       g_set_error_literal (error, G_IO_ERROR,
1425                            G_IO_ERROR_NOT_SUPPORTED,
1426                            _("Operation not supported"));
1427       return NULL;
1428     }
1429
1430   return (* iface->read_fn) (file, cancellable, error);
1431 }
1432
1433 /**
1434  * g_file_append_to:
1435  * @file: input #GFile.
1436  * @flags: a set of #GFileCreateFlags.
1437  * @cancellable: optional #GCancellable object, %NULL to ignore.
1438  * @error: a #GError, or %NULL
1439  *
1440  * Gets an output stream for appending data to the file. If
1441  * the file doesn't already exist it is created.
1442  *
1443  * By default files created are generally readable by everyone,
1444  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1445  * will be made readable only to the current user, to the level that
1446  * is supported on the target filesystem.
1447  *
1448  * If @cancellable is not %NULL, then the operation can be cancelled by
1449  * triggering the cancellable object from another thread. If the operation
1450  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1451  *
1452  * Some file systems don't allow all file names, and may
1453  * return an %G_IO_ERROR_INVALID_FILENAME error.
1454  * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
1455  * returned. Other errors are possible too, and depend on what kind of
1456  * filesystem the file is on.
1457  *
1458  * Returns: a #GFileOutputStream, or %NULL on error.
1459  *     Free the returned object with g_object_unref().
1460  **/
1461 GFileOutputStream *
1462 g_file_append_to (GFile             *file,
1463                   GFileCreateFlags   flags,
1464                   GCancellable      *cancellable,
1465                   GError           **error)
1466 {
1467   GFileIface *iface;
1468
1469   g_return_val_if_fail (G_IS_FILE (file), NULL);
1470
1471   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1472     return NULL;
1473
1474   iface = G_FILE_GET_IFACE (file);
1475
1476   if (iface->append_to == NULL)
1477     {
1478       g_set_error_literal (error, G_IO_ERROR,
1479                            G_IO_ERROR_NOT_SUPPORTED,
1480                            _("Operation not supported"));
1481       return NULL;
1482     }
1483
1484   return (* iface->append_to) (file, flags, cancellable, error);
1485 }
1486
1487 /**
1488  * g_file_create:
1489  * @file: input #GFile.
1490  * @flags: a set of #GFileCreateFlags.
1491  * @cancellable: optional #GCancellable object, %NULL to ignore.
1492  * @error: a #GError, or %NULL
1493  *
1494  * Creates a new file and returns an output stream for writing to it.
1495  * The file must not already exist.
1496  *
1497  * By default files created are generally readable by everyone,
1498  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1499  * will be made readable only to the current user, to the level that
1500  * is supported on the target filesystem.
1501  *
1502  * If @cancellable is not %NULL, then the operation can be cancelled by
1503  * triggering the cancellable object from another thread. If the operation
1504  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1505  *
1506  * If a file or directory with this name already exists the G_IO_ERROR_EXISTS
1507  * error will be returned.
1508  * Some file systems don't allow all file names, and may
1509  * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1510  * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1511  * Other errors are possible too, and depend on what kind of
1512  * filesystem the file is on.
1513  *
1514  * Returns: a #GFileOutputStream for the newly created file, or
1515  *     %NULL on error.
1516  *     Free the returned object with g_object_unref().
1517  **/
1518 GFileOutputStream *
1519 g_file_create (GFile             *file,
1520                GFileCreateFlags   flags,
1521                GCancellable      *cancellable,
1522                GError           **error)
1523 {
1524   GFileIface *iface;
1525
1526   g_return_val_if_fail (G_IS_FILE (file), NULL);
1527
1528   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1529     return NULL;
1530
1531   iface = G_FILE_GET_IFACE (file);
1532
1533   if (iface->create == NULL)
1534     {
1535       g_set_error_literal (error, G_IO_ERROR,
1536                            G_IO_ERROR_NOT_SUPPORTED,
1537                            _("Operation not supported"));
1538       return NULL;
1539     }
1540
1541   return (* iface->create) (file, flags, cancellable, error);
1542 }
1543
1544 /**
1545  * g_file_replace:
1546  * @file: input #GFile.
1547  * @etag: an optional <link linkend="gfile-etag">entity tag</link> for the
1548  *     current #GFile, or #NULL to ignore.
1549  * @make_backup: %TRUE if a backup should be created.
1550  * @flags: a set of #GFileCreateFlags.
1551  * @cancellable: optional #GCancellable object, %NULL to ignore.
1552  * @error: a #GError, or %NULL
1553  *
1554  * Returns an output stream for overwriting the file, possibly
1555  * creating a backup copy of the file first. If the file doesn't exist,
1556  * it will be created.
1557  *
1558  * This will try to replace the file in the safest way possible so
1559  * that any errors during the writing will not affect an already
1560  * existing copy of the file. For instance, for local files it
1561  * may write to a temporary file and then atomically rename over
1562  * the destination when the stream is closed.
1563  *
1564  * By default files created are generally readable by everyone,
1565  * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1566  * will be made readable only to the current user, to the level that
1567  * is supported on the target filesystem.
1568  *
1569  * If @cancellable is not %NULL, then the operation can be cancelled by
1570  * triggering the cancellable object from another thread. If the operation
1571  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1572  *
1573  * If you pass in a non-#NULL @etag value, then this value is
1574  * compared to the current entity tag of the file, and if they differ
1575  * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
1576  * that the file has been changed since you last read it. You can get
1577  * the new etag from g_file_output_stream_get_etag() after you've
1578  * finished writing and closed the #GFileOutputStream. When you load
1579  * a new file you can use g_file_input_stream_query_info() to get
1580  * the etag of the file.
1581  *
1582  * If @make_backup is %TRUE, this function will attempt to make a backup
1583  * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
1584  * error will be returned. If you want to replace anyway, try again with
1585  * @make_backup set to %FALSE.
1586  *
1587  * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
1588  * and if the file is some other form of non-regular file then a
1589  * G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
1590  * Some file systems don't allow all file names, and may
1591  * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1592  * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1593  * Other errors are possible too, and depend on what kind of
1594  * filesystem the file is on.
1595  *
1596  * Returns: a #GFileOutputStream or %NULL on error.
1597  *     Free the returned object with g_object_unref().
1598  **/
1599 GFileOutputStream *
1600 g_file_replace (GFile             *file,
1601                 const char        *etag,
1602                 gboolean           make_backup,
1603                 GFileCreateFlags   flags,
1604                 GCancellable      *cancellable,
1605                 GError           **error)
1606 {
1607   GFileIface *iface;
1608
1609   g_return_val_if_fail (G_IS_FILE (file), NULL);
1610
1611   if (g_cancellable_set_error_if_cancelled (cancellable, error))
1612     return NULL;
1613
1614   iface = G_FILE_GET_IFACE (file);
1615
1616   if (iface->replace == NULL)
1617     {
1618       g_set_error_literal (error, G_IO_ERROR,
1619                            G_IO_ERROR_NOT_SUPPORTED,
1620                            _("Operation not supported"));
1621       return NULL;
1622     }
1623
1624
1625   /* Handle empty tag string as NULL in consistent way. */
1626   if (etag && *etag == 0)
1627     etag = NULL;
1628
1629   return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1630 }
1631
1632 /**
1633  * g_file_read_async:
1634  * @file: input #GFile.
1635  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1636  *     of the request.
1637  * @cancellable: optional #GCancellable object, %NULL to ignore.
1638  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1639  * @user_data: the data to pass to callback function
1640  *
1641  * Asynchronously opens @file for reading.
1642  *
1643  * For more details, see g_file_read() which is
1644  * the synchronous version of this call.
1645  *
1646  * When the operation is finished, @callback will be called. You can then call
1647  * g_file_read_finish() to get the result of the operation.
1648  **/
1649 void
1650 g_file_read_async (GFile               *file,
1651                    int                  io_priority,
1652                    GCancellable        *cancellable,
1653                    GAsyncReadyCallback  callback,
1654                    gpointer             user_data)
1655 {
1656   GFileIface *iface;
1657
1658   g_return_if_fail (G_IS_FILE (file));
1659
1660   iface = G_FILE_GET_IFACE (file);
1661   (* iface->read_async) (file,
1662                          io_priority,
1663                          cancellable,
1664                          callback,
1665                          user_data);
1666 }
1667
1668 /**
1669  * g_file_read_finish:
1670  * @file: input #GFile.
1671  * @res: a #GAsyncResult.
1672  * @error: a #GError, or %NULL
1673  *
1674  * Finishes an asynchronous file read operation started with
1675  * g_file_read_async().
1676  *
1677  * Returns: a #GFileInputStream or %NULL on error.
1678  *     Free the returned object with g_object_unref().
1679  **/
1680 GFileInputStream *
1681 g_file_read_finish (GFile         *file,
1682                     GAsyncResult  *res,
1683                     GError       **error)
1684 {
1685   GFileIface *iface;
1686
1687   g_return_val_if_fail (G_IS_FILE (file), NULL);
1688   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1689
1690   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1691     {
1692       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1693       if (g_simple_async_result_propagate_error (simple, error))
1694         return NULL;
1695     }
1696
1697   iface = G_FILE_GET_IFACE (file);
1698   return (* iface->read_finish) (file, res, error);
1699 }
1700
1701 /**
1702  * g_file_append_to_async:
1703  * @file: input #GFile.
1704  * @flags: a set of #GFileCreateFlags.
1705  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1706  *     of the request.
1707  * @cancellable: optional #GCancellable object, %NULL to ignore.
1708  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1709  * @user_data: the data to pass to callback function
1710  *
1711  * Asynchronously opens @file for appending.
1712  *
1713  * For more details, see g_file_append_to() which is
1714  * the synchronous version of this call.
1715  *
1716  * When the operation is finished, @callback will be called. You can then call
1717  * g_file_append_to_finish() to get the result of the operation.
1718  **/
1719 void
1720 g_file_append_to_async (GFile               *file,
1721                         GFileCreateFlags     flags,
1722                         int                  io_priority,
1723                         GCancellable        *cancellable,
1724                         GAsyncReadyCallback  callback,
1725                         gpointer             user_data)
1726 {
1727   GFileIface *iface;
1728
1729   g_return_if_fail (G_IS_FILE (file));
1730
1731   iface = G_FILE_GET_IFACE (file);
1732   (* iface->append_to_async) (file,
1733                               flags,
1734                               io_priority,
1735                               cancellable,
1736                               callback,
1737                               user_data);
1738 }
1739
1740 /**
1741  * g_file_append_to_finish:
1742  * @file: input #GFile.
1743  * @res: #GAsyncResult
1744  * @error: a #GError, or %NULL
1745  *
1746  * Finishes an asynchronous file append operation started with
1747  * g_file_append_to_async().
1748  *
1749  * Returns: a valid #GFileOutputStream or %NULL on error.
1750  *     Free the returned object with g_object_unref().
1751  **/
1752 GFileOutputStream *
1753 g_file_append_to_finish (GFile         *file,
1754                          GAsyncResult  *res,
1755                          GError       **error)
1756 {
1757   GFileIface *iface;
1758
1759   g_return_val_if_fail (G_IS_FILE (file), NULL);
1760   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1761
1762   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1763     {
1764       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1765       if (g_simple_async_result_propagate_error (simple, error))
1766         return NULL;
1767     }
1768
1769   iface = G_FILE_GET_IFACE (file);
1770   return (* iface->append_to_finish) (file, res, error);
1771 }
1772
1773 /**
1774  * g_file_create_async:
1775  * @file: input #GFile.
1776  * @flags: a set of #GFileCreateFlags.
1777  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1778  *     of the request.
1779  * @cancellable: optional #GCancellable object, %NULL to ignore.
1780  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1781  * @user_data: the data to pass to callback function
1782  *
1783  * Asynchronously creates a new file and returns an output stream for writing to it.
1784  * The file must not already exist.
1785  *
1786  * For more details, see g_file_create() which is
1787  * the synchronous version of this call.
1788  *
1789  * When the operation is finished, @callback will be called. You can then call
1790  * g_file_create_finish() to get the result of the operation.
1791  **/
1792 void
1793 g_file_create_async (GFile               *file,
1794                      GFileCreateFlags     flags,
1795                      int                  io_priority,
1796                      GCancellable        *cancellable,
1797                      GAsyncReadyCallback  callback,
1798                      gpointer             user_data)
1799 {
1800   GFileIface *iface;
1801
1802   g_return_if_fail (G_IS_FILE (file));
1803
1804   iface = G_FILE_GET_IFACE (file);
1805   (* iface->create_async) (file,
1806                            flags,
1807                            io_priority,
1808                            cancellable,
1809                            callback,
1810                            user_data);
1811 }
1812
1813 /**
1814  * g_file_create_finish:
1815  * @file: input #GFile.
1816  * @res: a #GAsyncResult.
1817  * @error: a #GError, or %NULL
1818  *
1819  * Finishes an asynchronous file create operation started with
1820  * g_file_create_async().
1821  *
1822  * Returns: a #GFileOutputStream or %NULL on error.
1823  *     Free the returned object with g_object_unref().
1824  **/
1825 GFileOutputStream *
1826 g_file_create_finish (GFile         *file,
1827                       GAsyncResult  *res,
1828                       GError       **error)
1829 {
1830   GFileIface *iface;
1831
1832   g_return_val_if_fail (G_IS_FILE (file), NULL);
1833   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1834
1835   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1836     {
1837       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1838       if (g_simple_async_result_propagate_error (simple, error))
1839         return NULL;
1840     }
1841
1842   iface = G_FILE_GET_IFACE (file);
1843   return (* iface->create_finish) (file, res, error);
1844 }
1845
1846 /**
1847  * g_file_replace_async:
1848  * @file: input #GFile.
1849  * @etag: an <link linkend="gfile-etag">entity tag</link> for the
1850  *     current #GFile, or NULL to ignore.
1851  * @make_backup: %TRUE if a backup should be created.
1852  * @flags: a set of #GFileCreateFlags.
1853  * @io_priority: the <link linkend="io-priority">I/O priority</link>
1854  *     of the request.
1855  * @cancellable: optional #GCancellable object, %NULL to ignore.
1856  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1857  * @user_data: the data to pass to callback function
1858  *
1859  * Asynchronously overwrites the file, replacing the contents, possibly
1860  * creating a backup copy of the file first.
1861  *
1862  * For more details, see g_file_replace() which is
1863  * the synchronous version of this call.
1864  *
1865  * When the operation is finished, @callback will be called. You can then call
1866  * g_file_replace_finish() to get the result of the operation.
1867  **/
1868 void
1869 g_file_replace_async (GFile               *file,
1870                       const char          *etag,
1871                       gboolean             make_backup,
1872                       GFileCreateFlags     flags,
1873                       int                  io_priority,
1874                       GCancellable        *cancellable,
1875                       GAsyncReadyCallback  callback,
1876                       gpointer             user_data)
1877 {
1878   GFileIface *iface;
1879
1880   g_return_if_fail (G_IS_FILE (file));
1881
1882   iface = G_FILE_GET_IFACE (file);
1883   (* iface->replace_async) (file,
1884                             etag,
1885                             make_backup,
1886                             flags,
1887                             io_priority,
1888                             cancellable,
1889                             callback,
1890                             user_data);
1891 }
1892
1893 /**
1894  * g_file_replace_finish:
1895  * @file: input #GFile.
1896  * @res: a #GAsyncResult.
1897  * @error: a #GError, or %NULL
1898  *
1899  * Finishes an asynchronous file replace operation started with
1900  * g_file_replace_async().
1901  *
1902  * Returns: a #GFileOutputStream, or %NULL on error.
1903  *     Free the returned object with g_object_unref().
1904  **/
1905 GFileOutputStream *
1906 g_file_replace_finish (GFile         *file,
1907                        GAsyncResult  *res,
1908                        GError       **error)
1909 {
1910   GFileIface *iface;
1911
1912   g_return_val_if_fail (G_IS_FILE (file), NULL);
1913   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1914
1915   if (G_IS_SIMPLE_ASYNC_RESULT (res))
1916     {
1917       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1918       if (g_simple_async_result_propagate_error (simple, error))
1919         return NULL;
1920     }
1921
1922   iface = G_FILE_GET_IFACE (file);
1923   return (* iface->replace_finish) (file, res, error);
1924 }
1925
1926 static gboolean
1927 copy_symlink (GFile           *destination,
1928               GFileCopyFlags   flags,
1929               GCancellable    *cancellable,
1930               const char      *target,
1931               GError         **error)
1932 {
1933   GError *my_error;
1934   gboolean tried_delete;
1935   GFileInfo *info;
1936   GFileType file_type;
1937
1938   tried_delete = FALSE;
1939
1940  retry:
1941   my_error = NULL;
1942   if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
1943     {
1944       /* Maybe it already existed, and we want to overwrite? */
1945       if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
1946           my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
1947         {
1948           g_error_free (my_error);
1949
1950
1951           /* Don't overwrite if the destination is a directory */
1952           info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1953                                     G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
1954                                     cancellable, &my_error);
1955           if (info != NULL)
1956             {
1957               file_type = g_file_info_get_file_type (info);
1958               g_object_unref (info);
1959
1960               if (file_type == G_FILE_TYPE_DIRECTORY)
1961                 {
1962                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
1963                                        _("Can't copy over directory"));
1964                   return FALSE;
1965                 }
1966             }
1967
1968           if (!g_file_delete (destination, cancellable, error))
1969             return FALSE;
1970
1971           tried_delete = TRUE;
1972           goto retry;
1973         }
1974             /* Nah, fail */
1975       g_propagate_error (error, my_error);
1976       return FALSE;
1977     }
1978
1979   return TRUE;
1980 }
1981
1982 static GInputStream *
1983 open_source_for_copy (GFile           *source,
1984                       GFile           *destination,
1985                       GFileCopyFlags   flags,
1986                       GCancellable    *cancellable,
1987                       GError         **error)
1988 {
1989   GError *my_error;
1990   GInputStream *in;
1991   GFileInfo *info;
1992   GFileType file_type;
1993
1994   my_error = NULL;
1995   in = (GInputStream *)g_file_read (source, cancellable, &my_error);
1996   if (in != NULL)
1997     return in;
1998
1999   /* There was an error opening the source, try to set a good error for it: */
2000
2001   if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
2002     {
2003       /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2004        * as that is less useful to the app. Better check for errors on the
2005        * target instead.
2006        */
2007       g_error_free (my_error);
2008       my_error = NULL;
2009
2010       info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2011                                 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2012                                 cancellable, &my_error);
2013       if (info != NULL)
2014         {
2015           file_type = g_file_info_get_file_type (info);
2016           g_object_unref (info);
2017
2018           if (flags & G_FILE_COPY_OVERWRITE)
2019             {
2020               if (file_type == G_FILE_TYPE_DIRECTORY)
2021                 {
2022                   g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
2023                                        _("Can't copy directory over directory"));
2024                   return NULL;
2025                 }
2026               /* continue to would_recurse error */
2027             }
2028           else
2029             {
2030               g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
2031                                    _("Target file exists"));
2032               return NULL;
2033             }
2034         }
2035       else
2036         {
2037           /* Error getting info from target, return that error
2038            * (except for NOT_FOUND, which is no error here)
2039            */
2040           if (my_error->domain != G_IO_ERROR && my_error->code != G_IO_ERROR_NOT_FOUND)
2041             {
2042               g_propagate_error (error, my_error);
2043               return NULL;
2044             }
2045           g_error_free (my_error);
2046         }
2047
2048       g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
2049                            _("Can't recursively copy directory"));
2050       return NULL;
2051     }
2052
2053   g_propagate_error (error, my_error);
2054   return NULL;
2055 }
2056
2057 static gboolean
2058 should_copy (GFileAttributeInfo *info,
2059              gboolean            as_move)
2060 {
2061   if (as_move)
2062     return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
2063   return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
2064 }
2065
2066 static char *
2067 build_attribute_list_for_copy (GFileAttributeInfoList *attributes,
2068                                GFileAttributeInfoList *namespaces,
2069                                gboolean                as_move)
2070 {
2071   GString *s;
2072   gboolean first;
2073   int i;
2074
2075   first = TRUE;
2076   s = g_string_new ("");
2077
2078   if (attributes)
2079     {
2080       for (i = 0; i < attributes->n_infos; i++)
2081         {
2082           if (should_copy (&attributes->infos[i], as_move))
2083             {
2084               if (first)
2085                 first = FALSE;
2086               else
2087                 g_string_append_c (s, ',');
2088
2089               g_string_append (s, attributes->infos[i].name);
2090             }
2091         }
2092     }
2093
2094   if (namespaces)
2095     {
2096       for (i = 0; i < namespaces->n_infos; i++)
2097         {
2098           if (should_copy (&namespaces->infos[i], as_move))
2099             {
2100               if (first)
2101                 first = FALSE;
2102               else
2103                 g_string_append_c (s, ',');
2104
2105               g_string_append (s, namespaces->infos[i].name);
2106               g_string_append (s, ":*");
2107             }
2108         }
2109     }
2110
2111   return g_string_free (s, FALSE);
2112 }
2113
2114 /**
2115  * g_file_copy_attributes:
2116  * @source: a #GFile with attributes.
2117  * @destination: a #GFile to copy attributes to.
2118  * @flags: a set of #GFileCopyFlags.
2119  * @cancellable: optional #GCancellable object, %NULL to ignore.
2120  * @error: a #GError, %NULL to ignore.
2121  *
2122  * Copies the file attributes from @source to @destination.
2123  *
2124  * Normally only a subset of the file attributes are copied,
2125  * those that are copies in a normal file copy operation
2126  * (which for instance does not include e.g. mtime). However
2127  * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2128  * all the metadata that is possible to copy is copied.
2129  *
2130  * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise.
2131  **/
2132 gboolean
2133 g_file_copy_attributes (GFile           *source,
2134                         GFile           *destination,
2135                         GFileCopyFlags   flags,
2136                         GCancellable    *cancellable,
2137                         GError         **error)
2138 {
2139   GFileAttributeInfoList *attributes, *namespaces;
2140   char *attrs_to_read;
2141   gboolean res;
2142   GFileInfo *info;
2143   gboolean as_move;
2144   gboolean source_nofollow_symlinks;
2145
2146   as_move = flags & G_FILE_COPY_ALL_METADATA;
2147   source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
2148
2149   /* Ignore errors here, if the target supports no attributes there is nothing to copy */
2150   attributes = g_file_query_settable_attributes (destination, cancellable, NULL);
2151   namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL);
2152
2153   if (attributes == NULL && namespaces == NULL)
2154     return TRUE;
2155
2156   attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move);
2157
2158   /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2159    * we just don't copy it.
2160    */
2161   info = g_file_query_info (source, attrs_to_read,
2162                             source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
2163                             cancellable,
2164                             NULL);
2165
2166   g_free (attrs_to_read);
2167
2168   res = TRUE;
2169   if  (info)
2170     {
2171       res = g_file_set_attributes_from_info (destination,
2172                                              info, 0,
2173                                              cancellable,
2174                                              error);
2175       g_object_unref (info);
2176     }
2177
2178   g_file_attribute_info_list_unref (attributes);
2179   g_file_attribute_info_list_unref (namespaces);
2180
2181   return res;
2182 }
2183
2184 /* Closes the streams */
2185 static gboolean
2186 copy_stream_with_progress (GInputStream           *in,
2187                            GOutputStream          *out,
2188                            GFile                  *source,
2189                            GCancellable           *cancellable,
2190                            GFileProgressCallback   progress_callback,
2191                            gpointer                progress_callback_data,
2192                            GError                **error)
2193 {
2194   gssize n_read, n_written;
2195   goffset current_size;
2196   char buffer[1024*64], *p;
2197   gboolean res;
2198   goffset total_size;
2199   GFileInfo *info;
2200
2201   total_size = -1;
2202   info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2203                                          G_FILE_ATTRIBUTE_STANDARD_SIZE,
2204                                          cancellable, NULL);
2205   if (info)
2206     {
2207       if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2208         total_size = g_file_info_get_size (info);
2209       g_object_unref (info);
2210     }
2211
2212   if (total_size == -1)
2213     {
2214       info = g_file_query_info (source,
2215                                 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2216                                 G_FILE_QUERY_INFO_NONE,
2217                                 cancellable, NULL);
2218       if (info)
2219         {
2220           if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2221             total_size = g_file_info_get_size (info);
2222           g_object_unref (info);
2223         }
2224     }
2225
2226   if (total_size == -1)
2227     total_size = 0;
2228
2229   current_size = 0;
2230   res = TRUE;
2231   while (TRUE)
2232     {
2233       n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2234       if (n_read == -1)
2235         {
2236           res = FALSE;
2237           break;
2238         }
2239
2240       if (n_read == 0)
2241         break;
2242
2243       current_size += n_read;
2244
2245       p = buffer;
2246       while (n_read > 0)
2247         {
2248           n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2249           if (n_written == -1)
2250             {
2251               res = FALSE;
2252               break;
2253             }
2254
2255           p += n_written;
2256           n_read -= n_written;
2257         }
2258
2259       if (!res)
2260         break;
2261
2262       if (progress_callback)
2263         progress_callback (current_size, total_size, progress_callback_data);
2264     }
2265
2266   if (!res)
2267     error = NULL; /* Ignore further errors */
2268
2269   /* Make sure we send full copied size */
2270   if (progress_callback)
2271     progress_callback (current_size, total_size, progress_callback_data);
2272
2273   /* Don't care about errors in source here */
2274   g_input_stream_close (in, cancellable, NULL);
2275
2276   /* But write errors on close are bad! */
2277   if (!g_output_stream_close (out, cancellable, error))
2278     res = FALSE;
2279
2280   g_object_unref (in);
2281   g_object_unref (out);
2282
2283   return res;
2284 }
2285
2286 static gboolean
2287 file_copy_fallback (GFile                  *source,
2288                     GFile                  *destination,
2289                     GFileCopyFlags          flags,
2290                     GCancellable           *cancellable,
2291                     GFileProgressCallback   progress_callback,
2292                     gpointer                progress_callback_data,
2293                     GError                **error)
2294 {
2295   GInputStream *in;
2296   GOutputStream *out;
2297   GFileInfo *info;
2298   const char *target;
2299
2300   /* Maybe copy the symlink? */
2301   if (flags & G_FILE_COPY_NOFOLLOW_SYMLINKS)
2302     {
2303       info = g_file_query_info (source,
2304                                 G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
2305                                 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2306                                 cancellable,
2307                                 error);
2308       if (info == NULL)
2309         return FALSE;
2310
2311       if (g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK &&
2312           (target = g_file_info_get_symlink_target (info)) != NULL)
2313         {
2314           if (!copy_symlink (destination, flags, cancellable, target, error))
2315             {
2316               g_object_unref (info);
2317               return FALSE;
2318             }
2319
2320           g_object_unref (info);
2321           goto copied_file;
2322         }
2323
2324       g_object_unref (info);
2325     }
2326
2327   in = open_source_for_copy (source, destination, flags, cancellable, error);
2328   if (in == NULL)
2329     return FALSE;
2330
2331   if (flags & G_FILE_COPY_OVERWRITE)
2332     {
2333       out = (GOutputStream *)g_file_replace (destination,
2334                                              NULL,
2335                                              flags & G_FILE_COPY_BACKUP,
2336                                              0,
2337                                              cancellable, error);
2338     }
2339   else
2340     {
2341       out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
2342     }
2343
2344   if (out == NULL)
2345     {
2346       g_object_unref (in);
2347       return FALSE;
2348     }
2349
2350   if (!copy_stream_with_progress (in, out, source, cancellable,
2351                                   progress_callback, progress_callback_data,
2352                                   error))
2353     return FALSE;
2354
2355  copied_file:
2356
2357   /* Ignore errors here. Failure to copy metadata is not a hard error */
2358   g_file_copy_attributes (source, destination,
2359                           flags, cancellable, NULL);
2360
2361   return TRUE;
2362 }
2363
2364 /**
2365  * g_file_copy:
2366  * @source: input #GFile.
2367  * @destination: destination #GFile
2368  * @flags: set of #GFileCopyFlags
2369  * @cancellable: optional #GCancellable object, %NULL to ignore.
2370  * @progress_callback: function to callback with progress information
2371  * @progress_callback_data: user data to pass to @progress_callback
2372  * @error: #GError to set on error, or %NULL
2373  *
2374  * Copies the file @source to the location specified by @destination.
2375  * Can not handle recursive copies of directories.
2376  *
2377  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2378  * existing @destination file is overwritten.
2379  *
2380  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2381  * will be copied as symlinks, otherwise the target of the
2382  * @source symlink will be copied.
2383  *
2384  * If @cancellable is not %NULL, then the operation can be cancelled by
2385  * triggering the cancellable object from another thread. If the operation
2386  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2387  *
2388  * If @progress_callback is not %NULL, then the operation can be monitored by
2389  * setting this to a #GFileProgressCallback function. @progress_callback_data
2390  * will be passed to this function. It is guaranteed that this callback will
2391  * be called after all data has been transferred with the total number of bytes
2392  * copied during the operation.
2393  *
2394  * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2395  * error is returned, independent on the status of the @destination.
2396  *
2397  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2398  * error G_IO_ERROR_EXISTS is returned.
2399  *
2400  * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2401  * error is returned. If trying to overwrite a directory with a directory the
2402  * G_IO_ERROR_WOULD_MERGE error is returned.
2403  *
2404  * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
2405  * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
2406  * is returned.
2407  *
2408  * If you are interested in copying the #GFile object itself (not the on-disk
2409  * file), see g_file_dup().
2410  *
2411  * Returns: %TRUE on success, %FALSE otherwise.
2412  **/
2413 gboolean
2414 g_file_copy (GFile                  *source,
2415              GFile                  *destination,
2416              GFileCopyFlags          flags,
2417              GCancellable           *cancellable,
2418              GFileProgressCallback   progress_callback,
2419              gpointer                progress_callback_data,
2420              GError                **error)
2421 {
2422   GFileIface *iface;
2423   GError *my_error;
2424   gboolean res;
2425
2426   g_return_val_if_fail (G_IS_FILE (source), FALSE);
2427   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
2428
2429   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2430     return FALSE;
2431
2432   iface = G_FILE_GET_IFACE (destination);
2433   if (iface->copy)
2434     {
2435       my_error = NULL;
2436       res = (* iface->copy) (source, destination,
2437                              flags, cancellable,
2438                              progress_callback, progress_callback_data,
2439                              &my_error);
2440
2441       if (res)
2442         return TRUE;
2443
2444       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2445         {
2446           g_propagate_error (error, my_error);
2447               return FALSE;
2448         }
2449     }
2450
2451   /* If the types are different, and the destination method failed
2452      also try the source method */
2453   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
2454     {
2455       iface = G_FILE_GET_IFACE (source);
2456
2457       if (iface->copy)
2458         {
2459           my_error = NULL;
2460           res = (* iface->copy) (source, destination,
2461                                  flags, cancellable,
2462                                  progress_callback, progress_callback_data,
2463                                  &my_error);
2464
2465           if (res)
2466             return TRUE;
2467
2468           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2469             {
2470               g_propagate_error (error, my_error);
2471               return FALSE;
2472             }
2473         }
2474     }
2475
2476   return file_copy_fallback (source, destination, flags, cancellable,
2477                              progress_callback, progress_callback_data,
2478                              error);
2479 }
2480
2481 /**
2482  * g_file_copy_async:
2483  * @source: input #GFile.
2484  * @destination: destination #GFile
2485  * @flags: set of #GFileCopyFlags
2486  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2487  *     of the request.
2488  * @cancellable: optional #GCancellable object, %NULL to ignore.
2489  * @progress_callback: function to callback with progress information
2490  * @progress_callback_data: user data to pass to @progress_callback
2491  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
2492  * @user_data: the data to pass to callback function
2493  *
2494  * Copies the file @source to the location specified by @destination
2495  * asynchronously. For details of the behaviour, see g_file_copy().
2496  *
2497  * If @progress_callback is not %NULL, then that function that will be called
2498  * just like in g_file_copy(), however the callback will run in the main loop,
2499  * not in the thread that is doing the I/O operation.
2500  *
2501  * When the operation is finished, @callback will be called. You can then call
2502  * g_file_copy_finish() to get the result of the operation.
2503  **/
2504 void
2505 g_file_copy_async (GFile                  *source,
2506                    GFile                  *destination,
2507                    GFileCopyFlags          flags,
2508                    int                     io_priority,
2509                    GCancellable           *cancellable,
2510                    GFileProgressCallback   progress_callback,
2511                    gpointer                progress_callback_data,
2512                    GAsyncReadyCallback     callback,
2513                    gpointer                user_data)
2514 {
2515   GFileIface *iface;
2516
2517   g_return_if_fail (G_IS_FILE (source));
2518   g_return_if_fail (G_IS_FILE (destination));
2519
2520   iface = G_FILE_GET_IFACE (source);
2521   (* iface->copy_async) (source,
2522                          destination,
2523                          flags,
2524                          io_priority,
2525                          cancellable,
2526                          progress_callback,
2527                          progress_callback_data,
2528                          callback,
2529                          user_data);
2530 }
2531
2532 /**
2533  * g_file_copy_finish:
2534  * @file: input #GFile.
2535  * @res: a #GAsyncResult.
2536  * @error: a #GError, or %NULL
2537  *
2538  * Finishes copying the file started with
2539  * g_file_copy_async().
2540  *
2541  * Returns: a %TRUE on success, %FALSE on error.
2542  **/
2543 gboolean
2544 g_file_copy_finish (GFile        *file,
2545                     GAsyncResult *res,
2546                     GError      **error)
2547 {
2548   GFileIface *iface;
2549
2550   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2551   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
2552
2553   if (G_IS_SIMPLE_ASYNC_RESULT (res))
2554     {
2555       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2556
2557       if (g_simple_async_result_propagate_error (simple, error))
2558         return FALSE;
2559     }
2560
2561   iface = G_FILE_GET_IFACE (file);
2562   return (* iface->copy_finish) (file, res, error);
2563 }
2564
2565 /**
2566  * g_file_move:
2567  * @source: #GFile pointing to the source location.
2568  * @destination: #GFile pointing to the destination location.
2569  * @flags: set of #GFileCopyFlags.
2570  * @cancellable: optional #GCancellable object, %NULL to ignore.
2571  * @progress_callback: #GFileProgressCallback function for updates.
2572  * @progress_callback_data: gpointer to user data for the callback function.
2573  * @error: #GError for returning error conditions, or %NULL
2574  *
2575  *
2576  * Tries to move the file or directory @source to the location specified by @destination.
2577  * If native move operations are supported then this is used, otherwise a copy + delete
2578  * fallback is used. The native implementation may support moving directories (for instance
2579  * on moves inside the same filesystem), but the fallback code does not.
2580  *
2581  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2582  * existing @destination file is overwritten.
2583  *
2584  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2585  * will be copied as symlinks, otherwise the target of the
2586  * @source symlink will be copied.
2587  *
2588  * If @cancellable is not %NULL, then the operation can be cancelled by
2589  * triggering the cancellable object from another thread. If the operation
2590  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2591  *
2592  * If @progress_callback is not %NULL, then the operation can be monitored by
2593  * setting this to a #GFileProgressCallback function. @progress_callback_data
2594  * will be passed to this function. It is guaranteed that this callback will
2595  * be called after all data has been transferred with the total number of bytes
2596  * copied during the operation.
2597  *
2598  * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2599  * error is returned, independent on the status of the @destination.
2600  *
2601  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2602  * error G_IO_ERROR_EXISTS is returned.
2603  *
2604  * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2605  * error is returned. If trying to overwrite a directory with a directory the
2606  * G_IO_ERROR_WOULD_MERGE error is returned.
2607  *
2608  * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
2609  * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
2610  * may be returned (if the native move operation isn't available).
2611  *
2612  * Returns: %TRUE on successful move, %FALSE otherwise.
2613  **/
2614 gboolean
2615 g_file_move (GFile                  *source,
2616              GFile                  *destination,
2617              GFileCopyFlags          flags,
2618              GCancellable           *cancellable,
2619              GFileProgressCallback   progress_callback,
2620              gpointer                progress_callback_data,
2621              GError                **error)
2622 {
2623   GFileIface *iface;
2624   GError *my_error;
2625   gboolean res;
2626
2627   g_return_val_if_fail (G_IS_FILE (source), FALSE);
2628   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
2629
2630   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2631     return FALSE;
2632
2633   iface = G_FILE_GET_IFACE (destination);
2634   if (iface->move)
2635     {
2636       my_error = NULL;
2637       res = (* iface->move) (source, destination,
2638                              flags, cancellable,
2639                              progress_callback, progress_callback_data,
2640                              &my_error);
2641
2642       if (res)
2643         return TRUE;
2644
2645       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2646         {
2647           g_propagate_error (error, my_error);
2648           return FALSE;
2649         }
2650     }
2651
2652   /* If the types are different, and the destination method failed
2653      also try the source method */
2654   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
2655     {
2656       iface = G_FILE_GET_IFACE (source);
2657
2658       if (iface->move)
2659         {
2660           my_error = NULL;
2661           res = (* iface->move) (source, destination,
2662                                  flags, cancellable,
2663                                  progress_callback, progress_callback_data,
2664                                  &my_error);
2665
2666           if (res)
2667             return TRUE;
2668
2669           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2670             {
2671               g_propagate_error (error, my_error);
2672               return FALSE;
2673             }
2674         }
2675     }
2676
2677   if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
2678     {
2679       g_set_error_literal (error, G_IO_ERROR,
2680                            G_IO_ERROR_NOT_SUPPORTED,
2681                            _("Operation not supported"));
2682       return FALSE;
2683     }
2684
2685   flags |= G_FILE_COPY_ALL_METADATA;
2686   if (!g_file_copy (source, destination, flags, cancellable,
2687                     progress_callback, progress_callback_data,
2688                     error))
2689     return FALSE;
2690
2691   return g_file_delete (source, cancellable, error);
2692 }
2693
2694 /**
2695  * g_file_make_directory
2696  * @file: input #GFile.
2697  * @cancellable: optional #GCancellable object, %NULL to ignore.
2698  * @error: a #GError, or %NULL
2699  *
2700  * Creates a directory. Note that this will only create a child directory of
2701  * the immediate parent directory of the path or URI given by the #GFile. To
2702  * recursively create directories, see g_file_make_directory_with_parents().
2703  * This function will fail if the parent directory does not exist, setting
2704  * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating
2705  * directories, this function will fail, setting @error to
2706  * %G_IO_ERROR_NOT_SUPPORTED.
2707  *
2708  * If @cancellable is not %NULL, then the operation can be cancelled by
2709  * triggering the cancellable object from another thread. If the operation
2710  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2711  *
2712  * Returns: %TRUE on successful creation, %FALSE otherwise.
2713  **/
2714 gboolean
2715 g_file_make_directory (GFile         *file,
2716                        GCancellable  *cancellable,
2717                        GError       **error)
2718 {
2719   GFileIface *iface;
2720
2721   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2722
2723   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2724     return FALSE;
2725
2726   iface = G_FILE_GET_IFACE (file);
2727
2728   if (iface->make_directory == NULL)
2729     {
2730       g_set_error_literal (error, G_IO_ERROR,
2731                            G_IO_ERROR_NOT_SUPPORTED,
2732                            _("Operation not supported"));
2733       return FALSE;
2734     }
2735
2736   return (* iface->make_directory) (file, cancellable, error);
2737 }
2738
2739 /**
2740  * g_file_make_directory_with_parents:
2741  * @file: input #GFile.
2742  * @cancellable: optional #GCancellable object, %NULL to ignore.
2743  * @error: a #GError, or %NULL
2744  *
2745  * Creates a directory and any parent directories that may not exist similar to
2746  * 'mkdir -p'. If the file system does not support creating directories, this
2747  * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED.
2748  *
2749  * If @cancellable is not %NULL, then the operation can be cancelled by
2750  * triggering the cancellable object from another thread. If the operation
2751  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2752  *
2753  * Returns: %TRUE if all directories have been successfully created, %FALSE
2754  * otherwise.
2755  *
2756  * Since: 2.18
2757  **/
2758 gboolean
2759 g_file_make_directory_with_parents (GFile         *file,
2760                                     GCancellable  *cancellable,
2761                                     GError       **error)
2762 {
2763   gboolean result;
2764   GFile *parent_file, *work_file;
2765   GList *list = NULL, *l;
2766   GError *my_error = NULL;
2767
2768   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2769     return FALSE;
2770
2771   result = g_file_make_directory (file, cancellable, &my_error);
2772   if (result || my_error->code != G_IO_ERROR_NOT_FOUND)
2773     {
2774       if (my_error)
2775         g_propagate_error (error, my_error);
2776       return result;
2777     }
2778
2779   work_file = file;
2780
2781   while (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
2782     {
2783       g_clear_error (&my_error);
2784
2785       parent_file = g_file_get_parent (work_file);
2786       if (parent_file == NULL)
2787         break;
2788       result = g_file_make_directory (parent_file, cancellable, &my_error);
2789
2790       if (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
2791         list = g_list_prepend (list, parent_file);
2792
2793       work_file = parent_file;
2794     }
2795
2796   for (l = list; result && l; l = l->next)
2797     {
2798       result = g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
2799     }
2800
2801   /* Clean up */
2802   while (list != NULL)
2803     {
2804       g_object_unref ((GFile *) list->data);
2805       list = g_list_remove (list, list->data);
2806     }
2807
2808   if (!result)
2809     {
2810       g_propagate_error (error, my_error);
2811       return result;
2812     }
2813
2814   return g_file_make_directory (file, cancellable, error);
2815 }
2816
2817 /**
2818  * g_file_make_symbolic_link:
2819  * @file: input #GFile.
2820  * @symlink_value: a string with the value of the new symlink.
2821  * @cancellable: optional #GCancellable object, %NULL to ignore.
2822  * @error: a #GError.
2823  *
2824  * Creates a symbolic link.
2825  *
2826  * If @cancellable is not %NULL, then the operation can be cancelled by
2827  * triggering the cancellable object from another thread. If the operation
2828  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2829  *
2830  * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
2831  **/
2832 gboolean
2833 g_file_make_symbolic_link (GFile         *file,
2834                            const char    *symlink_value,
2835                            GCancellable  *cancellable,
2836                            GError       **error)
2837 {
2838   GFileIface *iface;
2839
2840   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2841   g_return_val_if_fail (symlink_value != NULL, FALSE);
2842
2843   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2844     return FALSE;
2845
2846   if (*symlink_value == '\0')
2847     {
2848       g_set_error_literal (error, G_IO_ERROR,
2849                            G_IO_ERROR_INVALID_ARGUMENT,
2850                            _("Invalid symlink value given"));
2851       return FALSE;
2852     }
2853
2854   iface = G_FILE_GET_IFACE (file);
2855
2856   if (iface->make_symbolic_link == NULL)
2857     {
2858       g_set_error_literal (error, G_IO_ERROR,
2859                            G_IO_ERROR_NOT_SUPPORTED,
2860                            _("Operation not supported"));
2861       return FALSE;
2862     }
2863
2864   return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
2865 }
2866
2867 /**
2868  * g_file_delete:
2869  * @file: input #GFile.
2870  * @cancellable: optional #GCancellable object, %NULL to ignore.
2871  * @error: a #GError, or %NULL
2872  *
2873  * Deletes a file. If the @file is a directory, it will only be deleted if it
2874  * is empty.
2875  *
2876  * If @cancellable is not %NULL, then the operation can be cancelled by
2877  * triggering the cancellable object from another thread. If the operation
2878  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2879  *
2880  * Returns: %TRUE if the file was deleted. %FALSE otherwise.
2881  **/
2882 gboolean
2883 g_file_delete (GFile         *file,
2884                GCancellable  *cancellable,
2885                GError       **error)
2886 {
2887   GFileIface *iface;
2888
2889   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2890
2891   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2892     return FALSE;
2893
2894   iface = G_FILE_GET_IFACE (file);
2895
2896   if (iface->delete_file == NULL)
2897     {
2898       g_set_error_literal (error, G_IO_ERROR,
2899                            G_IO_ERROR_NOT_SUPPORTED,
2900                            _("Operation not supported"));
2901       return FALSE;
2902     }
2903
2904   return (* iface->delete_file) (file, cancellable, error);
2905 }
2906
2907 /**
2908  * g_file_trash:
2909  * @file: #GFile to send to trash.
2910  * @cancellable: optional #GCancellable object, %NULL to ignore.
2911  * @error: a #GError, or %NULL
2912  *
2913  * Sends @file to the "Trashcan", if possible. This is similar to
2914  * deleting it, but the user can recover it before emptying the trashcan.
2915  * Not all file systems support trashing, so this call can return the
2916  * %G_IO_ERROR_NOT_SUPPORTED error.
2917  *
2918  *
2919  * If @cancellable is not %NULL, then the operation can be cancelled by
2920  * triggering the cancellable object from another thread. If the operation
2921  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2922  *
2923  * Returns: %TRUE on successful trash, %FALSE otherwise.
2924  **/
2925 gboolean
2926 g_file_trash (GFile         *file,
2927               GCancellable  *cancellable,
2928               GError       **error)
2929 {
2930   GFileIface *iface;
2931
2932   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2933
2934   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2935     return FALSE;
2936
2937   iface = G_FILE_GET_IFACE (file);
2938
2939   if (iface->trash == NULL)
2940     {
2941       g_set_error_literal (error,
2942                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2943                            _("Trash not supported"));
2944       return FALSE;
2945     }
2946
2947   return (* iface->trash) (file, cancellable, error);
2948 }
2949
2950 /**
2951  * g_file_set_display_name:
2952  * @file: input #GFile.
2953  * @display_name: a string.
2954  * @cancellable: optional #GCancellable object, %NULL to ignore.
2955  * @error: a #GError, or %NULL
2956  *
2957  * Renames @file to the specified display name.
2958  *
2959  * The display name is converted from UTF8 to the correct encoding for the target
2960  * filesystem if possible and the @file is renamed to this.
2961  *
2962  * If you want to implement a rename operation in the user interface the edit name
2963  * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
2964  * widget, and then the result after editing should be passed to g_file_set_display_name().
2965  *
2966  * On success the resulting converted filename is returned.
2967  *
2968  * If @cancellable is not %NULL, then the operation can be cancelled by
2969  * triggering the cancellable object from another thread. If the operation
2970  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2971  *
2972  * Returns: a #GFile specifying what @file was renamed to, or %NULL
2973  *     if there was an error.
2974  *     Free the returned object with g_object_unref().
2975  **/
2976 GFile *
2977 g_file_set_display_name (GFile         *file,
2978                          const char    *display_name,
2979                          GCancellable  *cancellable,
2980                          GError       **error)
2981 {
2982   GFileIface *iface;
2983
2984   g_return_val_if_fail (G_IS_FILE (file), NULL);
2985   g_return_val_if_fail (display_name != NULL, NULL);
2986
2987   if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
2988     {
2989       g_set_error (error,
2990                    G_IO_ERROR,
2991                    G_IO_ERROR_INVALID_ARGUMENT,
2992                    _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
2993       return NULL;
2994     }
2995
2996   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2997     return NULL;
2998
2999   iface = G_FILE_GET_IFACE (file);
3000
3001   return (* iface->set_display_name) (file, display_name, cancellable, error);
3002 }
3003
3004 /**
3005  * g_file_set_display_name_async:
3006  * @file: input #GFile.
3007  * @display_name: a string.
3008  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3009  *     of the request.
3010  * @cancellable: optional #GCancellable object, %NULL to ignore.
3011  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3012  * @user_data: the data to pass to callback function
3013  *
3014  * Asynchronously sets the display name for a given #GFile.
3015  *
3016  * For more details, see g_set_display_name() which is
3017  * the synchronous version of this call.
3018  *
3019  * When the operation is finished, @callback will be called. You can then call
3020  * g_file_set_display_name_finish() to get the result of the operation.
3021  **/
3022 void
3023 g_file_set_display_name_async (GFile               *file,
3024                                const char          *display_name,
3025                                int                  io_priority,
3026                                GCancellable        *cancellable,
3027                                GAsyncReadyCallback  callback,
3028                                gpointer             user_data)
3029 {
3030   GFileIface *iface;
3031
3032   g_return_if_fail (G_IS_FILE (file));
3033   g_return_if_fail (display_name != NULL);
3034
3035   iface = G_FILE_GET_IFACE (file);
3036   (* iface->set_display_name_async) (file,
3037                                      display_name,
3038                                      io_priority,
3039                                      cancellable,
3040                                      callback,
3041                                      user_data);
3042 }
3043
3044 /**
3045  * g_file_set_display_name_finish:
3046  * @file: input #GFile.
3047  * @res: a #GAsyncResult.
3048  * @error: a #GError, or %NULL
3049  *
3050  * Finishes setting a display name started with
3051  * g_file_set_display_name_async().
3052  *
3053  * Returns: a #GFile or %NULL on error.
3054  *     Free the returned object with g_object_unref().
3055  **/
3056 GFile *
3057 g_file_set_display_name_finish (GFile         *file,
3058                                 GAsyncResult  *res,
3059                                 GError       **error)
3060 {
3061   GFileIface *iface;
3062
3063   g_return_val_if_fail (G_IS_FILE (file), NULL);
3064   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3065
3066   if (G_IS_SIMPLE_ASYNC_RESULT (res))
3067     {
3068       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3069       if (g_simple_async_result_propagate_error (simple, error))
3070         return NULL;
3071     }
3072
3073   iface = G_FILE_GET_IFACE (file);
3074   return (* iface->set_display_name_finish) (file, res, error);
3075 }
3076
3077 /**
3078  * g_file_query_settable_attributes:
3079  * @file: input #GFile.
3080  * @cancellable: optional #GCancellable object, %NULL to ignore.
3081  * @error: a #GError, or %NULL
3082  *
3083  * Obtain the list of settable attributes for the file.
3084  *
3085  * Returns the type and full attribute name of all the attributes
3086  * that can be set on this file. This doesn't mean setting it will always
3087  * succeed though, you might get an access failure, or some specific
3088  * file may not support a specific attribute.
3089  *
3090  * If @cancellable is not %NULL, then the operation can be cancelled by
3091  * triggering the cancellable object from another thread. If the operation
3092  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3093  *
3094  * Returns: a #GFileAttributeInfoList describing the settable attributes.
3095  * When you are done with it, release it with g_file_attribute_info_list_unref()
3096  **/
3097 GFileAttributeInfoList *
3098 g_file_query_settable_attributes (GFile         *file,
3099                                   GCancellable  *cancellable,
3100                                   GError       **error)
3101 {
3102   GFileIface *iface;
3103   GError *my_error;
3104   GFileAttributeInfoList *list;
3105
3106   g_return_val_if_fail (G_IS_FILE (file), NULL);
3107
3108   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3109     return NULL;
3110
3111   iface = G_FILE_GET_IFACE (file);
3112
3113   if (iface->query_settable_attributes == NULL)
3114     return g_file_attribute_info_list_new ();
3115
3116   my_error = NULL;
3117   list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3118
3119   if (list == NULL)
3120     {
3121       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3122         {
3123           list = g_file_attribute_info_list_new ();
3124           g_error_free (my_error);
3125         }
3126       else
3127         g_propagate_error (error, my_error);
3128     }
3129
3130   return list;
3131 }
3132
3133 /**
3134  * g_file_query_writable_namespaces:
3135  * @file: input #GFile.
3136  * @cancellable: optional #GCancellable object, %NULL to ignore.
3137  * @error: a #GError, or %NULL
3138  *
3139  * Obtain the list of attribute namespaces where new attributes
3140  * can be created by a user. An example of this is extended
3141  * attributes (in the "xattr" namespace).
3142  *
3143  * If @cancellable is not %NULL, then the operation can be cancelled by
3144  * triggering the cancellable object from another thread. If the operation
3145  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3146  *
3147  * Returns: a #GFileAttributeInfoList describing the writable namespaces.
3148  * When you are done with it, release it with g_file_attribute_info_list_unref()
3149  **/
3150 GFileAttributeInfoList *
3151 g_file_query_writable_namespaces (GFile         *file,
3152                                   GCancellable  *cancellable,
3153                                   GError       **error)
3154 {
3155   GFileIface *iface;
3156   GError *my_error;
3157   GFileAttributeInfoList *list;
3158
3159   g_return_val_if_fail (G_IS_FILE (file), NULL);
3160
3161   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3162     return NULL;
3163
3164   iface = G_FILE_GET_IFACE (file);
3165
3166   if (iface->query_writable_namespaces == NULL)
3167     return g_file_attribute_info_list_new ();
3168
3169   my_error = NULL;
3170   list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
3171
3172   if (list == NULL)
3173     {
3174       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3175         {
3176           list = g_file_attribute_info_list_new ();
3177           g_error_free (my_error);
3178         }
3179       else
3180         g_propagate_error (error, my_error);
3181     }
3182
3183   return list;
3184 }
3185
3186 /**
3187  * g_file_set_attribute:
3188  * @file: input #GFile.
3189  * @attribute: a string containing the attribute's name.
3190  * @type: The type of the attribute
3191  * @value_p: a pointer to the value (or the pointer itself if the type is a pointer type)
3192  * @flags: a set of #GFileQueryInfoFlags.
3193  * @cancellable: optional #GCancellable object, %NULL to ignore.
3194  * @error: a #GError, or %NULL
3195  *
3196  * Sets an attribute in the file with attribute name @attribute to @value.
3197  *
3198  * If @cancellable is not %NULL, then the operation can be cancelled by
3199  * triggering the cancellable object from another thread. If the operation
3200  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3201  *
3202  * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3203  **/
3204 gboolean
3205 g_file_set_attribute (GFile                      *file,
3206                       const char                 *attribute,
3207                       GFileAttributeType          type,
3208                       gpointer                    value_p,
3209                       GFileQueryInfoFlags         flags,
3210                       GCancellable               *cancellable,
3211                       GError                    **error)
3212 {
3213   GFileIface *iface;
3214
3215   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3216   g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
3217
3218   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3219     return FALSE;
3220
3221   iface = G_FILE_GET_IFACE (file);
3222
3223   if (iface->set_attribute == NULL)
3224     {
3225       g_set_error_literal (error, G_IO_ERROR,
3226                            G_IO_ERROR_NOT_SUPPORTED,
3227                            _("Operation not supported"));
3228       return FALSE;
3229     }
3230
3231   return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
3232 }
3233
3234 /**
3235  * g_file_set_attributes_from_info:
3236  * @file: input #GFile.
3237  * @info: a #GFileInfo.
3238  * @flags: #GFileQueryInfoFlags
3239  * @cancellable: optional #GCancellable object, %NULL to ignore.
3240  * @error: a #GError, or %NULL
3241  *
3242  * Tries to set all attributes in the #GFileInfo on the target values,
3243  * not stopping on the first error.
3244  *
3245  * If there is any error during this operation then @error will be set to
3246  * the first error. Error on particular fields are flagged by setting
3247  * the "status" field in the attribute value to
3248  * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
3249  * further errors.
3250  *
3251  * If @cancellable is not %NULL, then the operation can be cancelled by
3252  * triggering the cancellable object from another thread. If the operation
3253  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3254  *
3255  * Returns: %TRUE if there was any error, %FALSE otherwise.
3256  **/
3257 gboolean
3258 g_file_set_attributes_from_info (GFile                *file,
3259                                  GFileInfo            *info,
3260                                  GFileQueryInfoFlags   flags,
3261                                  GCancellable         *cancellable,
3262                                  GError              **error)
3263 {
3264   GFileIface *iface;
3265
3266   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3267   g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
3268
3269   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3270     return FALSE;
3271
3272   g_file_info_clear_status (info);
3273
3274   iface = G_FILE_GET_IFACE (file);
3275
3276   return (* iface->set_attributes_from_info) (file,
3277                                               info,
3278                                               flags,
3279                                               cancellable,
3280                                               error);
3281 }
3282
3283
3284 static gboolean
3285 g_file_real_set_attributes_from_info (GFile                *file,
3286                                       GFileInfo            *info,
3287                                       GFileQueryInfoFlags   flags,
3288                                       GCancellable         *cancellable,
3289                                       GError              **error)
3290 {
3291   char **attributes;
3292   int i;
3293   gboolean res;
3294   GFileAttributeValue *value;
3295
3296   res = TRUE;
3297
3298   attributes = g_file_info_list_attributes (info, NULL);
3299
3300   for (i = 0; attributes[i] != NULL; i++)
3301     {
3302       value = _g_file_info_get_attribute_value (info, attributes[i]);
3303
3304       if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
3305         continue;
3306
3307       if (!g_file_set_attribute (file, attributes[i],
3308                                  value->type, _g_file_attribute_value_peek_as_pointer (value),
3309                                  flags, cancellable, error))
3310         {
3311           value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3312           res = FALSE;
3313           /* Don't set error multiple times */
3314           error = NULL;
3315         }
3316       else
3317         value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3318     }
3319
3320   g_strfreev (attributes);
3321
3322   return res;
3323 }
3324
3325 /**
3326  * g_file_set_attributes_async:
3327  * @file: input #GFile.
3328  * @info: a #GFileInfo.
3329  * @flags: a #GFileQueryInfoFlags.
3330  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3331  *     of the request.
3332  * @cancellable: optional #GCancellable object, %NULL to ignore.
3333  * @callback: a #GAsyncReadyCallback.
3334  * @user_data: a #gpointer.
3335  *
3336  * Asynchronously sets the attributes of @file with @info.
3337  *
3338  * For more details, see g_file_set_attributes_from_info() which is
3339  * the synchronous version of this call.
3340  *
3341  * When the operation is finished, @callback will be called. You can then call
3342  * g_file_set_attributes_finish() to get the result of the operation.
3343  **/
3344 void
3345 g_file_set_attributes_async (GFile               *file,
3346                              GFileInfo           *info,
3347                              GFileQueryInfoFlags  flags,
3348                              int                  io_priority,
3349                              GCancellable        *cancellable,
3350                              GAsyncReadyCallback  callback,
3351                              gpointer             user_data)
3352 {
3353   GFileIface *iface;
3354
3355   g_return_if_fail (G_IS_FILE (file));
3356   g_return_if_fail (G_IS_FILE_INFO (info));
3357
3358   iface = G_FILE_GET_IFACE (file);
3359   (* iface->set_attributes_async) (file,
3360                                    info,
3361                                    flags,
3362                                    io_priority,
3363                                    cancellable,
3364                                    callback,
3365                                    user_data);
3366 }
3367
3368 /**
3369  * g_file_set_attributes_finish:
3370  * @file: input #GFile.
3371  * @result: a #GAsyncResult.
3372  * @info: a #GFileInfo.
3373  * @error: a #GError, or %NULL
3374  *
3375  * Finishes setting an attribute started in g_file_set_attributes_async().
3376  *
3377  * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
3378  **/
3379 gboolean
3380 g_file_set_attributes_finish (GFile         *file,
3381                               GAsyncResult  *result,
3382                               GFileInfo    **info,
3383                               GError       **error)
3384 {
3385   GFileIface *iface;
3386
3387   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3388   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3389
3390   /* No standard handling of errors here, as we must set info even
3391    * on errors
3392    */
3393   iface = G_FILE_GET_IFACE (file);
3394   return (* iface->set_attributes_finish) (file, result, info, error);
3395 }
3396
3397 /**
3398  * g_file_set_attribute_string:
3399  * @file: input #GFile.
3400  * @attribute: a string containing the attribute's name.
3401  * @value: a string containing the attribute's value.
3402  * @flags: #GFileQueryInfoFlags.
3403  * @cancellable: optional #GCancellable object, %NULL to ignore.
3404  * @error: a #GError, or %NULL
3405  *
3406  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
3407  * If @attribute is of a different type, this operation will fail.
3408  *
3409  * If @cancellable is not %NULL, then the operation can be cancelled by
3410  * triggering the cancellable object from another thread. If the operation
3411  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3412  *
3413  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
3414  **/
3415 gboolean
3416 g_file_set_attribute_string (GFile                *file,
3417                              const char           *attribute,
3418                              const char           *value,
3419                              GFileQueryInfoFlags   flags,
3420                              GCancellable         *cancellable,
3421                              GError              **error)
3422 {
3423   return g_file_set_attribute (file, attribute,
3424                                G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
3425                                flags, cancellable, error);
3426 }
3427
3428 /**
3429  * g_file_set_attribute_byte_string:
3430  * @file: input #GFile.
3431  * @attribute: a string containing the attribute's name.
3432  * @value: a string containing the attribute's new value.
3433  * @flags: a #GFileQueryInfoFlags.
3434  * @cancellable: optional #GCancellable object, %NULL to ignore.
3435  * @error: a #GError, or %NULL
3436  *
3437  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
3438  * If @attribute is of a different type, this operation will fail,
3439  * returning %FALSE.
3440  *
3441  * If @cancellable is not %NULL, then the operation can be cancelled by
3442  * triggering the cancellable object from another thread. If the operation
3443  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3444  *
3445  * Returns: %TRUE if the @attribute was successfully set to @value
3446  * in the @file, %FALSE otherwise.
3447  **/
3448 gboolean
3449 g_file_set_attribute_byte_string  (GFile                *file,
3450                                    const char           *attribute,
3451                                    const char           *value,
3452                                    GFileQueryInfoFlags   flags,
3453                                    GCancellable         *cancellable,
3454                                    GError              **error)
3455 {
3456   return g_file_set_attribute (file, attribute,
3457                                G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
3458                                flags, cancellable, error);
3459 }
3460
3461 /**
3462  * g_file_set_attribute_uint32:
3463  * @file: input #GFile.
3464  * @attribute: a string containing the attribute's name.
3465  * @value: a #guint32 containing the attribute's new value.
3466  * @flags: a #GFileQueryInfoFlags.
3467  * @cancellable: optional #GCancellable object, %NULL to ignore.
3468  * @error: a #GError, or %NULL
3469  *
3470  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
3471  * If @attribute is of a different type, this operation will fail.
3472  *
3473  * If @cancellable is not %NULL, then the operation can be cancelled by
3474  * triggering the cancellable object from another thread. If the operation
3475  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3476  *
3477  * Returns: %TRUE if the @attribute was successfully set to @value
3478  * in the @file, %FALSE otherwise.
3479  **/
3480 gboolean
3481 g_file_set_attribute_uint32 (GFile                *file,
3482                              const char           *attribute,
3483                              guint32               value,
3484                              GFileQueryInfoFlags   flags,
3485                              GCancellable         *cancellable,
3486                              GError              **error)
3487 {
3488   return g_file_set_attribute (file, attribute,
3489                                G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
3490                                flags, cancellable, error);
3491 }
3492
3493 /**
3494  * g_file_set_attribute_int32:
3495  * @file: input #GFile.
3496  * @attribute: a string containing the attribute's name.
3497  * @value: a #gint32 containing the attribute's new value.
3498  * @flags: a #GFileQueryInfoFlags.
3499  * @cancellable: optional #GCancellable object, %NULL to ignore.
3500  * @error: a #GError, or %NULL
3501  *
3502  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
3503  * If @attribute is of a different type, this operation will fail.
3504  *
3505  * If @cancellable is not %NULL, then the operation can be cancelled by
3506  * triggering the cancellable object from another thread. If the operation
3507  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3508  *
3509  * Returns: %TRUE if the @attribute was successfully set to @value
3510  * in the @file, %FALSE otherwise.
3511  **/
3512 gboolean
3513 g_file_set_attribute_int32 (GFile                *file,
3514                             const char           *attribute,
3515                             gint32                value,
3516                             GFileQueryInfoFlags   flags,
3517                             GCancellable         *cancellable,
3518                             GError              **error)
3519 {
3520   return g_file_set_attribute (file, attribute,
3521                                G_FILE_ATTRIBUTE_TYPE_INT32, &value,
3522                                flags, cancellable, error);
3523 }
3524
3525 /**
3526  * g_file_set_attribute_uint64:
3527  * @file: input #GFile.
3528  * @attribute: a string containing the attribute's name.
3529  * @value: a #guint64 containing the attribute's new value.
3530  * @flags: a #GFileQueryInfoFlags.
3531  * @cancellable: optional #GCancellable object, %NULL to ignore.
3532  * @error: a #GError, or %NULL
3533  *
3534  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
3535  * If @attribute is of a different type, this operation will fail.
3536  *
3537  * If @cancellable is not %NULL, then the operation can be cancelled by
3538  * triggering the cancellable object from another thread. If the operation
3539  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3540  *
3541  * Returns: %TRUE if the @attribute was successfully set to @value
3542  * in the @file, %FALSE otherwise.
3543  **/
3544 gboolean
3545 g_file_set_attribute_uint64 (GFile                *file,
3546                              const char           *attribute,
3547                              guint64               value,
3548                              GFileQueryInfoFlags   flags,
3549                              GCancellable         *cancellable,
3550                              GError              **error)
3551  {
3552   return g_file_set_attribute (file, attribute,
3553                                G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
3554                                flags, cancellable, error);
3555 }
3556
3557 /**
3558  * g_file_set_attribute_int64:
3559  * @file: input #GFile.
3560  * @attribute: a string containing the attribute's name.
3561  * @value: a #guint64 containing the attribute's new value.
3562  * @flags: a #GFileQueryInfoFlags.
3563  * @cancellable: optional #GCancellable object, %NULL to ignore.
3564  * @error: a #GError, or %NULL
3565  *
3566  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
3567  * If @attribute is of a different type, this operation will fail.
3568  *
3569  * If @cancellable is not %NULL, then the operation can be cancelled by
3570  * triggering the cancellable object from another thread. If the operation
3571  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3572  *
3573  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
3574  **/
3575 gboolean
3576 g_file_set_attribute_int64 (GFile                *file,
3577                             const char           *attribute,
3578                             gint64                value,
3579                             GFileQueryInfoFlags   flags,
3580                             GCancellable         *cancellable,
3581                             GError              **error)
3582 {
3583   return g_file_set_attribute (file, attribute,
3584                                G_FILE_ATTRIBUTE_TYPE_INT64, &value,
3585                                flags, cancellable, error);
3586 }
3587
3588 /**
3589  * g_file_mount_mountable:
3590  * @file: input #GFile.
3591  * @flags: flags affecting the operation
3592  * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
3593  * @cancellable: optional #GCancellable object, %NULL to ignore.
3594  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3595  * @user_data: the data to pass to callback function
3596  *
3597  * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
3598  * Using @mount_operation, you can request callbacks when, for instance,
3599  * passwords are needed during authentication.
3600  *
3601  * If @cancellable is not %NULL, then the operation can be cancelled by
3602  * triggering the cancellable object from another thread. If the operation
3603  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3604  *
3605  * When the operation is finished, @callback will be called. You can then call
3606  * g_file_mount_mountable_finish() to get the result of the operation.
3607  **/
3608 void
3609 g_file_mount_mountable (GFile               *file,
3610                         GMountMountFlags     flags,
3611                         GMountOperation     *mount_operation,
3612                         GCancellable        *cancellable,
3613                         GAsyncReadyCallback  callback,
3614                         gpointer             user_data)
3615 {
3616   GFileIface *iface;
3617
3618   g_return_if_fail (G_IS_FILE (file));
3619
3620   iface = G_FILE_GET_IFACE (file);
3621
3622   if (iface->mount_mountable == NULL)
3623     {
3624       g_simple_async_report_error_in_idle (G_OBJECT (file),
3625                                            callback,
3626                                            user_data,
3627                                            G_IO_ERROR,
3628                                            G_IO_ERROR_NOT_SUPPORTED,
3629                                            _("Operation not supported"));
3630       return;
3631     }
3632
3633   (* iface->mount_mountable) (file,
3634                               flags,
3635                               mount_operation,
3636                               cancellable,
3637                               callback,
3638                               user_data);
3639 }
3640
3641 /**
3642  * g_file_mount_mountable_finish:
3643  * @file: input #GFile.
3644  * @result: a #GAsyncResult.
3645  * @error: a #GError, or %NULL
3646  *
3647  * Finishes a mount operation. See g_file_mount_mountable() for details.
3648  *
3649  * Finish an asynchronous mount operation that was started
3650  * with g_file_mount_mountable().
3651  *
3652  * Returns: a #GFile or %NULL on error.
3653  *     Free the returned object with g_object_unref().
3654  **/
3655 GFile *
3656 g_file_mount_mountable_finish (GFile         *file,
3657                                GAsyncResult  *result,
3658                                GError       **error)
3659 {
3660   GFileIface *iface;
3661
3662   g_return_val_if_fail (G_IS_FILE (file), NULL);
3663   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
3664
3665   if (G_IS_SIMPLE_ASYNC_RESULT (result))
3666     {
3667       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3668       if (g_simple_async_result_propagate_error (simple, error))
3669         return NULL;
3670     }
3671
3672   iface = G_FILE_GET_IFACE (file);
3673   return (* iface->mount_mountable_finish) (file, result, error);
3674 }
3675
3676 /**
3677  * g_file_unmount_mountable:
3678  * @file: input #GFile.
3679  * @flags: flags affecting the operation
3680  * @cancellable: optional #GCancellable object, %NULL to ignore.
3681  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3682  * @user_data: the data to pass to callback function
3683  *
3684  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
3685  *
3686  * If @cancellable is not %NULL, then the operation can be cancelled by
3687  * triggering the cancellable object from another thread. If the operation
3688  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3689  *
3690  * When the operation is finished, @callback will be called. You can then call
3691  * g_file_unmount_mountable_finish() to get the result of the operation.
3692  **/
3693 void
3694 g_file_unmount_mountable (GFile               *file,
3695                           GMountUnmountFlags   flags,
3696                           GCancellable        *cancellable,
3697                           GAsyncReadyCallback  callback,
3698                           gpointer             user_data)
3699 {
3700   GFileIface *iface;
3701
3702   g_return_if_fail (G_IS_FILE (file));
3703
3704   iface = G_FILE_GET_IFACE (file);
3705
3706   if (iface->unmount_mountable == NULL)
3707     {
3708       g_simple_async_report_error_in_idle (G_OBJECT (file),
3709                                            callback,
3710                                            user_data,
3711                                            G_IO_ERROR,
3712                                            G_IO_ERROR_NOT_SUPPORTED,
3713                                            _("Operation not supported"));
3714       return;
3715     }
3716
3717   (* iface->unmount_mountable) (file,
3718                                 flags,
3719                                 cancellable,
3720                                 callback,
3721                                 user_data);
3722 }
3723
3724 /**
3725  * g_file_unmount_mountable_finish:
3726  * @file: input #GFile.
3727  * @result: a #GAsyncResult.
3728  * @error: a #GError, or %NULL
3729  *
3730  * Finishes an unmount operation, see g_file_unmount_mountable() for details.
3731  *
3732  * Finish an asynchronous unmount operation that was started
3733  * with g_file_unmount_mountable().
3734  *
3735  * Returns: %TRUE if the operation finished successfully. %FALSE
3736  * otherwise.
3737  **/
3738 gboolean
3739 g_file_unmount_mountable_finish (GFile         *file,
3740                                  GAsyncResult  *result,
3741                                  GError       **error)
3742 {
3743   GFileIface *iface;
3744
3745   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3746   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3747
3748   if (G_IS_SIMPLE_ASYNC_RESULT (result))
3749     {
3750       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3751       if (g_simple_async_result_propagate_error (simple, error))
3752         return FALSE;
3753     }
3754
3755   iface = G_FILE_GET_IFACE (file);
3756   return (* iface->unmount_mountable_finish) (file, result, error);
3757 }
3758
3759 /**
3760  * g_file_eject_mountable:
3761  * @file: input #GFile.
3762  * @flags: flags affecting the operation
3763  * @cancellable: optional #GCancellable object, %NULL to ignore.
3764  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3765  * @user_data: the data to pass to callback function
3766  *
3767  * Starts an asynchronous eject on a mountable.
3768  * When this operation has completed, @callback will be called with
3769  * @user_user data, and the operation can be finalized with
3770  * g_file_eject_mountable_finish().
3771  *
3772  * If @cancellable is not %NULL, then the operation can be cancelled by
3773  * triggering the cancellable object from another thread. If the operation
3774  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3775  **/
3776 void
3777 g_file_eject_mountable (GFile               *file,
3778                         GMountUnmountFlags   flags,
3779                         GCancellable        *cancellable,
3780                         GAsyncReadyCallback  callback,
3781                         gpointer             user_data)
3782 {
3783   GFileIface *iface;
3784
3785   g_return_if_fail (G_IS_FILE (file));
3786
3787   iface = G_FILE_GET_IFACE (file);
3788
3789   if (iface->eject_mountable == NULL)
3790     {
3791       g_simple_async_report_error_in_idle (G_OBJECT (file),
3792                                            callback,
3793                                            user_data,
3794                                            G_IO_ERROR,
3795                                            G_IO_ERROR_NOT_SUPPORTED,
3796                                            _("Operation not supported"));
3797       return;
3798     }
3799
3800   (* iface->eject_mountable) (file,
3801                               flags,
3802                               cancellable,
3803                               callback,
3804                               user_data);
3805 }
3806
3807 /**
3808  * g_file_eject_mountable_finish:
3809  * @file: input #GFile.
3810  * @result: a #GAsyncResult.
3811  * @error: a #GError, or %NULL
3812  *
3813  * Finishes an asynchronous eject operation started by
3814  * g_file_eject_mountable().
3815  *
3816  * Returns: %TRUE if the @file was ejected successfully. %FALSE
3817  * otherwise.
3818  **/
3819 gboolean
3820 g_file_eject_mountable_finish (GFile         *file,
3821                                GAsyncResult  *result,
3822                                GError       **error)
3823 {
3824   GFileIface *iface;
3825
3826   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3827   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3828
3829   if (G_IS_SIMPLE_ASYNC_RESULT (result))
3830     {
3831       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3832       if (g_simple_async_result_propagate_error (simple, error))
3833         return FALSE;
3834     }
3835
3836   iface = G_FILE_GET_IFACE (file);
3837   return (* iface->eject_mountable_finish) (file, result, error);
3838 }
3839
3840 /**
3841  * g_file_monitor_directory:
3842  * @file: input #GFile.
3843  * @flags: a set of #GFileMonitorFlags.
3844  * @cancellable: optional #GCancellable object, %NULL to ignore.
3845  * @error: a #GError, or %NULL.
3846  *
3847  * Obtains a directory monitor for the given file.
3848  * This may fail if directory monitoring is not supported.
3849  *
3850  * If @cancellable is not %NULL, then the operation can be cancelled by
3851  * triggering the cancellable object from another thread. If the operation
3852  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3853  *
3854  * Returns: a #GFileMonitor for the given @file, or %NULL on error.
3855  *     Free the returned object with g_object_unref().
3856  **/
3857 GFileMonitor*
3858 g_file_monitor_directory (GFile             *file,
3859                           GFileMonitorFlags  flags,
3860                           GCancellable      *cancellable,
3861                           GError           **error)
3862 {
3863   GFileIface *iface;
3864
3865   g_return_val_if_fail (G_IS_FILE (file), NULL);
3866
3867   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3868     return NULL;
3869
3870   iface = G_FILE_GET_IFACE (file);
3871
3872   if (iface->monitor_dir == NULL)
3873     {
3874       g_set_error_literal (error, G_IO_ERROR,
3875                            G_IO_ERROR_NOT_SUPPORTED,
3876                            _("Operation not supported"));
3877       return NULL;
3878     }
3879
3880   return (* iface->monitor_dir) (file, flags, cancellable, error);
3881 }
3882
3883 /**
3884  * g_file_monitor_file:
3885  * @file: input #GFile.
3886  * @flags: a set of #GFileMonitorFlags.
3887  * @cancellable: optional #GCancellable object, %NULL to ignore.
3888  * @error: a #GError, or %NULL.
3889  *
3890  * Obtains a file monitor for the given file. If no file notification
3891  * mechanism exists, then regular polling of the file is used.
3892  *
3893  * If @cancellable is not %NULL, then the operation can be cancelled by
3894  * triggering the cancellable object from another thread. If the operation
3895  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3896  *
3897  * Returns: a #GFileMonitor for the given @file, or %NULL on error.
3898  *     Free the returned object with g_object_unref().
3899  **/
3900 GFileMonitor*
3901 g_file_monitor_file (GFile             *file,
3902                      GFileMonitorFlags  flags,
3903                      GCancellable      *cancellable,
3904                      GError           **error)
3905 {
3906   GFileIface *iface;
3907   GFileMonitor *monitor;
3908
3909   g_return_val_if_fail (G_IS_FILE (file), NULL);
3910
3911   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3912     return NULL;
3913
3914   iface = G_FILE_GET_IFACE (file);
3915
3916   monitor = NULL;
3917
3918   if (iface->monitor_file)
3919     monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
3920
3921 /* Fallback to polling */
3922   if (monitor == NULL)
3923     monitor = _g_poll_file_monitor_new (file);
3924
3925   return monitor;
3926 }
3927
3928 /**
3929  * g_file_monitor:
3930  * @file: input #GFile
3931  * @flags: a set of #GFileMonitorFlags
3932  * @cancellable: optional #GCancellable object, %NULL to ignore
3933  * @error: a #GError, or %NULL
3934  *
3935  * Obtains a file or directory monitor for the given file, depending
3936  * on the type of the file.
3937  *
3938  * If @cancellable is not %NULL, then the operation can be cancelled by
3939  * triggering the cancellable object from another thread. If the operation
3940  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3941  *
3942  * Returns: a #GFileMonitor for the given @file, or %NULL on error.
3943  *     Free the returned object with g_object_unref().
3944  *
3945  * Since: 2.18
3946  */
3947 GFileMonitor*
3948 g_file_monitor (GFile             *file,
3949                 GFileMonitorFlags  flags,
3950                 GCancellable      *cancellable,
3951                 GError           **error)
3952 {
3953   if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
3954     return g_file_monitor_directory (file, flags, cancellable, error);
3955   else
3956     return g_file_monitor_file (file, flags, cancellable, error);
3957 }
3958
3959 /********************************************
3960  *   Default implementation of async ops    *
3961  ********************************************/
3962
3963 typedef struct {
3964   char *attributes;
3965   GFileQueryInfoFlags flags;
3966   GFileInfo *info;
3967 } QueryInfoAsyncData;
3968
3969 static void
3970 query_info_data_free (QueryInfoAsyncData *data)
3971 {
3972   if (data->info)
3973     g_object_unref (data->info);
3974   g_free (data->attributes);
3975   g_free (data);
3976 }
3977
3978 static void
3979 query_info_async_thread (GSimpleAsyncResult *res,
3980                          GObject            *object,
3981                          GCancellable       *cancellable)
3982 {
3983   GError *error = NULL;
3984   QueryInfoAsyncData *data;
3985   GFileInfo *info;
3986
3987   data = g_simple_async_result_get_op_res_gpointer (res);
3988
3989   info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
3990
3991   if (info == NULL)
3992     {
3993       g_simple_async_result_set_from_error (res, error);
3994       g_error_free (error);
3995     }
3996   else
3997     data->info = info;
3998 }
3999
4000 static void
4001 g_file_real_query_info_async (GFile               *file,
4002                               const char          *attributes,
4003                               GFileQueryInfoFlags  flags,
4004                               int                  io_priority,
4005                               GCancellable        *cancellable,
4006                               GAsyncReadyCallback  callback,
4007                               gpointer             user_data)
4008 {
4009   GSimpleAsyncResult *res;
4010   QueryInfoAsyncData *data;
4011
4012   data = g_new0 (QueryInfoAsyncData, 1);
4013   data->attributes = g_strdup (attributes);
4014   data->flags = flags;
4015
4016   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
4017   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
4018
4019   g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
4020   g_object_unref (res);
4021 }
4022
4023 static GFileInfo *
4024 g_file_real_query_info_finish (GFile         *file,
4025                                GAsyncResult  *res,
4026                                GError       **error)
4027 {
4028   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4029   QueryInfoAsyncData *data;
4030
4031   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
4032
4033   data = g_simple_async_result_get_op_res_gpointer (simple);
4034   if (data->info)
4035     return g_object_ref (data->info);
4036
4037   return NULL;
4038 }
4039
4040 typedef struct {
4041   char *attributes;
4042   GFileInfo *info;
4043 } QueryFilesystemInfoAsyncData;
4044
4045 static void
4046 query_filesystem_info_data_free (QueryFilesystemInfoAsyncData *data)
4047 {
4048   if (data->info)
4049     g_object_unref (data->info);
4050   g_free (data->attributes);
4051   g_free (data);
4052 }
4053
4054 static void
4055 query_filesystem_info_async_thread (GSimpleAsyncResult *res,
4056                                     GObject            *object,
4057                                     GCancellable       *cancellable)
4058 {
4059   GError *error = NULL;
4060   QueryFilesystemInfoAsyncData *data;
4061   GFileInfo *info;
4062
4063   data = g_simple_async_result_get_op_res_gpointer (res);
4064
4065   info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error);
4066
4067   if (info == NULL)
4068     {
4069       g_simple_async_result_set_from_error (res, error);
4070       g_error_free (error);
4071     }
4072   else
4073     data->info = info;
4074 }
4075
4076 static void
4077 g_file_real_query_filesystem_info_async (GFile               *file,
4078                                          const char          *attributes,
4079                                          int                  io_priority,
4080                                          GCancellable        *cancellable,
4081                                          GAsyncReadyCallback  callback,
4082                                          gpointer             user_data)
4083 {
4084   GSimpleAsyncResult *res;
4085   QueryFilesystemInfoAsyncData *data;
4086
4087   data = g_new0 (QueryFilesystemInfoAsyncData, 1);
4088   data->attributes = g_strdup (attributes);
4089
4090   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async);
4091   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free);
4092
4093   g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable);
4094   g_object_unref (res);
4095 }
4096
4097 static GFileInfo *
4098 g_file_real_query_filesystem_info_finish (GFile         *file,
4099                                           GAsyncResult  *res,
4100                                           GError       **error)
4101 {
4102   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4103   QueryFilesystemInfoAsyncData *data;
4104
4105   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_filesystem_info_async);
4106
4107   data = g_simple_async_result_get_op_res_gpointer (simple);
4108   if (data->info)
4109     return g_object_ref (data->info);
4110
4111   return NULL;
4112 }
4113
4114 typedef struct {
4115   char *attributes;
4116   GFileQueryInfoFlags flags;
4117   GFileEnumerator *enumerator;
4118 } EnumerateChildrenAsyncData;
4119
4120 static void
4121 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
4122 {
4123   if (data->enumerator)
4124     g_object_unref (data->enumerator);
4125   g_free (data->attributes);
4126   g_free (data);
4127 }
4128
4129 static void
4130 enumerate_children_async_thread (GSimpleAsyncResult *res,
4131                                  GObject            *object,
4132                                  GCancellable       *cancellable)
4133 {
4134   GError *error = NULL;
4135   EnumerateChildrenAsyncData *data;
4136   GFileEnumerator *enumerator;
4137
4138   data = g_simple_async_result_get_op_res_gpointer (res);
4139
4140   enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4141
4142   if (enumerator == NULL)
4143     {
4144       g_simple_async_result_set_from_error (res, error);
4145       g_error_free (error);
4146     }
4147   else
4148     data->enumerator = enumerator;
4149 }
4150
4151 static void
4152 g_file_real_enumerate_children_async (GFile               *file,
4153                                       const char          *attributes,
4154                                       GFileQueryInfoFlags  flags,
4155                                       int                  io_priority,
4156                                       GCancellable        *cancellable,
4157                                       GAsyncReadyCallback  callback,
4158                                       gpointer             user_data)
4159 {
4160   GSimpleAsyncResult *res;
4161   EnumerateChildrenAsyncData *data;
4162
4163   data = g_new0 (EnumerateChildrenAsyncData, 1);
4164   data->attributes = g_strdup (attributes);
4165   data->flags = flags;
4166
4167   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
4168   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
4169
4170   g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
4171   g_object_unref (res);
4172 }
4173
4174 static GFileEnumerator *
4175 g_file_real_enumerate_children_finish (GFile         *file,
4176                                        GAsyncResult  *res,
4177                                        GError       **error)
4178 {
4179   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4180   EnumerateChildrenAsyncData *data;
4181
4182   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
4183
4184   data = g_simple_async_result_get_op_res_gpointer (simple);
4185   if (data->enumerator)
4186     return g_object_ref (data->enumerator);
4187
4188   return NULL;
4189 }
4190
4191 static void
4192 open_read_async_thread (GSimpleAsyncResult *res,
4193                         GObject            *object,
4194                         GCancellable       *cancellable)
4195 {
4196   GFileIface *iface;
4197   GFileInputStream *stream;
4198   GError *error = NULL;
4199
4200   iface = G_FILE_GET_IFACE (object);
4201
4202   if (iface->read_fn == NULL)
4203     {
4204       g_set_error_literal (error, G_IO_ERROR,
4205                            G_IO_ERROR_NOT_SUPPORTED,
4206                            _("Operation not supported"));
4207
4208       g_simple_async_result_set_from_error (res, error);
4209       g_error_free (error);
4210
4211       return;
4212     }
4213
4214   stream = iface->read_fn (G_FILE (object), cancellable, &error);
4215
4216   if (stream == NULL)
4217     {
4218       g_simple_async_result_set_from_error (res, error);
4219       g_error_free (error);
4220     }
4221   else
4222     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
4223 }
4224
4225 static void
4226 g_file_real_read_async (GFile               *file,
4227                         int                  io_priority,
4228                         GCancellable        *cancellable,
4229                         GAsyncReadyCallback  callback,
4230                         gpointer             user_data)
4231 {
4232   GSimpleAsyncResult *res;
4233
4234   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
4235
4236   g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
4237   g_object_unref (res);
4238 }
4239
4240 static GFileInputStream *
4241 g_file_real_read_finish (GFile         *file,
4242                          GAsyncResult  *res,
4243                          GError       **error)
4244 {
4245   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4246   gpointer op;
4247
4248   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
4249
4250   op = g_simple_async_result_get_op_res_gpointer (simple);
4251   if (op)
4252     return g_object_ref (op);
4253
4254   return NULL;
4255 }
4256
4257 static void
4258 append_to_async_thread (GSimpleAsyncResult *res,
4259                         GObject            *object,
4260                         GCancellable       *cancellable)
4261 {
4262   GFileIface *iface;
4263   GFileCreateFlags *data;
4264   GFileOutputStream *stream;
4265   GError *error = NULL;
4266
4267   iface = G_FILE_GET_IFACE (object);
4268
4269   data = g_simple_async_result_get_op_res_gpointer (res);
4270
4271   stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
4272
4273   if (stream == NULL)
4274     {
4275       g_simple_async_result_set_from_error (res, error);
4276       g_error_free (error);
4277     }
4278   else
4279     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
4280 }
4281
4282 static void
4283 g_file_real_append_to_async (GFile               *file,
4284                              GFileCreateFlags     flags,
4285                              int                  io_priority,
4286                              GCancellable        *cancellable,
4287                              GAsyncReadyCallback  callback,
4288                              gpointer             user_data)
4289 {
4290   GFileCreateFlags *data;
4291   GSimpleAsyncResult *res;
4292
4293   data = g_new0 (GFileCreateFlags, 1);
4294   *data = flags;
4295
4296   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
4297   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
4298
4299   g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
4300   g_object_unref (res);
4301 }
4302
4303 static GFileOutputStream *
4304 g_file_real_append_to_finish (GFile         *file,
4305                               GAsyncResult  *res,
4306                               GError       **error)
4307 {
4308   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4309   gpointer op;
4310
4311   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
4312
4313   op = g_simple_async_result_get_op_res_gpointer (simple);
4314   if (op)
4315     return g_object_ref (op);
4316
4317   return NULL;
4318 }
4319
4320 static void
4321 create_async_thread (GSimpleAsyncResult *res,
4322                      GObject            *object,
4323                      GCancellable       *cancellable)
4324 {
4325   GFileIface *iface;
4326   GFileCreateFlags *data;
4327   GFileOutputStream *stream;
4328   GError *error = NULL;
4329
4330   iface = G_FILE_GET_IFACE (object);
4331
4332   data = g_simple_async_result_get_op_res_gpointer (res);
4333
4334   stream = iface->create (G_FILE (object), *data, cancellable, &error);
4335
4336   if (stream == NULL)
4337     {
4338       g_simple_async_result_set_from_error (res, error);
4339       g_error_free (error);
4340     }
4341   else
4342     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
4343 }
4344
4345 static void
4346 g_file_real_create_async (GFile               *file,
4347                           GFileCreateFlags     flags,
4348                           int                  io_priority,
4349                           GCancellable        *cancellable,
4350                           GAsyncReadyCallback  callback,
4351                           gpointer             user_data)
4352 {
4353   GFileCreateFlags *data;
4354   GSimpleAsyncResult *res;
4355
4356   data = g_new0 (GFileCreateFlags, 1);
4357   *data = flags;
4358
4359   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
4360   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
4361
4362   g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
4363   g_object_unref (res);
4364 }
4365
4366 static GFileOutputStream *
4367 g_file_real_create_finish (GFile         *file,
4368                            GAsyncResult  *res,
4369                            GError       **error)
4370 {
4371   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4372   gpointer op;
4373
4374   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
4375
4376   op = g_simple_async_result_get_op_res_gpointer (simple);
4377   if (op)
4378     return g_object_ref (op);
4379
4380   return NULL;
4381 }
4382
4383 typedef struct {
4384   GFileOutputStream *stream;
4385   char *etag;
4386   gboolean make_backup;
4387   GFileCreateFlags flags;
4388 } ReplaceAsyncData;
4389
4390 static void
4391 replace_async_data_free (ReplaceAsyncData *data)
4392 {
4393   if (data->stream)
4394     g_object_unref (data->stream);
4395   g_free (data->etag);
4396   g_free (data);
4397 }
4398
4399 static void
4400 replace_async_thread (GSimpleAsyncResult *res,
4401                       GObject            *object,
4402                       GCancellable       *cancellable)
4403 {
4404   GFileIface *iface;
4405   GFileOutputStream *stream;
4406   GError *error = NULL;
4407   ReplaceAsyncData *data;
4408
4409   iface = G_FILE_GET_IFACE (object);
4410
4411   data = g_simple_async_result_get_op_res_gpointer (res);
4412
4413   stream = iface->replace (G_FILE (object),
4414                            data->etag,
4415                            data->make_backup,
4416                            data->flags,
4417                            cancellable,
4418                            &error);
4419
4420   if (stream == NULL)
4421     {
4422       g_simple_async_result_set_from_error (res, error);
4423       g_error_free (error);
4424     }
4425   else
4426     data->stream = stream;
4427 }
4428
4429 static void
4430 g_file_real_replace_async (GFile               *file,
4431                            const char          *etag,
4432                            gboolean             make_backup,
4433                            GFileCreateFlags     flags,
4434                            int                  io_priority,
4435                            GCancellable        *cancellable,
4436                            GAsyncReadyCallback  callback,
4437                            gpointer             user_data)
4438 {
4439   GSimpleAsyncResult *res;
4440   ReplaceAsyncData *data;
4441
4442   data = g_new0 (ReplaceAsyncData, 1);
4443   data->etag = g_strdup (etag);
4444   data->make_backup = make_backup;
4445   data->flags = flags;
4446
4447   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
4448   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
4449
4450   g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
4451   g_object_unref (res);
4452 }
4453
4454 static GFileOutputStream *
4455 g_file_real_replace_finish (GFile         *file,
4456                             GAsyncResult  *res,
4457                             GError       **error)
4458 {
4459   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4460   ReplaceAsyncData *data;
4461
4462   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
4463
4464   data = g_simple_async_result_get_op_res_gpointer (simple);
4465   if (data->stream)
4466     return g_object_ref (data->stream);
4467
4468   return NULL;
4469 }
4470
4471 typedef struct {
4472   char *name;
4473   GFile *file;
4474 } SetDisplayNameAsyncData;
4475
4476 static void
4477 set_display_name_data_free (SetDisplayNameAsyncData *data)
4478 {
4479   g_free (data->name);
4480   if (data->file)
4481     g_object_unref (data->file);
4482   g_free (data);
4483 }
4484
4485 static void
4486 set_display_name_async_thread (GSimpleAsyncResult *res,
4487                                GObject            *object,
4488                                GCancellable       *cancellable)
4489 {
4490   GError *error = NULL;
4491   SetDisplayNameAsyncData *data;
4492   GFile *file;
4493
4494   data = g_simple_async_result_get_op_res_gpointer (res);
4495
4496   file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
4497
4498   if (file == NULL)
4499     {
4500       g_simple_async_result_set_from_error (res, error);
4501       g_error_free (error);
4502     }
4503   else
4504     data->file = file;
4505 }
4506
4507 static void
4508 g_file_real_set_display_name_async (GFile               *file,
4509                                     const char          *display_name,
4510                                     int                  io_priority,
4511                                     GCancellable        *cancellable,
4512                                     GAsyncReadyCallback  callback,
4513                                     gpointer             user_data)
4514 {
4515   GSimpleAsyncResult *res;
4516   SetDisplayNameAsyncData *data;
4517
4518   data = g_new0 (SetDisplayNameAsyncData, 1);
4519   data->name = g_strdup (display_name);
4520
4521   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
4522   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
4523
4524   g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
4525   g_object_unref (res);
4526 }
4527
4528 static GFile *
4529 g_file_real_set_display_name_finish (GFile         *file,
4530                                      GAsyncResult  *res,
4531                                      GError       **error)
4532 {
4533   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4534   SetDisplayNameAsyncData *data;
4535
4536   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
4537
4538   data = g_simple_async_result_get_op_res_gpointer (simple);
4539   if (data->file)
4540     return g_object_ref (data->file);
4541
4542   return NULL;
4543 }
4544
4545 typedef struct {
4546   GFileQueryInfoFlags flags;
4547   GFileInfo *info;
4548   gboolean res;
4549   GError *error;
4550 } SetInfoAsyncData;
4551
4552 static void
4553 set_info_data_free (SetInfoAsyncData *data)
4554 {
4555   if (data->info)
4556     g_object_unref (data->info);
4557   if (data->error)
4558     g_error_free (data->error);
4559   g_free (data);
4560 }
4561
4562 static void
4563 set_info_async_thread (GSimpleAsyncResult *res,
4564                        GObject            *object,
4565                        GCancellable       *cancellable)
4566 {
4567   SetInfoAsyncData *data;
4568
4569   data = g_simple_async_result_get_op_res_gpointer (res);
4570
4571   data->error = NULL;
4572   data->res = g_file_set_attributes_from_info (G_FILE (object),
4573                                                data->info,
4574                                                data->flags,
4575                                                cancellable,
4576                                                &data->error);
4577 }
4578
4579 static void
4580 g_file_real_set_attributes_async (GFile               *file,
4581                                   GFileInfo           *info,
4582                                   GFileQueryInfoFlags  flags,
4583                                   int                  io_priority,
4584                                   GCancellable        *cancellable,
4585                                   GAsyncReadyCallback  callback,
4586                                   gpointer             user_data)
4587 {
4588   GSimpleAsyncResult *res;
4589   SetInfoAsyncData *data;
4590
4591   data = g_new0 (SetInfoAsyncData, 1);
4592   data->info = g_file_info_dup (info);
4593   data->flags = flags;
4594
4595   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
4596   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
4597
4598   g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
4599   g_object_unref (res);
4600 }
4601
4602 static gboolean
4603 g_file_real_set_attributes_finish (GFile         *file,
4604                                    GAsyncResult  *res,
4605                                    GFileInfo    **info,
4606                                    GError       **error)
4607 {
4608   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4609   SetInfoAsyncData *data;
4610
4611   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
4612
4613   data = g_simple_async_result_get_op_res_gpointer (simple);
4614
4615   if (info)
4616     *info = g_object_ref (data->info);
4617
4618   if (error != NULL && data->error)
4619     *error = g_error_copy (data->error);
4620
4621   return data->res;
4622 }
4623
4624 static void
4625 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
4626                                     GObject            *object,
4627                                     GCancellable       *cancellable)
4628 {
4629   GError *error = NULL;
4630   GMount *mount;
4631
4632   mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
4633
4634   if (mount == NULL)
4635     {
4636       g_simple_async_result_set_from_error (res, error);
4637       g_error_free (error);
4638     }
4639   else
4640     g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
4641 }
4642
4643 static void
4644 g_file_real_find_enclosing_mount_async (GFile               *file,
4645                                         int                  io_priority,
4646                                         GCancellable        *cancellable,
4647                                         GAsyncReadyCallback  callback,
4648                                         gpointer             user_data)
4649 {
4650   GSimpleAsyncResult *res;
4651
4652   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
4653
4654   g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
4655   g_object_unref (res);
4656 }
4657
4658 static GMount *
4659 g_file_real_find_enclosing_mount_finish (GFile         *file,
4660                                           GAsyncResult  *res,
4661                                           GError       **error)
4662 {
4663   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4664   GMount *mount;
4665
4666   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
4667
4668   mount = g_simple_async_result_get_op_res_gpointer (simple);
4669   return g_object_ref (mount);
4670 }
4671
4672
4673 typedef struct {
4674   GFile *source;
4675   GFile *destination;
4676   GFileCopyFlags flags;
4677   GFileProgressCallback progress_cb;
4678   gpointer progress_cb_data;
4679   GIOSchedulerJob *job;
4680 } CopyAsyncData;
4681
4682 static void
4683 copy_async_data_free (CopyAsyncData *data)
4684 {
4685   g_object_unref (data->source);
4686   g_object_unref (data->destination);
4687   g_free (data);
4688 }
4689
4690 typedef struct {
4691   CopyAsyncData *data;
4692   goffset current_num_bytes;
4693   goffset total_num_bytes;
4694 } ProgressData;
4695
4696 static gboolean
4697 copy_async_progress_in_main (gpointer user_data)
4698 {
4699   ProgressData *progress = user_data;
4700   CopyAsyncData *data = progress->data;
4701
4702   data->progress_cb (progress->current_num_bytes,
4703                      progress->total_num_bytes,
4704                      data->progress_cb_data);
4705
4706   return FALSE;
4707 }
4708
4709 static gboolean
4710 mainloop_barrier (gpointer user_data)
4711 {
4712   /* Does nothing, but ensures all queued idles before
4713      this are run */
4714   return FALSE;
4715 }
4716
4717
4718 static void
4719 copy_async_progress_callback (goffset  current_num_bytes,
4720                               goffset  total_num_bytes,
4721                               gpointer user_data)
4722 {
4723   CopyAsyncData *data = user_data;
4724   ProgressData *progress;
4725
4726   progress = g_new (ProgressData, 1);
4727   progress->data = data;
4728   progress->current_num_bytes = current_num_bytes;
4729   progress->total_num_bytes = total_num_bytes;
4730
4731   g_io_scheduler_job_send_to_mainloop_async (data->job,
4732                                              copy_async_progress_in_main,
4733                                              progress,
4734                                              g_free);
4735 }
4736
4737 static gboolean
4738 copy_async_thread (GIOSchedulerJob *job,
4739                    GCancellable    *cancellable,
4740                    gpointer         user_data)
4741 {
4742   GSimpleAsyncResult *res;
4743   CopyAsyncData *data;
4744   gboolean result;
4745   GError *error;
4746
4747   res = user_data;
4748   data = g_simple_async_result_get_op_res_gpointer (res);
4749
4750   error = NULL;
4751   data->job = job;
4752   result = g_file_copy (data->source,
4753                         data->destination,
4754                         data->flags,
4755                         cancellable,
4756                         (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
4757                         data,
4758                         &error);
4759
4760   /* Ensure all progress callbacks are done running in main thread */
4761   if (data->progress_cb != NULL)
4762     g_io_scheduler_job_send_to_mainloop (job,
4763                                          mainloop_barrier,
4764                                          NULL, NULL);
4765
4766   if (!result)
4767     {
4768       g_simple_async_result_set_from_error (res, error);
4769       g_error_free (error);
4770     }
4771
4772   g_simple_async_result_complete_in_idle (res);
4773
4774   return FALSE;
4775 }
4776
4777 static void
4778 g_file_real_copy_async (GFile                  *source,
4779                         GFile                  *destination,
4780                         GFileCopyFlags          flags,
4781                         int                     io_priority,
4782                         GCancellable           *cancellable,
4783                         GFileProgressCallback   progress_callback,
4784                         gpointer                progress_callback_data,
4785                         GAsyncReadyCallback     callback,
4786                         gpointer                user_data)
4787 {
4788   GSimpleAsyncResult *res;
4789   CopyAsyncData *data;
4790
4791   data = g_new0 (CopyAsyncData, 1);
4792   data->source = g_object_ref (source);
4793   data->destination = g_object_ref (destination);
4794   data->flags = flags;
4795   data->progress_cb = progress_callback;
4796   data->progress_cb_data = progress_callback_data;
4797
4798   res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
4799   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
4800
4801   g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
4802 }
4803
4804 static gboolean
4805 g_file_real_copy_finish (GFile        *file,
4806                          GAsyncResult *res,
4807                          GError      **error)
4808 {
4809   /* Error handled in g_file_copy_finish() */
4810   return TRUE;
4811 }
4812
4813
4814 /********************************************
4815  *   Default VFS operations                 *
4816  ********************************************/
4817
4818 /**
4819  * g_file_new_for_path:
4820  * @path: a string containing a relative or absolute path.
4821  *
4822  * Constructs a #GFile for a given path. This operation never
4823  * fails, but the returned object might not support any I/O
4824  * operation if @path is malformed.
4825  *
4826  * Returns: a new #GFile for the given @path.
4827  **/
4828 GFile *
4829 g_file_new_for_path (const char *path)
4830 {
4831   g_return_val_if_fail (path != NULL, NULL);
4832
4833   return g_vfs_get_file_for_path (g_vfs_get_default (), path);
4834 }
4835
4836 /**
4837  * g_file_new_for_uri:
4838  * @uri: a string containing a URI.
4839  *
4840  * Constructs a #GFile for a given URI. This operation never
4841  * fails, but the returned object might not support any I/O
4842  * operation if @uri is malformed or if the uri type is
4843  * not supported.
4844  *
4845  * Returns: a #GFile for the given @uri.
4846  **/
4847 GFile *
4848 g_file_new_for_uri (const char *uri)
4849 {
4850   g_return_val_if_fail (uri != NULL, NULL);
4851
4852   return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
4853 }
4854
4855 /**
4856  * g_file_parse_name:
4857  * @parse_name: a file name or path to be parsed.
4858  *
4859  * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
4860  * This operation never fails, but the returned object might not support any I/O
4861  * operation if the @parse_name cannot be parsed.
4862  *
4863  * Returns: a new #GFile.
4864  **/
4865 GFile *
4866 g_file_parse_name (const char *parse_name)
4867 {
4868   g_return_val_if_fail (parse_name != NULL, NULL);
4869
4870   return g_vfs_parse_name (g_vfs_get_default (), parse_name);
4871 }
4872
4873 static gboolean
4874 is_valid_scheme_character (char c)
4875 {
4876   return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
4877 }
4878
4879 /* Following RFC 2396, valid schemes are built like:
4880  *       scheme        = alpha *( alpha | digit | "+" | "-" | "." )
4881  */
4882 static gboolean
4883 has_valid_scheme (const char *uri)
4884 {
4885   const char *p;
4886
4887   p = uri;
4888
4889   if (!g_ascii_isalpha (*p))
4890     return FALSE;
4891
4892   do {
4893     p++;
4894   } while (is_valid_scheme_character (*p));
4895
4896   return *p == ':';
4897 }
4898
4899 /**
4900  * g_file_new_for_commandline_arg:
4901  * @arg: a command line string.
4902  *
4903  * Creates a #GFile with the given argument from the command line. The value of
4904  * @arg can be either a URI, an absolute path or a relative path resolved
4905  * relative to the current working directory.
4906  * This operation never fails, but the returned object might not support any
4907  * I/O operation if @arg points to a malformed path.
4908  *
4909  * Returns: a new #GFile.
4910  **/
4911 GFile *
4912 g_file_new_for_commandline_arg (const char *arg)
4913 {
4914   GFile *file;
4915   char *filename;
4916   char *current_dir;
4917
4918   g_return_val_if_fail (arg != NULL, NULL);
4919
4920   if (g_path_is_absolute (arg))
4921     return g_file_new_for_path (arg);
4922
4923   if (has_valid_scheme (arg))
4924     return g_file_new_for_uri (arg);
4925
4926   current_dir = g_get_current_dir ();
4927   filename = g_build_filename (current_dir, arg, NULL);
4928   g_free (current_dir);
4929
4930   file = g_file_new_for_path (filename);
4931   g_free (filename);
4932
4933   return file;
4934 }
4935
4936 /**
4937  * g_file_mount_enclosing_volume:
4938  * @location: input #GFile.
4939  * @flags: flags affecting the operation
4940  * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
4941  * @cancellable: optional #GCancellable object, %NULL to ignore.
4942  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4943  * @user_data: the data to pass to callback function
4944  *
4945  * Starts a @mount_operation, mounting the volume that contains the file @location.
4946  *
4947  * When this operation has completed, @callback will be called with
4948  * @user_user data, and the operation can be finalized with
4949  * g_file_mount_enclosing_volume_finish().
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 void
4956 g_file_mount_enclosing_volume (GFile               *location,
4957                                GMountMountFlags     flags,
4958                                GMountOperation     *mount_operation,
4959                                GCancellable        *cancellable,
4960                                GAsyncReadyCallback  callback,
4961                                gpointer             user_data)
4962 {
4963   GFileIface *iface;
4964
4965   g_return_if_fail (G_IS_FILE (location));
4966
4967   iface = G_FILE_GET_IFACE (location);
4968
4969   if (iface->mount_enclosing_volume == NULL)
4970     {
4971       g_simple_async_report_error_in_idle (G_OBJECT (location),
4972                                            callback, user_data,
4973                                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4974                                            _("volume doesn't implement mount"));
4975
4976       return;
4977     }
4978
4979   (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
4980
4981 }
4982
4983 /**
4984  * g_file_mount_enclosing_volume_finish:
4985  * @location: input #GFile.
4986  * @result: a #GAsyncResult.
4987  * @error: a #GError, or %NULL
4988  *
4989  * Finishes a mount operation started by g_file_mount_enclosing_volume().
4990  *
4991  * Returns: %TRUE if successful. If an error
4992  * has occurred, this function will return %FALSE and set @error
4993  * appropriately if present.
4994  **/
4995 gboolean
4996 g_file_mount_enclosing_volume_finish (GFile         *location,
4997                                       GAsyncResult  *result,
4998                                       GError       **error)
4999 {
5000   GFileIface *iface;
5001
5002   g_return_val_if_fail (G_IS_FILE (location), FALSE);
5003   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
5004
5005   if (G_IS_SIMPLE_ASYNC_RESULT (result))
5006     {
5007       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
5008       if (g_simple_async_result_propagate_error (simple, error))
5009         return FALSE;
5010     }
5011
5012   iface = G_FILE_GET_IFACE (location);
5013
5014   return (* iface->mount_enclosing_volume_finish) (location, result, error);
5015 }
5016
5017 /********************************************
5018  *   Utility functions                      *
5019  ********************************************/
5020
5021 /**
5022  * g_file_query_default_handler:
5023  * @file: a #GFile to open.
5024  * @cancellable: optional #GCancellable object, %NULL to ignore.
5025  * @error: a #GError, or %NULL
5026  *
5027  * Returns the #GAppInfo that is registered as the default
5028  * application to handle the file specified by @file.
5029  *
5030  * If @cancellable is not %NULL, then the operation can be cancelled by
5031  * triggering the cancellable object from another thread. If the operation
5032  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5033  *
5034  * Returns: a #GAppInfo if the handle was found, %NULL if there were errors.
5035  * When you are done with it, release it with g_object_unref()
5036  **/
5037 GAppInfo *
5038 g_file_query_default_handler (GFile                  *file,
5039                               GCancellable           *cancellable,
5040                               GError                **error)
5041 {
5042   char *uri_scheme;
5043   const char *content_type;
5044   GAppInfo *appinfo;
5045   GFileInfo *info;
5046   char *path;
5047
5048   uri_scheme = g_file_get_uri_scheme (file);
5049   appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
5050   g_free (uri_scheme);
5051
5052   if (appinfo != NULL)
5053     return appinfo;
5054
5055   info = g_file_query_info (file,
5056                             G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
5057                             0,
5058                             cancellable,
5059                             error);
5060   if (info == NULL)
5061     return NULL;
5062
5063   appinfo = NULL;
5064
5065   content_type = g_file_info_get_content_type (info);
5066   if (content_type)
5067     {
5068       /* Don't use is_native(), as we want to support fuse paths if availible */
5069       path = g_file_get_path (file);
5070       appinfo = g_app_info_get_default_for_type (content_type,
5071                                                  path == NULL);
5072       g_free (path);
5073     }
5074
5075   g_object_unref (info);
5076
5077   if (appinfo != NULL)
5078     return appinfo;
5079
5080   g_set_error_literal (error, G_IO_ERROR,
5081                        G_IO_ERROR_NOT_SUPPORTED,
5082                        _("No application is registered as handling this file"));
5083   return NULL;
5084
5085 }
5086
5087
5088 #define GET_CONTENT_BLOCK_SIZE 8192
5089
5090 /**
5091  * g_file_load_contents:
5092  * @file: input #GFile.
5093  * @cancellable: optional #GCancellable object, %NULL to ignore.
5094  * @contents: a location to place the contents of the file.
5095  * @length: a location to place the length of the contents of the file,
5096  *    or %NULL if the length is not needed
5097  * @etag_out: a location to place the current entity tag for the file,
5098  *    or %NULL if the entity tag is not needed
5099  * @error: a #GError, or %NULL
5100  *
5101  * Loads the content of the file into memory. The data is always
5102  * zero-terminated, but this is not included in the resultant @length.
5103  * The returned @content should be freed with g_free() when no longer
5104  * needed.
5105  *
5106  * If @cancellable is not %NULL, then the operation can be cancelled by
5107  * triggering the cancellable object from another thread. If the operation
5108  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5109  *
5110  * Returns: %TRUE if the @file's contents were successfully loaded.
5111  * %FALSE if there were errors.
5112  **/
5113 gboolean
5114 g_file_load_contents (GFile         *file,
5115                       GCancellable  *cancellable,
5116                       char         **contents,
5117                       gsize         *length,
5118                       char         **etag_out,
5119                       GError       **error)
5120 {
5121   GFileInputStream *in;
5122   GByteArray *content;
5123   gsize pos;
5124   gssize res;
5125   GFileInfo *info;
5126
5127   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5128   g_return_val_if_fail (contents != NULL, FALSE);
5129
5130   in = g_file_read (file, cancellable, error);
5131   if (in == NULL)
5132     return FALSE;
5133
5134   content = g_byte_array_new ();
5135   pos = 0;
5136
5137   g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
5138   while ((res = g_input_stream_read (G_INPUT_STREAM (in),
5139                                      content->data + pos,
5140                                      GET_CONTENT_BLOCK_SIZE,
5141                                      cancellable, error)) > 0)
5142     {
5143       pos += res;
5144       g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
5145     }
5146
5147   if (etag_out)
5148     {
5149       *etag_out = NULL;
5150
5151       info = g_file_input_stream_query_info (in,
5152                                              G_FILE_ATTRIBUTE_ETAG_VALUE,
5153                                              cancellable,
5154                                              NULL);
5155       if (info)
5156         {
5157           *etag_out = g_strdup (g_file_info_get_etag (info));
5158           g_object_unref (info);
5159         }
5160     }
5161
5162   /* Ignore errors on close */
5163   g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
5164   g_object_unref (in);
5165
5166   if (res < 0)
5167     {
5168       /* error is set already */
5169       g_byte_array_free (content, TRUE);
5170       return FALSE;
5171     }
5172
5173   if (length)
5174     *length = pos;
5175
5176   /* Zero terminate (we got an extra byte allocated for this */
5177   content->data[pos] = 0;
5178
5179   *contents = (char *)g_byte_array_free (content, FALSE);
5180
5181   return TRUE;
5182 }
5183
5184 typedef struct {
5185   GFile *file;
5186   GError *error;
5187   GCancellable *cancellable;
5188   GFileReadMoreCallback read_more_callback;
5189   GAsyncReadyCallback callback;
5190   gpointer user_data;
5191   GByteArray *content;
5192   gsize pos;
5193   char *etag;
5194 } LoadContentsData;
5195
5196
5197 static void
5198 load_contents_data_free (LoadContentsData *data)
5199 {
5200   if (data->error)
5201     g_error_free (data->error);
5202   if (data->cancellable)
5203     g_object_unref (data->cancellable);
5204   if (data->content)
5205     g_byte_array_free (data->content, TRUE);
5206   g_free (data->etag);
5207   g_object_unref (data->file);
5208   g_free (data);
5209 }
5210
5211 static void
5212 load_contents_close_callback (GObject      *obj,
5213                               GAsyncResult *close_res,
5214                               gpointer      user_data)
5215 {
5216   GInputStream *stream = G_INPUT_STREAM (obj);
5217   LoadContentsData *data = user_data;
5218   GSimpleAsyncResult *res;
5219
5220   /* Ignore errors here, we're only reading anyway */
5221   g_input_stream_close_finish (stream, close_res, NULL);
5222   g_object_unref (stream);
5223
5224   res = g_simple_async_result_new (G_OBJECT (data->file),
5225                                    data->callback,
5226                                    data->user_data,
5227                                    g_file_load_contents_async);
5228   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
5229   g_simple_async_result_complete (res);
5230   g_object_unref (res);
5231 }
5232
5233 static void
5234 load_contents_fstat_callback (GObject      *obj,
5235                               GAsyncResult *stat_res,
5236                               gpointer      user_data)
5237 {
5238   GInputStream *stream = G_INPUT_STREAM (obj);
5239   LoadContentsData *data = user_data;
5240   GFileInfo *info;
5241
5242   info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
5243                                                    stat_res, NULL);
5244   if (info)
5245     {
5246       data->etag = g_strdup (g_file_info_get_etag (info));
5247       g_object_unref (info);
5248     }
5249
5250   g_input_stream_close_async (stream, 0,
5251                               data->cancellable,
5252                               load_contents_close_callback, data);
5253 }
5254
5255 static void
5256 load_contents_read_callback (GObject      *obj,
5257                              GAsyncResult *read_res,
5258                              gpointer      user_data)
5259 {
5260   GInputStream *stream = G_INPUT_STREAM (obj);
5261   LoadContentsData *data = user_data;
5262   GError *error = NULL;
5263   gssize read_size;
5264
5265   read_size = g_input_stream_read_finish (stream, read_res, &error);
5266
5267   if (read_size < 0)
5268     {
5269       /* Error or EOF, close the file */
5270       data->error = error;
5271       g_input_stream_close_async (stream, 0,
5272                                   data->cancellable,
5273                                   load_contents_close_callback, data);
5274     }
5275   else if (read_size == 0)
5276     {
5277       g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
5278                                             G_FILE_ATTRIBUTE_ETAG_VALUE,
5279                                             0,
5280                                             data->cancellable,
5281                                             load_contents_fstat_callback,
5282                                             data);
5283     }
5284   else if (read_size > 0)
5285     {
5286       data->pos += read_size;
5287
5288       g_byte_array_set_size (data->content,
5289                              data->pos + GET_CONTENT_BLOCK_SIZE);
5290
5291
5292       if (data->read_more_callback &&
5293           !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
5294         g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
5295                                               G_FILE_ATTRIBUTE_ETAG_VALUE,
5296                                               0,
5297                                               data->cancellable,
5298                                               load_contents_fstat_callback,
5299                                               data);
5300       else
5301         g_input_stream_read_async (stream,
5302                                    data->content->data + data->pos,
5303                                    GET_CONTENT_BLOCK_SIZE,
5304                                    0,
5305                                    data->cancellable,
5306                                    load_contents_read_callback,
5307                                    data);
5308     }
5309 }
5310
5311 static void
5312 load_contents_open_callback (GObject      *obj,
5313                              GAsyncResult *open_res,
5314                              gpointer      user_data)
5315 {
5316   GFile *file = G_FILE (obj);
5317   GFileInputStream *stream;
5318   LoadContentsData *data = user_data;
5319   GError *error = NULL;
5320   GSimpleAsyncResult *res;
5321
5322   stream = g_file_read_finish (file, open_res, &error);
5323
5324   if (stream)
5325     {
5326       g_byte_array_set_size (data->content,
5327                              data->pos + GET_CONTENT_BLOCK_SIZE);
5328       g_input_stream_read_async (G_INPUT_STREAM (stream),
5329                                  data->content->data + data->pos,
5330                                  GET_CONTENT_BLOCK_SIZE,
5331                                  0,
5332                                  data->cancellable,
5333                                  load_contents_read_callback,
5334                                  data);
5335
5336     }
5337   else
5338     {
5339       res = g_simple_async_result_new_from_error (G_OBJECT (data->file),
5340                                                   data->callback,
5341                                                   data->user_data,
5342                                                   error);
5343       g_simple_async_result_complete (res);
5344       g_error_free (error);
5345       load_contents_data_free (data);
5346       g_object_unref (res);
5347     }
5348 }
5349
5350 /**
5351  * g_file_load_partial_contents_async:
5352  * @file: input #GFile.
5353  * @cancellable: optional #GCancellable object, %NULL to ignore.
5354  * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
5355  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5356  * @user_data: the data to pass to the callback functions.
5357  *
5358  * Reads the partial contents of a file. A #GFileReadMoreCallback should be
5359  * used to stop reading from the file when appropriate, else this function
5360  * will behave exactly as g_file_load_contents_async(). This operation
5361  * can be finished by g_file_load_partial_contents_finish().
5362  *
5363  * Users of this function should be aware that @user_data is passed to
5364  * both the @read_more_callback and the @callback.
5365  *
5366  * If @cancellable is not %NULL, then the operation can be cancelled by
5367  * triggering the cancellable object from another thread. If the operation
5368  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5369  **/
5370 void
5371 g_file_load_partial_contents_async (GFile                 *file,
5372                                     GCancellable          *cancellable,
5373                                     GFileReadMoreCallback  read_more_callback,
5374                                     GAsyncReadyCallback    callback,
5375                                     gpointer               user_data)
5376 {
5377   LoadContentsData *data;
5378
5379   g_return_if_fail (G_IS_FILE (file));
5380
5381   data = g_new0 (LoadContentsData, 1);
5382
5383   if (cancellable)
5384     data->cancellable = g_object_ref (cancellable);
5385   data->read_more_callback = read_more_callback;
5386   data->callback = callback;
5387   data->user_data = user_data;
5388   data->content = g_byte_array_new ();
5389   data->file = g_object_ref (file);
5390
5391   g_file_read_async (file,
5392                      0,
5393                      cancellable,
5394                      load_contents_open_callback,
5395                      data);
5396 }
5397
5398 /**
5399  * g_file_load_partial_contents_finish:
5400  * @file: input #GFile.
5401  * @res: a #GAsyncResult.
5402  * @contents: a location to place the contents of the file.
5403  * @length: a location to place the length of the contents of the file,
5404  *     or %NULL if the length is not needed
5405  * @etag_out: a location to place the current entity tag for the file,
5406  *     or %NULL if the entity tag is not needed
5407  * @error: a #GError, or %NULL
5408  *
5409  * Finishes an asynchronous partial load operation that was started
5410  * with g_file_load_partial_contents_async(). The data is always
5411  * zero-terminated, but this is not included in the resultant @length.
5412  * The returned @content should be freed with g_free() when no longer
5413  * needed.
5414  *
5415  * Returns: %TRUE if the load was successful. If %FALSE and @error is
5416  * present, it will be set appropriately.
5417  **/
5418 gboolean
5419 g_file_load_partial_contents_finish (GFile         *file,
5420                                      GAsyncResult  *res,
5421                                      char         **contents,
5422                                      gsize         *length,
5423                                      char         **etag_out,
5424                                      GError       **error)
5425 {
5426   GSimpleAsyncResult *simple;
5427   LoadContentsData *data;
5428
5429   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5430   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
5431   g_return_val_if_fail (contents != NULL, FALSE);
5432
5433   simple = G_SIMPLE_ASYNC_RESULT (res);
5434
5435   if (g_simple_async_result_propagate_error (simple, error))
5436     return FALSE;
5437
5438   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
5439
5440   data = g_simple_async_result_get_op_res_gpointer (simple);
5441
5442   if (data->error)
5443     {
5444       g_propagate_error (error, data->error);
5445       data->error = NULL;
5446       *contents = NULL;
5447       if (length)
5448         *length = 0;
5449       return FALSE;
5450     }
5451
5452   if (length)
5453     *length = data->pos;
5454
5455   if (etag_out)
5456     {
5457       *etag_out = data->etag;
5458       data->etag = NULL;
5459     }
5460
5461   /* Zero terminate */
5462   g_byte_array_set_size (data->content, data->pos + 1);
5463   data->content->data[data->pos] = 0;
5464
5465   *contents = (char *)g_byte_array_free (data->content, FALSE);
5466   data->content = NULL;
5467
5468   return TRUE;
5469 }
5470
5471 /**
5472  * g_file_load_contents_async:
5473  * @file: input #GFile.
5474  * @cancellable: optional #GCancellable object, %NULL to ignore.
5475  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5476  * @user_data: the data to pass to callback function
5477  *
5478  * Starts an asynchronous load of the @file's contents.
5479  *
5480  * For more details, see g_file_load_contents() which is
5481  * the synchronous version of this call.
5482  *
5483  * When the load operation has completed, @callback will be called
5484  * with @user data. To finish the operation, call
5485  * g_file_load_contents_finish() with the #GAsyncResult returned by
5486  * the @callback.
5487  *
5488  * If @cancellable is not %NULL, then the operation can be cancelled by
5489  * triggering the cancellable object from another thread. If the operation
5490  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5491  **/
5492 void
5493 g_file_load_contents_async (GFile               *file,
5494                            GCancellable        *cancellable,
5495                            GAsyncReadyCallback  callback,
5496                            gpointer             user_data)
5497 {
5498   g_file_load_partial_contents_async (file,
5499                                       cancellable,
5500                                       NULL,
5501                                       callback, user_data);
5502 }
5503
5504 /**
5505  * g_file_load_contents_finish:
5506  * @file: input #GFile.
5507  * @res: a #GAsyncResult.
5508  * @contents: a location to place the contents of the file.
5509  * @length: a location to place the length of the contents of the file,
5510  *     or %NULL if the length is not needed
5511  * @etag_out: a location to place the current entity tag for the file,
5512  *     or %NULL if the entity tag is not needed
5513  * @error: a #GError, or %NULL
5514  *
5515  * Finishes an asynchronous load of the @file's contents.
5516  * The contents are placed in @contents, and @length is set to the
5517  * size of the @contents string. The @content should be freed with
5518  * g_free() when no longer needed. If @etag_out is present, it will be
5519  * set to the new entity tag for the @file.
5520  *
5521  * Returns: %TRUE if the load was successful. If %FALSE and @error is
5522  * present, it will be set appropriately.
5523  **/
5524 gboolean
5525 g_file_load_contents_finish (GFile         *file,
5526                              GAsyncResult  *res,
5527                              char         **contents,
5528                              gsize         *length,
5529                              char         **etag_out,
5530                              GError       **error)
5531 {
5532   return g_file_load_partial_contents_finish (file,
5533                                               res,
5534                                               contents,
5535                                               length,
5536                                               etag_out,
5537                                               error);
5538 }
5539
5540 /**
5541  * g_file_replace_contents:
5542  * @file: input #GFile.
5543  * @contents: a string containing the new contents for @file.
5544  * @length: the length of @contents in bytes.
5545  * @etag: the old <link linkend="gfile-etag">entity tag</link>
5546  *     for the document, or %NULL
5547  * @make_backup: %TRUE if a backup should be created.
5548  * @flags: a set of #GFileCreateFlags.
5549  * @new_etag: a location to a new <link linkend="gfile-etag">entity tag</link>
5550  *      for the document. This should be freed with g_free() when no longer
5551  *      needed, or %NULL
5552  * @cancellable: optional #GCancellable object, %NULL to ignore.
5553  * @error: a #GError, or %NULL
5554  *
5555  * Replaces the contents of @file with @contents of @length bytes.
5556
5557  * If @etag is specified (not %NULL) any existing file must have that etag, or
5558  * the error %G_IO_ERROR_WRONG_ETAG will be returned.
5559  *
5560  * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
5561  *
5562  * If @cancellable is not %NULL, then the operation can be cancelled by
5563  * triggering the cancellable object from another thread. If the operation
5564  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5565  *
5566  * The returned @new_etag can be used to verify that the file hasn't changed the
5567  * next time it is saved over.
5568  *
5569  * Returns: %TRUE if successful. If an error
5570  * has occurred, this function will return %FALSE and set @error
5571  * appropriately if present.
5572  **/
5573 gboolean
5574 g_file_replace_contents (GFile             *file,
5575                          const char        *contents,
5576                          gsize              length,
5577                          const char        *etag,
5578                          gboolean           make_backup,
5579                          GFileCreateFlags   flags,
5580                          char             **new_etag,
5581                          GCancellable      *cancellable,
5582                          GError           **error)
5583 {
5584   GFileOutputStream *out;
5585   gsize pos, remainder;
5586   gssize res;
5587   gboolean ret;
5588
5589   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5590   g_return_val_if_fail (contents != NULL, FALSE);
5591
5592   out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
5593   if (out == NULL)
5594     return FALSE;
5595
5596   pos = 0;
5597   remainder = length;
5598   while (remainder > 0 &&
5599          (res = g_output_stream_write (G_OUTPUT_STREAM (out),
5600                                        contents + pos,
5601                                        MIN (remainder, GET_CONTENT_BLOCK_SIZE),
5602                                        cancellable,
5603                                        error)) > 0)
5604     {
5605       pos += res;
5606       remainder -= res;
5607     }
5608
5609   if (remainder > 0 && res < 0)
5610     {
5611       /* Ignore errors on close */
5612       g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
5613       g_object_unref (out);
5614
5615       /* error is set already */
5616       return FALSE;
5617     }
5618
5619   ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
5620
5621   if (new_etag)
5622     *new_etag = g_file_output_stream_get_etag (out);
5623
5624   g_object_unref (out);
5625
5626   return ret;
5627 }
5628
5629 typedef struct {
5630   GFile *file;
5631   GError *error;
5632   GCancellable *cancellable;
5633   GAsyncReadyCallback callback;
5634   gpointer user_data;
5635   const char *content;
5636   gsize length;
5637   gsize pos;
5638   char *etag;
5639 } ReplaceContentsData;
5640
5641 static void
5642 replace_contents_data_free (ReplaceContentsData *data)
5643 {
5644   if (data->error)
5645     g_error_free (data->error);
5646   if (data->cancellable)
5647     g_object_unref (data->cancellable);
5648   g_object_unref (data->file);
5649   g_free (data->etag);
5650   g_free (data);
5651 }
5652
5653 static void
5654 replace_contents_close_callback (GObject      *obj,
5655                                  GAsyncResult *close_res,
5656                                  gpointer      user_data)
5657 {
5658   GOutputStream *stream = G_OUTPUT_STREAM (obj);
5659   ReplaceContentsData *data = user_data;
5660   GSimpleAsyncResult *res;
5661
5662   /* Ignore errors here, we're only reading anyway */
5663   g_output_stream_close_finish (stream, close_res, NULL);
5664   g_object_unref (stream);
5665
5666   data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
5667
5668   res = g_simple_async_result_new (G_OBJECT (data->file),
5669                                    data->callback,
5670                                    data->user_data,
5671                                    g_file_replace_contents_async);
5672   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
5673   g_simple_async_result_complete (res);
5674   g_object_unref (res);
5675 }
5676
5677 static void
5678 replace_contents_write_callback (GObject      *obj,
5679                                  GAsyncResult *read_res,
5680                                  gpointer      user_data)
5681 {
5682   GOutputStream *stream = G_OUTPUT_STREAM (obj);
5683   ReplaceContentsData *data = user_data;
5684   GError *error = NULL;
5685   gssize write_size;
5686
5687   write_size = g_output_stream_write_finish (stream, read_res, &error);
5688
5689   if (write_size <= 0)
5690     {
5691       /* Error or EOF, close the file */
5692       if (write_size < 0)
5693         data->error = error;
5694       g_output_stream_close_async (stream, 0,
5695                                    data->cancellable,
5696                                    replace_contents_close_callback, data);
5697     }
5698   else if (write_size > 0)
5699     {
5700       data->pos += write_size;
5701
5702       if (data->pos >= data->length)
5703         g_output_stream_close_async (stream, 0,
5704                                      data->cancellable,
5705                                      replace_contents_close_callback, data);
5706       else
5707         g_output_stream_write_async (stream,
5708                                      data->content + data->pos,
5709                                      data->length - data->pos,
5710                                      0,
5711                                      data->cancellable,
5712                                      replace_contents_write_callback,
5713                                      data);
5714     }
5715 }
5716
5717 static void
5718 replace_contents_open_callback (GObject      *obj,
5719                                 GAsyncResult *open_res,
5720                                 gpointer      user_data)
5721 {
5722   GFile *file = G_FILE (obj);
5723   GFileOutputStream *stream;
5724   ReplaceContentsData *data = user_data;
5725   GError *error = NULL;
5726   GSimpleAsyncResult *res;
5727
5728   stream = g_file_replace_finish (file, open_res, &error);
5729
5730   if (stream)
5731     {
5732       g_output_stream_write_async (G_OUTPUT_STREAM (stream),
5733                                    data->content + data->pos,
5734                                    data->length - data->pos,
5735                                    0,
5736                                    data->cancellable,
5737                                    replace_contents_write_callback,
5738                                    data);
5739
5740     }
5741   else
5742     {
5743       res = g_simple_async_result_new_from_error (G_OBJECT (data->file),
5744                                                   data->callback,
5745                                                   data->user_data,
5746                                                   error);
5747       g_simple_async_result_complete (res);
5748       g_error_free (error);
5749       replace_contents_data_free (data);
5750       g_object_unref (res);
5751     }
5752 }
5753
5754 /**
5755  * g_file_replace_contents_async:
5756  * @file: input #GFile.
5757  * @contents: string of contents to replace the file with.
5758  * @length: the length of @contents in bytes.
5759  * @etag: a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
5760  * @make_backup: %TRUE if a backup should be created.
5761  * @flags: a set of #GFileCreateFlags.
5762  * @cancellable: optional #GCancellable object, %NULL to ignore.
5763  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5764  * @user_data: the data to pass to callback function
5765  *
5766  * Starts an asynchronous replacement of @file with the given
5767  * @contents of @length bytes. @etag will replace the document's
5768  * current entity tag.
5769  *
5770  * When this operation has completed, @callback will be called with
5771  * @user_user data, and the operation can be finalized with
5772  * g_file_replace_contents_finish().
5773  *
5774  * If @cancellable is not %NULL, then the operation can be cancelled by
5775  * triggering the cancellable object from another thread. If the operation
5776  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5777  *
5778  * If @make_backup is %TRUE, this function will attempt to
5779  * make a backup of @file.
5780  **/
5781 void
5782 g_file_replace_contents_async  (GFile               *file,
5783                                 const char          *contents,
5784                                 gsize                length,
5785                                 const char          *etag,
5786                                 gboolean             make_backup,
5787                                 GFileCreateFlags     flags,
5788                                 GCancellable        *cancellable,
5789                                 GAsyncReadyCallback  callback,
5790                                 gpointer             user_data)
5791 {
5792   ReplaceContentsData *data;
5793
5794   g_return_if_fail (G_IS_FILE (file));
5795   g_return_if_fail (contents != NULL);
5796
5797   data = g_new0 (ReplaceContentsData, 1);
5798
5799   if (cancellable)
5800     data->cancellable = g_object_ref (cancellable);
5801   data->callback = callback;
5802   data->user_data = user_data;
5803   data->content = contents;
5804   data->length = length;
5805   data->pos = 0;
5806   data->file = g_object_ref (file);
5807
5808   g_file_replace_async (file,
5809                         etag,
5810                         make_backup,
5811                         flags,
5812                         0,
5813                         cancellable,
5814                         replace_contents_open_callback,
5815                         data);
5816 }
5817
5818 /**
5819  * g_file_replace_contents_finish:
5820  * @file: input #GFile.
5821  * @res: a #GAsyncResult.
5822  * @new_etag: a location of a new <link linkend="gfile-etag">entity tag</link>
5823  *     for the document. This should be freed with g_free() when it is no
5824  *     longer needed, or %NULL
5825  * @error: a #GError, or %NULL
5826  *
5827  * Finishes an asynchronous replace of the given @file. See
5828  * g_file_replace_contents_async(). Sets @new_etag to the new entity
5829  * tag for the document, if present.
5830  *
5831  * Returns: %TRUE on success, %FALSE on failure.
5832  **/
5833 gboolean
5834 g_file_replace_contents_finish (GFile         *file,
5835                                 GAsyncResult  *res,
5836                                 char         **new_etag,
5837                                 GError       **error)
5838 {
5839   GSimpleAsyncResult *simple;
5840   ReplaceContentsData *data;
5841
5842   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5843   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
5844
5845   simple = G_SIMPLE_ASYNC_RESULT (res);
5846
5847   if (g_simple_async_result_propagate_error (simple, error))
5848     return FALSE;
5849
5850   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
5851
5852   data = g_simple_async_result_get_op_res_gpointer (simple);
5853
5854   if (data->error)
5855     {
5856       g_propagate_error (error, data->error);
5857       data->error = NULL;
5858       return FALSE;
5859     }
5860
5861
5862   if (new_etag)
5863     {
5864       *new_etag = data->etag;
5865       data->etag = NULL; /* Take ownership */
5866     }
5867
5868   return TRUE;
5869 }
5870
5871 #define __G_FILE_C__
5872 #include "gioaliasdef.c"