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,
2173                          G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2174                                              cancellable,
2175                                              error);
2176       g_object_unref (info);
2177     }
2178
2179   g_file_attribute_info_list_unref (attributes);
2180   g_file_attribute_info_list_unref (namespaces);
2181
2182   return res;
2183 }
2184
2185 /* Closes the streams */
2186 static gboolean
2187 copy_stream_with_progress (GInputStream           *in,
2188                            GOutputStream          *out,
2189                            GFile                  *source,
2190                            GCancellable           *cancellable,
2191                            GFileProgressCallback   progress_callback,
2192                            gpointer                progress_callback_data,
2193                            GError                **error)
2194 {
2195   gssize n_read, n_written;
2196   goffset current_size;
2197   char buffer[1024*64], *p;
2198   gboolean res;
2199   goffset total_size;
2200   GFileInfo *info;
2201
2202   total_size = -1;
2203   info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2204                                          G_FILE_ATTRIBUTE_STANDARD_SIZE,
2205                                          cancellable, NULL);
2206   if (info)
2207     {
2208       if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2209         total_size = g_file_info_get_size (info);
2210       g_object_unref (info);
2211     }
2212
2213   if (total_size == -1)
2214     {
2215       info = g_file_query_info (source,
2216                                 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2217                                 G_FILE_QUERY_INFO_NONE,
2218                                 cancellable, NULL);
2219       if (info)
2220         {
2221           if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2222             total_size = g_file_info_get_size (info);
2223           g_object_unref (info);
2224         }
2225     }
2226
2227   if (total_size == -1)
2228     total_size = 0;
2229
2230   current_size = 0;
2231   res = TRUE;
2232   while (TRUE)
2233     {
2234       n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2235       if (n_read == -1)
2236         {
2237           res = FALSE;
2238           break;
2239         }
2240
2241       if (n_read == 0)
2242         break;
2243
2244       current_size += n_read;
2245
2246       p = buffer;
2247       while (n_read > 0)
2248         {
2249           n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2250           if (n_written == -1)
2251             {
2252               res = FALSE;
2253               break;
2254             }
2255
2256           p += n_written;
2257           n_read -= n_written;
2258         }
2259
2260       if (!res)
2261         break;
2262
2263       if (progress_callback)
2264         progress_callback (current_size, total_size, progress_callback_data);
2265     }
2266
2267   if (!res)
2268     error = NULL; /* Ignore further errors */
2269
2270   /* Make sure we send full copied size */
2271   if (progress_callback)
2272     progress_callback (current_size, total_size, progress_callback_data);
2273
2274   /* Don't care about errors in source here */
2275   g_input_stream_close (in, cancellable, NULL);
2276
2277   /* But write errors on close are bad! */
2278   if (!g_output_stream_close (out, cancellable, error))
2279     res = FALSE;
2280
2281   g_object_unref (in);
2282   g_object_unref (out);
2283
2284   return res;
2285 }
2286
2287 static gboolean
2288 file_copy_fallback (GFile                  *source,
2289                     GFile                  *destination,
2290                     GFileCopyFlags          flags,
2291                     GCancellable           *cancellable,
2292                     GFileProgressCallback   progress_callback,
2293                     gpointer                progress_callback_data,
2294                     GError                **error)
2295 {
2296   GInputStream *in;
2297   GOutputStream *out;
2298   GFileInfo *info;
2299   const char *target;
2300
2301   /* Maybe copy the symlink? */
2302   if (flags & G_FILE_COPY_NOFOLLOW_SYMLINKS)
2303     {
2304       info = g_file_query_info (source,
2305                                 G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
2306                                 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2307                                 cancellable,
2308                                 error);
2309       if (info == NULL)
2310         return FALSE;
2311
2312       if (g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK &&
2313           (target = g_file_info_get_symlink_target (info)) != NULL)
2314         {
2315           if (!copy_symlink (destination, flags, cancellable, target, error))
2316             {
2317               g_object_unref (info);
2318               return FALSE;
2319             }
2320
2321           g_object_unref (info);
2322           goto copied_file;
2323         }
2324
2325       g_object_unref (info);
2326     }
2327
2328   in = open_source_for_copy (source, destination, flags, cancellable, error);
2329   if (in == NULL)
2330     return FALSE;
2331
2332   if (flags & G_FILE_COPY_OVERWRITE)
2333     {
2334       out = (GOutputStream *)g_file_replace (destination,
2335                                              NULL,
2336                                              flags & G_FILE_COPY_BACKUP,
2337                                              0,
2338                                              cancellable, error);
2339     }
2340   else
2341     {
2342       out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
2343     }
2344
2345   if (out == NULL)
2346     {
2347       g_object_unref (in);
2348       return FALSE;
2349     }
2350
2351   if (!copy_stream_with_progress (in, out, source, cancellable,
2352                                   progress_callback, progress_callback_data,
2353                                   error))
2354     return FALSE;
2355
2356  copied_file:
2357
2358   /* Ignore errors here. Failure to copy metadata is not a hard error */
2359   g_file_copy_attributes (source, destination,
2360                           flags, cancellable, NULL);
2361
2362   return TRUE;
2363 }
2364
2365 /**
2366  * g_file_copy:
2367  * @source: input #GFile.
2368  * @destination: destination #GFile
2369  * @flags: set of #GFileCopyFlags
2370  * @cancellable: optional #GCancellable object, %NULL to ignore.
2371  * @progress_callback: function to callback with progress information
2372  * @progress_callback_data: user data to pass to @progress_callback
2373  * @error: #GError to set on error, or %NULL
2374  *
2375  * Copies the file @source to the location specified by @destination.
2376  * Can not handle recursive copies of directories.
2377  *
2378  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2379  * existing @destination file is overwritten.
2380  *
2381  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2382  * will be copied as symlinks, otherwise the target of the
2383  * @source symlink will be copied.
2384  *
2385  * If @cancellable is not %NULL, then the operation can be cancelled by
2386  * triggering the cancellable object from another thread. If the operation
2387  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2388  *
2389  * If @progress_callback is not %NULL, then the operation can be monitored by
2390  * setting this to a #GFileProgressCallback function. @progress_callback_data
2391  * will be passed to this function. It is guaranteed that this callback will
2392  * be called after all data has been transferred with the total number of bytes
2393  * copied during the operation.
2394  *
2395  * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2396  * error is returned, independent on the status of the @destination.
2397  *
2398  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2399  * error G_IO_ERROR_EXISTS is returned.
2400  *
2401  * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2402  * error is returned. If trying to overwrite a directory with a directory the
2403  * G_IO_ERROR_WOULD_MERGE error is returned.
2404  *
2405  * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
2406  * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
2407  * is returned.
2408  *
2409  * If you are interested in copying the #GFile object itself (not the on-disk
2410  * file), see g_file_dup().
2411  *
2412  * Returns: %TRUE on success, %FALSE otherwise.
2413  **/
2414 gboolean
2415 g_file_copy (GFile                  *source,
2416              GFile                  *destination,
2417              GFileCopyFlags          flags,
2418              GCancellable           *cancellable,
2419              GFileProgressCallback   progress_callback,
2420              gpointer                progress_callback_data,
2421              GError                **error)
2422 {
2423   GFileIface *iface;
2424   GError *my_error;
2425   gboolean res;
2426
2427   g_return_val_if_fail (G_IS_FILE (source), FALSE);
2428   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
2429
2430   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2431     return FALSE;
2432
2433   iface = G_FILE_GET_IFACE (destination);
2434   if (iface->copy)
2435     {
2436       my_error = NULL;
2437       res = (* iface->copy) (source, destination,
2438                              flags, cancellable,
2439                              progress_callback, progress_callback_data,
2440                              &my_error);
2441
2442       if (res)
2443         return TRUE;
2444
2445       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2446         {
2447           g_propagate_error (error, my_error);
2448               return FALSE;
2449         }
2450     }
2451
2452   /* If the types are different, and the destination method failed
2453      also try the source method */
2454   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
2455     {
2456       iface = G_FILE_GET_IFACE (source);
2457
2458       if (iface->copy)
2459         {
2460           my_error = NULL;
2461           res = (* iface->copy) (source, destination,
2462                                  flags, cancellable,
2463                                  progress_callback, progress_callback_data,
2464                                  &my_error);
2465
2466           if (res)
2467             return TRUE;
2468
2469           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2470             {
2471               g_propagate_error (error, my_error);
2472               return FALSE;
2473             }
2474         }
2475     }
2476
2477   return file_copy_fallback (source, destination, flags, cancellable,
2478                              progress_callback, progress_callback_data,
2479                              error);
2480 }
2481
2482 /**
2483  * g_file_copy_async:
2484  * @source: input #GFile.
2485  * @destination: destination #GFile
2486  * @flags: set of #GFileCopyFlags
2487  * @io_priority: the <link linkend="io-priority">I/O priority</link>
2488  *     of the request.
2489  * @cancellable: optional #GCancellable object, %NULL to ignore.
2490  * @progress_callback: function to callback with progress information
2491  * @progress_callback_data: user data to pass to @progress_callback
2492  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
2493  * @user_data: the data to pass to callback function
2494  *
2495  * Copies the file @source to the location specified by @destination
2496  * asynchronously. For details of the behaviour, see g_file_copy().
2497  *
2498  * If @progress_callback is not %NULL, then that function that will be called
2499  * just like in g_file_copy(), however the callback will run in the main loop,
2500  * not in the thread that is doing the I/O operation.
2501  *
2502  * When the operation is finished, @callback will be called. You can then call
2503  * g_file_copy_finish() to get the result of the operation.
2504  **/
2505 void
2506 g_file_copy_async (GFile                  *source,
2507                    GFile                  *destination,
2508                    GFileCopyFlags          flags,
2509                    int                     io_priority,
2510                    GCancellable           *cancellable,
2511                    GFileProgressCallback   progress_callback,
2512                    gpointer                progress_callback_data,
2513                    GAsyncReadyCallback     callback,
2514                    gpointer                user_data)
2515 {
2516   GFileIface *iface;
2517
2518   g_return_if_fail (G_IS_FILE (source));
2519   g_return_if_fail (G_IS_FILE (destination));
2520
2521   iface = G_FILE_GET_IFACE (source);
2522   (* iface->copy_async) (source,
2523                          destination,
2524                          flags,
2525                          io_priority,
2526                          cancellable,
2527                          progress_callback,
2528                          progress_callback_data,
2529                          callback,
2530                          user_data);
2531 }
2532
2533 /**
2534  * g_file_copy_finish:
2535  * @file: input #GFile.
2536  * @res: a #GAsyncResult.
2537  * @error: a #GError, or %NULL
2538  *
2539  * Finishes copying the file started with
2540  * g_file_copy_async().
2541  *
2542  * Returns: a %TRUE on success, %FALSE on error.
2543  **/
2544 gboolean
2545 g_file_copy_finish (GFile        *file,
2546                     GAsyncResult *res,
2547                     GError      **error)
2548 {
2549   GFileIface *iface;
2550
2551   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2552   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
2553
2554   if (G_IS_SIMPLE_ASYNC_RESULT (res))
2555     {
2556       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2557
2558       if (g_simple_async_result_propagate_error (simple, error))
2559         return FALSE;
2560     }
2561
2562   iface = G_FILE_GET_IFACE (file);
2563   return (* iface->copy_finish) (file, res, error);
2564 }
2565
2566 /**
2567  * g_file_move:
2568  * @source: #GFile pointing to the source location.
2569  * @destination: #GFile pointing to the destination location.
2570  * @flags: set of #GFileCopyFlags.
2571  * @cancellable: optional #GCancellable object, %NULL to ignore.
2572  * @progress_callback: #GFileProgressCallback function for updates.
2573  * @progress_callback_data: gpointer to user data for the callback function.
2574  * @error: #GError for returning error conditions, or %NULL
2575  *
2576  *
2577  * Tries to move the file or directory @source to the location specified by @destination.
2578  * If native move operations are supported then this is used, otherwise a copy + delete
2579  * fallback is used. The native implementation may support moving directories (for instance
2580  * on moves inside the same filesystem), but the fallback code does not.
2581  *
2582  * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2583  * existing @destination file is overwritten.
2584  *
2585  * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2586  * will be copied as symlinks, otherwise the target of the
2587  * @source symlink will be copied.
2588  *
2589  * If @cancellable is not %NULL, then the operation can be cancelled by
2590  * triggering the cancellable object from another thread. If the operation
2591  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2592  *
2593  * If @progress_callback is not %NULL, then the operation can be monitored by
2594  * setting this to a #GFileProgressCallback function. @progress_callback_data
2595  * will be passed to this function. It is guaranteed that this callback will
2596  * be called after all data has been transferred with the total number of bytes
2597  * copied during the operation.
2598  *
2599  * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2600  * error is returned, independent on the status of the @destination.
2601  *
2602  * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2603  * error G_IO_ERROR_EXISTS is returned.
2604  *
2605  * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2606  * error is returned. If trying to overwrite a directory with a directory the
2607  * G_IO_ERROR_WOULD_MERGE error is returned.
2608  *
2609  * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
2610  * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
2611  * may be returned (if the native move operation isn't available).
2612  *
2613  * Returns: %TRUE on successful move, %FALSE otherwise.
2614  **/
2615 gboolean
2616 g_file_move (GFile                  *source,
2617              GFile                  *destination,
2618              GFileCopyFlags          flags,
2619              GCancellable           *cancellable,
2620              GFileProgressCallback   progress_callback,
2621              gpointer                progress_callback_data,
2622              GError                **error)
2623 {
2624   GFileIface *iface;
2625   GError *my_error;
2626   gboolean res;
2627
2628   g_return_val_if_fail (G_IS_FILE (source), FALSE);
2629   g_return_val_if_fail (G_IS_FILE (destination), FALSE);
2630
2631   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2632     return FALSE;
2633
2634   iface = G_FILE_GET_IFACE (destination);
2635   if (iface->move)
2636     {
2637       my_error = NULL;
2638       res = (* iface->move) (source, destination,
2639                              flags, cancellable,
2640                              progress_callback, progress_callback_data,
2641                              &my_error);
2642
2643       if (res)
2644         return TRUE;
2645
2646       if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2647         {
2648           g_propagate_error (error, my_error);
2649           return FALSE;
2650         }
2651     }
2652
2653   /* If the types are different, and the destination method failed
2654      also try the source method */
2655   if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
2656     {
2657       iface = G_FILE_GET_IFACE (source);
2658
2659       if (iface->move)
2660         {
2661           my_error = NULL;
2662           res = (* iface->move) (source, destination,
2663                                  flags, cancellable,
2664                                  progress_callback, progress_callback_data,
2665                                  &my_error);
2666
2667           if (res)
2668             return TRUE;
2669
2670           if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2671             {
2672               g_propagate_error (error, my_error);
2673               return FALSE;
2674             }
2675         }
2676     }
2677
2678   if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
2679     {
2680       g_set_error_literal (error, G_IO_ERROR,
2681                            G_IO_ERROR_NOT_SUPPORTED,
2682                            _("Operation not supported"));
2683       return FALSE;
2684     }
2685
2686   flags |= G_FILE_COPY_ALL_METADATA;
2687   if (!g_file_copy (source, destination, flags, cancellable,
2688                     progress_callback, progress_callback_data,
2689                     error))
2690     return FALSE;
2691
2692   return g_file_delete (source, cancellable, error);
2693 }
2694
2695 /**
2696  * g_file_make_directory
2697  * @file: input #GFile.
2698  * @cancellable: optional #GCancellable object, %NULL to ignore.
2699  * @error: a #GError, or %NULL
2700  *
2701  * Creates a directory. Note that this will only create a child directory of
2702  * the immediate parent directory of the path or URI given by the #GFile. To
2703  * recursively create directories, see g_file_make_directory_with_parents().
2704  * This function will fail if the parent directory does not exist, setting
2705  * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating
2706  * directories, this function will fail, setting @error to
2707  * %G_IO_ERROR_NOT_SUPPORTED.
2708  *
2709  * For a local #GFile the newly created directory will have the default
2710  * (current) ownership and permissions of the current process.
2711  *
2712  * If @cancellable is not %NULL, then the operation can be cancelled by
2713  * triggering the cancellable object from another thread. If the operation
2714  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2715  *
2716  * Returns: %TRUE on successful creation, %FALSE otherwise.
2717  **/
2718 gboolean
2719 g_file_make_directory (GFile         *file,
2720                        GCancellable  *cancellable,
2721                        GError       **error)
2722 {
2723   GFileIface *iface;
2724
2725   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2726
2727   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2728     return FALSE;
2729
2730   iface = G_FILE_GET_IFACE (file);
2731
2732   if (iface->make_directory == NULL)
2733     {
2734       g_set_error_literal (error, G_IO_ERROR,
2735                            G_IO_ERROR_NOT_SUPPORTED,
2736                            _("Operation not supported"));
2737       return FALSE;
2738     }
2739
2740   return (* iface->make_directory) (file, cancellable, error);
2741 }
2742
2743 /**
2744  * g_file_make_directory_with_parents:
2745  * @file: input #GFile.
2746  * @cancellable: optional #GCancellable object, %NULL to ignore.
2747  * @error: a #GError, or %NULL
2748  *
2749  * Creates a directory and any parent directories that may not exist similar to
2750  * 'mkdir -p'. If the file system does not support creating directories, this
2751  * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED.
2752  *
2753  * For a local #GFile the newly created directories will have the default
2754  * (current) ownership and permissions of the current process.
2755  *
2756  * If @cancellable is not %NULL, then the operation can be cancelled by
2757  * triggering the cancellable object from another thread. If the operation
2758  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2759  *
2760  * Returns: %TRUE if all directories have been successfully created, %FALSE
2761  * otherwise.
2762  *
2763  * Since: 2.18
2764  **/
2765 gboolean
2766 g_file_make_directory_with_parents (GFile         *file,
2767                                     GCancellable  *cancellable,
2768                                     GError       **error)
2769 {
2770   gboolean result;
2771   GFile *parent_file, *work_file;
2772   GList *list = NULL, *l;
2773   GError *my_error = NULL;
2774
2775   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2776     return FALSE;
2777
2778   result = g_file_make_directory (file, cancellable, &my_error);
2779   if (result || my_error->code != G_IO_ERROR_NOT_FOUND)
2780     {
2781       if (my_error)
2782         g_propagate_error (error, my_error);
2783       return result;
2784     }
2785
2786   work_file = file;
2787
2788   while (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
2789     {
2790       g_clear_error (&my_error);
2791
2792       parent_file = g_file_get_parent (work_file);
2793       if (parent_file == NULL)
2794         break;
2795       result = g_file_make_directory (parent_file, cancellable, &my_error);
2796
2797       if (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
2798         list = g_list_prepend (list, parent_file);
2799
2800       work_file = parent_file;
2801     }
2802
2803   for (l = list; result && l; l = l->next)
2804     {
2805       result = g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
2806     }
2807
2808   /* Clean up */
2809   while (list != NULL)
2810     {
2811       g_object_unref ((GFile *) list->data);
2812       list = g_list_remove (list, list->data);
2813     }
2814
2815   if (!result)
2816     {
2817       g_propagate_error (error, my_error);
2818       return result;
2819     }
2820
2821   return g_file_make_directory (file, cancellable, error);
2822 }
2823
2824 /**
2825  * g_file_make_symbolic_link:
2826  * @file: input #GFile.
2827  * @symlink_value: a string with the value of the new symlink.
2828  * @cancellable: optional #GCancellable object, %NULL to ignore.
2829  * @error: a #GError.
2830  *
2831  * Creates a symbolic link.
2832  *
2833  * If @cancellable is not %NULL, then the operation can be cancelled by
2834  * triggering the cancellable object from another thread. If the operation
2835  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2836  *
2837  * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
2838  **/
2839 gboolean
2840 g_file_make_symbolic_link (GFile         *file,
2841                            const char    *symlink_value,
2842                            GCancellable  *cancellable,
2843                            GError       **error)
2844 {
2845   GFileIface *iface;
2846
2847   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2848   g_return_val_if_fail (symlink_value != NULL, FALSE);
2849
2850   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2851     return FALSE;
2852
2853   if (*symlink_value == '\0')
2854     {
2855       g_set_error_literal (error, G_IO_ERROR,
2856                            G_IO_ERROR_INVALID_ARGUMENT,
2857                            _("Invalid symlink value given"));
2858       return FALSE;
2859     }
2860
2861   iface = G_FILE_GET_IFACE (file);
2862
2863   if (iface->make_symbolic_link == NULL)
2864     {
2865       g_set_error_literal (error, G_IO_ERROR,
2866                            G_IO_ERROR_NOT_SUPPORTED,
2867                            _("Operation not supported"));
2868       return FALSE;
2869     }
2870
2871   return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
2872 }
2873
2874 /**
2875  * g_file_delete:
2876  * @file: input #GFile.
2877  * @cancellable: optional #GCancellable object, %NULL to ignore.
2878  * @error: a #GError, or %NULL
2879  *
2880  * Deletes a file. If the @file is a directory, it will only be deleted if it
2881  * is empty.
2882  *
2883  * If @cancellable is not %NULL, then the operation can be cancelled by
2884  * triggering the cancellable object from another thread. If the operation
2885  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2886  *
2887  * Returns: %TRUE if the file was deleted. %FALSE otherwise.
2888  **/
2889 gboolean
2890 g_file_delete (GFile         *file,
2891                GCancellable  *cancellable,
2892                GError       **error)
2893 {
2894   GFileIface *iface;
2895
2896   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2897
2898   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2899     return FALSE;
2900
2901   iface = G_FILE_GET_IFACE (file);
2902
2903   if (iface->delete_file == NULL)
2904     {
2905       g_set_error_literal (error, G_IO_ERROR,
2906                            G_IO_ERROR_NOT_SUPPORTED,
2907                            _("Operation not supported"));
2908       return FALSE;
2909     }
2910
2911   return (* iface->delete_file) (file, cancellable, error);
2912 }
2913
2914 /**
2915  * g_file_trash:
2916  * @file: #GFile to send to trash.
2917  * @cancellable: optional #GCancellable object, %NULL to ignore.
2918  * @error: a #GError, or %NULL
2919  *
2920  * Sends @file to the "Trashcan", if possible. This is similar to
2921  * deleting it, but the user can recover it before emptying the trashcan.
2922  * Not all file systems support trashing, so this call can return the
2923  * %G_IO_ERROR_NOT_SUPPORTED error.
2924  *
2925  *
2926  * If @cancellable is not %NULL, then the operation can be cancelled by
2927  * triggering the cancellable object from another thread. If the operation
2928  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2929  *
2930  * Returns: %TRUE on successful trash, %FALSE otherwise.
2931  **/
2932 gboolean
2933 g_file_trash (GFile         *file,
2934               GCancellable  *cancellable,
2935               GError       **error)
2936 {
2937   GFileIface *iface;
2938
2939   g_return_val_if_fail (G_IS_FILE (file), FALSE);
2940
2941   if (g_cancellable_set_error_if_cancelled (cancellable, error))
2942     return FALSE;
2943
2944   iface = G_FILE_GET_IFACE (file);
2945
2946   if (iface->trash == NULL)
2947     {
2948       g_set_error_literal (error,
2949                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2950                            _("Trash not supported"));
2951       return FALSE;
2952     }
2953
2954   return (* iface->trash) (file, cancellable, error);
2955 }
2956
2957 /**
2958  * g_file_set_display_name:
2959  * @file: input #GFile.
2960  * @display_name: a string.
2961  * @cancellable: optional #GCancellable object, %NULL to ignore.
2962  * @error: a #GError, or %NULL
2963  *
2964  * Renames @file to the specified display name.
2965  *
2966  * The display name is converted from UTF8 to the correct encoding for the target
2967  * filesystem if possible and the @file is renamed to this.
2968  *
2969  * If you want to implement a rename operation in the user interface the edit name
2970  * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
2971  * widget, and then the result after editing should be passed to g_file_set_display_name().
2972  *
2973  * On success the resulting converted filename is returned.
2974  *
2975  * If @cancellable is not %NULL, then the operation can be cancelled by
2976  * triggering the cancellable object from another thread. If the operation
2977  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2978  *
2979  * Returns: a #GFile specifying what @file was renamed to, or %NULL
2980  *     if there was an error.
2981  *     Free the returned object with g_object_unref().
2982  **/
2983 GFile *
2984 g_file_set_display_name (GFile         *file,
2985                          const char    *display_name,
2986                          GCancellable  *cancellable,
2987                          GError       **error)
2988 {
2989   GFileIface *iface;
2990
2991   g_return_val_if_fail (G_IS_FILE (file), NULL);
2992   g_return_val_if_fail (display_name != NULL, NULL);
2993
2994   if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
2995     {
2996       g_set_error (error,
2997                    G_IO_ERROR,
2998                    G_IO_ERROR_INVALID_ARGUMENT,
2999                    _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
3000       return NULL;
3001     }
3002
3003   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3004     return NULL;
3005
3006   iface = G_FILE_GET_IFACE (file);
3007
3008   return (* iface->set_display_name) (file, display_name, cancellable, error);
3009 }
3010
3011 /**
3012  * g_file_set_display_name_async:
3013  * @file: input #GFile.
3014  * @display_name: a string.
3015  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3016  *     of the request.
3017  * @cancellable: optional #GCancellable object, %NULL to ignore.
3018  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3019  * @user_data: the data to pass to callback function
3020  *
3021  * Asynchronously sets the display name for a given #GFile.
3022  *
3023  * For more details, see g_set_display_name() which is
3024  * the synchronous version of this call.
3025  *
3026  * When the operation is finished, @callback will be called. You can then call
3027  * g_file_set_display_name_finish() to get the result of the operation.
3028  **/
3029 void
3030 g_file_set_display_name_async (GFile               *file,
3031                                const char          *display_name,
3032                                int                  io_priority,
3033                                GCancellable        *cancellable,
3034                                GAsyncReadyCallback  callback,
3035                                gpointer             user_data)
3036 {
3037   GFileIface *iface;
3038
3039   g_return_if_fail (G_IS_FILE (file));
3040   g_return_if_fail (display_name != NULL);
3041
3042   iface = G_FILE_GET_IFACE (file);
3043   (* iface->set_display_name_async) (file,
3044                                      display_name,
3045                                      io_priority,
3046                                      cancellable,
3047                                      callback,
3048                                      user_data);
3049 }
3050
3051 /**
3052  * g_file_set_display_name_finish:
3053  * @file: input #GFile.
3054  * @res: a #GAsyncResult.
3055  * @error: a #GError, or %NULL
3056  *
3057  * Finishes setting a display name started with
3058  * g_file_set_display_name_async().
3059  *
3060  * Returns: a #GFile or %NULL on error.
3061  *     Free the returned object with g_object_unref().
3062  **/
3063 GFile *
3064 g_file_set_display_name_finish (GFile         *file,
3065                                 GAsyncResult  *res,
3066                                 GError       **error)
3067 {
3068   GFileIface *iface;
3069
3070   g_return_val_if_fail (G_IS_FILE (file), NULL);
3071   g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3072
3073   if (G_IS_SIMPLE_ASYNC_RESULT (res))
3074     {
3075       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3076       if (g_simple_async_result_propagate_error (simple, error))
3077         return NULL;
3078     }
3079
3080   iface = G_FILE_GET_IFACE (file);
3081   return (* iface->set_display_name_finish) (file, res, error);
3082 }
3083
3084 /**
3085  * g_file_query_settable_attributes:
3086  * @file: input #GFile.
3087  * @cancellable: optional #GCancellable object, %NULL to ignore.
3088  * @error: a #GError, or %NULL
3089  *
3090  * Obtain the list of settable attributes for the file.
3091  *
3092  * Returns the type and full attribute name of all the attributes
3093  * that can be set on this file. This doesn't mean setting it will always
3094  * succeed though, you might get an access failure, or some specific
3095  * file may not support a specific attribute.
3096  *
3097  * If @cancellable is not %NULL, then the operation can be cancelled by
3098  * triggering the cancellable object from another thread. If the operation
3099  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3100  *
3101  * Returns: a #GFileAttributeInfoList describing the settable attributes.
3102  * When you are done with it, release it with g_file_attribute_info_list_unref()
3103  **/
3104 GFileAttributeInfoList *
3105 g_file_query_settable_attributes (GFile         *file,
3106                                   GCancellable  *cancellable,
3107                                   GError       **error)
3108 {
3109   GFileIface *iface;
3110   GError *my_error;
3111   GFileAttributeInfoList *list;
3112
3113   g_return_val_if_fail (G_IS_FILE (file), NULL);
3114
3115   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3116     return NULL;
3117
3118   iface = G_FILE_GET_IFACE (file);
3119
3120   if (iface->query_settable_attributes == NULL)
3121     return g_file_attribute_info_list_new ();
3122
3123   my_error = NULL;
3124   list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3125
3126   if (list == NULL)
3127     {
3128       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3129         {
3130           list = g_file_attribute_info_list_new ();
3131           g_error_free (my_error);
3132         }
3133       else
3134         g_propagate_error (error, my_error);
3135     }
3136
3137   return list;
3138 }
3139
3140 /**
3141  * g_file_query_writable_namespaces:
3142  * @file: input #GFile.
3143  * @cancellable: optional #GCancellable object, %NULL to ignore.
3144  * @error: a #GError, or %NULL
3145  *
3146  * Obtain the list of attribute namespaces where new attributes
3147  * can be created by a user. An example of this is extended
3148  * attributes (in the "xattr" namespace).
3149  *
3150  * If @cancellable is not %NULL, then the operation can be cancelled by
3151  * triggering the cancellable object from another thread. If the operation
3152  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3153  *
3154  * Returns: a #GFileAttributeInfoList describing the writable namespaces.
3155  * When you are done with it, release it with g_file_attribute_info_list_unref()
3156  **/
3157 GFileAttributeInfoList *
3158 g_file_query_writable_namespaces (GFile         *file,
3159                                   GCancellable  *cancellable,
3160                                   GError       **error)
3161 {
3162   GFileIface *iface;
3163   GError *my_error;
3164   GFileAttributeInfoList *list;
3165
3166   g_return_val_if_fail (G_IS_FILE (file), NULL);
3167
3168   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3169     return NULL;
3170
3171   iface = G_FILE_GET_IFACE (file);
3172
3173   if (iface->query_writable_namespaces == NULL)
3174     return g_file_attribute_info_list_new ();
3175
3176   my_error = NULL;
3177   list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
3178
3179   if (list == NULL)
3180     {
3181       if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3182         {
3183           list = g_file_attribute_info_list_new ();
3184           g_error_free (my_error);
3185         }
3186       else
3187         g_propagate_error (error, my_error);
3188     }
3189
3190   return list;
3191 }
3192
3193 /**
3194  * g_file_set_attribute:
3195  * @file: input #GFile.
3196  * @attribute: a string containing the attribute's name.
3197  * @type: The type of the attribute
3198  * @value_p: a pointer to the value (or the pointer itself if the type is a pointer type)
3199  * @flags: a set of #GFileQueryInfoFlags.
3200  * @cancellable: optional #GCancellable object, %NULL to ignore.
3201  * @error: a #GError, or %NULL
3202  *
3203  * Sets an attribute in the file with attribute name @attribute to @value.
3204  *
3205  * If @cancellable is not %NULL, then the operation can be cancelled by
3206  * triggering the cancellable object from another thread. If the operation
3207  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3208  *
3209  * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3210  **/
3211 gboolean
3212 g_file_set_attribute (GFile                      *file,
3213                       const char                 *attribute,
3214                       GFileAttributeType          type,
3215                       gpointer                    value_p,
3216                       GFileQueryInfoFlags         flags,
3217                       GCancellable               *cancellable,
3218                       GError                    **error)
3219 {
3220   GFileIface *iface;
3221
3222   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3223   g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
3224
3225   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3226     return FALSE;
3227
3228   iface = G_FILE_GET_IFACE (file);
3229
3230   if (iface->set_attribute == NULL)
3231     {
3232       g_set_error_literal (error, G_IO_ERROR,
3233                            G_IO_ERROR_NOT_SUPPORTED,
3234                            _("Operation not supported"));
3235       return FALSE;
3236     }
3237
3238   return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
3239 }
3240
3241 /**
3242  * g_file_set_attributes_from_info:
3243  * @file: input #GFile.
3244  * @info: a #GFileInfo.
3245  * @flags: #GFileQueryInfoFlags
3246  * @cancellable: optional #GCancellable object, %NULL to ignore.
3247  * @error: a #GError, or %NULL
3248  *
3249  * Tries to set all attributes in the #GFileInfo on the target values,
3250  * not stopping on the first error.
3251  *
3252  * If there is any error during this operation then @error will be set to
3253  * the first error. Error on particular fields are flagged by setting
3254  * the "status" field in the attribute value to
3255  * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
3256  * further errors.
3257  *
3258  * If @cancellable is not %NULL, then the operation can be cancelled by
3259  * triggering the cancellable object from another thread. If the operation
3260  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3261  *
3262  * Returns: %TRUE if there was any error, %FALSE otherwise.
3263  **/
3264 gboolean
3265 g_file_set_attributes_from_info (GFile                *file,
3266                                  GFileInfo            *info,
3267                                  GFileQueryInfoFlags   flags,
3268                                  GCancellable         *cancellable,
3269                                  GError              **error)
3270 {
3271   GFileIface *iface;
3272
3273   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3274   g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
3275
3276   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3277     return FALSE;
3278
3279   g_file_info_clear_status (info);
3280
3281   iface = G_FILE_GET_IFACE (file);
3282
3283   return (* iface->set_attributes_from_info) (file,
3284                                               info,
3285                                               flags,
3286                                               cancellable,
3287                                               error);
3288 }
3289
3290
3291 static gboolean
3292 g_file_real_set_attributes_from_info (GFile                *file,
3293                                       GFileInfo            *info,
3294                                       GFileQueryInfoFlags   flags,
3295                                       GCancellable         *cancellable,
3296                                       GError              **error)
3297 {
3298   char **attributes;
3299   int i;
3300   gboolean res;
3301   GFileAttributeValue *value;
3302
3303   res = TRUE;
3304
3305   attributes = g_file_info_list_attributes (info, NULL);
3306
3307   for (i = 0; attributes[i] != NULL; i++)
3308     {
3309       value = _g_file_info_get_attribute_value (info, attributes[i]);
3310
3311       if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
3312         continue;
3313
3314       if (!g_file_set_attribute (file, attributes[i],
3315                                  value->type, _g_file_attribute_value_peek_as_pointer (value),
3316                                  flags, cancellable, error))
3317         {
3318           value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3319           res = FALSE;
3320           /* Don't set error multiple times */
3321           error = NULL;
3322         }
3323       else
3324         value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3325     }
3326
3327   g_strfreev (attributes);
3328
3329   return res;
3330 }
3331
3332 /**
3333  * g_file_set_attributes_async:
3334  * @file: input #GFile.
3335  * @info: a #GFileInfo.
3336  * @flags: a #GFileQueryInfoFlags.
3337  * @io_priority: the <link linkend="io-priority">I/O priority</link>
3338  *     of the request.
3339  * @cancellable: optional #GCancellable object, %NULL to ignore.
3340  * @callback: a #GAsyncReadyCallback.
3341  * @user_data: a #gpointer.
3342  *
3343  * Asynchronously sets the attributes of @file with @info.
3344  *
3345  * For more details, see g_file_set_attributes_from_info() which is
3346  * the synchronous version of this call.
3347  *
3348  * When the operation is finished, @callback will be called. You can then call
3349  * g_file_set_attributes_finish() to get the result of the operation.
3350  **/
3351 void
3352 g_file_set_attributes_async (GFile               *file,
3353                              GFileInfo           *info,
3354                              GFileQueryInfoFlags  flags,
3355                              int                  io_priority,
3356                              GCancellable        *cancellable,
3357                              GAsyncReadyCallback  callback,
3358                              gpointer             user_data)
3359 {
3360   GFileIface *iface;
3361
3362   g_return_if_fail (G_IS_FILE (file));
3363   g_return_if_fail (G_IS_FILE_INFO (info));
3364
3365   iface = G_FILE_GET_IFACE (file);
3366   (* iface->set_attributes_async) (file,
3367                                    info,
3368                                    flags,
3369                                    io_priority,
3370                                    cancellable,
3371                                    callback,
3372                                    user_data);
3373 }
3374
3375 /**
3376  * g_file_set_attributes_finish:
3377  * @file: input #GFile.
3378  * @result: a #GAsyncResult.
3379  * @info: a #GFileInfo.
3380  * @error: a #GError, or %NULL
3381  *
3382  * Finishes setting an attribute started in g_file_set_attributes_async().
3383  *
3384  * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
3385  **/
3386 gboolean
3387 g_file_set_attributes_finish (GFile         *file,
3388                               GAsyncResult  *result,
3389                               GFileInfo    **info,
3390                               GError       **error)
3391 {
3392   GFileIface *iface;
3393
3394   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3395   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3396
3397   /* No standard handling of errors here, as we must set info even
3398    * on errors
3399    */
3400   iface = G_FILE_GET_IFACE (file);
3401   return (* iface->set_attributes_finish) (file, result, info, error);
3402 }
3403
3404 /**
3405  * g_file_set_attribute_string:
3406  * @file: input #GFile.
3407  * @attribute: a string containing the attribute's name.
3408  * @value: a string containing the attribute's value.
3409  * @flags: #GFileQueryInfoFlags.
3410  * @cancellable: optional #GCancellable object, %NULL to ignore.
3411  * @error: a #GError, or %NULL
3412  *
3413  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
3414  * If @attribute is of a different type, this operation will fail.
3415  *
3416  * If @cancellable is not %NULL, then the operation can be cancelled by
3417  * triggering the cancellable object from another thread. If the operation
3418  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3419  *
3420  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
3421  **/
3422 gboolean
3423 g_file_set_attribute_string (GFile                *file,
3424                              const char           *attribute,
3425                              const char           *value,
3426                              GFileQueryInfoFlags   flags,
3427                              GCancellable         *cancellable,
3428                              GError              **error)
3429 {
3430   return g_file_set_attribute (file, attribute,
3431                                G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
3432                                flags, cancellable, error);
3433 }
3434
3435 /**
3436  * g_file_set_attribute_byte_string:
3437  * @file: input #GFile.
3438  * @attribute: a string containing the attribute's name.
3439  * @value: a string containing the attribute's new value.
3440  * @flags: a #GFileQueryInfoFlags.
3441  * @cancellable: optional #GCancellable object, %NULL to ignore.
3442  * @error: a #GError, or %NULL
3443  *
3444  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
3445  * If @attribute is of a different type, this operation will fail,
3446  * returning %FALSE.
3447  *
3448  * If @cancellable is not %NULL, then the operation can be cancelled by
3449  * triggering the cancellable object from another thread. If the operation
3450  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3451  *
3452  * Returns: %TRUE if the @attribute was successfully set to @value
3453  * in the @file, %FALSE otherwise.
3454  **/
3455 gboolean
3456 g_file_set_attribute_byte_string  (GFile                *file,
3457                                    const char           *attribute,
3458                                    const char           *value,
3459                                    GFileQueryInfoFlags   flags,
3460                                    GCancellable         *cancellable,
3461                                    GError              **error)
3462 {
3463   return g_file_set_attribute (file, attribute,
3464                                G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
3465                                flags, cancellable, error);
3466 }
3467
3468 /**
3469  * g_file_set_attribute_uint32:
3470  * @file: input #GFile.
3471  * @attribute: a string containing the attribute's name.
3472  * @value: a #guint32 containing the attribute's new value.
3473  * @flags: a #GFileQueryInfoFlags.
3474  * @cancellable: optional #GCancellable object, %NULL to ignore.
3475  * @error: a #GError, or %NULL
3476  *
3477  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
3478  * If @attribute is of a different type, this operation will fail.
3479  *
3480  * If @cancellable is not %NULL, then the operation can be cancelled by
3481  * triggering the cancellable object from another thread. If the operation
3482  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3483  *
3484  * Returns: %TRUE if the @attribute was successfully set to @value
3485  * in the @file, %FALSE otherwise.
3486  **/
3487 gboolean
3488 g_file_set_attribute_uint32 (GFile                *file,
3489                              const char           *attribute,
3490                              guint32               value,
3491                              GFileQueryInfoFlags   flags,
3492                              GCancellable         *cancellable,
3493                              GError              **error)
3494 {
3495   return g_file_set_attribute (file, attribute,
3496                                G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
3497                                flags, cancellable, error);
3498 }
3499
3500 /**
3501  * g_file_set_attribute_int32:
3502  * @file: input #GFile.
3503  * @attribute: a string containing the attribute's name.
3504  * @value: a #gint32 containing the attribute's new value.
3505  * @flags: a #GFileQueryInfoFlags.
3506  * @cancellable: optional #GCancellable object, %NULL to ignore.
3507  * @error: a #GError, or %NULL
3508  *
3509  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
3510  * If @attribute is of a different type, this operation will fail.
3511  *
3512  * If @cancellable is not %NULL, then the operation can be cancelled by
3513  * triggering the cancellable object from another thread. If the operation
3514  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3515  *
3516  * Returns: %TRUE if the @attribute was successfully set to @value
3517  * in the @file, %FALSE otherwise.
3518  **/
3519 gboolean
3520 g_file_set_attribute_int32 (GFile                *file,
3521                             const char           *attribute,
3522                             gint32                value,
3523                             GFileQueryInfoFlags   flags,
3524                             GCancellable         *cancellable,
3525                             GError              **error)
3526 {
3527   return g_file_set_attribute (file, attribute,
3528                                G_FILE_ATTRIBUTE_TYPE_INT32, &value,
3529                                flags, cancellable, error);
3530 }
3531
3532 /**
3533  * g_file_set_attribute_uint64:
3534  * @file: input #GFile.
3535  * @attribute: a string containing the attribute's name.
3536  * @value: a #guint64 containing the attribute's new value.
3537  * @flags: a #GFileQueryInfoFlags.
3538  * @cancellable: optional #GCancellable object, %NULL to ignore.
3539  * @error: a #GError, or %NULL
3540  *
3541  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
3542  * If @attribute is of a different type, this operation will fail.
3543  *
3544  * If @cancellable is not %NULL, then the operation can be cancelled by
3545  * triggering the cancellable object from another thread. If the operation
3546  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3547  *
3548  * Returns: %TRUE if the @attribute was successfully set to @value
3549  * in the @file, %FALSE otherwise.
3550  **/
3551 gboolean
3552 g_file_set_attribute_uint64 (GFile                *file,
3553                              const char           *attribute,
3554                              guint64               value,
3555                              GFileQueryInfoFlags   flags,
3556                              GCancellable         *cancellable,
3557                              GError              **error)
3558  {
3559   return g_file_set_attribute (file, attribute,
3560                                G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
3561                                flags, cancellable, error);
3562 }
3563
3564 /**
3565  * g_file_set_attribute_int64:
3566  * @file: input #GFile.
3567  * @attribute: a string containing the attribute's name.
3568  * @value: a #guint64 containing the attribute's new value.
3569  * @flags: a #GFileQueryInfoFlags.
3570  * @cancellable: optional #GCancellable object, %NULL to ignore.
3571  * @error: a #GError, or %NULL
3572  *
3573  * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
3574  * If @attribute is of a different type, this operation will fail.
3575  *
3576  * If @cancellable is not %NULL, then the operation can be cancelled by
3577  * triggering the cancellable object from another thread. If the operation
3578  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3579  *
3580  * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
3581  **/
3582 gboolean
3583 g_file_set_attribute_int64 (GFile                *file,
3584                             const char           *attribute,
3585                             gint64                value,
3586                             GFileQueryInfoFlags   flags,
3587                             GCancellable         *cancellable,
3588                             GError              **error)
3589 {
3590   return g_file_set_attribute (file, attribute,
3591                                G_FILE_ATTRIBUTE_TYPE_INT64, &value,
3592                                flags, cancellable, error);
3593 }
3594
3595 /**
3596  * g_file_mount_mountable:
3597  * @file: input #GFile.
3598  * @flags: flags affecting the operation
3599  * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
3600  * @cancellable: optional #GCancellable object, %NULL to ignore.
3601  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3602  * @user_data: the data to pass to callback function
3603  *
3604  * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
3605  * Using @mount_operation, you can request callbacks when, for instance,
3606  * passwords are needed during authentication.
3607  *
3608  * If @cancellable is not %NULL, then the operation can be cancelled by
3609  * triggering the cancellable object from another thread. If the operation
3610  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3611  *
3612  * When the operation is finished, @callback will be called. You can then call
3613  * g_file_mount_mountable_finish() to get the result of the operation.
3614  **/
3615 void
3616 g_file_mount_mountable (GFile               *file,
3617                         GMountMountFlags     flags,
3618                         GMountOperation     *mount_operation,
3619                         GCancellable        *cancellable,
3620                         GAsyncReadyCallback  callback,
3621                         gpointer             user_data)
3622 {
3623   GFileIface *iface;
3624
3625   g_return_if_fail (G_IS_FILE (file));
3626
3627   iface = G_FILE_GET_IFACE (file);
3628
3629   if (iface->mount_mountable == NULL)
3630     {
3631       g_simple_async_report_error_in_idle (G_OBJECT (file),
3632                                            callback,
3633                                            user_data,
3634                                            G_IO_ERROR,
3635                                            G_IO_ERROR_NOT_SUPPORTED,
3636                                            _("Operation not supported"));
3637       return;
3638     }
3639
3640   (* iface->mount_mountable) (file,
3641                               flags,
3642                               mount_operation,
3643                               cancellable,
3644                               callback,
3645                               user_data);
3646 }
3647
3648 /**
3649  * g_file_mount_mountable_finish:
3650  * @file: input #GFile.
3651  * @result: a #GAsyncResult.
3652  * @error: a #GError, or %NULL
3653  *
3654  * Finishes a mount operation. See g_file_mount_mountable() for details.
3655  *
3656  * Finish an asynchronous mount operation that was started
3657  * with g_file_mount_mountable().
3658  *
3659  * Returns: a #GFile or %NULL on error.
3660  *     Free the returned object with g_object_unref().
3661  **/
3662 GFile *
3663 g_file_mount_mountable_finish (GFile         *file,
3664                                GAsyncResult  *result,
3665                                GError       **error)
3666 {
3667   GFileIface *iface;
3668
3669   g_return_val_if_fail (G_IS_FILE (file), NULL);
3670   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
3671
3672   if (G_IS_SIMPLE_ASYNC_RESULT (result))
3673     {
3674       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3675       if (g_simple_async_result_propagate_error (simple, error))
3676         return NULL;
3677     }
3678
3679   iface = G_FILE_GET_IFACE (file);
3680   return (* iface->mount_mountable_finish) (file, result, error);
3681 }
3682
3683 /**
3684  * g_file_unmount_mountable:
3685  * @file: input #GFile.
3686  * @flags: flags affecting the operation
3687  * @cancellable: optional #GCancellable object, %NULL to ignore.
3688  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3689  * @user_data: the data to pass to callback function
3690  *
3691  * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
3692  *
3693  * If @cancellable is not %NULL, then the operation can be cancelled by
3694  * triggering the cancellable object from another thread. If the operation
3695  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3696  *
3697  * When the operation is finished, @callback will be called. You can then call
3698  * g_file_unmount_mountable_finish() to get the result of the operation.
3699  **/
3700 void
3701 g_file_unmount_mountable (GFile               *file,
3702                           GMountUnmountFlags   flags,
3703                           GCancellable        *cancellable,
3704                           GAsyncReadyCallback  callback,
3705                           gpointer             user_data)
3706 {
3707   GFileIface *iface;
3708
3709   g_return_if_fail (G_IS_FILE (file));
3710
3711   iface = G_FILE_GET_IFACE (file);
3712
3713   if (iface->unmount_mountable == NULL)
3714     {
3715       g_simple_async_report_error_in_idle (G_OBJECT (file),
3716                                            callback,
3717                                            user_data,
3718                                            G_IO_ERROR,
3719                                            G_IO_ERROR_NOT_SUPPORTED,
3720                                            _("Operation not supported"));
3721       return;
3722     }
3723
3724   (* iface->unmount_mountable) (file,
3725                                 flags,
3726                                 cancellable,
3727                                 callback,
3728                                 user_data);
3729 }
3730
3731 /**
3732  * g_file_unmount_mountable_finish:
3733  * @file: input #GFile.
3734  * @result: a #GAsyncResult.
3735  * @error: a #GError, or %NULL
3736  *
3737  * Finishes an unmount operation, see g_file_unmount_mountable() for details.
3738  *
3739  * Finish an asynchronous unmount operation that was started
3740  * with g_file_unmount_mountable().
3741  *
3742  * Returns: %TRUE if the operation finished successfully. %FALSE
3743  * otherwise.
3744  **/
3745 gboolean
3746 g_file_unmount_mountable_finish (GFile         *file,
3747                                  GAsyncResult  *result,
3748                                  GError       **error)
3749 {
3750   GFileIface *iface;
3751
3752   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3753   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3754
3755   if (G_IS_SIMPLE_ASYNC_RESULT (result))
3756     {
3757       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3758       if (g_simple_async_result_propagate_error (simple, error))
3759         return FALSE;
3760     }
3761
3762   iface = G_FILE_GET_IFACE (file);
3763   return (* iface->unmount_mountable_finish) (file, result, error);
3764 }
3765
3766 /**
3767  * g_file_eject_mountable:
3768  * @file: input #GFile.
3769  * @flags: flags affecting the operation
3770  * @cancellable: optional #GCancellable object, %NULL to ignore.
3771  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3772  * @user_data: the data to pass to callback function
3773  *
3774  * Starts an asynchronous eject on a mountable.
3775  * When this operation has completed, @callback will be called with
3776  * @user_user data, and the operation can be finalized with
3777  * g_file_eject_mountable_finish().
3778  *
3779  * If @cancellable is not %NULL, then the operation can be cancelled by
3780  * triggering the cancellable object from another thread. If the operation
3781  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3782  **/
3783 void
3784 g_file_eject_mountable (GFile               *file,
3785                         GMountUnmountFlags   flags,
3786                         GCancellable        *cancellable,
3787                         GAsyncReadyCallback  callback,
3788                         gpointer             user_data)
3789 {
3790   GFileIface *iface;
3791
3792   g_return_if_fail (G_IS_FILE (file));
3793
3794   iface = G_FILE_GET_IFACE (file);
3795
3796   if (iface->eject_mountable == NULL)
3797     {
3798       g_simple_async_report_error_in_idle (G_OBJECT (file),
3799                                            callback,
3800                                            user_data,
3801                                            G_IO_ERROR,
3802                                            G_IO_ERROR_NOT_SUPPORTED,
3803                                            _("Operation not supported"));
3804       return;
3805     }
3806
3807   (* iface->eject_mountable) (file,
3808                               flags,
3809                               cancellable,
3810                               callback,
3811                               user_data);
3812 }
3813
3814 /**
3815  * g_file_eject_mountable_finish:
3816  * @file: input #GFile.
3817  * @result: a #GAsyncResult.
3818  * @error: a #GError, or %NULL
3819  *
3820  * Finishes an asynchronous eject operation started by
3821  * g_file_eject_mountable().
3822  *
3823  * Returns: %TRUE if the @file was ejected successfully. %FALSE
3824  * otherwise.
3825  **/
3826 gboolean
3827 g_file_eject_mountable_finish (GFile         *file,
3828                                GAsyncResult  *result,
3829                                GError       **error)
3830 {
3831   GFileIface *iface;
3832
3833   g_return_val_if_fail (G_IS_FILE (file), FALSE);
3834   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3835
3836   if (G_IS_SIMPLE_ASYNC_RESULT (result))
3837     {
3838       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3839       if (g_simple_async_result_propagate_error (simple, error))
3840         return FALSE;
3841     }
3842
3843   iface = G_FILE_GET_IFACE (file);
3844   return (* iface->eject_mountable_finish) (file, result, error);
3845 }
3846
3847 /**
3848  * g_file_monitor_directory:
3849  * @file: input #GFile.
3850  * @flags: a set of #GFileMonitorFlags.
3851  * @cancellable: optional #GCancellable object, %NULL to ignore.
3852  * @error: a #GError, or %NULL.
3853  *
3854  * Obtains a directory monitor for the given file.
3855  * This may fail if directory monitoring is not supported.
3856  *
3857  * If @cancellable is not %NULL, then the operation can be cancelled by
3858  * triggering the cancellable object from another thread. If the operation
3859  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3860  *
3861  * Returns: a #GFileMonitor for the given @file, or %NULL on error.
3862  *     Free the returned object with g_object_unref().
3863  **/
3864 GFileMonitor*
3865 g_file_monitor_directory (GFile             *file,
3866                           GFileMonitorFlags  flags,
3867                           GCancellable      *cancellable,
3868                           GError           **error)
3869 {
3870   GFileIface *iface;
3871
3872   g_return_val_if_fail (G_IS_FILE (file), NULL);
3873
3874   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3875     return NULL;
3876
3877   iface = G_FILE_GET_IFACE (file);
3878
3879   if (iface->monitor_dir == NULL)
3880     {
3881       g_set_error_literal (error, G_IO_ERROR,
3882                            G_IO_ERROR_NOT_SUPPORTED,
3883                            _("Operation not supported"));
3884       return NULL;
3885     }
3886
3887   return (* iface->monitor_dir) (file, flags, cancellable, error);
3888 }
3889
3890 /**
3891  * g_file_monitor_file:
3892  * @file: input #GFile.
3893  * @flags: a set of #GFileMonitorFlags.
3894  * @cancellable: optional #GCancellable object, %NULL to ignore.
3895  * @error: a #GError, or %NULL.
3896  *
3897  * Obtains a file monitor for the given file. If no file notification
3898  * mechanism exists, then regular polling of the file is used.
3899  *
3900  * If @cancellable is not %NULL, then the operation can be cancelled by
3901  * triggering the cancellable object from another thread. If the operation
3902  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3903  *
3904  * Returns: a #GFileMonitor for the given @file, or %NULL on error.
3905  *     Free the returned object with g_object_unref().
3906  **/
3907 GFileMonitor*
3908 g_file_monitor_file (GFile             *file,
3909                      GFileMonitorFlags  flags,
3910                      GCancellable      *cancellable,
3911                      GError           **error)
3912 {
3913   GFileIface *iface;
3914   GFileMonitor *monitor;
3915
3916   g_return_val_if_fail (G_IS_FILE (file), NULL);
3917
3918   if (g_cancellable_set_error_if_cancelled (cancellable, error))
3919     return NULL;
3920
3921   iface = G_FILE_GET_IFACE (file);
3922
3923   monitor = NULL;
3924
3925   if (iface->monitor_file)
3926     monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
3927
3928 /* Fallback to polling */
3929   if (monitor == NULL)
3930     monitor = _g_poll_file_monitor_new (file);
3931
3932   return monitor;
3933 }
3934
3935 /**
3936  * g_file_monitor:
3937  * @file: input #GFile
3938  * @flags: a set of #GFileMonitorFlags
3939  * @cancellable: optional #GCancellable object, %NULL to ignore
3940  * @error: a #GError, or %NULL
3941  *
3942  * Obtains a file or directory monitor for the given file, depending
3943  * on the type of the file.
3944  *
3945  * If @cancellable is not %NULL, then the operation can be cancelled by
3946  * triggering the cancellable object from another thread. If the operation
3947  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3948  *
3949  * Returns: a #GFileMonitor for the given @file, or %NULL on error.
3950  *     Free the returned object with g_object_unref().
3951  *
3952  * Since: 2.18
3953  */
3954 GFileMonitor*
3955 g_file_monitor (GFile             *file,
3956                 GFileMonitorFlags  flags,
3957                 GCancellable      *cancellable,
3958                 GError           **error)
3959 {
3960   if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
3961     return g_file_monitor_directory (file, flags, cancellable, error);
3962   else
3963     return g_file_monitor_file (file, flags, cancellable, error);
3964 }
3965
3966 /********************************************
3967  *   Default implementation of async ops    *
3968  ********************************************/
3969
3970 typedef struct {
3971   char *attributes;
3972   GFileQueryInfoFlags flags;
3973   GFileInfo *info;
3974 } QueryInfoAsyncData;
3975
3976 static void
3977 query_info_data_free (QueryInfoAsyncData *data)
3978 {
3979   if (data->info)
3980     g_object_unref (data->info);
3981   g_free (data->attributes);
3982   g_free (data);
3983 }
3984
3985 static void
3986 query_info_async_thread (GSimpleAsyncResult *res,
3987                          GObject            *object,
3988                          GCancellable       *cancellable)
3989 {
3990   GError *error = NULL;
3991   QueryInfoAsyncData *data;
3992   GFileInfo *info;
3993
3994   data = g_simple_async_result_get_op_res_gpointer (res);
3995
3996   info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
3997
3998   if (info == NULL)
3999     {
4000       g_simple_async_result_set_from_error (res, error);
4001       g_error_free (error);
4002     }
4003   else
4004     data->info = info;
4005 }
4006
4007 static void
4008 g_file_real_query_info_async (GFile               *file,
4009                               const char          *attributes,
4010                               GFileQueryInfoFlags  flags,
4011                               int                  io_priority,
4012                               GCancellable        *cancellable,
4013                               GAsyncReadyCallback  callback,
4014                               gpointer             user_data)
4015 {
4016   GSimpleAsyncResult *res;
4017   QueryInfoAsyncData *data;
4018
4019   data = g_new0 (QueryInfoAsyncData, 1);
4020   data->attributes = g_strdup (attributes);
4021   data->flags = flags;
4022
4023   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
4024   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
4025
4026   g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
4027   g_object_unref (res);
4028 }
4029
4030 static GFileInfo *
4031 g_file_real_query_info_finish (GFile         *file,
4032                                GAsyncResult  *res,
4033                                GError       **error)
4034 {
4035   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4036   QueryInfoAsyncData *data;
4037
4038   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
4039
4040   data = g_simple_async_result_get_op_res_gpointer (simple);
4041   if (data->info)
4042     return g_object_ref (data->info);
4043
4044   return NULL;
4045 }
4046
4047 typedef struct {
4048   char *attributes;
4049   GFileInfo *info;
4050 } QueryFilesystemInfoAsyncData;
4051
4052 static void
4053 query_filesystem_info_data_free (QueryFilesystemInfoAsyncData *data)
4054 {
4055   if (data->info)
4056     g_object_unref (data->info);
4057   g_free (data->attributes);
4058   g_free (data);
4059 }
4060
4061 static void
4062 query_filesystem_info_async_thread (GSimpleAsyncResult *res,
4063                                     GObject            *object,
4064                                     GCancellable       *cancellable)
4065 {
4066   GError *error = NULL;
4067   QueryFilesystemInfoAsyncData *data;
4068   GFileInfo *info;
4069
4070   data = g_simple_async_result_get_op_res_gpointer (res);
4071
4072   info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error);
4073
4074   if (info == NULL)
4075     {
4076       g_simple_async_result_set_from_error (res, error);
4077       g_error_free (error);
4078     }
4079   else
4080     data->info = info;
4081 }
4082
4083 static void
4084 g_file_real_query_filesystem_info_async (GFile               *file,
4085                                          const char          *attributes,
4086                                          int                  io_priority,
4087                                          GCancellable        *cancellable,
4088                                          GAsyncReadyCallback  callback,
4089                                          gpointer             user_data)
4090 {
4091   GSimpleAsyncResult *res;
4092   QueryFilesystemInfoAsyncData *data;
4093
4094   data = g_new0 (QueryFilesystemInfoAsyncData, 1);
4095   data->attributes = g_strdup (attributes);
4096
4097   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async);
4098   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free);
4099
4100   g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable);
4101   g_object_unref (res);
4102 }
4103
4104 static GFileInfo *
4105 g_file_real_query_filesystem_info_finish (GFile         *file,
4106                                           GAsyncResult  *res,
4107                                           GError       **error)
4108 {
4109   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4110   QueryFilesystemInfoAsyncData *data;
4111
4112   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_filesystem_info_async);
4113
4114   data = g_simple_async_result_get_op_res_gpointer (simple);
4115   if (data->info)
4116     return g_object_ref (data->info);
4117
4118   return NULL;
4119 }
4120
4121 typedef struct {
4122   char *attributes;
4123   GFileQueryInfoFlags flags;
4124   GFileEnumerator *enumerator;
4125 } EnumerateChildrenAsyncData;
4126
4127 static void
4128 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
4129 {
4130   if (data->enumerator)
4131     g_object_unref (data->enumerator);
4132   g_free (data->attributes);
4133   g_free (data);
4134 }
4135
4136 static void
4137 enumerate_children_async_thread (GSimpleAsyncResult *res,
4138                                  GObject            *object,
4139                                  GCancellable       *cancellable)
4140 {
4141   GError *error = NULL;
4142   EnumerateChildrenAsyncData *data;
4143   GFileEnumerator *enumerator;
4144
4145   data = g_simple_async_result_get_op_res_gpointer (res);
4146
4147   enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4148
4149   if (enumerator == NULL)
4150     {
4151       g_simple_async_result_set_from_error (res, error);
4152       g_error_free (error);
4153     }
4154   else
4155     data->enumerator = enumerator;
4156 }
4157
4158 static void
4159 g_file_real_enumerate_children_async (GFile               *file,
4160                                       const char          *attributes,
4161                                       GFileQueryInfoFlags  flags,
4162                                       int                  io_priority,
4163                                       GCancellable        *cancellable,
4164                                       GAsyncReadyCallback  callback,
4165                                       gpointer             user_data)
4166 {
4167   GSimpleAsyncResult *res;
4168   EnumerateChildrenAsyncData *data;
4169
4170   data = g_new0 (EnumerateChildrenAsyncData, 1);
4171   data->attributes = g_strdup (attributes);
4172   data->flags = flags;
4173
4174   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
4175   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
4176
4177   g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
4178   g_object_unref (res);
4179 }
4180
4181 static GFileEnumerator *
4182 g_file_real_enumerate_children_finish (GFile         *file,
4183                                        GAsyncResult  *res,
4184                                        GError       **error)
4185 {
4186   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4187   EnumerateChildrenAsyncData *data;
4188
4189   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
4190
4191   data = g_simple_async_result_get_op_res_gpointer (simple);
4192   if (data->enumerator)
4193     return g_object_ref (data->enumerator);
4194
4195   return NULL;
4196 }
4197
4198 static void
4199 open_read_async_thread (GSimpleAsyncResult *res,
4200                         GObject            *object,
4201                         GCancellable       *cancellable)
4202 {
4203   GFileIface *iface;
4204   GFileInputStream *stream;
4205   GError *error = NULL;
4206
4207   iface = G_FILE_GET_IFACE (object);
4208
4209   if (iface->read_fn == NULL)
4210     {
4211       g_set_error_literal (&error, G_IO_ERROR,
4212                            G_IO_ERROR_NOT_SUPPORTED,
4213                            _("Operation not supported"));
4214
4215       g_simple_async_result_set_from_error (res, error);
4216       g_error_free (error);
4217
4218       return;
4219     }
4220
4221   stream = iface->read_fn (G_FILE (object), cancellable, &error);
4222
4223   if (stream == NULL)
4224     {
4225       g_simple_async_result_set_from_error (res, error);
4226       g_error_free (error);
4227     }
4228   else
4229     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
4230 }
4231
4232 static void
4233 g_file_real_read_async (GFile               *file,
4234                         int                  io_priority,
4235                         GCancellable        *cancellable,
4236                         GAsyncReadyCallback  callback,
4237                         gpointer             user_data)
4238 {
4239   GSimpleAsyncResult *res;
4240
4241   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
4242
4243   g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
4244   g_object_unref (res);
4245 }
4246
4247 static GFileInputStream *
4248 g_file_real_read_finish (GFile         *file,
4249                          GAsyncResult  *res,
4250                          GError       **error)
4251 {
4252   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4253   gpointer op;
4254
4255   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
4256
4257   op = g_simple_async_result_get_op_res_gpointer (simple);
4258   if (op)
4259     return g_object_ref (op);
4260
4261   return NULL;
4262 }
4263
4264 static void
4265 append_to_async_thread (GSimpleAsyncResult *res,
4266                         GObject            *object,
4267                         GCancellable       *cancellable)
4268 {
4269   GFileIface *iface;
4270   GFileCreateFlags *data;
4271   GFileOutputStream *stream;
4272   GError *error = NULL;
4273
4274   iface = G_FILE_GET_IFACE (object);
4275
4276   data = g_simple_async_result_get_op_res_gpointer (res);
4277
4278   stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
4279
4280   if (stream == NULL)
4281     {
4282       g_simple_async_result_set_from_error (res, error);
4283       g_error_free (error);
4284     }
4285   else
4286     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
4287 }
4288
4289 static void
4290 g_file_real_append_to_async (GFile               *file,
4291                              GFileCreateFlags     flags,
4292                              int                  io_priority,
4293                              GCancellable        *cancellable,
4294                              GAsyncReadyCallback  callback,
4295                              gpointer             user_data)
4296 {
4297   GFileCreateFlags *data;
4298   GSimpleAsyncResult *res;
4299
4300   data = g_new0 (GFileCreateFlags, 1);
4301   *data = flags;
4302
4303   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
4304   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
4305
4306   g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
4307   g_object_unref (res);
4308 }
4309
4310 static GFileOutputStream *
4311 g_file_real_append_to_finish (GFile         *file,
4312                               GAsyncResult  *res,
4313                               GError       **error)
4314 {
4315   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4316   gpointer op;
4317
4318   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
4319
4320   op = g_simple_async_result_get_op_res_gpointer (simple);
4321   if (op)
4322     return g_object_ref (op);
4323
4324   return NULL;
4325 }
4326
4327 static void
4328 create_async_thread (GSimpleAsyncResult *res,
4329                      GObject            *object,
4330                      GCancellable       *cancellable)
4331 {
4332   GFileIface *iface;
4333   GFileCreateFlags *data;
4334   GFileOutputStream *stream;
4335   GError *error = NULL;
4336
4337   iface = G_FILE_GET_IFACE (object);
4338
4339   data = g_simple_async_result_get_op_res_gpointer (res);
4340
4341   stream = iface->create (G_FILE (object), *data, cancellable, &error);
4342
4343   if (stream == NULL)
4344     {
4345       g_simple_async_result_set_from_error (res, error);
4346       g_error_free (error);
4347     }
4348   else
4349     g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
4350 }
4351
4352 static void
4353 g_file_real_create_async (GFile               *file,
4354                           GFileCreateFlags     flags,
4355                           int                  io_priority,
4356                           GCancellable        *cancellable,
4357                           GAsyncReadyCallback  callback,
4358                           gpointer             user_data)
4359 {
4360   GFileCreateFlags *data;
4361   GSimpleAsyncResult *res;
4362
4363   data = g_new0 (GFileCreateFlags, 1);
4364   *data = flags;
4365
4366   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
4367   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
4368
4369   g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
4370   g_object_unref (res);
4371 }
4372
4373 static GFileOutputStream *
4374 g_file_real_create_finish (GFile         *file,
4375                            GAsyncResult  *res,
4376                            GError       **error)
4377 {
4378   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4379   gpointer op;
4380
4381   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
4382
4383   op = g_simple_async_result_get_op_res_gpointer (simple);
4384   if (op)
4385     return g_object_ref (op);
4386
4387   return NULL;
4388 }
4389
4390 typedef struct {
4391   GFileOutputStream *stream;
4392   char *etag;
4393   gboolean make_backup;
4394   GFileCreateFlags flags;
4395 } ReplaceAsyncData;
4396
4397 static void
4398 replace_async_data_free (ReplaceAsyncData *data)
4399 {
4400   if (data->stream)
4401     g_object_unref (data->stream);
4402   g_free (data->etag);
4403   g_free (data);
4404 }
4405
4406 static void
4407 replace_async_thread (GSimpleAsyncResult *res,
4408                       GObject            *object,
4409                       GCancellable       *cancellable)
4410 {
4411   GFileIface *iface;
4412   GFileOutputStream *stream;
4413   GError *error = NULL;
4414   ReplaceAsyncData *data;
4415
4416   iface = G_FILE_GET_IFACE (object);
4417
4418   data = g_simple_async_result_get_op_res_gpointer (res);
4419
4420   stream = iface->replace (G_FILE (object),
4421                            data->etag,
4422                            data->make_backup,
4423                            data->flags,
4424                            cancellable,
4425                            &error);
4426
4427   if (stream == NULL)
4428     {
4429       g_simple_async_result_set_from_error (res, error);
4430       g_error_free (error);
4431     }
4432   else
4433     data->stream = stream;
4434 }
4435
4436 static void
4437 g_file_real_replace_async (GFile               *file,
4438                            const char          *etag,
4439                            gboolean             make_backup,
4440                            GFileCreateFlags     flags,
4441                            int                  io_priority,
4442                            GCancellable        *cancellable,
4443                            GAsyncReadyCallback  callback,
4444                            gpointer             user_data)
4445 {
4446   GSimpleAsyncResult *res;
4447   ReplaceAsyncData *data;
4448
4449   data = g_new0 (ReplaceAsyncData, 1);
4450   data->etag = g_strdup (etag);
4451   data->make_backup = make_backup;
4452   data->flags = flags;
4453
4454   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
4455   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
4456
4457   g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
4458   g_object_unref (res);
4459 }
4460
4461 static GFileOutputStream *
4462 g_file_real_replace_finish (GFile         *file,
4463                             GAsyncResult  *res,
4464                             GError       **error)
4465 {
4466   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4467   ReplaceAsyncData *data;
4468
4469   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
4470
4471   data = g_simple_async_result_get_op_res_gpointer (simple);
4472   if (data->stream)
4473     return g_object_ref (data->stream);
4474
4475   return NULL;
4476 }
4477
4478 typedef struct {
4479   char *name;
4480   GFile *file;
4481 } SetDisplayNameAsyncData;
4482
4483 static void
4484 set_display_name_data_free (SetDisplayNameAsyncData *data)
4485 {
4486   g_free (data->name);
4487   if (data->file)
4488     g_object_unref (data->file);
4489   g_free (data);
4490 }
4491
4492 static void
4493 set_display_name_async_thread (GSimpleAsyncResult *res,
4494                                GObject            *object,
4495                                GCancellable       *cancellable)
4496 {
4497   GError *error = NULL;
4498   SetDisplayNameAsyncData *data;
4499   GFile *file;
4500
4501   data = g_simple_async_result_get_op_res_gpointer (res);
4502
4503   file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
4504
4505   if (file == NULL)
4506     {
4507       g_simple_async_result_set_from_error (res, error);
4508       g_error_free (error);
4509     }
4510   else
4511     data->file = file;
4512 }
4513
4514 static void
4515 g_file_real_set_display_name_async (GFile               *file,
4516                                     const char          *display_name,
4517                                     int                  io_priority,
4518                                     GCancellable        *cancellable,
4519                                     GAsyncReadyCallback  callback,
4520                                     gpointer             user_data)
4521 {
4522   GSimpleAsyncResult *res;
4523   SetDisplayNameAsyncData *data;
4524
4525   data = g_new0 (SetDisplayNameAsyncData, 1);
4526   data->name = g_strdup (display_name);
4527
4528   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
4529   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
4530
4531   g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
4532   g_object_unref (res);
4533 }
4534
4535 static GFile *
4536 g_file_real_set_display_name_finish (GFile         *file,
4537                                      GAsyncResult  *res,
4538                                      GError       **error)
4539 {
4540   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4541   SetDisplayNameAsyncData *data;
4542
4543   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
4544
4545   data = g_simple_async_result_get_op_res_gpointer (simple);
4546   if (data->file)
4547     return g_object_ref (data->file);
4548
4549   return NULL;
4550 }
4551
4552 typedef struct {
4553   GFileQueryInfoFlags flags;
4554   GFileInfo *info;
4555   gboolean res;
4556   GError *error;
4557 } SetInfoAsyncData;
4558
4559 static void
4560 set_info_data_free (SetInfoAsyncData *data)
4561 {
4562   if (data->info)
4563     g_object_unref (data->info);
4564   if (data->error)
4565     g_error_free (data->error);
4566   g_free (data);
4567 }
4568
4569 static void
4570 set_info_async_thread (GSimpleAsyncResult *res,
4571                        GObject            *object,
4572                        GCancellable       *cancellable)
4573 {
4574   SetInfoAsyncData *data;
4575
4576   data = g_simple_async_result_get_op_res_gpointer (res);
4577
4578   data->error = NULL;
4579   data->res = g_file_set_attributes_from_info (G_FILE (object),
4580                                                data->info,
4581                                                data->flags,
4582                                                cancellable,
4583                                                &data->error);
4584 }
4585
4586 static void
4587 g_file_real_set_attributes_async (GFile               *file,
4588                                   GFileInfo           *info,
4589                                   GFileQueryInfoFlags  flags,
4590                                   int                  io_priority,
4591                                   GCancellable        *cancellable,
4592                                   GAsyncReadyCallback  callback,
4593                                   gpointer             user_data)
4594 {
4595   GSimpleAsyncResult *res;
4596   SetInfoAsyncData *data;
4597
4598   data = g_new0 (SetInfoAsyncData, 1);
4599   data->info = g_file_info_dup (info);
4600   data->flags = flags;
4601
4602   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
4603   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
4604
4605   g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
4606   g_object_unref (res);
4607 }
4608
4609 static gboolean
4610 g_file_real_set_attributes_finish (GFile         *file,
4611                                    GAsyncResult  *res,
4612                                    GFileInfo    **info,
4613                                    GError       **error)
4614 {
4615   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4616   SetInfoAsyncData *data;
4617
4618   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
4619
4620   data = g_simple_async_result_get_op_res_gpointer (simple);
4621
4622   if (info)
4623     *info = g_object_ref (data->info);
4624
4625   if (error != NULL && data->error)
4626     *error = g_error_copy (data->error);
4627
4628   return data->res;
4629 }
4630
4631 static void
4632 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
4633                                     GObject            *object,
4634                                     GCancellable       *cancellable)
4635 {
4636   GError *error = NULL;
4637   GMount *mount;
4638
4639   mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
4640
4641   if (mount == NULL)
4642     {
4643       g_simple_async_result_set_from_error (res, error);
4644       g_error_free (error);
4645     }
4646   else
4647     g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
4648 }
4649
4650 static void
4651 g_file_real_find_enclosing_mount_async (GFile               *file,
4652                                         int                  io_priority,
4653                                         GCancellable        *cancellable,
4654                                         GAsyncReadyCallback  callback,
4655                                         gpointer             user_data)
4656 {
4657   GSimpleAsyncResult *res;
4658
4659   res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
4660
4661   g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
4662   g_object_unref (res);
4663 }
4664
4665 static GMount *
4666 g_file_real_find_enclosing_mount_finish (GFile         *file,
4667                                           GAsyncResult  *res,
4668                                           GError       **error)
4669 {
4670   GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4671   GMount *mount;
4672
4673   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
4674
4675   mount = g_simple_async_result_get_op_res_gpointer (simple);
4676   return g_object_ref (mount);
4677 }
4678
4679
4680 typedef struct {
4681   GFile *source;
4682   GFile *destination;
4683   GFileCopyFlags flags;
4684   GFileProgressCallback progress_cb;
4685   gpointer progress_cb_data;
4686   GIOSchedulerJob *job;
4687 } CopyAsyncData;
4688
4689 static void
4690 copy_async_data_free (CopyAsyncData *data)
4691 {
4692   g_object_unref (data->source);
4693   g_object_unref (data->destination);
4694   g_free (data);
4695 }
4696
4697 typedef struct {
4698   CopyAsyncData *data;
4699   goffset current_num_bytes;
4700   goffset total_num_bytes;
4701 } ProgressData;
4702
4703 static gboolean
4704 copy_async_progress_in_main (gpointer user_data)
4705 {
4706   ProgressData *progress = user_data;
4707   CopyAsyncData *data = progress->data;
4708
4709   data->progress_cb (progress->current_num_bytes,
4710                      progress->total_num_bytes,
4711                      data->progress_cb_data);
4712
4713   return FALSE;
4714 }
4715
4716 static gboolean
4717 mainloop_barrier (gpointer user_data)
4718 {
4719   /* Does nothing, but ensures all queued idles before
4720      this are run */
4721   return FALSE;
4722 }
4723
4724
4725 static void
4726 copy_async_progress_callback (goffset  current_num_bytes,
4727                               goffset  total_num_bytes,
4728                               gpointer user_data)
4729 {
4730   CopyAsyncData *data = user_data;
4731   ProgressData *progress;
4732
4733   progress = g_new (ProgressData, 1);
4734   progress->data = data;
4735   progress->current_num_bytes = current_num_bytes;
4736   progress->total_num_bytes = total_num_bytes;
4737
4738   g_io_scheduler_job_send_to_mainloop_async (data->job,
4739                                              copy_async_progress_in_main,
4740                                              progress,
4741                                              g_free);
4742 }
4743
4744 static gboolean
4745 copy_async_thread (GIOSchedulerJob *job,
4746                    GCancellable    *cancellable,
4747                    gpointer         user_data)
4748 {
4749   GSimpleAsyncResult *res;
4750   CopyAsyncData *data;
4751   gboolean result;
4752   GError *error;
4753
4754   res = user_data;
4755   data = g_simple_async_result_get_op_res_gpointer (res);
4756
4757   error = NULL;
4758   data->job = job;
4759   result = g_file_copy (data->source,
4760                         data->destination,
4761                         data->flags,
4762                         cancellable,
4763                         (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
4764                         data,
4765                         &error);
4766
4767   /* Ensure all progress callbacks are done running in main thread */
4768   if (data->progress_cb != NULL)
4769     g_io_scheduler_job_send_to_mainloop (job,
4770                                          mainloop_barrier,
4771                                          NULL, NULL);
4772
4773   if (!result)
4774     {
4775       g_simple_async_result_set_from_error (res, error);
4776       g_error_free (error);
4777     }
4778
4779   g_simple_async_result_complete_in_idle (res);
4780
4781   return FALSE;
4782 }
4783
4784 static void
4785 g_file_real_copy_async (GFile                  *source,
4786                         GFile                  *destination,
4787                         GFileCopyFlags          flags,
4788                         int                     io_priority,
4789                         GCancellable           *cancellable,
4790                         GFileProgressCallback   progress_callback,
4791                         gpointer                progress_callback_data,
4792                         GAsyncReadyCallback     callback,
4793                         gpointer                user_data)
4794 {
4795   GSimpleAsyncResult *res;
4796   CopyAsyncData *data;
4797
4798   data = g_new0 (CopyAsyncData, 1);
4799   data->source = g_object_ref (source);
4800   data->destination = g_object_ref (destination);
4801   data->flags = flags;
4802   data->progress_cb = progress_callback;
4803   data->progress_cb_data = progress_callback_data;
4804
4805   res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
4806   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
4807
4808   g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
4809 }
4810
4811 static gboolean
4812 g_file_real_copy_finish (GFile        *file,
4813                          GAsyncResult *res,
4814                          GError      **error)
4815 {
4816   /* Error handled in g_file_copy_finish() */
4817   return TRUE;
4818 }
4819
4820
4821 /********************************************
4822  *   Default VFS operations                 *
4823  ********************************************/
4824
4825 /**
4826  * g_file_new_for_path:
4827  * @path: a string containing a relative or absolute path.
4828  *
4829  * Constructs a #GFile for a given path. This operation never
4830  * fails, but the returned object might not support any I/O
4831  * operation if @path is malformed.
4832  *
4833  * Returns: a new #GFile for the given @path.
4834  **/
4835 GFile *
4836 g_file_new_for_path (const char *path)
4837 {
4838   g_return_val_if_fail (path != NULL, NULL);
4839
4840   return g_vfs_get_file_for_path (g_vfs_get_default (), path);
4841 }
4842
4843 /**
4844  * g_file_new_for_uri:
4845  * @uri: a string containing a URI.
4846  *
4847  * Constructs a #GFile for a given URI. This operation never
4848  * fails, but the returned object might not support any I/O
4849  * operation if @uri is malformed or if the uri type is
4850  * not supported.
4851  *
4852  * Returns: a #GFile for the given @uri.
4853  **/
4854 GFile *
4855 g_file_new_for_uri (const char *uri)
4856 {
4857   g_return_val_if_fail (uri != NULL, NULL);
4858
4859   return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
4860 }
4861
4862 /**
4863  * g_file_parse_name:
4864  * @parse_name: a file name or path to be parsed.
4865  *
4866  * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
4867  * This operation never fails, but the returned object might not support any I/O
4868  * operation if the @parse_name cannot be parsed.
4869  *
4870  * Returns: a new #GFile.
4871  **/
4872 GFile *
4873 g_file_parse_name (const char *parse_name)
4874 {
4875   g_return_val_if_fail (parse_name != NULL, NULL);
4876
4877   return g_vfs_parse_name (g_vfs_get_default (), parse_name);
4878 }
4879
4880 static gboolean
4881 is_valid_scheme_character (char c)
4882 {
4883   return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
4884 }
4885
4886 /* Following RFC 2396, valid schemes are built like:
4887  *       scheme        = alpha *( alpha | digit | "+" | "-" | "." )
4888  */
4889 static gboolean
4890 has_valid_scheme (const char *uri)
4891 {
4892   const char *p;
4893
4894   p = uri;
4895
4896   if (!g_ascii_isalpha (*p))
4897     return FALSE;
4898
4899   do {
4900     p++;
4901   } while (is_valid_scheme_character (*p));
4902
4903   return *p == ':';
4904 }
4905
4906 /**
4907  * g_file_new_for_commandline_arg:
4908  * @arg: a command line string.
4909  *
4910  * Creates a #GFile with the given argument from the command line. The value of
4911  * @arg can be either a URI, an absolute path or a relative path resolved
4912  * relative to the current working directory.
4913  * This operation never fails, but the returned object might not support any
4914  * I/O operation if @arg points to a malformed path.
4915  *
4916  * Returns: a new #GFile.
4917  **/
4918 GFile *
4919 g_file_new_for_commandline_arg (const char *arg)
4920 {
4921   GFile *file;
4922   char *filename;
4923   char *current_dir;
4924
4925   g_return_val_if_fail (arg != NULL, NULL);
4926
4927   if (g_path_is_absolute (arg))
4928     return g_file_new_for_path (arg);
4929
4930   if (has_valid_scheme (arg))
4931     return g_file_new_for_uri (arg);
4932
4933   current_dir = g_get_current_dir ();
4934   filename = g_build_filename (current_dir, arg, NULL);
4935   g_free (current_dir);
4936
4937   file = g_file_new_for_path (filename);
4938   g_free (filename);
4939
4940   return file;
4941 }
4942
4943 /**
4944  * g_file_mount_enclosing_volume:
4945  * @location: input #GFile.
4946  * @flags: flags affecting the operation
4947  * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
4948  * @cancellable: optional #GCancellable object, %NULL to ignore.
4949  * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4950  * @user_data: the data to pass to callback function
4951  *
4952  * Starts a @mount_operation, mounting the volume that contains the file @location.
4953  *
4954  * When this operation has completed, @callback will be called with
4955  * @user_user data, and the operation can be finalized with
4956  * g_file_mount_enclosing_volume_finish().
4957  *
4958  * If @cancellable is not %NULL, then the operation can be cancelled by
4959  * triggering the cancellable object from another thread. If the operation
4960  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4961  **/
4962 void
4963 g_file_mount_enclosing_volume (GFile               *location,
4964                                GMountMountFlags     flags,
4965                                GMountOperation     *mount_operation,
4966                                GCancellable        *cancellable,
4967                                GAsyncReadyCallback  callback,
4968                                gpointer             user_data)
4969 {
4970   GFileIface *iface;
4971
4972   g_return_if_fail (G_IS_FILE (location));
4973
4974   iface = G_FILE_GET_IFACE (location);
4975
4976   if (iface->mount_enclosing_volume == NULL)
4977     {
4978       g_simple_async_report_error_in_idle (G_OBJECT (location),
4979                                            callback, user_data,
4980                                            G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4981                                            _("volume doesn't implement mount"));
4982
4983       return;
4984     }
4985
4986   (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
4987
4988 }
4989
4990 /**
4991  * g_file_mount_enclosing_volume_finish:
4992  * @location: input #GFile.
4993  * @result: a #GAsyncResult.
4994  * @error: a #GError, or %NULL
4995  *
4996  * Finishes a mount operation started by g_file_mount_enclosing_volume().
4997  *
4998  * Returns: %TRUE if successful. If an error
4999  * has occurred, this function will return %FALSE and set @error
5000  * appropriately if present.
5001  **/
5002 gboolean
5003 g_file_mount_enclosing_volume_finish (GFile         *location,
5004                                       GAsyncResult  *result,
5005                                       GError       **error)
5006 {
5007   GFileIface *iface;
5008
5009   g_return_val_if_fail (G_IS_FILE (location), FALSE);
5010   g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
5011
5012   if (G_IS_SIMPLE_ASYNC_RESULT (result))
5013     {
5014       GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
5015       if (g_simple_async_result_propagate_error (simple, error))
5016         return FALSE;
5017     }
5018
5019   iface = G_FILE_GET_IFACE (location);
5020
5021   return (* iface->mount_enclosing_volume_finish) (location, result, error);
5022 }
5023
5024 /********************************************
5025  *   Utility functions                      *
5026  ********************************************/
5027
5028 /**
5029  * g_file_query_default_handler:
5030  * @file: a #GFile to open.
5031  * @cancellable: optional #GCancellable object, %NULL to ignore.
5032  * @error: a #GError, or %NULL
5033  *
5034  * Returns the #GAppInfo that is registered as the default
5035  * application to handle the file specified by @file.
5036  *
5037  * If @cancellable is not %NULL, then the operation can be cancelled by
5038  * triggering the cancellable object from another thread. If the operation
5039  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5040  *
5041  * Returns: a #GAppInfo if the handle was found, %NULL if there were errors.
5042  * When you are done with it, release it with g_object_unref()
5043  **/
5044 GAppInfo *
5045 g_file_query_default_handler (GFile                  *file,
5046                               GCancellable           *cancellable,
5047                               GError                **error)
5048 {
5049   char *uri_scheme;
5050   const char *content_type;
5051   GAppInfo *appinfo;
5052   GFileInfo *info;
5053   char *path;
5054
5055   uri_scheme = g_file_get_uri_scheme (file);
5056   appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
5057   g_free (uri_scheme);
5058
5059   if (appinfo != NULL)
5060     return appinfo;
5061
5062   info = g_file_query_info (file,
5063                             G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
5064                             0,
5065                             cancellable,
5066                             error);
5067   if (info == NULL)
5068     return NULL;
5069
5070   appinfo = NULL;
5071
5072   content_type = g_file_info_get_content_type (info);
5073   if (content_type)
5074     {
5075       /* Don't use is_native(), as we want to support fuse paths if availible */
5076       path = g_file_get_path (file);
5077       appinfo = g_app_info_get_default_for_type (content_type,
5078                                                  path == NULL);
5079       g_free (path);
5080     }
5081
5082   g_object_unref (info);
5083
5084   if (appinfo != NULL)
5085     return appinfo;
5086
5087   g_set_error_literal (error, G_IO_ERROR,
5088                        G_IO_ERROR_NOT_SUPPORTED,
5089                        _("No application is registered as handling this file"));
5090   return NULL;
5091
5092 }
5093
5094
5095 #define GET_CONTENT_BLOCK_SIZE 8192
5096
5097 /**
5098  * g_file_load_contents:
5099  * @file: input #GFile.
5100  * @cancellable: optional #GCancellable object, %NULL to ignore.
5101  * @contents: a location to place the contents of the file.
5102  * @length: a location to place the length of the contents of the file,
5103  *    or %NULL if the length is not needed
5104  * @etag_out: a location to place the current entity tag for the file,
5105  *    or %NULL if the entity tag is not needed
5106  * @error: a #GError, or %NULL
5107  *
5108  * Loads the content of the file into memory. The data is always
5109  * zero-terminated, but this is not included in the resultant @length.
5110  * The returned @content should be freed with g_free() when no longer
5111  * needed.
5112  *
5113  * If @cancellable is not %NULL, then the operation can be cancelled by
5114  * triggering the cancellable object from another thread. If the operation
5115  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5116  *
5117  * Returns: %TRUE if the @file's contents were successfully loaded.
5118  * %FALSE if there were errors.
5119  **/
5120 gboolean
5121 g_file_load_contents (GFile         *file,
5122                       GCancellable  *cancellable,
5123                       char         **contents,
5124                       gsize         *length,
5125                       char         **etag_out,
5126                       GError       **error)
5127 {
5128   GFileInputStream *in;
5129   GByteArray *content;
5130   gsize pos;
5131   gssize res;
5132   GFileInfo *info;
5133
5134   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5135   g_return_val_if_fail (contents != NULL, FALSE);
5136
5137   in = g_file_read (file, cancellable, error);
5138   if (in == NULL)
5139     return FALSE;
5140
5141   content = g_byte_array_new ();
5142   pos = 0;
5143
5144   g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
5145   while ((res = g_input_stream_read (G_INPUT_STREAM (in),
5146                                      content->data + pos,
5147                                      GET_CONTENT_BLOCK_SIZE,
5148                                      cancellable, error)) > 0)
5149     {
5150       pos += res;
5151       g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
5152     }
5153
5154   if (etag_out)
5155     {
5156       *etag_out = NULL;
5157
5158       info = g_file_input_stream_query_info (in,
5159                                              G_FILE_ATTRIBUTE_ETAG_VALUE,
5160                                              cancellable,
5161                                              NULL);
5162       if (info)
5163         {
5164           *etag_out = g_strdup (g_file_info_get_etag (info));
5165           g_object_unref (info);
5166         }
5167     }
5168
5169   /* Ignore errors on close */
5170   g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
5171   g_object_unref (in);
5172
5173   if (res < 0)
5174     {
5175       /* error is set already */
5176       g_byte_array_free (content, TRUE);
5177       return FALSE;
5178     }
5179
5180   if (length)
5181     *length = pos;
5182
5183   /* Zero terminate (we got an extra byte allocated for this */
5184   content->data[pos] = 0;
5185
5186   *contents = (char *)g_byte_array_free (content, FALSE);
5187
5188   return TRUE;
5189 }
5190
5191 typedef struct {
5192   GFile *file;
5193   GError *error;
5194   GCancellable *cancellable;
5195   GFileReadMoreCallback read_more_callback;
5196   GAsyncReadyCallback callback;
5197   gpointer user_data;
5198   GByteArray *content;
5199   gsize pos;
5200   char *etag;
5201 } LoadContentsData;
5202
5203
5204 static void
5205 load_contents_data_free (LoadContentsData *data)
5206 {
5207   if (data->error)
5208     g_error_free (data->error);
5209   if (data->cancellable)
5210     g_object_unref (data->cancellable);
5211   if (data->content)
5212     g_byte_array_free (data->content, TRUE);
5213   g_free (data->etag);
5214   g_object_unref (data->file);
5215   g_free (data);
5216 }
5217
5218 static void
5219 load_contents_close_callback (GObject      *obj,
5220                               GAsyncResult *close_res,
5221                               gpointer      user_data)
5222 {
5223   GInputStream *stream = G_INPUT_STREAM (obj);
5224   LoadContentsData *data = user_data;
5225   GSimpleAsyncResult *res;
5226
5227   /* Ignore errors here, we're only reading anyway */
5228   g_input_stream_close_finish (stream, close_res, NULL);
5229   g_object_unref (stream);
5230
5231   res = g_simple_async_result_new (G_OBJECT (data->file),
5232                                    data->callback,
5233                                    data->user_data,
5234                                    g_file_load_contents_async);
5235   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
5236   g_simple_async_result_complete (res);
5237   g_object_unref (res);
5238 }
5239
5240 static void
5241 load_contents_fstat_callback (GObject      *obj,
5242                               GAsyncResult *stat_res,
5243                               gpointer      user_data)
5244 {
5245   GInputStream *stream = G_INPUT_STREAM (obj);
5246   LoadContentsData *data = user_data;
5247   GFileInfo *info;
5248
5249   info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
5250                                                    stat_res, NULL);
5251   if (info)
5252     {
5253       data->etag = g_strdup (g_file_info_get_etag (info));
5254       g_object_unref (info);
5255     }
5256
5257   g_input_stream_close_async (stream, 0,
5258                               data->cancellable,
5259                               load_contents_close_callback, data);
5260 }
5261
5262 static void
5263 load_contents_read_callback (GObject      *obj,
5264                              GAsyncResult *read_res,
5265                              gpointer      user_data)
5266 {
5267   GInputStream *stream = G_INPUT_STREAM (obj);
5268   LoadContentsData *data = user_data;
5269   GError *error = NULL;
5270   gssize read_size;
5271
5272   read_size = g_input_stream_read_finish (stream, read_res, &error);
5273
5274   if (read_size < 0)
5275     {
5276       /* Error or EOF, close the file */
5277       data->error = error;
5278       g_input_stream_close_async (stream, 0,
5279                                   data->cancellable,
5280                                   load_contents_close_callback, data);
5281     }
5282   else if (read_size == 0)
5283     {
5284       g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
5285                                             G_FILE_ATTRIBUTE_ETAG_VALUE,
5286                                             0,
5287                                             data->cancellable,
5288                                             load_contents_fstat_callback,
5289                                             data);
5290     }
5291   else if (read_size > 0)
5292     {
5293       data->pos += read_size;
5294
5295       g_byte_array_set_size (data->content,
5296                              data->pos + GET_CONTENT_BLOCK_SIZE);
5297
5298
5299       if (data->read_more_callback &&
5300           !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
5301         g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
5302                                               G_FILE_ATTRIBUTE_ETAG_VALUE,
5303                                               0,
5304                                               data->cancellable,
5305                                               load_contents_fstat_callback,
5306                                               data);
5307       else
5308         g_input_stream_read_async (stream,
5309                                    data->content->data + data->pos,
5310                                    GET_CONTENT_BLOCK_SIZE,
5311                                    0,
5312                                    data->cancellable,
5313                                    load_contents_read_callback,
5314                                    data);
5315     }
5316 }
5317
5318 static void
5319 load_contents_open_callback (GObject      *obj,
5320                              GAsyncResult *open_res,
5321                              gpointer      user_data)
5322 {
5323   GFile *file = G_FILE (obj);
5324   GFileInputStream *stream;
5325   LoadContentsData *data = user_data;
5326   GError *error = NULL;
5327   GSimpleAsyncResult *res;
5328
5329   stream = g_file_read_finish (file, open_res, &error);
5330
5331   if (stream)
5332     {
5333       g_byte_array_set_size (data->content,
5334                              data->pos + GET_CONTENT_BLOCK_SIZE);
5335       g_input_stream_read_async (G_INPUT_STREAM (stream),
5336                                  data->content->data + data->pos,
5337                                  GET_CONTENT_BLOCK_SIZE,
5338                                  0,
5339                                  data->cancellable,
5340                                  load_contents_read_callback,
5341                                  data);
5342
5343     }
5344   else
5345     {
5346       res = g_simple_async_result_new_from_error (G_OBJECT (data->file),
5347                                                   data->callback,
5348                                                   data->user_data,
5349                                                   error);
5350       g_simple_async_result_complete (res);
5351       g_error_free (error);
5352       load_contents_data_free (data);
5353       g_object_unref (res);
5354     }
5355 }
5356
5357 /**
5358  * g_file_load_partial_contents_async:
5359  * @file: input #GFile.
5360  * @cancellable: optional #GCancellable object, %NULL to ignore.
5361  * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
5362  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5363  * @user_data: the data to pass to the callback functions.
5364  *
5365  * Reads the partial contents of a file. A #GFileReadMoreCallback should be
5366  * used to stop reading from the file when appropriate, else this function
5367  * will behave exactly as g_file_load_contents_async(). This operation
5368  * can be finished by g_file_load_partial_contents_finish().
5369  *
5370  * Users of this function should be aware that @user_data is passed to
5371  * both the @read_more_callback and the @callback.
5372  *
5373  * If @cancellable is not %NULL, then the operation can be cancelled by
5374  * triggering the cancellable object from another thread. If the operation
5375  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5376  **/
5377 void
5378 g_file_load_partial_contents_async (GFile                 *file,
5379                                     GCancellable          *cancellable,
5380                                     GFileReadMoreCallback  read_more_callback,
5381                                     GAsyncReadyCallback    callback,
5382                                     gpointer               user_data)
5383 {
5384   LoadContentsData *data;
5385
5386   g_return_if_fail (G_IS_FILE (file));
5387
5388   data = g_new0 (LoadContentsData, 1);
5389
5390   if (cancellable)
5391     data->cancellable = g_object_ref (cancellable);
5392   data->read_more_callback = read_more_callback;
5393   data->callback = callback;
5394   data->user_data = user_data;
5395   data->content = g_byte_array_new ();
5396   data->file = g_object_ref (file);
5397
5398   g_file_read_async (file,
5399                      0,
5400                      cancellable,
5401                      load_contents_open_callback,
5402                      data);
5403 }
5404
5405 /**
5406  * g_file_load_partial_contents_finish:
5407  * @file: input #GFile.
5408  * @res: a #GAsyncResult.
5409  * @contents: a location to place the contents of the file.
5410  * @length: a location to place the length of the contents of the file,
5411  *     or %NULL if the length is not needed
5412  * @etag_out: a location to place the current entity tag for the file,
5413  *     or %NULL if the entity tag is not needed
5414  * @error: a #GError, or %NULL
5415  *
5416  * Finishes an asynchronous partial load operation that was started
5417  * with g_file_load_partial_contents_async(). The data is always
5418  * zero-terminated, but this is not included in the resultant @length.
5419  * The returned @content should be freed with g_free() when no longer
5420  * needed.
5421  *
5422  * Returns: %TRUE if the load was successful. If %FALSE and @error is
5423  * present, it will be set appropriately.
5424  **/
5425 gboolean
5426 g_file_load_partial_contents_finish (GFile         *file,
5427                                      GAsyncResult  *res,
5428                                      char         **contents,
5429                                      gsize         *length,
5430                                      char         **etag_out,
5431                                      GError       **error)
5432 {
5433   GSimpleAsyncResult *simple;
5434   LoadContentsData *data;
5435
5436   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5437   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
5438   g_return_val_if_fail (contents != NULL, FALSE);
5439
5440   simple = G_SIMPLE_ASYNC_RESULT (res);
5441
5442   if (g_simple_async_result_propagate_error (simple, error))
5443     return FALSE;
5444
5445   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
5446
5447   data = g_simple_async_result_get_op_res_gpointer (simple);
5448
5449   if (data->error)
5450     {
5451       g_propagate_error (error, data->error);
5452       data->error = NULL;
5453       *contents = NULL;
5454       if (length)
5455         *length = 0;
5456       return FALSE;
5457     }
5458
5459   if (length)
5460     *length = data->pos;
5461
5462   if (etag_out)
5463     {
5464       *etag_out = data->etag;
5465       data->etag = NULL;
5466     }
5467
5468   /* Zero terminate */
5469   g_byte_array_set_size (data->content, data->pos + 1);
5470   data->content->data[data->pos] = 0;
5471
5472   *contents = (char *)g_byte_array_free (data->content, FALSE);
5473   data->content = NULL;
5474
5475   return TRUE;
5476 }
5477
5478 /**
5479  * g_file_load_contents_async:
5480  * @file: input #GFile.
5481  * @cancellable: optional #GCancellable object, %NULL to ignore.
5482  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5483  * @user_data: the data to pass to callback function
5484  *
5485  * Starts an asynchronous load of the @file's contents.
5486  *
5487  * For more details, see g_file_load_contents() which is
5488  * the synchronous version of this call.
5489  *
5490  * When the load operation has completed, @callback will be called
5491  * with @user data. To finish the operation, call
5492  * g_file_load_contents_finish() with the #GAsyncResult returned by
5493  * the @callback.
5494  *
5495  * If @cancellable is not %NULL, then the operation can be cancelled by
5496  * triggering the cancellable object from another thread. If the operation
5497  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5498  **/
5499 void
5500 g_file_load_contents_async (GFile               *file,
5501                            GCancellable        *cancellable,
5502                            GAsyncReadyCallback  callback,
5503                            gpointer             user_data)
5504 {
5505   g_file_load_partial_contents_async (file,
5506                                       cancellable,
5507                                       NULL,
5508                                       callback, user_data);
5509 }
5510
5511 /**
5512  * g_file_load_contents_finish:
5513  * @file: input #GFile.
5514  * @res: a #GAsyncResult.
5515  * @contents: a location to place the contents of the file.
5516  * @length: a location to place the length of the contents of the file,
5517  *     or %NULL if the length is not needed
5518  * @etag_out: a location to place the current entity tag for the file,
5519  *     or %NULL if the entity tag is not needed
5520  * @error: a #GError, or %NULL
5521  *
5522  * Finishes an asynchronous load of the @file's contents.
5523  * The contents are placed in @contents, and @length is set to the
5524  * size of the @contents string. The @content should be freed with
5525  * g_free() when no longer needed. If @etag_out is present, it will be
5526  * set to the new entity tag for the @file.
5527  *
5528  * Returns: %TRUE if the load was successful. If %FALSE and @error is
5529  * present, it will be set appropriately.
5530  **/
5531 gboolean
5532 g_file_load_contents_finish (GFile         *file,
5533                              GAsyncResult  *res,
5534                              char         **contents,
5535                              gsize         *length,
5536                              char         **etag_out,
5537                              GError       **error)
5538 {
5539   return g_file_load_partial_contents_finish (file,
5540                                               res,
5541                                               contents,
5542                                               length,
5543                                               etag_out,
5544                                               error);
5545 }
5546
5547 /**
5548  * g_file_replace_contents:
5549  * @file: input #GFile.
5550  * @contents: a string containing the new contents for @file.
5551  * @length: the length of @contents in bytes.
5552  * @etag: the old <link linkend="gfile-etag">entity tag</link>
5553  *     for the document, or %NULL
5554  * @make_backup: %TRUE if a backup should be created.
5555  * @flags: a set of #GFileCreateFlags.
5556  * @new_etag: a location to a new <link linkend="gfile-etag">entity tag</link>
5557  *      for the document. This should be freed with g_free() when no longer
5558  *      needed, or %NULL
5559  * @cancellable: optional #GCancellable object, %NULL to ignore.
5560  * @error: a #GError, or %NULL
5561  *
5562  * Replaces the contents of @file with @contents of @length bytes.
5563
5564  * If @etag is specified (not %NULL) any existing file must have that etag, or
5565  * the error %G_IO_ERROR_WRONG_ETAG will be returned.
5566  *
5567  * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
5568  *
5569  * If @cancellable is not %NULL, then the operation can be cancelled by
5570  * triggering the cancellable object from another thread. If the operation
5571  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5572  *
5573  * The returned @new_etag can be used to verify that the file hasn't changed the
5574  * next time it is saved over.
5575  *
5576  * Returns: %TRUE if successful. If an error
5577  * has occurred, this function will return %FALSE and set @error
5578  * appropriately if present.
5579  **/
5580 gboolean
5581 g_file_replace_contents (GFile             *file,
5582                          const char        *contents,
5583                          gsize              length,
5584                          const char        *etag,
5585                          gboolean           make_backup,
5586                          GFileCreateFlags   flags,
5587                          char             **new_etag,
5588                          GCancellable      *cancellable,
5589                          GError           **error)
5590 {
5591   GFileOutputStream *out;
5592   gsize pos, remainder;
5593   gssize res;
5594   gboolean ret;
5595
5596   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5597   g_return_val_if_fail (contents != NULL, FALSE);
5598
5599   out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
5600   if (out == NULL)
5601     return FALSE;
5602
5603   pos = 0;
5604   remainder = length;
5605   while (remainder > 0 &&
5606          (res = g_output_stream_write (G_OUTPUT_STREAM (out),
5607                                        contents + pos,
5608                                        MIN (remainder, GET_CONTENT_BLOCK_SIZE),
5609                                        cancellable,
5610                                        error)) > 0)
5611     {
5612       pos += res;
5613       remainder -= res;
5614     }
5615
5616   if (remainder > 0 && res < 0)
5617     {
5618       /* Ignore errors on close */
5619       g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
5620       g_object_unref (out);
5621
5622       /* error is set already */
5623       return FALSE;
5624     }
5625
5626   ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
5627
5628   if (new_etag)
5629     *new_etag = g_file_output_stream_get_etag (out);
5630
5631   g_object_unref (out);
5632
5633   return ret;
5634 }
5635
5636 typedef struct {
5637   GFile *file;
5638   GError *error;
5639   GCancellable *cancellable;
5640   GAsyncReadyCallback callback;
5641   gpointer user_data;
5642   const char *content;
5643   gsize length;
5644   gsize pos;
5645   char *etag;
5646 } ReplaceContentsData;
5647
5648 static void
5649 replace_contents_data_free (ReplaceContentsData *data)
5650 {
5651   if (data->error)
5652     g_error_free (data->error);
5653   if (data->cancellable)
5654     g_object_unref (data->cancellable);
5655   g_object_unref (data->file);
5656   g_free (data->etag);
5657   g_free (data);
5658 }
5659
5660 static void
5661 replace_contents_close_callback (GObject      *obj,
5662                                  GAsyncResult *close_res,
5663                                  gpointer      user_data)
5664 {
5665   GOutputStream *stream = G_OUTPUT_STREAM (obj);
5666   ReplaceContentsData *data = user_data;
5667   GSimpleAsyncResult *res;
5668
5669   /* Ignore errors here, we're only reading anyway */
5670   g_output_stream_close_finish (stream, close_res, NULL);
5671   g_object_unref (stream);
5672
5673   data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
5674
5675   res = g_simple_async_result_new (G_OBJECT (data->file),
5676                                    data->callback,
5677                                    data->user_data,
5678                                    g_file_replace_contents_async);
5679   g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
5680   g_simple_async_result_complete (res);
5681   g_object_unref (res);
5682 }
5683
5684 static void
5685 replace_contents_write_callback (GObject      *obj,
5686                                  GAsyncResult *read_res,
5687                                  gpointer      user_data)
5688 {
5689   GOutputStream *stream = G_OUTPUT_STREAM (obj);
5690   ReplaceContentsData *data = user_data;
5691   GError *error = NULL;
5692   gssize write_size;
5693
5694   write_size = g_output_stream_write_finish (stream, read_res, &error);
5695
5696   if (write_size <= 0)
5697     {
5698       /* Error or EOF, close the file */
5699       if (write_size < 0)
5700         data->error = error;
5701       g_output_stream_close_async (stream, 0,
5702                                    data->cancellable,
5703                                    replace_contents_close_callback, data);
5704     }
5705   else if (write_size > 0)
5706     {
5707       data->pos += write_size;
5708
5709       if (data->pos >= data->length)
5710         g_output_stream_close_async (stream, 0,
5711                                      data->cancellable,
5712                                      replace_contents_close_callback, data);
5713       else
5714         g_output_stream_write_async (stream,
5715                                      data->content + data->pos,
5716                                      data->length - data->pos,
5717                                      0,
5718                                      data->cancellable,
5719                                      replace_contents_write_callback,
5720                                      data);
5721     }
5722 }
5723
5724 static void
5725 replace_contents_open_callback (GObject      *obj,
5726                                 GAsyncResult *open_res,
5727                                 gpointer      user_data)
5728 {
5729   GFile *file = G_FILE (obj);
5730   GFileOutputStream *stream;
5731   ReplaceContentsData *data = user_data;
5732   GError *error = NULL;
5733   GSimpleAsyncResult *res;
5734
5735   stream = g_file_replace_finish (file, open_res, &error);
5736
5737   if (stream)
5738     {
5739       g_output_stream_write_async (G_OUTPUT_STREAM (stream),
5740                                    data->content + data->pos,
5741                                    data->length - data->pos,
5742                                    0,
5743                                    data->cancellable,
5744                                    replace_contents_write_callback,
5745                                    data);
5746
5747     }
5748   else
5749     {
5750       res = g_simple_async_result_new_from_error (G_OBJECT (data->file),
5751                                                   data->callback,
5752                                                   data->user_data,
5753                                                   error);
5754       g_simple_async_result_complete (res);
5755       g_error_free (error);
5756       replace_contents_data_free (data);
5757       g_object_unref (res);
5758     }
5759 }
5760
5761 /**
5762  * g_file_replace_contents_async:
5763  * @file: input #GFile.
5764  * @contents: string of contents to replace the file with.
5765  * @length: the length of @contents in bytes.
5766  * @etag: a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
5767  * @make_backup: %TRUE if a backup should be created.
5768  * @flags: a set of #GFileCreateFlags.
5769  * @cancellable: optional #GCancellable object, %NULL to ignore.
5770  * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5771  * @user_data: the data to pass to callback function
5772  *
5773  * Starts an asynchronous replacement of @file with the given
5774  * @contents of @length bytes. @etag will replace the document's
5775  * current entity tag.
5776  *
5777  * When this operation has completed, @callback will be called with
5778  * @user_user data, and the operation can be finalized with
5779  * g_file_replace_contents_finish().
5780  *
5781  * If @cancellable is not %NULL, then the operation can be cancelled by
5782  * triggering the cancellable object from another thread. If the operation
5783  * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5784  *
5785  * If @make_backup is %TRUE, this function will attempt to
5786  * make a backup of @file.
5787  **/
5788 void
5789 g_file_replace_contents_async  (GFile               *file,
5790                                 const char          *contents,
5791                                 gsize                length,
5792                                 const char          *etag,
5793                                 gboolean             make_backup,
5794                                 GFileCreateFlags     flags,
5795                                 GCancellable        *cancellable,
5796                                 GAsyncReadyCallback  callback,
5797                                 gpointer             user_data)
5798 {
5799   ReplaceContentsData *data;
5800
5801   g_return_if_fail (G_IS_FILE (file));
5802   g_return_if_fail (contents != NULL);
5803
5804   data = g_new0 (ReplaceContentsData, 1);
5805
5806   if (cancellable)
5807     data->cancellable = g_object_ref (cancellable);
5808   data->callback = callback;
5809   data->user_data = user_data;
5810   data->content = contents;
5811   data->length = length;
5812   data->pos = 0;
5813   data->file = g_object_ref (file);
5814
5815   g_file_replace_async (file,
5816                         etag,
5817                         make_backup,
5818                         flags,
5819                         0,
5820                         cancellable,
5821                         replace_contents_open_callback,
5822                         data);
5823 }
5824
5825 /**
5826  * g_file_replace_contents_finish:
5827  * @file: input #GFile.
5828  * @res: a #GAsyncResult.
5829  * @new_etag: a location of a new <link linkend="gfile-etag">entity tag</link>
5830  *     for the document. This should be freed with g_free() when it is no
5831  *     longer needed, or %NULL
5832  * @error: a #GError, or %NULL
5833  *
5834  * Finishes an asynchronous replace of the given @file. See
5835  * g_file_replace_contents_async(). Sets @new_etag to the new entity
5836  * tag for the document, if present.
5837  *
5838  * Returns: %TRUE on success, %FALSE on failure.
5839  **/
5840 gboolean
5841 g_file_replace_contents_finish (GFile         *file,
5842                                 GAsyncResult  *res,
5843                                 char         **new_etag,
5844                                 GError       **error)
5845 {
5846   GSimpleAsyncResult *simple;
5847   ReplaceContentsData *data;
5848
5849   g_return_val_if_fail (G_IS_FILE (file), FALSE);
5850   g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
5851
5852   simple = G_SIMPLE_ASYNC_RESULT (res);
5853
5854   if (g_simple_async_result_propagate_error (simple, error))
5855     return FALSE;
5856
5857   g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
5858
5859   data = g_simple_async_result_get_op_res_gpointer (simple);
5860
5861   if (data->error)
5862     {
5863       g_propagate_error (error, data->error);
5864       data->error = NULL;
5865       return FALSE;
5866     }
5867
5868
5869   if (new_etag)
5870     {
5871       *new_etag = data->etag;
5872       data->etag = NULL; /* Take ownership */
5873     }
5874
5875   return TRUE;
5876 }
5877
5878 #define __G_FILE_C__
5879 #include "gioaliasdef.c"