1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
20 * Author: Alexander Larsson <alexl@redhat.com>
26 #include <sys/ioctl.h>
28 /* See linux.git/fs/btrfs/ioctl.h */
29 #define BTRFS_IOCTL_MAGIC 0x94
30 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
41 #include <sys/types.h>
44 #include "glib/gstdio.h"
46 #include "glib-unix.h"
50 #include "gfileattribute-priv.h"
51 #include "gfiledescriptorbased.h"
52 #include "gpollfilemonitor.h"
54 #include "gfileinputstream.h"
55 #include "gfileoutputstream.h"
56 #include "glocalfileoutputstream.h"
57 #include "glocalfileiostream.h"
58 #include "glocalfile.h"
59 #include "gcancellable.h"
60 #include "gasyncresult.h"
67 * @short_description: File and Directory Handling
69 * @see_also: #GFileInfo, #GFileEnumerator
71 * #GFile is a high level abstraction for manipulating files on a
72 * virtual file system. #GFiles are lightweight, immutable objects
73 * that do no I/O upon creation. It is necessary to understand that
74 * #GFile objects do not represent files, merely an identifier for a
75 * file. All file content I/O is implemented as streaming operations
76 * (see #GInputStream and #GOutputStream).
78 * To construct a #GFile, you can use:
79 * - g_file_new_for_path() if you have a path.
80 * - g_file_new_for_uri() if you have a URI.
81 * - g_file_new_for_commandline_arg() for a command line argument.
82 * - g_file_new_tmp() to create a temporary file from a template.
83 * - g_file_parse_name() from a UTF-8 string gotten from g_file_get_parse_name().
85 * One way to think of a #GFile is as an abstraction of a pathname. For
86 * normal files the system pathname is what is stored internally, but as
87 * #GFiles are extensible it could also be something else that corresponds
88 * to a pathname in a userspace implementation of a filesystem.
90 * #GFiles make up hierarchies of directories and files that correspond to
91 * the files on a filesystem. You can move through the file system with
92 * #GFile using g_file_get_parent() to get an identifier for the parent
93 * directory, g_file_get_child() to get a child within a directory,
94 * g_file_resolve_relative_path() to resolve a relative path between two
95 * #GFiles. There can be multiple hierarchies, so you may not end up at
96 * the same root if you repeatedly call g_file_get_parent() on two different
99 * All #GFiles have a basename (get with g_file_get_basename()). These names
100 * are byte strings that are used to identify the file on the filesystem
101 * (relative to its parent directory) and there is no guarantees that they
102 * have any particular charset encoding or even make any sense at all. If
103 * you want to use filenames in a user interface you should use the display
104 * name that you can get by requesting the
105 * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
106 * This is guaranteed to be in UTF-8 and can be used in a user interface.
107 * But always store the real basename or the #GFile to use to actually
108 * access the file, because there is no way to go from a display name to
111 * Using #GFile as an identifier has the same weaknesses as using a path
112 * in that there may be multiple aliases for the same file. For instance,
113 * hard or soft links may cause two different #GFiles to refer to the same
114 * file. Other possible causes for aliases are: case insensitive filesystems,
115 * short and long names on FAT/NTFS, or bind mounts in Linux. If you want to
116 * check if two #GFiles point to the same file you can query for the
117 * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
118 * canonicalization of pathnames passed in, so that trivial differences in
119 * the path string used at creation (duplicated slashes, slash at end of
120 * path, "." or ".." path segments, etc) does not create different #GFiles.
122 * Many #GFile operations have both synchronous and asynchronous versions
123 * to suit your application. Asynchronous versions of synchronous functions
124 * simply have _async() appended to their function names. The asynchronous
125 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
126 * the operation, producing a GAsyncResult which is then passed to the
127 * function's matching _finish() operation.
129 * It is highly recommended to use asynchronous calls when running within a
130 * shared main loop, such as in the main thread of an application. This avoids
131 * I/O operations blocking other sources on the main loop from being dispatched.
132 * Synchronous I/O operations should be performed from worker threads. See the
133 * [introduction to asynchronous programming section][async-programming] for
136 * Some #GFile operations almost always take a noticeable amount of time, and
137 * so do not have synchronous analogs. Notable cases include:
138 * - g_file_mount_mountable() to mount a mountable file.
139 * - g_file_unmount_mountable_with_operation() to unmount a mountable file.
140 * - g_file_eject_mountable_with_operation() to eject a mountable file.
142 * ## Entity Tags # {#gfile-etag}
144 * One notable feature of #GFiles are entity tags, or "etags" for
145 * short. Entity tags are somewhat like a more abstract version of the
146 * traditional mtime, and can be used to quickly determine if the file
147 * has been modified from the version on the file system. See the
149 * [specification](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
150 * for HTTP Etag headers, which are a very similar concept.
153 static void g_file_real_query_info_async (GFile *file,
154 const char *attributes,
155 GFileQueryInfoFlags flags,
157 GCancellable *cancellable,
158 GAsyncReadyCallback callback,
160 static GFileInfo * g_file_real_query_info_finish (GFile *file,
163 static void g_file_real_query_filesystem_info_async (GFile *file,
164 const char *attributes,
166 GCancellable *cancellable,
167 GAsyncReadyCallback callback,
169 static GFileInfo * g_file_real_query_filesystem_info_finish (GFile *file,
172 static void g_file_real_enumerate_children_async (GFile *file,
173 const char *attributes,
174 GFileQueryInfoFlags flags,
176 GCancellable *cancellable,
177 GAsyncReadyCallback callback,
179 static GFileEnumerator * g_file_real_enumerate_children_finish (GFile *file,
182 static void g_file_real_read_async (GFile *file,
184 GCancellable *cancellable,
185 GAsyncReadyCallback callback,
187 static GFileInputStream * g_file_real_read_finish (GFile *file,
190 static void g_file_real_append_to_async (GFile *file,
191 GFileCreateFlags flags,
193 GCancellable *cancellable,
194 GAsyncReadyCallback callback,
196 static GFileOutputStream *g_file_real_append_to_finish (GFile *file,
199 static void g_file_real_create_async (GFile *file,
200 GFileCreateFlags flags,
202 GCancellable *cancellable,
203 GAsyncReadyCallback callback,
205 static GFileOutputStream *g_file_real_create_finish (GFile *file,
208 static void g_file_real_replace_async (GFile *file,
210 gboolean make_backup,
211 GFileCreateFlags flags,
213 GCancellable *cancellable,
214 GAsyncReadyCallback callback,
216 static GFileOutputStream *g_file_real_replace_finish (GFile *file,
219 static void g_file_real_delete_async (GFile *file,
221 GCancellable *cancellable,
222 GAsyncReadyCallback callback,
224 static gboolean g_file_real_delete_finish (GFile *file,
227 static void g_file_real_trash_async (GFile *file,
229 GCancellable *cancellable,
230 GAsyncReadyCallback callback,
232 static gboolean g_file_real_trash_finish (GFile *file,
235 static void g_file_real_make_directory_async (GFile *file,
237 GCancellable *cancellable,
238 GAsyncReadyCallback callback,
240 static gboolean g_file_real_make_directory_finish (GFile *file,
243 static void g_file_real_open_readwrite_async (GFile *file,
245 GCancellable *cancellable,
246 GAsyncReadyCallback callback,
248 static GFileIOStream * g_file_real_open_readwrite_finish (GFile *file,
251 static void g_file_real_create_readwrite_async (GFile *file,
252 GFileCreateFlags flags,
254 GCancellable *cancellable,
255 GAsyncReadyCallback callback,
257 static GFileIOStream * g_file_real_create_readwrite_finish (GFile *file,
260 static void g_file_real_replace_readwrite_async (GFile *file,
262 gboolean make_backup,
263 GFileCreateFlags flags,
265 GCancellable *cancellable,
266 GAsyncReadyCallback callback,
268 static GFileIOStream * g_file_real_replace_readwrite_finish (GFile *file,
271 static gboolean g_file_real_set_attributes_from_info (GFile *file,
273 GFileQueryInfoFlags flags,
274 GCancellable *cancellable,
276 static void g_file_real_set_display_name_async (GFile *file,
277 const char *display_name,
279 GCancellable *cancellable,
280 GAsyncReadyCallback callback,
282 static GFile * g_file_real_set_display_name_finish (GFile *file,
285 static void g_file_real_set_attributes_async (GFile *file,
287 GFileQueryInfoFlags flags,
289 GCancellable *cancellable,
290 GAsyncReadyCallback callback,
292 static gboolean g_file_real_set_attributes_finish (GFile *file,
296 static void g_file_real_find_enclosing_mount_async (GFile *file,
298 GCancellable *cancellable,
299 GAsyncReadyCallback callback,
301 static GMount * g_file_real_find_enclosing_mount_finish (GFile *file,
304 static void g_file_real_copy_async (GFile *source,
306 GFileCopyFlags flags,
308 GCancellable *cancellable,
309 GFileProgressCallback progress_callback,
310 gpointer progress_callback_data,
311 GAsyncReadyCallback callback,
313 static gboolean g_file_real_copy_finish (GFile *file,
317 static gboolean g_file_real_measure_disk_usage (GFile *file,
318 GFileMeasureFlags flags,
319 GCancellable *cancellable,
320 GFileMeasureProgressCallback progress_callback,
321 gpointer progress_data,
326 static void g_file_real_measure_disk_usage_async (GFile *file,
327 GFileMeasureFlags flags,
329 GCancellable *cancellable,
330 GFileMeasureProgressCallback progress_callback,
331 gpointer progress_data,
332 GAsyncReadyCallback callback,
334 static gboolean g_file_real_measure_disk_usage_finish (GFile *file,
335 GAsyncResult *result,
341 typedef GFileIface GFileInterface;
342 G_DEFINE_INTERFACE (GFile, g_file, G_TYPE_OBJECT)
345 g_file_default_init (GFileIface *iface)
347 iface->enumerate_children_async = g_file_real_enumerate_children_async;
348 iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
349 iface->set_display_name_async = g_file_real_set_display_name_async;
350 iface->set_display_name_finish = g_file_real_set_display_name_finish;
351 iface->query_info_async = g_file_real_query_info_async;
352 iface->query_info_finish = g_file_real_query_info_finish;
353 iface->query_filesystem_info_async = g_file_real_query_filesystem_info_async;
354 iface->query_filesystem_info_finish = g_file_real_query_filesystem_info_finish;
355 iface->set_attributes_async = g_file_real_set_attributes_async;
356 iface->set_attributes_finish = g_file_real_set_attributes_finish;
357 iface->read_async = g_file_real_read_async;
358 iface->read_finish = g_file_real_read_finish;
359 iface->append_to_async = g_file_real_append_to_async;
360 iface->append_to_finish = g_file_real_append_to_finish;
361 iface->create_async = g_file_real_create_async;
362 iface->create_finish = g_file_real_create_finish;
363 iface->replace_async = g_file_real_replace_async;
364 iface->replace_finish = g_file_real_replace_finish;
365 iface->delete_file_async = g_file_real_delete_async;
366 iface->delete_file_finish = g_file_real_delete_finish;
367 iface->trash_async = g_file_real_trash_async;
368 iface->trash_finish = g_file_real_trash_finish;
369 iface->make_directory_async = g_file_real_make_directory_async;
370 iface->make_directory_finish = g_file_real_make_directory_finish;
371 iface->open_readwrite_async = g_file_real_open_readwrite_async;
372 iface->open_readwrite_finish = g_file_real_open_readwrite_finish;
373 iface->create_readwrite_async = g_file_real_create_readwrite_async;
374 iface->create_readwrite_finish = g_file_real_create_readwrite_finish;
375 iface->replace_readwrite_async = g_file_real_replace_readwrite_async;
376 iface->replace_readwrite_finish = g_file_real_replace_readwrite_finish;
377 iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
378 iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
379 iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
380 iface->copy_async = g_file_real_copy_async;
381 iface->copy_finish = g_file_real_copy_finish;
382 iface->measure_disk_usage = g_file_real_measure_disk_usage;
383 iface->measure_disk_usage_async = g_file_real_measure_disk_usage_async;
384 iface->measure_disk_usage_finish = g_file_real_measure_disk_usage_finish;
390 * @file: input #GFile
392 * Checks to see if a file is native to the platform.
394 * A native file s one expressed in the platform-native filename format,
395 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
396 * as it might be on a locally mounted remote filesystem.
398 * On some systems non-native files may be available using the native
399 * filesystem via a userspace filesystem (FUSE), in these cases this call
400 * will return %FALSE, but g_file_get_path() will still return a native path.
402 * This call does no blocking I/O.
404 * Returns: %TRUE if @file is native
407 g_file_is_native (GFile *file)
411 g_return_val_if_fail (G_IS_FILE (file), FALSE);
413 iface = G_FILE_GET_IFACE (file);
415 return (* iface->is_native) (file);
420 * g_file_has_uri_scheme:
421 * @file: input #GFile
422 * @uri_scheme: a string containing a URI scheme
424 * Checks to see if a #GFile has a given URI scheme.
426 * This call does no blocking I/O.
428 * Returns: %TRUE if #GFile's backend supports the
429 * given URI scheme, %FALSE if URI scheme is %NULL,
430 * not supported, or #GFile is invalid.
433 g_file_has_uri_scheme (GFile *file,
434 const char *uri_scheme)
438 g_return_val_if_fail (G_IS_FILE (file), FALSE);
439 g_return_val_if_fail (uri_scheme != NULL, FALSE);
441 iface = G_FILE_GET_IFACE (file);
443 return (* iface->has_uri_scheme) (file, uri_scheme);
448 * g_file_get_uri_scheme:
449 * @file: input #GFile
451 * Gets the URI scheme for a #GFile.
452 * RFC 3986 decodes the scheme as:
454 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
456 * Common schemes include "file", "http", "ftp", etc.
458 * This call does no blocking I/O.
460 * Returns: a string containing the URI scheme for the given
461 * #GFile. The returned string should be freed with g_free()
462 * when no longer needed.
465 g_file_get_uri_scheme (GFile *file)
469 g_return_val_if_fail (G_IS_FILE (file), NULL);
471 iface = G_FILE_GET_IFACE (file);
473 return (* iface->get_uri_scheme) (file);
478 * g_file_get_basename:
479 * @file: input #GFile
481 * Gets the base name (the last component of the path) for a given #GFile.
483 * If called for the top level of a system (such as the filesystem root
484 * or a uri like sftp://host/) it will return a single directory separator
485 * (and on Windows, possibly a drive letter).
487 * The base name is a byte string (not UTF-8). It has no defined encoding
488 * or rules other than it may not contain zero bytes. If you want to use
489 * filenames in a user interface you should use the display name that you
490 * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
491 * attribute with g_file_query_info().
493 * This call does no blocking I/O.
495 * Returns: (type filename) (nullable): string containing the #GFile's
496 * base name, or %NULL if given #GFile is invalid. The returned string
497 * should be freed with g_free() when no longer needed.
500 g_file_get_basename (GFile *file)
504 g_return_val_if_fail (G_IS_FILE (file), NULL);
506 iface = G_FILE_GET_IFACE (file);
508 return (* iface->get_basename) (file);
513 * @file: input #GFile
515 * Gets the local pathname for #GFile, if one exists. If non-%NULL, this is
516 * guaranteed to be an absolute, canonical path. It might contain symlinks.
518 * This call does no blocking I/O.
520 * Returns: (type filename) (nullable): string containing the #GFile's path,
521 * or %NULL if no such path exists. The returned string should be freed
522 * with g_free() when no longer needed.
525 g_file_get_path (GFile *file)
529 g_return_val_if_fail (G_IS_FILE (file), NULL);
531 iface = G_FILE_GET_IFACE (file);
533 return (* iface->get_path) (file);
538 * @file: input #GFile
540 * Gets the URI for the @file.
542 * This call does no blocking I/O.
544 * Returns: a string containing the #GFile's URI.
545 * The returned string should be freed with g_free()
546 * when no longer needed.
549 g_file_get_uri (GFile *file)
553 g_return_val_if_fail (G_IS_FILE (file), NULL);
555 iface = G_FILE_GET_IFACE (file);
557 return (* iface->get_uri) (file);
561 * g_file_get_parse_name:
562 * @file: input #GFile
564 * Gets the parse name of the @file.
565 * A parse name is a UTF-8 string that describes the
566 * file such that one can get the #GFile back using
567 * g_file_parse_name().
569 * This is generally used to show the #GFile as a nice
570 * full-pathname kind of string in a user interface,
571 * like in a location entry.
573 * For local files with names that can safely be converted
574 * to UTF-8 the pathname is used, otherwise the IRI is used
575 * (a form of URI that allows UTF-8 characters unescaped).
577 * This call does no blocking I/O.
579 * Returns: a string containing the #GFile's parse name.
580 * The returned string should be freed with g_free()
581 * when no longer needed.
584 g_file_get_parse_name (GFile *file)
588 g_return_val_if_fail (G_IS_FILE (file), NULL);
590 iface = G_FILE_GET_IFACE (file);
592 return (* iface->get_parse_name) (file);
597 * @file: input #GFile
599 * Duplicates a #GFile handle. This operation does not duplicate
600 * the actual file or directory represented by the #GFile; see
601 * g_file_copy() if attempting to copy a file.
603 * This call does no blocking I/O.
605 * Returns: (transfer full): a new #GFile that is a duplicate
606 * of the given #GFile.
609 g_file_dup (GFile *file)
613 g_return_val_if_fail (G_IS_FILE (file), NULL);
615 iface = G_FILE_GET_IFACE (file);
617 return (* iface->dup) (file);
622 * @file: (type GFile): #gconstpointer to a #GFile
624 * Creates a hash value for a #GFile.
626 * This call does no blocking I/O.
629 * Returns: 0 if @file is not a valid #GFile, otherwise an
630 * integer that can be used as hash value for the #GFile.
631 * This function is intended for easily hashing a #GFile to
632 * add to a #GHashTable or similar data structure.
635 g_file_hash (gconstpointer file)
639 g_return_val_if_fail (G_IS_FILE (file), 0);
641 iface = G_FILE_GET_IFACE (file);
643 return (* iface->hash) ((GFile *)file);
648 * @file1: the first #GFile
649 * @file2: the second #GFile
651 * Checks if the two given #GFiles refer to the same file.
653 * Note that two #GFiles that differ can still refer to the same
654 * file on the filesystem due to various forms of filename
657 * This call does no blocking I/O.
659 * Returns: %TRUE if @file1 and @file2 are equal.
662 g_file_equal (GFile *file1,
667 g_return_val_if_fail (G_IS_FILE (file1), FALSE);
668 g_return_val_if_fail (G_IS_FILE (file2), FALSE);
673 if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
676 iface = G_FILE_GET_IFACE (file1);
678 return (* iface->equal) (file1, file2);
684 * @file: input #GFile
686 * Gets the parent directory for the @file.
687 * If the @file represents the root directory of the
688 * file system, then %NULL will be returned.
690 * This call does no blocking I/O.
692 * Returns: (nullable) (transfer full): a #GFile structure to the
693 * parent of the given #GFile or %NULL if there is no parent. Free
694 * the returned object with g_object_unref().
697 g_file_get_parent (GFile *file)
701 g_return_val_if_fail (G_IS_FILE (file), NULL);
703 iface = G_FILE_GET_IFACE (file);
705 return (* iface->get_parent) (file);
710 * @file: input #GFile
711 * @parent: (allow-none): the parent to check for, or %NULL
713 * Checks if @file has a parent, and optionally, if it is @parent.
715 * If @parent is %NULL then this function returns %TRUE if @file has any
716 * parent at all. If @parent is non-%NULL then %TRUE is only returned
717 * if @file is an immediate child of @parent.
719 * Returns: %TRUE if @file is an immediate child of @parent (or any parent in
720 * the case that @parent is %NULL).
725 g_file_has_parent (GFile *file,
728 GFile *actual_parent;
731 g_return_val_if_fail (G_IS_FILE (file), FALSE);
732 g_return_val_if_fail (parent == NULL || G_IS_FILE (parent), FALSE);
734 actual_parent = g_file_get_parent (file);
736 if (actual_parent != NULL)
739 result = g_file_equal (parent, actual_parent);
743 g_object_unref (actual_parent);
753 * @file: input #GFile
754 * @name: (type filename): string containing the child's basename
756 * Gets a child of @file with basename equal to @name.
758 * Note that the file with that specific name might not exist, but
759 * you can still have a #GFile that points to it. You can use this
760 * for instance to create that file.
762 * This call does no blocking I/O.
764 * Returns: (transfer full): a #GFile to a child specified by @name.
765 * Free the returned object with g_object_unref().
768 g_file_get_child (GFile *file,
771 g_return_val_if_fail (G_IS_FILE (file), NULL);
772 g_return_val_if_fail (name != NULL, NULL);
774 return g_file_resolve_relative_path (file, name);
778 * g_file_get_child_for_display_name:
779 * @file: input #GFile
780 * @display_name: string to a possible child
781 * @error: return location for an error
783 * Gets the child of @file for a given @display_name (i.e. a UTF-8
784 * version of the name). If this function fails, it returns %NULL
785 * and @error will be set. This is very useful when constructing a
786 * #GFile for a new file and the user entered the filename in the
787 * user interface, for instance when you select a directory and
788 * type a filename in the file selector.
790 * This call does no blocking I/O.
792 * Returns: (transfer full): a #GFile to the specified child, or
793 * %NULL if the display name couldn't be converted.
794 * Free the returned object with g_object_unref().
797 g_file_get_child_for_display_name (GFile *file,
798 const char *display_name,
803 g_return_val_if_fail (G_IS_FILE (file), NULL);
804 g_return_val_if_fail (display_name != NULL, NULL);
806 iface = G_FILE_GET_IFACE (file);
808 return (* iface->get_child_for_display_name) (file, display_name, error);
813 * @file: input #GFile
814 * @prefix: input #GFile
816 * Checks whether @file has the prefix specified by @prefix.
818 * In other words, if the names of initial elements of @file's
819 * pathname match @prefix. Only full pathname elements are matched,
820 * so a path like /foo is not considered a prefix of /foobar, only
823 * A #GFile is not a prefix of itself. If you want to check for
824 * equality, use g_file_equal().
826 * This call does no I/O, as it works purely on names. As such it can
827 * sometimes return %FALSE even if @file is inside a @prefix (from a
828 * filesystem point of view), because the prefix of @file is an alias
831 * Virtual: prefix_matches
832 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix,
836 g_file_has_prefix (GFile *file,
841 g_return_val_if_fail (G_IS_FILE (file), FALSE);
842 g_return_val_if_fail (G_IS_FILE (prefix), FALSE);
844 if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix))
847 iface = G_FILE_GET_IFACE (file);
849 /* The vtable function differs in arg order since
850 * we're using the old contains_file call
852 return (* iface->prefix_matches) (prefix, file);
856 * g_file_get_relative_path:
857 * @parent: input #GFile
858 * @descendant: input #GFile
860 * Gets the path for @descendant relative to @parent.
862 * This call does no blocking I/O.
864 * Returns: (type filename) (nullable): string with the relative path from
865 * @descendant to @parent, or %NULL if @descendant doesn't have @parent as
866 * prefix. The returned string should be freed with g_free() when
870 g_file_get_relative_path (GFile *parent,
875 g_return_val_if_fail (G_IS_FILE (parent), NULL);
876 g_return_val_if_fail (G_IS_FILE (descendant), NULL);
878 if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
881 iface = G_FILE_GET_IFACE (parent);
883 return (* iface->get_relative_path) (parent, descendant);
887 * g_file_resolve_relative_path:
888 * @file: input #GFile
889 * @relative_path: (type filename): a given relative path string
891 * Resolves a relative path for @file to an absolute path.
893 * This call does no blocking I/O.
895 * Returns: (transfer full): #GFile to the resolved path.
896 * %NULL if @relative_path is %NULL or if @file is invalid.
897 * Free the returned object with g_object_unref().
900 g_file_resolve_relative_path (GFile *file,
901 const char *relative_path)
905 g_return_val_if_fail (G_IS_FILE (file), NULL);
906 g_return_val_if_fail (relative_path != NULL, NULL);
908 iface = G_FILE_GET_IFACE (file);
910 return (* iface->resolve_relative_path) (file, relative_path);
914 * g_file_enumerate_children:
915 * @file: input #GFile
916 * @attributes: an attribute query string
917 * @flags: a set of #GFileQueryInfoFlags
918 * @cancellable: (allow-none): optional #GCancellable object,
920 * @error: #GError for error reporting
922 * Gets the requested information about the files in a directory.
923 * The result is a #GFileEnumerator object that will give out
924 * #GFileInfo objects for all the files in the directory.
926 * The @attributes value is a string that specifies the file
927 * attributes that should be gathered. It is not an error if
928 * it's not possible to read a particular requested attribute
929 * from a file - it just won't be set. @attributes should
930 * be a comma-separated list of attributes or attribute wildcards.
931 * The wildcard "*" means all attributes, and a wildcard like
932 * "standard::*" means all attributes in the standard namespace.
933 * An example attribute query be "standard::*,owner::user".
934 * The standard attributes are available as defines, like
935 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
937 * If @cancellable is not %NULL, then the operation can be cancelled
938 * by triggering the cancellable object from another thread. If the
939 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
942 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
943 * be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY
944 * error will be returned. Other errors are possible too.
946 * Returns: (transfer full): A #GFileEnumerator if successful,
947 * %NULL on error. Free the returned object with g_object_unref().
950 g_file_enumerate_children (GFile *file,
951 const char *attributes,
952 GFileQueryInfoFlags flags,
953 GCancellable *cancellable,
958 g_return_val_if_fail (G_IS_FILE (file), NULL);
960 if (g_cancellable_set_error_if_cancelled (cancellable, error))
963 iface = G_FILE_GET_IFACE (file);
965 if (iface->enumerate_children == NULL)
967 g_set_error_literal (error, G_IO_ERROR,
968 G_IO_ERROR_NOT_SUPPORTED,
969 _("Operation not supported"));
973 return (* iface->enumerate_children) (file, attributes, flags,
978 * g_file_enumerate_children_async:
979 * @file: input #GFile
980 * @attributes: an attribute query string
981 * @flags: a set of #GFileQueryInfoFlags
982 * @io_priority: the [I/O priority][io-priority] of the request
983 * @cancellable: (allow-none): optional #GCancellable object,
985 * @callback: (scope async): a #GAsyncReadyCallback to call when the
986 * request is satisfied
987 * @user_data: (closure): the data to pass to callback function
989 * Asynchronously gets the requested information about the files
990 * in a directory. The result is a #GFileEnumerator object that will
991 * give out #GFileInfo objects for all the files in the directory.
993 * For more details, see g_file_enumerate_children() which is
994 * the synchronous version of this call.
996 * When the operation is finished, @callback will be called. You can
997 * then call g_file_enumerate_children_finish() to get the result of
1001 g_file_enumerate_children_async (GFile *file,
1002 const char *attributes,
1003 GFileQueryInfoFlags flags,
1005 GCancellable *cancellable,
1006 GAsyncReadyCallback callback,
1011 g_return_if_fail (G_IS_FILE (file));
1013 iface = G_FILE_GET_IFACE (file);
1014 (* iface->enumerate_children_async) (file,
1024 * g_file_enumerate_children_finish:
1025 * @file: input #GFile
1026 * @res: a #GAsyncResult
1029 * Finishes an async enumerate children operation.
1030 * See g_file_enumerate_children_async().
1032 * Returns: (transfer full): a #GFileEnumerator or %NULL
1033 * if an error occurred.
1034 * Free the returned object with g_object_unref().
1037 g_file_enumerate_children_finish (GFile *file,
1043 g_return_val_if_fail (G_IS_FILE (file), NULL);
1044 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1046 if (g_async_result_legacy_propagate_error (res, error))
1049 iface = G_FILE_GET_IFACE (file);
1050 return (* iface->enumerate_children_finish) (file, res, error);
1054 * g_file_query_exists:
1055 * @file: input #GFile
1056 * @cancellable: (allow-none): optional #GCancellable object,
1059 * Utility function to check if a particular file exists. This is
1060 * implemented using g_file_query_info() and as such does blocking I/O.
1062 * Note that in many cases it is racy to first check for file existence
1063 * and then execute something based on the outcome of that, because the
1064 * file might have been created or removed in between the operations. The
1065 * general approach to handling that is to not check, but just do the
1066 * operation and handle the errors as they come.
1068 * As an example of race-free checking, take the case of reading a file,
1069 * and if it doesn't exist, creating it. There are two racy versions: read
1070 * it, and on error create it; and: check if it exists, if not create it.
1071 * These can both result in two processes creating the file (with perhaps
1072 * a partially written file as the result). The correct approach is to
1073 * always try to create the file with g_file_create() which will either
1074 * atomically create the file or fail with a %G_IO_ERROR_EXISTS error.
1076 * However, in many cases an existence check is useful in a user interface,
1077 * for instance to make a menu item sensitive/insensitive, so that you don't
1078 * have to fool users that something is possible and then just show an error
1079 * dialog. If you do this, you should make sure to also handle the errors
1080 * that can happen due to races when you execute the operation.
1082 * Returns: %TRUE if the file exists (and can be detected without error),
1083 * %FALSE otherwise (or if cancelled).
1086 g_file_query_exists (GFile *file,
1087 GCancellable *cancellable)
1091 g_return_val_if_fail (G_IS_FILE(file), FALSE);
1093 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1094 G_FILE_QUERY_INFO_NONE, cancellable, NULL);
1097 g_object_unref (info);
1105 * g_file_query_file_type:
1106 * @file: input #GFile
1107 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info()
1108 * @cancellable: (allow-none): optional #GCancellable object,
1111 * Utility function to inspect the #GFileType of a file. This is
1112 * implemented using g_file_query_info() and as such does blocking I/O.
1114 * The primary use case of this method is to check if a file is
1115 * a regular file, directory, or symlink.
1117 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN
1118 * if the file does not exist
1123 g_file_query_file_type (GFile *file,
1124 GFileQueryInfoFlags flags,
1125 GCancellable *cancellable)
1128 GFileType file_type;
1130 g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN);
1131 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags,
1135 file_type = g_file_info_get_file_type (info);
1136 g_object_unref (info);
1139 file_type = G_FILE_TYPE_UNKNOWN;
1145 * g_file_query_info:
1146 * @file: input #GFile
1147 * @attributes: an attribute query string
1148 * @flags: a set of #GFileQueryInfoFlags
1149 * @cancellable: (allow-none): optional #GCancellable object,
1153 * Gets the requested information about specified @file.
1154 * The result is a #GFileInfo object that contains key-value
1155 * attributes (such as the type or size of the file).
1157 * The @attributes value is a string that specifies the file
1158 * attributes that should be gathered. It is not an error if
1159 * it's not possible to read a particular requested attribute
1160 * from a file - it just won't be set. @attributes should be a
1161 * comma-separated list of attributes or attribute wildcards.
1162 * The wildcard "*" means all attributes, and a wildcard like
1163 * "standard::*" means all attributes in the standard namespace.
1164 * An example attribute query be "standard::*,owner::user".
1165 * The standard attributes are available as defines, like
1166 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1168 * If @cancellable is not %NULL, then the operation can be cancelled
1169 * by triggering the cancellable object from another thread. If the
1170 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1173 * For symlinks, normally the information about the target of the
1174 * symlink is returned, rather than information about the symlink
1175 * itself. However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
1176 * in @flags the information about the symlink itself will be returned.
1177 * Also, for symlinks that point to non-existing files the information
1178 * about the symlink itself will be returned.
1180 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1181 * returned. Other errors are possible too, and depend on what kind of
1182 * filesystem the file is on.
1184 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL
1185 * on error. Free the returned object with g_object_unref().
1188 g_file_query_info (GFile *file,
1189 const char *attributes,
1190 GFileQueryInfoFlags flags,
1191 GCancellable *cancellable,
1196 g_return_val_if_fail (G_IS_FILE (file), NULL);
1198 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1201 iface = G_FILE_GET_IFACE (file);
1203 if (iface->query_info == NULL)
1205 g_set_error_literal (error, G_IO_ERROR,
1206 G_IO_ERROR_NOT_SUPPORTED,
1207 _("Operation not supported"));
1211 return (* iface->query_info) (file, attributes, flags, cancellable, error);
1215 * g_file_query_info_async:
1216 * @file: input #GFile
1217 * @attributes: an attribute query string
1218 * @flags: a set of #GFileQueryInfoFlags
1219 * @io_priority: the [I/O priority][io-priority] of the request
1220 * @cancellable: (allow-none): optional #GCancellable object,
1222 * @callback: (scope async): a #GAsyncReadyCallback to call when the
1223 * request is satisfied
1224 * @user_data: (closure): the data to pass to callback function
1226 * Asynchronously gets the requested information about specified @file.
1227 * The result is a #GFileInfo object that contains key-value attributes
1228 * (such as type or size for the file).
1230 * For more details, see g_file_query_info() which is the synchronous
1231 * version of this call.
1233 * When the operation is finished, @callback will be called. You can
1234 * then call g_file_query_info_finish() to get the result of the operation.
1237 g_file_query_info_async (GFile *file,
1238 const char *attributes,
1239 GFileQueryInfoFlags flags,
1241 GCancellable *cancellable,
1242 GAsyncReadyCallback callback,
1247 g_return_if_fail (G_IS_FILE (file));
1249 iface = G_FILE_GET_IFACE (file);
1250 (* iface->query_info_async) (file,
1260 * g_file_query_info_finish:
1261 * @file: input #GFile
1262 * @res: a #GAsyncResult
1265 * Finishes an asynchronous file info query.
1266 * See g_file_query_info_async().
1268 * Returns: (transfer full): #GFileInfo for given @file
1269 * or %NULL on error. Free the returned object with
1273 g_file_query_info_finish (GFile *file,
1279 g_return_val_if_fail (G_IS_FILE (file), NULL);
1280 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1282 if (g_async_result_legacy_propagate_error (res, error))
1285 iface = G_FILE_GET_IFACE (file);
1286 return (* iface->query_info_finish) (file, res, error);
1290 * g_file_query_filesystem_info:
1291 * @file: input #GFile
1292 * @attributes: an attribute query string
1293 * @cancellable: (allow-none): optional #GCancellable object,
1297 * Similar to g_file_query_info(), but obtains information
1298 * about the filesystem the @file is on, rather than the file itself.
1299 * For instance the amount of space available and the type of
1302 * The @attributes value is a string that specifies the attributes
1303 * that should be gathered. It is not an error if it's not possible
1304 * to read a particular requested attribute from a file - it just
1305 * won't be set. @attributes should be a comma-separated list of
1306 * attributes or attribute wildcards. The wildcard "*" means all
1307 * attributes, and a wildcard like "filesystem::*" means all attributes
1308 * in the filesystem namespace. The standard namespace for filesystem
1309 * attributes is "filesystem". Common attributes of interest are
1310 * #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
1311 * in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
1312 * and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1314 * If @cancellable is not %NULL, then the operation can be cancelled
1315 * by triggering the cancellable object from another thread. If the
1316 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1319 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1320 * be returned. Other errors are possible too, and depend on what
1321 * kind of filesystem the file is on.
1323 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1324 * Free the returned object with g_object_unref().
1327 g_file_query_filesystem_info (GFile *file,
1328 const char *attributes,
1329 GCancellable *cancellable,
1334 g_return_val_if_fail (G_IS_FILE (file), NULL);
1336 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1339 iface = G_FILE_GET_IFACE (file);
1341 if (iface->query_filesystem_info == NULL)
1343 g_set_error_literal (error, G_IO_ERROR,
1344 G_IO_ERROR_NOT_SUPPORTED,
1345 _("Operation not supported"));
1349 return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1353 * g_file_query_filesystem_info_async:
1354 * @file: input #GFile
1355 * @attributes: an attribute query string
1356 * @io_priority: the [I/O priority][io-priority] of the request
1357 * @cancellable: (allow-none): optional #GCancellable object,
1359 * @callback: (scope async): a #GAsyncReadyCallback to call
1360 * when the request is satisfied
1361 * @user_data: (closure): the data to pass to callback function
1363 * Asynchronously gets the requested information about the filesystem
1364 * that the specified @file is on. The result is a #GFileInfo object
1365 * that contains key-value attributes (such as type or size for the
1368 * For more details, see g_file_query_filesystem_info() which is the
1369 * synchronous version of this call.
1371 * When the operation is finished, @callback will be called. You can
1372 * then call g_file_query_info_finish() to get the result of the
1376 g_file_query_filesystem_info_async (GFile *file,
1377 const char *attributes,
1379 GCancellable *cancellable,
1380 GAsyncReadyCallback callback,
1385 g_return_if_fail (G_IS_FILE (file));
1387 iface = G_FILE_GET_IFACE (file);
1388 (* iface->query_filesystem_info_async) (file,
1397 * g_file_query_filesystem_info_finish:
1398 * @file: input #GFile
1399 * @res: a #GAsyncResult
1402 * Finishes an asynchronous filesystem info query.
1403 * See g_file_query_filesystem_info_async().
1405 * Returns: (transfer full): #GFileInfo for given @file
1406 * or %NULL on error.
1407 * Free the returned object with g_object_unref().
1410 g_file_query_filesystem_info_finish (GFile *file,
1416 g_return_val_if_fail (G_IS_FILE (file), NULL);
1417 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1419 if (g_async_result_legacy_propagate_error (res, error))
1422 iface = G_FILE_GET_IFACE (file);
1423 return (* iface->query_filesystem_info_finish) (file, res, error);
1427 * g_file_find_enclosing_mount:
1428 * @file: input #GFile
1429 * @cancellable: (allow-none): optional #GCancellable object,
1433 * Gets a #GMount for the #GFile.
1435 * If the #GFileIface for @file does not have a mount (e.g.
1436 * possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND
1437 * and %NULL will be returned.
1439 * If @cancellable is not %NULL, then the operation can be cancelled by
1440 * triggering the cancellable object from another thread. If the operation
1441 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1443 * Returns: (transfer full): a #GMount where the @file is located
1444 * or %NULL on error.
1445 * Free the returned object with g_object_unref().
1448 g_file_find_enclosing_mount (GFile *file,
1449 GCancellable *cancellable,
1454 g_return_val_if_fail (G_IS_FILE (file), NULL);
1456 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1459 iface = G_FILE_GET_IFACE (file);
1460 if (iface->find_enclosing_mount == NULL)
1463 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
1464 /* Translators: This is an error message when
1465 * trying to find the enclosing (user visible)
1466 * mount of a file, but none exists.
1468 _("Containing mount does not exist"));
1472 return (* iface->find_enclosing_mount) (file, cancellable, error);
1476 * g_file_find_enclosing_mount_async:
1478 * @io_priority: the [I/O priority][io-priority] of the request
1479 * @cancellable: (allow-none): optional #GCancellable object,
1481 * @callback: (scope async): a #GAsyncReadyCallback to call
1482 * when the request is satisfied
1483 * @user_data: (closure): the data to pass to callback function
1485 * Asynchronously gets the mount for the file.
1487 * For more details, see g_file_find_enclosing_mount() which is
1488 * the synchronous version of this call.
1490 * When the operation is finished, @callback will be called.
1491 * You can then call g_file_find_enclosing_mount_finish() to
1492 * get the result of the operation.
1495 g_file_find_enclosing_mount_async (GFile *file,
1497 GCancellable *cancellable,
1498 GAsyncReadyCallback callback,
1503 g_return_if_fail (G_IS_FILE (file));
1505 iface = G_FILE_GET_IFACE (file);
1506 (* iface->find_enclosing_mount_async) (file,
1514 * g_file_find_enclosing_mount_finish:
1516 * @res: a #GAsyncResult
1519 * Finishes an asynchronous find mount request.
1520 * See g_file_find_enclosing_mount_async().
1522 * Returns: (transfer full): #GMount for given @file or %NULL on error.
1523 * Free the returned object with g_object_unref().
1526 g_file_find_enclosing_mount_finish (GFile *file,
1532 g_return_val_if_fail (G_IS_FILE (file), NULL);
1533 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1535 if (g_async_result_legacy_propagate_error (res, error))
1538 iface = G_FILE_GET_IFACE (file);
1539 return (* iface->find_enclosing_mount_finish) (file, res, error);
1545 * @file: #GFile to read
1546 * @cancellable: (allow-none): a #GCancellable
1547 * @error: a #GError, or %NULL
1549 * Opens a file for reading. The result is a #GFileInputStream that
1550 * can be used to read the contents of the file.
1552 * If @cancellable is not %NULL, then the operation can be cancelled by
1553 * triggering the cancellable object from another thread. If the operation
1554 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1556 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1557 * returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1558 * error will be returned. Other errors are possible too, and depend
1559 * on what kind of filesystem the file is on.
1562 * Returns: (transfer full): #GFileInputStream or %NULL on error.
1563 * Free the returned object with g_object_unref().
1566 g_file_read (GFile *file,
1567 GCancellable *cancellable,
1572 g_return_val_if_fail (G_IS_FILE (file), NULL);
1574 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1577 iface = G_FILE_GET_IFACE (file);
1579 if (iface->read_fn == NULL)
1581 g_set_error_literal (error, G_IO_ERROR,
1582 G_IO_ERROR_NOT_SUPPORTED,
1583 _("Operation not supported"));
1587 return (* iface->read_fn) (file, cancellable, error);
1592 * @file: input #GFile
1593 * @flags: a set of #GFileCreateFlags
1594 * @cancellable: (allow-none): optional #GCancellable object,
1596 * @error: a #GError, or %NULL
1598 * Gets an output stream for appending data to the file.
1599 * If the file doesn't already exist it is created.
1601 * By default files created are generally readable by everyone,
1602 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1603 * will be made readable only to the current user, to the level that
1604 * is supported on the target filesystem.
1606 * If @cancellable is not %NULL, then the operation can be cancelled
1607 * by triggering the cancellable object from another thread. If the
1608 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1611 * Some file systems don't allow all file names, and may return an
1612 * %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the
1613 * %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are
1614 * possible too, and depend on what kind of filesystem the file is on.
1616 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1617 * Free the returned object with g_object_unref().
1620 g_file_append_to (GFile *file,
1621 GFileCreateFlags flags,
1622 GCancellable *cancellable,
1627 g_return_val_if_fail (G_IS_FILE (file), NULL);
1629 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1632 iface = G_FILE_GET_IFACE (file);
1634 if (iface->append_to == NULL)
1636 g_set_error_literal (error, G_IO_ERROR,
1637 G_IO_ERROR_NOT_SUPPORTED,
1638 _("Operation not supported"));
1642 return (* iface->append_to) (file, flags, cancellable, error);
1647 * @file: input #GFile
1648 * @flags: a set of #GFileCreateFlags
1649 * @cancellable: (allow-none): optional #GCancellable object,
1651 * @error: a #GError, or %NULL
1653 * Creates a new file and returns an output stream for writing to it.
1654 * The file must not already exist.
1656 * By default files created are generally readable by everyone,
1657 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1658 * will be made readable only to the current user, to the level
1659 * that is supported on the target filesystem.
1661 * If @cancellable is not %NULL, then the operation can be cancelled
1662 * by triggering the cancellable object from another thread. If the
1663 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1666 * If a file or directory with this name already exists the
1667 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1668 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1669 * error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will
1670 * be returned. Other errors are possible too, and depend on what kind
1671 * of filesystem the file is on.
1673 * Returns: (transfer full): a #GFileOutputStream for the newly created
1674 * file, or %NULL on error.
1675 * Free the returned object with g_object_unref().
1678 g_file_create (GFile *file,
1679 GFileCreateFlags flags,
1680 GCancellable *cancellable,
1685 g_return_val_if_fail (G_IS_FILE (file), NULL);
1687 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1690 iface = G_FILE_GET_IFACE (file);
1692 if (iface->create == NULL)
1694 g_set_error_literal (error, G_IO_ERROR,
1695 G_IO_ERROR_NOT_SUPPORTED,
1696 _("Operation not supported"));
1700 return (* iface->create) (file, flags, cancellable, error);
1705 * @file: input #GFile
1706 * @etag: (allow-none): an optional [entity tag][gfile-etag]
1707 * for the current #GFile, or #NULL to ignore
1708 * @make_backup: %TRUE if a backup should be created
1709 * @flags: a set of #GFileCreateFlags
1710 * @cancellable: (allow-none): optional #GCancellable object,
1712 * @error: a #GError, or %NULL
1714 * Returns an output stream for overwriting the file, possibly
1715 * creating a backup copy of the file first. If the file doesn't exist,
1716 * it will be created.
1718 * This will try to replace the file in the safest way possible so
1719 * that any errors during the writing will not affect an already
1720 * existing copy of the file. For instance, for local files it
1721 * may write to a temporary file and then atomically rename over
1722 * the destination when the stream is closed.
1724 * By default files created are generally readable by everyone,
1725 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1726 * will be made readable only to the current user, to the level that
1727 * is supported on the target filesystem.
1729 * If @cancellable is not %NULL, then the operation can be cancelled
1730 * by triggering the cancellable object from another thread. If the
1731 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1734 * If you pass in a non-%NULL @etag value and @file already exists, then
1735 * this value is compared to the current entity tag of the file, and if
1736 * they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
1737 * generally means that the file has been changed since you last read
1738 * it. You can get the new etag from g_file_output_stream_get_etag()
1739 * after you've finished writing and closed the #GFileOutputStream. When
1740 * you load a new file you can use g_file_input_stream_query_info() to
1741 * get the etag of the file.
1743 * If @make_backup is %TRUE, this function will attempt to make a
1744 * backup of the current file before overwriting it. If this fails
1745 * a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
1746 * want to replace anyway, try again with @make_backup set to %FALSE.
1748 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will
1749 * be returned, and if the file is some other form of non-regular file
1750 * then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some
1751 * file systems don't allow all file names, and may return an
1752 * %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long
1753 * %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are
1754 * possible too, and depend on what kind of filesystem the file is on.
1756 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1757 * Free the returned object with g_object_unref().
1760 g_file_replace (GFile *file,
1762 gboolean make_backup,
1763 GFileCreateFlags flags,
1764 GCancellable *cancellable,
1769 g_return_val_if_fail (G_IS_FILE (file), NULL);
1771 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1774 iface = G_FILE_GET_IFACE (file);
1776 if (iface->replace == NULL)
1778 g_set_error_literal (error, G_IO_ERROR,
1779 G_IO_ERROR_NOT_SUPPORTED,
1780 _("Operation not supported"));
1784 /* Handle empty tag string as NULL in consistent way. */
1785 if (etag && *etag == 0)
1788 return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1792 * g_file_open_readwrite:
1793 * @file: #GFile to open
1794 * @cancellable: (allow-none): a #GCancellable
1795 * @error: a #GError, or %NULL
1797 * Opens an existing file for reading and writing. The result is
1798 * a #GFileIOStream that can be used to read and write the contents
1801 * If @cancellable is not %NULL, then the operation can be cancelled
1802 * by triggering the cancellable object from another thread. If the
1803 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1806 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1807 * be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1808 * error will be returned. Other errors are possible too, and depend on
1809 * what kind of filesystem the file is on. Note that in many non-local
1810 * file cases read and write streams are not supported, so make sure you
1811 * really need to do read and write streaming, rather than just opening
1812 * for reading or writing.
1814 * Returns: (transfer full): #GFileIOStream or %NULL on error.
1815 * Free the returned object with g_object_unref().
1820 g_file_open_readwrite (GFile *file,
1821 GCancellable *cancellable,
1826 g_return_val_if_fail (G_IS_FILE (file), NULL);
1828 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1831 iface = G_FILE_GET_IFACE (file);
1833 if (iface->open_readwrite == NULL)
1835 g_set_error_literal (error, G_IO_ERROR,
1836 G_IO_ERROR_NOT_SUPPORTED,
1837 _("Operation not supported"));
1841 return (* iface->open_readwrite) (file, cancellable, error);
1845 * g_file_create_readwrite:
1847 * @flags: a set of #GFileCreateFlags
1848 * @cancellable: (allow-none): optional #GCancellable object,
1850 * @error: return location for a #GError, or %NULL
1852 * Creates a new file and returns a stream for reading and
1853 * writing to it. The file must not already exist.
1855 * By default files created are generally readable by everyone,
1856 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1857 * will be made readable only to the current user, to the level
1858 * that is supported on the target filesystem.
1860 * If @cancellable is not %NULL, then the operation can be cancelled
1861 * by triggering the cancellable object from another thread. If the
1862 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1865 * If a file or directory with this name already exists, the
1866 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1867 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1868 * error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG
1869 * will be returned. Other errors are possible too, and depend on what
1870 * kind of filesystem the file is on.
1872 * Note that in many non-local file cases read and write streams are
1873 * not supported, so make sure you really need to do read and write
1874 * streaming, rather than just opening for reading or writing.
1876 * Returns: (transfer full): a #GFileIOStream for the newly created
1877 * file, or %NULL on error.
1878 * Free the returned object with g_object_unref().
1883 g_file_create_readwrite (GFile *file,
1884 GFileCreateFlags flags,
1885 GCancellable *cancellable,
1890 g_return_val_if_fail (G_IS_FILE (file), NULL);
1892 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1895 iface = G_FILE_GET_IFACE (file);
1897 if (iface->create_readwrite == NULL)
1899 g_set_error_literal (error, G_IO_ERROR,
1900 G_IO_ERROR_NOT_SUPPORTED,
1901 _("Operation not supported"));
1905 return (* iface->create_readwrite) (file, flags, cancellable, error);
1909 * g_file_replace_readwrite:
1911 * @etag: (allow-none): an optional [entity tag][gfile-etag]
1912 * for the current #GFile, or #NULL to ignore
1913 * @make_backup: %TRUE if a backup should be created
1914 * @flags: a set of #GFileCreateFlags
1915 * @cancellable: (allow-none): optional #GCancellable object,
1917 * @error: return location for a #GError, or %NULL
1919 * Returns an output stream for overwriting the file in readwrite mode,
1920 * possibly creating a backup copy of the file first. If the file doesn't
1921 * exist, it will be created.
1923 * For details about the behaviour, see g_file_replace() which does the
1924 * same thing but returns an output stream only.
1926 * Note that in many non-local file cases read and write streams are not
1927 * supported, so make sure you really need to do read and write streaming,
1928 * rather than just opening for reading or writing.
1930 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
1931 * Free the returned object with g_object_unref().
1936 g_file_replace_readwrite (GFile *file,
1938 gboolean make_backup,
1939 GFileCreateFlags flags,
1940 GCancellable *cancellable,
1945 g_return_val_if_fail (G_IS_FILE (file), NULL);
1947 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1950 iface = G_FILE_GET_IFACE (file);
1952 if (iface->replace_readwrite == NULL)
1954 g_set_error_literal (error, G_IO_ERROR,
1955 G_IO_ERROR_NOT_SUPPORTED,
1956 _("Operation not supported"));
1960 return (* iface->replace_readwrite) (file, etag, make_backup, flags, cancellable, error);
1964 * g_file_read_async:
1965 * @file: input #GFile
1966 * @io_priority: the [I/O priority][io-priority] of the request
1967 * @cancellable: (allow-none): optional #GCancellable object,
1969 * @callback: (scope async): a #GAsyncReadyCallback to call
1970 * when the request is satisfied
1971 * @user_data: (closure): the data to pass to callback function
1973 * Asynchronously opens @file for reading.
1975 * For more details, see g_file_read() which is
1976 * the synchronous version of this call.
1978 * When the operation is finished, @callback will be called.
1979 * You can then call g_file_read_finish() to get the result
1983 g_file_read_async (GFile *file,
1985 GCancellable *cancellable,
1986 GAsyncReadyCallback callback,
1991 g_return_if_fail (G_IS_FILE (file));
1993 iface = G_FILE_GET_IFACE (file);
1994 (* iface->read_async) (file,
2002 * g_file_read_finish:
2003 * @file: input #GFile
2004 * @res: a #GAsyncResult
2005 * @error: a #GError, or %NULL
2007 * Finishes an asynchronous file read operation started with
2008 * g_file_read_async().
2010 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
2011 * Free the returned object with g_object_unref().
2014 g_file_read_finish (GFile *file,
2020 g_return_val_if_fail (G_IS_FILE (file), NULL);
2021 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2023 if (g_async_result_legacy_propagate_error (res, error))
2026 iface = G_FILE_GET_IFACE (file);
2027 return (* iface->read_finish) (file, res, error);
2031 * g_file_append_to_async:
2032 * @file: input #GFile
2033 * @flags: a set of #GFileCreateFlags
2034 * @io_priority: the [I/O priority][io-priority] of the request
2035 * @cancellable: (allow-none): optional #GCancellable object,
2037 * @callback: (scope async): a #GAsyncReadyCallback to call
2038 * when the request is satisfied
2039 * @user_data: (closure): the data to pass to callback function
2041 * Asynchronously opens @file for appending.
2043 * For more details, see g_file_append_to() which is
2044 * the synchronous version of this call.
2046 * When the operation is finished, @callback will be called.
2047 * You can then call g_file_append_to_finish() to get the result
2051 g_file_append_to_async (GFile *file,
2052 GFileCreateFlags flags,
2054 GCancellable *cancellable,
2055 GAsyncReadyCallback callback,
2060 g_return_if_fail (G_IS_FILE (file));
2062 iface = G_FILE_GET_IFACE (file);
2063 (* iface->append_to_async) (file,
2072 * g_file_append_to_finish:
2073 * @file: input #GFile
2074 * @res: #GAsyncResult
2075 * @error: a #GError, or %NULL
2077 * Finishes an asynchronous file append operation started with
2078 * g_file_append_to_async().
2080 * Returns: (transfer full): a valid #GFileOutputStream
2081 * or %NULL on error.
2082 * Free the returned object with g_object_unref().
2085 g_file_append_to_finish (GFile *file,
2091 g_return_val_if_fail (G_IS_FILE (file), NULL);
2092 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2094 if (g_async_result_legacy_propagate_error (res, error))
2097 iface = G_FILE_GET_IFACE (file);
2098 return (* iface->append_to_finish) (file, res, error);
2102 * g_file_create_async:
2103 * @file: input #GFile
2104 * @flags: a set of #GFileCreateFlags
2105 * @io_priority: the [I/O priority][io-priority] of the request
2106 * @cancellable: (allow-none): optional #GCancellable object,
2108 * @callback: (scope async): a #GAsyncReadyCallback to call
2109 * when the request is satisfied
2110 * @user_data: (closure): the data to pass to callback function
2112 * Asynchronously creates a new file and returns an output stream
2113 * for writing to it. The file must not already exist.
2115 * For more details, see g_file_create() which is
2116 * the synchronous version of this call.
2118 * When the operation is finished, @callback will be called.
2119 * You can then call g_file_create_finish() to get the result
2123 g_file_create_async (GFile *file,
2124 GFileCreateFlags flags,
2126 GCancellable *cancellable,
2127 GAsyncReadyCallback callback,
2132 g_return_if_fail (G_IS_FILE (file));
2134 iface = G_FILE_GET_IFACE (file);
2135 (* iface->create_async) (file,
2144 * g_file_create_finish:
2145 * @file: input #GFile
2146 * @res: a #GAsyncResult
2147 * @error: a #GError, or %NULL
2149 * Finishes an asynchronous file create operation started with
2150 * g_file_create_async().
2152 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2153 * Free the returned object with g_object_unref().
2156 g_file_create_finish (GFile *file,
2162 g_return_val_if_fail (G_IS_FILE (file), NULL);
2163 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2165 if (g_async_result_legacy_propagate_error (res, error))
2168 iface = G_FILE_GET_IFACE (file);
2169 return (* iface->create_finish) (file, res, error);
2173 * g_file_replace_async:
2174 * @file: input #GFile
2175 * @etag: (allow-none): an [entity tag][gfile-etag] for the current #GFile,
2176 * or %NULL to ignore
2177 * @make_backup: %TRUE if a backup should be created
2178 * @flags: a set of #GFileCreateFlags
2179 * @io_priority: the [I/O priority][io-priority] of the request
2180 * @cancellable: (allow-none): optional #GCancellable object,
2182 * @callback: (scope async): a #GAsyncReadyCallback to call
2183 * when the request is satisfied
2184 * @user_data: (closure): the data to pass to callback function
2186 * Asynchronously overwrites the file, replacing the contents,
2187 * possibly creating a backup copy of the file first.
2189 * For more details, see g_file_replace() which is
2190 * the synchronous version of this call.
2192 * When the operation is finished, @callback will be called.
2193 * You can then call g_file_replace_finish() to get the result
2197 g_file_replace_async (GFile *file,
2199 gboolean make_backup,
2200 GFileCreateFlags flags,
2202 GCancellable *cancellable,
2203 GAsyncReadyCallback callback,
2208 g_return_if_fail (G_IS_FILE (file));
2210 iface = G_FILE_GET_IFACE (file);
2211 (* iface->replace_async) (file,
2222 * g_file_replace_finish:
2223 * @file: input #GFile
2224 * @res: a #GAsyncResult
2225 * @error: a #GError, or %NULL
2227 * Finishes an asynchronous file replace operation started with
2228 * g_file_replace_async().
2230 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2231 * Free the returned object with g_object_unref().
2234 g_file_replace_finish (GFile *file,
2240 g_return_val_if_fail (G_IS_FILE (file), NULL);
2241 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2243 if (g_async_result_legacy_propagate_error (res, error))
2246 iface = G_FILE_GET_IFACE (file);
2247 return (* iface->replace_finish) (file, res, error);
2251 * g_file_open_readwrite_async
2252 * @file: input #GFile
2253 * @io_priority: the [I/O priority][io-priority] of the request
2254 * @cancellable: (allow-none): optional #GCancellable object,
2256 * @callback: (scope async): a #GAsyncReadyCallback to call
2257 * when the request is satisfied
2258 * @user_data: (closure): the data to pass to callback function
2260 * Asynchronously opens @file for reading and writing.
2262 * For more details, see g_file_open_readwrite() which is
2263 * the synchronous version of this call.
2265 * When the operation is finished, @callback will be called.
2266 * You can then call g_file_open_readwrite_finish() to get
2267 * the result of the operation.
2272 g_file_open_readwrite_async (GFile *file,
2274 GCancellable *cancellable,
2275 GAsyncReadyCallback callback,
2280 g_return_if_fail (G_IS_FILE (file));
2282 iface = G_FILE_GET_IFACE (file);
2283 (* iface->open_readwrite_async) (file,
2291 * g_file_open_readwrite_finish:
2292 * @file: input #GFile
2293 * @res: a #GAsyncResult
2294 * @error: a #GError, or %NULL
2296 * Finishes an asynchronous file read operation started with
2297 * g_file_open_readwrite_async().
2299 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2300 * Free the returned object with g_object_unref().
2305 g_file_open_readwrite_finish (GFile *file,
2311 g_return_val_if_fail (G_IS_FILE (file), NULL);
2312 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2314 if (g_async_result_legacy_propagate_error (res, error))
2317 iface = G_FILE_GET_IFACE (file);
2318 return (* iface->open_readwrite_finish) (file, res, error);
2322 * g_file_create_readwrite_async:
2323 * @file: input #GFile
2324 * @flags: a set of #GFileCreateFlags
2325 * @io_priority: the [I/O priority][io-priority] of the request
2326 * @cancellable: (allow-none): optional #GCancellable object,
2328 * @callback: (scope async): a #GAsyncReadyCallback to call
2329 * when the request is satisfied
2330 * @user_data: (closure): the data to pass to callback function
2332 * Asynchronously creates a new file and returns a stream
2333 * for reading and writing to it. The file must not already exist.
2335 * For more details, see g_file_create_readwrite() which is
2336 * the synchronous version of this call.
2338 * When the operation is finished, @callback will be called.
2339 * You can then call g_file_create_readwrite_finish() to get
2340 * the result of the operation.
2345 g_file_create_readwrite_async (GFile *file,
2346 GFileCreateFlags flags,
2348 GCancellable *cancellable,
2349 GAsyncReadyCallback callback,
2354 g_return_if_fail (G_IS_FILE (file));
2356 iface = G_FILE_GET_IFACE (file);
2357 (* iface->create_readwrite_async) (file,
2366 * g_file_create_readwrite_finish:
2367 * @file: input #GFile
2368 * @res: a #GAsyncResult
2369 * @error: a #GError, or %NULL
2371 * Finishes an asynchronous file create operation started with
2372 * g_file_create_readwrite_async().
2374 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2375 * Free the returned object with g_object_unref().
2380 g_file_create_readwrite_finish (GFile *file,
2386 g_return_val_if_fail (G_IS_FILE (file), NULL);
2387 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2389 if (g_async_result_legacy_propagate_error (res, error))
2392 iface = G_FILE_GET_IFACE (file);
2393 return (* iface->create_readwrite_finish) (file, res, error);
2397 * g_file_replace_readwrite_async:
2398 * @file: input #GFile
2399 * @etag: (allow-none): an [entity tag][gfile-etag] for the current #GFile,
2400 * or %NULL to ignore
2401 * @make_backup: %TRUE if a backup should be created
2402 * @flags: a set of #GFileCreateFlags
2403 * @io_priority: the [I/O priority][io-priority] of the request
2404 * @cancellable: (allow-none): optional #GCancellable object,
2406 * @callback: (scope async): a #GAsyncReadyCallback to call
2407 * when the request is satisfied
2408 * @user_data: (closure): the data to pass to callback function
2410 * Asynchronously overwrites the file in read-write mode,
2411 * replacing the contents, possibly creating a backup copy
2412 * of the file first.
2414 * For more details, see g_file_replace_readwrite() which is
2415 * the synchronous version of this call.
2417 * When the operation is finished, @callback will be called.
2418 * You can then call g_file_replace_readwrite_finish() to get
2419 * the result of the operation.
2424 g_file_replace_readwrite_async (GFile *file,
2426 gboolean make_backup,
2427 GFileCreateFlags flags,
2429 GCancellable *cancellable,
2430 GAsyncReadyCallback callback,
2435 g_return_if_fail (G_IS_FILE (file));
2437 iface = G_FILE_GET_IFACE (file);
2438 (* iface->replace_readwrite_async) (file,
2449 * g_file_replace_readwrite_finish:
2450 * @file: input #GFile
2451 * @res: a #GAsyncResult
2452 * @error: a #GError, or %NULL
2454 * Finishes an asynchronous file replace operation started with
2455 * g_file_replace_readwrite_async().
2457 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2458 * Free the returned object with g_object_unref().
2463 g_file_replace_readwrite_finish (GFile *file,
2469 g_return_val_if_fail (G_IS_FILE (file), NULL);
2470 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2472 if (g_async_result_legacy_propagate_error (res, error))
2475 iface = G_FILE_GET_IFACE (file);
2476 return (* iface->replace_readwrite_finish) (file, res, error);
2480 copy_symlink (GFile *destination,
2481 GFileCopyFlags flags,
2482 GCancellable *cancellable,
2487 gboolean tried_delete;
2489 GFileType file_type;
2491 tried_delete = FALSE;
2495 if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
2497 /* Maybe it already existed, and we want to overwrite? */
2498 if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
2499 my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
2501 g_clear_error (&my_error);
2503 /* Don't overwrite if the destination is a directory */
2504 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2505 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2506 cancellable, &my_error);
2509 file_type = g_file_info_get_file_type (info);
2510 g_object_unref (info);
2512 if (file_type == G_FILE_TYPE_DIRECTORY)
2514 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
2515 _("Can’t copy over directory"));
2520 if (!g_file_delete (destination, cancellable, error))
2523 tried_delete = TRUE;
2527 g_propagate_error (error, my_error);
2534 static GFileInputStream *
2535 open_source_for_copy (GFile *source,
2537 GFileCopyFlags flags,
2538 GCancellable *cancellable,
2542 GFileInputStream *ret;
2544 GFileType file_type;
2547 ret = g_file_read (source, cancellable, &my_error);
2551 /* There was an error opening the source, try to set a good error for it: */
2552 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
2554 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2555 * as that is less useful to the app. Better check for errors on the
2558 g_error_free (my_error);
2561 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2562 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2563 cancellable, &my_error);
2565 g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_TYPE))
2567 file_type = g_file_info_get_file_type (info);
2568 g_object_unref (info);
2570 if (flags & G_FILE_COPY_OVERWRITE)
2572 if (file_type == G_FILE_TYPE_DIRECTORY)
2574 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
2575 _("Can’t copy directory over directory"));
2578 /* continue to would_recurse error */
2582 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
2583 _("Target file exists"));
2589 /* Error getting info from target, return that error
2590 * (except for NOT_FOUND, which is no error here)
2592 g_clear_object (&info);
2593 if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
2595 g_propagate_error (error, my_error);
2598 g_clear_error (&my_error);
2601 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
2602 _("Can’t recursively copy directory"));
2606 g_propagate_error (error, my_error);
2611 should_copy (GFileAttributeInfo *info,
2612 gboolean copy_all_attributes,
2613 gboolean skip_perms)
2615 if (skip_perms && strcmp(info->name, "unix::mode") == 0)
2618 if (copy_all_attributes)
2619 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
2620 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
2624 build_attribute_list_for_copy (GFile *file,
2625 GFileCopyFlags flags,
2626 char **out_attributes,
2627 GCancellable *cancellable,
2630 gboolean ret = FALSE;
2631 GFileAttributeInfoList *attributes = NULL, *namespaces = NULL;
2635 gboolean copy_all_attributes;
2636 gboolean skip_perms;
2638 copy_all_attributes = flags & G_FILE_COPY_ALL_METADATA;
2639 skip_perms = (flags & G_FILE_COPY_TARGET_DEFAULT_PERMS) != 0;
2641 /* Ignore errors here, if the target supports no attributes there is
2642 * nothing to copy. We still honor the cancellable though.
2644 attributes = g_file_query_settable_attributes (file, cancellable, NULL);
2645 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2648 namespaces = g_file_query_writable_namespaces (file, cancellable, NULL);
2649 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2652 if (attributes == NULL && namespaces == NULL)
2656 s = g_string_new ("");
2660 for (i = 0; i < attributes->n_infos; i++)
2662 if (should_copy (&attributes->infos[i], copy_all_attributes, skip_perms))
2667 g_string_append_c (s, ',');
2669 g_string_append (s, attributes->infos[i].name);
2676 for (i = 0; i < namespaces->n_infos; i++)
2678 if (should_copy (&namespaces->infos[i], copy_all_attributes, FALSE))
2683 g_string_append_c (s, ',');
2685 g_string_append (s, namespaces->infos[i].name);
2686 g_string_append (s, "::*");
2692 *out_attributes = g_string_free (s, FALSE);
2696 g_string_free (s, TRUE);
2698 g_file_attribute_info_list_unref (attributes);
2700 g_file_attribute_info_list_unref (namespaces);
2706 * g_file_copy_attributes:
2707 * @source: a #GFile with attributes
2708 * @destination: a #GFile to copy attributes to
2709 * @flags: a set of #GFileCopyFlags
2710 * @cancellable: (allow-none): optional #GCancellable object,
2712 * @error: a #GError, %NULL to ignore
2714 * Copies the file attributes from @source to @destination.
2716 * Normally only a subset of the file attributes are copied,
2717 * those that are copies in a normal file copy operation
2718 * (which for instance does not include e.g. owner). However
2719 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2720 * all the metadata that is possible to copy is copied. This
2721 * is useful when implementing move by copy + delete source.
2723 * Returns: %TRUE if the attributes were copied successfully,
2727 g_file_copy_attributes (GFile *source,
2729 GFileCopyFlags flags,
2730 GCancellable *cancellable,
2733 char *attrs_to_read;
2736 gboolean source_nofollow_symlinks;
2738 if (!build_attribute_list_for_copy (destination, flags, &attrs_to_read,
2739 cancellable, error))
2742 source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
2744 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2745 * we just don't copy it.
2747 info = g_file_query_info (source, attrs_to_read,
2748 source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
2752 g_free (attrs_to_read);
2757 res = g_file_set_attributes_from_info (destination,
2759 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2762 g_object_unref (info);
2769 copy_stream_with_progress (GInputStream *in,
2772 GCancellable *cancellable,
2773 GFileProgressCallback progress_callback,
2774 gpointer progress_callback_data,
2777 gssize n_read, n_written;
2778 goffset current_size;
2779 char buffer[1024*64], *p;
2785 /* avoid performance impact of querying total size when it's not needed */
2786 if (progress_callback)
2788 info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2789 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2793 if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2794 total_size = g_file_info_get_size (info);
2795 g_object_unref (info);
2798 if (total_size == -1)
2800 info = g_file_query_info (source,
2801 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2802 G_FILE_QUERY_INFO_NONE,
2806 if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2807 total_size = g_file_info_get_size (info);
2808 g_object_unref (info);
2813 if (total_size == -1)
2820 n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2830 current_size += n_read;
2835 n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2836 if (n_written == -1)
2843 n_read -= n_written;
2849 if (progress_callback)
2850 progress_callback (current_size, total_size, progress_callback_data);
2853 /* Make sure we send full copied size */
2854 if (progress_callback)
2855 progress_callback (current_size, total_size, progress_callback_data);
2863 do_splice (int fd_in,
2868 long *bytes_transferd,
2874 result = splice (fd_in, off_in, fd_out, off_out, len, SPLICE_F_MORE);
2882 else if (errsv == ENOSYS || errsv == EINVAL)
2883 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2884 _("Splice not supported"));
2886 g_set_error (error, G_IO_ERROR,
2887 g_io_error_from_errno (errsv),
2888 _("Error splicing file: %s"),
2889 g_strerror (errsv));
2894 *bytes_transferd = result;
2899 splice_stream_with_progress (GInputStream *in,
2901 GCancellable *cancellable,
2902 GFileProgressCallback progress_callback,
2903 gpointer progress_callback_data,
2906 int buffer[2] = { -1, -1 };
2913 fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
2914 fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
2916 if (!g_unix_open_pipe (buffer, FD_CLOEXEC, error))
2920 /* avoid performance impact of querying total size when it's not needed */
2921 if (progress_callback)
2925 if (fstat (fd_in, &sbuf) == 0)
2926 total_size = sbuf.st_size;
2929 if (total_size == -1)
2932 offset_in = offset_out = 0;
2939 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2942 if (!do_splice (fd_in, &offset_in, buffer[1], NULL, 1024*64, &n_read, error))
2953 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2956 if (!do_splice (buffer[0], NULL, fd_out, &offset_out, n_read, &n_written, error))
2959 n_read -= n_written;
2962 if (progress_callback)
2963 progress_callback (offset_in, total_size, progress_callback_data);
2966 /* Make sure we send full copied size */
2967 if (progress_callback)
2968 progress_callback (offset_in, total_size, progress_callback_data);
2970 if (!g_close (buffer[0], error))
2973 if (!g_close (buffer[1], error))
2977 if (buffer[0] != -1)
2978 (void) g_close (buffer[0], NULL);
2979 if (buffer[1] != -1)
2980 (void) g_close (buffer[1], NULL);
2988 btrfs_reflink_with_progress (GInputStream *in,
2991 GCancellable *cancellable,
2992 GFileProgressCallback progress_callback,
2993 gpointer progress_callback_data,
2996 goffset source_size;
3000 fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
3001 fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
3003 if (progress_callback)
3004 source_size = g_file_info_get_size (info);
3006 /* Btrfs clone ioctl properties:
3007 * - Works at the inode level
3008 * - Doesn't work with directories
3009 * - Always follows symlinks (source and destination)
3011 * By the time we get here, *in and *out are both regular files */
3012 ret = ioctl (fd_out, BTRFS_IOC_CLONE, fd_in);
3017 g_set_error_literal (error, G_IO_ERROR,
3018 G_IO_ERROR_NOT_SUPPORTED,
3019 _("Copy (reflink/clone) between mounts is not supported"));
3020 else if (errno == EINVAL)
3021 g_set_error_literal (error, G_IO_ERROR,
3022 G_IO_ERROR_NOT_SUPPORTED,
3023 _("Copy (reflink/clone) is not supported or invalid"));
3025 /* Most probably something odd happened; retry with fallback */
3026 g_set_error_literal (error, G_IO_ERROR,
3027 G_IO_ERROR_NOT_SUPPORTED,
3028 _("Copy (reflink/clone) is not supported or didn’t work"));
3029 /* We retry with fallback for all error cases because Btrfs is currently
3030 * unstable, and so we can't trust it to do clone properly.
3031 * In addition, any hard errors here would cause the same failure in the
3032 * fallback manual copy as well. */
3036 /* Make sure we send full copied size */
3037 if (progress_callback)
3038 progress_callback (source_size, source_size, progress_callback_data);
3045 file_copy_fallback (GFile *source,
3047 GFileCopyFlags flags,
3048 GCancellable *cancellable,
3049 GFileProgressCallback progress_callback,
3050 gpointer progress_callback_data,
3053 gboolean ret = FALSE;
3054 GFileInputStream *file_in = NULL;
3055 GInputStream *in = NULL;
3056 GOutputStream *out = NULL;
3057 GFileInfo *info = NULL;
3059 char *attrs_to_read;
3060 gboolean do_set_attributes = FALSE;
3062 /* need to know the file type */
3063 info = g_file_query_info (source,
3064 G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
3065 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3071 /* Maybe copy the symlink? */
3072 if ((flags & G_FILE_COPY_NOFOLLOW_SYMLINKS) &&
3073 g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK)
3075 target = g_file_info_get_symlink_target (info);
3078 if (!copy_symlink (destination, flags, cancellable, target, error))
3084 /* ... else fall back on a regular file copy */
3086 /* Handle "special" files (pipes, device nodes, ...)? */
3087 else if (g_file_info_get_file_type (info) == G_FILE_TYPE_SPECIAL)
3089 /* FIXME: could try to recreate device nodes and others? */
3090 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3091 _("Can’t copy special file"));
3095 /* Everything else should just fall back on a regular copy. */
3097 file_in = open_source_for_copy (source, destination, flags, cancellable, error);
3100 in = G_INPUT_STREAM (file_in);
3102 if (!build_attribute_list_for_copy (destination, flags, &attrs_to_read,
3103 cancellable, error))
3106 if (attrs_to_read != NULL)
3108 GError *tmp_error = NULL;
3110 /* Ok, ditch the previous lightweight info (on Unix we just
3111 * called lstat()); at this point we gather all the information
3112 * we need about the source from the opened file descriptor.
3114 g_object_unref (info);
3116 info = g_file_input_stream_query_info (file_in, attrs_to_read,
3117 cancellable, &tmp_error);
3120 /* Not all gvfs backends implement query_info_on_read(), we
3121 * can just fall back to the pathname again.
3122 * https://bugzilla.gnome.org/706254
3124 if (g_error_matches (tmp_error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
3126 g_clear_error (&tmp_error);
3127 info = g_file_query_info (source, attrs_to_read, G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3128 cancellable, error);
3132 g_free (attrs_to_read);
3133 g_propagate_error (error, tmp_error);
3137 g_free (attrs_to_read);
3141 do_set_attributes = TRUE;
3144 /* In the local file path, we pass down the source info which
3145 * includes things like unix::mode, to ensure that the target file
3146 * is not created with different permissions from the source file.
3148 * If a future API like g_file_replace_with_info() is added, switch
3149 * this code to use that.
3151 if (G_IS_LOCAL_FILE (destination))
3153 if (flags & G_FILE_COPY_OVERWRITE)
3154 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3156 flags & G_FILE_COPY_BACKUP,
3157 G_FILE_CREATE_REPLACE_DESTINATION,
3159 cancellable, error);
3161 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3163 cancellable, error);
3165 else if (flags & G_FILE_COPY_OVERWRITE)
3167 out = (GOutputStream *)g_file_replace (destination,
3169 flags & G_FILE_COPY_BACKUP,
3170 G_FILE_CREATE_REPLACE_DESTINATION,
3171 cancellable, error);
3175 out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
3182 if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
3184 GError *reflink_err = NULL;
3186 if (!btrfs_reflink_with_progress (in, out, info, cancellable,
3187 progress_callback, progress_callback_data,
3190 if (g_error_matches (reflink_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
3192 g_clear_error (&reflink_err);
3196 g_propagate_error (error, reflink_err);
3209 if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
3211 GError *splice_err = NULL;
3213 if (!splice_stream_with_progress (in, out, cancellable,
3214 progress_callback, progress_callback_data,
3217 if (g_error_matches (splice_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
3219 g_clear_error (&splice_err);
3223 g_propagate_error (error, splice_err);
3236 /* A plain read/write loop */
3237 if (!copy_stream_with_progress (in, out, source, cancellable,
3238 progress_callback, progress_callback_data,
3246 /* Don't care about errors in source here */
3247 (void) g_input_stream_close (in, cancellable, NULL);
3248 g_object_unref (in);
3253 /* But write errors on close are bad! */
3254 if (!g_output_stream_close (out, cancellable, ret ? error : NULL))
3256 g_object_unref (out);
3259 /* Ignore errors here. Failure to copy metadata is not a hard error */
3260 /* TODO: set these attributes /before/ we do the rename() on Unix */
3261 if (ret && do_set_attributes)
3263 g_file_set_attributes_from_info (destination,
3265 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3270 g_clear_object (&info);
3277 * @source: input #GFile
3278 * @destination: destination #GFile
3279 * @flags: set of #GFileCopyFlags
3280 * @cancellable: (allow-none): optional #GCancellable object,
3282 * @progress_callback: (allow-none) (scope call): function to callback with
3283 * progress information, or %NULL if progress information is not needed
3284 * @progress_callback_data: (closure): user data to pass to @progress_callback
3285 * @error: #GError to set on error, or %NULL
3287 * Copies the file @source to the location specified by @destination.
3288 * Can not handle recursive copies of directories.
3290 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3291 * existing @destination file is overwritten.
3293 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3294 * will be copied as symlinks, otherwise the target of the
3295 * @source symlink will be copied.
3297 * If @cancellable is not %NULL, then the operation can be cancelled by
3298 * triggering the cancellable object from another thread. If the operation
3299 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3301 * If @progress_callback is not %NULL, then the operation can be monitored
3302 * by setting this to a #GFileProgressCallback function.
3303 * @progress_callback_data will be passed to this function. It is guaranteed
3304 * that this callback will be called after all data has been transferred with
3305 * the total number of bytes copied during the operation.
3307 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3308 * is returned, independent on the status of the @destination.
3310 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3311 * the error %G_IO_ERROR_EXISTS is returned.
3313 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3314 * error is returned. If trying to overwrite a directory with a directory the
3315 * %G_IO_ERROR_WOULD_MERGE error is returned.
3317 * If the source is a directory and the target does not exist, or
3318 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3319 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3321 * If you are interested in copying the #GFile object itself (not the on-disk
3322 * file), see g_file_dup().
3324 * Returns: %TRUE on success, %FALSE otherwise.
3327 g_file_copy (GFile *source,
3329 GFileCopyFlags flags,
3330 GCancellable *cancellable,
3331 GFileProgressCallback progress_callback,
3332 gpointer progress_callback_data,
3339 g_return_val_if_fail (G_IS_FILE (source), FALSE);
3340 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3342 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3345 iface = G_FILE_GET_IFACE (destination);
3349 res = (* iface->copy) (source, destination,
3351 progress_callback, progress_callback_data,
3357 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3359 g_propagate_error (error, my_error);
3363 g_clear_error (&my_error);
3366 /* If the types are different, and the destination method failed
3367 * also try the source method
3369 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3371 iface = G_FILE_GET_IFACE (source);
3376 res = (* iface->copy) (source, destination,
3378 progress_callback, progress_callback_data,
3384 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3386 g_propagate_error (error, my_error);
3390 g_clear_error (&my_error);
3394 return file_copy_fallback (source, destination, flags, cancellable,
3395 progress_callback, progress_callback_data,
3400 * g_file_copy_async: (skip)
3401 * @source: input #GFile
3402 * @destination: destination #GFile
3403 * @flags: set of #GFileCopyFlags
3404 * @io_priority: the [I/O priority][io-priority] of the request
3405 * @cancellable: (allow-none): optional #GCancellable object,
3407 * @progress_callback: (allow-none): function to callback with progress
3408 * information, or %NULL if progress information is not needed
3409 * @progress_callback_data: (closure): user data to pass to @progress_callback
3410 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3411 * @user_data: the data to pass to callback function
3413 * Copies the file @source to the location specified by @destination
3414 * asynchronously. For details of the behaviour, see g_file_copy().
3416 * If @progress_callback is not %NULL, then that function that will be called
3417 * just like in g_file_copy(). The callback will run in the default main context
3418 * of the thread calling g_file_copy_async() — the same context as @callback is
3421 * When the operation is finished, @callback will be called. You can then call
3422 * g_file_copy_finish() to get the result of the operation.
3425 g_file_copy_async (GFile *source,
3427 GFileCopyFlags flags,
3429 GCancellable *cancellable,
3430 GFileProgressCallback progress_callback,
3431 gpointer progress_callback_data,
3432 GAsyncReadyCallback callback,
3437 g_return_if_fail (G_IS_FILE (source));
3438 g_return_if_fail (G_IS_FILE (destination));
3440 iface = G_FILE_GET_IFACE (source);
3441 (* iface->copy_async) (source,
3447 progress_callback_data,
3453 * g_file_copy_finish:
3454 * @file: input #GFile
3455 * @res: a #GAsyncResult
3456 * @error: a #GError, or %NULL
3458 * Finishes copying the file started with g_file_copy_async().
3460 * Returns: a %TRUE on success, %FALSE on error.
3463 g_file_copy_finish (GFile *file,
3469 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3470 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
3472 if (g_async_result_legacy_propagate_error (res, error))
3475 iface = G_FILE_GET_IFACE (file);
3476 return (* iface->copy_finish) (file, res, error);
3481 * @source: #GFile pointing to the source location
3482 * @destination: #GFile pointing to the destination location
3483 * @flags: set of #GFileCopyFlags
3484 * @cancellable: (allow-none): optional #GCancellable object,
3486 * @progress_callback: (allow-none) (scope call): #GFileProgressCallback
3487 * function for updates
3488 * @progress_callback_data: (closure): gpointer to user data for
3489 * the callback function
3490 * @error: #GError for returning error conditions, or %NULL
3492 * Tries to move the file or directory @source to the location specified
3493 * by @destination. If native move operations are supported then this is
3494 * used, otherwise a copy + delete fallback is used. The native
3495 * implementation may support moving directories (for instance on moves
3496 * inside the same filesystem), but the fallback code does not.
3498 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3499 * existing @destination file is overwritten.
3501 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3502 * will be copied as symlinks, otherwise the target of the
3503 * @source symlink will be copied.
3505 * If @cancellable is not %NULL, then the operation can be cancelled by
3506 * triggering the cancellable object from another thread. If the operation
3507 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3509 * If @progress_callback is not %NULL, then the operation can be monitored
3510 * by setting this to a #GFileProgressCallback function.
3511 * @progress_callback_data will be passed to this function. It is
3512 * guaranteed that this callback will be called after all data has been
3513 * transferred with the total number of bytes copied during the operation.
3515 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3516 * error is returned, independent on the status of the @destination.
3518 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3519 * then the error %G_IO_ERROR_EXISTS is returned.
3521 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3522 * error is returned. If trying to overwrite a directory with a directory the
3523 * %G_IO_ERROR_WOULD_MERGE error is returned.
3525 * If the source is a directory and the target does not exist, or
3526 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3527 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3528 * move operation isn't available).
3530 * Returns: %TRUE on successful move, %FALSE otherwise.
3533 g_file_move (GFile *source,
3535 GFileCopyFlags flags,
3536 GCancellable *cancellable,
3537 GFileProgressCallback progress_callback,
3538 gpointer progress_callback_data,
3545 g_return_val_if_fail (G_IS_FILE (source), FALSE);
3546 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3548 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3551 iface = G_FILE_GET_IFACE (destination);
3555 res = (* iface->move) (source, destination,
3557 progress_callback, progress_callback_data,
3563 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3565 g_propagate_error (error, my_error);
3569 g_clear_error (&my_error);
3572 /* If the types are different, and the destination method failed
3573 * also try the source method
3575 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3577 iface = G_FILE_GET_IFACE (source);
3582 res = (* iface->move) (source, destination,
3584 progress_callback, progress_callback_data,
3590 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3592 g_propagate_error (error, my_error);
3596 g_clear_error (&my_error);
3600 if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
3602 g_set_error_literal (error, G_IO_ERROR,
3603 G_IO_ERROR_NOT_SUPPORTED,
3604 _("Operation not supported"));
3608 flags |= G_FILE_COPY_ALL_METADATA;
3609 if (!g_file_copy (source, destination, flags, cancellable,
3610 progress_callback, progress_callback_data,
3614 return g_file_delete (source, cancellable, error);
3618 * g_file_make_directory:
3619 * @file: input #GFile
3620 * @cancellable: (allow-none): optional #GCancellable object,
3622 * @error: a #GError, or %NULL
3624 * Creates a directory. Note that this will only create a child directory
3625 * of the immediate parent directory of the path or URI given by the #GFile.
3626 * To recursively create directories, see g_file_make_directory_with_parents().
3627 * This function will fail if the parent directory does not exist, setting
3628 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3629 * creating directories, this function will fail, setting @error to
3630 * %G_IO_ERROR_NOT_SUPPORTED.
3632 * For a local #GFile the newly created directory will have the default
3633 * (current) ownership and permissions of the current process.
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.
3639 * Returns: %TRUE on successful creation, %FALSE otherwise.
3642 g_file_make_directory (GFile *file,
3643 GCancellable *cancellable,
3648 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3650 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3653 iface = G_FILE_GET_IFACE (file);
3655 if (iface->make_directory == NULL)
3657 g_set_error_literal (error, G_IO_ERROR,
3658 G_IO_ERROR_NOT_SUPPORTED,
3659 _("Operation not supported"));
3663 return (* iface->make_directory) (file, cancellable, error);
3667 * g_file_make_directory_async:
3668 * @file: input #GFile
3669 * @io_priority: the [I/O priority][io-priority] of the request
3670 * @cancellable: (allow-none): optional #GCancellable object,
3672 * @callback: a #GAsyncReadyCallback to call
3673 * when the request is satisfied
3674 * @user_data: the data to pass to callback function
3676 * Asynchronously creates a directory.
3678 * Virtual: make_directory_async
3682 g_file_make_directory_async (GFile *file,
3684 GCancellable *cancellable,
3685 GAsyncReadyCallback callback,
3690 g_return_if_fail (G_IS_FILE (file));
3692 iface = G_FILE_GET_IFACE (file);
3693 (* iface->make_directory_async) (file,
3701 * g_file_make_directory_finish:
3702 * @file: input #GFile
3703 * @result: a #GAsyncResult
3704 * @error: a #GError, or %NULL
3706 * Finishes an asynchronous directory creation, started with
3707 * g_file_make_directory_async().
3709 * Virtual: make_directory_finish
3710 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3714 g_file_make_directory_finish (GFile *file,
3715 GAsyncResult *result,
3720 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3721 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3723 iface = G_FILE_GET_IFACE (file);
3724 return (* iface->make_directory_finish) (file, result, error);
3728 * g_file_make_directory_with_parents:
3729 * @file: input #GFile
3730 * @cancellable: (allow-none): optional #GCancellable object,
3732 * @error: a #GError, or %NULL
3734 * Creates a directory and any parent directories that may not
3735 * exist similar to 'mkdir -p'. If the file system does not support
3736 * creating directories, this function will fail, setting @error to
3737 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3738 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3739 * the similar g_mkdir_with_parents().
3741 * For a local #GFile the newly created directories will have the default
3742 * (current) ownership and permissions of the current process.
3744 * If @cancellable is not %NULL, then the operation can be cancelled by
3745 * triggering the cancellable object from another thread. If the operation
3746 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3748 * Returns: %TRUE if all directories have been successfully created, %FALSE
3754 g_file_make_directory_with_parents (GFile *file,
3755 GCancellable *cancellable,
3758 GFile *work_file = NULL;
3759 GList *list = NULL, *l;
3760 GError *my_error = NULL;
3762 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3764 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3767 /* Try for the simple case of not having to create any parent
3768 * directories. If any parent directory needs to be created, this
3769 * call will fail with NOT_FOUND. If that happens, then that value of
3770 * my_error persists into the while loop below.
3772 g_file_make_directory (file, cancellable, &my_error);
3773 if (!g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
3776 g_propagate_error (error, my_error);
3777 return my_error == NULL;
3780 work_file = g_object_ref (file);
3782 /* Creates the parent directories as needed. In case any particular
3783 * creation operation fails for lack of other parent directories
3784 * (NOT_FOUND), the directory is added to a list of directories to
3785 * create later, and the value of my_error is retained until the next
3786 * iteration of the loop. After the loop my_error should either be
3787 * empty or contain a real failure condition.
3789 while (g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
3793 parent_file = g_file_get_parent (work_file);
3794 if (parent_file == NULL)
3797 g_clear_error (&my_error);
3798 g_file_make_directory (parent_file, cancellable, &my_error);
3799 /* Another process may have created the directory in between the
3800 * G_IO_ERROR_NOT_FOUND and now
3802 if (g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_EXISTS))
3803 g_clear_error (&my_error);
3805 g_object_unref (work_file);
3806 work_file = g_object_ref (parent_file);
3808 if (g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
3809 list = g_list_prepend (list, parent_file); /* Transfer ownership of ref */
3811 g_object_unref (parent_file);
3814 /* All directories should be able to be created now, so an error at
3815 * this point means the whole operation must fail -- except an EXISTS
3816 * error, which means that another process already created the
3817 * directory in between the previous failure and now.
3819 for (l = list; my_error == NULL && l; l = l->next)
3821 g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
3822 if (g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_EXISTS))
3823 g_clear_error (&my_error);
3827 g_object_unref (work_file);
3830 while (list != NULL)
3832 g_object_unref ((GFile *) list->data);
3833 list = g_list_remove (list, list->data);
3836 /* At this point an error in my_error means a that something
3837 * unexpected failed in either of the loops above, so the whole
3838 * operation must fail.
3840 if (my_error != NULL)
3842 g_propagate_error (error, my_error);
3846 return g_file_make_directory (file, cancellable, error);
3850 * g_file_make_symbolic_link:
3851 * @file: a #GFile with the name of the symlink to create
3852 * @symlink_value: (type filename): a string with the path for the target
3853 * of the new symlink
3854 * @cancellable: (allow-none): optional #GCancellable object,
3858 * Creates a symbolic link named @file which contains the string
3861 * If @cancellable is not %NULL, then the operation can be cancelled by
3862 * triggering the cancellable object from another thread. If the operation
3863 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3865 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3868 g_file_make_symbolic_link (GFile *file,
3869 const char *symlink_value,
3870 GCancellable *cancellable,
3875 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3876 g_return_val_if_fail (symlink_value != NULL, FALSE);
3878 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3881 if (*symlink_value == '\0')
3883 g_set_error_literal (error, G_IO_ERROR,
3884 G_IO_ERROR_INVALID_ARGUMENT,
3885 _("Invalid symlink value given"));
3889 iface = G_FILE_GET_IFACE (file);
3891 if (iface->make_symbolic_link == NULL)
3893 g_set_error_literal (error, G_IO_ERROR,
3894 G_IO_ERROR_NOT_SUPPORTED,
3895 _("Operation not supported"));
3899 return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
3904 * @file: input #GFile
3905 * @cancellable: (allow-none): optional #GCancellable object,
3907 * @error: a #GError, or %NULL
3909 * Deletes a file. If the @file is a directory, it will only be
3910 * deleted if it is empty. This has the same semantics as g_unlink().
3912 * If @cancellable is not %NULL, then the operation can be cancelled by
3913 * triggering the cancellable object from another thread. If the operation
3914 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3916 * Virtual: delete_file
3917 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3920 g_file_delete (GFile *file,
3921 GCancellable *cancellable,
3926 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3928 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3931 iface = G_FILE_GET_IFACE (file);
3933 if (iface->delete_file == NULL)
3935 g_set_error_literal (error, G_IO_ERROR,
3936 G_IO_ERROR_NOT_SUPPORTED,
3937 _("Operation not supported"));
3941 return (* iface->delete_file) (file, cancellable, error);
3945 * g_file_delete_async:
3946 * @file: input #GFile
3947 * @io_priority: the [I/O priority][io-priority] of the request
3948 * @cancellable: (allow-none): optional #GCancellable object,
3950 * @callback: a #GAsyncReadyCallback to call
3951 * when the request is satisfied
3952 * @user_data: the data to pass to callback function
3954 * Asynchronously delete a file. If the @file is a directory, it will
3955 * only be deleted if it is empty. This has the same semantics as
3958 * Virtual: delete_file_async
3962 g_file_delete_async (GFile *file,
3964 GCancellable *cancellable,
3965 GAsyncReadyCallback callback,
3970 g_return_if_fail (G_IS_FILE (file));
3972 iface = G_FILE_GET_IFACE (file);
3973 (* iface->delete_file_async) (file,
3981 * g_file_delete_finish:
3982 * @file: input #GFile
3983 * @result: a #GAsyncResult
3984 * @error: a #GError, or %NULL
3986 * Finishes deleting a file started with g_file_delete_async().
3988 * Virtual: delete_file_finish
3989 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3993 g_file_delete_finish (GFile *file,
3994 GAsyncResult *result,
3999 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4000 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4002 if (g_async_result_legacy_propagate_error (result, error))
4005 iface = G_FILE_GET_IFACE (file);
4006 return (* iface->delete_file_finish) (file, result, error);
4011 * @file: #GFile to send to trash
4012 * @cancellable: (allow-none): optional #GCancellable object,
4014 * @error: a #GError, or %NULL
4016 * Sends @file to the "Trashcan", if possible. This is similar to
4017 * deleting it, but the user can recover it before emptying the trashcan.
4018 * Not all file systems support trashing, so this call can return the
4019 * %G_IO_ERROR_NOT_SUPPORTED error.
4021 * If @cancellable is not %NULL, then the operation can be cancelled by
4022 * triggering the cancellable object from another thread. If the operation
4023 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4026 * Returns: %TRUE on successful trash, %FALSE otherwise.
4029 g_file_trash (GFile *file,
4030 GCancellable *cancellable,
4035 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4037 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4040 iface = G_FILE_GET_IFACE (file);
4042 if (iface->trash == NULL)
4044 g_set_error_literal (error,
4045 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4046 _("Trash not supported"));
4050 return (* iface->trash) (file, cancellable, error);
4054 * g_file_trash_async:
4055 * @file: input #GFile
4056 * @io_priority: the [I/O priority][io-priority] of the request
4057 * @cancellable: (allow-none): optional #GCancellable object,
4059 * @callback: a #GAsyncReadyCallback to call
4060 * when the request is satisfied
4061 * @user_data: the data to pass to callback function
4063 * Asynchronously sends @file to the Trash location, if possible.
4065 * Virtual: trash_async
4069 g_file_trash_async (GFile *file,
4071 GCancellable *cancellable,
4072 GAsyncReadyCallback callback,
4077 g_return_if_fail (G_IS_FILE (file));
4079 iface = G_FILE_GET_IFACE (file);
4080 (* iface->trash_async) (file,
4088 * g_file_trash_finish:
4089 * @file: input #GFile
4090 * @result: a #GAsyncResult
4091 * @error: a #GError, or %NULL
4093 * Finishes an asynchronous file trashing operation, started with
4094 * g_file_trash_async().
4096 * Virtual: trash_finish
4097 * Returns: %TRUE on successful trash, %FALSE otherwise.
4101 g_file_trash_finish (GFile *file,
4102 GAsyncResult *result,
4107 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4108 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4110 iface = G_FILE_GET_IFACE (file);
4111 return (* iface->trash_finish) (file, result, error);
4115 * g_file_set_display_name:
4116 * @file: input #GFile
4117 * @display_name: a string
4118 * @cancellable: (allow-none): optional #GCancellable object,
4120 * @error: a #GError, or %NULL
4122 * Renames @file to the specified display name.
4124 * The display name is converted from UTF-8 to the correct encoding
4125 * for the target filesystem if possible and the @file is renamed to this.
4127 * If you want to implement a rename operation in the user interface the
4128 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4129 * initial value in the rename widget, and then the result after editing
4130 * should be passed to g_file_set_display_name().
4132 * On success the resulting converted filename is returned.
4134 * If @cancellable is not %NULL, then the operation can be cancelled by
4135 * triggering the cancellable object from another thread. If the operation
4136 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4138 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4139 * or %NULL if there was an error.
4140 * Free the returned object with g_object_unref().
4143 g_file_set_display_name (GFile *file,
4144 const gchar *display_name,
4145 GCancellable *cancellable,
4150 g_return_val_if_fail (G_IS_FILE (file), NULL);
4151 g_return_val_if_fail (display_name != NULL, NULL);
4153 if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
4157 G_IO_ERROR_INVALID_ARGUMENT,
4158 _("File names cannot contain “%c”"), G_DIR_SEPARATOR);
4162 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4165 iface = G_FILE_GET_IFACE (file);
4167 return (* iface->set_display_name) (file, display_name, cancellable, error);
4171 * g_file_set_display_name_async:
4172 * @file: input #GFile
4173 * @display_name: a string
4174 * @io_priority: the [I/O priority][io-priority] of the request
4175 * @cancellable: (allow-none): optional #GCancellable object,
4177 * @callback: (scope async): a #GAsyncReadyCallback to call
4178 * when the request is satisfied
4179 * @user_data: (closure): the data to pass to callback function
4181 * Asynchronously sets the display name for a given #GFile.
4183 * For more details, see g_file_set_display_name() which is
4184 * the synchronous version of this call.
4186 * When the operation is finished, @callback will be called.
4187 * You can then call g_file_set_display_name_finish() to get
4188 * the result of the operation.
4191 g_file_set_display_name_async (GFile *file,
4192 const gchar *display_name,
4194 GCancellable *cancellable,
4195 GAsyncReadyCallback callback,
4200 g_return_if_fail (G_IS_FILE (file));
4201 g_return_if_fail (display_name != NULL);
4203 iface = G_FILE_GET_IFACE (file);
4204 (* iface->set_display_name_async) (file,
4213 * g_file_set_display_name_finish:
4214 * @file: input #GFile
4215 * @res: a #GAsyncResult
4216 * @error: a #GError, or %NULL
4218 * Finishes setting a display name started with
4219 * g_file_set_display_name_async().
4221 * Returns: (transfer full): a #GFile or %NULL on error.
4222 * Free the returned object with g_object_unref().
4225 g_file_set_display_name_finish (GFile *file,
4231 g_return_val_if_fail (G_IS_FILE (file), NULL);
4232 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
4234 if (g_async_result_legacy_propagate_error (res, error))
4237 iface = G_FILE_GET_IFACE (file);
4238 return (* iface->set_display_name_finish) (file, res, error);
4242 * g_file_query_settable_attributes:
4243 * @file: input #GFile
4244 * @cancellable: (allow-none): optional #GCancellable object,
4246 * @error: a #GError, or %NULL
4248 * Obtain the list of settable attributes for the file.
4250 * Returns the type and full attribute name of all the attributes
4251 * that can be set on this file. This doesn't mean setting it will
4252 * always succeed though, you might get an access failure, or some
4253 * specific file may not support a specific attribute.
4255 * If @cancellable is not %NULL, then the operation can be cancelled by
4256 * triggering the cancellable object from another thread. If the operation
4257 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4259 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4260 * When you are done with it, release it with
4261 * g_file_attribute_info_list_unref()
4263 GFileAttributeInfoList *
4264 g_file_query_settable_attributes (GFile *file,
4265 GCancellable *cancellable,
4270 GFileAttributeInfoList *list;
4272 g_return_val_if_fail (G_IS_FILE (file), NULL);
4274 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4277 iface = G_FILE_GET_IFACE (file);
4279 if (iface->query_settable_attributes == NULL)
4280 return g_file_attribute_info_list_new ();
4283 list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
4287 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
4289 list = g_file_attribute_info_list_new ();
4290 g_error_free (my_error);
4293 g_propagate_error (error, my_error);
4300 * g_file_query_writable_namespaces:
4301 * @file: input #GFile
4302 * @cancellable: (allow-none): optional #GCancellable object,
4304 * @error: a #GError, or %NULL
4306 * Obtain the list of attribute namespaces where new attributes
4307 * can be created by a user. An example of this is extended
4308 * attributes (in the "xattr" namespace).
4310 * If @cancellable is not %NULL, then the operation can be cancelled by
4311 * triggering the cancellable object from another thread. If the operation
4312 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4314 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4315 * When you are done with it, release it with
4316 * g_file_attribute_info_list_unref()
4318 GFileAttributeInfoList *
4319 g_file_query_writable_namespaces (GFile *file,
4320 GCancellable *cancellable,
4325 GFileAttributeInfoList *list;
4327 g_return_val_if_fail (G_IS_FILE (file), NULL);
4329 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4332 iface = G_FILE_GET_IFACE (file);
4334 if (iface->query_writable_namespaces == NULL)
4335 return g_file_attribute_info_list_new ();
4338 list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
4342 g_warn_if_reached();
4343 list = g_file_attribute_info_list_new ();
4346 if (my_error != NULL)
4348 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
4350 g_error_free (my_error);
4353 g_propagate_error (error, my_error);
4360 * g_file_set_attribute:
4361 * @file: input #GFile
4362 * @attribute: a string containing the attribute's name
4363 * @type: The type of the attribute
4364 * @value_p: (allow-none): a pointer to the value (or the pointer
4365 * itself if the type is a pointer type)
4366 * @flags: a set of #GFileQueryInfoFlags
4367 * @cancellable: (allow-none): optional #GCancellable object,
4369 * @error: a #GError, or %NULL
4371 * Sets an attribute in the file with attribute name @attribute to @value.
4373 * Some attributes can be unset by setting @attribute to
4374 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4376 * If @cancellable is not %NULL, then the operation can be cancelled by
4377 * triggering the cancellable object from another thread. If the operation
4378 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4380 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4383 g_file_set_attribute (GFile *file,
4384 const gchar *attribute,
4385 GFileAttributeType type,
4387 GFileQueryInfoFlags flags,
4388 GCancellable *cancellable,
4393 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4394 g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
4396 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4399 iface = G_FILE_GET_IFACE (file);
4401 if (iface->set_attribute == NULL)
4403 g_set_error_literal (error, G_IO_ERROR,
4404 G_IO_ERROR_NOT_SUPPORTED,
4405 _("Operation not supported"));
4409 return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
4413 * g_file_set_attributes_from_info:
4414 * @file: input #GFile
4415 * @info: a #GFileInfo
4416 * @flags: #GFileQueryInfoFlags
4417 * @cancellable: (allow-none): optional #GCancellable object,
4419 * @error: a #GError, or %NULL
4421 * Tries to set all attributes in the #GFileInfo on the target
4422 * values, not stopping on the first error.
4424 * If there is any error during this operation then @error will
4425 * be set to the first error. Error on particular fields are flagged
4426 * by setting the "status" field in the attribute value to
4427 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4428 * also detect further errors.
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.
4434 * Returns: %FALSE if there was any error, %TRUE otherwise.
4437 g_file_set_attributes_from_info (GFile *file,
4439 GFileQueryInfoFlags flags,
4440 GCancellable *cancellable,
4445 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4446 g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
4448 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4451 g_file_info_clear_status (info);
4453 iface = G_FILE_GET_IFACE (file);
4455 return (* iface->set_attributes_from_info) (file,
4463 g_file_real_set_attributes_from_info (GFile *file,
4465 GFileQueryInfoFlags flags,
4466 GCancellable *cancellable,
4472 GFileAttributeValue *value;
4476 attributes = g_file_info_list_attributes (info, NULL);
4478 for (i = 0; attributes[i] != NULL; i++)
4480 value = _g_file_info_get_attribute_value (info, attributes[i]);
4482 if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
4485 if (!g_file_set_attribute (file, attributes[i],
4486 value->type, _g_file_attribute_value_peek_as_pointer (value),
4487 flags, cancellable, error))
4489 value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
4491 /* Don't set error multiple times */
4495 value->status = G_FILE_ATTRIBUTE_STATUS_SET;
4498 g_strfreev (attributes);
4504 * g_file_set_attributes_async:
4505 * @file: input #GFile
4506 * @info: a #GFileInfo
4507 * @flags: a #GFileQueryInfoFlags
4508 * @io_priority: the [I/O priority][io-priority] of the request
4509 * @cancellable: (allow-none): optional #GCancellable object,
4511 * @callback: (scope async): a #GAsyncReadyCallback
4512 * @user_data: (closure): a #gpointer
4514 * Asynchronously sets the attributes of @file with @info.
4516 * For more details, see g_file_set_attributes_from_info(),
4517 * which is the synchronous version of this call.
4519 * When the operation is finished, @callback will be called.
4520 * You can then call g_file_set_attributes_finish() to get
4521 * the result of the operation.
4524 g_file_set_attributes_async (GFile *file,
4526 GFileQueryInfoFlags flags,
4528 GCancellable *cancellable,
4529 GAsyncReadyCallback callback,
4534 g_return_if_fail (G_IS_FILE (file));
4535 g_return_if_fail (G_IS_FILE_INFO (info));
4537 iface = G_FILE_GET_IFACE (file);
4538 (* iface->set_attributes_async) (file,
4548 * g_file_set_attributes_finish:
4549 * @file: input #GFile
4550 * @result: a #GAsyncResult
4551 * @info: (out) (transfer full): a #GFileInfo
4552 * @error: a #GError, or %NULL
4554 * Finishes setting an attribute started in g_file_set_attributes_async().
4556 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4559 g_file_set_attributes_finish (GFile *file,
4560 GAsyncResult *result,
4566 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4567 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4569 /* No standard handling of errors here, as we must set info even
4572 iface = G_FILE_GET_IFACE (file);
4573 return (* iface->set_attributes_finish) (file, result, info, error);
4577 * g_file_set_attribute_string:
4578 * @file: input #GFile
4579 * @attribute: a string containing the attribute's name
4580 * @value: a string containing the attribute's value
4581 * @flags: #GFileQueryInfoFlags
4582 * @cancellable: (allow-none): optional #GCancellable object,
4584 * @error: a #GError, or %NULL
4586 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4587 * If @attribute is of a different type, this operation will fail.
4589 * If @cancellable is not %NULL, then the operation can be cancelled by
4590 * triggering the cancellable object from another thread. If the operation
4591 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4593 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4596 g_file_set_attribute_string (GFile *file,
4597 const char *attribute,
4599 GFileQueryInfoFlags flags,
4600 GCancellable *cancellable,
4603 return g_file_set_attribute (file, attribute,
4604 G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
4605 flags, cancellable, error);
4609 * g_file_set_attribute_byte_string:
4610 * @file: input #GFile
4611 * @attribute: a string containing the attribute's name
4612 * @value: a string containing the attribute's new value
4613 * @flags: a #GFileQueryInfoFlags
4614 * @cancellable: (allow-none): optional #GCancellable object,
4616 * @error: a #GError, or %NULL
4618 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4619 * If @attribute is of a different type, this operation will fail,
4622 * If @cancellable is not %NULL, then the operation can be cancelled by
4623 * triggering the cancellable object from another thread. If the operation
4624 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4626 * Returns: %TRUE if the @attribute was successfully set to @value
4627 * in the @file, %FALSE otherwise.
4630 g_file_set_attribute_byte_string (GFile *file,
4631 const gchar *attribute,
4633 GFileQueryInfoFlags flags,
4634 GCancellable *cancellable,
4637 return g_file_set_attribute (file, attribute,
4638 G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
4639 flags, cancellable, error);
4643 * g_file_set_attribute_uint32:
4644 * @file: input #GFile
4645 * @attribute: a string containing the attribute's name
4646 * @value: a #guint32 containing the attribute's new value
4647 * @flags: a #GFileQueryInfoFlags
4648 * @cancellable: (allow-none): optional #GCancellable object,
4650 * @error: a #GError, or %NULL
4652 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4653 * If @attribute is of a different type, this operation will fail.
4655 * If @cancellable is not %NULL, then the operation can be cancelled by
4656 * triggering the cancellable object from another thread. If the operation
4657 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4659 * Returns: %TRUE if the @attribute was successfully set to @value
4660 * in the @file, %FALSE otherwise.
4663 g_file_set_attribute_uint32 (GFile *file,
4664 const gchar *attribute,
4666 GFileQueryInfoFlags flags,
4667 GCancellable *cancellable,
4670 return g_file_set_attribute (file, attribute,
4671 G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
4672 flags, cancellable, error);
4676 * g_file_set_attribute_int32:
4677 * @file: input #GFile
4678 * @attribute: a string containing the attribute's name
4679 * @value: a #gint32 containing the attribute's new value
4680 * @flags: a #GFileQueryInfoFlags
4681 * @cancellable: (allow-none): optional #GCancellable object,
4683 * @error: a #GError, or %NULL
4685 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4686 * If @attribute is of a different type, this operation will fail.
4688 * If @cancellable is not %NULL, then the operation can be cancelled by
4689 * triggering the cancellable object from another thread. If the operation
4690 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4692 * Returns: %TRUE if the @attribute was successfully set to @value
4693 * in the @file, %FALSE otherwise.
4696 g_file_set_attribute_int32 (GFile *file,
4697 const gchar *attribute,
4699 GFileQueryInfoFlags flags,
4700 GCancellable *cancellable,
4703 return g_file_set_attribute (file, attribute,
4704 G_FILE_ATTRIBUTE_TYPE_INT32, &value,
4705 flags, cancellable, error);
4709 * g_file_set_attribute_uint64:
4710 * @file: input #GFile
4711 * @attribute: a string containing the attribute's name
4712 * @value: a #guint64 containing the attribute's new value
4713 * @flags: a #GFileQueryInfoFlags
4714 * @cancellable: (allow-none): optional #GCancellable object,
4716 * @error: a #GError, or %NULL
4718 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4719 * If @attribute is of a different type, this operation will fail.
4721 * If @cancellable is not %NULL, then the operation can be cancelled by
4722 * triggering the cancellable object from another thread. If the operation
4723 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4725 * Returns: %TRUE if the @attribute was successfully set to @value
4726 * in the @file, %FALSE otherwise.
4729 g_file_set_attribute_uint64 (GFile *file,
4730 const gchar *attribute,
4732 GFileQueryInfoFlags flags,
4733 GCancellable *cancellable,
4736 return g_file_set_attribute (file, attribute,
4737 G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
4738 flags, cancellable, error);
4742 * g_file_set_attribute_int64:
4743 * @file: input #GFile
4744 * @attribute: a string containing the attribute's name
4745 * @value: a #guint64 containing the attribute's new value
4746 * @flags: a #GFileQueryInfoFlags
4747 * @cancellable: (allow-none): optional #GCancellable object,
4749 * @error: a #GError, or %NULL
4751 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4752 * If @attribute is of a different type, this operation will fail.
4754 * If @cancellable is not %NULL, then the operation can be cancelled by
4755 * triggering the cancellable object from another thread. If the operation
4756 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4758 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4761 g_file_set_attribute_int64 (GFile *file,
4762 const gchar *attribute,
4764 GFileQueryInfoFlags flags,
4765 GCancellable *cancellable,
4768 return g_file_set_attribute (file, attribute,
4769 G_FILE_ATTRIBUTE_TYPE_INT64, &value,
4770 flags, cancellable, error);
4774 * g_file_mount_mountable:
4775 * @file: input #GFile
4776 * @flags: flags affecting the operation
4777 * @mount_operation: (allow-none): a #GMountOperation,
4778 * or %NULL to avoid user interaction
4779 * @cancellable: (allow-none): optional #GCancellable object,
4781 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4782 * when the request is satisfied, or %NULL
4783 * @user_data: (closure): the data to pass to callback function
4785 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4786 * Using @mount_operation, you can request callbacks when, for instance,
4787 * passwords are needed during authentication.
4789 * If @cancellable is not %NULL, then the operation can be cancelled by
4790 * triggering the cancellable object from another thread. If the operation
4791 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4793 * When the operation is finished, @callback will be called.
4794 * You can then call g_file_mount_mountable_finish() to get
4795 * the result of the operation.
4798 g_file_mount_mountable (GFile *file,
4799 GMountMountFlags flags,
4800 GMountOperation *mount_operation,
4801 GCancellable *cancellable,
4802 GAsyncReadyCallback callback,
4807 g_return_if_fail (G_IS_FILE (file));
4809 iface = G_FILE_GET_IFACE (file);
4811 if (iface->mount_mountable == NULL)
4813 g_task_report_new_error (file, callback, user_data,
4814 g_file_mount_mountable,
4815 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4816 _("Operation not supported"));
4820 (* iface->mount_mountable) (file,
4829 * g_file_mount_mountable_finish:
4830 * @file: input #GFile
4831 * @result: a #GAsyncResult
4832 * @error: a #GError, or %NULL
4834 * Finishes a mount operation. See g_file_mount_mountable() for details.
4836 * Finish an asynchronous mount operation that was started
4837 * with g_file_mount_mountable().
4839 * Returns: (transfer full): a #GFile or %NULL on error.
4840 * Free the returned object with g_object_unref().
4843 g_file_mount_mountable_finish (GFile *file,
4844 GAsyncResult *result,
4849 g_return_val_if_fail (G_IS_FILE (file), NULL);
4850 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
4852 if (g_async_result_legacy_propagate_error (result, error))
4854 else if (g_async_result_is_tagged (result, g_file_mount_mountable))
4855 return g_task_propagate_pointer (G_TASK (result), error);
4857 iface = G_FILE_GET_IFACE (file);
4858 return (* iface->mount_mountable_finish) (file, result, error);
4862 * g_file_unmount_mountable:
4863 * @file: input #GFile
4864 * @flags: flags affecting the operation
4865 * @cancellable: (allow-none): optional #GCancellable object,
4867 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4868 * when the request is satisfied, or %NULL
4869 * @user_data: (closure): the data to pass to callback function
4871 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4873 * If @cancellable is not %NULL, then the operation can be cancelled by
4874 * triggering the cancellable object from another thread. If the operation
4875 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4877 * When the operation is finished, @callback will be called.
4878 * You can then call g_file_unmount_mountable_finish() to get
4879 * the result of the operation.
4881 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4884 g_file_unmount_mountable (GFile *file,
4885 GMountUnmountFlags flags,
4886 GCancellable *cancellable,
4887 GAsyncReadyCallback callback,
4892 g_return_if_fail (G_IS_FILE (file));
4894 iface = G_FILE_GET_IFACE (file);
4896 if (iface->unmount_mountable == NULL)
4898 g_task_report_new_error (file, callback, user_data,
4899 g_file_unmount_mountable_with_operation,
4900 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4901 _("Operation not supported"));
4905 (* iface->unmount_mountable) (file,
4913 * g_file_unmount_mountable_finish:
4914 * @file: input #GFile
4915 * @result: a #GAsyncResult
4916 * @error: a #GError, or %NULL
4918 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4920 * Finish an asynchronous unmount operation that was started
4921 * with g_file_unmount_mountable().
4923 * Returns: %TRUE if the operation finished successfully.
4926 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
4930 g_file_unmount_mountable_finish (GFile *file,
4931 GAsyncResult *result,
4936 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4937 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4939 if (g_async_result_legacy_propagate_error (result, error))
4941 else if (g_async_result_is_tagged (result, g_file_unmount_mountable_with_operation))
4942 return g_task_propagate_boolean (G_TASK (result), error);
4944 iface = G_FILE_GET_IFACE (file);
4945 return (* iface->unmount_mountable_finish) (file, result, error);
4949 * g_file_unmount_mountable_with_operation:
4950 * @file: input #GFile
4951 * @flags: flags affecting the operation
4952 * @mount_operation: (allow-none): a #GMountOperation,
4953 * or %NULL to avoid user interaction
4954 * @cancellable: (allow-none): optional #GCancellable object,
4956 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4957 * when the request is satisfied, or %NULL
4958 * @user_data: (closure): the data to pass to callback function
4960 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
4962 * If @cancellable is not %NULL, then the operation can be cancelled by
4963 * triggering the cancellable object from another thread. If the operation
4964 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4966 * When the operation is finished, @callback will be called.
4967 * You can then call g_file_unmount_mountable_finish() to get
4968 * the result of the operation.
4973 g_file_unmount_mountable_with_operation (GFile *file,
4974 GMountUnmountFlags flags,
4975 GMountOperation *mount_operation,
4976 GCancellable *cancellable,
4977 GAsyncReadyCallback callback,
4982 g_return_if_fail (G_IS_FILE (file));
4984 iface = G_FILE_GET_IFACE (file);
4986 if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL)
4988 g_task_report_new_error (file, callback, user_data,
4989 g_file_unmount_mountable_with_operation,
4990 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4991 _("Operation not supported"));
4995 if (iface->unmount_mountable_with_operation != NULL)
4996 (* iface->unmount_mountable_with_operation) (file,
5003 (* iface->unmount_mountable) (file,
5011 * g_file_unmount_mountable_with_operation_finish:
5012 * @file: input #GFile
5013 * @result: a #GAsyncResult
5014 * @error: a #GError, or %NULL
5016 * Finishes an unmount operation,
5017 * see g_file_unmount_mountable_with_operation() for details.
5019 * Finish an asynchronous unmount operation that was started
5020 * with g_file_unmount_mountable_with_operation().
5022 * Returns: %TRUE if the operation finished successfully.
5028 g_file_unmount_mountable_with_operation_finish (GFile *file,
5029 GAsyncResult *result,
5034 g_return_val_if_fail (G_IS_FILE (file), FALSE);
5035 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
5037 if (g_async_result_legacy_propagate_error (result, error))
5039 else if (g_async_result_is_tagged (result, g_file_unmount_mountable_with_operation))
5040 return g_task_propagate_boolean (G_TASK (result), error);
5042 iface = G_FILE_GET_IFACE (file);
5043 if (iface->unmount_mountable_with_operation_finish != NULL)
5044 return (* iface->unmount_mountable_with_operation_finish) (file, result, error);
5046 return (* iface->unmount_mountable_finish) (file, result, error);
5050 * g_file_eject_mountable:
5051 * @file: input #GFile
5052 * @flags: flags affecting the operation
5053 * @cancellable: (allow-none): optional #GCancellable object,
5055 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
5056 * when the request is satisfied, or %NULL
5057 * @user_data: (closure): the data to pass to callback function
5059 * Starts an asynchronous eject on a mountable.
5060 * When this operation has completed, @callback will be called with
5061 * @user_user data, and the operation can be finalized with
5062 * g_file_eject_mountable_finish().
5064 * If @cancellable is not %NULL, then the operation can be cancelled by
5065 * triggering the cancellable object from another thread. If the operation
5066 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5068 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5071 g_file_eject_mountable (GFile *file,
5072 GMountUnmountFlags flags,
5073 GCancellable *cancellable,
5074 GAsyncReadyCallback callback,
5079 g_return_if_fail (G_IS_FILE (file));
5081 iface = G_FILE_GET_IFACE (file);
5083 if (iface->eject_mountable == NULL)
5085 g_task_report_new_error (file, callback, user_data,
5086 g_file_eject_mountable_with_operation,
5087 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
5088 _("Operation not supported"));
5092 (* iface->eject_mountable) (file,
5100 * g_file_eject_mountable_finish:
5101 * @file: input #GFile
5102 * @result: a #GAsyncResult
5103 * @error: a #GError, or %NULL
5105 * Finishes an asynchronous eject operation started by
5106 * g_file_eject_mountable().
5108 * Returns: %TRUE if the @file was ejected successfully.
5111 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5115 g_file_eject_mountable_finish (GFile *file,
5116 GAsyncResult *result,
5121 g_return_val_if_fail (G_IS_FILE (file), FALSE);
5122 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
5124 if (g_async_result_legacy_propagate_error (result, error))
5126 else if (g_async_result_is_tagged (result, g_file_eject_mountable_with_operation))
5127 return g_task_propagate_boolean (G_TASK (result), error);
5129 iface = G_FILE_GET_IFACE (file);
5130 return (* iface->eject_mountable_finish) (file, result, error);
5134 * g_file_eject_mountable_with_operation:
5135 * @file: input #GFile
5136 * @flags: flags affecting the operation
5137 * @mount_operation: (allow-none): a #GMountOperation,
5138 * or %NULL to avoid user interaction
5139 * @cancellable: (allow-none): optional #GCancellable object,
5141 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
5142 * when the request is satisfied, or %NULL
5143 * @user_data: (closure): the data to pass to callback function
5145 * Starts an asynchronous eject on a mountable.
5146 * When this operation has completed, @callback will be called with
5147 * @user_user data, and the operation can be finalized with
5148 * g_file_eject_mountable_with_operation_finish().
5150 * If @cancellable is not %NULL, then the operation can be cancelled by
5151 * triggering the cancellable object from another thread. If the operation
5152 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5157 g_file_eject_mountable_with_operation (GFile *file,
5158 GMountUnmountFlags flags,
5159 GMountOperation *mount_operation,
5160 GCancellable *cancellable,
5161 GAsyncReadyCallback callback,
5166 g_return_if_fail (G_IS_FILE (file));
5168 iface = G_FILE_GET_IFACE (file);
5170 if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL)
5172 g_task_report_new_error (file, callback, user_data,
5173 g_file_eject_mountable_with_operation,
5174 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
5175 _("Operation not supported"));
5179 if (iface->eject_mountable_with_operation != NULL)
5180 (* iface->eject_mountable_with_operation) (file,
5187 (* iface->eject_mountable) (file,
5195 * g_file_eject_mountable_with_operation_finish:
5196 * @file: input #GFile
5197 * @result: a #GAsyncResult
5198 * @error: a #GError, or %NULL
5200 * Finishes an asynchronous eject operation started by
5201 * g_file_eject_mountable_with_operation().
5203 * Returns: %TRUE if the @file was ejected successfully.
5209 g_file_eject_mountable_with_operation_finish (GFile *file,
5210 GAsyncResult *result,
5215 g_return_val_if_fail (G_IS_FILE (file), FALSE);
5216 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
5218 if (g_async_result_legacy_propagate_error (result, error))
5220 else if (g_async_result_is_tagged (result, g_file_eject_mountable_with_operation))
5221 return g_task_propagate_boolean (G_TASK (result), error);
5223 iface = G_FILE_GET_IFACE (file);
5224 if (iface->eject_mountable_with_operation_finish != NULL)
5225 return (* iface->eject_mountable_with_operation_finish) (file, result, error);
5227 return (* iface->eject_mountable_finish) (file, result, error);
5231 * g_file_monitor_directory:
5232 * @file: input #GFile
5233 * @flags: a set of #GFileMonitorFlags
5234 * @cancellable: (allow-none): optional #GCancellable object,
5236 * @error: a #GError, or %NULL
5238 * Obtains a directory monitor for the given file.
5239 * This may fail if directory monitoring is not supported.
5241 * If @cancellable is not %NULL, then the operation can be cancelled by
5242 * triggering the cancellable object from another thread. If the operation
5243 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5245 * It does not make sense for @flags to contain
5246 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5247 * directories. It is not possible to monitor all the files in a
5248 * directory for changes made via hard links; if you want to do this then
5249 * you must register individual watches with g_file_monitor().
5251 * Virtual: monitor_dir
5252 * Returns: (transfer full): a #GFileMonitor for the given @file,
5253 * or %NULL on error.
5254 * Free the returned object with g_object_unref().
5257 g_file_monitor_directory (GFile *file,
5258 GFileMonitorFlags flags,
5259 GCancellable *cancellable,
5264 g_return_val_if_fail (G_IS_FILE (file), NULL);
5265 g_return_val_if_fail (~flags & G_FILE_MONITOR_WATCH_HARD_LINKS, NULL);
5267 if (g_cancellable_set_error_if_cancelled (cancellable, error))
5270 iface = G_FILE_GET_IFACE (file);
5272 if (iface->monitor_dir == NULL)
5274 g_set_error_literal (error, G_IO_ERROR,
5275 G_IO_ERROR_NOT_SUPPORTED,
5276 _("Operation not supported"));
5280 return (* iface->monitor_dir) (file, flags, cancellable, error);
5284 * g_file_monitor_file:
5285 * @file: input #GFile
5286 * @flags: a set of #GFileMonitorFlags
5287 * @cancellable: (allow-none): optional #GCancellable object,
5289 * @error: a #GError, or %NULL
5291 * Obtains a file monitor for the given file. If no file notification
5292 * mechanism exists, then regular polling of the file is used.
5294 * If @cancellable is not %NULL, then the operation can be cancelled by
5295 * triggering the cancellable object from another thread. If the operation
5296 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5298 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5299 * will also attempt to report changes made to the file via another
5300 * filename (ie, a hard link). Without this flag, you can only rely on
5301 * changes made through the filename contained in @file to be
5302 * reported. Using this flag may result in an increase in resource
5303 * usage, and may not have any effect depending on the #GFileMonitor
5304 * backend and/or filesystem type.
5306 * Returns: (transfer full): a #GFileMonitor for the given @file,
5307 * or %NULL on error.
5308 * Free the returned object with g_object_unref().
5311 g_file_monitor_file (GFile *file,
5312 GFileMonitorFlags flags,
5313 GCancellable *cancellable,
5317 GFileMonitor *monitor;
5319 g_return_val_if_fail (G_IS_FILE (file), NULL);
5321 if (g_cancellable_set_error_if_cancelled (cancellable, error))
5324 iface = G_FILE_GET_IFACE (file);
5328 if (iface->monitor_file)
5329 monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
5331 /* Fallback to polling */
5332 if (monitor == NULL)
5333 monitor = _g_poll_file_monitor_new (file);
5340 * @file: input #GFile
5341 * @flags: a set of #GFileMonitorFlags
5342 * @cancellable: (allow-none): optional #GCancellable object,
5344 * @error: a #GError, or %NULL
5346 * Obtains a file or directory monitor for the given file,
5347 * depending on the type of the file.
5349 * If @cancellable is not %NULL, then the operation can be cancelled by
5350 * triggering the cancellable object from another thread. If the operation
5351 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5353 * Returns: (transfer full): a #GFileMonitor for the given @file,
5354 * or %NULL on error.
5355 * Free the returned object with g_object_unref().
5360 g_file_monitor (GFile *file,
5361 GFileMonitorFlags flags,
5362 GCancellable *cancellable,
5365 if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
5366 return g_file_monitor_directory (file,
5367 flags & ~G_FILE_MONITOR_WATCH_HARD_LINKS,
5368 cancellable, error);
5370 return g_file_monitor_file (file, flags, cancellable, error);
5373 /********************************************
5374 * Default implementation of async ops *
5375 ********************************************/
5379 GFileQueryInfoFlags flags;
5380 } QueryInfoAsyncData;
5383 query_info_data_free (QueryInfoAsyncData *data)
5385 g_free (data->attributes);
5390 query_info_async_thread (GTask *task,
5393 GCancellable *cancellable)
5395 QueryInfoAsyncData *data = task_data;
5397 GError *error = NULL;
5399 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5401 g_task_return_pointer (task, info, g_object_unref);
5403 g_task_return_error (task, error);
5407 g_file_real_query_info_async (GFile *file,
5408 const char *attributes,
5409 GFileQueryInfoFlags flags,
5411 GCancellable *cancellable,
5412 GAsyncReadyCallback callback,
5416 QueryInfoAsyncData *data;
5418 data = g_new0 (QueryInfoAsyncData, 1);
5419 data->attributes = g_strdup (attributes);
5420 data->flags = flags;
5422 task = g_task_new (file, cancellable, callback, user_data);
5423 g_task_set_source_tag (task, g_file_real_query_info_async);
5424 g_task_set_task_data (task, data, (GDestroyNotify)query_info_data_free);
5425 g_task_set_priority (task, io_priority);
5426 g_task_run_in_thread (task, query_info_async_thread);
5427 g_object_unref (task);
5431 g_file_real_query_info_finish (GFile *file,
5435 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5437 return g_task_propagate_pointer (G_TASK (res), error);
5441 query_filesystem_info_async_thread (GTask *task,
5444 GCancellable *cancellable)
5446 const char *attributes = task_data;
5448 GError *error = NULL;
5450 info = g_file_query_filesystem_info (G_FILE (object), attributes, cancellable, &error);
5452 g_task_return_pointer (task, info, g_object_unref);
5454 g_task_return_error (task, error);
5458 g_file_real_query_filesystem_info_async (GFile *file,
5459 const char *attributes,
5461 GCancellable *cancellable,
5462 GAsyncReadyCallback callback,
5467 task = g_task_new (file, cancellable, callback, user_data);
5468 g_task_set_source_tag (task, g_file_real_query_filesystem_info_async);
5469 g_task_set_task_data (task, g_strdup (attributes), g_free);
5470 g_task_set_priority (task, io_priority);
5471 g_task_run_in_thread (task, query_filesystem_info_async_thread);
5472 g_object_unref (task);
5476 g_file_real_query_filesystem_info_finish (GFile *file,
5480 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5482 return g_task_propagate_pointer (G_TASK (res), error);
5486 enumerate_children_async_thread (GTask *task,
5489 GCancellable *cancellable)
5491 QueryInfoAsyncData *data = task_data;
5492 GFileEnumerator *enumerator;
5493 GError *error = NULL;
5495 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5497 g_task_return_error (task, error);
5499 g_task_return_pointer (task, enumerator, g_object_unref);
5503 g_file_real_enumerate_children_async (GFile *file,
5504 const char *attributes,
5505 GFileQueryInfoFlags flags,
5507 GCancellable *cancellable,
5508 GAsyncReadyCallback callback,
5512 QueryInfoAsyncData *data;
5514 data = g_new0 (QueryInfoAsyncData, 1);
5515 data->attributes = g_strdup (attributes);
5516 data->flags = flags;
5518 task = g_task_new (file, cancellable, callback, user_data);
5519 g_task_set_source_tag (task, g_file_real_enumerate_children_async);
5520 g_task_set_task_data (task, data, (GDestroyNotify)query_info_data_free);
5521 g_task_set_priority (task, io_priority);
5522 g_task_run_in_thread (task, enumerate_children_async_thread);
5523 g_object_unref (task);
5526 static GFileEnumerator *
5527 g_file_real_enumerate_children_finish (GFile *file,
5531 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5533 return g_task_propagate_pointer (G_TASK (res), error);
5537 open_read_async_thread (GTask *task,
5540 GCancellable *cancellable)
5542 GFileInputStream *stream;
5543 GError *error = NULL;
5545 stream = g_file_read (G_FILE (object), cancellable, &error);
5547 g_task_return_pointer (task, stream, g_object_unref);
5549 g_task_return_error (task, error);
5553 g_file_real_read_async (GFile *file,
5555 GCancellable *cancellable,
5556 GAsyncReadyCallback callback,
5561 task = g_task_new (file, cancellable, callback, user_data);
5562 g_task_set_source_tag (task, g_file_real_read_async);
5563 g_task_set_priority (task, io_priority);
5564 g_task_run_in_thread (task, open_read_async_thread);
5565 g_object_unref (task);
5568 static GFileInputStream *
5569 g_file_real_read_finish (GFile *file,
5573 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5575 return g_task_propagate_pointer (G_TASK (res), error);
5579 append_to_async_thread (GTask *task,
5580 gpointer source_object,
5582 GCancellable *cancellable)
5584 GFileCreateFlags *data = task_data;
5585 GFileOutputStream *stream;
5586 GError *error = NULL;
5588 stream = g_file_append_to (G_FILE (source_object), *data, cancellable, &error);
5590 g_task_return_pointer (task, stream, g_object_unref);
5592 g_task_return_error (task, error);
5596 g_file_real_append_to_async (GFile *file,
5597 GFileCreateFlags flags,
5599 GCancellable *cancellable,
5600 GAsyncReadyCallback callback,
5603 GFileCreateFlags *data;
5606 data = g_new0 (GFileCreateFlags, 1);
5609 task = g_task_new (file, cancellable, callback, user_data);
5610 g_task_set_source_tag (task, g_file_real_append_to_async);
5611 g_task_set_task_data (task, data, g_free);
5612 g_task_set_priority (task, io_priority);
5614 g_task_run_in_thread (task, append_to_async_thread);
5615 g_object_unref (task);
5618 static GFileOutputStream *
5619 g_file_real_append_to_finish (GFile *file,
5623 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5625 return g_task_propagate_pointer (G_TASK (res), error);
5629 create_async_thread (GTask *task,
5630 gpointer source_object,
5632 GCancellable *cancellable)
5634 GFileCreateFlags *data = task_data;
5635 GFileOutputStream *stream;
5636 GError *error = NULL;
5638 stream = g_file_create (G_FILE (source_object), *data, cancellable, &error);
5640 g_task_return_pointer (task, stream, g_object_unref);
5642 g_task_return_error (task, error);
5646 g_file_real_create_async (GFile *file,
5647 GFileCreateFlags flags,
5649 GCancellable *cancellable,
5650 GAsyncReadyCallback callback,
5653 GFileCreateFlags *data;
5656 data = g_new0 (GFileCreateFlags, 1);
5659 task = g_task_new (file, cancellable, callback, user_data);
5660 g_task_set_source_tag (task, g_file_real_create_async);
5661 g_task_set_task_data (task, data, g_free);
5662 g_task_set_priority (task, io_priority);
5664 g_task_run_in_thread (task, create_async_thread);
5665 g_object_unref (task);
5668 static GFileOutputStream *
5669 g_file_real_create_finish (GFile *file,
5673 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5675 return g_task_propagate_pointer (G_TASK (res), error);
5679 GFileOutputStream *stream;
5681 gboolean make_backup;
5682 GFileCreateFlags flags;
5686 replace_async_data_free (ReplaceAsyncData *data)
5689 g_object_unref (data->stream);
5690 g_free (data->etag);
5695 replace_async_thread (GTask *task,
5696 gpointer source_object,
5698 GCancellable *cancellable)
5700 GFileOutputStream *stream;
5701 ReplaceAsyncData *data = task_data;
5702 GError *error = NULL;
5704 stream = g_file_replace (G_FILE (source_object),
5712 g_task_return_pointer (task, stream, g_object_unref);
5714 g_task_return_error (task, error);
5718 g_file_real_replace_async (GFile *file,
5720 gboolean make_backup,
5721 GFileCreateFlags flags,
5723 GCancellable *cancellable,
5724 GAsyncReadyCallback callback,
5728 ReplaceAsyncData *data;
5730 data = g_new0 (ReplaceAsyncData, 1);
5731 data->etag = g_strdup (etag);
5732 data->make_backup = make_backup;
5733 data->flags = flags;
5735 task = g_task_new (file, cancellable, callback, user_data);
5736 g_task_set_source_tag (task, g_file_real_replace_async);
5737 g_task_set_task_data (task, data, (GDestroyNotify)replace_async_data_free);
5738 g_task_set_priority (task, io_priority);
5740 g_task_run_in_thread (task, replace_async_thread);
5741 g_object_unref (task);
5744 static GFileOutputStream *
5745 g_file_real_replace_finish (GFile *file,
5749 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5751 return g_task_propagate_pointer (G_TASK (res), error);
5755 delete_async_thread (GTask *task,
5758 GCancellable *cancellable)
5760 GError *error = NULL;
5762 if (g_file_delete (G_FILE (object), cancellable, &error))
5763 g_task_return_boolean (task, TRUE);
5765 g_task_return_error (task, error);
5769 g_file_real_delete_async (GFile *file,
5771 GCancellable *cancellable,
5772 GAsyncReadyCallback callback,
5777 task = g_task_new (file, cancellable, callback, user_data);
5778 g_task_set_source_tag (task, g_file_real_delete_async);
5779 g_task_set_priority (task, io_priority);
5780 g_task_run_in_thread (task, delete_async_thread);
5781 g_object_unref (task);
5785 g_file_real_delete_finish (GFile *file,
5789 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
5791 return g_task_propagate_boolean (G_TASK (res), error);
5795 trash_async_thread (GTask *task,
5798 GCancellable *cancellable)
5800 GError *error = NULL;
5802 if (g_file_trash (G_FILE (object), cancellable, &error))
5803 g_task_return_boolean (task, TRUE);
5805 g_task_return_error (task, error);
5809 g_file_real_trash_async (GFile *file,
5811 GCancellable *cancellable,
5812 GAsyncReadyCallback callback,
5817 task = g_task_new (file, cancellable, callback, user_data);
5818 g_task_set_source_tag (task, g_file_real_trash_async);
5819 g_task_set_priority (task, io_priority);
5820 g_task_run_in_thread (task, trash_async_thread);
5821 g_object_unref (task);
5825 g_file_real_trash_finish (GFile *file,
5829 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
5831 return g_task_propagate_boolean (G_TASK (res), error);
5835 make_directory_async_thread (GTask *task,
5838 GCancellable *cancellable)
5840 GError *error = NULL;
5842 if (g_file_make_directory (G_FILE (object), cancellable, &error))
5843 g_task_return_boolean (task, TRUE);
5845 g_task_return_error (task, error);
5849 g_file_real_make_directory_async (GFile *file,
5851 GCancellable *cancellable,
5852 GAsyncReadyCallback callback,
5857 task = g_task_new (file, cancellable, callback, user_data);
5858 g_task_set_source_tag (task, g_file_real_make_directory_async);
5859 g_task_set_priority (task, io_priority);
5860 g_task_run_in_thread (task, make_directory_async_thread);
5861 g_object_unref (task);
5865 g_file_real_make_directory_finish (GFile *file,
5869 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
5871 return g_task_propagate_boolean (G_TASK (res), error);
5875 open_readwrite_async_thread (GTask *task,
5878 GCancellable *cancellable)
5880 GFileIOStream *stream;
5881 GError *error = NULL;
5883 stream = g_file_open_readwrite (G_FILE (object), cancellable, &error);
5886 g_task_return_error (task, error);
5888 g_task_return_pointer (task, stream, g_object_unref);
5892 g_file_real_open_readwrite_async (GFile *file,
5894 GCancellable *cancellable,
5895 GAsyncReadyCallback callback,
5900 task = g_task_new (file, cancellable, callback, user_data);
5901 g_task_set_source_tag (task, g_file_real_open_readwrite_async);
5902 g_task_set_priority (task, io_priority);
5904 g_task_run_in_thread (task, open_readwrite_async_thread);
5905 g_object_unref (task);
5908 static GFileIOStream *
5909 g_file_real_open_readwrite_finish (GFile *file,
5913 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5915 return g_task_propagate_pointer (G_TASK (res), error);
5919 create_readwrite_async_thread (GTask *task,
5922 GCancellable *cancellable)
5924 GFileCreateFlags *data = task_data;
5925 GFileIOStream *stream;
5926 GError *error = NULL;
5928 stream = g_file_create_readwrite (G_FILE (object), *data, cancellable, &error);
5931 g_task_return_error (task, error);
5933 g_task_return_pointer (task, stream, g_object_unref);
5937 g_file_real_create_readwrite_async (GFile *file,
5938 GFileCreateFlags flags,
5940 GCancellable *cancellable,
5941 GAsyncReadyCallback callback,
5944 GFileCreateFlags *data;
5947 data = g_new0 (GFileCreateFlags, 1);
5950 task = g_task_new (file, cancellable, callback, user_data);
5951 g_task_set_source_tag (task, g_file_real_create_readwrite_async);
5952 g_task_set_task_data (task, data, g_free);
5953 g_task_set_priority (task, io_priority);
5955 g_task_run_in_thread (task, create_readwrite_async_thread);
5956 g_object_unref (task);
5959 static GFileIOStream *
5960 g_file_real_create_readwrite_finish (GFile *file,
5964 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
5966 return g_task_propagate_pointer (G_TASK (res), error);
5971 gboolean make_backup;
5972 GFileCreateFlags flags;
5973 } ReplaceRWAsyncData;
5976 replace_rw_async_data_free (ReplaceRWAsyncData *data)
5978 g_free (data->etag);
5983 replace_readwrite_async_thread (GTask *task,
5986 GCancellable *cancellable)
5988 GFileIOStream *stream;
5989 GError *error = NULL;
5990 ReplaceRWAsyncData *data = task_data;
5992 stream = g_file_replace_readwrite (G_FILE (object),
6000 g_task_return_error (task, error);
6002 g_task_return_pointer (task, stream, g_object_unref);
6006 g_file_real_replace_readwrite_async (GFile *file,
6008 gboolean make_backup,
6009 GFileCreateFlags flags,
6011 GCancellable *cancellable,
6012 GAsyncReadyCallback callback,
6016 ReplaceRWAsyncData *data;
6018 data = g_new0 (ReplaceRWAsyncData, 1);
6019 data->etag = g_strdup (etag);
6020 data->make_backup = make_backup;
6021 data->flags = flags;
6023 task = g_task_new (file, cancellable, callback, user_data);
6024 g_task_set_source_tag (task, g_file_real_replace_readwrite_async);
6025 g_task_set_task_data (task, data, (GDestroyNotify)replace_rw_async_data_free);
6026 g_task_set_priority (task, io_priority);
6028 g_task_run_in_thread (task, replace_readwrite_async_thread);
6029 g_object_unref (task);
6032 static GFileIOStream *
6033 g_file_real_replace_readwrite_finish (GFile *file,
6037 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
6039 return g_task_propagate_pointer (G_TASK (res), error);
6043 set_display_name_async_thread (GTask *task,
6046 GCancellable *cancellable)
6048 GError *error = NULL;
6049 char *name = task_data;
6052 file = g_file_set_display_name (G_FILE (object), name, cancellable, &error);
6055 g_task_return_error (task, error);
6057 g_task_return_pointer (task, file, g_object_unref);
6061 g_file_real_set_display_name_async (GFile *file,
6062 const char *display_name,
6064 GCancellable *cancellable,
6065 GAsyncReadyCallback callback,
6070 task = g_task_new (file, cancellable, callback, user_data);
6071 g_task_set_source_tag (task, g_file_real_set_display_name_async);
6072 g_task_set_task_data (task, g_strdup (display_name), g_free);
6073 g_task_set_priority (task, io_priority);
6075 g_task_run_in_thread (task, set_display_name_async_thread);
6076 g_object_unref (task);
6080 g_file_real_set_display_name_finish (GFile *file,
6084 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
6086 return g_task_propagate_pointer (G_TASK (res), error);
6090 GFileQueryInfoFlags flags;
6097 set_info_data_free (SetInfoAsyncData *data)
6100 g_object_unref (data->info);
6102 g_error_free (data->error);
6107 set_info_async_thread (GTask *task,
6110 GCancellable *cancellable)
6112 SetInfoAsyncData *data = task_data;
6115 data->res = g_file_set_attributes_from_info (G_FILE (object),
6123 g_file_real_set_attributes_async (GFile *file,
6125 GFileQueryInfoFlags flags,
6127 GCancellable *cancellable,
6128 GAsyncReadyCallback callback,
6132 SetInfoAsyncData *data;
6134 data = g_new0 (SetInfoAsyncData, 1);
6135 data->info = g_file_info_dup (info);
6136 data->flags = flags;
6138 task = g_task_new (file, cancellable, callback, user_data);
6139 g_task_set_source_tag (task, g_file_real_set_attributes_async);
6140 g_task_set_task_data (task, data, (GDestroyNotify)set_info_data_free);
6141 g_task_set_priority (task, io_priority);
6143 g_task_run_in_thread (task, set_info_async_thread);
6144 g_object_unref (task);
6148 g_file_real_set_attributes_finish (GFile *file,
6153 SetInfoAsyncData *data;
6155 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
6157 data = g_task_get_task_data (G_TASK (res));
6160 *info = g_object_ref (data->info);
6162 if (error != NULL && data->error)
6163 *error = g_error_copy (data->error);
6169 find_enclosing_mount_async_thread (GTask *task,
6172 GCancellable *cancellable)
6174 GError *error = NULL;
6177 mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
6180 g_task_return_error (task, error);
6182 g_task_return_pointer (task, mount, g_object_unref);
6186 g_file_real_find_enclosing_mount_async (GFile *file,
6188 GCancellable *cancellable,
6189 GAsyncReadyCallback callback,
6194 task = g_task_new (file, cancellable, callback, user_data);
6195 g_task_set_source_tag (task, g_file_real_find_enclosing_mount_async);
6196 g_task_set_priority (task, io_priority);
6198 g_task_run_in_thread (task, find_enclosing_mount_async_thread);
6199 g_object_unref (task);
6203 g_file_real_find_enclosing_mount_finish (GFile *file,
6207 g_return_val_if_fail (g_task_is_valid (res, file), NULL);
6209 return g_task_propagate_pointer (G_TASK (res), error);
6216 GFileCopyFlags flags;
6217 GFileProgressCallback progress_cb;
6218 gpointer progress_cb_data;
6222 copy_async_data_free (CopyAsyncData *data)
6224 g_object_unref (data->source);
6225 g_object_unref (data->destination);
6226 g_slice_free (CopyAsyncData, data);
6230 CopyAsyncData *data;
6231 goffset current_num_bytes;
6232 goffset total_num_bytes;
6236 copy_async_progress_in_main (gpointer user_data)
6238 ProgressData *progress = user_data;
6239 CopyAsyncData *data = progress->data;
6241 data->progress_cb (progress->current_num_bytes,
6242 progress->total_num_bytes,
6243 data->progress_cb_data);
6249 copy_async_progress_callback (goffset current_num_bytes,
6250 goffset total_num_bytes,
6253 GTask *task = user_data;
6254 CopyAsyncData *data = g_task_get_task_data (task);
6255 ProgressData *progress;
6257 progress = g_new (ProgressData, 1);
6258 progress->data = data;
6259 progress->current_num_bytes = current_num_bytes;
6260 progress->total_num_bytes = total_num_bytes;
6262 g_main_context_invoke_full (g_task_get_context (task),
6263 g_task_get_priority (task),
6264 copy_async_progress_in_main,
6270 copy_async_thread (GTask *task,
6273 GCancellable *cancellable)
6275 CopyAsyncData *data = task_data;
6277 GError *error = NULL;
6279 result = g_file_copy (data->source,
6283 (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
6287 g_task_return_boolean (task, TRUE);
6289 g_task_return_error (task, error);
6293 g_file_real_copy_async (GFile *source,
6295 GFileCopyFlags flags,
6297 GCancellable *cancellable,
6298 GFileProgressCallback progress_callback,
6299 gpointer progress_callback_data,
6300 GAsyncReadyCallback callback,
6304 CopyAsyncData *data;
6306 data = g_slice_new (CopyAsyncData);
6307 data->source = g_object_ref (source);
6308 data->destination = g_object_ref (destination);
6309 data->flags = flags;
6310 data->progress_cb = progress_callback;
6311 data->progress_cb_data = progress_callback_data;
6313 task = g_task_new (source, cancellable, callback, user_data);
6314 g_task_set_source_tag (task, g_file_real_copy_async);
6315 g_task_set_task_data (task, data, (GDestroyNotify)copy_async_data_free);
6316 g_task_set_priority (task, io_priority);
6317 g_task_run_in_thread (task, copy_async_thread);
6318 g_object_unref (task);
6322 g_file_real_copy_finish (GFile *file,
6326 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
6328 return g_task_propagate_boolean (G_TASK (res), error);
6332 /********************************************
6333 * Default VFS operations *
6334 ********************************************/
6337 * g_file_new_for_path:
6338 * @path: (type filename): a string containing a relative or absolute path.
6339 * The string must be encoded in the glib filename encoding.
6341 * Constructs a #GFile for a given path. This operation never
6342 * fails, but the returned object might not support any I/O
6343 * operation if @path is malformed.
6345 * Returns: (transfer full): a new #GFile for the given @path.
6346 * Free the returned object with g_object_unref().
6349 g_file_new_for_path (const char *path)
6351 g_return_val_if_fail (path != NULL, NULL);
6353 return g_vfs_get_file_for_path (g_vfs_get_default (), path);
6357 * g_file_new_for_uri:
6358 * @uri: a UTF-8 string containing a URI
6360 * Constructs a #GFile for a given URI. This operation never
6361 * fails, but the returned object might not support any I/O
6362 * operation if @uri is malformed or if the uri type is
6365 * Returns: (transfer full): a new #GFile for the given @uri.
6366 * Free the returned object with g_object_unref().
6369 g_file_new_for_uri (const char *uri)
6371 g_return_val_if_fail (uri != NULL, NULL);
6373 return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
6378 * @tmpl: (type filename) (allow-none): Template for the file
6379 * name, as in g_file_open_tmp(), or %NULL for a default template
6380 * @iostream: (out): on return, a #GFileIOStream for the created file
6381 * @error: a #GError, or %NULL
6383 * Opens a file in the preferred directory for temporary files (as
6384 * returned by g_get_tmp_dir()) and returns a #GFile and
6385 * #GFileIOStream pointing to it.
6387 * @tmpl should be a string in the GLib file name encoding
6388 * containing a sequence of six 'X' characters, and containing no
6389 * directory components. If it is %NULL, a default template is used.
6391 * Unlike the other #GFile constructors, this will return %NULL if
6392 * a temporary file could not be created.
6394 * Returns: (transfer full): a new #GFile.
6395 * Free the returned object with g_object_unref().
6400 g_file_new_tmp (const char *tmpl,
6401 GFileIOStream **iostream,
6407 GFileOutputStream *output;
6409 g_return_val_if_fail (iostream != NULL, NULL);
6411 fd = g_file_open_tmp (tmpl, &path, error);
6415 file = g_file_new_for_path (path);
6417 output = _g_local_file_output_stream_new (fd);
6418 *iostream = _g_local_file_io_stream_new (G_LOCAL_FILE_OUTPUT_STREAM (output));
6420 g_object_unref (output);
6427 * g_file_parse_name:
6428 * @parse_name: a file name or path to be parsed
6430 * Constructs a #GFile with the given @parse_name (i.e. something
6431 * given by g_file_get_parse_name()). This operation never fails,
6432 * but the returned object might not support any I/O operation if
6433 * the @parse_name cannot be parsed.
6435 * Returns: (transfer full): a new #GFile.
6438 g_file_parse_name (const char *parse_name)
6440 g_return_val_if_fail (parse_name != NULL, NULL);
6442 return g_vfs_parse_name (g_vfs_get_default (), parse_name);
6446 is_valid_scheme_character (char c)
6448 return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
6451 /* Following RFC 2396, valid schemes are built like:
6452 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6455 has_valid_scheme (const char *uri)
6461 if (!g_ascii_isalpha (*p))
6466 } while (is_valid_scheme_character (*p));
6472 new_for_cmdline_arg (const gchar *arg,
6478 if (g_path_is_absolute (arg))
6479 return g_file_new_for_path (arg);
6481 if (has_valid_scheme (arg))
6482 return g_file_new_for_uri (arg);
6488 current_dir = g_get_current_dir ();
6489 filename = g_build_filename (current_dir, arg, NULL);
6490 g_free (current_dir);
6493 filename = g_build_filename (cwd, arg, NULL);
6495 file = g_file_new_for_path (filename);
6502 * g_file_new_for_commandline_arg:
6503 * @arg: a command line string
6505 * Creates a #GFile with the given argument from the command line.
6506 * The value of @arg can be either a URI, an absolute path or a
6507 * relative path resolved relative to the current working directory.
6508 * This operation never fails, but the returned object might not
6509 * support any I/O operation if @arg points to a malformed path.
6511 * Note that on Windows, this function expects its argument to be in
6512 * UTF-8 -- not the system code page. This means that you
6513 * should not use this function with string from argv as it is passed
6514 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6515 * the commandline. #GApplication also uses UTF-8 but
6516 * g_application_command_line_create_file_for_arg() may be more useful
6517 * for you there. It is also always possible to use this function with
6518 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6520 * Returns: (transfer full): a new #GFile.
6521 * Free the returned object with g_object_unref().
6524 g_file_new_for_commandline_arg (const char *arg)
6526 g_return_val_if_fail (arg != NULL, NULL);
6528 return new_for_cmdline_arg (arg, NULL);
6532 * g_file_new_for_commandline_arg_and_cwd:
6533 * @arg: a command line string
6534 * @cwd: (type filename): the current working directory of the commandline
6536 * Creates a #GFile with the given argument from the command line.
6538 * This function is similar to g_file_new_for_commandline_arg() except
6539 * that it allows for passing the current working directory as an
6540 * argument instead of using the current working directory of the
6543 * This is useful if the commandline argument was given in a context
6544 * other than the invocation of the current process.
6546 * See also g_application_command_line_create_file_for_arg().
6548 * Returns: (transfer full): a new #GFile
6553 g_file_new_for_commandline_arg_and_cwd (const gchar *arg,
6556 g_return_val_if_fail (arg != NULL, NULL);
6557 g_return_val_if_fail (cwd != NULL, NULL);
6559 return new_for_cmdline_arg (arg, cwd);
6563 * g_file_mount_enclosing_volume:
6564 * @location: input #GFile
6565 * @flags: flags affecting the operation
6566 * @mount_operation: (allow-none): a #GMountOperation
6567 * or %NULL to avoid user interaction
6568 * @cancellable: (allow-none): optional #GCancellable object,
6570 * @callback: (allow-none): a #GAsyncReadyCallback to call
6571 * when the request is satisfied, or %NULL
6572 * @user_data: the data to pass to callback function
6574 * Starts a @mount_operation, mounting the volume that contains
6575 * the file @location.
6577 * When this operation has completed, @callback will be called with
6578 * @user_user data, and the operation can be finalized with
6579 * g_file_mount_enclosing_volume_finish().
6581 * If @cancellable is not %NULL, then the operation can be cancelled by
6582 * triggering the cancellable object from another thread. If the operation
6583 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6586 g_file_mount_enclosing_volume (GFile *location,
6587 GMountMountFlags flags,
6588 GMountOperation *mount_operation,
6589 GCancellable *cancellable,
6590 GAsyncReadyCallback callback,
6595 g_return_if_fail (G_IS_FILE (location));
6597 iface = G_FILE_GET_IFACE (location);
6599 if (iface->mount_enclosing_volume == NULL)
6601 g_task_report_new_error (location, callback, user_data,
6602 g_file_mount_enclosing_volume,
6603 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
6604 _("volume doesn’t implement mount"));
6608 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6613 * g_file_mount_enclosing_volume_finish:
6614 * @location: input #GFile
6615 * @result: a #GAsyncResult
6616 * @error: a #GError, or %NULL
6618 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6620 * Returns: %TRUE if successful. If an error has occurred,
6621 * this function will return %FALSE and set @error
6622 * appropriately if present.
6625 g_file_mount_enclosing_volume_finish (GFile *location,
6626 GAsyncResult *result,
6631 g_return_val_if_fail (G_IS_FILE (location), FALSE);
6632 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6634 if (g_async_result_legacy_propagate_error (result, error))
6636 else if (g_async_result_is_tagged (result, g_file_mount_enclosing_volume))
6637 return g_task_propagate_boolean (G_TASK (result), error);
6639 iface = G_FILE_GET_IFACE (location);
6641 return (* iface->mount_enclosing_volume_finish) (location, result, error);
6644 /********************************************
6645 * Utility functions *
6646 ********************************************/
6649 * g_file_query_default_handler:
6650 * @file: a #GFile to open
6651 * @cancellable: optional #GCancellable object, %NULL to ignore
6652 * @error: a #GError, or %NULL
6654 * Returns the #GAppInfo that is registered as the default
6655 * application to handle the file specified by @file.
6657 * If @cancellable is not %NULL, then the operation can be cancelled by
6658 * triggering the cancellable object from another thread. If the operation
6659 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6661 * Returns: (transfer full): a #GAppInfo if the handle was found,
6662 * %NULL if there were errors.
6663 * When you are done with it, release it with g_object_unref()
6666 g_file_query_default_handler (GFile *file,
6667 GCancellable *cancellable,
6671 const char *content_type;
6676 uri_scheme = g_file_get_uri_scheme (file);
6677 if (uri_scheme && uri_scheme[0] != '\0')
6679 appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
6680 g_free (uri_scheme);
6682 if (appinfo != NULL)
6686 info = g_file_query_info (file,
6687 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6696 content_type = g_file_info_get_content_type (info);
6699 /* Don't use is_native(), as we want to support fuse paths if available */
6700 path = g_file_get_path (file);
6701 appinfo = g_app_info_get_default_for_type (content_type,
6706 g_object_unref (info);
6708 if (appinfo != NULL)
6711 g_set_error_literal (error, G_IO_ERROR,
6712 G_IO_ERROR_NOT_SUPPORTED,
6713 _("No application is registered as handling this file"));
6717 #define GET_CONTENT_BLOCK_SIZE 8192
6720 * g_file_load_contents:
6721 * @file: input #GFile
6722 * @cancellable: optional #GCancellable object, %NULL to ignore
6723 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6724 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6725 * or %NULL if the length is not needed
6726 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6727 * or %NULL if the entity tag is not needed
6728 * @error: a #GError, or %NULL
6730 * Loads the content of the file into memory. The data is always
6731 * zero-terminated, but this is not included in the resultant @length.
6732 * The returned @content should be freed with g_free() when no longer
6735 * If @cancellable is not %NULL, then the operation can be cancelled by
6736 * triggering the cancellable object from another thread. If the operation
6737 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6739 * Returns: %TRUE if the @file's contents were successfully loaded.
6740 * %FALSE if there were errors.
6743 g_file_load_contents (GFile *file,
6744 GCancellable *cancellable,
6750 GFileInputStream *in;
6751 GByteArray *content;
6756 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6757 g_return_val_if_fail (contents != NULL, FALSE);
6759 in = g_file_read (file, cancellable, error);
6763 content = g_byte_array_new ();
6766 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6767 while ((res = g_input_stream_read (G_INPUT_STREAM (in),
6768 content->data + pos,
6769 GET_CONTENT_BLOCK_SIZE,
6770 cancellable, error)) > 0)
6773 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6780 info = g_file_input_stream_query_info (in,
6781 G_FILE_ATTRIBUTE_ETAG_VALUE,
6786 *etag_out = g_strdup (g_file_info_get_etag (info));
6787 g_object_unref (info);
6791 /* Ignore errors on close */
6792 g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
6793 g_object_unref (in);
6797 /* error is set already */
6798 g_byte_array_free (content, TRUE);
6805 /* Zero terminate (we got an extra byte allocated for this */
6806 content->data[pos] = 0;
6808 *contents = (char *)g_byte_array_free (content, FALSE);
6815 GFileReadMoreCallback read_more_callback;
6816 GByteArray *content;
6823 load_contents_data_free (LoadContentsData *data)
6826 g_byte_array_free (data->content, TRUE);
6827 g_free (data->etag);
6832 load_contents_close_callback (GObject *obj,
6833 GAsyncResult *close_res,
6836 GInputStream *stream = G_INPUT_STREAM (obj);
6837 LoadContentsData *data = user_data;
6839 /* Ignore errors here, we're only reading anyway */
6840 g_input_stream_close_finish (stream, close_res, NULL);
6841 g_object_unref (stream);
6843 g_task_return_boolean (data->task, TRUE);
6844 g_object_unref (data->task);
6848 load_contents_fstat_callback (GObject *obj,
6849 GAsyncResult *stat_res,
6852 GInputStream *stream = G_INPUT_STREAM (obj);
6853 LoadContentsData *data = user_data;
6856 info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
6860 data->etag = g_strdup (g_file_info_get_etag (info));
6861 g_object_unref (info);
6864 g_input_stream_close_async (stream, 0,
6865 g_task_get_cancellable (data->task),
6866 load_contents_close_callback, data);
6870 load_contents_read_callback (GObject *obj,
6871 GAsyncResult *read_res,
6874 GInputStream *stream = G_INPUT_STREAM (obj);
6875 LoadContentsData *data = user_data;
6876 GError *error = NULL;
6879 read_size = g_input_stream_read_finish (stream, read_res, &error);
6883 g_task_return_error (data->task, error);
6884 g_object_unref (data->task);
6886 /* Close the file ignoring any error */
6887 g_input_stream_close_async (stream, 0, NULL, NULL, NULL);
6888 g_object_unref (stream);
6890 else if (read_size == 0)
6892 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6893 G_FILE_ATTRIBUTE_ETAG_VALUE,
6895 g_task_get_cancellable (data->task),
6896 load_contents_fstat_callback,
6899 else if (read_size > 0)
6901 data->pos += read_size;
6903 g_byte_array_set_size (data->content,
6904 data->pos + GET_CONTENT_BLOCK_SIZE);
6907 if (data->read_more_callback &&
6908 !data->read_more_callback ((char *)data->content->data, data->pos,
6909 g_async_result_get_user_data (G_ASYNC_RESULT (data->task))))
6910 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6911 G_FILE_ATTRIBUTE_ETAG_VALUE,
6913 g_task_get_cancellable (data->task),
6914 load_contents_fstat_callback,
6917 g_input_stream_read_async (stream,
6918 data->content->data + data->pos,
6919 GET_CONTENT_BLOCK_SIZE,
6921 g_task_get_cancellable (data->task),
6922 load_contents_read_callback,
6928 load_contents_open_callback (GObject *obj,
6929 GAsyncResult *open_res,
6932 GFile *file = G_FILE (obj);
6933 GFileInputStream *stream;
6934 LoadContentsData *data = user_data;
6935 GError *error = NULL;
6937 stream = g_file_read_finish (file, open_res, &error);
6941 g_byte_array_set_size (data->content,
6942 data->pos + GET_CONTENT_BLOCK_SIZE);
6943 g_input_stream_read_async (G_INPUT_STREAM (stream),
6944 data->content->data + data->pos,
6945 GET_CONTENT_BLOCK_SIZE,
6947 g_task_get_cancellable (data->task),
6948 load_contents_read_callback,
6953 g_task_return_error (data->task, error);
6954 g_object_unref (data->task);
6959 * g_file_load_partial_contents_async: (skip)
6960 * @file: input #GFile
6961 * @cancellable: optional #GCancellable object, %NULL to ignore
6962 * @read_more_callback: a #GFileReadMoreCallback to receive partial data
6963 * and to specify whether further data should be read
6964 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6965 * @user_data: the data to pass to the callback functions
6967 * Reads the partial contents of a file. A #GFileReadMoreCallback should
6968 * be used to stop reading from the file when appropriate, else this
6969 * function will behave exactly as g_file_load_contents_async(). This
6970 * operation can be finished by g_file_load_partial_contents_finish().
6972 * Users of this function should be aware that @user_data is passed to
6973 * both the @read_more_callback and the @callback.
6975 * If @cancellable is not %NULL, then the operation can be cancelled by
6976 * triggering the cancellable object from another thread. If the operation
6977 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6980 g_file_load_partial_contents_async (GFile *file,
6981 GCancellable *cancellable,
6982 GFileReadMoreCallback read_more_callback,
6983 GAsyncReadyCallback callback,
6986 LoadContentsData *data;
6988 g_return_if_fail (G_IS_FILE (file));
6990 data = g_new0 (LoadContentsData, 1);
6991 data->read_more_callback = read_more_callback;
6992 data->content = g_byte_array_new ();
6994 data->task = g_task_new (file, cancellable, callback, user_data);
6995 g_task_set_source_tag (data->task, g_file_load_partial_contents_async);
6996 g_task_set_task_data (data->task, data, (GDestroyNotify)load_contents_data_free);
6998 g_file_read_async (file,
7000 g_task_get_cancellable (data->task),
7001 load_contents_open_callback,
7006 * g_file_load_partial_contents_finish:
7007 * @file: input #GFile
7008 * @res: a #GAsyncResult
7009 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7010 * @length: (out) (allow-none): a location to place the length of the contents of the file,
7011 * or %NULL if the length is not needed
7012 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
7013 * or %NULL if the entity tag is not needed
7014 * @error: a #GError, or %NULL
7016 * Finishes an asynchronous partial load operation that was started
7017 * with g_file_load_partial_contents_async(). The data is always
7018 * zero-terminated, but this is not included in the resultant @length.
7019 * The returned @content should be freed with g_free() when no longer
7022 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7023 * present, it will be set appropriately.
7026 g_file_load_partial_contents_finish (GFile *file,
7034 LoadContentsData *data;
7036 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7037 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
7038 g_return_val_if_fail (contents != NULL, FALSE);
7040 task = G_TASK (res);
7042 if (!g_task_propagate_boolean (task, error))
7049 data = g_task_get_task_data (task);
7052 *length = data->pos;
7056 *etag_out = data->etag;
7060 /* Zero terminate */
7061 g_byte_array_set_size (data->content, data->pos + 1);
7062 data->content->data[data->pos] = 0;
7064 *contents = (char *)g_byte_array_free (data->content, FALSE);
7065 data->content = NULL;
7071 * g_file_load_contents_async:
7072 * @file: input #GFile
7073 * @cancellable: optional #GCancellable object, %NULL to ignore
7074 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7075 * @user_data: the data to pass to callback function
7077 * Starts an asynchronous load of the @file's contents.
7079 * For more details, see g_file_load_contents() which is
7080 * the synchronous version of this call.
7082 * When the load operation has completed, @callback will be called
7083 * with @user data. To finish the operation, call
7084 * g_file_load_contents_finish() with the #GAsyncResult returned by
7087 * If @cancellable is not %NULL, then the operation can be cancelled by
7088 * triggering the cancellable object from another thread. If the operation
7089 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7092 g_file_load_contents_async (GFile *file,
7093 GCancellable *cancellable,
7094 GAsyncReadyCallback callback,
7097 g_file_load_partial_contents_async (file,
7100 callback, user_data);
7104 * g_file_load_contents_finish:
7105 * @file: input #GFile
7106 * @res: a #GAsyncResult
7107 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7108 * @length: (out) (allow-none): a location to place the length of the contents of the file,
7109 * or %NULL if the length is not needed
7110 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
7111 * or %NULL if the entity tag is not needed
7112 * @error: a #GError, or %NULL
7114 * Finishes an asynchronous load of the @file's contents.
7115 * The contents are placed in @contents, and @length is set to the
7116 * size of the @contents string. The @content should be freed with
7117 * g_free() when no longer needed. If @etag_out is present, it will be
7118 * set to the new entity tag for the @file.
7120 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7121 * present, it will be set appropriately.
7124 g_file_load_contents_finish (GFile *file,
7131 return g_file_load_partial_contents_finish (file,
7140 * g_file_replace_contents:
7141 * @file: input #GFile
7142 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7143 * @length: the length of @contents in bytes
7144 * @etag: (allow-none): the old [entity-tag][gfile-etag] for the document,
7146 * @make_backup: %TRUE if a backup should be created
7147 * @flags: a set of #GFileCreateFlags
7148 * @new_etag: (allow-none) (out): a location to a new [entity tag][gfile-etag]
7149 * for the document. This should be freed with g_free() when no longer
7151 * @cancellable: optional #GCancellable object, %NULL to ignore
7152 * @error: a #GError, or %NULL
7154 * Replaces the contents of @file with @contents of @length bytes.
7156 * If @etag is specified (not %NULL), any existing file must have that etag,
7157 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7159 * If @make_backup is %TRUE, this function will attempt to make a backup
7160 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7161 * file contents in the safest way possible. For example, atomic renames are
7162 * used when replacing local files’ contents.
7164 * If @cancellable is not %NULL, then the operation can be cancelled by
7165 * triggering the cancellable object from another thread. If the operation
7166 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7168 * The returned @new_etag can be used to verify that the file hasn't
7169 * changed the next time it is saved over.
7171 * Returns: %TRUE if successful. If an error has occurred, this function
7172 * will return %FALSE and set @error appropriately if present.
7175 g_file_replace_contents (GFile *file,
7176 const char *contents,
7179 gboolean make_backup,
7180 GFileCreateFlags flags,
7182 GCancellable *cancellable,
7185 GFileOutputStream *out;
7186 gsize pos, remainder;
7190 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7191 g_return_val_if_fail (contents != NULL, FALSE);
7193 out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
7199 while (remainder > 0 &&
7200 (res = g_output_stream_write (G_OUTPUT_STREAM (out),
7202 MIN (remainder, GET_CONTENT_BLOCK_SIZE),
7210 if (remainder > 0 && res < 0)
7212 /* Ignore errors on close */
7213 g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
7214 g_object_unref (out);
7216 /* error is set already */
7220 ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
7223 *new_etag = g_file_output_stream_get_etag (out);
7225 g_object_unref (out);
7236 } ReplaceContentsData;
7239 replace_contents_data_free (ReplaceContentsData *data)
7241 g_bytes_unref (data->content);
7242 g_free (data->etag);
7247 replace_contents_close_callback (GObject *obj,
7248 GAsyncResult *close_res,
7251 GOutputStream *stream = G_OUTPUT_STREAM (obj);
7252 ReplaceContentsData *data = user_data;
7254 /* Ignore errors here, we're only reading anyway */
7255 g_output_stream_close_finish (stream, close_res, NULL);
7256 g_object_unref (stream);
7260 data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
7261 g_task_return_boolean (data->task, TRUE);
7263 g_object_unref (data->task);
7267 replace_contents_write_callback (GObject *obj,
7268 GAsyncResult *read_res,
7271 GOutputStream *stream = G_OUTPUT_STREAM (obj);
7272 ReplaceContentsData *data = user_data;
7273 GError *error = NULL;
7276 write_size = g_output_stream_write_finish (stream, read_res, &error);
7278 if (write_size <= 0)
7280 /* Error or EOF, close the file */
7283 data->failed = TRUE;
7284 g_task_return_error (data->task, error);
7286 g_output_stream_close_async (stream, 0,
7287 g_task_get_cancellable (data->task),
7288 replace_contents_close_callback, data);
7290 else if (write_size > 0)
7292 const gchar *content;
7295 content = g_bytes_get_data (data->content, &length);
7296 data->pos += write_size;
7298 if (data->pos >= length)
7299 g_output_stream_close_async (stream, 0,
7300 g_task_get_cancellable (data->task),
7301 replace_contents_close_callback, data);
7303 g_output_stream_write_async (stream,
7304 content + data->pos,
7307 g_task_get_cancellable (data->task),
7308 replace_contents_write_callback,
7314 replace_contents_open_callback (GObject *obj,
7315 GAsyncResult *open_res,
7318 GFile *file = G_FILE (obj);
7319 GFileOutputStream *stream;
7320 ReplaceContentsData *data = user_data;
7321 GError *error = NULL;
7323 stream = g_file_replace_finish (file, open_res, &error);
7327 const gchar *content;
7330 content = g_bytes_get_data (data->content, &length);
7331 g_output_stream_write_async (G_OUTPUT_STREAM (stream),
7332 content + data->pos,
7335 g_task_get_cancellable (data->task),
7336 replace_contents_write_callback,
7341 g_task_return_error (data->task, error);
7342 g_object_unref (data->task);
7347 * g_file_replace_contents_async:
7348 * @file: input #GFile
7349 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7350 * @length: the length of @contents in bytes
7351 * @etag: (allow-none): a new [entity tag][gfile-etag] for the @file, or %NULL
7352 * @make_backup: %TRUE if a backup should be created
7353 * @flags: a set of #GFileCreateFlags
7354 * @cancellable: optional #GCancellable object, %NULL to ignore
7355 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7356 * @user_data: the data to pass to callback function
7358 * Starts an asynchronous replacement of @file with the given
7359 * @contents of @length bytes. @etag will replace the document's
7360 * current entity tag.
7362 * When this operation has completed, @callback will be called with
7363 * @user_user data, and the operation can be finalized with
7364 * g_file_replace_contents_finish().
7366 * If @cancellable is not %NULL, then the operation can be cancelled by
7367 * triggering the cancellable object from another thread. If the operation
7368 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7370 * If @make_backup is %TRUE, this function will attempt to
7371 * make a backup of @file.
7373 * Note that no copy of @content will be made, so it must stay valid
7374 * until @callback is called. See g_file_replace_contents_bytes_async()
7375 * for a #GBytes version that will automatically hold a reference to the
7376 * contents (without copying) for the duration of the call.
7379 g_file_replace_contents_async (GFile *file,
7380 const char *contents,
7383 gboolean make_backup,
7384 GFileCreateFlags flags,
7385 GCancellable *cancellable,
7386 GAsyncReadyCallback callback,
7391 bytes = g_bytes_new_static (contents, length);
7392 g_file_replace_contents_bytes_async (file, bytes, etag, make_backup, flags,
7393 cancellable, callback, user_data);
7394 g_bytes_unref (bytes);
7398 * g_file_replace_contents_bytes_async:
7399 * @file: input #GFile
7400 * @contents: a #GBytes
7401 * @etag: (allow-none): a new [entity tag][gfile-etag] for the @file, or %NULL
7402 * @make_backup: %TRUE if a backup should be created
7403 * @flags: a set of #GFileCreateFlags
7404 * @cancellable: optional #GCancellable object, %NULL to ignore
7405 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7406 * @user_data: the data to pass to callback function
7408 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7409 * This function will keep a ref on @contents until the operation is done.
7410 * Unlike g_file_replace_contents_async() this allows forgetting about the
7411 * content without waiting for the callback.
7413 * When this operation has completed, @callback will be called with
7414 * @user_user data, and the operation can be finalized with
7415 * g_file_replace_contents_finish().
7420 g_file_replace_contents_bytes_async (GFile *file,
7423 gboolean make_backup,
7424 GFileCreateFlags flags,
7425 GCancellable *cancellable,
7426 GAsyncReadyCallback callback,
7429 ReplaceContentsData *data;
7431 g_return_if_fail (G_IS_FILE (file));
7432 g_return_if_fail (contents != NULL);
7434 data = g_new0 (ReplaceContentsData, 1);
7436 data->content = g_bytes_ref (contents);
7438 data->task = g_task_new (file, cancellable, callback, user_data);
7439 g_task_set_source_tag (data->task, g_file_replace_contents_bytes_async);
7440 g_task_set_task_data (data->task, data, (GDestroyNotify)replace_contents_data_free);
7442 g_file_replace_async (file,
7447 g_task_get_cancellable (data->task),
7448 replace_contents_open_callback,
7453 * g_file_replace_contents_finish:
7454 * @file: input #GFile
7455 * @res: a #GAsyncResult
7456 * @new_etag: (out) (allow-none): a location of a new [entity tag][gfile-etag]
7457 * for the document. This should be freed with g_free() when it is no
7458 * longer needed, or %NULL
7459 * @error: a #GError, or %NULL
7461 * Finishes an asynchronous replace of the given @file. See
7462 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7463 * tag for the document, if present.
7465 * Returns: %TRUE on success, %FALSE on failure.
7468 g_file_replace_contents_finish (GFile *file,
7474 ReplaceContentsData *data;
7476 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7477 g_return_val_if_fail (g_task_is_valid (res, file), FALSE);
7479 task = G_TASK (res);
7481 if (!g_task_propagate_boolean (task, error))
7484 data = g_task_get_task_data (task);
7488 *new_etag = data->etag;
7489 data->etag = NULL; /* Take ownership */
7496 g_file_real_measure_disk_usage (GFile *file,
7497 GFileMeasureFlags flags,
7498 GCancellable *cancellable,
7499 GFileMeasureProgressCallback progress_callback,
7500 gpointer progress_data,
7501 guint64 *disk_usage,
7506 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7507 "Operation not supported for the current backend.");
7513 GFileMeasureFlags flags;
7514 GFileMeasureProgressCallback progress_callback;
7515 gpointer progress_data;
7527 GFileMeasureProgressCallback callback;
7530 guint64 current_size;
7536 measure_disk_usage_invoke_progress (gpointer user_data)
7538 MeasureProgress *progress = user_data;
7540 (* progress->callback) (progress->reporting,
7541 progress->current_size, progress->num_dirs, progress->num_files,
7542 progress->user_data);
7548 measure_disk_usage_progress (gboolean reporting,
7549 guint64 current_size,
7554 MeasureProgress progress;
7555 GTask *task = user_data;
7556 MeasureTaskData *data;
7558 data = g_task_get_task_data (task);
7560 progress.callback = data->progress_callback;
7561 progress.user_data = data->progress_data;
7562 progress.reporting = reporting;
7563 progress.current_size = current_size;
7564 progress.num_dirs = num_dirs;
7565 progress.num_files = num_files;
7567 g_main_context_invoke_full (g_task_get_context (task),
7568 g_task_get_priority (task),
7569 measure_disk_usage_invoke_progress,
7570 g_memdup (&progress, sizeof progress),
7575 measure_disk_usage_thread (GTask *task,
7576 gpointer source_object,
7578 GCancellable *cancellable)
7580 MeasureTaskData *data = task_data;
7581 GError *error = NULL;
7582 MeasureResult result = { 0, };
7584 if (g_file_measure_disk_usage (source_object, data->flags, cancellable,
7585 data->progress_callback ? measure_disk_usage_progress : NULL, task,
7586 &result.disk_usage, &result.num_dirs, &result.num_files,
7588 g_task_return_pointer (task, g_memdup (&result, sizeof result), g_free);
7590 g_task_return_error (task, error);
7594 g_file_real_measure_disk_usage_async (GFile *file,
7595 GFileMeasureFlags flags,
7597 GCancellable *cancellable,
7598 GFileMeasureProgressCallback progress_callback,
7599 gpointer progress_data,
7600 GAsyncReadyCallback callback,
7603 MeasureTaskData data;
7607 data.progress_callback = progress_callback;
7608 data.progress_data = progress_data;
7610 task = g_task_new (file, cancellable, callback, user_data);
7611 g_task_set_source_tag (task, g_file_real_measure_disk_usage_async);
7612 g_task_set_task_data (task, g_memdup (&data, sizeof data), g_free);
7613 g_task_set_priority (task, io_priority);
7615 g_task_run_in_thread (task, measure_disk_usage_thread);
7616 g_object_unref (task);
7620 g_file_real_measure_disk_usage_finish (GFile *file,
7621 GAsyncResult *result,
7622 guint64 *disk_usage,
7627 MeasureResult *measure_result;
7629 g_return_val_if_fail (g_task_is_valid (result, file), FALSE);
7631 measure_result = g_task_propagate_pointer (G_TASK (result), error);
7633 if (measure_result == NULL)
7637 *disk_usage = measure_result->disk_usage;
7640 *num_dirs = measure_result->num_dirs;
7643 *num_files = measure_result->num_files;
7645 g_free (measure_result);
7651 * g_file_measure_disk_usage:
7653 * @flags: #GFileMeasureFlags
7654 * @cancellable: (allow-none): optional #GCancellable
7655 * @progress_callback: (allow-none): a #GFileMeasureProgressCallback
7656 * @progress_data: user_data for @progress_callback
7657 * @disk_usage: (allow-none) (out): the number of bytes of disk space used
7658 * @num_dirs: (allow-none) (out): the number of directories encountered
7659 * @num_files: (allow-none) (out): the number of non-directories encountered
7660 * @error: (allow-none): %NULL, or a pointer to a %NULL #GError pointer
7662 * Recursively measures the disk usage of @file.
7664 * This is essentially an analog of the 'du' command, but it also
7665 * reports the number of directories and non-directory files encountered
7666 * (including things like symbolic links).
7668 * By default, errors are only reported against the toplevel file
7669 * itself. Errors found while recursing are silently ignored, unless
7670 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7672 * The returned size, @disk_usage, is in bytes and should be formatted
7673 * with g_format_size() in order to get something reasonable for showing
7674 * in a user interface.
7676 * @progress_callback and @progress_data can be given to request
7677 * periodic progress updates while scanning. See the documentation for
7678 * #GFileMeasureProgressCallback for information about when and how the
7679 * callback will be invoked.
7681 * Returns: %TRUE if successful, with the out parameters set.
7682 * %FALSE otherwise, with @error set.
7687 g_file_measure_disk_usage (GFile *file,
7688 GFileMeasureFlags flags,
7689 GCancellable *cancellable,
7690 GFileMeasureProgressCallback progress_callback,
7691 gpointer progress_data,
7692 guint64 *disk_usage,
7697 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7698 g_return_val_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable), FALSE);
7699 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
7701 return G_FILE_GET_IFACE (file)->measure_disk_usage (file, flags, cancellable,
7702 progress_callback, progress_data,
7703 disk_usage, num_dirs, num_files,
7708 * g_file_measure_disk_usage_async:
7710 * @flags: #GFileMeasureFlags
7711 * @io_priority: the [I/O priority][io-priority] of the request
7712 * @cancellable: (allow-none): optional #GCancellable
7713 * @progress_callback: (allow-none): a #GFileMeasureProgressCallback
7714 * @progress_data: user_data for @progress_callback
7715 * @callback: (allow-none): a #GAsyncReadyCallback to call when complete
7716 * @user_data: the data to pass to callback function
7718 * Recursively measures the disk usage of @file.
7720 * This is the asynchronous version of g_file_measure_disk_usage(). See
7721 * there for more information.
7726 g_file_measure_disk_usage_async (GFile *file,
7727 GFileMeasureFlags flags,
7729 GCancellable *cancellable,
7730 GFileMeasureProgressCallback progress_callback,
7731 gpointer progress_data,
7732 GAsyncReadyCallback callback,
7735 g_return_if_fail (G_IS_FILE (file));
7736 g_return_if_fail (cancellable == NULL || G_IS_CANCELLABLE (cancellable));
7738 G_FILE_GET_IFACE (file)->measure_disk_usage_async (file, flags, io_priority, cancellable,
7739 progress_callback, progress_data,
7740 callback, user_data);
7744 * g_file_measure_disk_usage_finish:
7746 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7747 * @disk_usage: (allow-none) (out): the number of bytes of disk space used
7748 * @num_dirs: (allow-none) (out): the number of directories encountered
7749 * @num_files: (allow-none) (out): the number of non-directories encountered
7750 * @error: (allow-none): %NULL, or a pointer to a %NULL #GError pointer
7752 * Collects the results from an earlier call to
7753 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7756 * Returns: %TRUE if successful, with the out parameters set.
7757 * %FALSE otherwise, with @error set.
7762 g_file_measure_disk_usage_finish (GFile *file,
7763 GAsyncResult *result,
7764 guint64 *disk_usage,
7769 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7770 g_return_val_if_fail (error == NULL || *error == NULL, FALSE);
7772 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7776 * g_file_start_mountable:
7777 * @file: input #GFile
7778 * @flags: flags affecting the operation
7779 * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction
7780 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
7781 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7782 * @user_data: the data to pass to callback function
7784 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7785 * Using @start_operation, you can request callbacks when, for instance,
7786 * passwords are needed during authentication.
7788 * If @cancellable is not %NULL, then the operation can be cancelled by
7789 * triggering the cancellable object from another thread. If the operation
7790 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7792 * When the operation is finished, @callback will be called.
7793 * You can then call g_file_mount_mountable_finish() to get
7794 * the result of the operation.
7799 g_file_start_mountable (GFile *file,
7800 GDriveStartFlags flags,
7801 GMountOperation *start_operation,
7802 GCancellable *cancellable,
7803 GAsyncReadyCallback callback,
7808 g_return_if_fail (G_IS_FILE (file));
7810 iface = G_FILE_GET_IFACE (file);
7812 if (iface->start_mountable == NULL)
7814 g_task_report_new_error (file, callback, user_data,
7815 g_file_start_mountable,
7816 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7817 _("Operation not supported"));
7821 (* iface->start_mountable) (file,
7830 * g_file_start_mountable_finish:
7831 * @file: input #GFile
7832 * @result: a #GAsyncResult
7833 * @error: a #GError, or %NULL
7835 * Finishes a start operation. See g_file_start_mountable() for details.
7837 * Finish an asynchronous start operation that was started
7838 * with g_file_start_mountable().
7840 * Returns: %TRUE if the operation finished successfully. %FALSE
7846 g_file_start_mountable_finish (GFile *file,
7847 GAsyncResult *result,
7852 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7853 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7855 if (g_async_result_legacy_propagate_error (result, error))
7857 else if (g_async_result_is_tagged (result, g_file_start_mountable))
7858 return g_task_propagate_boolean (G_TASK (result), error);
7860 iface = G_FILE_GET_IFACE (file);
7861 return (* iface->start_mountable_finish) (file, result, error);
7865 * g_file_stop_mountable:
7866 * @file: input #GFile
7867 * @flags: flags affecting the operation
7868 * @mount_operation: (allow-none): a #GMountOperation,
7869 * or %NULL to avoid user interaction.
7870 * @cancellable: (allow-none): optional #GCancellable object,
7872 * @callback: (allow-none): a #GAsyncReadyCallback to call
7873 * when the request is satisfied, or %NULL
7874 * @user_data: the data to pass to callback function
7876 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
7878 * If @cancellable is not %NULL, then the operation can be cancelled by
7879 * triggering the cancellable object from another thread. If the operation
7880 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7882 * When the operation is finished, @callback will be called.
7883 * You can then call g_file_stop_mountable_finish() to get
7884 * the result of the operation.
7889 g_file_stop_mountable (GFile *file,
7890 GMountUnmountFlags flags,
7891 GMountOperation *mount_operation,
7892 GCancellable *cancellable,
7893 GAsyncReadyCallback callback,
7898 g_return_if_fail (G_IS_FILE (file));
7900 iface = G_FILE_GET_IFACE (file);
7902 if (iface->stop_mountable == NULL)
7904 g_task_report_new_error (file, callback, user_data,
7905 g_file_stop_mountable,
7906 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7907 _("Operation not supported"));
7911 (* iface->stop_mountable) (file,
7920 * g_file_stop_mountable_finish:
7921 * @file: input #GFile
7922 * @result: a #GAsyncResult
7923 * @error: a #GError, or %NULL
7925 * Finishes an stop operation, see g_file_stop_mountable() for details.
7927 * Finish an asynchronous stop operation that was started
7928 * with g_file_stop_mountable().
7930 * Returns: %TRUE if the operation finished successfully.
7936 g_file_stop_mountable_finish (GFile *file,
7937 GAsyncResult *result,
7942 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7943 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7945 if (g_async_result_legacy_propagate_error (result, error))
7947 else if (g_async_result_is_tagged (result, g_file_stop_mountable))
7948 return g_task_propagate_boolean (G_TASK (result), error);
7950 iface = G_FILE_GET_IFACE (file);
7951 return (* iface->stop_mountable_finish) (file, result, error);
7955 * g_file_poll_mountable:
7956 * @file: input #GFile
7957 * @cancellable: optional #GCancellable object, %NULL to ignore
7958 * @callback: (allow-none): a #GAsyncReadyCallback to call
7959 * when the request is satisfied, or %NULL
7960 * @user_data: the data to pass to callback function
7962 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
7964 * If @cancellable is not %NULL, then the operation can be cancelled by
7965 * triggering the cancellable object from another thread. If the operation
7966 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7968 * When the operation is finished, @callback will be called.
7969 * You can then call g_file_mount_mountable_finish() to get
7970 * the result of the operation.
7975 g_file_poll_mountable (GFile *file,
7976 GCancellable *cancellable,
7977 GAsyncReadyCallback callback,
7982 g_return_if_fail (G_IS_FILE (file));
7984 iface = G_FILE_GET_IFACE (file);
7986 if (iface->poll_mountable == NULL)
7988 g_task_report_new_error (file, callback, user_data,
7989 g_file_poll_mountable,
7990 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
7991 _("Operation not supported"));
7995 (* iface->poll_mountable) (file,
8002 * g_file_poll_mountable_finish:
8003 * @file: input #GFile
8004 * @result: a #GAsyncResult
8005 * @error: a #GError, or %NULL
8007 * Finishes a poll operation. See g_file_poll_mountable() for details.
8009 * Finish an asynchronous poll operation that was polled
8010 * with g_file_poll_mountable().
8012 * Returns: %TRUE if the operation finished successfully. %FALSE
8018 g_file_poll_mountable_finish (GFile *file,
8019 GAsyncResult *result,
8024 g_return_val_if_fail (G_IS_FILE (file), FALSE);
8025 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
8027 if (g_async_result_legacy_propagate_error (result, error))
8029 else if (g_async_result_is_tagged (result, g_file_poll_mountable))
8030 return g_task_propagate_boolean (G_TASK (result), error);
8032 iface = G_FILE_GET_IFACE (file);
8033 return (* iface->poll_mountable_finish) (file, result, error);
8037 * g_file_supports_thread_contexts:
8040 * Checks if @file supports
8041 * [thread-default contexts][g-main-context-push-thread-default-context].
8042 * If this returns %FALSE, you cannot perform asynchronous operations on
8043 * @file in a thread that has a thread-default context.
8045 * Returns: Whether or not @file supports thread-default contexts.
8050 g_file_supports_thread_contexts (GFile *file)
8054 g_return_val_if_fail (G_IS_FILE (file), FALSE);
8056 iface = G_FILE_GET_IFACE (file);
8057 return iface->supports_thread_contexts;