1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2006-2007 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
22 * Author: Alexander Larsson <alexl@redhat.com>
33 #include <sys/types.h>
39 #include "gioscheduler.h"
40 #include "gsimpleasyncresult.h"
41 #include "gfileattribute-priv.h"
42 #include "gfiledescriptorbased.h"
43 #include "gpollfilemonitor.h"
45 #include "gfileinputstream.h"
46 #include "gfileoutputstream.h"
47 #include "gcancellable.h"
48 #include "gasyncresult.h"
55 * @short_description: File and Directory Handling
57 * @see_also: #GFileInfo, #GFileEnumerator
59 * #GFile is a high level abstraction for manipulating files on a
60 * virtual file system. #GFile<!-- -->s are lightweight, immutable
61 * objects that do no I/O upon creation. It is necessary to understand that
62 * #GFile objects do not represent files, merely an identifier for a file. All
63 * file content I/O is implemented as streaming operations (see #GInputStream and
66 * To construct a #GFile, you can use:
67 * g_file_new_for_path() if you have a path.
68 * g_file_new_for_uri() if you have a URI.
69 * g_file_new_for_commandline_arg() for a command line argument.
70 * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name().
72 * One way to think of a #GFile is as an abstraction of a pathname. For normal
73 * files the system pathname is what is stored internally, but as #GFile<!-- -->s
74 * are extensible it could also be something else that corresponds to a pathname
75 * in a userspace implementation of a filesystem.
77 * #GFile<!-- -->s make up hierarchies of directories and files that correspond to the
78 * files on a filesystem. You can move through the file system with #GFile using
79 * g_file_get_parent() to get an identifier for the parent directory, g_file_get_child()
80 * to get a child within a directory, g_file_resolve_relative_path() to resolve a relative
81 * path between two #GFile<!-- -->s. There can be multiple hierarchies, so you may not
82 * end up at the same root if you repeatedly call g_file_get_parent() on two different
85 * All #GFile<!-- -->s have a basename (get with g_file_get_basename()). These names
86 * are byte strings that are used to identify the file on the filesystem (relative to
87 * its parent directory) and there is no guarantees that they have any particular charset
88 * encoding or even make any sense at all. If you want to use filenames in a user
89 * interface you should use the display name that you can get by requesting the
90 * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
91 * This is guaranteed to be in utf8 and can be used in a user interface. But always
92 * store the real basename or the #GFile to use to actually access the file, because
93 * there is no way to go from a display name to the actual name.
95 * Using #GFile as an identifier has the same weaknesses as using a path in that
96 * there may be multiple aliases for the same file. For instance, hard or
97 * soft links may cause two different #GFile<!-- -->s to refer to the same file.
98 * Other possible causes for aliases are: case insensitive filesystems, short
99 * and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if
100 * two #GFile<!-- -->s point to the same file you can query for the
101 * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
102 * canonicalization of pathnames passed in, so that trivial differences in the
103 * path string used at creation (duplicated slashes, slash at end of path, "."
104 * or ".." path segments, etc) does not create different #GFile<!-- -->s.
106 * Many #GFile operations have both synchronous and asynchronous versions
107 * to suit your application. Asynchronous versions of synchronous functions
108 * simply have _async() appended to their function names. The asynchronous
109 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
110 * the operation, producing a GAsyncResult which is then passed to the
111 * function's matching _finish() operation.
113 * Some #GFile operations do not have synchronous analogs, as they may
114 * take a very long time to finish, and blocking may leave an application
115 * unusable. Notable cases include:
116 * g_file_mount_mountable() to mount a mountable file.
117 * g_file_unmount_mountable_with_operation() to unmount a mountable file.
118 * g_file_eject_mountable_with_operation() to eject a mountable file.
120 * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
121 * One notable feature of #GFile<!-- -->s are entity tags, or "etags" for
122 * short. Entity tags are somewhat like a more abstract version of the
123 * traditional mtime, and can be used to quickly determine if the file has
124 * been modified from the version on the file system. See the HTTP 1.1
125 * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
126 * for HTTP Etag headers, which are a very similar concept.
130 static void g_file_real_query_info_async (GFile *file,
131 const char *attributes,
132 GFileQueryInfoFlags flags,
134 GCancellable *cancellable,
135 GAsyncReadyCallback callback,
137 static GFileInfo * g_file_real_query_info_finish (GFile *file,
140 static void g_file_real_query_filesystem_info_async (GFile *file,
141 const char *attributes,
143 GCancellable *cancellable,
144 GAsyncReadyCallback callback,
146 static GFileInfo * g_file_real_query_filesystem_info_finish (GFile *file,
149 static void g_file_real_enumerate_children_async (GFile *file,
150 const char *attributes,
151 GFileQueryInfoFlags flags,
153 GCancellable *cancellable,
154 GAsyncReadyCallback callback,
156 static GFileEnumerator * g_file_real_enumerate_children_finish (GFile *file,
159 static void g_file_real_read_async (GFile *file,
161 GCancellable *cancellable,
162 GAsyncReadyCallback callback,
164 static GFileInputStream * g_file_real_read_finish (GFile *file,
167 static void g_file_real_append_to_async (GFile *file,
168 GFileCreateFlags flags,
170 GCancellable *cancellable,
171 GAsyncReadyCallback callback,
173 static GFileOutputStream *g_file_real_append_to_finish (GFile *file,
176 static void g_file_real_create_async (GFile *file,
177 GFileCreateFlags flags,
179 GCancellable *cancellable,
180 GAsyncReadyCallback callback,
182 static GFileOutputStream *g_file_real_create_finish (GFile *file,
185 static void g_file_real_replace_async (GFile *file,
187 gboolean make_backup,
188 GFileCreateFlags flags,
190 GCancellable *cancellable,
191 GAsyncReadyCallback callback,
193 static GFileOutputStream *g_file_real_replace_finish (GFile *file,
196 static void g_file_real_open_readwrite_async (GFile *file,
198 GCancellable *cancellable,
199 GAsyncReadyCallback callback,
201 static GFileIOStream * g_file_real_open_readwrite_finish (GFile *file,
204 static void g_file_real_create_readwrite_async (GFile *file,
205 GFileCreateFlags flags,
207 GCancellable *cancellable,
208 GAsyncReadyCallback callback,
210 static GFileIOStream * g_file_real_create_readwrite_finish (GFile *file,
213 static void g_file_real_replace_readwrite_async (GFile *file,
215 gboolean make_backup,
216 GFileCreateFlags flags,
218 GCancellable *cancellable,
219 GAsyncReadyCallback callback,
221 static GFileIOStream * g_file_real_replace_readwrite_finish (GFile *file,
224 static gboolean g_file_real_set_attributes_from_info (GFile *file,
226 GFileQueryInfoFlags flags,
227 GCancellable *cancellable,
229 static void g_file_real_set_display_name_async (GFile *file,
230 const char *display_name,
232 GCancellable *cancellable,
233 GAsyncReadyCallback callback,
235 static GFile * g_file_real_set_display_name_finish (GFile *file,
238 static void g_file_real_set_attributes_async (GFile *file,
240 GFileQueryInfoFlags flags,
242 GCancellable *cancellable,
243 GAsyncReadyCallback callback,
245 static gboolean g_file_real_set_attributes_finish (GFile *file,
249 static void g_file_real_find_enclosing_mount_async (GFile *file,
251 GCancellable *cancellable,
252 GAsyncReadyCallback callback,
254 static GMount * g_file_real_find_enclosing_mount_finish (GFile *file,
257 static void g_file_real_copy_async (GFile *source,
259 GFileCopyFlags flags,
261 GCancellable *cancellable,
262 GFileProgressCallback progress_callback,
263 gpointer progress_callback_data,
264 GAsyncReadyCallback callback,
266 static gboolean g_file_real_copy_finish (GFile *file,
270 typedef GFileIface GFileInterface;
271 G_DEFINE_INTERFACE (GFile, g_file, G_TYPE_OBJECT)
274 g_file_default_init (GFileIface *iface)
276 iface->enumerate_children_async = g_file_real_enumerate_children_async;
277 iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
278 iface->set_display_name_async = g_file_real_set_display_name_async;
279 iface->set_display_name_finish = g_file_real_set_display_name_finish;
280 iface->query_info_async = g_file_real_query_info_async;
281 iface->query_info_finish = g_file_real_query_info_finish;
282 iface->query_filesystem_info_async = g_file_real_query_filesystem_info_async;
283 iface->query_filesystem_info_finish = g_file_real_query_filesystem_info_finish;
284 iface->set_attributes_async = g_file_real_set_attributes_async;
285 iface->set_attributes_finish = g_file_real_set_attributes_finish;
286 iface->read_async = g_file_real_read_async;
287 iface->read_finish = g_file_real_read_finish;
288 iface->append_to_async = g_file_real_append_to_async;
289 iface->append_to_finish = g_file_real_append_to_finish;
290 iface->create_async = g_file_real_create_async;
291 iface->create_finish = g_file_real_create_finish;
292 iface->replace_async = g_file_real_replace_async;
293 iface->replace_finish = g_file_real_replace_finish;
294 iface->open_readwrite_async = g_file_real_open_readwrite_async;
295 iface->open_readwrite_finish = g_file_real_open_readwrite_finish;
296 iface->create_readwrite_async = g_file_real_create_readwrite_async;
297 iface->create_readwrite_finish = g_file_real_create_readwrite_finish;
298 iface->replace_readwrite_async = g_file_real_replace_readwrite_async;
299 iface->replace_readwrite_finish = g_file_real_replace_readwrite_finish;
300 iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
301 iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
302 iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
303 iface->copy_async = g_file_real_copy_async;
304 iface->copy_finish = g_file_real_copy_finish;
310 * @file: input #GFile.
312 * Checks to see if a file is native to the platform.
314 * A native file s one expressed in the platform-native filename format,
315 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
316 * as it might be on a locally mounted remote filesystem.
318 * On some systems non-native files may be available using
319 * the native filesystem via a userspace filesystem (FUSE), in
320 * these cases this call will return %FALSE, but g_file_get_path()
321 * will still return a native path.
323 * This call does no blocking i/o.
325 * Returns: %TRUE if file is native.
328 g_file_is_native (GFile *file)
332 g_return_val_if_fail (G_IS_FILE (file), FALSE);
334 iface = G_FILE_GET_IFACE (file);
336 return (* iface->is_native) (file);
341 * g_file_has_uri_scheme:
342 * @file: input #GFile.
343 * @uri_scheme: a string containing a URI scheme.
345 * Checks to see if a #GFile has a given URI scheme.
347 * This call does no blocking i/o.
349 * Returns: %TRUE if #GFile's backend supports the
350 * given URI scheme, %FALSE if URI scheme is %NULL,
351 * not supported, or #GFile is invalid.
354 g_file_has_uri_scheme (GFile *file,
355 const char *uri_scheme)
359 g_return_val_if_fail (G_IS_FILE (file), FALSE);
360 g_return_val_if_fail (uri_scheme != NULL, FALSE);
362 iface = G_FILE_GET_IFACE (file);
364 return (* iface->has_uri_scheme) (file, uri_scheme);
369 * g_file_get_uri_scheme:
370 * @file: input #GFile.
372 * Gets the URI scheme for a #GFile.
373 * RFC 3986 decodes the scheme as:
375 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
377 * Common schemes include "file", "http", "ftp", etc.
379 * This call does no blocking i/o.
381 * Returns: a string containing the URI scheme for the given
382 * #GFile. The returned string should be freed with g_free()
383 * when no longer needed.
386 g_file_get_uri_scheme (GFile *file)
390 g_return_val_if_fail (G_IS_FILE (file), NULL);
392 iface = G_FILE_GET_IFACE (file);
394 return (* iface->get_uri_scheme) (file);
399 * g_file_get_basename:
400 * @file: input #GFile.
402 * Gets the base name (the last component of the path) for a given #GFile.
404 * If called for the top level of a system (such as the filesystem root
405 * or a uri like sftp://host/) it will return a single directory separator
406 * (and on Windows, possibly a drive letter).
408 * The base name is a byte string (*not* UTF-8). It has no defined encoding
409 * or rules other than it may not contain zero bytes. If you want to use
410 * filenames in a user interface you should use the display name that you
411 * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
412 * attribute with g_file_query_info().
414 * This call does no blocking i/o.
416 * Returns: string containing the #GFile's base name, or %NULL
417 * if given #GFile is invalid. The returned string should be
418 * freed with g_free() when no longer needed.
421 g_file_get_basename (GFile *file)
425 g_return_val_if_fail (G_IS_FILE (file), NULL);
427 iface = G_FILE_GET_IFACE (file);
429 return (* iface->get_basename) (file);
434 * @file: input #GFile.
436 * Gets the local pathname for #GFile, if one exists.
438 * This call does no blocking i/o.
440 * Returns: string containing the #GFile's path, or %NULL if
441 * no such path exists. The returned string should be
442 * freed with g_free() when no longer needed.
445 g_file_get_path (GFile *file)
449 g_return_val_if_fail (G_IS_FILE (file), NULL);
451 iface = G_FILE_GET_IFACE (file);
453 return (* iface->get_path) (file);
458 * @file: input #GFile.
460 * Gets the URI for the @file.
462 * This call does no blocking i/o.
464 * Returns: a string containing the #GFile's URI.
465 * The returned string should be freed with g_free() when no longer needed.
468 g_file_get_uri (GFile *file)
472 g_return_val_if_fail (G_IS_FILE (file), NULL);
474 iface = G_FILE_GET_IFACE (file);
476 return (* iface->get_uri) (file);
480 * g_file_get_parse_name:
481 * @file: input #GFile.
483 * Gets the parse name of the @file.
484 * A parse name is a UTF-8 string that describes the
485 * file such that one can get the #GFile back using
486 * g_file_parse_name().
488 * This is generally used to show the #GFile as a nice
489 * full-pathname kind of string in a user interface,
490 * like in a location entry.
492 * For local files with names that can safely be converted
493 * to UTF8 the pathname is used, otherwise the IRI is used
494 * (a form of URI that allows UTF8 characters unescaped).
496 * This call does no blocking i/o.
498 * Returns: a string containing the #GFile's parse name. The returned
499 * string should be freed with g_free() when no longer needed.
502 g_file_get_parse_name (GFile *file)
506 g_return_val_if_fail (G_IS_FILE (file), NULL);
508 iface = G_FILE_GET_IFACE (file);
510 return (* iface->get_parse_name) (file);
515 * @file: input #GFile.
517 * Duplicates a #GFile handle. This operation does not duplicate
518 * the actual file or directory represented by the #GFile; see
519 * g_file_copy() if attempting to copy a file.
521 * This call does no blocking i/o.
523 * Returns: (transfer full): a new #GFile that is a duplicate of the given #GFile.
526 g_file_dup (GFile *file)
530 g_return_val_if_fail (G_IS_FILE (file), NULL);
532 iface = G_FILE_GET_IFACE (file);
534 return (* iface->dup) (file);
539 * @file: #gconstpointer to a #GFile.
541 * Creates a hash value for a #GFile.
543 * This call does no blocking i/o.
546 * Returns: 0 if @file is not a valid #GFile, otherwise an
547 * integer that can be used as hash value for the #GFile.
548 * This function is intended for easily hashing a #GFile to
549 * add to a #GHashTable or similar data structure.
552 g_file_hash (gconstpointer file)
556 g_return_val_if_fail (G_IS_FILE (file), 0);
558 iface = G_FILE_GET_IFACE (file);
560 return (* iface->hash) ((GFile *)file);
565 * @file1: the first #GFile.
566 * @file2: the second #GFile.
568 * Checks equality of two given #GFile<!-- -->s. Note that two
569 * #GFile<!-- -->s that differ can still refer to the same
570 * file on the filesystem due to various forms of filename
573 * This call does no blocking i/o.
575 * Returns: %TRUE if @file1 and @file2 are equal.
576 * %FALSE if either is not a #GFile.
579 g_file_equal (GFile *file1,
584 g_return_val_if_fail (G_IS_FILE (file1), FALSE);
585 g_return_val_if_fail (G_IS_FILE (file2), FALSE);
587 if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
590 iface = G_FILE_GET_IFACE (file1);
592 return (* iface->equal) (file1, file2);
598 * @file: input #GFile.
600 * Gets the parent directory for the @file.
601 * If the @file represents the root directory of the
602 * file system, then %NULL will be returned.
604 * This call does no blocking i/o.
606 * Returns: (transfer full): a #GFile structure to the parent of the given
607 * #GFile or %NULL if there is no parent.
608 * Free the returned object with g_object_unref().
611 g_file_get_parent (GFile *file)
615 g_return_val_if_fail (G_IS_FILE (file), NULL);
617 iface = G_FILE_GET_IFACE (file);
619 return (* iface->get_parent) (file);
624 * @file: input #GFile
625 * @parent: the parent to check for, or %NULL
627 * Checks if @file has a parent, and optionally, if it is @parent.
629 * If @parent is %NULL then this function returns %TRUE if @file has any
630 * parent at all. If @parent is non-%NULL then %TRUE is only returned
631 * if @file is a child of @parent.
633 * Returns: %TRUE if @file is a child of @parent (or any parent in the
634 * case that @parent is %NULL).
639 g_file_has_parent (GFile *file,
642 GFile *actual_parent;
645 g_return_val_if_fail (G_IS_FILE (file), FALSE);
646 g_return_val_if_fail (parent == NULL || G_IS_FILE (parent), FALSE);
648 actual_parent = g_file_get_parent (file);
650 if (actual_parent != NULL)
653 result = g_file_equal (parent, actual_parent);
657 g_object_unref (actual_parent);
667 * @file: input #GFile.
668 * @name: string containing the child's basename.
670 * Gets a child of @file with basename equal to @name.
672 * Note that the file with that specific name might not exist, but
673 * you can still have a #GFile that points to it. You can use this
674 * for instance to create that file.
676 * This call does no blocking i/o.
678 * Returns: (transfer full): a #GFile to a child specified by @name.
679 * Free the returned object with g_object_unref().
682 g_file_get_child (GFile *file,
685 g_return_val_if_fail (G_IS_FILE (file), NULL);
686 g_return_val_if_fail (name != NULL, NULL);
688 return g_file_resolve_relative_path (file, name);
692 * g_file_get_child_for_display_name:
693 * @file: input #GFile.
694 * @display_name: string to a possible child.
697 * Gets the child of @file for a given @display_name (i.e. a UTF8
698 * version of the name). If this function fails, it returns %NULL and @error will be
699 * set. This is very useful when constructing a GFile for a new file
700 * and the user entered the filename in the user interface, for instance
701 * when you select a directory and type a filename in the file selector.
703 * This call does no blocking i/o.
705 * Returns: (transfer full): a #GFile to the specified child, or
706 * %NULL if the display name couldn't be converted.
707 * Free the returned object with g_object_unref().
710 g_file_get_child_for_display_name (GFile *file,
711 const char *display_name,
716 g_return_val_if_fail (G_IS_FILE (file), NULL);
717 g_return_val_if_fail (display_name != NULL, NULL);
719 iface = G_FILE_GET_IFACE (file);
721 return (* iface->get_child_for_display_name) (file, display_name, error);
726 * @file: input #GFile.
727 * @prefix: input #GFile.
729 * Checks whether @file has the prefix specified by @prefix. In other word,
730 * if the names of initial elements of @file<!-- -->s pathname match @prefix.
731 * Only full pathname elements are matched, so a path like /foo is not
732 * considered a prefix of /foobar, only of /foo/bar.
734 * This call does no i/o, as it works purely on names. As such it can
735 * sometimes return %FALSE even if @file is inside a @prefix (from a
736 * filesystem point of view), because the prefix of @file is an alias
739 * Virtual: prefix_matches
740 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix.
744 g_file_has_prefix (GFile *file,
749 g_return_val_if_fail (G_IS_FILE (file), FALSE);
750 g_return_val_if_fail (G_IS_FILE (prefix), FALSE);
752 if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix))
755 iface = G_FILE_GET_IFACE (file);
757 /* The vtable function differs in arg order since we're
758 using the old contains_file call */
759 return (* iface->prefix_matches) (prefix, file);
763 * g_file_get_relative_path:
764 * @parent: input #GFile.
765 * @descendant: input #GFile.
767 * Gets the path for @descendant relative to @parent.
769 * This call does no blocking i/o.
771 * Returns: string with the relative path from @descendant
772 * to @parent, or %NULL if @descendant doesn't have @parent as prefix.
773 * The returned string should be freed with g_free() when no longer needed.
776 g_file_get_relative_path (GFile *parent,
781 g_return_val_if_fail (G_IS_FILE (parent), NULL);
782 g_return_val_if_fail (G_IS_FILE (descendant), NULL);
784 if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
787 iface = G_FILE_GET_IFACE (parent);
789 return (* iface->get_relative_path) (parent, descendant);
793 * g_file_resolve_relative_path:
794 * @file: input #GFile.
795 * @relative_path: a given relative path string.
797 * Resolves a relative path for @file to an absolute path.
799 * This call does no blocking i/o.
801 * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path
802 * is %NULL or if @file is invalid.
803 * Free the returned object with g_object_unref().
806 g_file_resolve_relative_path (GFile *file,
807 const char *relative_path)
811 g_return_val_if_fail (G_IS_FILE (file), NULL);
812 g_return_val_if_fail (relative_path != NULL, NULL);
814 iface = G_FILE_GET_IFACE (file);
816 return (* iface->resolve_relative_path) (file, relative_path);
820 * g_file_enumerate_children:
821 * @file: input #GFile.
822 * @attributes: an attribute query string.
823 * @flags: a set of #GFileQueryInfoFlags.
824 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
825 * @error: #GError for error reporting.
827 * Gets the requested information about the files in a directory. The result
828 * is a #GFileEnumerator object that will give out #GFileInfo objects for
829 * all the files in the directory.
831 * The @attributes value is a string that specifies the file attributes that
832 * should be gathered. It is not an error if it's not possible to read a particular
833 * requested attribute from a file - it just won't be set. @attributes should
834 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
835 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
836 * namespace. An example attribute query be "standard::*,owner::user".
837 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
839 * If @cancellable is not %NULL, then the operation can be cancelled by
840 * triggering the cancellable object from another thread. If the operation
841 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
843 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
844 * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
845 * Other errors are possible too.
847 * Returns: (transfer full): A #GFileEnumerator if successful, %NULL on error.
848 * Free the returned object with g_object_unref().
851 g_file_enumerate_children (GFile *file,
852 const char *attributes,
853 GFileQueryInfoFlags flags,
854 GCancellable *cancellable,
860 g_return_val_if_fail (G_IS_FILE (file), NULL);
862 if (g_cancellable_set_error_if_cancelled (cancellable, error))
865 iface = G_FILE_GET_IFACE (file);
867 if (iface->enumerate_children == NULL)
869 g_set_error_literal (error, G_IO_ERROR,
870 G_IO_ERROR_NOT_SUPPORTED,
871 _("Operation not supported"));
875 return (* iface->enumerate_children) (file, attributes, flags,
880 * g_file_enumerate_children_async:
881 * @file: input #GFile.
882 * @attributes: an attribute query string.
883 * @flags: a set of #GFileQueryInfoFlags.
884 * @io_priority: the <link linkend="io-priority">I/O priority</link>
886 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
887 * @callback: (scope async): a #GAsyncReadyCallback to call when the
888 * request is satisfied
889 * @user_data: (closure): the data to pass to callback function
891 * Asynchronously gets the requested information about the files in a directory. The result
892 * is a #GFileEnumerator object that will give out #GFileInfo objects for
893 * all the files in the directory.
895 * For more details, see g_file_enumerate_children() which is
896 * the synchronous version of this call.
898 * When the operation is finished, @callback will be called. You can then call
899 * g_file_enumerate_children_finish() to get the result of the operation.
902 g_file_enumerate_children_async (GFile *file,
903 const char *attributes,
904 GFileQueryInfoFlags flags,
906 GCancellable *cancellable,
907 GAsyncReadyCallback callback,
912 g_return_if_fail (G_IS_FILE (file));
914 iface = G_FILE_GET_IFACE (file);
915 (* iface->enumerate_children_async) (file,
925 * g_file_enumerate_children_finish:
926 * @file: input #GFile.
927 * @res: a #GAsyncResult.
930 * Finishes an async enumerate children operation.
931 * See g_file_enumerate_children_async().
933 * Returns: (transfer full): a #GFileEnumerator or %NULL if an error occurred.
934 * Free the returned object with g_object_unref().
937 g_file_enumerate_children_finish (GFile *file,
943 g_return_val_if_fail (G_IS_FILE (file), NULL);
944 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
946 if (G_IS_SIMPLE_ASYNC_RESULT (res))
948 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
949 if (g_simple_async_result_propagate_error (simple, error))
953 iface = G_FILE_GET_IFACE (file);
954 return (* iface->enumerate_children_finish) (file, res, error);
958 * g_file_query_exists:
959 * @file: input #GFile.
960 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
962 * Utility function to check if a particular file exists. This is
963 * implemented using g_file_query_info() and as such does blocking I/O.
965 * Note that in many cases it is racy to first check for file existence
966 * and then execute something based on the outcome of that, because the
967 * file might have been created or removed in between the operations. The
968 * general approach to handling that is to not check, but just do the
969 * operation and handle the errors as they come.
971 * As an example of race-free checking, take the case of reading a file, and
972 * if it doesn't exist, creating it. There are two racy versions: read it, and
973 * on error create it; and: check if it exists, if not create it. These
974 * can both result in two processes creating the file (with perhaps a partially
975 * written file as the result). The correct approach is to always try to create
976 * the file with g_file_create() which will either atomically create the file
977 * or fail with a G_IO_ERROR_EXISTS error.
979 * However, in many cases an existence check is useful in a user
980 * interface, for instance to make a menu item sensitive/insensitive, so that
981 * you don't have to fool users that something is possible and then just show
982 * and error dialog. If you do this, you should make sure to also handle the
983 * errors that can happen due to races when you execute the operation.
985 * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
988 g_file_query_exists (GFile *file,
989 GCancellable *cancellable)
993 g_return_val_if_fail (G_IS_FILE(file), FALSE);
995 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
996 G_FILE_QUERY_INFO_NONE, cancellable, NULL);
999 g_object_unref (info);
1007 * g_file_query_file_type:
1008 * @file: input #GFile.
1009 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info().
1010 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1012 * Utility function to inspect the #GFileType of a file. This is
1013 * implemented using g_file_query_info() and as such does blocking I/O.
1015 * The primary use case of this method is to check if a file is a regular file,
1016 * directory, or symlink.
1018 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file
1024 g_file_query_file_type (GFile *file,
1025 GFileQueryInfoFlags flags,
1026 GCancellable *cancellable)
1029 GFileType file_type;
1031 g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN);
1032 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags,
1036 file_type = g_file_info_get_file_type (info);
1037 g_object_unref (info);
1040 file_type = G_FILE_TYPE_UNKNOWN;
1046 * g_file_query_info:
1047 * @file: input #GFile.
1048 * @attributes: an attribute query string.
1049 * @flags: a set of #GFileQueryInfoFlags.
1050 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1051 * @error: a #GError.
1053 * Gets the requested information about specified @file. The result
1054 * is a #GFileInfo object that contains key-value attributes (such as
1055 * the type or size of the file).
1057 * The @attributes value is a string that specifies the file attributes that
1058 * should be gathered. It is not an error if it's not possible to read a particular
1059 * requested attribute from a file - it just won't be set. @attributes should
1060 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
1061 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
1062 * namespace. An example attribute query be "standard::*,owner::user".
1063 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
1065 * If @cancellable is not %NULL, then the operation can be cancelled by
1066 * triggering the cancellable object from another thread. If the operation
1067 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1069 * For symlinks, normally the information about the target of the
1070 * symlink is returned, rather than information about the symlink itself.
1071 * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
1072 * information about the symlink itself will be returned. Also, for symlinks
1073 * that point to non-existing files the information about the symlink itself
1076 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1077 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1079 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error.
1080 * Free the returned object with g_object_unref().
1083 g_file_query_info (GFile *file,
1084 const char *attributes,
1085 GFileQueryInfoFlags flags,
1086 GCancellable *cancellable,
1091 g_return_val_if_fail (G_IS_FILE (file), NULL);
1093 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1096 iface = G_FILE_GET_IFACE (file);
1098 if (iface->query_info == NULL)
1100 g_set_error_literal (error, G_IO_ERROR,
1101 G_IO_ERROR_NOT_SUPPORTED,
1102 _("Operation not supported"));
1106 return (* iface->query_info) (file, attributes, flags, cancellable, error);
1110 * g_file_query_info_async:
1111 * @file: input #GFile.
1112 * @attributes: an attribute query string.
1113 * @flags: a set of #GFileQueryInfoFlags.
1114 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1116 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1117 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1118 * @user_data: (closure): the data to pass to callback function
1120 * Asynchronously gets the requested information about specified @file. The result
1121 * is a #GFileInfo object that contains key-value attributes (such as type or size
1124 * For more details, see g_file_query_info() which is
1125 * the synchronous version of this call.
1127 * When the operation is finished, @callback will be called. You can then call
1128 * g_file_query_info_finish() to get the result of the operation.
1131 g_file_query_info_async (GFile *file,
1132 const char *attributes,
1133 GFileQueryInfoFlags flags,
1135 GCancellable *cancellable,
1136 GAsyncReadyCallback callback,
1141 g_return_if_fail (G_IS_FILE (file));
1143 iface = G_FILE_GET_IFACE (file);
1144 (* iface->query_info_async) (file,
1154 * g_file_query_info_finish:
1155 * @file: input #GFile.
1156 * @res: a #GAsyncResult.
1157 * @error: a #GError.
1159 * Finishes an asynchronous file info query.
1160 * See g_file_query_info_async().
1162 * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
1163 * Free the returned object with g_object_unref().
1166 g_file_query_info_finish (GFile *file,
1172 g_return_val_if_fail (G_IS_FILE (file), NULL);
1173 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1175 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1177 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1178 if (g_simple_async_result_propagate_error (simple, error))
1182 iface = G_FILE_GET_IFACE (file);
1183 return (* iface->query_info_finish) (file, res, error);
1187 * g_file_query_filesystem_info:
1188 * @file: input #GFile.
1189 * @attributes: an attribute query string.
1190 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1191 * @error: a #GError.
1193 * Similar to g_file_query_info(), but obtains information
1194 * about the filesystem the @file is on, rather than the file itself.
1195 * For instance the amount of space available and the type of
1198 * The @attributes value is a string that specifies the file attributes that
1199 * should be gathered. It is not an error if it's not possible to read a particular
1200 * requested attribute from a file - it just won't be set. @attributes should
1201 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
1202 * means all attributes, and a wildcard like "filesystem::*" means all attributes in the
1203 * filesystem namespace. The standard namespace for filesystem attributes is "filesystem".
1204 * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
1205 * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
1206 * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1208 * If @cancellable is not %NULL, then the operation can be cancelled by
1209 * triggering the cancellable object from another thread. If the operation
1210 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1212 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1213 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1215 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1216 * Free the returned object with g_object_unref().
1219 g_file_query_filesystem_info (GFile *file,
1220 const char *attributes,
1221 GCancellable *cancellable,
1226 g_return_val_if_fail (G_IS_FILE (file), NULL);
1228 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1231 iface = G_FILE_GET_IFACE (file);
1233 if (iface->query_filesystem_info == NULL)
1235 g_set_error_literal (error, G_IO_ERROR,
1236 G_IO_ERROR_NOT_SUPPORTED,
1237 _("Operation not supported"));
1241 return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1245 * g_file_query_filesystem_info_async:
1246 * @file: input #GFile.
1247 * @attributes: an attribute query string.
1248 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1250 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1251 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1252 * @user_data: (closure): the data to pass to callback function
1254 * Asynchronously gets the requested information about the filesystem
1255 * that the specified @file is on. The result is a #GFileInfo object
1256 * that contains key-value attributes (such as type or size for the
1259 * For more details, see g_file_query_filesystem_info() which is the
1260 * synchronous version of this call.
1262 * When the operation is finished, @callback will be called. You can
1263 * then call g_file_query_info_finish() to get the result of the
1267 g_file_query_filesystem_info_async (GFile *file,
1268 const char *attributes,
1270 GCancellable *cancellable,
1271 GAsyncReadyCallback callback,
1276 g_return_if_fail (G_IS_FILE (file));
1278 iface = G_FILE_GET_IFACE (file);
1279 (* iface->query_filesystem_info_async) (file,
1288 * g_file_query_filesystem_info_finish:
1289 * @file: input #GFile.
1290 * @res: a #GAsyncResult.
1291 * @error: a #GError.
1293 * Finishes an asynchronous filesystem info query. See
1294 * g_file_query_filesystem_info_async().
1296 * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
1297 * Free the returned object with g_object_unref().
1300 g_file_query_filesystem_info_finish (GFile *file,
1306 g_return_val_if_fail (G_IS_FILE (file), NULL);
1307 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1309 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1311 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1312 if (g_simple_async_result_propagate_error (simple, error))
1316 iface = G_FILE_GET_IFACE (file);
1317 return (* iface->query_filesystem_info_finish) (file, res, error);
1321 * g_file_find_enclosing_mount:
1322 * @file: input #GFile.
1323 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1324 * @error: a #GError.
1326 * Gets a #GMount for the #GFile.
1328 * If the #GFileIface for @file does not have a mount (e.g. possibly a
1329 * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
1332 * If @cancellable is not %NULL, then the operation can be cancelled by
1333 * triggering the cancellable object from another thread. If the operation
1334 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1336 * Returns: (transfer full): a #GMount where the @file is located or %NULL on error.
1337 * Free the returned object with g_object_unref().
1340 g_file_find_enclosing_mount (GFile *file,
1341 GCancellable *cancellable,
1346 g_return_val_if_fail (G_IS_FILE (file), NULL);
1348 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1351 iface = G_FILE_GET_IFACE (file);
1352 if (iface->find_enclosing_mount == NULL)
1355 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
1356 /* Translators: This is an error message when trying to find the
1357 * enclosing (user visible) mount of a file, but none exists. */
1358 _("Containing mount does not exist"));
1362 return (* iface->find_enclosing_mount) (file, cancellable, error);
1366 * g_file_find_enclosing_mount_async:
1368 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1370 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1371 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1372 * @user_data: (closure): the data to pass to callback function
1374 * Asynchronously gets the mount for the file.
1376 * For more details, see g_file_find_enclosing_mount() which is
1377 * the synchronous version of this call.
1379 * When the operation is finished, @callback will be called. You can then call
1380 * g_file_find_enclosing_mount_finish() to get the result of the operation.
1383 g_file_find_enclosing_mount_async (GFile *file,
1385 GCancellable *cancellable,
1386 GAsyncReadyCallback callback,
1391 g_return_if_fail (G_IS_FILE (file));
1393 iface = G_FILE_GET_IFACE (file);
1394 (* iface->find_enclosing_mount_async) (file,
1402 * g_file_find_enclosing_mount_finish:
1404 * @res: a #GAsyncResult
1407 * Finishes an asynchronous find mount request.
1408 * See g_file_find_enclosing_mount_async().
1410 * Returns: (transfer full): #GMount for given @file or %NULL on error.
1411 * Free the returned object with g_object_unref().
1414 g_file_find_enclosing_mount_finish (GFile *file,
1420 g_return_val_if_fail (G_IS_FILE (file), NULL);
1421 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1423 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1425 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1426 if (g_simple_async_result_propagate_error (simple, error))
1430 iface = G_FILE_GET_IFACE (file);
1431 return (* iface->find_enclosing_mount_finish) (file, res, error);
1437 * @file: #GFile to read.
1438 * @cancellable: (allow-none): a #GCancellable
1439 * @error: a #GError, or %NULL
1441 * Opens a file for reading. The result is a #GFileInputStream that
1442 * can be used to read the contents of the file.
1444 * If @cancellable is not %NULL, then the operation can be cancelled by
1445 * triggering the cancellable object from another thread. If the operation
1446 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1448 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1449 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1450 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1453 * Returns: (transfer full): #GFileInputStream or %NULL on error.
1454 * Free the returned object with g_object_unref().
1457 g_file_read (GFile *file,
1458 GCancellable *cancellable,
1463 g_return_val_if_fail (G_IS_FILE (file), NULL);
1465 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1468 iface = G_FILE_GET_IFACE (file);
1470 if (iface->read_fn == NULL)
1472 g_set_error_literal (error, G_IO_ERROR,
1473 G_IO_ERROR_NOT_SUPPORTED,
1474 _("Operation not supported"));
1478 return (* iface->read_fn) (file, cancellable, error);
1483 * @file: input #GFile.
1484 * @flags: a set of #GFileCreateFlags.
1485 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1486 * @error: a #GError, or %NULL
1488 * Gets an output stream for appending data to the file. If
1489 * the file doesn't already exist it is created.
1491 * By default files created are generally readable by everyone,
1492 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1493 * will be made readable only to the current user, to the level that
1494 * is supported on the target filesystem.
1496 * If @cancellable is not %NULL, then the operation can be cancelled by
1497 * triggering the cancellable object from another thread. If the operation
1498 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1500 * Some file systems don't allow all file names, and may
1501 * return an %G_IO_ERROR_INVALID_FILENAME error.
1502 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
1503 * returned. Other errors are possible too, and depend on what kind of
1504 * filesystem the file is on.
1506 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1507 * Free the returned object with g_object_unref().
1510 g_file_append_to (GFile *file,
1511 GFileCreateFlags flags,
1512 GCancellable *cancellable,
1517 g_return_val_if_fail (G_IS_FILE (file), NULL);
1519 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1522 iface = G_FILE_GET_IFACE (file);
1524 if (iface->append_to == NULL)
1526 g_set_error_literal (error, G_IO_ERROR,
1527 G_IO_ERROR_NOT_SUPPORTED,
1528 _("Operation not supported"));
1532 return (* iface->append_to) (file, flags, cancellable, error);
1537 * @file: input #GFile.
1538 * @flags: a set of #GFileCreateFlags.
1539 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1540 * @error: a #GError, or %NULL
1542 * Creates a new file and returns an output stream for writing to it.
1543 * The file must not already exist.
1545 * By default files created are generally readable by everyone,
1546 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1547 * will be made readable only to the current user, to the level that
1548 * is supported on the target filesystem.
1550 * If @cancellable is not %NULL, then the operation can be cancelled by
1551 * triggering the cancellable object from another thread. If the operation
1552 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1554 * If a file or directory with this name already exists the G_IO_ERROR_EXISTS
1555 * error will be returned.
1556 * Some file systems don't allow all file names, and may
1557 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1558 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1559 * Other errors are possible too, and depend on what kind of
1560 * filesystem the file is on.
1562 * Returns: (transfer full): a #GFileOutputStream for the newly created file, or
1564 * Free the returned object with g_object_unref().
1567 g_file_create (GFile *file,
1568 GFileCreateFlags flags,
1569 GCancellable *cancellable,
1574 g_return_val_if_fail (G_IS_FILE (file), NULL);
1576 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1579 iface = G_FILE_GET_IFACE (file);
1581 if (iface->create == NULL)
1583 g_set_error_literal (error, G_IO_ERROR,
1584 G_IO_ERROR_NOT_SUPPORTED,
1585 _("Operation not supported"));
1589 return (* iface->create) (file, flags, cancellable, error);
1594 * @file: input #GFile.
1595 * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the
1596 * current #GFile, or #NULL to ignore.
1597 * @make_backup: %TRUE if a backup should be created.
1598 * @flags: a set of #GFileCreateFlags.
1599 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1600 * @error: a #GError, or %NULL
1602 * Returns an output stream for overwriting the file, possibly
1603 * creating a backup copy of the file first. If the file doesn't exist,
1604 * it will be created.
1606 * This will try to replace the file in the safest way possible so
1607 * that any errors during the writing will not affect an already
1608 * existing copy of the file. For instance, for local files it
1609 * may write to a temporary file and then atomically rename over
1610 * the destination when the stream is closed.
1612 * By default files created are generally readable by everyone,
1613 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1614 * will be made readable only to the current user, to the level that
1615 * is supported on the target filesystem.
1617 * If @cancellable is not %NULL, then the operation can be cancelled by
1618 * triggering the cancellable object from another thread. If the operation
1619 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1621 * If you pass in a non-#NULL @etag value, then this value is
1622 * compared to the current entity tag of the file, and if they differ
1623 * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
1624 * that the file has been changed since you last read it. You can get
1625 * the new etag from g_file_output_stream_get_etag() after you've
1626 * finished writing and closed the #GFileOutputStream. When you load
1627 * a new file you can use g_file_input_stream_query_info() to get
1628 * the etag of the file.
1630 * If @make_backup is %TRUE, this function will attempt to make a backup
1631 * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
1632 * error will be returned. If you want to replace anyway, try again with
1633 * @make_backup set to %FALSE.
1635 * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
1636 * and if the file is some other form of non-regular file then a
1637 * G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
1638 * Some file systems don't allow all file names, and may
1639 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1640 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1641 * Other errors are possible too, and depend on what kind of
1642 * filesystem the file is on.
1644 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1645 * Free the returned object with g_object_unref().
1648 g_file_replace (GFile *file,
1650 gboolean make_backup,
1651 GFileCreateFlags flags,
1652 GCancellable *cancellable,
1657 g_return_val_if_fail (G_IS_FILE (file), NULL);
1659 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1662 iface = G_FILE_GET_IFACE (file);
1664 if (iface->replace == NULL)
1666 g_set_error_literal (error, G_IO_ERROR,
1667 G_IO_ERROR_NOT_SUPPORTED,
1668 _("Operation not supported"));
1673 /* Handle empty tag string as NULL in consistent way. */
1674 if (etag && *etag == 0)
1677 return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1681 * g_file_open_readwrite:
1682 * @file: #GFile to open
1683 * @cancellable: (allow-none): a #GCancellable
1684 * @error: a #GError, or %NULL
1686 * Opens an existing file for reading and writing. The result is
1687 * a #GFileIOStream that can be used to read and write the contents of the file.
1689 * If @cancellable is not %NULL, then the operation can be cancelled by
1690 * triggering the cancellable object from another thread. If the operation
1691 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1693 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1694 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1695 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1696 * Note that in many non-local file cases read and write streams are not supported,
1697 * so make sure you really need to do read and write streaming, rather than
1698 * just opening for reading or writing.
1700 * Returns: (transfer full): #GFileIOStream or %NULL on error.
1701 * Free the returned object with g_object_unref().
1706 g_file_open_readwrite (GFile *file,
1707 GCancellable *cancellable,
1712 g_return_val_if_fail (G_IS_FILE (file), NULL);
1714 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1717 iface = G_FILE_GET_IFACE (file);
1719 if (iface->open_readwrite == NULL)
1721 g_set_error_literal (error, G_IO_ERROR,
1722 G_IO_ERROR_NOT_SUPPORTED,
1723 _("Operation not supported"));
1727 return (* iface->open_readwrite) (file, cancellable, error);
1731 * g_file_create_readwrite:
1733 * @flags: a set of #GFileCreateFlags
1734 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
1735 * @error: return location for a #GError, or %NULL
1737 * Creates a new file and returns a stream for reading and writing to it.
1738 * The file must not already exist.
1740 * By default files created are generally readable by everyone,
1741 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1742 * will be made readable only to the current user, to the level that
1743 * is supported on the target filesystem.
1745 * If @cancellable is not %NULL, then the operation can be cancelled by
1746 * triggering the cancellable object from another thread. If the operation
1747 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1749 * If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
1750 * error will be returned. Some file systems don't allow all file names,
1751 * and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
1752 * is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
1753 * are possible too, and depend on what kind of filesystem the file is on.
1755 * Note that in many non-local file cases read and write streams are not
1756 * supported, so make sure you really need to do read and write streaming,
1757 * rather than just opening for reading or writing.
1759 * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error.
1760 * Free the returned object with g_object_unref().
1765 g_file_create_readwrite (GFile *file,
1766 GFileCreateFlags flags,
1767 GCancellable *cancellable,
1772 g_return_val_if_fail (G_IS_FILE (file), NULL);
1774 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1777 iface = G_FILE_GET_IFACE (file);
1779 if (iface->create_readwrite == NULL)
1781 g_set_error_literal (error, G_IO_ERROR,
1782 G_IO_ERROR_NOT_SUPPORTED,
1783 _("Operation not supported"));
1787 return (* iface->create_readwrite) (file, flags, cancellable, error);
1791 * g_file_replace_readwrite:
1793 * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the
1794 * current #GFile, or #NULL to ignore
1795 * @make_backup: %TRUE if a backup should be created
1796 * @flags: a set of #GFileCreateFlags
1797 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
1798 * @error: return location for a #GError, or %NULL
1800 * Returns an output stream for overwriting the file in readwrite mode,
1801 * possibly creating a backup copy of the file first. If the file doesn't
1802 * exist, it will be created.
1804 * For details about the behaviour, see g_file_replace() which does the same
1805 * thing but returns an output stream only.
1807 * Note that in many non-local file cases read and write streams are not
1808 * supported, so make sure you really need to do read and write streaming,
1809 * rather than just opening for reading or writing.
1811 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
1812 * Free the returned object with g_object_unref().
1817 g_file_replace_readwrite (GFile *file,
1819 gboolean make_backup,
1820 GFileCreateFlags flags,
1821 GCancellable *cancellable,
1826 g_return_val_if_fail (G_IS_FILE (file), NULL);
1828 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1831 iface = G_FILE_GET_IFACE (file);
1833 if (iface->replace_readwrite == NULL)
1835 g_set_error_literal (error, G_IO_ERROR,
1836 G_IO_ERROR_NOT_SUPPORTED,
1837 _("Operation not supported"));
1841 return (* iface->replace_readwrite) (file, etag, make_backup, flags, cancellable, error);
1845 * g_file_read_async:
1846 * @file: input #GFile
1847 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1849 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1850 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1851 * @user_data: (closure): the data to pass to callback function
1853 * Asynchronously opens @file for reading.
1855 * For more details, see g_file_read() which is
1856 * the synchronous version of this call.
1858 * When the operation is finished, @callback will be called. You can then call
1859 * g_file_read_finish() to get the result of the operation.
1862 g_file_read_async (GFile *file,
1864 GCancellable *cancellable,
1865 GAsyncReadyCallback callback,
1870 g_return_if_fail (G_IS_FILE (file));
1872 iface = G_FILE_GET_IFACE (file);
1873 (* iface->read_async) (file,
1881 * g_file_read_finish:
1882 * @file: input #GFile.
1883 * @res: a #GAsyncResult.
1884 * @error: a #GError, or %NULL
1886 * Finishes an asynchronous file read operation started with
1887 * g_file_read_async().
1889 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
1890 * Free the returned object with g_object_unref().
1893 g_file_read_finish (GFile *file,
1899 g_return_val_if_fail (G_IS_FILE (file), NULL);
1900 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1902 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1904 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1905 if (g_simple_async_result_propagate_error (simple, error))
1909 iface = G_FILE_GET_IFACE (file);
1910 return (* iface->read_finish) (file, res, error);
1914 * g_file_append_to_async:
1915 * @file: input #GFile.
1916 * @flags: a set of #GFileCreateFlags.
1917 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1919 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1920 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1921 * @user_data: (closure): the data to pass to callback function
1923 * Asynchronously opens @file for appending.
1925 * For more details, see g_file_append_to() which is
1926 * the synchronous version of this call.
1928 * When the operation is finished, @callback will be called. You can then call
1929 * g_file_append_to_finish() to get the result of the operation.
1932 g_file_append_to_async (GFile *file,
1933 GFileCreateFlags flags,
1935 GCancellable *cancellable,
1936 GAsyncReadyCallback callback,
1941 g_return_if_fail (G_IS_FILE (file));
1943 iface = G_FILE_GET_IFACE (file);
1944 (* iface->append_to_async) (file,
1953 * g_file_append_to_finish:
1954 * @file: input #GFile.
1955 * @res: #GAsyncResult
1956 * @error: a #GError, or %NULL
1958 * Finishes an asynchronous file append operation started with
1959 * g_file_append_to_async().
1961 * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error.
1962 * Free the returned object with g_object_unref().
1965 g_file_append_to_finish (GFile *file,
1971 g_return_val_if_fail (G_IS_FILE (file), NULL);
1972 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1974 if (G_IS_SIMPLE_ASYNC_RESULT (res))
1976 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
1977 if (g_simple_async_result_propagate_error (simple, error))
1981 iface = G_FILE_GET_IFACE (file);
1982 return (* iface->append_to_finish) (file, res, error);
1986 * g_file_create_async:
1987 * @file: input #GFile.
1988 * @flags: a set of #GFileCreateFlags.
1989 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1991 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1992 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1993 * @user_data: (closure): the data to pass to callback function
1995 * Asynchronously creates a new file and returns an output stream for writing to it.
1996 * The file must not already exist.
1998 * For more details, see g_file_create() which is
1999 * the synchronous version of this call.
2001 * When the operation is finished, @callback will be called. You can then call
2002 * g_file_create_finish() to get the result of the operation.
2005 g_file_create_async (GFile *file,
2006 GFileCreateFlags flags,
2008 GCancellable *cancellable,
2009 GAsyncReadyCallback callback,
2014 g_return_if_fail (G_IS_FILE (file));
2016 iface = G_FILE_GET_IFACE (file);
2017 (* iface->create_async) (file,
2026 * g_file_create_finish:
2027 * @file: input #GFile.
2028 * @res: a #GAsyncResult.
2029 * @error: a #GError, or %NULL
2031 * Finishes an asynchronous file create operation started with
2032 * g_file_create_async().
2034 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2035 * Free the returned object with g_object_unref().
2038 g_file_create_finish (GFile *file,
2044 g_return_val_if_fail (G_IS_FILE (file), NULL);
2045 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2047 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2049 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2050 if (g_simple_async_result_propagate_error (simple, error))
2054 iface = G_FILE_GET_IFACE (file);
2055 return (* iface->create_finish) (file, res, error);
2059 * g_file_replace_async:
2060 * @file: input #GFile.
2061 * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the
2062 * current #GFile, or NULL to ignore.
2063 * @make_backup: %TRUE if a backup should be created.
2064 * @flags: a set of #GFileCreateFlags.
2065 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2067 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2068 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2069 * @user_data: (closure): the data to pass to callback function
2071 * Asynchronously overwrites the file, replacing the contents, possibly
2072 * creating a backup copy of the file first.
2074 * For more details, see g_file_replace() which is
2075 * the synchronous version of this call.
2077 * When the operation is finished, @callback will be called. You can then call
2078 * g_file_replace_finish() to get the result of the operation.
2081 g_file_replace_async (GFile *file,
2083 gboolean make_backup,
2084 GFileCreateFlags flags,
2086 GCancellable *cancellable,
2087 GAsyncReadyCallback callback,
2092 g_return_if_fail (G_IS_FILE (file));
2094 iface = G_FILE_GET_IFACE (file);
2095 (* iface->replace_async) (file,
2106 * g_file_replace_finish:
2107 * @file: input #GFile.
2108 * @res: a #GAsyncResult.
2109 * @error: a #GError, or %NULL
2111 * Finishes an asynchronous file replace operation started with
2112 * g_file_replace_async().
2114 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2115 * Free the returned object with g_object_unref().
2118 g_file_replace_finish (GFile *file,
2124 g_return_val_if_fail (G_IS_FILE (file), NULL);
2125 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2127 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2129 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2130 if (g_simple_async_result_propagate_error (simple, error))
2134 iface = G_FILE_GET_IFACE (file);
2135 return (* iface->replace_finish) (file, res, error);
2140 * g_file_open_readwrite_async:
2141 * @file: input #GFile.
2142 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2144 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2145 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2146 * @user_data: (closure): the data to pass to callback function
2148 * Asynchronously opens @file for reading and writing.
2150 * For more details, see g_file_open_readwrite() which is
2151 * the synchronous version of this call.
2153 * When the operation is finished, @callback will be called. You can then call
2154 * g_file_open_readwrite_finish() to get the result of the operation.
2159 g_file_open_readwrite_async (GFile *file,
2161 GCancellable *cancellable,
2162 GAsyncReadyCallback callback,
2167 g_return_if_fail (G_IS_FILE (file));
2169 iface = G_FILE_GET_IFACE (file);
2170 (* iface->open_readwrite_async) (file,
2178 * g_file_open_readwrite_finish:
2179 * @file: input #GFile.
2180 * @res: a #GAsyncResult.
2181 * @error: a #GError, or %NULL
2183 * Finishes an asynchronous file read operation started with
2184 * g_file_open_readwrite_async().
2186 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2187 * Free the returned object with g_object_unref().
2192 g_file_open_readwrite_finish (GFile *file,
2198 g_return_val_if_fail (G_IS_FILE (file), NULL);
2199 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2201 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2203 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2204 if (g_simple_async_result_propagate_error (simple, error))
2208 iface = G_FILE_GET_IFACE (file);
2209 return (* iface->open_readwrite_finish) (file, res, error);
2214 * g_file_create_readwrite_async:
2215 * @file: input #GFile
2216 * @flags: a set of #GFileCreateFlags
2217 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2219 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
2220 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2221 * @user_data: (closure): the data to pass to callback function
2223 * Asynchronously creates a new file and returns a stream for reading and
2224 * writing to it. The file must not already exist.
2226 * For more details, see g_file_create_readwrite() which is
2227 * the synchronous version of this call.
2229 * When the operation is finished, @callback will be called. You can then
2230 * call g_file_create_readwrite_finish() to get the result of the operation.
2235 g_file_create_readwrite_async (GFile *file,
2236 GFileCreateFlags flags,
2238 GCancellable *cancellable,
2239 GAsyncReadyCallback callback,
2244 g_return_if_fail (G_IS_FILE (file));
2246 iface = G_FILE_GET_IFACE (file);
2247 (* iface->create_readwrite_async) (file,
2256 * g_file_create_readwrite_finish:
2257 * @file: input #GFile
2258 * @res: a #GAsyncResult
2259 * @error: a #GError, or %NULL
2261 * Finishes an asynchronous file create operation started with
2262 * g_file_create_readwrite_async().
2264 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2265 * Free the returned object with g_object_unref().
2270 g_file_create_readwrite_finish (GFile *file,
2276 g_return_val_if_fail (G_IS_FILE (file), NULL);
2277 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2279 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2281 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2282 if (g_simple_async_result_propagate_error (simple, error))
2286 iface = G_FILE_GET_IFACE (file);
2287 return (* iface->create_readwrite_finish) (file, res, error);
2291 * g_file_replace_readwrite_async:
2292 * @file: input #GFile.
2293 * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the
2294 * current #GFile, or NULL to ignore.
2295 * @make_backup: %TRUE if a backup should be created.
2296 * @flags: a set of #GFileCreateFlags.
2297 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2299 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2300 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2301 * @user_data: (closure): the data to pass to callback function
2303 * Asynchronously overwrites the file in read-write mode, replacing the
2304 * contents, possibly creating a backup copy of the file first.
2306 * For more details, see g_file_replace_readwrite() which is
2307 * the synchronous version of this call.
2309 * When the operation is finished, @callback will be called. You can then
2310 * call g_file_replace_readwrite_finish() to get the result of the operation.
2315 g_file_replace_readwrite_async (GFile *file,
2317 gboolean make_backup,
2318 GFileCreateFlags flags,
2320 GCancellable *cancellable,
2321 GAsyncReadyCallback callback,
2326 g_return_if_fail (G_IS_FILE (file));
2328 iface = G_FILE_GET_IFACE (file);
2329 (* iface->replace_readwrite_async) (file,
2340 * g_file_replace_readwrite_finish:
2341 * @file: input #GFile.
2342 * @res: a #GAsyncResult.
2343 * @error: a #GError, or %NULL
2345 * Finishes an asynchronous file replace operation started with
2346 * g_file_replace_readwrite_async().
2348 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2349 * Free the returned object with g_object_unref().
2354 g_file_replace_readwrite_finish (GFile *file,
2360 g_return_val_if_fail (G_IS_FILE (file), NULL);
2361 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2363 if (G_IS_SIMPLE_ASYNC_RESULT (res))
2365 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
2366 if (g_simple_async_result_propagate_error (simple, error))
2370 iface = G_FILE_GET_IFACE (file);
2371 return (* iface->replace_readwrite_finish) (file, res, error);
2375 copy_symlink (GFile *destination,
2376 GFileCopyFlags flags,
2377 GCancellable *cancellable,
2382 gboolean tried_delete;
2384 GFileType file_type;
2386 tried_delete = FALSE;
2390 if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
2392 /* Maybe it already existed, and we want to overwrite? */
2393 if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
2394 my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
2396 g_error_free (my_error);
2399 /* Don't overwrite if the destination is a directory */
2400 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2401 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2402 cancellable, &my_error);
2405 file_type = g_file_info_get_file_type (info);
2406 g_object_unref (info);
2408 if (file_type == G_FILE_TYPE_DIRECTORY)
2410 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
2411 _("Can't copy over directory"));
2416 if (!g_file_delete (destination, cancellable, error))
2419 tried_delete = TRUE;
2423 g_propagate_error (error, my_error);
2430 static GInputStream *
2431 open_source_for_copy (GFile *source,
2433 GFileCopyFlags flags,
2434 GCancellable *cancellable,
2440 GFileType file_type;
2443 in = (GInputStream *)g_file_read (source, cancellable, &my_error);
2447 /* There was an error opening the source, try to set a good error for it: */
2449 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
2451 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2452 * as that is less useful to the app. Better check for errors on the
2455 g_error_free (my_error);
2458 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2459 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2460 cancellable, &my_error);
2462 g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_TYPE))
2464 file_type = g_file_info_get_file_type (info);
2465 g_object_unref (info);
2467 if (flags & G_FILE_COPY_OVERWRITE)
2469 if (file_type == G_FILE_TYPE_DIRECTORY)
2471 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
2472 _("Can't copy directory over directory"));
2475 /* continue to would_recurse error */
2479 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
2480 _("Target file exists"));
2486 /* Error getting info from target, return that error
2487 * (except for NOT_FOUND, which is no error here)
2489 if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
2491 g_propagate_error (error, my_error);
2494 g_clear_error (&my_error);
2497 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
2498 _("Can't recursively copy directory"));
2502 g_propagate_error (error, my_error);
2507 should_copy (GFileAttributeInfo *info,
2509 gboolean skip_perms)
2511 if (skip_perms && strcmp(info->name, "unix::mode") == 0)
2515 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
2516 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
2520 build_attribute_list_for_copy (GFileAttributeInfoList *attributes,
2521 GFileAttributeInfoList *namespaces,
2523 gboolean skip_perms)
2530 s = g_string_new ("");
2534 for (i = 0; i < attributes->n_infos; i++)
2536 if (should_copy (&attributes->infos[i], as_move, skip_perms))
2541 g_string_append_c (s, ',');
2543 g_string_append (s, attributes->infos[i].name);
2550 for (i = 0; i < namespaces->n_infos; i++)
2552 if (should_copy (&namespaces->infos[i], as_move, FALSE))
2557 g_string_append_c (s, ',');
2559 g_string_append (s, namespaces->infos[i].name);
2560 g_string_append (s, "::*");
2565 return g_string_free (s, FALSE);
2569 * g_file_copy_attributes:
2570 * @source: a #GFile with attributes.
2571 * @destination: a #GFile to copy attributes to.
2572 * @flags: a set of #GFileCopyFlags.
2573 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2574 * @error: a #GError, %NULL to ignore.
2576 * Copies the file attributes from @source to @destination.
2578 * Normally only a subset of the file attributes are copied,
2579 * those that are copies in a normal file copy operation
2580 * (which for instance does not include e.g. owner). However
2581 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2582 * all the metadata that is possible to copy is copied. This
2583 * is useful when implementing move by copy + delete source.
2585 * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise.
2588 g_file_copy_attributes (GFile *source,
2590 GFileCopyFlags flags,
2591 GCancellable *cancellable,
2594 GFileAttributeInfoList *attributes, *namespaces;
2595 char *attrs_to_read;
2599 gboolean source_nofollow_symlinks;
2600 gboolean skip_perms;
2602 as_move = flags & G_FILE_COPY_ALL_METADATA;
2603 source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
2604 skip_perms = (flags & G_FILE_COPY_TARGET_DEFAULT_PERMS) != 0;
2606 /* Ignore errors here, if the target supports no attributes there is nothing to copy */
2607 attributes = g_file_query_settable_attributes (destination, cancellable, NULL);
2608 namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL);
2610 if (attributes == NULL && namespaces == NULL)
2613 attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move, skip_perms);
2615 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2616 * we just don't copy it.
2618 info = g_file_query_info (source, attrs_to_read,
2619 source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
2623 g_free (attrs_to_read);
2628 res = g_file_set_attributes_from_info (destination,
2630 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2633 g_object_unref (info);
2636 g_file_attribute_info_list_unref (attributes);
2637 g_file_attribute_info_list_unref (namespaces);
2643 copy_stream_with_progress (GInputStream *in,
2646 GCancellable *cancellable,
2647 GFileProgressCallback progress_callback,
2648 gpointer progress_callback_data,
2651 gssize n_read, n_written;
2652 goffset current_size;
2653 char buffer[1024*64], *p;
2659 /* avoid performance impact of querying total size when it's not needed */
2660 if (progress_callback)
2662 info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2663 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2667 if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2668 total_size = g_file_info_get_size (info);
2669 g_object_unref (info);
2672 if (total_size == -1)
2674 info = g_file_query_info (source,
2675 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2676 G_FILE_QUERY_INFO_NONE,
2680 if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2681 total_size = g_file_info_get_size (info);
2682 g_object_unref (info);
2687 if (total_size == -1)
2694 n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2704 current_size += n_read;
2709 n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2710 if (n_written == -1)
2717 n_read -= n_written;
2723 if (progress_callback)
2724 progress_callback (current_size, total_size, progress_callback_data);
2727 /* Make sure we send full copied size */
2728 if (progress_callback)
2729 progress_callback (current_size, total_size, progress_callback_data);
2737 do_splice (int fd_in,
2742 long *bytes_transferd,
2748 result = splice (fd_in, off_in, fd_out, off_out, len, SPLICE_F_MORE);
2756 else if (errsv == ENOSYS || errsv == EINVAL)
2757 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2758 _("Splice not supported"));
2760 g_set_error (error, G_IO_ERROR,
2761 g_io_error_from_errno (errsv),
2762 _("Error splicing file: %s"),
2763 g_strerror (errsv));
2768 *bytes_transferd = result;
2773 splice_stream_with_progress (GInputStream *in,
2775 GCancellable *cancellable,
2776 GFileProgressCallback progress_callback,
2777 gpointer progress_callback_data,
2787 fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
2788 fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
2790 if (pipe (buffer) != 0)
2792 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2793 "Pipe creation failed");
2798 /* avoid performance impact of querying total size when it's not needed */
2799 if (progress_callback)
2803 if (fstat (fd_in, &sbuf) == 0)
2804 total_size = sbuf.st_size;
2807 if (total_size == -1)
2810 offset_in = offset_out = 0;
2817 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2820 if (!do_splice (fd_in, &offset_in, buffer[1], NULL, 1024*64, &n_read, error))
2831 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2834 if (!do_splice (buffer[0], NULL, fd_out, &offset_out, n_read, &n_written, error))
2837 n_read -= n_written;
2840 if (progress_callback)
2841 progress_callback (offset_in, total_size, progress_callback_data);
2844 /* Make sure we send full copied size */
2845 if (progress_callback)
2846 progress_callback (offset_in, total_size, progress_callback_data);
2857 file_copy_fallback (GFile *source,
2859 GFileCopyFlags flags,
2860 GCancellable *cancellable,
2861 GFileProgressCallback progress_callback,
2862 gpointer progress_callback_data,
2871 gboolean fallback = TRUE;
2874 /* need to know the file type */
2875 info = g_file_query_info (source,
2876 G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
2877 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2884 /* Maybe copy the symlink? */
2885 if ((flags & G_FILE_COPY_NOFOLLOW_SYMLINKS) &&
2886 g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK)
2888 target = g_file_info_get_symlink_target (info);
2891 if (!copy_symlink (destination, flags, cancellable, target, error))
2893 g_object_unref (info);
2897 g_object_unref (info);
2900 /* ... else fall back on a regular file copy */
2901 g_object_unref (info);
2903 /* Handle "special" files (pipes, device nodes, ...)? */
2904 else if (g_file_info_get_file_type (info) == G_FILE_TYPE_SPECIAL)
2906 /* FIXME: could try to recreate device nodes and others? */
2908 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2909 _("Can't copy special file"));
2910 g_object_unref (info);
2913 /* Everything else should just fall back on a regular copy. */
2915 g_object_unref (info);
2917 in = open_source_for_copy (source, destination, flags, cancellable, error);
2921 if (flags & G_FILE_COPY_OVERWRITE)
2923 out = (GOutputStream *)g_file_replace (destination,
2925 flags & G_FILE_COPY_BACKUP,
2926 G_FILE_CREATE_REPLACE_DESTINATION,
2927 cancellable, error);
2931 out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
2936 g_object_unref (in);
2941 if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
2943 GError *splice_err = NULL;
2945 result = splice_stream_with_progress (in, out, cancellable,
2946 progress_callback, progress_callback_data,
2949 if (result || !g_error_matches (splice_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
2953 g_propagate_error (error, splice_err);
2956 g_clear_error (&splice_err);
2961 result = copy_stream_with_progress (in, out, source, cancellable,
2962 progress_callback, progress_callback_data,
2965 /* Don't care about errors in source here */
2966 g_input_stream_close (in, cancellable, NULL);
2968 /* But write errors on close are bad! */
2969 if (!g_output_stream_close (out, cancellable, result ? error : NULL))
2972 g_object_unref (in);
2973 g_object_unref (out);
2975 if (result == FALSE)
2979 /* Ignore errors here. Failure to copy metadata is not a hard error */
2980 g_file_copy_attributes (source, destination,
2981 flags, cancellable, NULL);
2988 * @source: input #GFile.
2989 * @destination: destination #GFile
2990 * @flags: set of #GFileCopyFlags
2991 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2992 * @progress_callback: (scope call): function to callback with progress information
2993 * @progress_callback_data: (closure): user data to pass to @progress_callback
2994 * @error: #GError to set on error, or %NULL
2996 * Copies the file @source to the location specified by @destination.
2997 * Can not handle recursive copies of directories.
2999 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3000 * existing @destination file is overwritten.
3002 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3003 * will be copied as symlinks, otherwise the target of the
3004 * @source symlink will be copied.
3006 * If @cancellable is not %NULL, then the operation can be cancelled by
3007 * triggering the cancellable object from another thread. If the operation
3008 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3010 * If @progress_callback is not %NULL, then the operation can be monitored by
3011 * setting this to a #GFileProgressCallback function. @progress_callback_data
3012 * will be passed to this function. It is guaranteed that this callback will
3013 * be called after all data has been transferred with the total number of bytes
3014 * copied during the operation.
3016 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
3017 * error is returned, independent on the status of the @destination.
3019 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
3020 * error G_IO_ERROR_EXISTS is returned.
3022 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
3023 * error is returned. If trying to overwrite a directory with a directory the
3024 * G_IO_ERROR_WOULD_MERGE error is returned.
3026 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
3027 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
3030 * If you are interested in copying the #GFile object itself (not the on-disk
3031 * file), see g_file_dup().
3033 * Returns: %TRUE on success, %FALSE otherwise.
3036 g_file_copy (GFile *source,
3038 GFileCopyFlags flags,
3039 GCancellable *cancellable,
3040 GFileProgressCallback progress_callback,
3041 gpointer progress_callback_data,
3048 g_return_val_if_fail (G_IS_FILE (source), FALSE);
3049 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3051 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3054 iface = G_FILE_GET_IFACE (destination);
3058 res = (* iface->copy) (source, destination,
3060 progress_callback, progress_callback_data,
3066 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3068 g_propagate_error (error, my_error);
3072 g_clear_error (&my_error);
3075 /* If the types are different, and the destination method failed
3076 also try the source method */
3077 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3079 iface = G_FILE_GET_IFACE (source);
3084 res = (* iface->copy) (source, destination,
3086 progress_callback, progress_callback_data,
3092 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3094 g_propagate_error (error, my_error);
3098 g_clear_error (&my_error);
3102 return file_copy_fallback (source, destination, flags, cancellable,
3103 progress_callback, progress_callback_data,
3108 * g_file_copy_async: (skip)
3109 * @source: input #GFile.
3110 * @destination: destination #GFile
3111 * @flags: set of #GFileCopyFlags
3112 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3114 * @cancellable: optional #GCancellable object, %NULL to ignore.
3115 * @progress_callback: function to callback with progress information
3116 * @progress_callback_data: user data to pass to @progress_callback
3117 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3118 * @user_data: the data to pass to callback function
3120 * Copies the file @source to the location specified by @destination
3121 * asynchronously. For details of the behaviour, see g_file_copy().
3123 * If @progress_callback is not %NULL, then that function that will be called
3124 * just like in g_file_copy(), however the callback will run in the main loop,
3125 * not in the thread that is doing the I/O operation.
3127 * When the operation is finished, @callback will be called. You can then call
3128 * g_file_copy_finish() to get the result of the operation.
3131 g_file_copy_async (GFile *source,
3133 GFileCopyFlags flags,
3135 GCancellable *cancellable,
3136 GFileProgressCallback progress_callback,
3137 gpointer progress_callback_data,
3138 GAsyncReadyCallback callback,
3143 g_return_if_fail (G_IS_FILE (source));
3144 g_return_if_fail (G_IS_FILE (destination));
3146 iface = G_FILE_GET_IFACE (source);
3147 (* iface->copy_async) (source,
3153 progress_callback_data,
3159 * g_file_copy_finish:
3160 * @file: input #GFile.
3161 * @res: a #GAsyncResult.
3162 * @error: a #GError, or %NULL
3164 * Finishes copying the file started with
3165 * g_file_copy_async().
3167 * Returns: a %TRUE on success, %FALSE on error.
3170 g_file_copy_finish (GFile *file,
3176 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3177 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
3179 if (G_IS_SIMPLE_ASYNC_RESULT (res))
3181 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3183 if (g_simple_async_result_propagate_error (simple, error))
3187 iface = G_FILE_GET_IFACE (file);
3188 return (* iface->copy_finish) (file, res, error);
3193 * @source: #GFile pointing to the source location.
3194 * @destination: #GFile pointing to the destination location.
3195 * @flags: set of #GFileCopyFlags.
3196 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3197 * @progress_callback: (scope call): #GFileProgressCallback function for updates.
3198 * @progress_callback_data: (closure): gpointer to user data for the callback function.
3199 * @error: #GError for returning error conditions, or %NULL
3202 * Tries to move the file or directory @source to the location specified by @destination.
3203 * If native move operations are supported then this is used, otherwise a copy + delete
3204 * fallback is used. The native implementation may support moving directories (for instance
3205 * on moves inside the same filesystem), but the fallback code does not.
3207 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3208 * existing @destination file is overwritten.
3210 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3211 * will be copied as symlinks, otherwise the target of the
3212 * @source symlink will be copied.
3214 * If @cancellable is not %NULL, then the operation can be cancelled by
3215 * triggering the cancellable object from another thread. If the operation
3216 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3218 * If @progress_callback is not %NULL, then the operation can be monitored by
3219 * setting this to a #GFileProgressCallback function. @progress_callback_data
3220 * will be passed to this function. It is guaranteed that this callback will
3221 * be called after all data has been transferred with the total number of bytes
3222 * copied during the operation.
3224 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
3225 * error is returned, independent on the status of the @destination.
3227 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
3228 * error G_IO_ERROR_EXISTS is returned.
3230 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
3231 * error is returned. If trying to overwrite a directory with a directory the
3232 * G_IO_ERROR_WOULD_MERGE error is returned.
3234 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
3235 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
3236 * may be returned (if the native move operation isn't available).
3238 * Returns: %TRUE on successful move, %FALSE otherwise.
3241 g_file_move (GFile *source,
3243 GFileCopyFlags flags,
3244 GCancellable *cancellable,
3245 GFileProgressCallback progress_callback,
3246 gpointer progress_callback_data,
3253 g_return_val_if_fail (G_IS_FILE (source), FALSE);
3254 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3256 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3259 iface = G_FILE_GET_IFACE (destination);
3263 res = (* iface->move) (source, destination,
3265 progress_callback, progress_callback_data,
3271 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3273 g_propagate_error (error, my_error);
3278 /* If the types are different, and the destination method failed
3279 also try the source method */
3280 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3282 iface = G_FILE_GET_IFACE (source);
3287 res = (* iface->move) (source, destination,
3289 progress_callback, progress_callback_data,
3295 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3297 g_propagate_error (error, my_error);
3303 if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
3305 g_set_error_literal (error, G_IO_ERROR,
3306 G_IO_ERROR_NOT_SUPPORTED,
3307 _("Operation not supported"));
3311 flags |= G_FILE_COPY_ALL_METADATA;
3312 if (!g_file_copy (source, destination, flags, cancellable,
3313 progress_callback, progress_callback_data,
3317 return g_file_delete (source, cancellable, error);
3321 * g_file_make_directory
3322 * @file: input #GFile.
3323 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3324 * @error: a #GError, or %NULL
3326 * Creates a directory. Note that this will only create a child directory of
3327 * the immediate parent directory of the path or URI given by the #GFile. To
3328 * recursively create directories, see g_file_make_directory_with_parents().
3329 * This function will fail if the parent directory does not exist, setting
3330 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating
3331 * directories, this function will fail, setting @error to
3332 * %G_IO_ERROR_NOT_SUPPORTED.
3334 * For a local #GFile the newly created directory will have the default
3335 * (current) ownership and permissions of the current process.
3337 * If @cancellable is not %NULL, then the operation can be cancelled by
3338 * triggering the cancellable object from another thread. If the operation
3339 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3341 * Returns: %TRUE on successful creation, %FALSE otherwise.
3344 g_file_make_directory (GFile *file,
3345 GCancellable *cancellable,
3350 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3352 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3355 iface = G_FILE_GET_IFACE (file);
3357 if (iface->make_directory == NULL)
3359 g_set_error_literal (error, G_IO_ERROR,
3360 G_IO_ERROR_NOT_SUPPORTED,
3361 _("Operation not supported"));
3365 return (* iface->make_directory) (file, cancellable, error);
3369 * g_file_make_directory_with_parents:
3370 * @file: input #GFile.
3371 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3372 * @error: a #GError, or %NULL
3374 * Creates a directory and any parent directories that may not exist similar to
3375 * 'mkdir -p'. If the file system does not support creating directories, this
3376 * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED.
3378 * For a local #GFile the newly created directories will have the default
3379 * (current) ownership and permissions of the current process.
3381 * If @cancellable is not %NULL, then the operation can be cancelled by
3382 * triggering the cancellable object from another thread. If the operation
3383 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3385 * Returns: %TRUE if all directories have been successfully created, %FALSE
3391 g_file_make_directory_with_parents (GFile *file,
3392 GCancellable *cancellable,
3396 GFile *parent_file, *work_file;
3397 GList *list = NULL, *l;
3398 GError *my_error = NULL;
3400 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3403 result = g_file_make_directory (file, cancellable, &my_error);
3404 if (result || my_error->code != G_IO_ERROR_NOT_FOUND)
3407 g_propagate_error (error, my_error);
3413 while (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
3415 g_clear_error (&my_error);
3417 parent_file = g_file_get_parent (work_file);
3418 if (parent_file == NULL)
3420 result = g_file_make_directory (parent_file, cancellable, &my_error);
3422 if (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
3423 list = g_list_prepend (list, parent_file);
3425 work_file = parent_file;
3428 for (l = list; result && l; l = l->next)
3430 result = g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
3434 while (list != NULL)
3436 g_object_unref ((GFile *) list->data);
3437 list = g_list_remove (list, list->data);
3442 g_propagate_error (error, my_error);
3446 return g_file_make_directory (file, cancellable, error);
3450 * g_file_make_symbolic_link:
3451 * @file: a #GFile with the name of the symlink to create
3452 * @symlink_value: a string with the path for the target of the new symlink
3453 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3454 * @error: a #GError.
3456 * Creates a symbolic link named @file which contains the string
3459 * If @cancellable is not %NULL, then the operation can be cancelled by
3460 * triggering the cancellable object from another thread. If the operation
3461 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3463 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3466 g_file_make_symbolic_link (GFile *file,
3467 const char *symlink_value,
3468 GCancellable *cancellable,
3473 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3474 g_return_val_if_fail (symlink_value != NULL, FALSE);
3476 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3479 if (*symlink_value == '\0')
3481 g_set_error_literal (error, G_IO_ERROR,
3482 G_IO_ERROR_INVALID_ARGUMENT,
3483 _("Invalid symlink value given"));
3487 iface = G_FILE_GET_IFACE (file);
3489 if (iface->make_symbolic_link == NULL)
3491 g_set_error_literal (error, G_IO_ERROR,
3492 G_IO_ERROR_NOT_SUPPORTED,
3493 _("Operation not supported"));
3497 return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
3502 * @file: input #GFile.
3503 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3504 * @error: a #GError, or %NULL
3506 * Deletes a file. If the @file is a directory, it will only be deleted if it
3509 * If @cancellable is not %NULL, then the operation can be cancelled by
3510 * triggering the cancellable object from another thread. If the operation
3511 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3513 * Virtual: delete_file
3514 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3517 g_file_delete (GFile *file,
3518 GCancellable *cancellable,
3523 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3525 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3528 iface = G_FILE_GET_IFACE (file);
3530 if (iface->delete_file == NULL)
3532 g_set_error_literal (error, G_IO_ERROR,
3533 G_IO_ERROR_NOT_SUPPORTED,
3534 _("Operation not supported"));
3538 return (* iface->delete_file) (file, cancellable, error);
3543 * @file: #GFile to send to trash.
3544 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3545 * @error: a #GError, or %NULL
3547 * Sends @file to the "Trashcan", if possible. This is similar to
3548 * deleting it, but the user can recover it before emptying the trashcan.
3549 * Not all file systems support trashing, so this call can return the
3550 * %G_IO_ERROR_NOT_SUPPORTED error.
3553 * If @cancellable is not %NULL, then the operation can be cancelled by
3554 * triggering the cancellable object from another thread. If the operation
3555 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3557 * Returns: %TRUE on successful trash, %FALSE otherwise.
3560 g_file_trash (GFile *file,
3561 GCancellable *cancellable,
3566 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3568 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3571 iface = G_FILE_GET_IFACE (file);
3573 if (iface->trash == NULL)
3575 g_set_error_literal (error,
3576 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3577 _("Trash not supported"));
3581 return (* iface->trash) (file, cancellable, error);
3585 * g_file_set_display_name:
3586 * @file: input #GFile.
3587 * @display_name: a string.
3588 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3589 * @error: a #GError, or %NULL
3591 * Renames @file to the specified display name.
3593 * The display name is converted from UTF8 to the correct encoding for the target
3594 * filesystem if possible and the @file is renamed to this.
3596 * If you want to implement a rename operation in the user interface the edit name
3597 * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
3598 * widget, and then the result after editing should be passed to g_file_set_display_name().
3600 * On success the resulting converted filename is returned.
3602 * If @cancellable is not %NULL, then the operation can be cancelled by
3603 * triggering the cancellable object from another thread. If the operation
3604 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3606 * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL
3607 * if there was an error.
3608 * Free the returned object with g_object_unref().
3611 g_file_set_display_name (GFile *file,
3612 const char *display_name,
3613 GCancellable *cancellable,
3618 g_return_val_if_fail (G_IS_FILE (file), NULL);
3619 g_return_val_if_fail (display_name != NULL, NULL);
3621 if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
3625 G_IO_ERROR_INVALID_ARGUMENT,
3626 _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
3630 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3633 iface = G_FILE_GET_IFACE (file);
3635 return (* iface->set_display_name) (file, display_name, cancellable, error);
3639 * g_file_set_display_name_async:
3640 * @file: input #GFile.
3641 * @display_name: a string.
3642 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3644 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3645 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3646 * @user_data: (closure): the data to pass to callback function
3648 * Asynchronously sets the display name for a given #GFile.
3650 * For more details, see g_file_set_display_name() which is
3651 * the synchronous version of this call.
3653 * When the operation is finished, @callback will be called. You can then call
3654 * g_file_set_display_name_finish() to get the result of the operation.
3657 g_file_set_display_name_async (GFile *file,
3658 const char *display_name,
3660 GCancellable *cancellable,
3661 GAsyncReadyCallback callback,
3666 g_return_if_fail (G_IS_FILE (file));
3667 g_return_if_fail (display_name != NULL);
3669 iface = G_FILE_GET_IFACE (file);
3670 (* iface->set_display_name_async) (file,
3679 * g_file_set_display_name_finish:
3680 * @file: input #GFile.
3681 * @res: a #GAsyncResult.
3682 * @error: a #GError, or %NULL
3684 * Finishes setting a display name started with
3685 * g_file_set_display_name_async().
3687 * Returns: (transfer full): a #GFile or %NULL on error.
3688 * Free the returned object with g_object_unref().
3691 g_file_set_display_name_finish (GFile *file,
3697 g_return_val_if_fail (G_IS_FILE (file), NULL);
3698 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3700 if (G_IS_SIMPLE_ASYNC_RESULT (res))
3702 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
3703 if (g_simple_async_result_propagate_error (simple, error))
3707 iface = G_FILE_GET_IFACE (file);
3708 return (* iface->set_display_name_finish) (file, res, error);
3712 * g_file_query_settable_attributes:
3713 * @file: input #GFile.
3714 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3715 * @error: a #GError, or %NULL
3717 * Obtain the list of settable attributes for the file.
3719 * Returns the type and full attribute name of all the attributes
3720 * that can be set on this file. This doesn't mean setting it will always
3721 * succeed though, you might get an access failure, or some specific
3722 * file may not support a specific attribute.
3724 * If @cancellable is not %NULL, then the operation can be cancelled by
3725 * triggering the cancellable object from another thread. If the operation
3726 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3728 * Returns: a #GFileAttributeInfoList describing the settable attributes.
3729 * When you are done with it, release it with g_file_attribute_info_list_unref()
3731 GFileAttributeInfoList *
3732 g_file_query_settable_attributes (GFile *file,
3733 GCancellable *cancellable,
3738 GFileAttributeInfoList *list;
3740 g_return_val_if_fail (G_IS_FILE (file), NULL);
3742 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3745 iface = G_FILE_GET_IFACE (file);
3747 if (iface->query_settable_attributes == NULL)
3748 return g_file_attribute_info_list_new ();
3751 list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3755 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3757 list = g_file_attribute_info_list_new ();
3758 g_error_free (my_error);
3761 g_propagate_error (error, my_error);
3768 * g_file_query_writable_namespaces:
3769 * @file: input #GFile.
3770 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3771 * @error: a #GError, or %NULL
3773 * Obtain the list of attribute namespaces where new attributes
3774 * can be created by a user. An example of this is extended
3775 * attributes (in the "xattr" namespace).
3777 * If @cancellable is not %NULL, then the operation can be cancelled by
3778 * triggering the cancellable object from another thread. If the operation
3779 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3781 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
3782 * When you are done with it, release it with g_file_attribute_info_list_unref()
3784 GFileAttributeInfoList *
3785 g_file_query_writable_namespaces (GFile *file,
3786 GCancellable *cancellable,
3791 GFileAttributeInfoList *list;
3793 g_return_val_if_fail (G_IS_FILE (file), NULL);
3795 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3798 iface = G_FILE_GET_IFACE (file);
3800 if (iface->query_writable_namespaces == NULL)
3801 return g_file_attribute_info_list_new ();
3804 list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
3808 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3810 list = g_file_attribute_info_list_new ();
3811 g_error_free (my_error);
3814 g_propagate_error (error, my_error);
3821 * g_file_set_attribute:
3822 * @file: input #GFile.
3823 * @attribute: a string containing the attribute's name.
3824 * @type: The type of the attribute
3825 * @value_p: a pointer to the value (or the pointer itself if the type is a pointer type)
3826 * @flags: a set of #GFileQueryInfoFlags.
3827 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3828 * @error: a #GError, or %NULL
3830 * Sets an attribute in the file with attribute name @attribute to @value.
3832 * Some attributes can be unset by setting @attribute to
3833 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value to %NULL.
3835 * If @cancellable is not %NULL, then the operation can be cancelled by
3836 * triggering the cancellable object from another thread. If the operation
3837 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3839 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3842 g_file_set_attribute (GFile *file,
3843 const char *attribute,
3844 GFileAttributeType type,
3846 GFileQueryInfoFlags flags,
3847 GCancellable *cancellable,
3852 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3853 g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
3855 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3858 iface = G_FILE_GET_IFACE (file);
3860 if (iface->set_attribute == NULL)
3862 g_set_error_literal (error, G_IO_ERROR,
3863 G_IO_ERROR_NOT_SUPPORTED,
3864 _("Operation not supported"));
3868 return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
3872 * g_file_set_attributes_from_info:
3873 * @file: input #GFile.
3874 * @info: a #GFileInfo.
3875 * @flags: #GFileQueryInfoFlags
3876 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3877 * @error: a #GError, or %NULL
3879 * Tries to set all attributes in the #GFileInfo on the target values,
3880 * not stopping on the first error.
3882 * If there is any error during this operation then @error will be set to
3883 * the first error. Error on particular fields are flagged by setting
3884 * the "status" field in the attribute value to
3885 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
3888 * If @cancellable is not %NULL, then the operation can be cancelled by
3889 * triggering the cancellable object from another thread. If the operation
3890 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3892 * Returns: %TRUE if there was any error, %FALSE otherwise.
3895 g_file_set_attributes_from_info (GFile *file,
3897 GFileQueryInfoFlags flags,
3898 GCancellable *cancellable,
3903 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3904 g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
3906 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3909 g_file_info_clear_status (info);
3911 iface = G_FILE_GET_IFACE (file);
3913 return (* iface->set_attributes_from_info) (file,
3922 g_file_real_set_attributes_from_info (GFile *file,
3924 GFileQueryInfoFlags flags,
3925 GCancellable *cancellable,
3931 GFileAttributeValue *value;
3935 attributes = g_file_info_list_attributes (info, NULL);
3937 for (i = 0; attributes[i] != NULL; i++)
3939 value = _g_file_info_get_attribute_value (info, attributes[i]);
3941 if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
3944 if (!g_file_set_attribute (file, attributes[i],
3945 value->type, _g_file_attribute_value_peek_as_pointer (value),
3946 flags, cancellable, error))
3948 value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3950 /* Don't set error multiple times */
3954 value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3957 g_strfreev (attributes);
3963 * g_file_set_attributes_async:
3964 * @file: input #GFile.
3965 * @info: a #GFileInfo.
3966 * @flags: a #GFileQueryInfoFlags.
3967 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3969 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3970 * @callback: (scope async): a #GAsyncReadyCallback.
3971 * @user_data: (closure): a #gpointer.
3973 * Asynchronously sets the attributes of @file with @info.
3975 * For more details, see g_file_set_attributes_from_info() which is
3976 * the synchronous version of this call.
3978 * When the operation is finished, @callback will be called. You can then call
3979 * g_file_set_attributes_finish() to get the result of the operation.
3982 g_file_set_attributes_async (GFile *file,
3984 GFileQueryInfoFlags flags,
3986 GCancellable *cancellable,
3987 GAsyncReadyCallback callback,
3992 g_return_if_fail (G_IS_FILE (file));
3993 g_return_if_fail (G_IS_FILE_INFO (info));
3995 iface = G_FILE_GET_IFACE (file);
3996 (* iface->set_attributes_async) (file,
4006 * g_file_set_attributes_finish:
4007 * @file: input #GFile.
4008 * @result: a #GAsyncResult.
4009 * @info: (out) (transfer full): a #GFileInfo.
4010 * @error: a #GError, or %NULL
4012 * Finishes setting an attribute started in g_file_set_attributes_async().
4014 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4017 g_file_set_attributes_finish (GFile *file,
4018 GAsyncResult *result,
4024 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4025 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4027 /* No standard handling of errors here, as we must set info even
4030 iface = G_FILE_GET_IFACE (file);
4031 return (* iface->set_attributes_finish) (file, result, info, error);
4035 * g_file_set_attribute_string:
4036 * @file: input #GFile.
4037 * @attribute: a string containing the attribute's name.
4038 * @value: a string containing the attribute's value.
4039 * @flags: #GFileQueryInfoFlags.
4040 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4041 * @error: a #GError, or %NULL
4043 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4044 * If @attribute is of a different type, this operation will fail.
4046 * If @cancellable is not %NULL, then the operation can be cancelled by
4047 * triggering the cancellable object from another thread. If the operation
4048 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4050 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4053 g_file_set_attribute_string (GFile *file,
4054 const char *attribute,
4056 GFileQueryInfoFlags flags,
4057 GCancellable *cancellable,
4060 return g_file_set_attribute (file, attribute,
4061 G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
4062 flags, cancellable, error);
4066 * g_file_set_attribute_byte_string:
4067 * @file: input #GFile.
4068 * @attribute: a string containing the attribute's name.
4069 * @value: a string containing the attribute's new value.
4070 * @flags: a #GFileQueryInfoFlags.
4071 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4072 * @error: a #GError, or %NULL
4074 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4075 * If @attribute is of a different type, this operation will fail,
4078 * If @cancellable is not %NULL, then the operation can be cancelled by
4079 * triggering the cancellable object from another thread. If the operation
4080 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4082 * Returns: %TRUE if the @attribute was successfully set to @value
4083 * in the @file, %FALSE otherwise.
4086 g_file_set_attribute_byte_string (GFile *file,
4087 const char *attribute,
4089 GFileQueryInfoFlags flags,
4090 GCancellable *cancellable,
4093 return g_file_set_attribute (file, attribute,
4094 G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
4095 flags, cancellable, error);
4099 * g_file_set_attribute_uint32:
4100 * @file: input #GFile.
4101 * @attribute: a string containing the attribute's name.
4102 * @value: a #guint32 containing the attribute's new value.
4103 * @flags: a #GFileQueryInfoFlags.
4104 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4105 * @error: a #GError, or %NULL
4107 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4108 * If @attribute is of a different type, this operation will fail.
4110 * If @cancellable is not %NULL, then the operation can be cancelled by
4111 * triggering the cancellable object from another thread. If the operation
4112 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4114 * Returns: %TRUE if the @attribute was successfully set to @value
4115 * in the @file, %FALSE otherwise.
4118 g_file_set_attribute_uint32 (GFile *file,
4119 const char *attribute,
4121 GFileQueryInfoFlags flags,
4122 GCancellable *cancellable,
4125 return g_file_set_attribute (file, attribute,
4126 G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
4127 flags, cancellable, error);
4131 * g_file_set_attribute_int32:
4132 * @file: input #GFile.
4133 * @attribute: a string containing the attribute's name.
4134 * @value: a #gint32 containing the attribute's new value.
4135 * @flags: a #GFileQueryInfoFlags.
4136 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4137 * @error: a #GError, or %NULL
4139 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4140 * If @attribute is of a different type, this operation will fail.
4142 * If @cancellable is not %NULL, then the operation can be cancelled by
4143 * triggering the cancellable object from another thread. If the operation
4144 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4146 * Returns: %TRUE if the @attribute was successfully set to @value
4147 * in the @file, %FALSE otherwise.
4150 g_file_set_attribute_int32 (GFile *file,
4151 const char *attribute,
4153 GFileQueryInfoFlags flags,
4154 GCancellable *cancellable,
4157 return g_file_set_attribute (file, attribute,
4158 G_FILE_ATTRIBUTE_TYPE_INT32, &value,
4159 flags, cancellable, error);
4163 * g_file_set_attribute_uint64:
4164 * @file: input #GFile.
4165 * @attribute: a string containing the attribute's name.
4166 * @value: a #guint64 containing the attribute's new value.
4167 * @flags: a #GFileQueryInfoFlags.
4168 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4169 * @error: a #GError, or %NULL
4171 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4172 * If @attribute is of a different type, this operation will fail.
4174 * If @cancellable is not %NULL, then the operation can be cancelled by
4175 * triggering the cancellable object from another thread. If the operation
4176 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4178 * Returns: %TRUE if the @attribute was successfully set to @value
4179 * in the @file, %FALSE otherwise.
4182 g_file_set_attribute_uint64 (GFile *file,
4183 const char *attribute,
4185 GFileQueryInfoFlags flags,
4186 GCancellable *cancellable,
4189 return g_file_set_attribute (file, attribute,
4190 G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
4191 flags, cancellable, error);
4195 * g_file_set_attribute_int64:
4196 * @file: input #GFile.
4197 * @attribute: a string containing the attribute's name.
4198 * @value: a #guint64 containing the attribute's new value.
4199 * @flags: a #GFileQueryInfoFlags.
4200 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4201 * @error: a #GError, or %NULL
4203 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4204 * If @attribute is of a different type, this operation will fail.
4206 * If @cancellable is not %NULL, then the operation can be cancelled by
4207 * triggering the cancellable object from another thread. If the operation
4208 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4210 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4213 g_file_set_attribute_int64 (GFile *file,
4214 const char *attribute,
4216 GFileQueryInfoFlags flags,
4217 GCancellable *cancellable,
4220 return g_file_set_attribute (file, attribute,
4221 G_FILE_ATTRIBUTE_TYPE_INT64, &value,
4222 flags, cancellable, error);
4226 * g_file_mount_mountable:
4227 * @file: input #GFile.
4228 * @flags: flags affecting the operation
4229 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
4230 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4231 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4232 * @user_data: (closure): the data to pass to callback function
4234 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4235 * Using @mount_operation, you can request callbacks when, for instance,
4236 * passwords are needed during authentication.
4238 * If @cancellable is not %NULL, then the operation can be cancelled by
4239 * triggering the cancellable object from another thread. If the operation
4240 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4242 * When the operation is finished, @callback will be called. You can then call
4243 * g_file_mount_mountable_finish() to get the result of the operation.
4246 g_file_mount_mountable (GFile *file,
4247 GMountMountFlags flags,
4248 GMountOperation *mount_operation,
4249 GCancellable *cancellable,
4250 GAsyncReadyCallback callback,
4255 g_return_if_fail (G_IS_FILE (file));
4257 iface = G_FILE_GET_IFACE (file);
4259 if (iface->mount_mountable == NULL)
4261 g_simple_async_report_error_in_idle (G_OBJECT (file),
4265 G_IO_ERROR_NOT_SUPPORTED,
4266 _("Operation not supported"));
4270 (* iface->mount_mountable) (file,
4279 * g_file_mount_mountable_finish:
4280 * @file: input #GFile.
4281 * @result: a #GAsyncResult.
4282 * @error: a #GError, or %NULL
4284 * Finishes a mount operation. See g_file_mount_mountable() for details.
4286 * Finish an asynchronous mount operation that was started
4287 * with g_file_mount_mountable().
4289 * Returns: (transfer full): a #GFile or %NULL on error.
4290 * Free the returned object with g_object_unref().
4293 g_file_mount_mountable_finish (GFile *file,
4294 GAsyncResult *result,
4299 g_return_val_if_fail (G_IS_FILE (file), NULL);
4300 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
4302 if (G_IS_SIMPLE_ASYNC_RESULT (result))
4304 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
4305 if (g_simple_async_result_propagate_error (simple, error))
4309 iface = G_FILE_GET_IFACE (file);
4310 return (* iface->mount_mountable_finish) (file, result, error);
4314 * g_file_unmount_mountable:
4315 * @file: input #GFile.
4316 * @flags: flags affecting the operation
4317 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4318 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4319 * @user_data: (closure): the data to pass to callback function
4321 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4323 * If @cancellable is not %NULL, then the operation can be cancelled by
4324 * triggering the cancellable object from another thread. If the operation
4325 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4327 * When the operation is finished, @callback will be called. You can then call
4328 * g_file_unmount_mountable_finish() to get the result of the operation.
4330 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4333 g_file_unmount_mountable (GFile *file,
4334 GMountUnmountFlags flags,
4335 GCancellable *cancellable,
4336 GAsyncReadyCallback callback,
4341 g_return_if_fail (G_IS_FILE (file));
4343 iface = G_FILE_GET_IFACE (file);
4345 if (iface->unmount_mountable == NULL)
4347 g_simple_async_report_error_in_idle (G_OBJECT (file),
4351 G_IO_ERROR_NOT_SUPPORTED,
4352 _("Operation not supported"));
4356 (* iface->unmount_mountable) (file,
4364 * g_file_unmount_mountable_finish:
4365 * @file: input #GFile.
4366 * @result: a #GAsyncResult.
4367 * @error: a #GError, or %NULL
4369 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4371 * Finish an asynchronous unmount operation that was started
4372 * with g_file_unmount_mountable().
4374 * Returns: %TRUE if the operation finished successfully. %FALSE
4377 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead.
4380 g_file_unmount_mountable_finish (GFile *file,
4381 GAsyncResult *result,
4386 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4387 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4389 if (G_IS_SIMPLE_ASYNC_RESULT (result))
4391 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
4392 if (g_simple_async_result_propagate_error (simple, error))
4396 iface = G_FILE_GET_IFACE (file);
4397 return (* iface->unmount_mountable_finish) (file, result, error);
4401 * g_file_unmount_mountable_with_operation:
4402 * @file: input #GFile.
4403 * @flags: flags affecting the operation
4404 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
4405 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4406 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4407 * @user_data: (closure): the data to pass to callback function
4409 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4411 * If @cancellable is not %NULL, then the operation can be cancelled by
4412 * triggering the cancellable object from another thread. If the operation
4413 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4415 * When the operation is finished, @callback will be called. You can then call
4416 * g_file_unmount_mountable_finish() to get the result of the operation.
4421 g_file_unmount_mountable_with_operation (GFile *file,
4422 GMountUnmountFlags flags,
4423 GMountOperation *mount_operation,
4424 GCancellable *cancellable,
4425 GAsyncReadyCallback callback,
4430 g_return_if_fail (G_IS_FILE (file));
4432 iface = G_FILE_GET_IFACE (file);
4434 if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL)
4436 g_simple_async_report_error_in_idle (G_OBJECT (file),
4440 G_IO_ERROR_NOT_SUPPORTED,
4441 _("Operation not supported"));
4445 if (iface->unmount_mountable_with_operation != NULL)
4446 (* iface->unmount_mountable_with_operation) (file,
4453 (* iface->unmount_mountable) (file,
4461 * g_file_unmount_mountable_with_operation_finish:
4462 * @file: input #GFile.
4463 * @result: a #GAsyncResult.
4464 * @error: a #GError, or %NULL
4466 * Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
4468 * Finish an asynchronous unmount operation that was started
4469 * with g_file_unmount_mountable_with_operation().
4471 * Returns: %TRUE if the operation finished successfully. %FALSE
4477 g_file_unmount_mountable_with_operation_finish (GFile *file,
4478 GAsyncResult *result,
4483 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4484 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4486 if (G_IS_SIMPLE_ASYNC_RESULT (result))
4488 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
4489 if (g_simple_async_result_propagate_error (simple, error))
4493 iface = G_FILE_GET_IFACE (file);
4494 if (iface->unmount_mountable_with_operation_finish != NULL)
4495 return (* iface->unmount_mountable_with_operation_finish) (file, result, error);
4497 return (* iface->unmount_mountable_finish) (file, result, error);
4501 * g_file_eject_mountable:
4502 * @file: input #GFile.
4503 * @flags: flags affecting the operation
4504 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4505 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4506 * @user_data: (closure): the data to pass to callback function
4508 * Starts an asynchronous eject on a mountable.
4509 * When this operation has completed, @callback will be called with
4510 * @user_user data, and the operation can be finalized with
4511 * g_file_eject_mountable_finish().
4513 * If @cancellable is not %NULL, then the operation can be cancelled by
4514 * triggering the cancellable object from another thread. If the operation
4515 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4517 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
4520 g_file_eject_mountable (GFile *file,
4521 GMountUnmountFlags flags,
4522 GCancellable *cancellable,
4523 GAsyncReadyCallback callback,
4528 g_return_if_fail (G_IS_FILE (file));
4530 iface = G_FILE_GET_IFACE (file);
4532 if (iface->eject_mountable == NULL)
4534 g_simple_async_report_error_in_idle (G_OBJECT (file),
4538 G_IO_ERROR_NOT_SUPPORTED,
4539 _("Operation not supported"));
4543 (* iface->eject_mountable) (file,
4551 * g_file_eject_mountable_finish:
4552 * @file: input #GFile.
4553 * @result: a #GAsyncResult.
4554 * @error: a #GError, or %NULL
4556 * Finishes an asynchronous eject operation started by
4557 * g_file_eject_mountable().
4559 * Returns: %TRUE if the @file was ejected successfully. %FALSE
4562 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead.
4565 g_file_eject_mountable_finish (GFile *file,
4566 GAsyncResult *result,
4571 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4572 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4574 if (G_IS_SIMPLE_ASYNC_RESULT (result))
4576 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
4577 if (g_simple_async_result_propagate_error (simple, error))
4581 iface = G_FILE_GET_IFACE (file);
4582 return (* iface->eject_mountable_finish) (file, result, error);
4586 * g_file_eject_mountable_with_operation:
4587 * @file: input #GFile.
4588 * @flags: flags affecting the operation
4589 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
4590 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4591 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4592 * @user_data: (closure): the data to pass to callback function
4594 * Starts an asynchronous eject on a mountable.
4595 * When this operation has completed, @callback will be called with
4596 * @user_user data, and the operation can be finalized with
4597 * g_file_eject_mountable_with_operation_finish().
4599 * If @cancellable is not %NULL, then the operation can be cancelled by
4600 * triggering the cancellable object from another thread. If the operation
4601 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4606 g_file_eject_mountable_with_operation (GFile *file,
4607 GMountUnmountFlags flags,
4608 GMountOperation *mount_operation,
4609 GCancellable *cancellable,
4610 GAsyncReadyCallback callback,
4615 g_return_if_fail (G_IS_FILE (file));
4617 iface = G_FILE_GET_IFACE (file);
4619 if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL)
4621 g_simple_async_report_error_in_idle (G_OBJECT (file),
4625 G_IO_ERROR_NOT_SUPPORTED,
4626 _("Operation not supported"));
4630 if (iface->eject_mountable_with_operation != NULL)
4631 (* iface->eject_mountable_with_operation) (file,
4638 (* iface->eject_mountable) (file,
4646 * g_file_eject_mountable_with_operation_finish:
4647 * @file: input #GFile.
4648 * @result: a #GAsyncResult.
4649 * @error: a #GError, or %NULL
4651 * Finishes an asynchronous eject operation started by
4652 * g_file_eject_mountable_with_operation().
4654 * Returns: %TRUE if the @file was ejected successfully. %FALSE
4660 g_file_eject_mountable_with_operation_finish (GFile *file,
4661 GAsyncResult *result,
4666 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4667 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4669 if (G_IS_SIMPLE_ASYNC_RESULT (result))
4671 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
4672 if (g_simple_async_result_propagate_error (simple, error))
4676 iface = G_FILE_GET_IFACE (file);
4677 if (iface->eject_mountable_with_operation_finish != NULL)
4678 return (* iface->eject_mountable_with_operation_finish) (file, result, error);
4680 return (* iface->eject_mountable_finish) (file, result, error);
4684 * g_file_monitor_directory:
4685 * @file: input #GFile.
4686 * @flags: a set of #GFileMonitorFlags.
4687 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4688 * @error: a #GError, or %NULL.
4690 * Obtains a directory monitor for the given file.
4691 * This may fail if directory monitoring is not supported.
4693 * If @cancellable is not %NULL, then the operation can be cancelled by
4694 * triggering the cancellable object from another thread. If the operation
4695 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4697 * Virtual: monitor_dir
4698 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4699 * Free the returned object with g_object_unref().
4702 g_file_monitor_directory (GFile *file,
4703 GFileMonitorFlags flags,
4704 GCancellable *cancellable,
4709 g_return_val_if_fail (G_IS_FILE (file), NULL);
4711 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4714 iface = G_FILE_GET_IFACE (file);
4716 if (iface->monitor_dir == NULL)
4718 g_set_error_literal (error, G_IO_ERROR,
4719 G_IO_ERROR_NOT_SUPPORTED,
4720 _("Operation not supported"));
4724 return (* iface->monitor_dir) (file, flags, cancellable, error);
4728 * g_file_monitor_file:
4729 * @file: input #GFile.
4730 * @flags: a set of #GFileMonitorFlags.
4731 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4732 * @error: a #GError, or %NULL.
4734 * Obtains a file monitor for the given file. If no file notification
4735 * mechanism exists, then regular polling of the file is used.
4737 * If @cancellable is not %NULL, then the operation can be cancelled by
4738 * triggering the cancellable object from another thread. If the operation
4739 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4741 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4742 * Free the returned object with g_object_unref().
4745 g_file_monitor_file (GFile *file,
4746 GFileMonitorFlags flags,
4747 GCancellable *cancellable,
4751 GFileMonitor *monitor;
4753 g_return_val_if_fail (G_IS_FILE (file), NULL);
4755 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4758 iface = G_FILE_GET_IFACE (file);
4762 if (iface->monitor_file)
4763 monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
4765 /* Fallback to polling */
4766 if (monitor == NULL)
4767 monitor = _g_poll_file_monitor_new (file);
4774 * @file: input #GFile
4775 * @flags: a set of #GFileMonitorFlags
4776 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
4777 * @error: a #GError, or %NULL
4779 * Obtains a file or directory monitor for the given file, depending
4780 * on the type of the file.
4782 * If @cancellable is not %NULL, then the operation can be cancelled by
4783 * triggering the cancellable object from another thread. If the operation
4784 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4786 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4787 * Free the returned object with g_object_unref().
4792 g_file_monitor (GFile *file,
4793 GFileMonitorFlags flags,
4794 GCancellable *cancellable,
4797 if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
4798 return g_file_monitor_directory (file, flags, cancellable, error);
4800 return g_file_monitor_file (file, flags, cancellable, error);
4803 /********************************************
4804 * Default implementation of async ops *
4805 ********************************************/
4809 GFileQueryInfoFlags flags;
4811 } QueryInfoAsyncData;
4814 query_info_data_free (QueryInfoAsyncData *data)
4817 g_object_unref (data->info);
4818 g_free (data->attributes);
4823 query_info_async_thread (GSimpleAsyncResult *res,
4825 GCancellable *cancellable)
4827 GError *error = NULL;
4828 QueryInfoAsyncData *data;
4831 data = g_simple_async_result_get_op_res_gpointer (res);
4833 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4836 g_simple_async_result_take_error (res, error);
4842 g_file_real_query_info_async (GFile *file,
4843 const char *attributes,
4844 GFileQueryInfoFlags flags,
4846 GCancellable *cancellable,
4847 GAsyncReadyCallback callback,
4850 GSimpleAsyncResult *res;
4851 QueryInfoAsyncData *data;
4853 data = g_new0 (QueryInfoAsyncData, 1);
4854 data->attributes = g_strdup (attributes);
4855 data->flags = flags;
4857 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
4858 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
4860 g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
4861 g_object_unref (res);
4865 g_file_real_query_info_finish (GFile *file,
4869 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4870 QueryInfoAsyncData *data;
4872 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
4874 data = g_simple_async_result_get_op_res_gpointer (simple);
4876 return g_object_ref (data->info);
4884 } QueryFilesystemInfoAsyncData;
4887 query_filesystem_info_data_free (QueryFilesystemInfoAsyncData *data)
4890 g_object_unref (data->info);
4891 g_free (data->attributes);
4896 query_filesystem_info_async_thread (GSimpleAsyncResult *res,
4898 GCancellable *cancellable)
4900 GError *error = NULL;
4901 QueryFilesystemInfoAsyncData *data;
4904 data = g_simple_async_result_get_op_res_gpointer (res);
4906 info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error);
4909 g_simple_async_result_take_error (res, error);
4915 g_file_real_query_filesystem_info_async (GFile *file,
4916 const char *attributes,
4918 GCancellable *cancellable,
4919 GAsyncReadyCallback callback,
4922 GSimpleAsyncResult *res;
4923 QueryFilesystemInfoAsyncData *data;
4925 data = g_new0 (QueryFilesystemInfoAsyncData, 1);
4926 data->attributes = g_strdup (attributes);
4928 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async);
4929 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free);
4931 g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable);
4932 g_object_unref (res);
4936 g_file_real_query_filesystem_info_finish (GFile *file,
4940 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4941 QueryFilesystemInfoAsyncData *data;
4943 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_filesystem_info_async);
4945 data = g_simple_async_result_get_op_res_gpointer (simple);
4947 return g_object_ref (data->info);
4954 GFileQueryInfoFlags flags;
4955 GFileEnumerator *enumerator;
4956 } EnumerateChildrenAsyncData;
4959 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
4961 if (data->enumerator)
4962 g_object_unref (data->enumerator);
4963 g_free (data->attributes);
4968 enumerate_children_async_thread (GSimpleAsyncResult *res,
4970 GCancellable *cancellable)
4972 GError *error = NULL;
4973 EnumerateChildrenAsyncData *data;
4974 GFileEnumerator *enumerator;
4976 data = g_simple_async_result_get_op_res_gpointer (res);
4978 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4980 if (enumerator == NULL)
4981 g_simple_async_result_take_error (res, error);
4983 data->enumerator = enumerator;
4987 g_file_real_enumerate_children_async (GFile *file,
4988 const char *attributes,
4989 GFileQueryInfoFlags flags,
4991 GCancellable *cancellable,
4992 GAsyncReadyCallback callback,
4995 GSimpleAsyncResult *res;
4996 EnumerateChildrenAsyncData *data;
4998 data = g_new0 (EnumerateChildrenAsyncData, 1);
4999 data->attributes = g_strdup (attributes);
5000 data->flags = flags;
5002 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
5003 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
5005 g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
5006 g_object_unref (res);
5009 static GFileEnumerator *
5010 g_file_real_enumerate_children_finish (GFile *file,
5014 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5015 EnumerateChildrenAsyncData *data;
5017 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
5019 data = g_simple_async_result_get_op_res_gpointer (simple);
5020 if (data->enumerator)
5021 return g_object_ref (data->enumerator);
5027 open_read_async_thread (GSimpleAsyncResult *res,
5029 GCancellable *cancellable)
5032 GFileInputStream *stream;
5033 GError *error = NULL;
5035 iface = G_FILE_GET_IFACE (object);
5037 if (iface->read_fn == NULL)
5039 g_set_error_literal (&error, G_IO_ERROR,
5040 G_IO_ERROR_NOT_SUPPORTED,
5041 _("Operation not supported"));
5043 g_simple_async_result_take_error (res, error);
5048 stream = iface->read_fn (G_FILE (object), cancellable, &error);
5051 g_simple_async_result_take_error (res, error);
5053 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5057 g_file_real_read_async (GFile *file,
5059 GCancellable *cancellable,
5060 GAsyncReadyCallback callback,
5063 GSimpleAsyncResult *res;
5065 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
5067 g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
5068 g_object_unref (res);
5071 static GFileInputStream *
5072 g_file_real_read_finish (GFile *file,
5076 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5079 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
5081 op = g_simple_async_result_get_op_res_gpointer (simple);
5083 return g_object_ref (op);
5089 append_to_async_thread (GSimpleAsyncResult *res,
5091 GCancellable *cancellable)
5094 GFileCreateFlags *data;
5095 GFileOutputStream *stream;
5096 GError *error = NULL;
5098 iface = G_FILE_GET_IFACE (object);
5100 data = g_simple_async_result_get_op_res_gpointer (res);
5102 stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
5105 g_simple_async_result_take_error (res, error);
5107 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5111 g_file_real_append_to_async (GFile *file,
5112 GFileCreateFlags flags,
5114 GCancellable *cancellable,
5115 GAsyncReadyCallback callback,
5118 GFileCreateFlags *data;
5119 GSimpleAsyncResult *res;
5121 data = g_new0 (GFileCreateFlags, 1);
5124 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
5125 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5127 g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
5128 g_object_unref (res);
5131 static GFileOutputStream *
5132 g_file_real_append_to_finish (GFile *file,
5136 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5139 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
5141 op = g_simple_async_result_get_op_res_gpointer (simple);
5143 return g_object_ref (op);
5149 create_async_thread (GSimpleAsyncResult *res,
5151 GCancellable *cancellable)
5154 GFileCreateFlags *data;
5155 GFileOutputStream *stream;
5156 GError *error = NULL;
5158 iface = G_FILE_GET_IFACE (object);
5160 data = g_simple_async_result_get_op_res_gpointer (res);
5162 stream = iface->create (G_FILE (object), *data, cancellable, &error);
5165 g_simple_async_result_take_error (res, error);
5167 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5171 g_file_real_create_async (GFile *file,
5172 GFileCreateFlags flags,
5174 GCancellable *cancellable,
5175 GAsyncReadyCallback callback,
5178 GFileCreateFlags *data;
5179 GSimpleAsyncResult *res;
5181 data = g_new0 (GFileCreateFlags, 1);
5184 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
5185 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5187 g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
5188 g_object_unref (res);
5191 static GFileOutputStream *
5192 g_file_real_create_finish (GFile *file,
5196 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5199 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
5201 op = g_simple_async_result_get_op_res_gpointer (simple);
5203 return g_object_ref (op);
5209 GFileOutputStream *stream;
5211 gboolean make_backup;
5212 GFileCreateFlags flags;
5216 replace_async_data_free (ReplaceAsyncData *data)
5219 g_object_unref (data->stream);
5220 g_free (data->etag);
5225 replace_async_thread (GSimpleAsyncResult *res,
5227 GCancellable *cancellable)
5230 GFileOutputStream *stream;
5231 GError *error = NULL;
5232 ReplaceAsyncData *data;
5234 iface = G_FILE_GET_IFACE (object);
5236 data = g_simple_async_result_get_op_res_gpointer (res);
5238 stream = iface->replace (G_FILE (object),
5246 g_simple_async_result_take_error (res, error);
5248 data->stream = stream;
5252 g_file_real_replace_async (GFile *file,
5254 gboolean make_backup,
5255 GFileCreateFlags flags,
5257 GCancellable *cancellable,
5258 GAsyncReadyCallback callback,
5261 GSimpleAsyncResult *res;
5262 ReplaceAsyncData *data;
5264 data = g_new0 (ReplaceAsyncData, 1);
5265 data->etag = g_strdup (etag);
5266 data->make_backup = make_backup;
5267 data->flags = flags;
5269 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
5270 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
5272 g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
5273 g_object_unref (res);
5276 static GFileOutputStream *
5277 g_file_real_replace_finish (GFile *file,
5281 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5282 ReplaceAsyncData *data;
5284 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
5286 data = g_simple_async_result_get_op_res_gpointer (simple);
5288 return g_object_ref (data->stream);
5294 open_readwrite_async_thread (GSimpleAsyncResult *res,
5296 GCancellable *cancellable)
5299 GFileIOStream *stream;
5300 GError *error = NULL;
5302 iface = G_FILE_GET_IFACE (object);
5304 if (iface->open_readwrite == NULL)
5306 g_set_error_literal (&error, G_IO_ERROR,
5307 G_IO_ERROR_NOT_SUPPORTED,
5308 _("Operation not supported"));
5310 g_simple_async_result_take_error (res, error);
5315 stream = iface->open_readwrite (G_FILE (object), cancellable, &error);
5318 g_simple_async_result_take_error (res, error);
5320 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5324 g_file_real_open_readwrite_async (GFile *file,
5326 GCancellable *cancellable,
5327 GAsyncReadyCallback callback,
5330 GSimpleAsyncResult *res;
5332 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_open_readwrite_async);
5334 g_simple_async_result_run_in_thread (res, open_readwrite_async_thread, io_priority, cancellable);
5335 g_object_unref (res);
5338 static GFileIOStream *
5339 g_file_real_open_readwrite_finish (GFile *file,
5343 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5346 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_open_readwrite_async);
5348 op = g_simple_async_result_get_op_res_gpointer (simple);
5350 return g_object_ref (op);
5356 create_readwrite_async_thread (GSimpleAsyncResult *res,
5358 GCancellable *cancellable)
5361 GFileCreateFlags *data;
5362 GFileIOStream *stream;
5363 GError *error = NULL;
5365 iface = G_FILE_GET_IFACE (object);
5367 data = g_simple_async_result_get_op_res_gpointer (res);
5369 if (iface->create_readwrite == NULL)
5371 g_set_error_literal (&error, G_IO_ERROR,
5372 G_IO_ERROR_NOT_SUPPORTED,
5373 _("Operation not supported"));
5375 g_simple_async_result_take_error (res, error);
5380 stream = iface->create_readwrite (G_FILE (object), *data, cancellable, &error);
5383 g_simple_async_result_take_error (res, error);
5385 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5389 g_file_real_create_readwrite_async (GFile *file,
5390 GFileCreateFlags flags,
5392 GCancellable *cancellable,
5393 GAsyncReadyCallback callback,
5396 GFileCreateFlags *data;
5397 GSimpleAsyncResult *res;
5399 data = g_new0 (GFileCreateFlags, 1);
5402 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_readwrite_async);
5403 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5405 g_simple_async_result_run_in_thread (res, create_readwrite_async_thread, io_priority, cancellable);
5406 g_object_unref (res);
5409 static GFileIOStream *
5410 g_file_real_create_readwrite_finish (GFile *file,
5414 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5417 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_readwrite_async);
5419 op = g_simple_async_result_get_op_res_gpointer (simple);
5421 return g_object_ref (op);
5427 GFileIOStream *stream;
5429 gboolean make_backup;
5430 GFileCreateFlags flags;
5431 } ReplaceRWAsyncData;
5434 replace_rw_async_data_free (ReplaceRWAsyncData *data)
5437 g_object_unref (data->stream);
5438 g_free (data->etag);
5443 replace_readwrite_async_thread (GSimpleAsyncResult *res,
5445 GCancellable *cancellable)
5448 GFileIOStream *stream;
5449 GError *error = NULL;
5450 ReplaceRWAsyncData *data;
5452 iface = G_FILE_GET_IFACE (object);
5454 data = g_simple_async_result_get_op_res_gpointer (res);
5456 stream = iface->replace_readwrite (G_FILE (object),
5464 g_simple_async_result_take_error (res, error);
5466 data->stream = stream;
5470 g_file_real_replace_readwrite_async (GFile *file,
5472 gboolean make_backup,
5473 GFileCreateFlags flags,
5475 GCancellable *cancellable,
5476 GAsyncReadyCallback callback,
5479 GSimpleAsyncResult *res;
5480 ReplaceRWAsyncData *data;
5482 data = g_new0 (ReplaceRWAsyncData, 1);
5483 data->etag = g_strdup (etag);
5484 data->make_backup = make_backup;
5485 data->flags = flags;
5487 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_readwrite_async);
5488 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_rw_async_data_free);
5490 g_simple_async_result_run_in_thread (res, replace_readwrite_async_thread, io_priority, cancellable);
5491 g_object_unref (res);
5494 static GFileIOStream *
5495 g_file_real_replace_readwrite_finish (GFile *file,
5499 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5500 ReplaceRWAsyncData *data;
5502 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_readwrite_async);
5504 data = g_simple_async_result_get_op_res_gpointer (simple);
5506 return g_object_ref (data->stream);
5514 } SetDisplayNameAsyncData;
5517 set_display_name_data_free (SetDisplayNameAsyncData *data)
5519 g_free (data->name);
5521 g_object_unref (data->file);
5526 set_display_name_async_thread (GSimpleAsyncResult *res,
5528 GCancellable *cancellable)
5530 GError *error = NULL;
5531 SetDisplayNameAsyncData *data;
5534 data = g_simple_async_result_get_op_res_gpointer (res);
5536 file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
5539 g_simple_async_result_take_error (res, error);
5545 g_file_real_set_display_name_async (GFile *file,
5546 const char *display_name,
5548 GCancellable *cancellable,
5549 GAsyncReadyCallback callback,
5552 GSimpleAsyncResult *res;
5553 SetDisplayNameAsyncData *data;
5555 data = g_new0 (SetDisplayNameAsyncData, 1);
5556 data->name = g_strdup (display_name);
5558 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
5559 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
5561 g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
5562 g_object_unref (res);
5566 g_file_real_set_display_name_finish (GFile *file,
5570 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5571 SetDisplayNameAsyncData *data;
5573 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
5575 data = g_simple_async_result_get_op_res_gpointer (simple);
5577 return g_object_ref (data->file);
5583 GFileQueryInfoFlags flags;
5590 set_info_data_free (SetInfoAsyncData *data)
5593 g_object_unref (data->info);
5595 g_error_free (data->error);
5600 set_info_async_thread (GSimpleAsyncResult *res,
5602 GCancellable *cancellable)
5604 SetInfoAsyncData *data;
5606 data = g_simple_async_result_get_op_res_gpointer (res);
5609 data->res = g_file_set_attributes_from_info (G_FILE (object),
5617 g_file_real_set_attributes_async (GFile *file,
5619 GFileQueryInfoFlags flags,
5621 GCancellable *cancellable,
5622 GAsyncReadyCallback callback,
5625 GSimpleAsyncResult *res;
5626 SetInfoAsyncData *data;
5628 data = g_new0 (SetInfoAsyncData, 1);
5629 data->info = g_file_info_dup (info);
5630 data->flags = flags;
5632 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
5633 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
5635 g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
5636 g_object_unref (res);
5640 g_file_real_set_attributes_finish (GFile *file,
5645 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5646 SetInfoAsyncData *data;
5648 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
5650 data = g_simple_async_result_get_op_res_gpointer (simple);
5653 *info = g_object_ref (data->info);
5655 if (error != NULL && data->error)
5656 *error = g_error_copy (data->error);
5662 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
5664 GCancellable *cancellable)
5666 GError *error = NULL;
5669 mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
5672 g_simple_async_result_take_error (res, error);
5674 g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
5678 g_file_real_find_enclosing_mount_async (GFile *file,
5680 GCancellable *cancellable,
5681 GAsyncReadyCallback callback,
5684 GSimpleAsyncResult *res;
5686 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
5688 g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
5689 g_object_unref (res);
5693 g_file_real_find_enclosing_mount_finish (GFile *file,
5697 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5700 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
5702 mount = g_simple_async_result_get_op_res_gpointer (simple);
5703 return g_object_ref (mount);
5710 GFileCopyFlags flags;
5711 GFileProgressCallback progress_cb;
5712 gpointer progress_cb_data;
5713 GIOSchedulerJob *job;
5717 copy_async_data_free (CopyAsyncData *data)
5719 g_object_unref (data->source);
5720 g_object_unref (data->destination);
5725 CopyAsyncData *data;
5726 goffset current_num_bytes;
5727 goffset total_num_bytes;
5731 copy_async_progress_in_main (gpointer user_data)
5733 ProgressData *progress = user_data;
5734 CopyAsyncData *data = progress->data;
5736 data->progress_cb (progress->current_num_bytes,
5737 progress->total_num_bytes,
5738 data->progress_cb_data);
5744 mainloop_barrier (gpointer user_data)
5746 /* Does nothing, but ensures all queued idles before
5753 copy_async_progress_callback (goffset current_num_bytes,
5754 goffset total_num_bytes,
5757 CopyAsyncData *data = user_data;
5758 ProgressData *progress;
5760 progress = g_new (ProgressData, 1);
5761 progress->data = data;
5762 progress->current_num_bytes = current_num_bytes;
5763 progress->total_num_bytes = total_num_bytes;
5765 g_io_scheduler_job_send_to_mainloop_async (data->job,
5766 copy_async_progress_in_main,
5772 copy_async_thread (GIOSchedulerJob *job,
5773 GCancellable *cancellable,
5776 GSimpleAsyncResult *res;
5777 CopyAsyncData *data;
5782 data = g_simple_async_result_get_op_res_gpointer (res);
5786 result = g_file_copy (data->source,
5790 (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
5794 /* Ensure all progress callbacks are done running in main thread */
5795 if (data->progress_cb != NULL)
5796 g_io_scheduler_job_send_to_mainloop (job,
5801 g_simple_async_result_take_error (res, error);
5803 g_simple_async_result_complete_in_idle (res);
5809 g_file_real_copy_async (GFile *source,
5811 GFileCopyFlags flags,
5813 GCancellable *cancellable,
5814 GFileProgressCallback progress_callback,
5815 gpointer progress_callback_data,
5816 GAsyncReadyCallback callback,
5819 GSimpleAsyncResult *res;
5820 CopyAsyncData *data;
5822 data = g_new0 (CopyAsyncData, 1);
5823 data->source = g_object_ref (source);
5824 data->destination = g_object_ref (destination);
5825 data->flags = flags;
5826 data->progress_cb = progress_callback;
5827 data->progress_cb_data = progress_callback_data;
5829 res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
5830 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
5832 g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
5836 g_file_real_copy_finish (GFile *file,
5840 /* Error handled in g_file_copy_finish() */
5845 /********************************************
5846 * Default VFS operations *
5847 ********************************************/
5850 * g_file_new_for_path:
5851 * @path: a string containing a relative or absolute path. The string
5852 * must be encoded in the glib filename encoding.
5854 * Constructs a #GFile for a given path. This operation never
5855 * fails, but the returned object might not support any I/O
5856 * operation if @path is malformed.
5858 * Returns: (transfer full): a new #GFile for the given @path.
5861 g_file_new_for_path (const char *path)
5863 g_return_val_if_fail (path != NULL, NULL);
5865 return g_vfs_get_file_for_path (g_vfs_get_default (), path);
5869 * g_file_new_for_uri:
5870 * @uri: a UTF8 string containing a URI.
5872 * Constructs a #GFile for a given URI. This operation never
5873 * fails, but the returned object might not support any I/O
5874 * operation if @uri is malformed or if the uri type is
5877 * Returns: (transfer full): a #GFile for the given @uri.
5880 g_file_new_for_uri (const char *uri)
5882 g_return_val_if_fail (uri != NULL, NULL);
5884 return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
5888 * g_file_parse_name:
5889 * @parse_name: a file name or path to be parsed.
5891 * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
5892 * This operation never fails, but the returned object might not support any I/O
5893 * operation if the @parse_name cannot be parsed.
5895 * Returns: (transfer full): a new #GFile.
5898 g_file_parse_name (const char *parse_name)
5900 g_return_val_if_fail (parse_name != NULL, NULL);
5902 return g_vfs_parse_name (g_vfs_get_default (), parse_name);
5906 is_valid_scheme_character (char c)
5908 return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
5911 /* Following RFC 2396, valid schemes are built like:
5912 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
5915 has_valid_scheme (const char *uri)
5921 if (!g_ascii_isalpha (*p))
5926 } while (is_valid_scheme_character (*p));
5932 * g_file_new_for_commandline_arg:
5933 * @arg: a command line string.
5935 * Creates a #GFile with the given argument from the command line. The value of
5936 * @arg can be either a URI, an absolute path or a relative path resolved
5937 * relative to the current working directory.
5938 * This operation never fails, but the returned object might not support any
5939 * I/O operation if @arg points to a malformed path.
5941 * Returns: (transfer full): a new #GFile.
5944 g_file_new_for_commandline_arg (const char *arg)
5950 g_return_val_if_fail (arg != NULL, NULL);
5952 if (g_path_is_absolute (arg))
5953 return g_file_new_for_path (arg);
5955 if (has_valid_scheme (arg))
5956 return g_file_new_for_uri (arg);
5958 current_dir = g_get_current_dir ();
5959 filename = g_build_filename (current_dir, arg, NULL);
5960 g_free (current_dir);
5962 file = g_file_new_for_path (filename);
5969 * g_file_mount_enclosing_volume:
5970 * @location: input #GFile.
5971 * @flags: flags affecting the operation
5972 * @mount_operation: a #GMountOperation or %NULL to avoid user interaction.
5973 * @cancellable: optional #GCancellable object, %NULL to ignore.
5974 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
5975 * @user_data: the data to pass to callback function
5977 * Starts a @mount_operation, mounting the volume that contains the file @location.
5979 * When this operation has completed, @callback will be called with
5980 * @user_user data, and the operation can be finalized with
5981 * g_file_mount_enclosing_volume_finish().
5983 * If @cancellable is not %NULL, then the operation can be cancelled by
5984 * triggering the cancellable object from another thread. If the operation
5985 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5988 g_file_mount_enclosing_volume (GFile *location,
5989 GMountMountFlags flags,
5990 GMountOperation *mount_operation,
5991 GCancellable *cancellable,
5992 GAsyncReadyCallback callback,
5997 g_return_if_fail (G_IS_FILE (location));
5999 iface = G_FILE_GET_IFACE (location);
6001 if (iface->mount_enclosing_volume == NULL)
6003 g_simple_async_report_error_in_idle (G_OBJECT (location),
6004 callback, user_data,
6005 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
6006 _("volume doesn't implement mount"));
6011 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6016 * g_file_mount_enclosing_volume_finish:
6017 * @location: input #GFile.
6018 * @result: a #GAsyncResult.
6019 * @error: a #GError, or %NULL
6021 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6023 * Returns: %TRUE if successful. If an error
6024 * has occurred, this function will return %FALSE and set @error
6025 * appropriately if present.
6028 g_file_mount_enclosing_volume_finish (GFile *location,
6029 GAsyncResult *result,
6034 g_return_val_if_fail (G_IS_FILE (location), FALSE);
6035 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6037 if (G_IS_SIMPLE_ASYNC_RESULT (result))
6039 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
6040 if (g_simple_async_result_propagate_error (simple, error))
6044 iface = G_FILE_GET_IFACE (location);
6046 return (* iface->mount_enclosing_volume_finish) (location, result, error);
6049 /********************************************
6050 * Utility functions *
6051 ********************************************/
6054 * g_file_query_default_handler:
6055 * @file: a #GFile to open.
6056 * @cancellable: optional #GCancellable object, %NULL to ignore.
6057 * @error: a #GError, or %NULL
6059 * Returns the #GAppInfo that is registered as the default
6060 * application to handle the file specified by @file.
6062 * If @cancellable is not %NULL, then the operation can be cancelled by
6063 * triggering the cancellable object from another thread. If the operation
6064 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6066 * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors.
6067 * When you are done with it, release it with g_object_unref()
6070 g_file_query_default_handler (GFile *file,
6071 GCancellable *cancellable,
6075 const char *content_type;
6080 uri_scheme = g_file_get_uri_scheme (file);
6081 if (uri_scheme && uri_scheme[0] != '\0')
6083 appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
6084 g_free (uri_scheme);
6086 if (appinfo != NULL)
6090 info = g_file_query_info (file,
6091 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6100 content_type = g_file_info_get_content_type (info);
6103 /* Don't use is_native(), as we want to support fuse paths if available */
6104 path = g_file_get_path (file);
6105 appinfo = g_app_info_get_default_for_type (content_type,
6110 g_object_unref (info);
6112 if (appinfo != NULL)
6115 g_set_error_literal (error, G_IO_ERROR,
6116 G_IO_ERROR_NOT_SUPPORTED,
6117 _("No application is registered as handling this file"));
6123 #define GET_CONTENT_BLOCK_SIZE 8192
6126 * g_file_load_contents:
6127 * @file: input #GFile.
6128 * @cancellable: optional #GCancellable object, %NULL to ignore.
6129 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6130 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6131 * or %NULL if the length is not needed
6132 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6133 * or %NULL if the entity tag is not needed
6134 * @error: a #GError, or %NULL
6136 * Loads the content of the file into memory. The data is always
6137 * zero-terminated, but this is not included in the resultant @length.
6138 * The returned @content should be freed with g_free() when no longer
6141 * If @cancellable is not %NULL, then the operation can be cancelled by
6142 * triggering the cancellable object from another thread. If the operation
6143 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6145 * Returns: %TRUE if the @file's contents were successfully loaded.
6146 * %FALSE if there were errors.
6149 g_file_load_contents (GFile *file,
6150 GCancellable *cancellable,
6156 GFileInputStream *in;
6157 GByteArray *content;
6162 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6163 g_return_val_if_fail (contents != NULL, FALSE);
6165 in = g_file_read (file, cancellable, error);
6169 content = g_byte_array_new ();
6172 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6173 while ((res = g_input_stream_read (G_INPUT_STREAM (in),
6174 content->data + pos,
6175 GET_CONTENT_BLOCK_SIZE,
6176 cancellable, error)) > 0)
6179 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6186 info = g_file_input_stream_query_info (in,
6187 G_FILE_ATTRIBUTE_ETAG_VALUE,
6192 *etag_out = g_strdup (g_file_info_get_etag (info));
6193 g_object_unref (info);
6197 /* Ignore errors on close */
6198 g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
6199 g_object_unref (in);
6203 /* error is set already */
6204 g_byte_array_free (content, TRUE);
6211 /* Zero terminate (we got an extra byte allocated for this */
6212 content->data[pos] = 0;
6214 *contents = (char *)g_byte_array_free (content, FALSE);
6222 GCancellable *cancellable;
6223 GFileReadMoreCallback read_more_callback;
6224 GAsyncReadyCallback callback;
6226 GByteArray *content;
6233 load_contents_data_free (LoadContentsData *data)
6236 g_error_free (data->error);
6237 if (data->cancellable)
6238 g_object_unref (data->cancellable);
6240 g_byte_array_free (data->content, TRUE);
6241 g_free (data->etag);
6242 g_object_unref (data->file);
6247 load_contents_close_callback (GObject *obj,
6248 GAsyncResult *close_res,
6251 GInputStream *stream = G_INPUT_STREAM (obj);
6252 LoadContentsData *data = user_data;
6253 GSimpleAsyncResult *res;
6255 /* Ignore errors here, we're only reading anyway */
6256 g_input_stream_close_finish (stream, close_res, NULL);
6257 g_object_unref (stream);
6259 res = g_simple_async_result_new (G_OBJECT (data->file),
6262 g_file_load_contents_async);
6263 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
6264 g_simple_async_result_complete (res);
6265 g_object_unref (res);
6269 load_contents_fstat_callback (GObject *obj,
6270 GAsyncResult *stat_res,
6273 GInputStream *stream = G_INPUT_STREAM (obj);
6274 LoadContentsData *data = user_data;
6277 info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
6281 data->etag = g_strdup (g_file_info_get_etag (info));
6282 g_object_unref (info);
6285 g_input_stream_close_async (stream, 0,
6287 load_contents_close_callback, data);
6291 load_contents_read_callback (GObject *obj,
6292 GAsyncResult *read_res,
6295 GInputStream *stream = G_INPUT_STREAM (obj);
6296 LoadContentsData *data = user_data;
6297 GError *error = NULL;
6300 read_size = g_input_stream_read_finish (stream, read_res, &error);
6304 /* Error or EOF, close the file */
6305 data->error = error;
6306 g_input_stream_close_async (stream, 0,
6308 load_contents_close_callback, data);
6310 else if (read_size == 0)
6312 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6313 G_FILE_ATTRIBUTE_ETAG_VALUE,
6316 load_contents_fstat_callback,
6319 else if (read_size > 0)
6321 data->pos += read_size;
6323 g_byte_array_set_size (data->content,
6324 data->pos + GET_CONTENT_BLOCK_SIZE);
6327 if (data->read_more_callback &&
6328 !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
6329 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6330 G_FILE_ATTRIBUTE_ETAG_VALUE,
6333 load_contents_fstat_callback,
6336 g_input_stream_read_async (stream,
6337 data->content->data + data->pos,
6338 GET_CONTENT_BLOCK_SIZE,
6341 load_contents_read_callback,
6347 load_contents_open_callback (GObject *obj,
6348 GAsyncResult *open_res,
6351 GFile *file = G_FILE (obj);
6352 GFileInputStream *stream;
6353 LoadContentsData *data = user_data;
6354 GError *error = NULL;
6355 GSimpleAsyncResult *res;
6357 stream = g_file_read_finish (file, open_res, &error);
6361 g_byte_array_set_size (data->content,
6362 data->pos + GET_CONTENT_BLOCK_SIZE);
6363 g_input_stream_read_async (G_INPUT_STREAM (stream),
6364 data->content->data + data->pos,
6365 GET_CONTENT_BLOCK_SIZE,
6368 load_contents_read_callback,
6374 res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6378 g_simple_async_result_complete (res);
6379 load_contents_data_free (data);
6380 g_object_unref (res);
6385 * g_file_load_partial_contents_async: (skip)
6386 * @file: input #GFile.
6387 * @cancellable: optional #GCancellable object, %NULL to ignore.
6388 * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
6389 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6390 * @user_data: the data to pass to the callback functions.
6392 * Reads the partial contents of a file. A #GFileReadMoreCallback should be
6393 * used to stop reading from the file when appropriate, else this function
6394 * will behave exactly as g_file_load_contents_async(). This operation
6395 * can be finished by g_file_load_partial_contents_finish().
6397 * Users of this function should be aware that @user_data is passed to
6398 * both the @read_more_callback and the @callback.
6400 * If @cancellable is not %NULL, then the operation can be cancelled by
6401 * triggering the cancellable object from another thread. If the operation
6402 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6405 g_file_load_partial_contents_async (GFile *file,
6406 GCancellable *cancellable,
6407 GFileReadMoreCallback read_more_callback,
6408 GAsyncReadyCallback callback,
6411 LoadContentsData *data;
6413 g_return_if_fail (G_IS_FILE (file));
6415 data = g_new0 (LoadContentsData, 1);
6418 data->cancellable = g_object_ref (cancellable);
6419 data->read_more_callback = read_more_callback;
6420 data->callback = callback;
6421 data->user_data = user_data;
6422 data->content = g_byte_array_new ();
6423 data->file = g_object_ref (file);
6425 g_file_read_async (file,
6428 load_contents_open_callback,
6433 * g_file_load_partial_contents_finish:
6434 * @file: input #GFile.
6435 * @res: a #GAsyncResult.
6436 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6437 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6438 * or %NULL if the length is not needed
6439 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6440 * or %NULL if the entity tag is not needed
6441 * @error: a #GError, or %NULL
6443 * Finishes an asynchronous partial load operation that was started
6444 * with g_file_load_partial_contents_async(). The data is always
6445 * zero-terminated, but this is not included in the resultant @length.
6446 * The returned @content should be freed with g_free() when no longer
6449 * Returns: %TRUE if the load was successful. If %FALSE and @error is
6450 * present, it will be set appropriately.
6453 g_file_load_partial_contents_finish (GFile *file,
6460 GSimpleAsyncResult *simple;
6461 LoadContentsData *data;
6463 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6464 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
6465 g_return_val_if_fail (contents != NULL, FALSE);
6467 simple = G_SIMPLE_ASYNC_RESULT (res);
6469 if (g_simple_async_result_propagate_error (simple, error))
6472 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
6474 data = g_simple_async_result_get_op_res_gpointer (simple);
6478 g_propagate_error (error, data->error);
6487 *length = data->pos;
6491 *etag_out = data->etag;
6495 /* Zero terminate */
6496 g_byte_array_set_size (data->content, data->pos + 1);
6497 data->content->data[data->pos] = 0;
6499 *contents = (char *)g_byte_array_free (data->content, FALSE);
6500 data->content = NULL;
6506 * g_file_load_contents_async:
6507 * @file: input #GFile.
6508 * @cancellable: optional #GCancellable object, %NULL to ignore.
6509 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6510 * @user_data: the data to pass to callback function
6512 * Starts an asynchronous load of the @file's contents.
6514 * For more details, see g_file_load_contents() which is
6515 * the synchronous version of this call.
6517 * When the load operation has completed, @callback will be called
6518 * with @user data. To finish the operation, call
6519 * g_file_load_contents_finish() with the #GAsyncResult returned by
6522 * If @cancellable is not %NULL, then the operation can be cancelled by
6523 * triggering the cancellable object from another thread. If the operation
6524 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6527 g_file_load_contents_async (GFile *file,
6528 GCancellable *cancellable,
6529 GAsyncReadyCallback callback,
6532 g_file_load_partial_contents_async (file,
6535 callback, user_data);
6539 * g_file_load_contents_finish:
6540 * @file: input #GFile.
6541 * @res: a #GAsyncResult.
6542 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6543 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6544 * or %NULL if the length is not needed
6545 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6546 * or %NULL if the entity tag is not needed
6547 * @error: a #GError, or %NULL
6549 * Finishes an asynchronous load of the @file's contents.
6550 * The contents are placed in @contents, and @length is set to the
6551 * size of the @contents string. The @content should be freed with
6552 * g_free() when no longer needed. If @etag_out is present, it will be
6553 * set to the new entity tag for the @file.
6555 * Returns: %TRUE if the load was successful. If %FALSE and @error is
6556 * present, it will be set appropriately.
6559 g_file_load_contents_finish (GFile *file,
6566 return g_file_load_partial_contents_finish (file,
6575 * g_file_replace_contents:
6576 * @file: input #GFile.
6577 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file.
6578 * @length: the length of @contents in bytes.
6579 * @etag: (allow-none): the old <link linkend="gfile-etag">entity tag</link>
6580 * for the document, or %NULL
6581 * @make_backup: %TRUE if a backup should be created.
6582 * @flags: a set of #GFileCreateFlags.
6583 * @new_etag: (allow-none) (out): a location to a new <link linkend="gfile-etag">entity tag</link>
6584 * for the document. This should be freed with g_free() when no longer
6586 * @cancellable: optional #GCancellable object, %NULL to ignore.
6587 * @error: a #GError, or %NULL
6589 * Replaces the contents of @file with @contents of @length bytes.
6591 * If @etag is specified (not %NULL) any existing file must have that etag, or
6592 * the error %G_IO_ERROR_WRONG_ETAG will be returned.
6594 * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
6596 * If @cancellable is not %NULL, then the operation can be cancelled by
6597 * triggering the cancellable object from another thread. If the operation
6598 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6600 * The returned @new_etag can be used to verify that the file hasn't changed the
6601 * next time it is saved over.
6603 * Returns: %TRUE if successful. If an error
6604 * has occurred, this function will return %FALSE and set @error
6605 * appropriately if present.
6608 g_file_replace_contents (GFile *file,
6609 const char *contents,
6612 gboolean make_backup,
6613 GFileCreateFlags flags,
6615 GCancellable *cancellable,
6618 GFileOutputStream *out;
6619 gsize pos, remainder;
6623 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6624 g_return_val_if_fail (contents != NULL, FALSE);
6626 out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
6632 while (remainder > 0 &&
6633 (res = g_output_stream_write (G_OUTPUT_STREAM (out),
6635 MIN (remainder, GET_CONTENT_BLOCK_SIZE),
6643 if (remainder > 0 && res < 0)
6645 /* Ignore errors on close */
6646 g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
6647 g_object_unref (out);
6649 /* error is set already */
6653 ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
6656 *new_etag = g_file_output_stream_get_etag (out);
6658 g_object_unref (out);
6666 GCancellable *cancellable;
6667 GAsyncReadyCallback callback;
6669 const char *content;
6673 } ReplaceContentsData;
6676 replace_contents_data_free (ReplaceContentsData *data)
6679 g_error_free (data->error);
6680 if (data->cancellable)
6681 g_object_unref (data->cancellable);
6682 g_object_unref (data->file);
6683 g_free (data->etag);
6688 replace_contents_close_callback (GObject *obj,
6689 GAsyncResult *close_res,
6692 GOutputStream *stream = G_OUTPUT_STREAM (obj);
6693 ReplaceContentsData *data = user_data;
6694 GSimpleAsyncResult *res;
6696 /* Ignore errors here, we're only reading anyway */
6697 g_output_stream_close_finish (stream, close_res, NULL);
6698 g_object_unref (stream);
6700 data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
6702 res = g_simple_async_result_new (G_OBJECT (data->file),
6705 g_file_replace_contents_async);
6706 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
6707 g_simple_async_result_complete (res);
6708 g_object_unref (res);
6712 replace_contents_write_callback (GObject *obj,
6713 GAsyncResult *read_res,
6716 GOutputStream *stream = G_OUTPUT_STREAM (obj);
6717 ReplaceContentsData *data = user_data;
6718 GError *error = NULL;
6721 write_size = g_output_stream_write_finish (stream, read_res, &error);
6723 if (write_size <= 0)
6725 /* Error or EOF, close the file */
6727 data->error = error;
6728 g_output_stream_close_async (stream, 0,
6730 replace_contents_close_callback, data);
6732 else if (write_size > 0)
6734 data->pos += write_size;
6736 if (data->pos >= data->length)
6737 g_output_stream_close_async (stream, 0,
6739 replace_contents_close_callback, data);
6741 g_output_stream_write_async (stream,
6742 data->content + data->pos,
6743 data->length - data->pos,
6746 replace_contents_write_callback,
6752 replace_contents_open_callback (GObject *obj,
6753 GAsyncResult *open_res,
6756 GFile *file = G_FILE (obj);
6757 GFileOutputStream *stream;
6758 ReplaceContentsData *data = user_data;
6759 GError *error = NULL;
6760 GSimpleAsyncResult *res;
6762 stream = g_file_replace_finish (file, open_res, &error);
6766 g_output_stream_write_async (G_OUTPUT_STREAM (stream),
6767 data->content + data->pos,
6768 data->length - data->pos,
6771 replace_contents_write_callback,
6777 res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6781 g_simple_async_result_complete (res);
6782 replace_contents_data_free (data);
6783 g_object_unref (res);
6788 * g_file_replace_contents_async:
6789 * @file: input #GFile.
6790 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with.
6791 * @length: the length of @contents in bytes.
6792 * @etag: (allow-none): a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
6793 * @make_backup: %TRUE if a backup should be created.
6794 * @flags: a set of #GFileCreateFlags.
6795 * @cancellable: optional #GCancellable object, %NULL to ignore.
6796 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6797 * @user_data: the data to pass to callback function
6799 * Starts an asynchronous replacement of @file with the given
6800 * @contents of @length bytes. @etag will replace the document's
6801 * current entity tag.
6803 * When this operation has completed, @callback will be called with
6804 * @user_user data, and the operation can be finalized with
6805 * g_file_replace_contents_finish().
6807 * If @cancellable is not %NULL, then the operation can be cancelled by
6808 * triggering the cancellable object from another thread. If the operation
6809 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6811 * If @make_backup is %TRUE, this function will attempt to
6812 * make a backup of @file.
6815 g_file_replace_contents_async (GFile *file,
6816 const char *contents,
6819 gboolean make_backup,
6820 GFileCreateFlags flags,
6821 GCancellable *cancellable,
6822 GAsyncReadyCallback callback,
6825 ReplaceContentsData *data;
6827 g_return_if_fail (G_IS_FILE (file));
6828 g_return_if_fail (contents != NULL);
6830 data = g_new0 (ReplaceContentsData, 1);
6833 data->cancellable = g_object_ref (cancellable);
6834 data->callback = callback;
6835 data->user_data = user_data;
6836 data->content = contents;
6837 data->length = length;
6839 data->file = g_object_ref (file);
6841 g_file_replace_async (file,
6847 replace_contents_open_callback,
6852 * g_file_replace_contents_finish:
6853 * @file: input #GFile.
6854 * @res: a #GAsyncResult.
6855 * @new_etag: (out) (allow-none): a location of a new <link linkend="gfile-etag">entity tag</link>
6856 * for the document. This should be freed with g_free() when it is no
6857 * longer needed, or %NULL
6858 * @error: a #GError, or %NULL
6860 * Finishes an asynchronous replace of the given @file. See
6861 * g_file_replace_contents_async(). Sets @new_etag to the new entity
6862 * tag for the document, if present.
6864 * Returns: %TRUE on success, %FALSE on failure.
6867 g_file_replace_contents_finish (GFile *file,
6872 GSimpleAsyncResult *simple;
6873 ReplaceContentsData *data;
6875 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6876 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
6878 simple = G_SIMPLE_ASYNC_RESULT (res);
6880 if (g_simple_async_result_propagate_error (simple, error))
6883 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
6885 data = g_simple_async_result_get_op_res_gpointer (simple);
6889 g_propagate_error (error, data->error);
6897 *new_etag = data->etag;
6898 data->etag = NULL; /* Take ownership */
6905 * g_file_start_mountable:
6906 * @file: input #GFile.
6907 * @flags: flags affecting the operation
6908 * @start_operation: a #GMountOperation, or %NULL to avoid user interaction.
6909 * @cancellable: optional #GCancellable object, %NULL to ignore.
6910 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
6911 * @user_data: the data to pass to callback function
6913 * Starts a file of type G_FILE_TYPE_MOUNTABLE.
6914 * Using @start_operation, you can request callbacks when, for instance,
6915 * passwords are needed during authentication.
6917 * If @cancellable is not %NULL, then the operation can be cancelled by
6918 * triggering the cancellable object from another thread. If the operation
6919 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6921 * When the operation is finished, @callback will be called. You can then call
6922 * g_file_mount_mountable_finish() to get the result of the operation.
6927 g_file_start_mountable (GFile *file,
6928 GDriveStartFlags flags,
6929 GMountOperation *start_operation,
6930 GCancellable *cancellable,
6931 GAsyncReadyCallback callback,
6936 g_return_if_fail (G_IS_FILE (file));
6938 iface = G_FILE_GET_IFACE (file);
6940 if (iface->start_mountable == NULL)
6942 g_simple_async_report_error_in_idle (G_OBJECT (file),
6946 G_IO_ERROR_NOT_SUPPORTED,
6947 _("Operation not supported"));
6951 (* iface->start_mountable) (file,
6960 * g_file_start_mountable_finish:
6961 * @file: input #GFile.
6962 * @result: a #GAsyncResult.
6963 * @error: a #GError, or %NULL
6965 * Finishes a start operation. See g_file_start_mountable() for details.
6967 * Finish an asynchronous start operation that was started
6968 * with g_file_start_mountable().
6970 * Returns: %TRUE if the operation finished successfully. %FALSE
6976 g_file_start_mountable_finish (GFile *file,
6977 GAsyncResult *result,
6982 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6983 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6985 if (G_IS_SIMPLE_ASYNC_RESULT (result))
6987 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
6988 if (g_simple_async_result_propagate_error (simple, error))
6992 iface = G_FILE_GET_IFACE (file);
6993 return (* iface->start_mountable_finish) (file, result, error);
6997 * g_file_stop_mountable:
6998 * @file: input #GFile.
6999 * @flags: flags affecting the operation
7000 * @mount_operation: a #GMountOperation, or %NULL to avoid user interaction.
7001 * @cancellable: optional #GCancellable object, %NULL to ignore.
7002 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7003 * @user_data: the data to pass to callback function
7005 * Stops a file of type G_FILE_TYPE_MOUNTABLE.
7007 * If @cancellable is not %NULL, then the operation can be cancelled by
7008 * triggering the cancellable object from another thread. If the operation
7009 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7011 * When the operation is finished, @callback will be called. You can then call
7012 * g_file_stop_mountable_finish() to get the result of the operation.
7017 g_file_stop_mountable (GFile *file,
7018 GMountUnmountFlags flags,
7019 GMountOperation *mount_operation,
7020 GCancellable *cancellable,
7021 GAsyncReadyCallback callback,
7026 g_return_if_fail (G_IS_FILE (file));
7028 iface = G_FILE_GET_IFACE (file);
7030 if (iface->stop_mountable == NULL)
7032 g_simple_async_report_error_in_idle (G_OBJECT (file),
7036 G_IO_ERROR_NOT_SUPPORTED,
7037 _("Operation not supported"));
7041 (* iface->stop_mountable) (file,
7050 * g_file_stop_mountable_finish:
7051 * @file: input #GFile.
7052 * @result: a #GAsyncResult.
7053 * @error: a #GError, or %NULL
7055 * Finishes an stop operation, see g_file_stop_mountable() for details.
7057 * Finish an asynchronous stop operation that was started
7058 * with g_file_stop_mountable().
7060 * Returns: %TRUE if the operation finished successfully. %FALSE
7066 g_file_stop_mountable_finish (GFile *file,
7067 GAsyncResult *result,
7072 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7073 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7075 if (G_IS_SIMPLE_ASYNC_RESULT (result))
7077 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
7078 if (g_simple_async_result_propagate_error (simple, error))
7082 iface = G_FILE_GET_IFACE (file);
7083 return (* iface->stop_mountable_finish) (file, result, error);
7087 * g_file_poll_mountable:
7088 * @file: input #GFile.
7089 * @cancellable: optional #GCancellable object, %NULL to ignore.
7090 * @callback: a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7091 * @user_data: the data to pass to callback function
7093 * Polls a file of type G_FILE_TYPE_MOUNTABLE.
7095 * If @cancellable is not %NULL, then the operation can be cancelled by
7096 * triggering the cancellable object from another thread. If the operation
7097 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7099 * When the operation is finished, @callback will be called. You can then call
7100 * g_file_mount_mountable_finish() to get the result of the operation.
7105 g_file_poll_mountable (GFile *file,
7106 GCancellable *cancellable,
7107 GAsyncReadyCallback callback,
7112 g_return_if_fail (G_IS_FILE (file));
7114 iface = G_FILE_GET_IFACE (file);
7116 if (iface->poll_mountable == NULL)
7118 g_simple_async_report_error_in_idle (G_OBJECT (file),
7122 G_IO_ERROR_NOT_SUPPORTED,
7123 _("Operation not supported"));
7127 (* iface->poll_mountable) (file,
7134 * g_file_poll_mountable_finish:
7135 * @file: input #GFile.
7136 * @result: a #GAsyncResult.
7137 * @error: a #GError, or %NULL
7139 * Finishes a poll operation. See g_file_poll_mountable() for details.
7141 * Finish an asynchronous poll operation that was polled
7142 * with g_file_poll_mountable().
7144 * Returns: %TRUE if the operation finished successfully. %FALSE
7150 g_file_poll_mountable_finish (GFile *file,
7151 GAsyncResult *result,
7156 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7157 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7159 if (G_IS_SIMPLE_ASYNC_RESULT (result))
7161 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result);
7162 if (g_simple_async_result_propagate_error (simple, error))
7166 iface = G_FILE_GET_IFACE (file);
7167 return (* iface->poll_mountable_finish) (file, result, error);
7171 * g_file_supports_thread_contexts:
7174 * Checks if @file supports <link
7175 * linkend="g-main-context-push-thread-default-context">thread-default
7176 * contexts</link>. If this returns %FALSE, you cannot perform
7177 * asynchronous operations on @file in a thread that has a
7178 * thread-default context.
7180 * Returns: Whether or not @file supports thread-default contexts.
7185 g_file_supports_thread_contexts (GFile *file)
7189 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7191 iface = G_FILE_GET_IFACE (file);
7192 return iface->supports_thread_contexts;