1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General
16 * Public License along with this library; if not, write to the
17 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18 * Boston, MA 02111-1307, USA.
20 * Author: Alexander Larsson <alexl@redhat.com>
25 #include <sys/types.h>
31 #include "gioscheduler.h"
32 #include <glocalfile.h>
33 #include "gsimpleasyncresult.h"
34 #include "gfileattribute-priv.h"
35 #include "gpollfilemonitor.h"
42 * @short_description: File and Directory Handling
44 * @see_also: #GFileInfo, #GFileEnumerator
46 * #GFile is a high level abstraction for manipulating files on a
47 * virtual file system. #GFile<!-- -->s are lightweight, immutable
48 * objects that do no I/O upon creation. It is necessary to understand that
49 * #GFile objects do not represent files, merely a handle to a file. All
50 * file I/O is implemented as streaming operations (see #GInputStream and
53 * To construct a #GFile, you can use:
54 * g_file_new_for_path() if you have a path.
55 * g_file_new_for_uri() if you have a URI.
56 * g_file_new_for_commandline_arg() for a command line argument.
58 * You can move through the file system with #GFile handles with
59 * g_file_get_parent() to get a handle to the parent directory.
60 * g_file_get_child() to get a handle to a child within a directory.
61 * g_file_resolve_relative_path() to resolve a relative path between
62 * two #GFile<!-- -->s.
64 * Many #GFile operations have both synchronous and asynchronous versions
65 * to suit your application. Asynchronous versions of synchronous functions
66 * simply have _async() appended to their function names. The asynchronous
67 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
68 * the operation, producing a GAsyncResult which is then passed to the
69 * function's matching _finish()
72 * Some #GFile operations do not have synchronous analogs, as they may
73 * take a very long time to finish, and blocking may leave an application
74 * unusable. Notable cases include:
75 * g_file_mount_mountable() to mount a mountable file.
76 * g_file_unmount_mountable() to unmount a mountable file.
77 * g_file_eject_mountable() to eject a mountable file.
79 * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
80 * One notable feature of #GFile<!-- -->s are entity tags, or "etags" for
81 * short. Entity tags are somewhat like a more abstract version of the
82 * traditional mtime, and can be used to quickly determine if the file has
83 * been modified from the version on the file system. See the HTTP 1.1
84 * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
85 * for HTTP Etag headers, which are a very similar concept.
89 static void g_file_base_init (gpointer g_class);
90 static void g_file_class_init (gpointer g_class,
93 static void g_file_real_query_info_async (GFile *file,
94 const char *attributes,
95 GFileQueryInfoFlags flags,
97 GCancellable *cancellable,
98 GAsyncReadyCallback callback,
100 static GFileInfo * g_file_real_query_info_finish (GFile *file,
103 static void g_file_real_enumerate_children_async (GFile *file,
104 const char *attributes,
105 GFileQueryInfoFlags flags,
107 GCancellable *cancellable,
108 GAsyncReadyCallback callback,
110 static GFileEnumerator * g_file_real_enumerate_children_finish (GFile *file,
113 static void g_file_real_read_async (GFile *file,
115 GCancellable *cancellable,
116 GAsyncReadyCallback callback,
118 static GFileInputStream * g_file_real_read_finish (GFile *file,
121 static void g_file_real_append_to_async (GFile *file,
122 GFileCreateFlags flags,
124 GCancellable *cancellable,
125 GAsyncReadyCallback callback,
127 static GFileOutputStream *g_file_real_append_to_finish (GFile *file,
130 static void g_file_real_create_async (GFile *file,
131 GFileCreateFlags flags,
133 GCancellable *cancellable,
134 GAsyncReadyCallback callback,
136 static GFileOutputStream *g_file_real_create_finish (GFile *file,
139 static void g_file_real_replace_async (GFile *file,
141 gboolean make_backup,
142 GFileCreateFlags flags,
144 GCancellable *cancellable,
145 GAsyncReadyCallback callback,
147 static GFileOutputStream *g_file_real_replace_finish (GFile *file,
150 static gboolean g_file_real_set_attributes_from_info (GFile *file,
152 GFileQueryInfoFlags flags,
153 GCancellable *cancellable,
155 static void g_file_real_set_display_name_async (GFile *file,
156 const char *display_name,
158 GCancellable *cancellable,
159 GAsyncReadyCallback callback,
161 static GFile * g_file_real_set_display_name_finish (GFile *file,
164 static void g_file_real_set_attributes_async (GFile *file,
166 GFileQueryInfoFlags flags,
168 GCancellable *cancellable,
169 GAsyncReadyCallback callback,
171 static gboolean g_file_real_set_attributes_finish (GFile *file,
175 static void g_file_real_find_enclosing_mount_async (GFile *file,
177 GCancellable *cancellable,
178 GAsyncReadyCallback callback,
180 static GMount * g_file_real_find_enclosing_mount_finish (GFile *file,
183 static void g_file_real_copy_async (GFile *source,
185 GFileCopyFlags flags,
187 GCancellable *cancellable,
188 GFileProgressCallback progress_callback,
189 gpointer progress_callback_data,
190 GAsyncReadyCallback callback,
192 static gboolean g_file_real_copy_finish (GFile *file,
197 g_file_get_type (void)
199 static GType file_type = 0;
203 static const GTypeInfo file_info =
205 sizeof (GFileIface), /* class_size */
206 g_file_base_init, /* base_init */
207 NULL, /* base_finalize */
209 NULL, /* class_finalize */
210 NULL, /* class_data */
217 g_type_register_static (G_TYPE_INTERFACE, I_("GFile"),
220 g_type_interface_add_prerequisite (file_type, G_TYPE_OBJECT);
227 g_file_class_init (gpointer g_class,
230 GFileIface *iface = g_class;
232 iface->enumerate_children_async = g_file_real_enumerate_children_async;
233 iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
234 iface->set_display_name_async = g_file_real_set_display_name_async;
235 iface->set_display_name_finish = g_file_real_set_display_name_finish;
236 iface->query_info_async = g_file_real_query_info_async;
237 iface->query_info_finish = g_file_real_query_info_finish;
238 iface->set_attributes_async = g_file_real_set_attributes_async;
239 iface->set_attributes_finish = g_file_real_set_attributes_finish;
240 iface->read_async = g_file_real_read_async;
241 iface->read_finish = g_file_real_read_finish;
242 iface->append_to_async = g_file_real_append_to_async;
243 iface->append_to_finish = g_file_real_append_to_finish;
244 iface->create_async = g_file_real_create_async;
245 iface->create_finish = g_file_real_create_finish;
246 iface->replace_async = g_file_real_replace_async;
247 iface->replace_finish = g_file_real_replace_finish;
248 iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
249 iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
250 iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
251 iface->copy_async = g_file_real_copy_async;
252 iface->copy_finish = g_file_real_copy_finish;
256 g_file_base_init (gpointer g_class)
263 * @file: input #GFile.
265 * Checks to see if a file is native to the platform.
267 * A native file s one expressed in the platform-native filename format,
268 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
269 * as it might be on a locally mounted remote filesystem.
271 * On some systems non-native files may be available using
272 * the native filesystem via a userspace filesystem (FUSE), in
273 * these cases this call will return %FALSE, but g_file_get_path()
274 * will still return a native path.
276 * This call does no blocking i/o.
278 * Returns: %TRUE if file is native.
281 g_file_is_native (GFile *file)
285 g_return_val_if_fail (G_IS_FILE (file), FALSE);
287 iface = G_FILE_GET_IFACE (file);
289 return (* iface->is_native) (file);
294 * g_file_has_uri_scheme:
295 * @file: input #GFile.
296 * @uri_scheme: a string containing a URI scheme.
298 * Checks to see if a #GFile has a given URI scheme.
300 * This call does no blocking i/o.
302 * Returns: %TRUE if #GFile's backend supports the
303 * given URI scheme, %FALSE if URI scheme is %NULL,
304 * not supported, or #GFile is invalid.
307 g_file_has_uri_scheme (GFile *file,
308 const char *uri_scheme)
312 g_return_val_if_fail (G_IS_FILE (file), FALSE);
313 g_return_val_if_fail (uri_scheme != NULL, FALSE);
315 iface = G_FILE_GET_IFACE (file);
317 return (* iface->has_uri_scheme) (file, uri_scheme);
322 * g_file_get_uri_scheme:
323 * @file: input #GFile.
325 * Gets the URI scheme for a #GFile.
326 * RFC 3986 decodes the scheme as:
328 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
330 * Common schemes include "file", "http", "ftp", etc.
332 * This call does no blocking i/o.
334 * Returns: a string containing the URI scheme for the given
335 * #GFile. The returned string should be freed with g_free()
336 * when no longer needed.
339 g_file_get_uri_scheme (GFile *file)
343 g_return_val_if_fail (G_IS_FILE (file), NULL);
345 iface = G_FILE_GET_IFACE (file);
347 return (* iface->get_uri_scheme) (file);
352 * g_file_get_basename:
353 * @file: input #GFile.
355 * Gets the base name (the last component of the path) for a given #GFile.
357 * If called for the top level of a system (such as the filesystem root
358 * or a uri like sftp://host/ it will return a single directory separator
359 * (and on Windows, possibly a drive letter).
361 * This call does no blocking i/o.
363 * Returns: string containing the #GFile's base name, or %NULL
364 * if given #GFile is invalid. The returned string should be
365 * freed with g_free() when no longer needed.
368 g_file_get_basename (GFile *file)
372 g_return_val_if_fail (G_IS_FILE (file), NULL);
374 iface = G_FILE_GET_IFACE (file);
376 return (* iface->get_basename) (file);
381 * @file: input #GFile.
383 * Gets the local pathname for #GFile, if one exists.
385 * This call does no blocking i/o.
387 * Returns: string containing the #GFile's path, or %NULL if
388 * no such path exists. The returned string should be
389 * freed with g_free() when no longer needed.
392 g_file_get_path (GFile *file)
396 g_return_val_if_fail (G_IS_FILE (file), NULL);
398 iface = G_FILE_GET_IFACE (file);
400 return (* iface->get_path) (file);
405 * @file: input #GFile.
407 * Gets the URI for the @file.
409 * This call does no blocking i/o.
411 * Returns: a string containing the #GFile's URI.
412 * The returned string should be freed with g_free() when no longer needed.
415 g_file_get_uri (GFile *file)
419 g_return_val_if_fail (G_IS_FILE (file), NULL);
421 iface = G_FILE_GET_IFACE (file);
423 return (* iface->get_uri) (file);
427 * g_file_get_parse_name:
428 * @file: input #GFile.
430 * Gets the parse name of the @file.
431 * A parse name is a UTF-8 string that describes the
432 * file such that one can get the #GFile back using
433 * g_file_parse_name().
435 * This is generally used to show the #GFile as a nice
436 * string in a user interface, like in a location entry.
438 * For local files with names that can safely be converted
439 * to UTF8 the pathname is used, otherwise the IRI is used
440 * (a form of URI that allows UTF8 characters unescaped).
442 * This call does no blocking i/o.
444 * Returns: a string containing the #GFile's parse name. The returned
445 * string should be freed with g_free() when no longer needed.
448 g_file_get_parse_name (GFile *file)
452 g_return_val_if_fail (G_IS_FILE (file), NULL);
454 iface = G_FILE_GET_IFACE (file);
456 return (* iface->get_parse_name) (file);
461 * @file: input #GFile.
463 * Duplicates a #GFile handle. This operation does not duplicate
464 * the actual file or directory represented by the #GFile; see
465 * g_file_copy() if attempting to copy a file.
467 * This call does no blocking i/o.
469 * Returns: #GFile that is a duplicate of the given #GFile.
472 g_file_dup (GFile *file)
476 g_return_val_if_fail (G_IS_FILE (file), NULL);
478 iface = G_FILE_GET_IFACE (file);
480 return (* iface->dup) (file);
485 * @file: #gconstpointer to a #GFile.
487 * Creates a hash value for a #GFile.
489 * This call does no blocking i/o.
491 * Returns: 0 if @file is not a valid #GFile, otherwise an
492 * integer that can be used as hash value for the #GFile.
493 * This function is intended for easily hashing a #GFile to
494 * add to a #GHashTable or similar data structure.
497 g_file_hash (gconstpointer file)
501 g_return_val_if_fail (G_IS_FILE (file), 0);
503 iface = G_FILE_GET_IFACE (file);
505 return (* iface->hash) ((GFile *)file);
510 * @file1: the first #GFile.
511 * @file2: the second #GFile.
513 * Checks equality of two given #GFile<!-- -->s
515 * This call does no blocking i/o.
517 * Returns: %TRUE if @file1 and @file2 are equal.
518 * %FALSE if either is not a #GFile.
521 g_file_equal (GFile *file1,
526 g_return_val_if_fail (G_IS_FILE (file1), FALSE);
527 g_return_val_if_fail (G_IS_FILE (file2), FALSE);
529 if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
532 iface = G_FILE_GET_IFACE (file1);
534 return (* iface->equal) (file1, file2);
540 * @file: input #GFile.
542 * Gets the parent directory for the @file.
543 * If the @file represents the root directory of the
544 * file system, then %NULL will be returned.
546 * This call does no blocking i/o.
548 * Returns: a #GFile structure to the parent of the given
549 * #GFile or %NULL if there is no parent.
552 g_file_get_parent (GFile *file)
556 g_return_val_if_fail (G_IS_FILE (file), NULL);
558 iface = G_FILE_GET_IFACE (file);
560 return (* iface->get_parent) (file);
565 * @file: input #GFile.
566 * @name: string containing the child's name.
568 * Gets a specific child of @file with name equal to @name.
570 * Note that the file with that specific name might not exist, but
571 * you can still have a #GFile that points to it. You can use this
572 * for instance to create that file.
574 * This call does no blocking i/o.
576 * Returns: a #GFile to a child specified by @name.
579 g_file_get_child (GFile *file,
582 g_return_val_if_fail (G_IS_FILE (file), NULL);
583 g_return_val_if_fail (name != NULL, NULL);
585 return g_file_resolve_relative_path (file, name);
589 * g_file_get_child_for_display_name:
590 * @file: input #GFile.
591 * @display_name: string to a possible child.
594 * Gets the child of @file for a given @display_name (i.e. a UTF8
595 * version of the name). If this function fails, it returns %NULL and @error will be
596 * set. This is very useful when constructing a GFile for a new file
597 * and the user entered the filename in the user interface, for instance
598 * when you select a directory and type a filename in the file selector.
600 * This call does no blocking i/o.
602 * Returns: a #GFile to the specified child, or
603 * %NULL if the display name couldn't be converted.
606 g_file_get_child_for_display_name (GFile *file,
607 const char *display_name,
612 g_return_val_if_fail (G_IS_FILE (file), NULL);
613 g_return_val_if_fail (display_name != NULL, NULL);
615 iface = G_FILE_GET_IFACE (file);
617 return (* iface->get_child_for_display_name) (file, display_name, error);
621 * g_file_contains_file:
622 * @parent: input #GFile.
623 * @descendant: input #GFile.
625 * Checks whether @parent (recursively) contains the specified @descendant.
627 * This call does no blocking i/o.
629 * Returns: %TRUE if the @descendant's parent, grandparent, etc is @parent. %FALSE otherwise.
632 g_file_contains_file (GFile *parent,
637 g_return_val_if_fail (G_IS_FILE (parent), FALSE);
638 g_return_val_if_fail (G_IS_FILE (descendant), FALSE);
640 if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
643 iface = G_FILE_GET_IFACE (parent);
645 return (* iface->contains_file) (parent, descendant);
649 * g_file_get_relative_path:
650 * @parent: input #GFile.
651 * @descendant: input #GFile.
653 * Gets the path for @descendant relative to @parent.
655 * This call does no blocking i/o.
657 * Returns: string with the relative path from @descendant
658 * to @parent, or %NULL if @descendant is not a descendant of @parent. The returned string should be freed with
659 * g_free() when no longer needed.
662 g_file_get_relative_path (GFile *parent,
667 g_return_val_if_fail (G_IS_FILE (parent), NULL);
668 g_return_val_if_fail (G_IS_FILE (descendant), NULL);
670 if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
673 iface = G_FILE_GET_IFACE (parent);
675 return (* iface->get_relative_path) (parent, descendant);
679 * g_file_resolve_relative_path:
680 * @file: input #GFile.
681 * @relative_path: a given relative path string.
683 * Resolves a relative path for @file to an absolute path.
685 * This call does no blocking i/o.
687 * Returns: #GFile to the resolved path. %NULL if @relative_path
688 * is %NULL or if @file is invalid.
691 g_file_resolve_relative_path (GFile *file,
692 const char *relative_path)
696 g_return_val_if_fail (G_IS_FILE (file), NULL);
697 g_return_val_if_fail (relative_path != NULL, NULL);
699 iface = G_FILE_GET_IFACE (file);
701 return (* iface->resolve_relative_path) (file, relative_path);
705 * g_file_enumerate_children:
706 * @file: input #GFile.
707 * @attributes: an attribute query string.
708 * @flags: a set of #GFileQueryInfoFlags.
709 * @cancellable: optional #GCancellable object, %NULL to ignore.
710 * @error: #GError for error reporting.
712 * Gets the requested information about the files in a directory. The result
713 * is a #GFileEnumerator object that will give out #GFileInfo objects for
714 * all the files in the directory.
716 * The @attribute value is a string that specifies the file attributes that
717 * should be gathered. It is not an error if it's not possible to read a particular
718 * requested attribute from a file - it just won't be set. @attribute should
719 * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
720 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
721 * namespace. An example attribute query be "standard::*,owner::user".
722 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
724 * If @cancellable is not %NULL, then the operation can be cancelled by
725 * triggering the cancellable object from another thread. If the operation
726 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
728 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
729 * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
730 * Other errors are possible too.
732 * Returns: A #GFileEnumerator if successful, %NULL on error.
735 g_file_enumerate_children (GFile *file,
736 const char *attributes,
737 GFileQueryInfoFlags flags,
738 GCancellable *cancellable,
744 g_return_val_if_fail (G_IS_FILE (file), NULL);
746 if (g_cancellable_set_error_if_cancelled (cancellable, error))
749 iface = G_FILE_GET_IFACE (file);
751 if (iface->enumerate_children == NULL)
753 g_set_error (error, G_IO_ERROR,
754 G_IO_ERROR_NOT_SUPPORTED,
755 _("Operation not supported"));
759 return (* iface->enumerate_children) (file, attributes, flags,
764 * g_file_enumerate_children_async:
765 * @file: input #GFile.
766 * @attributes: an attribute query string.
767 * @flags: a set of #GFileQueryInfoFlags.
768 * @io_priority: the <link linkend="io-priority">I/O priority</link>
770 * @cancellable: optional #GCancellable object, %NULL to ignore.
771 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
772 * @user_data: the data to pass to callback function
774 * Asynchronously gets the requested information about the files in a directory. The result
775 * is a #GFileEnumerator object that will give out #GFileInfo objects for
776 * all the files in the directory.
778 * For more details, see g_file_enumerate_children() which is
779 * the synchronous version of this call.
781 * When the operation is finished, @callback will be called. You can then call
782 * g_file_enumerate_children_finish() to get the result of the operation.
785 g_file_enumerate_children_async (GFile *file,
786 const char *attributes,
787 GFileQueryInfoFlags flags,
789 GCancellable *cancellable,
790 GAsyncReadyCallback callback,
795 g_return_if_fail (G_IS_FILE (file));
797 iface = G_FILE_GET_IFACE (file);
798 (* iface->enumerate_children_async) (file,
808 * g_file_enumerate_children_finish:
809 * @file: input #GFile.
810 * @res: a #GAsyncResult.
813 * Finishes an async enumerate children operation.
814 * See g_file_enumerate_children_async().
816 * Returns: a #GFileEnumerator or %NULL if an error occurred.
819 g_file_enumerate_children_finish (GFile *file,
825 g_return_val_if_fail (G_IS_FILE (file), NULL);
826 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
828 if (G_IS_SIMPLE_ASYNC_RESULT (res))
830 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
831 if (g_simple_async_result_propagate_error (simple, error))
835 iface = G_FILE_GET_IFACE (file);
836 return (* iface->enumerate_children_finish) (file, res, error);
840 * g_file_query_exists:
841 * @file: input #GFile.
842 * @cancellable: optional #GCancellable object, %NULL to ignore.
844 * Utility function to check if a particular file exists. This is
845 * implemented using g_file_query_info() and as such does blocking I/O.
847 * Note that in many cases it is racy to first check for file existance
848 * and then execute something based on the outcome of that, because the
849 * file might have been created or removed inbetween the operations. The
850 * general approach to handling that is to not check, but just do the
851 * operation and handle the errors as they come.
853 * As an example of race-free checking, take the case of reading a file, and
854 * if it doesn't exist, creating it. There are two racy versions: read it, and
855 * on error create it; and: check if it exists, if not create it. These
856 * can both result in two processes creating the file (with perhaps a partially
857 * written file as the result). The correct approach is to always try to create
858 * the file with g_file_create() which will either atomically create the file
859 * or fail with a G_IO_ERROR_EXISTS error.
861 * However, in many cases an existance check is useful in a user
862 * interface, for instance to make a menu item sensitive/insensitive, so that
863 * you don't have to fool users that something is possible and then just show
864 * and error dialog. If you do this, you should make sure to also handle the
865 * errors that can happen due to races when you execute the operation.
867 * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
870 g_file_query_exists (GFile *file,
871 GCancellable *cancellable)
875 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
876 G_FILE_QUERY_INFO_NONE,
880 g_object_unref (info);
889 * @file: input #GFile.
890 * @attributes: an attribute query string.
891 * @flags: a set of #GFileQueryInfoFlags.
892 * @cancellable: optional #GCancellable object, %NULL to ignore.
895 * Gets the requested information about specified @file. The result
896 * is a #GFileInfo object that contains key-value attributes (such as
897 * the type or size of the file).
899 * The @attribute value is a string that specifies the file attributes that
900 * should be gathered. It is not an error if it's not possible to read a particular
901 * requested attribute from a file - it just won't be set. @attribute should
902 * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
903 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
904 * namespace. An example attribute query be "standard::*,owner::user".
905 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
907 * If @cancellable is not %NULL, then the operation can be cancelled by
908 * triggering the cancellable object from another thread. If the operation
909 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
911 * For symlinks, normally the information about the target of the
912 * symlink is returned, rather than information about the symlink itself.
913 * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
914 * information about the symlink itself will be returned. Also, for symlinks
915 * that point to non-existing files the information about the symlink itself
918 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
919 * Other errors are possible too, and depend on what kind of filesystem the file is on.
921 * Returns: a #GFileInfo for the given @file, or %NULL on error.
924 g_file_query_info (GFile *file,
925 const char *attributes,
926 GFileQueryInfoFlags flags,
927 GCancellable *cancellable,
932 g_return_val_if_fail (G_IS_FILE (file), NULL);
934 if (g_cancellable_set_error_if_cancelled (cancellable, error))
937 iface = G_FILE_GET_IFACE (file);
939 if (iface->query_info == NULL)
941 g_set_error (error, G_IO_ERROR,
942 G_IO_ERROR_NOT_SUPPORTED,
943 _("Operation not supported"));
947 return (* iface->query_info) (file, attributes, flags, cancellable, error);
951 * g_file_query_info_async:
952 * @file: input #GFile.
953 * @attributes: an attribute query string.
954 * @flags: a set of #GFileQueryInfoFlags.
955 * @io_priority: the <link linkend="io-priority">I/O priority</link>
957 * @cancellable: optional #GCancellable object, %NULL to ignore.
958 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
959 * @user_data: the data to pass to callback function
961 * Asynchronously gets the requested information about specified @file. The result
962 * is a #GFileInfo object that contains key-value attributes (such as type or size
965 * For more details, see g_file_query_info() which is
966 * the synchronous version of this call.
968 * When the operation is finished, @callback will be called. You can then call
969 * g_file_query_info_finish() to get the result of the operation.
972 g_file_query_info_async (GFile *file,
973 const char *attributes,
974 GFileQueryInfoFlags flags,
976 GCancellable *cancellable,
977 GAsyncReadyCallback callback,
982 g_return_if_fail (G_IS_FILE (file));
984 iface = G_FILE_GET_IFACE (file);
985 (* iface->query_info_async) (file,
995 * g_file_query_info_finish:
996 * @file: input #GFile.
997 * @res: a #GAsyncResult.
1000 * Finishes an asynchronous file info query.
1001 * See g_file_query_info_async().
1003 * Returns: #GFileInfo for given @file or %NULL on error.
1006 g_file_query_info_finish (GFile *file,
1012 g_return_val_if_fail (G_IS_FILE (file), NULL);
1013 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1015 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1017 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1018 if (g_simple_async_result_propagate_error (simple, error))
1022 iface = G_FILE_GET_IFACE (file);
1023 return (* iface->query_info_finish) (file, res, error);
1027 * g_file_query_filesystem_info:
1028 * @file: input #GFile.
1029 * @attributes: an attribute query string.
1030 * @cancellable: optional #GCancellable object, %NULL to ignore.
1031 * @error: a #GError.
1033 * Similar to g_file_query_info(), but obtains information
1034 * about the filesystem the @file is on, rather than the file itself.
1035 * For instance the amount of space available and the type of
1038 * The @attribute value is a string that specifies the file attributes that
1039 * should be gathered. It is not an error if it's not possible to read a particular
1040 * requested attribute from a file - it just won't be set. @attribute should
1041 * be a comma-separated list of attribute or attribute wildcards. The wildcard "*"
1042 * means all attributes, and a wildcard like "fs:*" means all attributes in the fs
1043 * namespace. The standard namespace for filesystem attributes is "fs".
1044 * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
1045 * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
1046 * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1048 * If @cancellable is not %NULL, then the operation can be cancelled by
1049 * triggering the cancellable object from another thread. If the operation
1050 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1052 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1053 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1055 * Returns: a #GFileInfo or %NULL if there was an error.
1058 g_file_query_filesystem_info (GFile *file,
1059 const char *attributes,
1060 GCancellable *cancellable,
1065 g_return_val_if_fail (G_IS_FILE (file), NULL);
1067 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1070 iface = G_FILE_GET_IFACE (file);
1072 if (iface->query_filesystem_info == NULL)
1074 g_set_error (error, G_IO_ERROR,
1075 G_IO_ERROR_NOT_SUPPORTED,
1076 _("Operation not supported"));
1080 return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1084 * g_file_find_enclosing_mount:
1085 * @file: input #GFile.
1086 * @cancellable: optional #GCancellable object, %NULL to ignore.
1087 * @error: a #GError.
1089 * Gets a #GMount for the #GFile.
1091 * If the #GFileIface for @file does not have a mount (e.g. possibly a
1092 * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
1095 * If @cancellable is not %NULL, then the operation can be cancelled by
1096 * triggering the cancellable object from another thread. If the operation
1097 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1099 * Returns: a #GMount where the @file is located or %NULL on error.
1102 g_file_find_enclosing_mount (GFile *file,
1103 GCancellable *cancellable,
1108 g_return_val_if_fail (G_IS_FILE (file), NULL);
1110 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1113 iface = G_FILE_GET_IFACE (file);
1114 if (iface->find_enclosing_mount == NULL)
1116 g_set_error (error, G_IO_ERROR,
1117 G_IO_ERROR_NOT_FOUND,
1118 _("Containing mount does not exist"));
1122 return (* iface->find_enclosing_mount) (file, cancellable, error);
1125 * g_file_find_enclosing_mount_async:
1127 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1129 * @cancellable: optional #GCancellable object, %NULL to ignore.
1130 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1131 * @user_data: the data to pass to callback function
1133 * Asynchronously gets the mount for the file.
1135 * For more details, see g_file_find_enclosing_mount() which is
1136 * the synchronous version of this call.
1138 * When the operation is finished, @callback will be called. You can then call
1139 * g_file_find_enclosing_mount_finish() to get the result of the operation.
1142 g_file_find_enclosing_mount_async (GFile *file,
1144 GCancellable *cancellable,
1145 GAsyncReadyCallback callback,
1150 g_return_if_fail (G_IS_FILE (file));
1152 iface = G_FILE_GET_IFACE (file);
1153 (* iface->find_enclosing_mount_async) (file,
1161 * g_file_find_enclosing_mount_finish:
1163 * @res: a #GAsyncResult
1166 * Finishes an asynchronous find mount request.
1167 * See g_file_find_enclosing_mount_async().
1169 * Returns: #GMount for given @file or %NULL on error.
1172 g_file_find_enclosing_mount_finish (GFile *file,
1178 g_return_val_if_fail (G_IS_FILE (file), NULL);
1179 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1181 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1183 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1184 if (g_simple_async_result_propagate_error (simple, error))
1188 iface = G_FILE_GET_IFACE (file);
1189 return (* iface->find_enclosing_mount_finish) (file, res, error);
1195 * @file: #GFile to read.
1196 * @cancellable: a #GCancellable
1197 * @error: a #GError, or %NULL
1199 * Opens a file for reading. The result is a #GFileInputStream that
1200 * can be used to read the contents of the file.
1202 * If @cancellable is not %NULL, then the operation can be cancelled by
1203 * triggering the cancellable object from another thread. If the operation
1204 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1206 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1207 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1208 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1210 * Returns: #GFileInputStream or %NULL on error.
1213 g_file_read (GFile *file,
1214 GCancellable *cancellable,
1219 g_return_val_if_fail (G_IS_FILE (file), NULL);
1221 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1224 iface = G_FILE_GET_IFACE (file);
1226 if (iface->read_fn == NULL)
1228 g_set_error (error, G_IO_ERROR,
1229 G_IO_ERROR_NOT_SUPPORTED,
1230 _("Operation not supported"));
1234 return (* iface->read_fn) (file, cancellable, error);
1239 * @file: input #GFile.
1240 * @flags: a set of #GFileCreateFlags.
1241 * @cancellable: optional #GCancellable object, %NULL to ignore.
1242 * @error: a #GError, or %NULL
1244 * Gets an output stream for appending data to the file. If
1245 * the file doesn't already exist it is created.
1247 * By default files created are generally readable by everyone,
1248 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1249 * will be made readable only to the current user, to the level that
1250 * is supported on the target filesystem.
1252 * If @cancellable is not %NULL, then the operation can be cancelled by
1253 * triggering the cancellable object from another thread. If the operation
1254 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1256 * Some file systems don't allow all file names, and may
1257 * return an G_IO_ERROR_INVALID_FILENAME error.
1258 * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be
1259 * returned. Other errors are possible too, and depend on what kind of
1260 * filesystem the file is on.
1262 * Returns: a #GFileOutputStream.
1265 g_file_append_to (GFile *file,
1266 GFileCreateFlags flags,
1267 GCancellable *cancellable,
1272 g_return_val_if_fail (G_IS_FILE (file), NULL);
1274 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1277 iface = G_FILE_GET_IFACE (file);
1279 if (iface->append_to == NULL)
1281 g_set_error (error, G_IO_ERROR,
1282 G_IO_ERROR_NOT_SUPPORTED,
1283 _("Operation not supported"));
1287 return (* iface->append_to) (file, flags, cancellable, error);
1292 * @file: input #GFile.
1293 * @flags: a set of #GFileCreateFlags.
1294 * @cancellable: optional #GCancellable object, %NULL to ignore.
1295 * @error: a #GError, or %NULL
1297 * Creates a new file and returns an output stream for writing to it.
1298 * The file must not already exists.
1300 * By default files created are generally readable by everyone,
1301 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1302 * will be made readable only to the current user, to the level that
1303 * is supported on the target filesystem.
1305 * If @cancellable is not %NULL, then the operation can be cancelled by
1306 * triggering the cancellable object from another thread. If the operation
1307 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1309 * If a file with this name already exists the G_IO_ERROR_EXISTS error
1310 * will be returned. If the file is a directory the G_IO_ERROR_IS_DIRECTORY
1311 * error will be returned.
1312 * Some file systems don't allow all file names, and may
1313 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1314 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1315 * Other errors are possible too, and depend on what kind of
1316 * filesystem the file is on.
1318 * Returns: a #GFileOutputStream for the newly created file, or
1322 g_file_create (GFile *file,
1323 GFileCreateFlags flags,
1324 GCancellable *cancellable,
1329 g_return_val_if_fail (G_IS_FILE (file), NULL);
1331 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1334 iface = G_FILE_GET_IFACE (file);
1336 if (iface->create == NULL)
1338 g_set_error (error, G_IO_ERROR,
1339 G_IO_ERROR_NOT_SUPPORTED,
1340 _("Operation not supported"));
1344 return (* iface->create) (file, flags, cancellable, error);
1349 * @file: input #GFile.
1350 * @etag: an optional <link linkend="gfile-etag">entity tag</link> for the
1351 * current #GFile, or #NULL to ignore.
1352 * @make_backup: %TRUE if a backup should be created.
1353 * @flags: a set of #GFileCreateFlags.
1354 * @cancellable: optional #GCancellable object, %NULL to ignore.
1355 * @error: a #GError, or %NULL
1357 * Returns an output stream for overwriting the file, possibly
1358 * creating a backup copy of the file first.
1360 * This will try to replace the file in the safest way possible so
1361 * that any errors during the writing will not affect an already
1362 * existing copy of the file. For instance, for local files it
1363 * may write to a temporary file and then atomically rename over
1364 * the destination when the stream is closed.
1366 * By default files created are generally readable by everyone,
1367 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1368 * will be made readable only to the current user, to the level that
1369 * is supported on the target filesystem.
1371 * If @cancellable is not %NULL, then the operation can be cancelled by
1372 * triggering the cancellable object from another thread. If the operation
1373 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1375 * If you pass in a non-#NULL @etag value, then this value is
1376 * compared to the current entity tag of the file, and if they differ
1377 * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
1378 * that the file has been changed since you last read it. You can get
1379 * the new etag from g_file_output_stream_get_etag() after you've
1380 * finished writing and closed the #GFileOutputStream. When you load
1381 * a new file you can use g_file_input_stream_query_info() to get
1382 * the etag of the file.
1384 * If @make_backup is %TRUE, this function will attempt to make a backup
1385 * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
1386 * error will be returned. If you want to replace anyway, try again with
1387 * @make_backup set to %FALSE.
1389 * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
1390 * and if the file is some other form of non-regular file then a
1391 * G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
1392 * Some file systems don't allow all file names, and may
1393 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1394 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1395 * Other errors are possible too, and depend on what kind of
1396 * filesystem the file is on.
1398 * Returns: a #GFileOutputStream or %NULL on error.
1401 g_file_replace (GFile *file,
1403 gboolean make_backup,
1404 GFileCreateFlags flags,
1405 GCancellable *cancellable,
1410 g_return_val_if_fail (G_IS_FILE (file), NULL);
1412 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1415 iface = G_FILE_GET_IFACE (file);
1417 if (iface->replace == NULL)
1419 g_set_error (error, G_IO_ERROR,
1420 G_IO_ERROR_NOT_SUPPORTED,
1421 _("Operation not supported"));
1426 /* Handle empty tag string as NULL in consistent way. */
1427 if (etag && *etag == 0)
1430 return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1434 * g_file_read_async:
1435 * @file: input #GFile.
1436 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1438 * @cancellable: optional #GCancellable object, %NULL to ignore.
1439 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1440 * @user_data: the data to pass to callback function
1442 * Asynchronously opens @file for reading.
1444 * For more details, see g_file_read() which is
1445 * the synchronous version of this call.
1447 * When the operation is finished, @callback will be called. You can then call
1448 * g_file_read_finish() to get the result of the operation.
1451 g_file_read_async (GFile *file,
1453 GCancellable *cancellable,
1454 GAsyncReadyCallback callback,
1459 g_return_if_fail (G_IS_FILE (file));
1461 iface = G_FILE_GET_IFACE (file);
1462 (* iface->read_async) (file,
1470 * g_file_read_finish:
1471 * @file: input #GFile.
1472 * @res: a #GAsyncResult.
1473 * @error: a #GError, or %NULL
1475 * Finishes an asynchronous file read operation started with
1476 * g_file_read_async().
1478 * Returns: a #GFileInputStream or %NULL on error.
1481 g_file_read_finish (GFile *file,
1487 g_return_val_if_fail (G_IS_FILE (file), NULL);
1488 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1490 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1492 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1493 if (g_simple_async_result_propagate_error (simple, error))
1497 iface = G_FILE_GET_IFACE (file);
1498 return (* iface->read_finish) (file, res, error);
1502 * g_file_append_to_async:
1503 * @file: input #GFile.
1504 * @flags: a set of #GFileCreateFlags.
1505 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1507 * @cancellable: optional #GCancellable object, %NULL to ignore.
1508 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1509 * @user_data: the data to pass to callback function
1511 * Asynchronously opens @file for appending.
1513 * For more details, see g_file_append_to() which is
1514 * the synchronous version of this call.
1516 * When the operation is finished, @callback will be called. You can then call
1517 * g_file_append_to_finish() to get the result of the operation.
1520 g_file_append_to_async (GFile *file,
1521 GFileCreateFlags flags,
1523 GCancellable *cancellable,
1524 GAsyncReadyCallback callback,
1529 g_return_if_fail (G_IS_FILE (file));
1531 iface = G_FILE_GET_IFACE (file);
1532 (* iface->append_to_async) (file,
1541 * g_file_append_to_finish:
1542 * @file: input #GFile.
1543 * @res: #GAsyncResult
1544 * @error: a #GError, or %NULL
1546 * Finishes an asynchronous file append operation started with
1547 * g_file_append_to_async().
1549 * Returns: a valid #GFileOutputStream or %NULL on error.
1552 g_file_append_to_finish (GFile *file,
1558 g_return_val_if_fail (G_IS_FILE (file), NULL);
1559 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1561 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1563 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1564 if (g_simple_async_result_propagate_error (simple, error))
1568 iface = G_FILE_GET_IFACE (file);
1569 return (* iface->append_to_finish) (file, res, error);
1573 * g_file_create_async:
1574 * @file: input #GFile.
1575 * @flags: a set of #GFileCreateFlags.
1576 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1578 * @cancellable: optional #GCancellable object, %NULL to ignore.
1579 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1580 * @user_data: the data to pass to callback function
1582 * Asynchronously creates a new file and returns an output stream for writing to it.
1583 * The file must not already exists.
1585 * For more details, see g_file_create() which is
1586 * the synchronous version of this call.
1588 * When the operation is finished, @callback will be called. You can then call
1589 * g_file_create_finish() to get the result of the operation.
1592 g_file_create_async (GFile *file,
1593 GFileCreateFlags flags,
1595 GCancellable *cancellable,
1596 GAsyncReadyCallback callback,
1601 g_return_if_fail (G_IS_FILE (file));
1603 iface = G_FILE_GET_IFACE (file);
1604 (* iface->create_async) (file,
1613 * g_file_create_finish:
1614 * @file: input #GFile.
1615 * @res: a #GAsyncResult.
1616 * @error: a #GError, or %NULL
1618 * Finishes an asynchronous file create operation started with
1619 * g_file_create_async().
1621 * Returns: a #GFileOutputStream or %NULL on error.
1624 g_file_create_finish (GFile *file,
1630 g_return_val_if_fail (G_IS_FILE (file), NULL);
1631 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1633 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1635 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1636 if (g_simple_async_result_propagate_error (simple, error))
1640 iface = G_FILE_GET_IFACE (file);
1641 return (* iface->create_finish) (file, res, error);
1645 * g_file_replace_async:
1646 * @file: input #GFile.
1647 * @etag: an <link linkend="gfile-etag">entity tag</link> for the
1648 * current #GFile, or NULL to ignore.
1649 * @make_backup: %TRUE if a backup should be created.
1650 * @flags: a set of #GFileCreateFlags.
1651 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1653 * @cancellable: optional #GCancellable object, %NULL to ignore.
1654 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
1655 * @user_data: the data to pass to callback function
1657 * Asynchronously overwrites the file, replacing the contents, possibly
1658 * creating a backup copy of the file first.
1660 * For more details, see g_file_replace() which is
1661 * the synchronous version of this call.
1663 * When the operation is finished, @callback will be called. You can then call
1664 * g_file_replace_finish() to get the result of the operation.
1667 g_file_replace_async (GFile *file,
1669 gboolean make_backup,
1670 GFileCreateFlags flags,
1672 GCancellable *cancellable,
1673 GAsyncReadyCallback callback,
1678 g_return_if_fail (G_IS_FILE (file));
1680 iface = G_FILE_GET_IFACE (file);
1681 (* iface->replace_async) (file,
1692 * g_file_replace_finish:
1693 * @file: input #GFile.
1694 * @res: a #GAsyncResult.
1695 * @error: a #GError, or %NULL
1697 * Finishes an asynchronous file replace operation started with
1698 * g_file_replace_async().
1700 * Returns: a #GFileOutputStream, or %NULL on error.
1703 g_file_replace_finish (GFile *file,
1709 g_return_val_if_fail (G_IS_FILE (file), NULL);
1710 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1712 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1714 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1715 if (g_simple_async_result_propagate_error (simple, error))
1719 iface = G_FILE_GET_IFACE (file);
1720 return (* iface->replace_finish) (file, res, error);
1724 copy_symlink (GFile *destination,
1725 GFileCopyFlags flags,
1726 GCancellable *cancellable,
1731 gboolean tried_delete;
1733 GFileType file_type;
1735 tried_delete = FALSE;
1739 if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
1741 /* Maybe it already existed, and we want to overwrite? */
1742 if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
1743 my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
1745 g_error_free (my_error);
1748 /* Don't overwrite if the destination is a directory */
1749 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1750 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
1751 cancellable, &my_error);
1754 file_type = g_file_info_get_file_type (info);
1755 g_object_unref (info);
1757 if (file_type == G_FILE_TYPE_DIRECTORY)
1759 g_set_error (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
1760 _("Can't copy over directory"));
1765 if (!g_file_delete (destination, cancellable, error))
1768 tried_delete = TRUE;
1772 g_propagate_error (error, my_error);
1779 static GInputStream *
1780 open_source_for_copy (GFile *source,
1782 GFileCopyFlags flags,
1783 GCancellable *cancellable,
1789 GFileType file_type;
1792 in = (GInputStream *)g_file_read (source, cancellable, &my_error);
1796 /* There was an error opening the source, try to set a good error for it: */
1798 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
1800 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
1801 * as that is less useful to the app. Better check for errors on the
1804 g_error_free (my_error);
1807 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1808 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
1809 cancellable, &my_error);
1812 file_type = g_file_info_get_file_type (info);
1813 g_object_unref (info);
1815 if (flags & G_FILE_COPY_OVERWRITE)
1817 if (file_type == G_FILE_TYPE_DIRECTORY)
1819 g_set_error (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
1820 _("Can't copy directory over directory"));
1823 /* continue to would_recurse error */
1827 g_set_error (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
1828 _("Target file exists"));
1834 /* Error getting info from target, return that error
1835 * (except for NOT_FOUND, which is no error here)
1837 if (my_error->domain != G_IO_ERROR && my_error->code != G_IO_ERROR_NOT_FOUND)
1839 g_propagate_error (error, my_error);
1842 g_error_free (my_error);
1845 g_set_error (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
1846 _("Can't recursively copy directory"));
1850 g_propagate_error (error, my_error);
1855 should_copy (GFileAttributeInfo *info,
1859 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
1860 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
1864 build_attribute_list_for_copy (GFileAttributeInfoList *attributes,
1865 GFileAttributeInfoList *namespaces,
1873 s = g_string_new ("");
1877 for (i = 0; i < attributes->n_infos; i++)
1879 if (should_copy (&attributes->infos[i], as_move))
1884 g_string_append_c (s, ',');
1886 g_string_append (s, attributes->infos[i].name);
1893 for (i = 0; i < namespaces->n_infos; i++)
1895 if (should_copy (&namespaces->infos[i], as_move))
1900 g_string_append_c (s, ',');
1902 g_string_append (s, namespaces->infos[i].name);
1903 g_string_append (s, ":*");
1908 return g_string_free (s, FALSE);
1912 * g_file_copy_attributes:
1913 * @source: a #GFile with attributes.
1914 * @destination: a #GFile to copy attributes to.
1915 * @flags: a set of #GFileCopyFlags.
1916 * @cancellable: optional #GCancellable object, %NULL to ignore.
1917 * @error: a #GError, %NULL to ignore.
1919 * Copies the file attributes from @source to @destination.
1921 * Normally only a subset of the file attributes are copied,
1922 * those that are copies in a normal file copy operation
1923 * (which for instance does not include e.g. mtime). However
1924 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
1925 * all the metadata that is possible to copy is copied.
1927 * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise.
1930 g_file_copy_attributes (GFile *source,
1932 GFileCopyFlags flags,
1933 GCancellable *cancellable,
1936 GFileAttributeInfoList *attributes, *namespaces;
1937 char *attrs_to_read;
1941 gboolean source_nofollow_symlinks;
1943 as_move = flags & G_FILE_COPY_ALL_METADATA;
1944 source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
1946 /* Ignore errors here, if the target supports no attributes there is nothing to copy */
1947 attributes = g_file_query_settable_attributes (destination, cancellable, NULL);
1948 namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL);
1950 if (attributes == NULL && namespaces == NULL)
1953 attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move);
1955 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
1956 * we just don't copy it.
1958 info = g_file_query_info (source, attrs_to_read,
1959 source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
1963 g_free (attrs_to_read);
1968 res = g_file_set_attributes_from_info (destination,
1972 g_object_unref (info);
1975 g_file_attribute_info_list_unref (attributes);
1976 g_file_attribute_info_list_unref (namespaces);
1981 /* Closes the streams */
1983 copy_stream_with_progress (GInputStream *in,
1985 GCancellable *cancellable,
1986 GFileProgressCallback progress_callback,
1987 gpointer progress_callback_data,
1990 gssize n_read, n_written;
1991 goffset current_size;
1992 char buffer[8192], *p;
1998 info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
1999 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2003 total_size = g_file_info_get_size (info);
2004 g_object_unref (info);
2011 n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2021 current_size += n_read;
2026 n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2027 if (n_written == -1)
2034 n_read -= n_written;
2040 if (progress_callback)
2041 progress_callback (current_size, total_size, progress_callback_data);
2045 error = NULL; /* Ignore further errors */
2047 /* Make sure we send full copied size */
2048 if (progress_callback)
2049 progress_callback (current_size, total_size, progress_callback_data);
2052 /* Don't care about errors in source here */
2053 g_input_stream_close (in, cancellable, NULL);
2055 /* But write errors on close are bad! */
2056 if (!g_output_stream_close (out, cancellable, error))
2059 g_object_unref (in);
2060 g_object_unref (out);
2066 file_copy_fallback (GFile *source,
2068 GFileCopyFlags flags,
2069 GCancellable *cancellable,
2070 GFileProgressCallback progress_callback,
2071 gpointer progress_callback_data,
2079 /* Maybe copy the symlink? */
2080 if (flags & G_FILE_COPY_NOFOLLOW_SYMLINKS)
2082 info = g_file_query_info (source,
2083 G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
2084 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2090 if (g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK &&
2091 (target = g_file_info_get_symlink_target (info)) != NULL)
2093 if (!copy_symlink (destination, flags, cancellable, target, error))
2095 g_object_unref (info);
2099 g_object_unref (info);
2103 g_object_unref (info);
2106 in = open_source_for_copy (source, destination, flags, cancellable, error);
2110 if (flags & G_FILE_COPY_OVERWRITE)
2112 out = (GOutputStream *)g_file_replace (destination,
2114 flags & G_FILE_COPY_BACKUP,
2115 cancellable, error);
2119 out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
2124 g_object_unref (in);
2128 if (!copy_stream_with_progress (in, out, cancellable,
2129 progress_callback, progress_callback_data,
2135 /* Ignore errors here. Failure to copy metadata is not a hard error */
2136 g_file_copy_attributes (source, destination,
2137 flags, cancellable, NULL);
2144 * @source: input #GFile.
2145 * @destination: destination #GFile
2146 * @flags: set of #GFileCopyFlags
2147 * @cancellable: optional #GCancellable object, %NULL to ignore.
2148 * @progress_callback: function to callback with progress information
2149 * @progress_callback_data: user data to pass to @progress_callback
2150 * @error: #GError to set on error, or %NULL
2152 * Copies the file @source to the location specified by @destination.
2153 * Can not handle recursive copies of directories.
2155 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2156 * existing @destination file is overwritten.
2158 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2159 * will be copied as symlinks, otherwise the target of the
2160 * @source symlink will be copied.
2162 * If @cancellable is not %NULL, then the operation can be cancelled by
2163 * triggering the cancellable object from another thread. If the operation
2164 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2166 * If @progress_callback is not %NULL, then the operation can be monitored by
2167 * setting this to a #GFileProgressCallback function. @progress_callback_data
2168 * will be passed to this function. It is guaranteed that this callback will
2169 * be called after all data has been transferred with the total number of bytes
2170 * copied during the operation.
2172 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2173 * error is returned, independent on the status of the @destination.
2175 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2176 * error G_IO_ERROR_EXISTS is returned.
2178 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2179 * error is returned. If trying to overwrite a directory with a directory the
2180 * G_IO_ERROR_WOULD_MERGE error is returned.
2182 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
2183 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
2186 * If you are interested in copying the #GFile object itself (not the on-disk
2187 * file), see g_file_dup().
2189 * Returns: %TRUE on success, %FALSE otherwise.
2192 g_file_copy (GFile *source,
2194 GFileCopyFlags flags,
2195 GCancellable *cancellable,
2196 GFileProgressCallback progress_callback,
2197 gpointer progress_callback_data,
2204 g_return_val_if_fail (G_IS_FILE (source), FALSE);
2205 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
2207 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2210 iface = G_FILE_GET_IFACE (destination);
2214 res = (* iface->copy) (source, destination,
2216 progress_callback, progress_callback_data,
2222 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2224 g_propagate_error (error, my_error);
2229 /* If the types are different, and the destination method failed
2230 also try the source method */
2231 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
2233 iface = G_FILE_GET_IFACE (source);
2238 res = (* iface->copy) (source, destination,
2240 progress_callback, progress_callback_data,
2246 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2248 g_propagate_error (error, my_error);
2254 return file_copy_fallback (source, destination, flags, cancellable,
2255 progress_callback, progress_callback_data,
2260 * g_file_copy_async:
2261 * @source: input #GFile.
2262 * @destination: destination #GFile
2263 * @flags: set of #GFileCopyFlags
2264 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2266 * @cancellable: optional #GCancellable object, %NULL to ignore.
2267 * @progress_callback: function to callback with progress information
2268 * @progress_callback_data: user data to pass to @progress_callback
2269 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
2270 * @user_data: the data to pass to callback function
2272 * Copies the file @source to the location specified by @destination
2273 * asynchronously. For details of the behaviour, see g_file_copy().
2275 * If @progress_callback is not %NULL, then that function that will be called
2276 * just like in g_file_copy(), however the callback will run in the main loop,
2277 * not in the thread that is doing the I/O operation.
2279 * When the operation is finished, @callback will be called. You can then call
2280 * g_file_copy_finish() to get the result of the operation.
2283 g_file_copy_async (GFile *source,
2285 GFileCopyFlags flags,
2287 GCancellable *cancellable,
2288 GFileProgressCallback progress_callback,
2289 gpointer progress_callback_data,
2290 GAsyncReadyCallback callback,
2295 g_return_if_fail (G_IS_FILE (source));
2296 g_return_if_fail (G_IS_FILE (destination));
2298 iface = G_FILE_GET_IFACE (source);
2299 (* iface->copy_async) (source,
2305 progress_callback_data,
2311 * g_file_copy_finish:
2312 * @file: input #GFile.
2313 * @res: a #GAsyncResult.
2314 * @error: a #GError, or %NULL
2316 * Finishes copying the file started with
2317 * g_file_copy_async().
2319 * Returns: a %TRUE on success, %FALSE on error.
2322 g_file_copy_finish (GFile *file,
2328 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2329 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
2331 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2333 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2335 if (g_simple_async_result_propagate_error (simple, error))
2339 iface = G_FILE_GET_IFACE (file);
2340 return (* iface->copy_finish) (file, res, error);
2345 * @source: #GFile pointing to the source location.
2346 * @destination: #GFile pointing to the destination location.
2347 * @flags: set of #GFileCopyFlags.
2348 * @cancellable: optional #GCancellable object, %NULL to ignore.
2349 * @progress_callback: #GFileProgressCallback function for updates.
2350 * @progress_callback_data: gpointer to user data for the callback function.
2351 * @error: #GError for returning error conditions, or %NULL
2354 * Tries to move the file or directory @source to the location specified by @destination.
2355 * If native move operations are supported then this is used, otherwise a copy + delete
2356 * fallback is used. The native implementation may support moving directories (for instance
2357 * on moves inside the same filesystem), but the fallback code does not.
2359 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2360 * existing @destination file is overwritten.
2362 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2363 * will be copied as symlinks, otherwise the target of the
2364 * @source symlink will be copied.
2366 * If @cancellable is not %NULL, then the operation can be cancelled by
2367 * triggering the cancellable object from another thread. If the operation
2368 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2370 * If @progress_callback is not %NULL, then the operation can be monitored by
2371 * setting this to a #GFileProgressCallback function. @progress_callback_data
2372 * will be passed to this function. It is guaranteed that this callback will
2373 * be called after all data has been transferred with the total number of bytes
2374 * copied during the operation.
2376 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2377 * error is returned, independent on the status of the @destination.
2379 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2380 * error G_IO_ERROR_EXISTS is returned.
2382 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2383 * error is returned. If trying to overwrite a directory with a directory the
2384 * G_IO_ERROR_WOULD_MERGE error is returned.
2386 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
2387 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
2388 * may be returned (if the native move operation isn't available).
2390 * Returns: %TRUE on successful move, %FALSE otherwise.
2393 g_file_move (GFile *source,
2395 GFileCopyFlags flags,
2396 GCancellable *cancellable,
2397 GFileProgressCallback progress_callback,
2398 gpointer progress_callback_data,
2405 g_return_val_if_fail (G_IS_FILE (source), FALSE);
2406 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
2408 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2411 iface = G_FILE_GET_IFACE (destination);
2415 res = (* iface->move) (source, destination,
2417 progress_callback, progress_callback_data,
2423 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2425 g_propagate_error (error, my_error);
2430 /* If the types are different, and the destination method failed
2431 also try the source method */
2432 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
2434 iface = G_FILE_GET_IFACE (source);
2439 res = (* iface->move) (source, destination,
2441 progress_callback, progress_callback_data,
2447 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
2449 g_propagate_error (error, my_error);
2455 if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
2457 g_set_error (error, G_IO_ERROR,
2458 G_IO_ERROR_NOT_SUPPORTED,
2459 _("Operation not supported"));
2463 flags |= G_FILE_COPY_ALL_METADATA;
2464 if (!g_file_copy (source, destination, flags, cancellable,
2465 progress_callback, progress_callback_data,
2469 return g_file_delete (source, cancellable, error);
2473 * g_file_make_directory
2474 * @file: input #GFile.
2475 * @cancellable: optional #GCancellable object, %NULL to ignore.
2476 * @error: a #GError, or %NULL
2478 * Creates a directory.
2480 * If @cancellable is not %NULL, then the operation can be cancelled by
2481 * triggering the cancellable object from another thread. If the operation
2482 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2484 * Returns: %TRUE on successful creation, %FALSE otherwise.
2487 g_file_make_directory (GFile *file,
2488 GCancellable *cancellable,
2493 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2495 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2498 iface = G_FILE_GET_IFACE (file);
2500 if (iface->make_directory == NULL)
2502 g_set_error (error, G_IO_ERROR,
2503 G_IO_ERROR_NOT_SUPPORTED,
2504 _("Operation not supported"));
2508 return (* iface->make_directory) (file, cancellable, error);
2512 * g_file_make_symbolic_link:
2513 * @file: input #GFile.
2514 * @symlink_value: a string with the value of the new symlink.
2515 * @cancellable: optional #GCancellable object, %NULL to ignore.
2516 * @error: a #GError.
2518 * Creates a symbolic link.
2520 * If @cancellable is not %NULL, then the operation can be cancelled by
2521 * triggering the cancellable object from another thread. If the operation
2522 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2524 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
2527 g_file_make_symbolic_link (GFile *file,
2528 const char *symlink_value,
2529 GCancellable *cancellable,
2534 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2535 g_return_val_if_fail (symlink_value != NULL, FALSE);
2537 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2540 if (*symlink_value == '\0')
2542 g_set_error (error, G_IO_ERROR,
2543 G_IO_ERROR_INVALID_ARGUMENT,
2544 _("Invalid symlink value given"));
2548 iface = G_FILE_GET_IFACE (file);
2550 if (iface->make_symbolic_link == NULL)
2552 g_set_error (error, G_IO_ERROR,
2553 G_IO_ERROR_NOT_SUPPORTED,
2554 _("Operation not supported"));
2558 return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
2563 * @file: input #GFile.
2564 * @cancellable: optional #GCancellable object, %NULL to ignore.
2565 * @error: a #GError, or %NULL
2569 * If @cancellable is not %NULL, then the operation can be cancelled by
2570 * triggering the cancellable object from another thread. If the operation
2571 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2573 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
2576 g_file_delete (GFile *file,
2577 GCancellable *cancellable,
2582 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2584 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2587 iface = G_FILE_GET_IFACE (file);
2589 if (iface->delete_file == NULL)
2591 g_set_error (error, G_IO_ERROR,
2592 G_IO_ERROR_NOT_SUPPORTED,
2593 _("Operation not supported"));
2597 return (* iface->delete_file) (file, cancellable, error);
2602 * @file: #GFile to send to trash.
2603 * @cancellable: optional #GCancellable object, %NULL to ignore.
2604 * @error: a #GError, or %NULL
2606 * Sends @file to the "Trashcan", if possible. This is similar to
2607 * deleting it, but the user can recover it before emptying the trashcan.
2608 * Not all file systems support trashing, so this call can return the
2609 * %G_IO_ERROR_NOT_SUPPORTED error.
2612 * If @cancellable is not %NULL, then the operation can be cancelled by
2613 * triggering the cancellable object from another thread. If the operation
2614 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2616 * Returns: %TRUE on successful trash, %FALSE otherwise.
2619 g_file_trash (GFile *file,
2620 GCancellable *cancellable,
2625 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2627 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2630 iface = G_FILE_GET_IFACE (file);
2632 if (iface->trash == NULL)
2635 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2636 _("Trash not supported"));
2640 return (* iface->trash) (file, cancellable, error);
2644 * g_file_set_display_name:
2645 * @file: input #GFile.
2646 * @display_name: a string.
2647 * @cancellable: optional #GCancellable object, %NULL to ignore.
2648 * @error: a #GError, or %NULL
2650 * Renames @file to the specified display name.
2652 * The display name is converted from UTF8 to the correct encoding for the target
2653 * filesystem if possible and the @file is renamed to this.
2655 * If you want to implement a rename operation in the user interface the edit name
2656 * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
2657 * widget, and then the result after editing should be passed to g_file_set_display_name().
2659 * On success the resulting converted filename is returned.
2661 * If @cancellable is not %NULL, then the operation can be cancelled by
2662 * triggering the cancellable object from another thread. If the operation
2663 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2665 * Returns: a #GFile specifying what @file was renamed to, or %NULL if there was an error.
2668 g_file_set_display_name (GFile *file,
2669 const char *display_name,
2670 GCancellable *cancellable,
2675 g_return_val_if_fail (G_IS_FILE (file), NULL);
2676 g_return_val_if_fail (display_name != NULL, NULL);
2678 if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
2682 G_IO_ERROR_INVALID_ARGUMENT,
2683 _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
2687 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2690 iface = G_FILE_GET_IFACE (file);
2692 return (* iface->set_display_name) (file, display_name, cancellable, error);
2696 * g_file_set_display_name_async:
2697 * @file: input #GFile.
2698 * @display_name: a string.
2699 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2701 * @cancellable: optional #GCancellable object, %NULL to ignore.
2702 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
2703 * @user_data: the data to pass to callback function
2705 * Asynchronously sets the display name for a given #GFile.
2707 * For more details, see g_set_display_name() which is
2708 * the synchronous version of this call.
2710 * When the operation is finished, @callback will be called. You can then call
2711 * g_file_set_display_name_finish() to get the result of the operation.
2714 g_file_set_display_name_async (GFile *file,
2715 const char *display_name,
2717 GCancellable *cancellable,
2718 GAsyncReadyCallback callback,
2723 g_return_if_fail (G_IS_FILE (file));
2724 g_return_if_fail (display_name != NULL);
2726 iface = G_FILE_GET_IFACE (file);
2727 (* iface->set_display_name_async) (file,
2736 * g_file_set_display_name_finish:
2737 * @file: input #GFile.
2738 * @res: a #GAsyncResult.
2739 * @error: a #GError, or %NULL
2741 * Finishes setting a display name started with
2742 * g_file_set_display_name_async().
2744 * Returns: a #GFile or %NULL on error.
2747 g_file_set_display_name_finish (GFile *file,
2753 g_return_val_if_fail (G_IS_FILE (file), NULL);
2754 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2756 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2758 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2759 if (g_simple_async_result_propagate_error (simple, error))
2763 iface = G_FILE_GET_IFACE (file);
2764 return (* iface->set_display_name_finish) (file, res, error);
2768 * g_file_query_settable_attributes:
2769 * @file: input #GFile.
2770 * @cancellable: optional #GCancellable object, %NULL to ignore.
2771 * @error: a #GError, or %NULL
2773 * Obtain the list of settable attributes for the file.
2775 * Returns the type and full attribute name of all the attributes
2776 * that can be set on this file. This doesn't mean setting it will always
2777 * succeed though, you might get an access failure, or some specific
2778 * file may not support a specific attribute.
2780 * If @cancellable is not %NULL, then the operation can be cancelled by
2781 * triggering the cancellable object from another thread. If the operation
2782 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2784 * Returns: a #GFileAttributeInfoList describing the settable attributes.
2785 * When you are done with it, release it with g_file_attribute_info_list_unref()
2787 GFileAttributeInfoList *
2788 g_file_query_settable_attributes (GFile *file,
2789 GCancellable *cancellable,
2794 GFileAttributeInfoList *list;
2796 g_return_val_if_fail (G_IS_FILE (file), NULL);
2798 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2801 iface = G_FILE_GET_IFACE (file);
2803 if (iface->query_settable_attributes == NULL)
2804 return g_file_attribute_info_list_new ();
2807 list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
2811 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
2813 list = g_file_attribute_info_list_new ();
2814 g_error_free (my_error);
2817 g_propagate_error (error, my_error);
2824 * g_file_query_writable_namespaces:
2825 * @file: input #GFile.
2826 * @cancellable: optional #GCancellable object, %NULL to ignore.
2827 * @error: a #GError, or %NULL
2829 * Obtain the list of attribute namespaces where new attributes
2830 * can be created by a user. An example of this is extended
2831 * attributes (in the "xattr" namespace).
2833 * If @cancellable is not %NULL, then the operation can be cancelled by
2834 * triggering the cancellable object from another thread. If the operation
2835 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2837 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
2838 * When you are done with it, release it with g_file_attribute_info_list_unref()
2840 GFileAttributeInfoList *
2841 g_file_query_writable_namespaces (GFile *file,
2842 GCancellable *cancellable,
2847 GFileAttributeInfoList *list;
2849 g_return_val_if_fail (G_IS_FILE (file), NULL);
2851 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2854 iface = G_FILE_GET_IFACE (file);
2856 if (iface->query_writable_namespaces == NULL)
2857 return g_file_attribute_info_list_new ();
2860 list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
2864 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
2866 list = g_file_attribute_info_list_new ();
2867 g_error_free (my_error);
2870 g_propagate_error (error, my_error);
2877 * g_file_set_attribute:
2878 * @file: input #GFile.
2879 * @attribute: a string containing the attribute's name.
2880 * @type: The type of the attribute
2881 * @value_p: a pointer to the value (or the pointer itself if the type is a pointer type)
2882 * @flags: a set of #GFileQueryInfoFlags.
2883 * @cancellable: optional #GCancellable object, %NULL to ignore.
2884 * @error: a #GError, or %NULL
2886 * Sets an attribute in the file with attribute name @attribute to @value.
2888 * If @cancellable is not %NULL, then the operation can be cancelled by
2889 * triggering the cancellable object from another thread. If the operation
2890 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2892 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
2895 g_file_set_attribute (GFile *file,
2896 const char *attribute,
2897 GFileAttributeType type,
2899 GFileQueryInfoFlags flags,
2900 GCancellable *cancellable,
2905 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2906 g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
2908 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2911 iface = G_FILE_GET_IFACE (file);
2913 if (iface->set_attribute == NULL)
2915 g_set_error (error, G_IO_ERROR,
2916 G_IO_ERROR_NOT_SUPPORTED,
2917 _("Operation not supported"));
2921 return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
2925 * g_file_set_attributes_from_info:
2926 * @file: input #GFile.
2927 * @info: a #GFileInfo.
2928 * @flags: #GFileQueryInfoFlags
2929 * @cancellable: optional #GCancellable object, %NULL to ignore.
2930 * @error: a #GError, or %NULL
2932 * Tries to set all attributes in the #GFileInfo on the target values,
2933 * not stopping on the first error.
2935 * If there is any error during this operation then @error will be set to
2936 * the first error. Error on particular fields are flagged by setting
2937 * the "status" field in the attribute value to
2938 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
2941 * If @cancellable is not %NULL, then the operation can be cancelled by
2942 * triggering the cancellable object from another thread. If the operation
2943 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2945 * Returns: %TRUE if there was any error, %FALSE otherwise.
2948 g_file_set_attributes_from_info (GFile *file,
2950 GFileQueryInfoFlags flags,
2951 GCancellable *cancellable,
2956 g_return_val_if_fail (G_IS_FILE (file), FALSE);
2957 g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
2959 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2962 g_file_info_clear_status (info);
2964 iface = G_FILE_GET_IFACE (file);
2966 return (* iface->set_attributes_from_info) (file,
2975 g_file_real_set_attributes_from_info (GFile *file,
2977 GFileQueryInfoFlags flags,
2978 GCancellable *cancellable,
2984 GFileAttributeValue *value;
2988 attributes = g_file_info_list_attributes (info, NULL);
2990 for (i = 0; attributes[i] != NULL; i++)
2992 value = _g_file_info_get_attribute_value (info, attributes[i]);
2994 if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
2997 if (!g_file_set_attribute (file, attributes[i],
2998 value->type, _g_file_attribute_value_peek_as_pointer (value),
2999 flags, cancellable, error))
3001 value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3003 /* Don't set error multiple times */
3007 value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3010 g_strfreev (attributes);
3016 * g_file_set_attributes_async:
3017 * @file: input #GFile.
3018 * @info: a #GFileInfo.
3019 * @flags: a #GFileQueryInfoFlags.
3020 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3022 * @cancellable: optional #GCancellable object, %NULL to ignore.
3023 * @callback: a #GAsyncReadyCallback.
3024 * @user_data: a #gpointer.
3026 * Asynchronously sets the attributes of @file with @info.
3028 * For more details, see g_file_set_attributes_from_info() which is
3029 * the synchronous version of this call.
3031 * When the operation is finished, @callback will be called. You can then call
3032 * g_file_set_attributes_finish() to get the result of the operation.
3035 g_file_set_attributes_async (GFile *file,
3037 GFileQueryInfoFlags flags,
3039 GCancellable *cancellable,
3040 GAsyncReadyCallback callback,
3045 g_return_if_fail (G_IS_FILE (file));
3046 g_return_if_fail (G_IS_FILE_INFO (info));
3048 iface = G_FILE_GET_IFACE (file);
3049 (* iface->set_attributes_async) (file,
3059 * g_file_set_attributes_finish:
3060 * @file: input #GFile.
3061 * @result: a #GAsyncResult.
3062 * @info: a #GFileInfo.
3063 * @error: a #GError, or %NULL
3065 * Finishes setting an attribute started in g_file_set_attributes_async().
3067 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
3070 g_file_set_attributes_finish (GFile *file,
3071 GAsyncResult *result,
3077 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3078 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3080 /* No standard handling of errors here, as we must set info even
3083 iface = G_FILE_GET_IFACE (file);
3084 return (* iface->set_attributes_finish) (file, result, info, error);
3088 * g_file_set_attribute_string:
3089 * @file: input #GFile.
3090 * @attribute: a string containing the attribute's name.
3091 * @value: a string containing the attribute's value.
3092 * @flags: #GFileQueryInfoFlags.
3093 * @cancellable: optional #GCancellable object, %NULL to ignore.
3094 * @error: a #GError, or %NULL
3096 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
3097 * If @attribute is of a different type, this operation will fail.
3099 * If @cancellable is not %NULL, then the operation can be cancelled by
3100 * triggering the cancellable object from another thread. If the operation
3101 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3103 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
3106 g_file_set_attribute_string (GFile *file,
3107 const char *attribute,
3109 GFileQueryInfoFlags flags,
3110 GCancellable *cancellable,
3113 return g_file_set_attribute (file, attribute,
3114 G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
3115 flags, cancellable, error);
3119 * g_file_set_attribute_byte_string:
3120 * @file: input #GFile.
3121 * @attribute: a string containing the attribute's name.
3122 * @value: a string containing the attribute's new value.
3123 * @flags: a #GFileQueryInfoFlags.
3124 * @cancellable: optional #GCancellable object, %NULL to ignore.
3125 * @error: a #GError, or %NULL
3127 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
3128 * If @attribute is of a different type, this operation will fail,
3131 * If @cancellable is not %NULL, then the operation can be cancelled by
3132 * triggering the cancellable object from another thread. If the operation
3133 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3135 * Returns: %TRUE if the @attribute was successfully set to @value
3136 * in the @file, %FALSE otherwise.
3139 g_file_set_attribute_byte_string (GFile *file,
3140 const char *attribute,
3142 GFileQueryInfoFlags flags,
3143 GCancellable *cancellable,
3146 return g_file_set_attribute (file, attribute,
3147 G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
3148 flags, cancellable, error);
3152 * g_file_set_attribute_uint32:
3153 * @file: input #GFile.
3154 * @attribute: a string containing the attribute's name.
3155 * @value: a #guint32 containing the attribute's new value.
3156 * @flags: a #GFileQueryInfoFlags.
3157 * @cancellable: optional #GCancellable object, %NULL to ignore.
3158 * @error: a #GError, or %NULL
3160 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
3161 * If @attribute is of a different type, this operation will fail.
3163 * If @cancellable is not %NULL, then the operation can be cancelled by
3164 * triggering the cancellable object from another thread. If the operation
3165 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3167 * Returns: %TRUE if the @attribute was successfully set to @value
3168 * in the @file, %FALSE otherwise.
3171 g_file_set_attribute_uint32 (GFile *file,
3172 const char *attribute,
3174 GFileQueryInfoFlags flags,
3175 GCancellable *cancellable,
3178 return g_file_set_attribute (file, attribute,
3179 G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
3180 flags, cancellable, error);
3184 * g_file_set_attribute_int32:
3185 * @file: input #GFile.
3186 * @attribute: a string containing the attribute's name.
3187 * @value: a #gint32 containing the attribute's new value.
3188 * @flags: a #GFileQueryInfoFlags.
3189 * @cancellable: optional #GCancellable object, %NULL to ignore.
3190 * @error: a #GError, or %NULL
3192 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
3193 * If @attribute is of a different type, this operation will fail.
3195 * If @cancellable is not %NULL, then the operation can be cancelled by
3196 * triggering the cancellable object from another thread. If the operation
3197 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3199 * Returns: %TRUE if the @attribute was successfully set to @value
3200 * in the @file, %FALSE otherwise.
3203 g_file_set_attribute_int32 (GFile *file,
3204 const char *attribute,
3206 GFileQueryInfoFlags flags,
3207 GCancellable *cancellable,
3210 return g_file_set_attribute (file, attribute,
3211 G_FILE_ATTRIBUTE_TYPE_INT32, &value,
3212 flags, cancellable, error);
3216 * g_file_set_attribute_uint64:
3217 * @file: input #GFile.
3218 * @attribute: a string containing the attribute's name.
3219 * @value: a #guint64 containing the attribute's new value.
3220 * @flags: a #GFileQueryInfoFlags.
3221 * @cancellable: optional #GCancellable object, %NULL to ignore.
3222 * @error: a #GError, or %NULL
3224 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
3225 * If @attribute is of a different type, this operation will fail.
3227 * If @cancellable is not %NULL, then the operation can be cancelled by
3228 * triggering the cancellable object from another thread. If the operation
3229 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3231 * Returns: %TRUE if the @attribute was successfully set to @value
3232 * in the @file, %FALSE otherwise.
3235 g_file_set_attribute_uint64 (GFile *file,
3236 const char *attribute,
3238 GFileQueryInfoFlags flags,
3239 GCancellable *cancellable,
3242 return g_file_set_attribute (file, attribute,
3243 G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
3244 flags, cancellable, error);
3248 * g_file_set_attribute_int64:
3249 * @file: input #GFile.
3250 * @attribute: a string containing the attribute's name.
3251 * @value: a #guint64 containing the attribute's new value.
3252 * @flags: a #GFileQueryInfoFlags.
3253 * @cancellable: optional #GCancellable object, %NULL to ignore.
3254 * @error: a #GError, or %NULL
3256 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
3257 * If @attribute is of a different type, this operation will fail.
3259 * If @cancellable is not %NULL, then the operation can be cancelled by
3260 * triggering the cancellable object from another thread. If the operation
3261 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3263 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
3266 g_file_set_attribute_int64 (GFile *file,
3267 const char *attribute,
3269 GFileQueryInfoFlags flags,
3270 GCancellable *cancellable,
3273 return g_file_set_attribute (file, attribute,
3274 G_FILE_ATTRIBUTE_TYPE_INT64, &value,
3275 flags, cancellable, error);
3279 * g_file_mount_mountable:
3280 * @file: input #GFile.
3281 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
3282 * @cancellable: optional #GCancellable object, %NULL to ignore.
3283 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3284 * @user_data: the data to pass to callback function
3286 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
3287 * Using @mount_operation, you can request callbacks when, for instance,
3288 * passwords are needed during authentication.
3290 * If @cancellable is not %NULL, then the operation can be cancelled by
3291 * triggering the cancellable object from another thread. If the operation
3292 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3294 * When the operation is finished, @callback will be called. You can then call
3295 * g_file_mount_mountable_finish() to get the result of the operation.
3298 g_file_mount_mountable (GFile *file,
3299 GMountOperation *mount_operation,
3300 GCancellable *cancellable,
3301 GAsyncReadyCallback callback,
3306 g_return_if_fail (G_IS_FILE (file));
3308 iface = G_FILE_GET_IFACE (file);
3310 if (iface->mount_mountable == NULL)
3311 g_simple_async_report_error_in_idle (G_OBJECT (file),
3315 G_IO_ERROR_NOT_SUPPORTED,
3316 _("Operation not supported"));
3318 (* iface->mount_mountable) (file,
3326 * g_file_mount_mountable_finish:
3327 * @file: input #GFile.
3328 * @result: a #GAsyncResult.
3329 * @error: a #GError, or %NULL
3331 * Finishes a mount operation. See g_file_mount_mountable() for details.
3333 * Finish an asynchronous mount operation that was started
3334 * with g_file_mount_mountable().
3336 * Returns: a #GFile or %NULL on error.
3339 g_file_mount_mountable_finish (GFile *file,
3340 GAsyncResult *result,
3345 g_return_val_if_fail (G_IS_FILE (file), NULL);
3346 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
3348 if (G_IS_SIMPLE_ASYNC_RESULT (result))
3350 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3351 if (g_simple_async_result_propagate_error (simple, error))
3355 iface = G_FILE_GET_IFACE (file);
3356 return (* iface->mount_mountable_finish) (file, result, error);
3360 * g_file_unmount_mountable:
3361 * @file: input #GFile.
3362 * @flags: flags affecting the operation
3363 * @cancellable: optional #GCancellable object, %NULL to ignore.
3364 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3365 * @user_data: the data to pass to callback function
3367 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
3369 * If @cancellable is not %NULL, then the operation can be cancelled by
3370 * triggering the cancellable object from another thread. If the operation
3371 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3373 * When the operation is finished, @callback will be called. You can then call
3374 * g_file_unmount_mountable_finish() to get the result of the operation.
3377 g_file_unmount_mountable (GFile *file,
3378 GMountUnmountFlags flags,
3379 GCancellable *cancellable,
3380 GAsyncReadyCallback callback,
3385 g_return_if_fail (G_IS_FILE (file));
3387 iface = G_FILE_GET_IFACE (file);
3389 if (iface->unmount_mountable == NULL)
3390 g_simple_async_report_error_in_idle (G_OBJECT (file),
3394 G_IO_ERROR_NOT_SUPPORTED,
3395 _("Operation not supported"));
3397 (* iface->unmount_mountable) (file,
3405 * g_file_unmount_mountable_finish:
3406 * @file: input #GFile.
3407 * @result: a #GAsyncResult.
3408 * @error: a #GError, or %NULL
3410 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
3412 * Finish an asynchronous unmount operation that was started
3413 * with g_file_unmount_mountable().
3415 * Returns: %TRUE if the operation finished successfully. %FALSE
3419 g_file_unmount_mountable_finish (GFile *file,
3420 GAsyncResult *result,
3425 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3426 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3428 if (G_IS_SIMPLE_ASYNC_RESULT (result))
3430 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3431 if (g_simple_async_result_propagate_error (simple, error))
3435 iface = G_FILE_GET_IFACE (file);
3436 return (* iface->unmount_mountable_finish) (file, result, error);
3440 * g_file_eject_mountable:
3441 * @file: input #GFile.
3442 * @flags: flags affecting the operation
3443 * @cancellable: optional #GCancellable object, %NULL to ignore.
3444 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
3445 * @user_data: the data to pass to callback function
3447 * Starts an asynchronous eject on a mountable.
3448 * When this operation has completed, @callback will be called with
3449 * @user_user data, and the operation can be finalized with
3450 * g_file_eject_mountable_finish().
3452 * If @cancellable is not %NULL, then the operation can be cancelled by
3453 * triggering the cancellable object from another thread. If the operation
3454 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3457 g_file_eject_mountable (GFile *file,
3458 GMountUnmountFlags flags,
3459 GCancellable *cancellable,
3460 GAsyncReadyCallback callback,
3465 g_return_if_fail (G_IS_FILE (file));
3467 iface = G_FILE_GET_IFACE (file);
3469 if (iface->eject_mountable == NULL)
3470 g_simple_async_report_error_in_idle (G_OBJECT (file),
3474 G_IO_ERROR_NOT_SUPPORTED,
3475 _("Operation not supported"));
3477 (* iface->eject_mountable) (file,
3485 * g_file_eject_mountable_finish:
3486 * @file: input #GFile.
3487 * @result: a #GAsyncResult.
3488 * @error: a #GError, or %NULL
3490 * Finishes an asynchronous eject operation started by
3491 * g_file_eject_mountable().
3493 * Returns: %TRUE if the @file was ejected successfully. %FALSE
3497 g_file_eject_mountable_finish (GFile *file,
3498 GAsyncResult *result,
3503 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3504 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3506 if (G_IS_SIMPLE_ASYNC_RESULT (result))
3508 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
3509 if (g_simple_async_result_propagate_error (simple, error))
3513 iface = G_FILE_GET_IFACE (file);
3514 return (* iface->eject_mountable_finish) (file, result, error);
3518 * g_file_monitor_directory:
3519 * @file: input #GFile.
3520 * @flags: a set of #GFileMonitorFlags.
3521 * @cancellable: optional #GCancellable object, %NULL to ignore.
3522 * @error: a #GError, or %NULL.
3524 * Obtains a directory monitor for the given file.
3525 * This may fail if directory monitoring is not supported.
3527 * If @cancellable is not %NULL, then the operation can be cancelled by
3528 * triggering the cancellable object from another thread. If the operation
3529 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3531 * Returns: a #GFileMonitor for the given @file,
3532 * or %NULL on error.
3535 g_file_monitor_directory (GFile *file,
3536 GFileMonitorFlags flags,
3537 GCancellable *cancellable,
3542 g_return_val_if_fail (G_IS_FILE (file), NULL);
3544 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3547 iface = G_FILE_GET_IFACE (file);
3549 if (iface->monitor_dir == NULL)
3551 g_set_error (error, G_IO_ERROR,
3552 G_IO_ERROR_NOT_SUPPORTED,
3553 _("Operation not supported"));
3557 return (* iface->monitor_dir) (file, flags, cancellable, error);
3561 * g_file_monitor_file:
3562 * @file: input #GFile.
3563 * @flags: a set of #GFileMonitorFlags.
3564 * @cancellable: optional #GCancellable object, %NULL to ignore.
3565 * @error: a #GError, or %NULL.
3567 * Obtains a file monitor for the given file. If no file notification
3568 * mechanism exists, then regular polling of the file is used.
3570 * If @cancellable is not %NULL, then the operation can be cancelled by
3571 * triggering the cancellable object from another thread. If the operation
3572 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3574 * Returns: a #GFileMonitor for the given @file.
3577 g_file_monitor_file (GFile *file,
3578 GFileMonitorFlags flags,
3579 GCancellable *cancellable,
3583 GFileMonitor *monitor;
3585 g_return_val_if_fail (G_IS_FILE (file), NULL);
3587 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3590 iface = G_FILE_GET_IFACE (file);
3594 if (iface->monitor_file)
3595 monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
3597 /* Fallback to polling */
3598 if (monitor == NULL)
3599 monitor = _g_poll_file_monitor_new (file);
3604 /********************************************
3605 * Default implementation of async ops *
3606 ********************************************/
3610 GFileQueryInfoFlags flags;
3612 } QueryInfoAsyncData;
3615 query_info_data_free (QueryInfoAsyncData *data)
3618 g_object_unref (data->info);
3619 g_free (data->attributes);
3624 query_info_async_thread (GSimpleAsyncResult *res,
3626 GCancellable *cancellable)
3628 GError *error = NULL;
3629 QueryInfoAsyncData *data;
3632 data = g_simple_async_result_get_op_res_gpointer (res);
3634 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
3638 g_simple_async_result_set_from_error (res, error);
3639 g_error_free (error);
3646 g_file_real_query_info_async (GFile *file,
3647 const char *attributes,
3648 GFileQueryInfoFlags flags,
3650 GCancellable *cancellable,
3651 GAsyncReadyCallback callback,
3654 GSimpleAsyncResult *res;
3655 QueryInfoAsyncData *data;
3657 data = g_new0 (QueryInfoAsyncData, 1);
3658 data->attributes = g_strdup (attributes);
3659 data->flags = flags;
3661 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
3662 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
3664 g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
3665 g_object_unref (res);
3669 g_file_real_query_info_finish (GFile *file,
3673 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3674 QueryInfoAsyncData *data;
3676 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
3678 data = g_simple_async_result_get_op_res_gpointer (simple);
3680 return g_object_ref (data->info);
3687 GFileQueryInfoFlags flags;
3688 GFileEnumerator *enumerator;
3689 } EnumerateChildrenAsyncData;
3692 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
3694 if (data->enumerator)
3695 g_object_unref (data->enumerator);
3696 g_free (data->attributes);
3701 enumerate_children_async_thread (GSimpleAsyncResult *res,
3703 GCancellable *cancellable)
3705 GError *error = NULL;
3706 EnumerateChildrenAsyncData *data;
3707 GFileEnumerator *enumerator;
3709 data = g_simple_async_result_get_op_res_gpointer (res);
3711 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
3713 if (enumerator == NULL)
3715 g_simple_async_result_set_from_error (res, error);
3716 g_error_free (error);
3719 data->enumerator = enumerator;
3723 g_file_real_enumerate_children_async (GFile *file,
3724 const char *attributes,
3725 GFileQueryInfoFlags flags,
3727 GCancellable *cancellable,
3728 GAsyncReadyCallback callback,
3731 GSimpleAsyncResult *res;
3732 EnumerateChildrenAsyncData *data;
3734 data = g_new0 (EnumerateChildrenAsyncData, 1);
3735 data->attributes = g_strdup (attributes);
3736 data->flags = flags;
3738 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
3739 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
3741 g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
3742 g_object_unref (res);
3745 static GFileEnumerator *
3746 g_file_real_enumerate_children_finish (GFile *file,
3750 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3751 EnumerateChildrenAsyncData *data;
3753 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
3755 data = g_simple_async_result_get_op_res_gpointer (simple);
3756 if (data->enumerator)
3757 return g_object_ref (data->enumerator);
3763 open_read_async_thread (GSimpleAsyncResult *res,
3765 GCancellable *cancellable)
3768 GFileInputStream *stream;
3769 GError *error = NULL;
3771 iface = G_FILE_GET_IFACE (object);
3773 stream = iface->read_fn (G_FILE (object), cancellable, &error);
3777 g_simple_async_result_set_from_error (res, error);
3778 g_error_free (error);
3781 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
3785 g_file_real_read_async (GFile *file,
3787 GCancellable *cancellable,
3788 GAsyncReadyCallback callback,
3791 GSimpleAsyncResult *res;
3793 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
3795 g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
3796 g_object_unref (res);
3799 static GFileInputStream *
3800 g_file_real_read_finish (GFile *file,
3804 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3807 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
3809 op = g_simple_async_result_get_op_res_gpointer (simple);
3811 return g_object_ref (op);
3817 append_to_async_thread (GSimpleAsyncResult *res,
3819 GCancellable *cancellable)
3822 GFileCreateFlags *data;
3823 GFileOutputStream *stream;
3824 GError *error = NULL;
3826 iface = G_FILE_GET_IFACE (object);
3828 data = g_simple_async_result_get_op_res_gpointer (res);
3830 stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
3834 g_simple_async_result_set_from_error (res, error);
3835 g_error_free (error);
3838 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
3842 g_file_real_append_to_async (GFile *file,
3843 GFileCreateFlags flags,
3845 GCancellable *cancellable,
3846 GAsyncReadyCallback callback,
3849 GFileCreateFlags *data;
3850 GSimpleAsyncResult *res;
3852 data = g_new0 (GFileCreateFlags, 1);
3855 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
3856 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
3858 g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
3859 g_object_unref (res);
3862 static GFileOutputStream *
3863 g_file_real_append_to_finish (GFile *file,
3867 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3870 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
3872 op = g_simple_async_result_get_op_res_gpointer (simple);
3874 return g_object_ref (op);
3880 create_async_thread (GSimpleAsyncResult *res,
3882 GCancellable *cancellable)
3885 GFileCreateFlags *data;
3886 GFileOutputStream *stream;
3887 GError *error = NULL;
3889 iface = G_FILE_GET_IFACE (object);
3891 data = g_simple_async_result_get_op_res_gpointer (res);
3893 stream = iface->create (G_FILE (object), *data, cancellable, &error);
3897 g_simple_async_result_set_from_error (res, error);
3898 g_error_free (error);
3901 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
3905 g_file_real_create_async (GFile *file,
3906 GFileCreateFlags flags,
3908 GCancellable *cancellable,
3909 GAsyncReadyCallback callback,
3912 GFileCreateFlags *data;
3913 GSimpleAsyncResult *res;
3915 data = g_new0 (GFileCreateFlags, 1);
3918 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
3919 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
3921 g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
3922 g_object_unref (res);
3925 static GFileOutputStream *
3926 g_file_real_create_finish (GFile *file,
3930 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3933 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
3935 op = g_simple_async_result_get_op_res_gpointer (simple);
3937 return g_object_ref (op);
3943 GFileOutputStream *stream;
3945 gboolean make_backup;
3946 GFileCreateFlags flags;
3950 replace_async_data_free (ReplaceAsyncData *data)
3953 g_object_unref (data->stream);
3954 g_free (data->etag);
3959 replace_async_thread (GSimpleAsyncResult *res,
3961 GCancellable *cancellable)
3964 GFileOutputStream *stream;
3965 GError *error = NULL;
3966 ReplaceAsyncData *data;
3968 iface = G_FILE_GET_IFACE (object);
3970 data = g_simple_async_result_get_op_res_gpointer (res);
3972 stream = iface->replace (G_FILE (object),
3981 g_simple_async_result_set_from_error (res, error);
3982 g_error_free (error);
3985 data->stream = stream;
3989 g_file_real_replace_async (GFile *file,
3991 gboolean make_backup,
3992 GFileCreateFlags flags,
3994 GCancellable *cancellable,
3995 GAsyncReadyCallback callback,
3998 GSimpleAsyncResult *res;
3999 ReplaceAsyncData *data;
4001 data = g_new0 (ReplaceAsyncData, 1);
4002 data->etag = g_strdup (etag);
4003 data->make_backup = make_backup;
4004 data->flags = flags;
4006 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
4007 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
4009 g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
4010 g_object_unref (res);
4013 static GFileOutputStream *
4014 g_file_real_replace_finish (GFile *file,
4018 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4019 ReplaceAsyncData *data;
4021 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
4023 data = g_simple_async_result_get_op_res_gpointer (simple);
4025 return g_object_ref (data->stream);
4033 } SetDisplayNameAsyncData;
4036 set_display_name_data_free (SetDisplayNameAsyncData *data)
4038 g_free (data->name);
4040 g_object_unref (data->file);
4045 set_display_name_async_thread (GSimpleAsyncResult *res,
4047 GCancellable *cancellable)
4049 GError *error = NULL;
4050 SetDisplayNameAsyncData *data;
4053 data = g_simple_async_result_get_op_res_gpointer (res);
4055 file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
4059 g_simple_async_result_set_from_error (res, error);
4060 g_error_free (error);
4067 g_file_real_set_display_name_async (GFile *file,
4068 const char *display_name,
4070 GCancellable *cancellable,
4071 GAsyncReadyCallback callback,
4074 GSimpleAsyncResult *res;
4075 SetDisplayNameAsyncData *data;
4077 data = g_new0 (SetDisplayNameAsyncData, 1);
4078 data->name = g_strdup (display_name);
4080 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
4081 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
4083 g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
4084 g_object_unref (res);
4088 g_file_real_set_display_name_finish (GFile *file,
4092 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4093 SetDisplayNameAsyncData *data;
4095 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
4097 data = g_simple_async_result_get_op_res_gpointer (simple);
4099 return g_object_ref (data->file);
4105 GFileQueryInfoFlags flags;
4112 set_info_data_free (SetInfoAsyncData *data)
4115 g_object_unref (data->info);
4117 g_error_free (data->error);
4122 set_info_async_thread (GSimpleAsyncResult *res,
4124 GCancellable *cancellable)
4126 SetInfoAsyncData *data;
4128 data = g_simple_async_result_get_op_res_gpointer (res);
4131 data->res = g_file_set_attributes_from_info (G_FILE (object),
4139 g_file_real_set_attributes_async (GFile *file,
4141 GFileQueryInfoFlags flags,
4143 GCancellable *cancellable,
4144 GAsyncReadyCallback callback,
4147 GSimpleAsyncResult *res;
4148 SetInfoAsyncData *data;
4150 data = g_new0 (SetInfoAsyncData, 1);
4151 data->info = g_file_info_dup (info);
4152 data->flags = flags;
4154 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
4155 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
4157 g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
4158 g_object_unref (res);
4162 g_file_real_set_attributes_finish (GFile *file,
4167 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4168 SetInfoAsyncData *data;
4170 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
4172 data = g_simple_async_result_get_op_res_gpointer (simple);
4175 *info = g_object_ref (data->info);
4177 if (error != NULL && data->error)
4178 *error = g_error_copy (data->error);
4184 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
4186 GCancellable *cancellable)
4188 GError *error = NULL;
4191 mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
4195 g_simple_async_result_set_from_error (res, error);
4196 g_error_free (error);
4199 g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
4203 g_file_real_find_enclosing_mount_async (GFile *file,
4205 GCancellable *cancellable,
4206 GAsyncReadyCallback callback,
4209 GSimpleAsyncResult *res;
4211 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
4213 g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
4214 g_object_unref (res);
4218 g_file_real_find_enclosing_mount_finish (GFile *file,
4222 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4225 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
4227 mount = g_simple_async_result_get_op_res_gpointer (simple);
4228 return g_object_ref (mount);
4235 GFileCopyFlags flags;
4236 GFileProgressCallback progress_cb;
4237 gpointer progress_cb_data;
4238 GIOSchedulerJob *job;
4242 copy_async_data_free (CopyAsyncData *data)
4244 g_object_unref (data->source);
4245 g_object_unref (data->destination);
4250 CopyAsyncData *data;
4251 goffset current_num_bytes;
4252 goffset total_num_bytes;
4256 copy_async_progress_in_main (gpointer user_data)
4258 ProgressData *progress = user_data;
4259 CopyAsyncData *data = progress->data;
4261 data->progress_cb (progress->current_num_bytes,
4262 progress->total_num_bytes,
4263 data->progress_cb_data);
4269 mainloop_barrier (gpointer user_data)
4271 /* Does nothing, but ensures all queued idles before
4278 copy_async_progress_callback (goffset current_num_bytes,
4279 goffset total_num_bytes,
4282 CopyAsyncData *data = user_data;
4283 ProgressData *progress;
4285 progress = g_new (ProgressData, 1);
4286 progress->data = data;
4287 progress->current_num_bytes = current_num_bytes;
4288 progress->total_num_bytes = total_num_bytes;
4290 g_io_scheduler_job_send_to_mainloop_async (data->job,
4291 copy_async_progress_in_main,
4297 copy_async_thread (GIOSchedulerJob *job,
4298 GCancellable *cancellable,
4301 GSimpleAsyncResult *res;
4302 CopyAsyncData *data;
4307 data = g_simple_async_result_get_op_res_gpointer (res);
4311 result = g_file_copy (data->source,
4315 (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
4319 /* Ensure all progress callbacks are done running in main thread */
4320 if (data->progress_cb != NULL)
4321 g_io_scheduler_job_send_to_mainloop (job,
4327 g_simple_async_result_set_from_error (res, error);
4328 g_error_free (error);
4331 g_simple_async_result_complete_in_idle (res);
4337 g_file_real_copy_async (GFile *source,
4339 GFileCopyFlags flags,
4341 GCancellable *cancellable,
4342 GFileProgressCallback progress_callback,
4343 gpointer progress_callback_data,
4344 GAsyncReadyCallback callback,
4347 GSimpleAsyncResult *res;
4348 CopyAsyncData *data;
4350 data = g_new0 (CopyAsyncData, 1);
4351 data->source = g_object_ref (source);
4352 data->destination = g_object_ref (destination);
4353 data->flags = flags;
4354 data->progress_cb = progress_callback;
4355 data->progress_cb_data = progress_callback_data;
4357 res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
4358 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
4360 g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
4364 g_file_real_copy_finish (GFile *file,
4368 /* Error handled in g_file_copy_finish() */
4373 /********************************************
4374 * Default VFS operations *
4375 ********************************************/
4378 * g_file_new_for_path:
4379 * @path: a string containing a relative or absolute path.
4381 * Constructs a #GFile for a given path. This operation never
4382 * fails, but the returned object might not support any I/O
4383 * operation if @path is malformed.
4385 * Returns: a new #GFile for the given @path.
4388 g_file_new_for_path (const char *path)
4390 g_return_val_if_fail (path != NULL, NULL);
4392 return g_vfs_get_file_for_path (g_vfs_get_default (), path);
4396 * g_file_new_for_uri:
4397 * @uri: a string containing a URI.
4399 * Constructs a #GFile for a given URI. This operation never
4400 * fails, but the returned object might not support any I/O
4401 * operation if @uri is malformed or if the uri type is
4404 * Returns: a #GFile for the given @uri.
4407 g_file_new_for_uri (const char *uri)
4409 g_return_val_if_fail (uri != NULL, NULL);
4411 return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
4415 * g_file_parse_name:
4416 * @parse_name: a file name or path to be parsed.
4418 * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
4419 * This operation never fails, but the returned object might not support any I/O
4420 * operation if the @parse_name cannot be parsed.
4422 * Returns: a new #GFile.
4425 g_file_parse_name (const char *parse_name)
4427 g_return_val_if_fail (parse_name != NULL, NULL);
4429 return g_vfs_parse_name (g_vfs_get_default (), parse_name);
4433 is_valid_scheme_character (char c)
4435 return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
4439 has_valid_scheme (const char *uri)
4445 if (!is_valid_scheme_character (*p))
4450 } while (is_valid_scheme_character (*p));
4456 * g_file_new_for_commandline_arg:
4457 * @arg: a command line string.
4459 * Creates a #GFile with the given argument from the command line. The value of
4460 * @arg can be either a URI, an absolute path or a relative path resolved
4461 * relative to the current working directory.
4462 * This operation never fails, but the returned object might not support any
4463 * I/O operation if @arg points to a malformed path.
4465 * Returns: a new #GFile.
4468 g_file_new_for_commandline_arg (const char *arg)
4474 g_return_val_if_fail (arg != NULL, NULL);
4476 if (g_path_is_absolute (arg))
4477 return g_file_new_for_path (arg);
4479 if (has_valid_scheme (arg))
4480 return g_file_new_for_uri (arg);
4482 current_dir = g_get_current_dir ();
4483 filename = g_build_filename (current_dir, arg, NULL);
4484 g_free (current_dir);
4486 file = g_file_new_for_path (filename);
4493 * g_file_mount_enclosing_volume:
4494 * @location: input #GFile.
4495 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
4496 * @cancellable: optional #GCancellable object, %NULL to ignore.
4497 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4498 * @user_data: the data to pass to callback function
4500 * Starts a @mount_operation, mounting the volume that contains the file @location.
4502 * When this operation has completed, @callback will be called with
4503 * @user_user data, and the operation can be finalized with
4504 * g_file_mount_enclosing_volume_finish().
4506 * If @cancellable is not %NULL, then the operation can be cancelled by
4507 * triggering the cancellable object from another thread. If the operation
4508 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4511 g_file_mount_enclosing_volume (GFile *location,
4512 GMountOperation *mount_operation,
4513 GCancellable *cancellable,
4514 GAsyncReadyCallback callback,
4519 g_return_if_fail (G_IS_FILE (location));
4521 iface = G_FILE_GET_IFACE (location);
4523 if (iface->mount_enclosing_volume == NULL)
4525 g_simple_async_report_error_in_idle (G_OBJECT (location),
4526 callback, user_data,
4527 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
4528 _("volume doesn't implement mount"));
4533 (* iface->mount_enclosing_volume) (location, mount_operation, cancellable, callback, user_data);
4538 * g_file_mount_enclosing_volume_finish:
4539 * @location: input #GFile.
4540 * @result: a #GAsyncResult.
4541 * @error: a #GError, or %NULL
4543 * Finishes a mount operation started by g_file_mount_enclosing_volume().
4545 * Returns: %TRUE if successful. If an error
4546 * has occurred, this function will return %FALSE and set @error
4547 * appropriately if present.
4550 g_file_mount_enclosing_volume_finish (GFile *location,
4551 GAsyncResult *result,
4556 g_return_val_if_fail (G_IS_FILE (location), FALSE);
4557 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4559 if (G_IS_SIMPLE_ASYNC_RESULT (result))
4561 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
4562 if (g_simple_async_result_propagate_error (simple, error))
4566 iface = G_FILE_GET_IFACE (location);
4568 return (* iface->mount_enclosing_volume_finish) (location, result, error);
4571 /********************************************
4572 * Utility functions *
4573 ********************************************/
4576 g_file_query_default_handler (GFile *file,
4577 GCancellable *cancellable,
4581 const char *content_type;
4586 uri_scheme = g_file_get_uri_scheme (file);
4587 appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
4588 g_free (uri_scheme);
4590 if (appinfo != NULL)
4593 info = g_file_query_info (file,
4594 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
4603 content_type = g_file_info_get_content_type (info);
4606 /* Don't use is_native(), as we want to support fuse paths if availible */
4607 path = g_file_get_path (file);
4608 appinfo = g_app_info_get_default_for_type (content_type,
4613 g_object_unref (info);
4615 if (appinfo != NULL)
4618 g_set_error (error, G_IO_ERROR,
4619 G_IO_ERROR_NOT_SUPPORTED,
4620 _("No application is registered as handling this file"));
4626 #define GET_CONTENT_BLOCK_SIZE 8192
4629 * g_file_load_contents:
4630 * @file: input #GFile.
4631 * @cancellable: optional #GCancellable object, %NULL to ignore.
4632 * @contents: a location to place the contents of the file.
4633 * @length: a location to place the length of the contents of the file.
4634 * @etag_out: a location to place the current entity tag for the file.
4635 * @error: a #GError, or %NULL
4637 * Loads the content of the file into memory, returning the size of
4638 * the data. The data is always zero terminated, but this is not
4639 * included in the resultant @length.
4641 * If @cancellable is not %NULL, then the operation can be cancelled by
4642 * triggering the cancellable object from another thread. If the operation
4643 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4645 * Returns: %TRUE if the @file's contents were successfully loaded.
4646 * %FALSE if there were errors..
4649 g_file_load_contents (GFile *file,
4650 GCancellable *cancellable,
4656 GFileInputStream *in;
4657 GByteArray *content;
4662 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4663 g_return_val_if_fail (contents != NULL, FALSE);
4665 in = g_file_read (file, cancellable, error);
4669 content = g_byte_array_new ();
4672 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
4673 while ((res = g_input_stream_read (G_INPUT_STREAM (in),
4674 content->data + pos,
4675 GET_CONTENT_BLOCK_SIZE,
4676 cancellable, error)) > 0)
4679 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
4686 info = g_file_input_stream_query_info (in,
4687 G_FILE_ATTRIBUTE_ETAG_VALUE,
4692 *etag_out = g_strdup (g_file_info_get_etag (info));
4693 g_object_unref (info);
4697 /* Ignore errors on close */
4698 g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
4699 g_object_unref (in);
4703 /* error is set already */
4704 g_byte_array_free (content, TRUE);
4711 /* Zero terminate (we got an extra byte allocated for this */
4712 content->data[pos] = 0;
4714 *contents = (char *)g_byte_array_free (content, FALSE);
4722 GCancellable *cancellable;
4723 GFileReadMoreCallback read_more_callback;
4724 GAsyncReadyCallback callback;
4726 GByteArray *content;
4733 load_contents_data_free (LoadContentsData *data)
4736 g_error_free (data->error);
4737 if (data->cancellable)
4738 g_object_unref (data->cancellable);
4740 g_byte_array_free (data->content, TRUE);
4741 g_free (data->etag);
4742 g_object_unref (data->file);
4747 load_contents_close_callback (GObject *obj,
4748 GAsyncResult *close_res,
4751 GInputStream *stream = G_INPUT_STREAM (obj);
4752 LoadContentsData *data = user_data;
4753 GSimpleAsyncResult *res;
4755 /* Ignore errors here, we're only reading anyway */
4756 g_input_stream_close_finish (stream, close_res, NULL);
4757 g_object_unref (stream);
4759 res = g_simple_async_result_new (G_OBJECT (data->file),
4762 g_file_load_contents_async);
4763 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
4764 g_simple_async_result_complete (res);
4765 g_object_unref (res);
4769 load_contents_fstat_callback (GObject *obj,
4770 GAsyncResult *stat_res,
4773 GInputStream *stream = G_INPUT_STREAM (obj);
4774 LoadContentsData *data = user_data;
4777 info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
4781 data->etag = g_strdup (g_file_info_get_etag (info));
4782 g_object_unref (info);
4785 g_input_stream_close_async (stream, 0,
4787 load_contents_close_callback, data);
4791 load_contents_read_callback (GObject *obj,
4792 GAsyncResult *read_res,
4795 GInputStream *stream = G_INPUT_STREAM (obj);
4796 LoadContentsData *data = user_data;
4797 GError *error = NULL;
4800 read_size = g_input_stream_read_finish (stream, read_res, &error);
4804 /* Error or EOF, close the file */
4805 data->error = error;
4806 g_input_stream_close_async (stream, 0,
4808 load_contents_close_callback, data);
4810 else if (read_size == 0)
4812 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
4813 G_FILE_ATTRIBUTE_ETAG_VALUE,
4816 load_contents_fstat_callback,
4819 else if (read_size > 0)
4821 data->pos += read_size;
4823 g_byte_array_set_size (data->content,
4824 data->pos + GET_CONTENT_BLOCK_SIZE);
4827 if (data->read_more_callback &&
4828 !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
4829 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
4830 G_FILE_ATTRIBUTE_ETAG_VALUE,
4833 load_contents_fstat_callback,
4836 g_input_stream_read_async (stream,
4837 data->content->data + data->pos,
4838 GET_CONTENT_BLOCK_SIZE,
4841 load_contents_read_callback,
4847 load_contents_open_callback (GObject *obj,
4848 GAsyncResult *open_res,
4851 GFile *file = G_FILE (obj);
4852 GFileInputStream *stream;
4853 LoadContentsData *data = user_data;
4854 GError *error = NULL;
4855 GSimpleAsyncResult *res;
4857 stream = g_file_read_finish (file, open_res, &error);
4861 g_byte_array_set_size (data->content,
4862 data->pos + GET_CONTENT_BLOCK_SIZE);
4863 g_input_stream_read_async (G_INPUT_STREAM (stream),
4864 data->content->data + data->pos,
4865 GET_CONTENT_BLOCK_SIZE,
4868 load_contents_read_callback,
4874 res = g_simple_async_result_new_from_error (G_OBJECT (data->file),
4878 g_simple_async_result_complete (res);
4879 g_error_free (error);
4880 load_contents_data_free (data);
4881 g_object_unref (res);
4886 * g_file_load_partial_contents_async:
4887 * @file: input #GFile.
4888 * @cancellable: optional #GCancellable object, %NULL to ignore.
4889 * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
4890 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
4891 * @user_data: the data to pass to the callback functions.
4893 * Reads the partial contents of a file. A #GFileReadMoreCallback should be
4894 * used to stop reading from the file when appropriate, else this function
4895 * will behave exactly as g_file_load_contents_async(). This operation
4896 * can be finished by g_file_load_partial_contents_finish().
4898 * Users of this function should be aware that @user_data is passed to
4899 * both the @read_more_callback and the @callback.
4901 * If @cancellable is not %NULL, then the operation can be cancelled by
4902 * triggering the cancellable object from another thread. If the operation
4903 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4906 g_file_load_partial_contents_async (GFile *file,
4907 GCancellable *cancellable,
4908 GFileReadMoreCallback read_more_callback,
4909 GAsyncReadyCallback callback,
4912 LoadContentsData *data;
4914 g_return_if_fail (G_IS_FILE (file));
4916 data = g_new0 (LoadContentsData, 1);
4919 data->cancellable = g_object_ref (cancellable);
4920 data->read_more_callback = read_more_callback;
4921 data->callback = callback;
4922 data->user_data = user_data;
4923 data->content = g_byte_array_new ();
4924 data->file = g_object_ref (file);
4926 g_file_read_async (file,
4929 load_contents_open_callback,
4934 * g_file_load_partial_contents_finish:
4935 * @file: input #GFile.
4936 * @res: a #GAsyncResult.
4937 * @contents: a location to place the contents of the file.
4938 * @length: a location to place the length of the contents of the file.
4939 * @etag_out: a location to place the current entity tag for the file.
4940 * @error: a #GError, or %NULL
4942 * Finishes an asynchronous partial load operation that was started
4943 * with g_file_load_partial_contents_async().
4945 * Returns: %TRUE if the load was successful. If %FALSE and @error is
4946 * present, it will be set appropriately.
4949 g_file_load_partial_contents_finish (GFile *file,
4956 GSimpleAsyncResult *simple;
4957 LoadContentsData *data;
4959 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4960 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
4961 g_return_val_if_fail (contents != NULL, FALSE);
4963 simple = G_SIMPLE_ASYNC_RESULT (res);
4965 if (g_simple_async_result_propagate_error (simple, error))
4968 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
4970 data = g_simple_async_result_get_op_res_gpointer (simple);
4974 g_propagate_error (error, data->error);
4983 *length = data->pos;
4987 *etag_out = data->etag;
4991 /* Zero terminate */
4992 g_byte_array_set_size (data->content, data->pos + 1);
4993 data->content->data[data->pos] = 0;
4995 *contents = (char *)g_byte_array_free (data->content, FALSE);
4996 data->content = NULL;
5002 * g_file_load_contents_async:
5003 * @file: input #GFile.
5004 * @cancellable: optional #GCancellable object, %NULL to ignore.
5005 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5006 * @user_data: the data to pass to callback function
5008 * Starts an asynchronous load of the @file's contents.
5010 * For more details, see g_file_load_contents() which is
5011 * the synchronous version of this call.
5013 * When the load operation has completed, @callback will be called
5014 * with @user data. To finish the operation, call
5015 * g_file_load_contents_finish() with the #GAsyncResult returned by
5018 * If @cancellable is not %NULL, then the operation can be cancelled by
5019 * triggering the cancellable object from another thread. If the operation
5020 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5023 g_file_load_contents_async (GFile *file,
5024 GCancellable *cancellable,
5025 GAsyncReadyCallback callback,
5028 g_file_load_partial_contents_async (file,
5031 callback, user_data);
5035 * g_file_load_contents_finish:
5036 * @file: input #GFile.
5037 * @res: a #GAsyncResult.
5038 * @contents: a location to place the contents of the file.
5039 * @length: a location to place the length of the contents of the file.
5040 * @etag_out: a location to place the current entity tag for the file.
5041 * @error: a #GError, or %NULL
5043 * Finishes an asynchronous load of the @file's contents.
5044 * The contents are placed in @contents, and @length is set to the
5045 * size of the @contents string. If @etag_out is present, it will be
5046 * set to the new entity tag for the @file.
5048 * Returns: %TRUE if the load was successful. If %FALSE and @error is
5049 * present, it will be set appropriately.
5052 g_file_load_contents_finish (GFile *file,
5059 return g_file_load_partial_contents_finish (file,
5068 * g_file_replace_contents:
5069 * @file: input #GFile.
5070 * @contents: a string containing the new contents for @file.
5071 * @length: the length of @contents in bytes.
5072 * @etag: the old <link linkend="gfile-etag">entity tag</link>
5074 * @make_backup: %TRUE if a backup should be created.
5075 * @flags: a set of #GFileCreateFlags.
5076 * @new_etag: a location to a new <link linkend="gfile-etag">entity tag</link>
5077 * for the document. This should be freed with g_free() when no longer
5079 * @cancellable: optional #GCancellable object, %NULL to ignore.
5080 * @error: a #GError, or %NULL
5082 * Replaces the contents of @file with @contents of @length bytes.
5084 * If @etag is specified (not %NULL) any existing file must have that etag, or
5085 * the error %G_IO_ERROR_WRONG_ETAG will be returned.
5087 * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
5089 * If @cancellable is not %NULL, then the operation can be cancelled by
5090 * triggering the cancellable object from another thread. If the operation
5091 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5093 * The returned @new_etag can be used to verify that the file hasn't changed the
5094 * next time it is saved over.
5096 * Returns: %TRUE if successful. If an error
5097 * has occurred, this function will return %FALSE and set @error
5098 * appropriately if present.
5101 g_file_replace_contents (GFile *file,
5102 const char *contents,
5105 gboolean make_backup,
5106 GFileCreateFlags flags,
5108 GCancellable *cancellable,
5111 GFileOutputStream *out;
5112 gsize pos, remainder;
5115 g_return_val_if_fail (G_IS_FILE (file), FALSE);
5116 g_return_val_if_fail (contents != NULL, FALSE);
5118 out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
5124 while (remainder > 0 &&
5125 (res = g_output_stream_write (G_OUTPUT_STREAM (out),
5127 MIN (remainder, GET_CONTENT_BLOCK_SIZE),
5135 if (remainder > 0 && res < 0)
5137 /* Ignore errors on close */
5138 g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
5140 /* error is set already */
5144 if (!g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error))
5148 *new_etag = g_file_output_stream_get_etag (out);
5156 GCancellable *cancellable;
5157 GAsyncReadyCallback callback;
5159 const char *content;
5163 } ReplaceContentsData;
5166 replace_contents_data_free (ReplaceContentsData *data)
5169 g_error_free (data->error);
5170 if (data->cancellable)
5171 g_object_unref (data->cancellable);
5172 g_object_unref (data->file);
5173 g_free (data->etag);
5178 replace_contents_close_callback (GObject *obj,
5179 GAsyncResult *close_res,
5182 GOutputStream *stream = G_OUTPUT_STREAM (obj);
5183 ReplaceContentsData *data = user_data;
5184 GSimpleAsyncResult *res;
5186 /* Ignore errors here, we're only reading anyway */
5187 g_output_stream_close_finish (stream, close_res, NULL);
5188 g_object_unref (stream);
5190 data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
5192 res = g_simple_async_result_new (G_OBJECT (data->file),
5195 g_file_replace_contents_async);
5196 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
5197 g_simple_async_result_complete (res);
5198 g_object_unref (res);
5202 replace_contents_write_callback (GObject *obj,
5203 GAsyncResult *read_res,
5206 GOutputStream *stream = G_OUTPUT_STREAM (obj);
5207 ReplaceContentsData *data = user_data;
5208 GError *error = NULL;
5211 write_size = g_output_stream_write_finish (stream, read_res, &error);
5213 if (write_size <= 0)
5215 /* Error or EOF, close the file */
5217 data->error = error;
5218 g_output_stream_close_async (stream, 0,
5220 replace_contents_close_callback, data);
5222 else if (write_size > 0)
5224 data->pos += write_size;
5226 if (data->pos >= data->length)
5227 g_output_stream_close_async (stream, 0,
5229 replace_contents_close_callback, data);
5231 g_output_stream_write_async (stream,
5232 data->content + data->pos,
5233 data->length - data->pos,
5236 replace_contents_write_callback,
5242 replace_contents_open_callback (GObject *obj,
5243 GAsyncResult *open_res,
5246 GFile *file = G_FILE (obj);
5247 GFileOutputStream *stream;
5248 ReplaceContentsData *data = user_data;
5249 GError *error = NULL;
5250 GSimpleAsyncResult *res;
5252 stream = g_file_replace_finish (file, open_res, &error);
5256 g_output_stream_write_async (G_OUTPUT_STREAM (stream),
5257 data->content + data->pos,
5258 data->length - data->pos,
5261 replace_contents_write_callback,
5267 res = g_simple_async_result_new_from_error (G_OBJECT (data->file),
5271 g_simple_async_result_complete (res);
5272 g_error_free (error);
5273 replace_contents_data_free (data);
5274 g_object_unref (res);
5279 * g_file_replace_contents_async:
5280 * @file: input #GFile.
5281 * @contents: string of contents to replace the file with.
5282 * @length: the length of @contents in bytes.
5283 * @etag: a new <link linkend="gfile-etag">entity tag</link> for the @file.
5284 * @make_backup: %TRUE if a backup should be created.
5285 * @flags: a set of #GFileCreateFlags.
5286 * @cancellable: optional #GCancellable object, %NULL to ignore.
5287 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
5288 * @user_data: the data to pass to callback function
5290 * Starts an asynchronous replacement of @file with the given
5291 * @contents of @length bytes. @etag will replace the document's
5292 * current entity tag.
5294 * When this operation has completed, @callback will be called with
5295 * @user_user data, and the operation can be finalized with
5296 * g_file_replace_contents_finish().
5298 * If @cancellable is not %NULL, then the operation can be cancelled by
5299 * triggering the cancellable object from another thread. If the operation
5300 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5302 * If @make_backup is %TRUE, this function will attempt to
5303 * make a backup of @file.
5306 g_file_replace_contents_async (GFile *file,
5307 const char *contents,
5310 gboolean make_backup,
5311 GFileCreateFlags flags,
5312 GCancellable *cancellable,
5313 GAsyncReadyCallback callback,
5316 ReplaceContentsData *data;
5318 g_return_if_fail (G_IS_FILE (file));
5319 g_return_if_fail (contents != NULL);
5321 data = g_new0 (ReplaceContentsData, 1);
5324 data->cancellable = g_object_ref (cancellable);
5325 data->callback = callback;
5326 data->user_data = user_data;
5327 data->content = contents;
5328 data->length = length;
5330 data->file = g_object_ref (file);
5332 g_file_replace_async (file,
5338 replace_contents_open_callback,
5343 * g_file_replace_contents_finish:
5344 * @file: input #GFile.
5345 * @res: a #GAsyncResult.
5346 * @new_etag: a location of a new <link linkend="gfile-etag">entity tag</link>
5347 * for the document. This should be freed with g_free() when it is no
5349 * @error: a #GError, or %NULL
5351 * Finishes an asynchronous replace of the given @file. See
5352 * g_file_replace_contents_async(). Sets @new_etag to the new entity
5353 * tag for the document, if present.
5355 * Returns: %TRUE on success, %FALSE on failure.
5358 g_file_replace_contents_finish (GFile *file,
5363 GSimpleAsyncResult *simple;
5364 ReplaceContentsData *data;
5366 g_return_val_if_fail (G_IS_FILE (file), FALSE);
5367 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
5369 simple = G_SIMPLE_ASYNC_RESULT (res);
5371 if (g_simple_async_result_propagate_error (simple, error))
5374 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
5376 data = g_simple_async_result_get_op_res_gpointer (simple);
5380 g_propagate_error (error, data->error);
5388 *new_etag = data->etag;
5389 data->etag = NULL; /* Take ownership */
5395 #define __G_FILE_C__
5396 #include "gioaliasdef.c"