gio/gfile.c

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