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 "glocalfileoutputstream.h"
48 #include "glocalfileiostream.h"
49 #include "gcancellable.h"
50 #include "gasyncresult.h"
57 * @short_description: File and Directory Handling
59 * @see_also: #GFileInfo, #GFileEnumerator
61 * #GFile is a high level abstraction for manipulating files on a
62 * virtual file system. #GFile<!-- -->s are lightweight, immutable
63 * objects that do no I/O upon creation. It is necessary to understand that
64 * #GFile objects do not represent files, merely an identifier for a file. All
65 * file content I/O is implemented as streaming operations (see #GInputStream and
68 * To construct a #GFile, you can use:
69 * g_file_new_for_path() if you have a path.
70 * g_file_new_for_uri() if you have a URI.
71 * g_file_new_for_commandline_arg() for a command line argument.
72 * g_file_new_tmp() to create a temporary file from a template.
73 * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name().
75 * One way to think of a #GFile is as an abstraction of a pathname. For normal
76 * files the system pathname is what is stored internally, but as #GFile<!-- -->s
77 * are extensible it could also be something else that corresponds to a pathname
78 * in a userspace implementation of a filesystem.
80 * #GFile<!-- -->s make up hierarchies of directories and files that correspond to the
81 * files on a filesystem. You can move through the file system with #GFile using
82 * g_file_get_parent() to get an identifier for the parent directory, g_file_get_child()
83 * to get a child within a directory, g_file_resolve_relative_path() to resolve a relative
84 * path between two #GFile<!-- -->s. There can be multiple hierarchies, so you may not
85 * end up at the same root if you repeatedly call g_file_get_parent() on two different
88 * All #GFile<!-- -->s have a basename (get with g_file_get_basename()). These names
89 * are byte strings that are used to identify the file on the filesystem (relative to
90 * its parent directory) and there is no guarantees that they have any particular charset
91 * encoding or even make any sense at all. If you want to use filenames in a user
92 * interface you should use the display name that you can get by requesting the
93 * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
94 * This is guaranteed to be in utf8 and can be used in a user interface. But always
95 * store the real basename or the #GFile to use to actually access the file, because
96 * there is no way to go from a display name to the actual name.
98 * Using #GFile as an identifier has the same weaknesses as using a path in that
99 * there may be multiple aliases for the same file. For instance, hard or
100 * soft links may cause two different #GFile<!-- -->s to refer to the same file.
101 * Other possible causes for aliases are: case insensitive filesystems, short
102 * and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if
103 * two #GFile<!-- -->s point to the same file you can query for the
104 * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
105 * canonicalization of pathnames passed in, so that trivial differences in the
106 * path string used at creation (duplicated slashes, slash at end of path, "."
107 * or ".." path segments, etc) does not create different #GFile<!-- -->s.
109 * Many #GFile operations have both synchronous and asynchronous versions
110 * to suit your application. Asynchronous versions of synchronous functions
111 * simply have _async() appended to their function names. The asynchronous
112 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
113 * the operation, producing a GAsyncResult which is then passed to the
114 * function's matching _finish() operation.
116 * Some #GFile operations do not have synchronous analogs, as they may
117 * take a very long time to finish, and blocking may leave an application
118 * unusable. Notable cases include:
119 * g_file_mount_mountable() to mount a mountable file.
120 * g_file_unmount_mountable_with_operation() to unmount a mountable file.
121 * g_file_eject_mountable_with_operation() to eject a mountable file.
123 * <para id="gfile-etag"><indexterm><primary>entity tag</primary></indexterm>
124 * One notable feature of #GFile<!-- -->s are entity tags, or "etags" for
125 * short. Entity tags are somewhat like a more abstract version of the
126 * traditional mtime, and can be used to quickly determine if the file has
127 * been modified from the version on the file system. See the HTTP 1.1
128 * <ulink url="http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html">specification</ulink>
129 * for HTTP Etag headers, which are a very similar concept.
133 static void g_file_real_query_info_async (GFile *file,
134 const char *attributes,
135 GFileQueryInfoFlags flags,
137 GCancellable *cancellable,
138 GAsyncReadyCallback callback,
140 static GFileInfo * g_file_real_query_info_finish (GFile *file,
143 static void g_file_real_query_filesystem_info_async (GFile *file,
144 const char *attributes,
146 GCancellable *cancellable,
147 GAsyncReadyCallback callback,
149 static GFileInfo * g_file_real_query_filesystem_info_finish (GFile *file,
152 static void g_file_real_enumerate_children_async (GFile *file,
153 const char *attributes,
154 GFileQueryInfoFlags flags,
156 GCancellable *cancellable,
157 GAsyncReadyCallback callback,
159 static GFileEnumerator * g_file_real_enumerate_children_finish (GFile *file,
162 static void g_file_real_read_async (GFile *file,
164 GCancellable *cancellable,
165 GAsyncReadyCallback callback,
167 static GFileInputStream * g_file_real_read_finish (GFile *file,
170 static void g_file_real_append_to_async (GFile *file,
171 GFileCreateFlags flags,
173 GCancellable *cancellable,
174 GAsyncReadyCallback callback,
176 static GFileOutputStream *g_file_real_append_to_finish (GFile *file,
179 static void g_file_real_create_async (GFile *file,
180 GFileCreateFlags flags,
182 GCancellable *cancellable,
183 GAsyncReadyCallback callback,
185 static GFileOutputStream *g_file_real_create_finish (GFile *file,
188 static void g_file_real_replace_async (GFile *file,
190 gboolean make_backup,
191 GFileCreateFlags flags,
193 GCancellable *cancellable,
194 GAsyncReadyCallback callback,
196 static GFileOutputStream *g_file_real_replace_finish (GFile *file,
199 static void g_file_real_delete_async (GFile *file,
201 GCancellable *cancellable,
202 GAsyncReadyCallback callback,
204 static gboolean g_file_real_delete_finish (GFile *file,
207 static void g_file_real_open_readwrite_async (GFile *file,
209 GCancellable *cancellable,
210 GAsyncReadyCallback callback,
212 static GFileIOStream * g_file_real_open_readwrite_finish (GFile *file,
215 static void g_file_real_create_readwrite_async (GFile *file,
216 GFileCreateFlags flags,
218 GCancellable *cancellable,
219 GAsyncReadyCallback callback,
221 static GFileIOStream * g_file_real_create_readwrite_finish (GFile *file,
224 static void g_file_real_replace_readwrite_async (GFile *file,
226 gboolean make_backup,
227 GFileCreateFlags flags,
229 GCancellable *cancellable,
230 GAsyncReadyCallback callback,
232 static GFileIOStream * g_file_real_replace_readwrite_finish (GFile *file,
235 static gboolean g_file_real_set_attributes_from_info (GFile *file,
237 GFileQueryInfoFlags flags,
238 GCancellable *cancellable,
240 static void g_file_real_set_display_name_async (GFile *file,
241 const char *display_name,
243 GCancellable *cancellable,
244 GAsyncReadyCallback callback,
246 static GFile * g_file_real_set_display_name_finish (GFile *file,
249 static void g_file_real_set_attributes_async (GFile *file,
251 GFileQueryInfoFlags flags,
253 GCancellable *cancellable,
254 GAsyncReadyCallback callback,
256 static gboolean g_file_real_set_attributes_finish (GFile *file,
260 static void g_file_real_find_enclosing_mount_async (GFile *file,
262 GCancellable *cancellable,
263 GAsyncReadyCallback callback,
265 static GMount * g_file_real_find_enclosing_mount_finish (GFile *file,
268 static void g_file_real_copy_async (GFile *source,
270 GFileCopyFlags flags,
272 GCancellable *cancellable,
273 GFileProgressCallback progress_callback,
274 gpointer progress_callback_data,
275 GAsyncReadyCallback callback,
277 static gboolean g_file_real_copy_finish (GFile *file,
281 typedef GFileIface GFileInterface;
282 G_DEFINE_INTERFACE (GFile, g_file, G_TYPE_OBJECT)
285 g_file_default_init (GFileIface *iface)
287 iface->enumerate_children_async = g_file_real_enumerate_children_async;
288 iface->enumerate_children_finish = g_file_real_enumerate_children_finish;
289 iface->set_display_name_async = g_file_real_set_display_name_async;
290 iface->set_display_name_finish = g_file_real_set_display_name_finish;
291 iface->query_info_async = g_file_real_query_info_async;
292 iface->query_info_finish = g_file_real_query_info_finish;
293 iface->query_filesystem_info_async = g_file_real_query_filesystem_info_async;
294 iface->query_filesystem_info_finish = g_file_real_query_filesystem_info_finish;
295 iface->set_attributes_async = g_file_real_set_attributes_async;
296 iface->set_attributes_finish = g_file_real_set_attributes_finish;
297 iface->read_async = g_file_real_read_async;
298 iface->read_finish = g_file_real_read_finish;
299 iface->append_to_async = g_file_real_append_to_async;
300 iface->append_to_finish = g_file_real_append_to_finish;
301 iface->create_async = g_file_real_create_async;
302 iface->create_finish = g_file_real_create_finish;
303 iface->replace_async = g_file_real_replace_async;
304 iface->replace_finish = g_file_real_replace_finish;
305 iface->delete_file_async = g_file_real_delete_async;
306 iface->delete_file_finish = g_file_real_delete_finish;
307 iface->open_readwrite_async = g_file_real_open_readwrite_async;
308 iface->open_readwrite_finish = g_file_real_open_readwrite_finish;
309 iface->create_readwrite_async = g_file_real_create_readwrite_async;
310 iface->create_readwrite_finish = g_file_real_create_readwrite_finish;
311 iface->replace_readwrite_async = g_file_real_replace_readwrite_async;
312 iface->replace_readwrite_finish = g_file_real_replace_readwrite_finish;
313 iface->find_enclosing_mount_async = g_file_real_find_enclosing_mount_async;
314 iface->find_enclosing_mount_finish = g_file_real_find_enclosing_mount_finish;
315 iface->set_attributes_from_info = g_file_real_set_attributes_from_info;
316 iface->copy_async = g_file_real_copy_async;
317 iface->copy_finish = g_file_real_copy_finish;
323 * @file: input #GFile.
325 * Checks to see if a file is native to the platform.
327 * A native file s one expressed in the platform-native filename format,
328 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
329 * as it might be on a locally mounted remote filesystem.
331 * On some systems non-native files may be available using
332 * the native filesystem via a userspace filesystem (FUSE), in
333 * these cases this call will return %FALSE, but g_file_get_path()
334 * will still return a native path.
336 * This call does no blocking i/o.
338 * Returns: %TRUE if file is native.
341 g_file_is_native (GFile *file)
345 g_return_val_if_fail (G_IS_FILE (file), FALSE);
347 iface = G_FILE_GET_IFACE (file);
349 return (* iface->is_native) (file);
354 * g_file_has_uri_scheme:
355 * @file: input #GFile.
356 * @uri_scheme: a string containing a URI scheme.
358 * Checks to see if a #GFile has a given URI scheme.
360 * This call does no blocking i/o.
362 * Returns: %TRUE if #GFile's backend supports the
363 * given URI scheme, %FALSE if URI scheme is %NULL,
364 * not supported, or #GFile is invalid.
367 g_file_has_uri_scheme (GFile *file,
368 const char *uri_scheme)
372 g_return_val_if_fail (G_IS_FILE (file), FALSE);
373 g_return_val_if_fail (uri_scheme != NULL, FALSE);
375 iface = G_FILE_GET_IFACE (file);
377 return (* iface->has_uri_scheme) (file, uri_scheme);
382 * g_file_get_uri_scheme:
383 * @file: input #GFile.
385 * Gets the URI scheme for a #GFile.
386 * RFC 3986 decodes the scheme as:
388 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
390 * Common schemes include "file", "http", "ftp", etc.
392 * This call does no blocking i/o.
394 * Returns: a string containing the URI scheme for the given
395 * #GFile. The returned string should be freed with g_free()
396 * when no longer needed.
399 g_file_get_uri_scheme (GFile *file)
403 g_return_val_if_fail (G_IS_FILE (file), NULL);
405 iface = G_FILE_GET_IFACE (file);
407 return (* iface->get_uri_scheme) (file);
412 * g_file_get_basename:
413 * @file: input #GFile.
415 * Gets the base name (the last component of the path) for a given #GFile.
417 * If called for the top level of a system (such as the filesystem root
418 * or a uri like sftp://host/) it will return a single directory separator
419 * (and on Windows, possibly a drive letter).
421 * The base name is a byte string (*not* UTF-8). It has no defined encoding
422 * or rules other than it may not contain zero bytes. If you want to use
423 * filenames in a user interface you should use the display name that you
424 * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
425 * attribute with g_file_query_info().
427 * This call does no blocking i/o.
429 * Returns: string containing the #GFile's base name, or %NULL
430 * if given #GFile is invalid. The returned string should be
431 * freed with g_free() when no longer needed.
434 g_file_get_basename (GFile *file)
438 g_return_val_if_fail (G_IS_FILE (file), NULL);
440 iface = G_FILE_GET_IFACE (file);
442 return (* iface->get_basename) (file);
447 * @file: input #GFile.
449 * Gets the local pathname for #GFile, if one exists.
451 * This call does no blocking i/o.
453 * Returns: string containing the #GFile's path, or %NULL if
454 * no such path exists. The returned string should be
455 * freed with g_free() when no longer needed.
458 g_file_get_path (GFile *file)
462 g_return_val_if_fail (G_IS_FILE (file), NULL);
464 iface = G_FILE_GET_IFACE (file);
466 return (* iface->get_path) (file);
471 * @file: input #GFile.
473 * Gets the URI for the @file.
475 * This call does no blocking i/o.
477 * Returns: a string containing the #GFile's URI.
478 * The returned string should be freed with g_free() when no longer needed.
481 g_file_get_uri (GFile *file)
485 g_return_val_if_fail (G_IS_FILE (file), NULL);
487 iface = G_FILE_GET_IFACE (file);
489 return (* iface->get_uri) (file);
493 * g_file_get_parse_name:
494 * @file: input #GFile.
496 * Gets the parse name of the @file.
497 * A parse name is a UTF-8 string that describes the
498 * file such that one can get the #GFile back using
499 * g_file_parse_name().
501 * This is generally used to show the #GFile as a nice
502 * full-pathname kind of string in a user interface,
503 * like in a location entry.
505 * For local files with names that can safely be converted
506 * to UTF8 the pathname is used, otherwise the IRI is used
507 * (a form of URI that allows UTF8 characters unescaped).
509 * This call does no blocking i/o.
511 * Returns: a string containing the #GFile's parse name. The returned
512 * string should be freed with g_free() when no longer needed.
515 g_file_get_parse_name (GFile *file)
519 g_return_val_if_fail (G_IS_FILE (file), NULL);
521 iface = G_FILE_GET_IFACE (file);
523 return (* iface->get_parse_name) (file);
528 * @file: input #GFile.
530 * Duplicates a #GFile handle. This operation does not duplicate
531 * the actual file or directory represented by the #GFile; see
532 * g_file_copy() if attempting to copy a file.
534 * This call does no blocking i/o.
536 * Returns: (transfer full): a new #GFile that is a duplicate of the given #GFile.
539 g_file_dup (GFile *file)
543 g_return_val_if_fail (G_IS_FILE (file), NULL);
545 iface = G_FILE_GET_IFACE (file);
547 return (* iface->dup) (file);
552 * @file: (type GFile): #gconstpointer to a #GFile.
554 * Creates a hash value for a #GFile.
556 * This call does no blocking i/o.
559 * Returns: 0 if @file is not a valid #GFile, otherwise an
560 * integer that can be used as hash value for the #GFile.
561 * This function is intended for easily hashing a #GFile to
562 * add to a #GHashTable or similar data structure.
565 g_file_hash (gconstpointer file)
569 g_return_val_if_fail (G_IS_FILE (file), 0);
571 iface = G_FILE_GET_IFACE (file);
573 return (* iface->hash) ((GFile *)file);
578 * @file1: the first #GFile.
579 * @file2: the second #GFile.
581 * Checks equality of two given #GFile<!-- -->s. Note that two
582 * #GFile<!-- -->s that differ can still refer to the same
583 * file on the filesystem due to various forms of filename
586 * This call does no blocking i/o.
588 * Returns: %TRUE if @file1 and @file2 are equal.
589 * %FALSE if either is not a #GFile.
592 g_file_equal (GFile *file1,
597 g_return_val_if_fail (G_IS_FILE (file1), FALSE);
598 g_return_val_if_fail (G_IS_FILE (file2), FALSE);
600 if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2))
603 iface = G_FILE_GET_IFACE (file1);
605 return (* iface->equal) (file1, file2);
611 * @file: input #GFile.
613 * Gets the parent directory for the @file.
614 * If the @file represents the root directory of the
615 * file system, then %NULL will be returned.
617 * This call does no blocking i/o.
619 * Returns: (transfer full): a #GFile structure to the parent of the given
620 * #GFile or %NULL if there is no parent.
621 * Free the returned object with g_object_unref().
624 g_file_get_parent (GFile *file)
628 g_return_val_if_fail (G_IS_FILE (file), NULL);
630 iface = G_FILE_GET_IFACE (file);
632 return (* iface->get_parent) (file);
637 * @file: input #GFile
638 * @parent: (allow-none): the parent to check for, or %NULL
640 * Checks if @file has a parent, and optionally, if it is @parent.
642 * If @parent is %NULL then this function returns %TRUE if @file has any
643 * parent at all. If @parent is non-%NULL then %TRUE is only returned
644 * if @file is a child of @parent.
646 * Returns: %TRUE if @file is a child of @parent (or any parent in the
647 * case that @parent is %NULL).
652 g_file_has_parent (GFile *file,
655 GFile *actual_parent;
658 g_return_val_if_fail (G_IS_FILE (file), FALSE);
659 g_return_val_if_fail (parent == NULL || G_IS_FILE (parent), FALSE);
661 actual_parent = g_file_get_parent (file);
663 if (actual_parent != NULL)
666 result = g_file_equal (parent, actual_parent);
670 g_object_unref (actual_parent);
680 * @file: input #GFile.
681 * @name: string containing the child's basename.
683 * Gets a child of @file with basename equal to @name.
685 * Note that the file with that specific name might not exist, but
686 * you can still have a #GFile that points to it. You can use this
687 * for instance to create that file.
689 * This call does no blocking i/o.
691 * Returns: (transfer full): a #GFile to a child specified by @name.
692 * Free the returned object with g_object_unref().
695 g_file_get_child (GFile *file,
698 g_return_val_if_fail (G_IS_FILE (file), NULL);
699 g_return_val_if_fail (name != NULL, NULL);
701 return g_file_resolve_relative_path (file, name);
705 * g_file_get_child_for_display_name:
706 * @file: input #GFile.
707 * @display_name: string to a possible child.
710 * Gets the child of @file for a given @display_name (i.e. a UTF8
711 * version of the name). If this function fails, it returns %NULL and @error will be
712 * set. This is very useful when constructing a GFile for a new file
713 * and the user entered the filename in the user interface, for instance
714 * when you select a directory and type a filename in the file selector.
716 * This call does no blocking i/o.
718 * Returns: (transfer full): a #GFile to the specified child, or
719 * %NULL if the display name couldn't be converted.
720 * Free the returned object with g_object_unref().
723 g_file_get_child_for_display_name (GFile *file,
724 const char *display_name,
729 g_return_val_if_fail (G_IS_FILE (file), NULL);
730 g_return_val_if_fail (display_name != NULL, NULL);
732 iface = G_FILE_GET_IFACE (file);
734 return (* iface->get_child_for_display_name) (file, display_name, error);
739 * @file: input #GFile.
740 * @prefix: input #GFile.
742 * Checks whether @file has the prefix specified by @prefix. In other word,
743 * if the names of initial elements of @file<!-- -->s pathname match @prefix.
744 * Only full pathname elements are matched, so a path like /foo is not
745 * considered a prefix of /foobar, only of /foo/bar.
747 * This call does no i/o, as it works purely on names. As such it can
748 * sometimes return %FALSE even if @file is inside a @prefix (from a
749 * filesystem point of view), because the prefix of @file is an alias
752 * Virtual: prefix_matches
753 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix.
757 g_file_has_prefix (GFile *file,
762 g_return_val_if_fail (G_IS_FILE (file), FALSE);
763 g_return_val_if_fail (G_IS_FILE (prefix), FALSE);
765 if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix))
768 iface = G_FILE_GET_IFACE (file);
770 /* The vtable function differs in arg order since we're
771 using the old contains_file call */
772 return (* iface->prefix_matches) (prefix, file);
776 * g_file_get_relative_path:
777 * @parent: input #GFile.
778 * @descendant: input #GFile.
780 * Gets the path for @descendant relative to @parent.
782 * This call does no blocking i/o.
784 * Returns: string with the relative path from @descendant
785 * to @parent, or %NULL if @descendant doesn't have @parent as prefix.
786 * The returned string should be freed with g_free() when no longer needed.
789 g_file_get_relative_path (GFile *parent,
794 g_return_val_if_fail (G_IS_FILE (parent), NULL);
795 g_return_val_if_fail (G_IS_FILE (descendant), NULL);
797 if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant))
800 iface = G_FILE_GET_IFACE (parent);
802 return (* iface->get_relative_path) (parent, descendant);
806 * g_file_resolve_relative_path:
807 * @file: input #GFile.
808 * @relative_path: a given relative path string.
810 * Resolves a relative path for @file to an absolute path.
812 * This call does no blocking i/o.
814 * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path
815 * is %NULL or if @file is invalid.
816 * Free the returned object with g_object_unref().
819 g_file_resolve_relative_path (GFile *file,
820 const char *relative_path)
824 g_return_val_if_fail (G_IS_FILE (file), NULL);
825 g_return_val_if_fail (relative_path != NULL, NULL);
827 iface = G_FILE_GET_IFACE (file);
829 return (* iface->resolve_relative_path) (file, relative_path);
833 * g_file_enumerate_children:
834 * @file: input #GFile.
835 * @attributes: an attribute query string.
836 * @flags: a set of #GFileQueryInfoFlags.
837 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
838 * @error: #GError for error reporting.
840 * Gets the requested information about the files in a directory. The result
841 * is a #GFileEnumerator object that will give out #GFileInfo objects for
842 * all the files in the directory.
844 * The @attributes value is a string that specifies the file attributes that
845 * should be gathered. It is not an error if it's not possible to read a particular
846 * requested attribute from a file - it just won't be set. @attributes should
847 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
848 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
849 * namespace. An example attribute query be "standard::*,owner::user".
850 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
852 * If @cancellable is not %NULL, then the operation can be cancelled by
853 * triggering the cancellable object from another thread. If the operation
854 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
856 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
857 * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned.
858 * Other errors are possible too.
860 * Returns: (transfer full): A #GFileEnumerator if successful, %NULL on error.
861 * Free the returned object with g_object_unref().
864 g_file_enumerate_children (GFile *file,
865 const char *attributes,
866 GFileQueryInfoFlags flags,
867 GCancellable *cancellable,
873 g_return_val_if_fail (G_IS_FILE (file), NULL);
875 if (g_cancellable_set_error_if_cancelled (cancellable, error))
878 iface = G_FILE_GET_IFACE (file);
880 if (iface->enumerate_children == NULL)
882 g_set_error_literal (error, G_IO_ERROR,
883 G_IO_ERROR_NOT_SUPPORTED,
884 _("Operation not supported"));
888 return (* iface->enumerate_children) (file, attributes, flags,
893 * g_file_enumerate_children_async:
894 * @file: input #GFile.
895 * @attributes: an attribute query string.
896 * @flags: a set of #GFileQueryInfoFlags.
897 * @io_priority: the <link linkend="io-priority">I/O priority</link>
899 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
900 * @callback: (scope async) : a #GAsyncReadyCallback to call when the
901 * request is satisfied
902 * @user_data: (closure): the data to pass to callback function
904 * Asynchronously gets the requested information about the files in a directory. The result
905 * is a #GFileEnumerator object that will give out #GFileInfo objects for
906 * all the files in the directory.
908 * For more details, see g_file_enumerate_children() which is
909 * the synchronous version of this call.
911 * When the operation is finished, @callback will be called. You can then call
912 * g_file_enumerate_children_finish() to get the result of the operation.
915 g_file_enumerate_children_async (GFile *file,
916 const char *attributes,
917 GFileQueryInfoFlags flags,
919 GCancellable *cancellable,
920 GAsyncReadyCallback callback,
925 g_return_if_fail (G_IS_FILE (file));
927 iface = G_FILE_GET_IFACE (file);
928 (* iface->enumerate_children_async) (file,
938 * g_file_enumerate_children_finish:
939 * @file: input #GFile.
940 * @res: a #GAsyncResult.
943 * Finishes an async enumerate children operation.
944 * See g_file_enumerate_children_async().
946 * Returns: (transfer full): a #GFileEnumerator or %NULL if an error occurred.
947 * Free the returned object with g_object_unref().
950 g_file_enumerate_children_finish (GFile *file,
956 g_return_val_if_fail (G_IS_FILE (file), NULL);
957 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
959 if (g_async_result_legacy_propagate_error (res, error))
962 iface = G_FILE_GET_IFACE (file);
963 return (* iface->enumerate_children_finish) (file, res, error);
967 * g_file_query_exists:
968 * @file: input #GFile.
969 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
971 * Utility function to check if a particular file exists. This is
972 * implemented using g_file_query_info() and as such does blocking I/O.
974 * Note that in many cases it is racy to first check for file existence
975 * and then execute something based on the outcome of that, because the
976 * file might have been created or removed in between the operations. The
977 * general approach to handling that is to not check, but just do the
978 * operation and handle the errors as they come.
980 * As an example of race-free checking, take the case of reading a file, and
981 * if it doesn't exist, creating it. There are two racy versions: read it, and
982 * on error create it; and: check if it exists, if not create it. These
983 * can both result in two processes creating the file (with perhaps a partially
984 * written file as the result). The correct approach is to always try to create
985 * the file with g_file_create() which will either atomically create the file
986 * or fail with a G_IO_ERROR_EXISTS error.
988 * However, in many cases an existence check is useful in a user
989 * interface, for instance to make a menu item sensitive/insensitive, so that
990 * you don't have to fool users that something is possible and then just show
991 * and error dialog. If you do this, you should make sure to also handle the
992 * errors that can happen due to races when you execute the operation.
994 * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled).
997 g_file_query_exists (GFile *file,
998 GCancellable *cancellable)
1002 g_return_val_if_fail (G_IS_FILE(file), FALSE);
1004 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE,
1005 G_FILE_QUERY_INFO_NONE, cancellable, NULL);
1008 g_object_unref (info);
1016 * g_file_query_file_type:
1017 * @file: input #GFile.
1018 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info().
1019 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1021 * Utility function to inspect the #GFileType of a file. This is
1022 * implemented using g_file_query_info() and as such does blocking I/O.
1024 * The primary use case of this method is to check if a file is a regular file,
1025 * directory, or symlink.
1027 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file
1033 g_file_query_file_type (GFile *file,
1034 GFileQueryInfoFlags flags,
1035 GCancellable *cancellable)
1038 GFileType file_type;
1040 g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN);
1041 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags,
1045 file_type = g_file_info_get_file_type (info);
1046 g_object_unref (info);
1049 file_type = G_FILE_TYPE_UNKNOWN;
1055 * g_file_query_info:
1056 * @file: input #GFile.
1057 * @attributes: an attribute query string.
1058 * @flags: a set of #GFileQueryInfoFlags.
1059 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1060 * @error: a #GError.
1062 * Gets the requested information about specified @file. The result
1063 * is a #GFileInfo object that contains key-value attributes (such as
1064 * the type or size of the file).
1066 * The @attributes value is a string that specifies the file attributes that
1067 * should be gathered. It is not an error if it's not possible to read a particular
1068 * requested attribute from a file - it just won't be set. @attributes should
1069 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
1070 * means all attributes, and a wildcard like "standard::*" means all attributes in the standard
1071 * namespace. An example attribute query be "standard::*,owner::user".
1072 * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME.
1074 * If @cancellable is not %NULL, then the operation can be cancelled by
1075 * triggering the cancellable object from another thread. If the operation
1076 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1078 * For symlinks, normally the information about the target of the
1079 * symlink is returned, rather than information about the symlink itself.
1080 * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the
1081 * information about the symlink itself will be returned. Also, for symlinks
1082 * that point to non-existing files the information about the symlink itself
1085 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1086 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1088 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error.
1089 * Free the returned object with g_object_unref().
1092 g_file_query_info (GFile *file,
1093 const char *attributes,
1094 GFileQueryInfoFlags flags,
1095 GCancellable *cancellable,
1100 g_return_val_if_fail (G_IS_FILE (file), NULL);
1102 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1105 iface = G_FILE_GET_IFACE (file);
1107 if (iface->query_info == NULL)
1109 g_set_error_literal (error, G_IO_ERROR,
1110 G_IO_ERROR_NOT_SUPPORTED,
1111 _("Operation not supported"));
1115 return (* iface->query_info) (file, attributes, flags, cancellable, error);
1119 * g_file_query_info_async:
1120 * @file: input #GFile.
1121 * @attributes: an attribute query string.
1122 * @flags: a set of #GFileQueryInfoFlags.
1123 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1125 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1126 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1127 * @user_data: (closure): the data to pass to callback function
1129 * Asynchronously gets the requested information about specified @file. The result
1130 * is a #GFileInfo object that contains key-value attributes (such as type or size
1133 * For more details, see g_file_query_info() which is
1134 * the synchronous version of this call.
1136 * When the operation is finished, @callback will be called. You can then call
1137 * g_file_query_info_finish() to get the result of the operation.
1140 g_file_query_info_async (GFile *file,
1141 const char *attributes,
1142 GFileQueryInfoFlags flags,
1144 GCancellable *cancellable,
1145 GAsyncReadyCallback callback,
1150 g_return_if_fail (G_IS_FILE (file));
1152 iface = G_FILE_GET_IFACE (file);
1153 (* iface->query_info_async) (file,
1163 * g_file_query_info_finish:
1164 * @file: input #GFile.
1165 * @res: a #GAsyncResult.
1166 * @error: a #GError.
1168 * Finishes an asynchronous file info query.
1169 * See g_file_query_info_async().
1171 * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
1172 * Free the returned object with g_object_unref().
1175 g_file_query_info_finish (GFile *file,
1181 g_return_val_if_fail (G_IS_FILE (file), NULL);
1182 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1184 if (g_async_result_legacy_propagate_error (res, error))
1187 iface = G_FILE_GET_IFACE (file);
1188 return (* iface->query_info_finish) (file, res, error);
1192 * g_file_query_filesystem_info:
1193 * @file: input #GFile.
1194 * @attributes: an attribute query string.
1195 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1196 * @error: a #GError.
1198 * Similar to g_file_query_info(), but obtains information
1199 * about the filesystem the @file is on, rather than the file itself.
1200 * For instance the amount of space available and the type of
1203 * The @attributes value is a string that specifies the file attributes that
1204 * should be gathered. It is not an error if it's not possible to read a particular
1205 * requested attribute from a file - it just won't be set. @attributes should
1206 * be a comma-separated list of attributes or attribute wildcards. The wildcard "*"
1207 * means all attributes, and a wildcard like "filesystem::*" means all attributes in the
1208 * filesystem namespace. The standard namespace for filesystem attributes is "filesystem".
1209 * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE
1210 * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of
1211 * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1213 * If @cancellable is not %NULL, then the operation can be cancelled by
1214 * triggering the cancellable object from another thread. If the operation
1215 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1217 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1218 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1220 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1221 * Free the returned object with g_object_unref().
1224 g_file_query_filesystem_info (GFile *file,
1225 const char *attributes,
1226 GCancellable *cancellable,
1231 g_return_val_if_fail (G_IS_FILE (file), NULL);
1233 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1236 iface = G_FILE_GET_IFACE (file);
1238 if (iface->query_filesystem_info == NULL)
1240 g_set_error_literal (error, G_IO_ERROR,
1241 G_IO_ERROR_NOT_SUPPORTED,
1242 _("Operation not supported"));
1246 return (* iface->query_filesystem_info) (file, attributes, cancellable, error);
1250 * g_file_query_filesystem_info_async:
1251 * @file: input #GFile.
1252 * @attributes: an attribute query string.
1253 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1255 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1256 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1257 * @user_data: (closure): the data to pass to callback function
1259 * Asynchronously gets the requested information about the filesystem
1260 * that the specified @file is on. The result is a #GFileInfo object
1261 * that contains key-value attributes (such as type or size for the
1264 * For more details, see g_file_query_filesystem_info() which is the
1265 * synchronous version of this call.
1267 * When the operation is finished, @callback will be called. You can
1268 * then call g_file_query_info_finish() to get the result of the
1272 g_file_query_filesystem_info_async (GFile *file,
1273 const char *attributes,
1275 GCancellable *cancellable,
1276 GAsyncReadyCallback callback,
1281 g_return_if_fail (G_IS_FILE (file));
1283 iface = G_FILE_GET_IFACE (file);
1284 (* iface->query_filesystem_info_async) (file,
1293 * g_file_query_filesystem_info_finish:
1294 * @file: input #GFile.
1295 * @res: a #GAsyncResult.
1296 * @error: a #GError.
1298 * Finishes an asynchronous filesystem info query. See
1299 * g_file_query_filesystem_info_async().
1301 * Returns: (transfer full): #GFileInfo for given @file or %NULL on error.
1302 * Free the returned object with g_object_unref().
1305 g_file_query_filesystem_info_finish (GFile *file,
1311 g_return_val_if_fail (G_IS_FILE (file), NULL);
1312 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1314 if (g_async_result_legacy_propagate_error (res, error))
1317 iface = G_FILE_GET_IFACE (file);
1318 return (* iface->query_filesystem_info_finish) (file, res, error);
1322 * g_file_find_enclosing_mount:
1323 * @file: input #GFile.
1324 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1325 * @error: a #GError.
1327 * Gets a #GMount for the #GFile.
1329 * If the #GFileIface for @file does not have a mount (e.g. possibly a
1330 * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL
1333 * If @cancellable is not %NULL, then the operation can be cancelled by
1334 * triggering the cancellable object from another thread. If the operation
1335 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1337 * Returns: (transfer full): a #GMount where the @file is located or %NULL on error.
1338 * Free the returned object with g_object_unref().
1341 g_file_find_enclosing_mount (GFile *file,
1342 GCancellable *cancellable,
1347 g_return_val_if_fail (G_IS_FILE (file), NULL);
1349 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1352 iface = G_FILE_GET_IFACE (file);
1353 if (iface->find_enclosing_mount == NULL)
1356 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND,
1357 /* Translators: This is an error message when trying to find the
1358 * enclosing (user visible) mount of a file, but none exists. */
1359 _("Containing mount does not exist"));
1363 return (* iface->find_enclosing_mount) (file, cancellable, error);
1367 * g_file_find_enclosing_mount_async:
1369 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1371 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1372 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1373 * @user_data: (closure): the data to pass to callback function
1375 * Asynchronously gets the mount for the file.
1377 * For more details, see g_file_find_enclosing_mount() which is
1378 * the synchronous version of this call.
1380 * When the operation is finished, @callback will be called. You can then call
1381 * g_file_find_enclosing_mount_finish() to get the result of the operation.
1384 g_file_find_enclosing_mount_async (GFile *file,
1386 GCancellable *cancellable,
1387 GAsyncReadyCallback callback,
1392 g_return_if_fail (G_IS_FILE (file));
1394 iface = G_FILE_GET_IFACE (file);
1395 (* iface->find_enclosing_mount_async) (file,
1403 * g_file_find_enclosing_mount_finish:
1405 * @res: a #GAsyncResult
1408 * Finishes an asynchronous find mount request.
1409 * See g_file_find_enclosing_mount_async().
1411 * Returns: (transfer full): #GMount for given @file or %NULL on error.
1412 * Free the returned object with g_object_unref().
1415 g_file_find_enclosing_mount_finish (GFile *file,
1421 g_return_val_if_fail (G_IS_FILE (file), NULL);
1422 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1424 if (g_async_result_legacy_propagate_error (res, error))
1427 iface = G_FILE_GET_IFACE (file);
1428 return (* iface->find_enclosing_mount_finish) (file, res, error);
1434 * @file: #GFile to read.
1435 * @cancellable: (allow-none): a #GCancellable
1436 * @error: a #GError, or %NULL
1438 * Opens a file for reading. The result is a #GFileInputStream that
1439 * can be used to read the contents of the file.
1441 * If @cancellable is not %NULL, then the operation can be cancelled by
1442 * triggering the cancellable object from another thread. If the operation
1443 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1445 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1446 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1447 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1450 * Returns: (transfer full): #GFileInputStream or %NULL on error.
1451 * Free the returned object with g_object_unref().
1454 g_file_read (GFile *file,
1455 GCancellable *cancellable,
1460 g_return_val_if_fail (G_IS_FILE (file), NULL);
1462 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1465 iface = G_FILE_GET_IFACE (file);
1467 if (iface->read_fn == NULL)
1469 g_set_error_literal (error, G_IO_ERROR,
1470 G_IO_ERROR_NOT_SUPPORTED,
1471 _("Operation not supported"));
1475 return (* iface->read_fn) (file, cancellable, error);
1480 * @file: input #GFile.
1481 * @flags: a set of #GFileCreateFlags.
1482 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1483 * @error: a #GError, or %NULL
1485 * Gets an output stream for appending data to the file. If
1486 * the file doesn't already exist it is created.
1488 * By default files created are generally readable by everyone,
1489 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1490 * will be made readable only to the current user, to the level that
1491 * is supported on the target filesystem.
1493 * If @cancellable is not %NULL, then the operation can be cancelled by
1494 * triggering the cancellable object from another thread. If the operation
1495 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1497 * Some file systems don't allow all file names, and may
1498 * return an %G_IO_ERROR_INVALID_FILENAME error.
1499 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be
1500 * returned. Other errors are possible too, and depend on what kind of
1501 * filesystem the file is on.
1503 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1504 * Free the returned object with g_object_unref().
1507 g_file_append_to (GFile *file,
1508 GFileCreateFlags flags,
1509 GCancellable *cancellable,
1514 g_return_val_if_fail (G_IS_FILE (file), NULL);
1516 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1519 iface = G_FILE_GET_IFACE (file);
1521 if (iface->append_to == NULL)
1523 g_set_error_literal (error, G_IO_ERROR,
1524 G_IO_ERROR_NOT_SUPPORTED,
1525 _("Operation not supported"));
1529 return (* iface->append_to) (file, flags, cancellable, error);
1534 * @file: input #GFile.
1535 * @flags: a set of #GFileCreateFlags.
1536 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1537 * @error: a #GError, or %NULL
1539 * Creates a new file and returns an output stream for writing to it.
1540 * The file must not already exist.
1542 * By default files created are generally readable by everyone,
1543 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1544 * will be made readable only to the current user, to the level that
1545 * is supported on the target filesystem.
1547 * If @cancellable is not %NULL, then the operation can be cancelled by
1548 * triggering the cancellable object from another thread. If the operation
1549 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1551 * If a file or directory with this name already exists the G_IO_ERROR_EXISTS
1552 * error will be returned.
1553 * Some file systems don't allow all file names, and may
1554 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1555 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1556 * Other errors are possible too, and depend on what kind of
1557 * filesystem the file is on.
1559 * Returns: (transfer full): a #GFileOutputStream for the newly created file, or
1561 * Free the returned object with g_object_unref().
1564 g_file_create (GFile *file,
1565 GFileCreateFlags flags,
1566 GCancellable *cancellable,
1571 g_return_val_if_fail (G_IS_FILE (file), NULL);
1573 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1576 iface = G_FILE_GET_IFACE (file);
1578 if (iface->create == NULL)
1580 g_set_error_literal (error, G_IO_ERROR,
1581 G_IO_ERROR_NOT_SUPPORTED,
1582 _("Operation not supported"));
1586 return (* iface->create) (file, flags, cancellable, error);
1591 * @file: input #GFile.
1592 * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the
1593 * current #GFile, or #NULL to ignore.
1594 * @make_backup: %TRUE if a backup should be created.
1595 * @flags: a set of #GFileCreateFlags.
1596 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1597 * @error: a #GError, or %NULL
1599 * Returns an output stream for overwriting the file, possibly
1600 * creating a backup copy of the file first. If the file doesn't exist,
1601 * it will be created.
1603 * This will try to replace the file in the safest way possible so
1604 * that any errors during the writing will not affect an already
1605 * existing copy of the file. For instance, for local files it
1606 * may write to a temporary file and then atomically rename over
1607 * the destination when the stream is closed.
1609 * By default files created are generally readable by everyone,
1610 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1611 * will be made readable only to the current user, to the level that
1612 * is supported on the target filesystem.
1614 * If @cancellable is not %NULL, then the operation can be cancelled by
1615 * triggering the cancellable object from another thread. If the operation
1616 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1618 * If you pass in a non-#NULL @etag value, then this value is
1619 * compared to the current entity tag of the file, and if they differ
1620 * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means
1621 * that the file has been changed since you last read it. You can get
1622 * the new etag from g_file_output_stream_get_etag() after you've
1623 * finished writing and closed the #GFileOutputStream. When you load
1624 * a new file you can use g_file_input_stream_query_info() to get
1625 * the etag of the file.
1627 * If @make_backup is %TRUE, this function will attempt to make a backup
1628 * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP
1629 * error will be returned. If you want to replace anyway, try again with
1630 * @make_backup set to %FALSE.
1632 * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned,
1633 * and if the file is some other form of non-regular file then a
1634 * G_IO_ERROR_NOT_REGULAR_FILE error will be returned.
1635 * Some file systems don't allow all file names, and may
1636 * return an G_IO_ERROR_INVALID_FILENAME error, and if the name
1637 * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned.
1638 * Other errors are possible too, and depend on what kind of
1639 * filesystem the file is on.
1641 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1642 * Free the returned object with g_object_unref().
1645 g_file_replace (GFile *file,
1647 gboolean make_backup,
1648 GFileCreateFlags flags,
1649 GCancellable *cancellable,
1654 g_return_val_if_fail (G_IS_FILE (file), NULL);
1656 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1659 iface = G_FILE_GET_IFACE (file);
1661 if (iface->replace == NULL)
1663 g_set_error_literal (error, G_IO_ERROR,
1664 G_IO_ERROR_NOT_SUPPORTED,
1665 _("Operation not supported"));
1670 /* Handle empty tag string as NULL in consistent way. */
1671 if (etag && *etag == 0)
1674 return (* iface->replace) (file, etag, make_backup, flags, cancellable, error);
1678 * g_file_open_readwrite:
1679 * @file: #GFile to open
1680 * @cancellable: (allow-none): a #GCancellable
1681 * @error: a #GError, or %NULL
1683 * Opens an existing file for reading and writing. The result is
1684 * a #GFileIOStream that can be used to read and write the contents of the file.
1686 * If @cancellable is not %NULL, then the operation can be cancelled by
1687 * triggering the cancellable object from another thread. If the operation
1688 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1690 * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned.
1691 * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned.
1692 * Other errors are possible too, and depend on what kind of filesystem the file is on.
1693 * Note that in many non-local file cases read and write streams are not supported,
1694 * so make sure you really need to do read and write streaming, rather than
1695 * just opening for reading or writing.
1697 * Returns: (transfer full): #GFileIOStream or %NULL on error.
1698 * Free the returned object with g_object_unref().
1703 g_file_open_readwrite (GFile *file,
1704 GCancellable *cancellable,
1709 g_return_val_if_fail (G_IS_FILE (file), NULL);
1711 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1714 iface = G_FILE_GET_IFACE (file);
1716 if (iface->open_readwrite == NULL)
1718 g_set_error_literal (error, G_IO_ERROR,
1719 G_IO_ERROR_NOT_SUPPORTED,
1720 _("Operation not supported"));
1724 return (* iface->open_readwrite) (file, cancellable, error);
1728 * g_file_create_readwrite:
1730 * @flags: a set of #GFileCreateFlags
1731 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
1732 * @error: return location for a #GError, or %NULL
1734 * Creates a new file and returns a stream for reading and writing to it.
1735 * The file must not already exist.
1737 * By default files created are generally readable by everyone,
1738 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1739 * will be made readable only to the current user, to the level that
1740 * is supported on the target filesystem.
1742 * If @cancellable is not %NULL, then the operation can be cancelled by
1743 * triggering the cancellable object from another thread. If the operation
1744 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1746 * If a file or directory with this name already exists the %G_IO_ERROR_EXISTS
1747 * error will be returned. Some file systems don't allow all file names,
1748 * and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name
1749 * is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors
1750 * are possible too, and depend on what kind of filesystem the file is on.
1752 * Note that in many non-local file cases read and write streams are not
1753 * supported, so make sure you really need to do read and write streaming,
1754 * rather than just opening for reading or writing.
1756 * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error.
1757 * Free the returned object with g_object_unref().
1762 g_file_create_readwrite (GFile *file,
1763 GFileCreateFlags flags,
1764 GCancellable *cancellable,
1769 g_return_val_if_fail (G_IS_FILE (file), NULL);
1771 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1774 iface = G_FILE_GET_IFACE (file);
1776 if (iface->create_readwrite == NULL)
1778 g_set_error_literal (error, G_IO_ERROR,
1779 G_IO_ERROR_NOT_SUPPORTED,
1780 _("Operation not supported"));
1784 return (* iface->create_readwrite) (file, flags, cancellable, error);
1788 * g_file_replace_readwrite:
1790 * @etag: (allow-none): an optional <link linkend="gfile-etag">entity tag</link> for the
1791 * current #GFile, or #NULL to ignore
1792 * @make_backup: %TRUE if a backup should be created
1793 * @flags: a set of #GFileCreateFlags
1794 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
1795 * @error: return location for a #GError, or %NULL
1797 * Returns an output stream for overwriting the file in readwrite mode,
1798 * possibly creating a backup copy of the file first. If the file doesn't
1799 * exist, it will be created.
1801 * For details about the behaviour, see g_file_replace() which does the same
1802 * thing but returns an output stream only.
1804 * Note that in many non-local file cases read and write streams are not
1805 * supported, so make sure you really need to do read and write streaming,
1806 * rather than just opening for reading or writing.
1808 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
1809 * Free the returned object with g_object_unref().
1814 g_file_replace_readwrite (GFile *file,
1816 gboolean make_backup,
1817 GFileCreateFlags flags,
1818 GCancellable *cancellable,
1823 g_return_val_if_fail (G_IS_FILE (file), NULL);
1825 if (g_cancellable_set_error_if_cancelled (cancellable, error))
1828 iface = G_FILE_GET_IFACE (file);
1830 if (iface->replace_readwrite == NULL)
1832 g_set_error_literal (error, G_IO_ERROR,
1833 G_IO_ERROR_NOT_SUPPORTED,
1834 _("Operation not supported"));
1838 return (* iface->replace_readwrite) (file, etag, make_backup, flags, cancellable, error);
1842 * g_file_read_async:
1843 * @file: input #GFile
1844 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1846 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1847 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1848 * @user_data: (closure): the data to pass to callback function
1850 * Asynchronously opens @file for reading.
1852 * For more details, see g_file_read() which is
1853 * the synchronous version of this call.
1855 * When the operation is finished, @callback will be called. You can then call
1856 * g_file_read_finish() to get the result of the operation.
1859 g_file_read_async (GFile *file,
1861 GCancellable *cancellable,
1862 GAsyncReadyCallback callback,
1867 g_return_if_fail (G_IS_FILE (file));
1869 iface = G_FILE_GET_IFACE (file);
1870 (* iface->read_async) (file,
1878 * g_file_read_finish:
1879 * @file: input #GFile.
1880 * @res: a #GAsyncResult.
1881 * @error: a #GError, or %NULL
1883 * Finishes an asynchronous file read operation started with
1884 * g_file_read_async().
1886 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
1887 * Free the returned object with g_object_unref().
1890 g_file_read_finish (GFile *file,
1896 g_return_val_if_fail (G_IS_FILE (file), NULL);
1897 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1899 if (g_async_result_legacy_propagate_error (res, error))
1902 iface = G_FILE_GET_IFACE (file);
1903 return (* iface->read_finish) (file, res, error);
1907 * g_file_append_to_async:
1908 * @file: input #GFile.
1909 * @flags: a set of #GFileCreateFlags.
1910 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1912 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1913 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1914 * @user_data: (closure): the data to pass to callback function
1916 * Asynchronously opens @file for appending.
1918 * For more details, see g_file_append_to() which is
1919 * the synchronous version of this call.
1921 * When the operation is finished, @callback will be called. You can then call
1922 * g_file_append_to_finish() to get the result of the operation.
1925 g_file_append_to_async (GFile *file,
1926 GFileCreateFlags flags,
1928 GCancellable *cancellable,
1929 GAsyncReadyCallback callback,
1934 g_return_if_fail (G_IS_FILE (file));
1936 iface = G_FILE_GET_IFACE (file);
1937 (* iface->append_to_async) (file,
1946 * g_file_append_to_finish:
1947 * @file: input #GFile.
1948 * @res: #GAsyncResult
1949 * @error: a #GError, or %NULL
1951 * Finishes an asynchronous file append operation started with
1952 * g_file_append_to_async().
1954 * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error.
1955 * Free the returned object with g_object_unref().
1958 g_file_append_to_finish (GFile *file,
1964 g_return_val_if_fail (G_IS_FILE (file), NULL);
1965 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
1967 if (g_async_result_legacy_propagate_error (res, error))
1970 iface = G_FILE_GET_IFACE (file);
1971 return (* iface->append_to_finish) (file, res, error);
1975 * g_file_create_async:
1976 * @file: input #GFile.
1977 * @flags: a set of #GFileCreateFlags.
1978 * @io_priority: the <link linkend="io-priority">I/O priority</link>
1980 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
1981 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
1982 * @user_data: (closure): the data to pass to callback function
1984 * Asynchronously creates a new file and returns an output stream for writing to it.
1985 * The file must not already exist.
1987 * For more details, see g_file_create() which is
1988 * the synchronous version of this call.
1990 * When the operation is finished, @callback will be called. You can then call
1991 * g_file_create_finish() to get the result of the operation.
1994 g_file_create_async (GFile *file,
1995 GFileCreateFlags flags,
1997 GCancellable *cancellable,
1998 GAsyncReadyCallback callback,
2003 g_return_if_fail (G_IS_FILE (file));
2005 iface = G_FILE_GET_IFACE (file);
2006 (* iface->create_async) (file,
2015 * g_file_create_finish:
2016 * @file: input #GFile.
2017 * @res: a #GAsyncResult.
2018 * @error: a #GError, or %NULL
2020 * Finishes an asynchronous file create operation started with
2021 * g_file_create_async().
2023 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2024 * Free the returned object with g_object_unref().
2027 g_file_create_finish (GFile *file,
2033 g_return_val_if_fail (G_IS_FILE (file), NULL);
2034 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2036 if (g_async_result_legacy_propagate_error (res, error))
2039 iface = G_FILE_GET_IFACE (file);
2040 return (* iface->create_finish) (file, res, error);
2044 * g_file_replace_async:
2045 * @file: input #GFile.
2046 * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the
2047 * current #GFile, or NULL to ignore.
2048 * @make_backup: %TRUE if a backup should be created.
2049 * @flags: a set of #GFileCreateFlags.
2050 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2052 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2053 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2054 * @user_data: (closure): the data to pass to callback function
2056 * Asynchronously overwrites the file, replacing the contents, possibly
2057 * creating a backup copy of the file first.
2059 * For more details, see g_file_replace() which is
2060 * the synchronous version of this call.
2062 * When the operation is finished, @callback will be called. You can then call
2063 * g_file_replace_finish() to get the result of the operation.
2066 g_file_replace_async (GFile *file,
2068 gboolean make_backup,
2069 GFileCreateFlags flags,
2071 GCancellable *cancellable,
2072 GAsyncReadyCallback callback,
2077 g_return_if_fail (G_IS_FILE (file));
2079 iface = G_FILE_GET_IFACE (file);
2080 (* iface->replace_async) (file,
2091 * g_file_replace_finish:
2092 * @file: input #GFile.
2093 * @res: a #GAsyncResult.
2094 * @error: a #GError, or %NULL
2096 * Finishes an asynchronous file replace operation started with
2097 * g_file_replace_async().
2099 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2100 * Free the returned object with g_object_unref().
2103 g_file_replace_finish (GFile *file,
2109 g_return_val_if_fail (G_IS_FILE (file), NULL);
2110 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2112 if (g_async_result_legacy_propagate_error (res, error))
2115 iface = G_FILE_GET_IFACE (file);
2116 return (* iface->replace_finish) (file, res, error);
2121 * g_file_open_readwrite_async:
2122 * @file: input #GFile.
2123 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2125 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2126 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2127 * @user_data: (closure): the data to pass to callback function
2129 * Asynchronously opens @file for reading and writing.
2131 * For more details, see g_file_open_readwrite() which is
2132 * the synchronous version of this call.
2134 * When the operation is finished, @callback will be called. You can then call
2135 * g_file_open_readwrite_finish() to get the result of the operation.
2140 g_file_open_readwrite_async (GFile *file,
2142 GCancellable *cancellable,
2143 GAsyncReadyCallback callback,
2148 g_return_if_fail (G_IS_FILE (file));
2150 iface = G_FILE_GET_IFACE (file);
2151 (* iface->open_readwrite_async) (file,
2159 * g_file_open_readwrite_finish:
2160 * @file: input #GFile.
2161 * @res: a #GAsyncResult.
2162 * @error: a #GError, or %NULL
2164 * Finishes an asynchronous file read operation started with
2165 * g_file_open_readwrite_async().
2167 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2168 * Free the returned object with g_object_unref().
2173 g_file_open_readwrite_finish (GFile *file,
2179 g_return_val_if_fail (G_IS_FILE (file), NULL);
2180 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2182 if (g_async_result_legacy_propagate_error (res, error))
2185 iface = G_FILE_GET_IFACE (file);
2186 return (* iface->open_readwrite_finish) (file, res, error);
2191 * g_file_create_readwrite_async:
2192 * @file: input #GFile
2193 * @flags: a set of #GFileCreateFlags
2194 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2196 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
2197 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2198 * @user_data: (closure): the data to pass to callback function
2200 * Asynchronously creates a new file and returns a stream for reading and
2201 * writing to it. The file must not already exist.
2203 * For more details, see g_file_create_readwrite() which is
2204 * the synchronous version of this call.
2206 * When the operation is finished, @callback will be called. You can then
2207 * call g_file_create_readwrite_finish() to get the result of the operation.
2212 g_file_create_readwrite_async (GFile *file,
2213 GFileCreateFlags flags,
2215 GCancellable *cancellable,
2216 GAsyncReadyCallback callback,
2221 g_return_if_fail (G_IS_FILE (file));
2223 iface = G_FILE_GET_IFACE (file);
2224 (* iface->create_readwrite_async) (file,
2233 * g_file_create_readwrite_finish:
2234 * @file: input #GFile
2235 * @res: a #GAsyncResult
2236 * @error: a #GError, or %NULL
2238 * Finishes an asynchronous file create operation started with
2239 * g_file_create_readwrite_async().
2241 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2242 * Free the returned object with g_object_unref().
2247 g_file_create_readwrite_finish (GFile *file,
2253 g_return_val_if_fail (G_IS_FILE (file), NULL);
2254 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2256 if (g_async_result_legacy_propagate_error (res, error))
2259 iface = G_FILE_GET_IFACE (file);
2260 return (* iface->create_readwrite_finish) (file, res, error);
2264 * g_file_replace_readwrite_async:
2265 * @file: input #GFile.
2266 * @etag: (allow-none): an <link linkend="gfile-etag">entity tag</link> for the
2267 * current #GFile, or NULL to ignore.
2268 * @make_backup: %TRUE if a backup should be created.
2269 * @flags: a set of #GFileCreateFlags.
2270 * @io_priority: the <link linkend="io-priority">I/O priority</link>
2272 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2273 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
2274 * @user_data: (closure): the data to pass to callback function
2276 * Asynchronously overwrites the file in read-write mode, replacing the
2277 * contents, possibly creating a backup copy of the file first.
2279 * For more details, see g_file_replace_readwrite() which is
2280 * the synchronous version of this call.
2282 * When the operation is finished, @callback will be called. You can then
2283 * call g_file_replace_readwrite_finish() to get the result of the operation.
2288 g_file_replace_readwrite_async (GFile *file,
2290 gboolean make_backup,
2291 GFileCreateFlags flags,
2293 GCancellable *cancellable,
2294 GAsyncReadyCallback callback,
2299 g_return_if_fail (G_IS_FILE (file));
2301 iface = G_FILE_GET_IFACE (file);
2302 (* iface->replace_readwrite_async) (file,
2313 * g_file_replace_readwrite_finish:
2314 * @file: input #GFile.
2315 * @res: a #GAsyncResult.
2316 * @error: a #GError, or %NULL
2318 * Finishes an asynchronous file replace operation started with
2319 * g_file_replace_readwrite_async().
2321 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2322 * Free the returned object with g_object_unref().
2327 g_file_replace_readwrite_finish (GFile *file,
2333 g_return_val_if_fail (G_IS_FILE (file), NULL);
2334 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
2336 if (g_async_result_legacy_propagate_error (res, error))
2339 iface = G_FILE_GET_IFACE (file);
2340 return (* iface->replace_readwrite_finish) (file, res, error);
2344 copy_symlink (GFile *destination,
2345 GFileCopyFlags flags,
2346 GCancellable *cancellable,
2351 gboolean tried_delete;
2353 GFileType file_type;
2355 tried_delete = FALSE;
2359 if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error))
2361 /* Maybe it already existed, and we want to overwrite? */
2362 if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) &&
2363 my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS)
2365 g_error_free (my_error);
2368 /* Don't overwrite if the destination is a directory */
2369 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2370 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2371 cancellable, &my_error);
2374 file_type = g_file_info_get_file_type (info);
2375 g_object_unref (info);
2377 if (file_type == G_FILE_TYPE_DIRECTORY)
2379 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY,
2380 _("Can't copy over directory"));
2385 if (!g_file_delete (destination, cancellable, error))
2388 tried_delete = TRUE;
2392 g_propagate_error (error, my_error);
2399 static GInputStream *
2400 open_source_for_copy (GFile *source,
2402 GFileCopyFlags flags,
2403 GCancellable *cancellable,
2409 GFileType file_type;
2412 in = (GInputStream *)g_file_read (source, cancellable, &my_error);
2416 /* There was an error opening the source, try to set a good error for it: */
2418 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY)
2420 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2421 * as that is less useful to the app. Better check for errors on the
2424 g_error_free (my_error);
2427 info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE,
2428 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2429 cancellable, &my_error);
2431 g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_TYPE))
2433 file_type = g_file_info_get_file_type (info);
2434 g_object_unref (info);
2436 if (flags & G_FILE_COPY_OVERWRITE)
2438 if (file_type == G_FILE_TYPE_DIRECTORY)
2440 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE,
2441 _("Can't copy directory over directory"));
2444 /* continue to would_recurse error */
2448 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS,
2449 _("Target file exists"));
2455 /* Error getting info from target, return that error
2456 * (except for NOT_FOUND, which is no error here)
2458 if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
2460 g_propagate_error (error, my_error);
2463 g_clear_error (&my_error);
2466 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE,
2467 _("Can't recursively copy directory"));
2471 g_propagate_error (error, my_error);
2476 should_copy (GFileAttributeInfo *info,
2478 gboolean skip_perms)
2480 if (skip_perms && strcmp(info->name, "unix::mode") == 0)
2484 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WHEN_MOVED;
2485 return info->flags & G_FILE_ATTRIBUTE_INFO_COPY_WITH_FILE;
2489 build_attribute_list_for_copy (GFileAttributeInfoList *attributes,
2490 GFileAttributeInfoList *namespaces,
2492 gboolean skip_perms)
2499 s = g_string_new ("");
2503 for (i = 0; i < attributes->n_infos; i++)
2505 if (should_copy (&attributes->infos[i], as_move, skip_perms))
2510 g_string_append_c (s, ',');
2512 g_string_append (s, attributes->infos[i].name);
2519 for (i = 0; i < namespaces->n_infos; i++)
2521 if (should_copy (&namespaces->infos[i], as_move, FALSE))
2526 g_string_append_c (s, ',');
2528 g_string_append (s, namespaces->infos[i].name);
2529 g_string_append (s, "::*");
2534 return g_string_free (s, FALSE);
2538 * g_file_copy_attributes:
2539 * @source: a #GFile with attributes.
2540 * @destination: a #GFile to copy attributes to.
2541 * @flags: a set of #GFileCopyFlags.
2542 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
2543 * @error: a #GError, %NULL to ignore.
2545 * Copies the file attributes from @source to @destination.
2547 * Normally only a subset of the file attributes are copied,
2548 * those that are copies in a normal file copy operation
2549 * (which for instance does not include e.g. owner). However
2550 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2551 * all the metadata that is possible to copy is copied. This
2552 * is useful when implementing move by copy + delete source.
2554 * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise.
2557 g_file_copy_attributes (GFile *source,
2559 GFileCopyFlags flags,
2560 GCancellable *cancellable,
2563 GFileAttributeInfoList *attributes, *namespaces;
2564 char *attrs_to_read;
2568 gboolean source_nofollow_symlinks;
2569 gboolean skip_perms;
2571 as_move = flags & G_FILE_COPY_ALL_METADATA;
2572 source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS;
2573 skip_perms = (flags & G_FILE_COPY_TARGET_DEFAULT_PERMS) != 0;
2575 /* Ignore errors here, if the target supports no attributes there is nothing to copy */
2576 attributes = g_file_query_settable_attributes (destination, cancellable, NULL);
2577 namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL);
2579 if (attributes == NULL && namespaces == NULL)
2582 attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move, skip_perms);
2584 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2585 * we just don't copy it.
2587 info = g_file_query_info (source, attrs_to_read,
2588 source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0,
2592 g_free (attrs_to_read);
2597 res = g_file_set_attributes_from_info (destination,
2599 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2602 g_object_unref (info);
2605 g_file_attribute_info_list_unref (attributes);
2606 g_file_attribute_info_list_unref (namespaces);
2612 copy_stream_with_progress (GInputStream *in,
2615 GCancellable *cancellable,
2616 GFileProgressCallback progress_callback,
2617 gpointer progress_callback_data,
2620 gssize n_read, n_written;
2621 goffset current_size;
2622 char buffer[1024*64], *p;
2628 /* avoid performance impact of querying total size when it's not needed */
2629 if (progress_callback)
2631 info = g_file_input_stream_query_info (G_FILE_INPUT_STREAM (in),
2632 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2636 if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2637 total_size = g_file_info_get_size (info);
2638 g_object_unref (info);
2641 if (total_size == -1)
2643 info = g_file_query_info (source,
2644 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2645 G_FILE_QUERY_INFO_NONE,
2649 if (g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_SIZE))
2650 total_size = g_file_info_get_size (info);
2651 g_object_unref (info);
2656 if (total_size == -1)
2663 n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error);
2673 current_size += n_read;
2678 n_written = g_output_stream_write (out, p, n_read, cancellable, error);
2679 if (n_written == -1)
2686 n_read -= n_written;
2692 if (progress_callback)
2693 progress_callback (current_size, total_size, progress_callback_data);
2696 /* Make sure we send full copied size */
2697 if (progress_callback)
2698 progress_callback (current_size, total_size, progress_callback_data);
2706 do_splice (int fd_in,
2711 long *bytes_transferd,
2717 result = splice (fd_in, off_in, fd_out, off_out, len, SPLICE_F_MORE);
2725 else if (errsv == ENOSYS || errsv == EINVAL)
2726 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2727 _("Splice not supported"));
2729 g_set_error (error, G_IO_ERROR,
2730 g_io_error_from_errno (errsv),
2731 _("Error splicing file: %s"),
2732 g_strerror (errsv));
2737 *bytes_transferd = result;
2742 splice_stream_with_progress (GInputStream *in,
2744 GCancellable *cancellable,
2745 GFileProgressCallback progress_callback,
2746 gpointer progress_callback_data,
2756 fd_in = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (in));
2757 fd_out = g_file_descriptor_based_get_fd (G_FILE_DESCRIPTOR_BASED (out));
2759 if (pipe (buffer) != 0)
2761 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2762 "Pipe creation failed");
2767 /* avoid performance impact of querying total size when it's not needed */
2768 if (progress_callback)
2772 if (fstat (fd_in, &sbuf) == 0)
2773 total_size = sbuf.st_size;
2776 if (total_size == -1)
2779 offset_in = offset_out = 0;
2786 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2789 if (!do_splice (fd_in, &offset_in, buffer[1], NULL, 1024*64, &n_read, error))
2800 if (g_cancellable_set_error_if_cancelled (cancellable, error))
2803 if (!do_splice (buffer[0], NULL, fd_out, &offset_out, n_read, &n_written, error))
2806 n_read -= n_written;
2809 if (progress_callback)
2810 progress_callback (offset_in, total_size, progress_callback_data);
2813 /* Make sure we send full copied size */
2814 if (progress_callback)
2815 progress_callback (offset_in, total_size, progress_callback_data);
2826 file_copy_fallback (GFile *source,
2828 GFileCopyFlags flags,
2829 GCancellable *cancellable,
2830 GFileProgressCallback progress_callback,
2831 gpointer progress_callback_data,
2840 gboolean fallback = TRUE;
2843 /* need to know the file type */
2844 info = g_file_query_info (source,
2845 G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET,
2846 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2853 /* Maybe copy the symlink? */
2854 if ((flags & G_FILE_COPY_NOFOLLOW_SYMLINKS) &&
2855 g_file_info_get_file_type (info) == G_FILE_TYPE_SYMBOLIC_LINK)
2857 target = g_file_info_get_symlink_target (info);
2860 if (!copy_symlink (destination, flags, cancellable, target, error))
2862 g_object_unref (info);
2866 g_object_unref (info);
2869 /* ... else fall back on a regular file copy */
2870 g_object_unref (info);
2872 /* Handle "special" files (pipes, device nodes, ...)? */
2873 else if (g_file_info_get_file_type (info) == G_FILE_TYPE_SPECIAL)
2875 /* FIXME: could try to recreate device nodes and others? */
2877 g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
2878 _("Can't copy special file"));
2879 g_object_unref (info);
2882 /* Everything else should just fall back on a regular copy. */
2884 g_object_unref (info);
2886 in = open_source_for_copy (source, destination, flags, cancellable, error);
2890 if (flags & G_FILE_COPY_OVERWRITE)
2892 out = (GOutputStream *)g_file_replace (destination,
2894 flags & G_FILE_COPY_BACKUP,
2895 G_FILE_CREATE_REPLACE_DESTINATION,
2896 cancellable, error);
2900 out = (GOutputStream *)g_file_create (destination, 0, cancellable, error);
2905 g_object_unref (in);
2910 if (G_IS_FILE_DESCRIPTOR_BASED (in) && G_IS_FILE_DESCRIPTOR_BASED (out))
2912 GError *splice_err = NULL;
2914 result = splice_stream_with_progress (in, out, cancellable,
2915 progress_callback, progress_callback_data,
2918 if (result || !g_error_matches (splice_err, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED))
2922 g_propagate_error (error, splice_err);
2925 g_clear_error (&splice_err);
2930 result = copy_stream_with_progress (in, out, source, cancellable,
2931 progress_callback, progress_callback_data,
2934 /* Don't care about errors in source here */
2935 g_input_stream_close (in, cancellable, NULL);
2937 /* But write errors on close are bad! */
2938 if (!g_output_stream_close (out, cancellable, result ? error : NULL))
2941 g_object_unref (in);
2942 g_object_unref (out);
2944 if (result == FALSE)
2948 /* Ignore errors here. Failure to copy metadata is not a hard error */
2949 g_file_copy_attributes (source, destination,
2950 flags, cancellable, NULL);
2957 * @source: input #GFile.
2958 * @destination: destination #GFile
2959 * @flags: set of #GFileCopyFlags
2960 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
2961 * @progress_callback: (allow-none) (scope call): function to callback with
2962 * progress information, or %NULL if progress information is not needed
2963 * @progress_callback_data: (closure): user data to pass to @progress_callback
2964 * @error: #GError to set on error, or %NULL
2966 * Copies the file @source to the location specified by @destination.
2967 * Can not handle recursive copies of directories.
2969 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
2970 * existing @destination file is overwritten.
2972 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
2973 * will be copied as symlinks, otherwise the target of the
2974 * @source symlink will be copied.
2976 * If @cancellable is not %NULL, then the operation can be cancelled by
2977 * triggering the cancellable object from another thread. If the operation
2978 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
2980 * If @progress_callback is not %NULL, then the operation can be monitored by
2981 * setting this to a #GFileProgressCallback function. @progress_callback_data
2982 * will be passed to this function. It is guaranteed that this callback will
2983 * be called after all data has been transferred with the total number of bytes
2984 * copied during the operation.
2986 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
2987 * error is returned, independent on the status of the @destination.
2989 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
2990 * error G_IO_ERROR_EXISTS is returned.
2992 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
2993 * error is returned. If trying to overwrite a directory with a directory the
2994 * G_IO_ERROR_WOULD_MERGE error is returned.
2996 * If the source is a directory and the target does not exist, or
2997 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
2998 * G_IO_ERROR_WOULD_RECURSE error is returned.
3000 * If you are interested in copying the #GFile object itself (not the on-disk
3001 * file), see g_file_dup().
3003 * Returns: %TRUE on success, %FALSE otherwise.
3006 g_file_copy (GFile *source,
3008 GFileCopyFlags flags,
3009 GCancellable *cancellable,
3010 GFileProgressCallback progress_callback,
3011 gpointer progress_callback_data,
3018 g_return_val_if_fail (G_IS_FILE (source), FALSE);
3019 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3021 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3024 iface = G_FILE_GET_IFACE (destination);
3028 res = (* iface->copy) (source, destination,
3030 progress_callback, progress_callback_data,
3036 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3038 g_propagate_error (error, my_error);
3042 g_clear_error (&my_error);
3045 /* If the types are different, and the destination method failed
3046 also try the source method */
3047 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3049 iface = G_FILE_GET_IFACE (source);
3054 res = (* iface->copy) (source, destination,
3056 progress_callback, progress_callback_data,
3062 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3064 g_propagate_error (error, my_error);
3068 g_clear_error (&my_error);
3072 return file_copy_fallback (source, destination, flags, cancellable,
3073 progress_callback, progress_callback_data,
3078 * g_file_copy_async: (skip)
3079 * @source: input #GFile.
3080 * @destination: destination #GFile
3081 * @flags: set of #GFileCopyFlags
3082 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3084 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
3085 * @progress_callback: (allow-none): function to callback with progress
3086 * information, or %NULL if progress information is not needed
3087 * @progress_callback_data: (closure): user data to pass to @progress_callback
3088 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3089 * @user_data: the data to pass to callback function
3091 * Copies the file @source to the location specified by @destination
3092 * asynchronously. For details of the behaviour, see g_file_copy().
3094 * If @progress_callback is not %NULL, then that function that will be called
3095 * just like in g_file_copy(), however the callback will run in the main loop,
3096 * not in the thread that is doing the I/O operation.
3098 * When the operation is finished, @callback will be called. You can then call
3099 * g_file_copy_finish() to get the result of the operation.
3102 g_file_copy_async (GFile *source,
3104 GFileCopyFlags flags,
3106 GCancellable *cancellable,
3107 GFileProgressCallback progress_callback,
3108 gpointer progress_callback_data,
3109 GAsyncReadyCallback callback,
3114 g_return_if_fail (G_IS_FILE (source));
3115 g_return_if_fail (G_IS_FILE (destination));
3117 iface = G_FILE_GET_IFACE (source);
3118 (* iface->copy_async) (source,
3124 progress_callback_data,
3130 * g_file_copy_finish:
3131 * @file: input #GFile.
3132 * @res: a #GAsyncResult.
3133 * @error: a #GError, or %NULL
3135 * Finishes copying the file started with
3136 * g_file_copy_async().
3138 * Returns: a %TRUE on success, %FALSE on error.
3141 g_file_copy_finish (GFile *file,
3147 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3148 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE);
3150 if (g_async_result_legacy_propagate_error (res, error))
3153 iface = G_FILE_GET_IFACE (file);
3154 return (* iface->copy_finish) (file, res, error);
3159 * @source: #GFile pointing to the source location.
3160 * @destination: #GFile pointing to the destination location.
3161 * @flags: set of #GFileCopyFlags.
3162 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3163 * @progress_callback: (allow-none) (scope call): #GFileProgressCallback function for updates.
3164 * @progress_callback_data: (closure): gpointer to user data for the callback function.
3165 * @error: #GError for returning error conditions, or %NULL
3168 * Tries to move the file or directory @source to the location specified by @destination.
3169 * If native move operations are supported then this is used, otherwise a copy + delete
3170 * fallback is used. The native implementation may support moving directories (for instance
3171 * on moves inside the same filesystem), but the fallback code does not.
3173 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3174 * existing @destination file is overwritten.
3176 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3177 * will be copied as symlinks, otherwise the target of the
3178 * @source symlink will be copied.
3180 * If @cancellable is not %NULL, then the operation can be cancelled by
3181 * triggering the cancellable object from another thread. If the operation
3182 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3184 * If @progress_callback is not %NULL, then the operation can be monitored by
3185 * setting this to a #GFileProgressCallback function. @progress_callback_data
3186 * will be passed to this function. It is guaranteed that this callback will
3187 * be called after all data has been transferred with the total number of bytes
3188 * copied during the operation.
3190 * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND
3191 * error is returned, independent on the status of the @destination.
3193 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the
3194 * error G_IO_ERROR_EXISTS is returned.
3196 * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY
3197 * error is returned. If trying to overwrite a directory with a directory the
3198 * G_IO_ERROR_WOULD_MERGE error is returned.
3200 * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is
3201 * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error
3202 * may be returned (if the native move operation isn't available).
3204 * Returns: %TRUE on successful move, %FALSE otherwise.
3207 g_file_move (GFile *source,
3209 GFileCopyFlags flags,
3210 GCancellable *cancellable,
3211 GFileProgressCallback progress_callback,
3212 gpointer progress_callback_data,
3219 g_return_val_if_fail (G_IS_FILE (source), FALSE);
3220 g_return_val_if_fail (G_IS_FILE (destination), FALSE);
3222 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3225 iface = G_FILE_GET_IFACE (destination);
3229 res = (* iface->move) (source, destination,
3231 progress_callback, progress_callback_data,
3237 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3239 g_propagate_error (error, my_error);
3244 /* If the types are different, and the destination method failed
3245 also try the source method */
3246 if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination))
3248 iface = G_FILE_GET_IFACE (source);
3253 res = (* iface->move) (source, destination,
3255 progress_callback, progress_callback_data,
3261 if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED)
3263 g_propagate_error (error, my_error);
3269 if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE)
3271 g_set_error_literal (error, G_IO_ERROR,
3272 G_IO_ERROR_NOT_SUPPORTED,
3273 _("Operation not supported"));
3277 flags |= G_FILE_COPY_ALL_METADATA;
3278 if (!g_file_copy (source, destination, flags, cancellable,
3279 progress_callback, progress_callback_data,
3283 return g_file_delete (source, cancellable, error);
3287 * g_file_make_directory:
3288 * @file: input #GFile.
3289 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3290 * @error: a #GError, or %NULL
3292 * Creates a directory. Note that this will only create a child directory of
3293 * the immediate parent directory of the path or URI given by the #GFile. To
3294 * recursively create directories, see g_file_make_directory_with_parents().
3295 * This function will fail if the parent directory does not exist, setting
3296 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating
3297 * directories, this function will fail, setting @error to
3298 * %G_IO_ERROR_NOT_SUPPORTED.
3300 * For a local #GFile the newly created directory will have the default
3301 * (current) ownership and permissions of the current process.
3303 * If @cancellable is not %NULL, then the operation can be cancelled by
3304 * triggering the cancellable object from another thread. If the operation
3305 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3307 * Returns: %TRUE on successful creation, %FALSE otherwise.
3310 g_file_make_directory (GFile *file,
3311 GCancellable *cancellable,
3316 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3318 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3321 iface = G_FILE_GET_IFACE (file);
3323 if (iface->make_directory == NULL)
3325 g_set_error_literal (error, G_IO_ERROR,
3326 G_IO_ERROR_NOT_SUPPORTED,
3327 _("Operation not supported"));
3331 return (* iface->make_directory) (file, cancellable, error);
3335 * g_file_make_directory_with_parents:
3336 * @file: input #GFile.
3337 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3338 * @error: a #GError, or %NULL
3340 * Creates a directory and any parent directories that may not exist similar to
3341 * 'mkdir -p'. If the file system does not support creating directories, this
3342 * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the
3343 * directory itself already exists, this function will fail setting @error
3344 * to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents().
3346 * For a local #GFile the newly created directories will have the default
3347 * (current) ownership and permissions of the current process.
3349 * If @cancellable is not %NULL, then the operation can be cancelled by
3350 * triggering the cancellable object from another thread. If the operation
3351 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3353 * Returns: %TRUE if all directories have been successfully created, %FALSE
3359 g_file_make_directory_with_parents (GFile *file,
3360 GCancellable *cancellable,
3364 GFile *work_file = NULL;
3365 GList *list = NULL, *l;
3366 GError *my_error = NULL;
3368 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3370 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3373 result = g_file_make_directory (file, cancellable, &my_error);
3374 if (result || my_error->code != G_IO_ERROR_NOT_FOUND)
3377 g_propagate_error (error, my_error);
3381 work_file = g_object_ref (file);
3383 while (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
3387 g_clear_error (&my_error);
3389 parent_file = g_file_get_parent (work_file);
3390 if (parent_file == NULL)
3392 result = g_file_make_directory (parent_file, cancellable, &my_error);
3394 g_object_unref (work_file);
3395 work_file = g_object_ref (parent_file);
3397 if (!result && my_error->code == G_IO_ERROR_NOT_FOUND)
3398 list = g_list_prepend (list, parent_file); /* Transfer ownership of ref */
3400 g_object_unref (parent_file);
3403 g_clear_error (&my_error);
3404 for (l = list; result && l; l = l->next)
3406 result = g_file_make_directory ((GFile *) l->data, cancellable, &my_error);
3410 g_object_unref (work_file);
3413 while (list != NULL)
3415 g_object_unref ((GFile *) list->data);
3416 list = g_list_remove (list, list->data);
3421 g_propagate_error (error, my_error);
3425 return g_file_make_directory (file, cancellable, error);
3429 * g_file_make_symbolic_link:
3430 * @file: a #GFile with the name of the symlink to create
3431 * @symlink_value: a string with the path for the target of the new symlink
3432 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3433 * @error: a #GError.
3435 * Creates a symbolic link named @file which contains the string
3438 * If @cancellable is not %NULL, then the operation can be cancelled by
3439 * triggering the cancellable object from another thread. If the operation
3440 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3442 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3445 g_file_make_symbolic_link (GFile *file,
3446 const char *symlink_value,
3447 GCancellable *cancellable,
3452 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3453 g_return_val_if_fail (symlink_value != NULL, FALSE);
3455 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3458 if (*symlink_value == '\0')
3460 g_set_error_literal (error, G_IO_ERROR,
3461 G_IO_ERROR_INVALID_ARGUMENT,
3462 _("Invalid symlink value given"));
3466 iface = G_FILE_GET_IFACE (file);
3468 if (iface->make_symbolic_link == NULL)
3470 g_set_error_literal (error, G_IO_ERROR,
3471 G_IO_ERROR_NOT_SUPPORTED,
3472 _("Operation not supported"));
3476 return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error);
3481 * @file: input #GFile.
3482 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3483 * @error: a #GError, or %NULL
3485 * Deletes a file. If the @file is a directory, it will only be deleted if it
3486 * is empty. This has the same semantics as g_unlink().
3488 * If @cancellable is not %NULL, then the operation can be cancelled by
3489 * triggering the cancellable object from another thread. If the operation
3490 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3492 * Virtual: delete_file
3493 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3496 g_file_delete (GFile *file,
3497 GCancellable *cancellable,
3502 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3504 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3507 iface = G_FILE_GET_IFACE (file);
3509 if (iface->delete_file == NULL)
3511 g_set_error_literal (error, G_IO_ERROR,
3512 G_IO_ERROR_NOT_SUPPORTED,
3513 _("Operation not supported"));
3517 return (* iface->delete_file) (file, cancellable, error);
3521 * g_file_delete_async:
3522 * @file: input #GFile.
3523 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3525 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3526 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3527 * @user_data: the data to pass to callback function
3529 * Asynchronously delete a file. If the @file is a directory, it will
3530 * only be deleted if it is empty. This has the same semantics as
3533 * Virtual: delete_file_async
3537 g_file_delete_async (GFile *file,
3539 GCancellable *cancellable,
3540 GAsyncReadyCallback callback,
3545 g_return_if_fail (G_IS_FILE (file));
3547 iface = G_FILE_GET_IFACE (file);
3548 (* iface->delete_file_async) (file,
3556 * g_file_delete_finish:
3557 * @file: input #GFile.
3558 * @res: a #GAsyncResult.
3559 * @error: a #GError, or %NULL
3561 * Finishes deleting a file started with
3562 * g_file_delete_async().
3564 * Virtual: delete_file_finish
3568 g_file_delete_finish (GFile *file,
3569 GAsyncResult *result,
3574 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3575 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
3577 if (g_async_result_legacy_propagate_error (result, error))
3580 iface = G_FILE_GET_IFACE (file);
3581 return (* iface->delete_file_finish) (file, result, error);
3586 * @file: #GFile to send to trash.
3587 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3588 * @error: a #GError, or %NULL
3590 * Sends @file to the "Trashcan", if possible. This is similar to
3591 * deleting it, but the user can recover it before emptying the trashcan.
3592 * Not all file systems support trashing, so this call can return the
3593 * %G_IO_ERROR_NOT_SUPPORTED error.
3596 * If @cancellable is not %NULL, then the operation can be cancelled by
3597 * triggering the cancellable object from another thread. If the operation
3598 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3600 * Returns: %TRUE on successful trash, %FALSE otherwise.
3603 g_file_trash (GFile *file,
3604 GCancellable *cancellable,
3609 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3611 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3614 iface = G_FILE_GET_IFACE (file);
3616 if (iface->trash == NULL)
3618 g_set_error_literal (error,
3619 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
3620 _("Trash not supported"));
3624 return (* iface->trash) (file, cancellable, error);
3628 * g_file_set_display_name:
3629 * @file: input #GFile.
3630 * @display_name: a string.
3631 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3632 * @error: a #GError, or %NULL
3634 * Renames @file to the specified display name.
3636 * The display name is converted from UTF8 to the correct encoding for the target
3637 * filesystem if possible and the @file is renamed to this.
3639 * If you want to implement a rename operation in the user interface the edit name
3640 * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename
3641 * widget, and then the result after editing should be passed to g_file_set_display_name().
3643 * On success the resulting converted filename is returned.
3645 * If @cancellable is not %NULL, then the operation can be cancelled by
3646 * triggering the cancellable object from another thread. If the operation
3647 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3649 * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL
3650 * if there was an error.
3651 * Free the returned object with g_object_unref().
3654 g_file_set_display_name (GFile *file,
3655 const char *display_name,
3656 GCancellable *cancellable,
3661 g_return_val_if_fail (G_IS_FILE (file), NULL);
3662 g_return_val_if_fail (display_name != NULL, NULL);
3664 if (strchr (display_name, G_DIR_SEPARATOR) != NULL)
3668 G_IO_ERROR_INVALID_ARGUMENT,
3669 _("File names cannot contain '%c'"), G_DIR_SEPARATOR);
3673 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3676 iface = G_FILE_GET_IFACE (file);
3678 return (* iface->set_display_name) (file, display_name, cancellable, error);
3682 * g_file_set_display_name_async:
3683 * @file: input #GFile.
3684 * @display_name: a string.
3685 * @io_priority: the <link linkend="io-priority">I/O priority</link>
3687 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3688 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3689 * @user_data: (closure): the data to pass to callback function
3691 * Asynchronously sets the display name for a given #GFile.
3693 * For more details, see g_file_set_display_name() which is
3694 * the synchronous version of this call.
3696 * When the operation is finished, @callback will be called. You can then call
3697 * g_file_set_display_name_finish() to get the result of the operation.
3700 g_file_set_display_name_async (GFile *file,
3701 const char *display_name,
3703 GCancellable *cancellable,
3704 GAsyncReadyCallback callback,
3709 g_return_if_fail (G_IS_FILE (file));
3710 g_return_if_fail (display_name != NULL);
3712 iface = G_FILE_GET_IFACE (file);
3713 (* iface->set_display_name_async) (file,
3722 * g_file_set_display_name_finish:
3723 * @file: input #GFile.
3724 * @res: a #GAsyncResult.
3725 * @error: a #GError, or %NULL
3727 * Finishes setting a display name started with
3728 * g_file_set_display_name_async().
3730 * Returns: (transfer full): a #GFile or %NULL on error.
3731 * Free the returned object with g_object_unref().
3734 g_file_set_display_name_finish (GFile *file,
3740 g_return_val_if_fail (G_IS_FILE (file), NULL);
3741 g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL);
3743 if (g_async_result_legacy_propagate_error (res, error))
3746 iface = G_FILE_GET_IFACE (file);
3747 return (* iface->set_display_name_finish) (file, res, error);
3751 * g_file_query_settable_attributes:
3752 * @file: input #GFile.
3753 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3754 * @error: a #GError, or %NULL
3756 * Obtain the list of settable attributes for the file.
3758 * Returns the type and full attribute name of all the attributes
3759 * that can be set on this file. This doesn't mean setting it will always
3760 * succeed though, you might get an access failure, or some specific
3761 * file may not support a specific attribute.
3763 * If @cancellable is not %NULL, then the operation can be cancelled by
3764 * triggering the cancellable object from another thread. If the operation
3765 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3767 * Returns: a #GFileAttributeInfoList describing the settable attributes.
3768 * When you are done with it, release it with g_file_attribute_info_list_unref()
3770 GFileAttributeInfoList *
3771 g_file_query_settable_attributes (GFile *file,
3772 GCancellable *cancellable,
3777 GFileAttributeInfoList *list;
3779 g_return_val_if_fail (G_IS_FILE (file), NULL);
3781 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3784 iface = G_FILE_GET_IFACE (file);
3786 if (iface->query_settable_attributes == NULL)
3787 return g_file_attribute_info_list_new ();
3790 list = (* iface->query_settable_attributes) (file, cancellable, &my_error);
3794 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3796 list = g_file_attribute_info_list_new ();
3797 g_error_free (my_error);
3800 g_propagate_error (error, my_error);
3807 * g_file_query_writable_namespaces:
3808 * @file: input #GFile.
3809 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3810 * @error: a #GError, or %NULL
3812 * Obtain the list of attribute namespaces where new attributes
3813 * can be created by a user. An example of this is extended
3814 * attributes (in the "xattr" namespace).
3816 * If @cancellable is not %NULL, then the operation can be cancelled by
3817 * triggering the cancellable object from another thread. If the operation
3818 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3820 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
3821 * When you are done with it, release it with g_file_attribute_info_list_unref()
3823 GFileAttributeInfoList *
3824 g_file_query_writable_namespaces (GFile *file,
3825 GCancellable *cancellable,
3830 GFileAttributeInfoList *list;
3832 g_return_val_if_fail (G_IS_FILE (file), NULL);
3834 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3837 iface = G_FILE_GET_IFACE (file);
3839 if (iface->query_writable_namespaces == NULL)
3840 return g_file_attribute_info_list_new ();
3843 list = (* iface->query_writable_namespaces) (file, cancellable, &my_error);
3847 if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED)
3849 list = g_file_attribute_info_list_new ();
3850 g_error_free (my_error);
3853 g_propagate_error (error, my_error);
3860 * g_file_set_attribute:
3861 * @file: input #GFile.
3862 * @attribute: a string containing the attribute's name.
3863 * @type: The type of the attribute
3864 * @value_p: (allow-none): a pointer to the value (or the pointer itself if the type is a pointer type)
3865 * @flags: a set of #GFileQueryInfoFlags.
3866 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3867 * @error: a #GError, or %NULL
3869 * Sets an attribute in the file with attribute name @attribute to @value.
3871 * Some attributes can be unset by setting @attribute to
3872 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
3874 * If @cancellable is not %NULL, then the operation can be cancelled by
3875 * triggering the cancellable object from another thread. If the operation
3876 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3878 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
3881 g_file_set_attribute (GFile *file,
3882 const char *attribute,
3883 GFileAttributeType type,
3885 GFileQueryInfoFlags flags,
3886 GCancellable *cancellable,
3891 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3892 g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE);
3894 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3897 iface = G_FILE_GET_IFACE (file);
3899 if (iface->set_attribute == NULL)
3901 g_set_error_literal (error, G_IO_ERROR,
3902 G_IO_ERROR_NOT_SUPPORTED,
3903 _("Operation not supported"));
3907 return (* iface->set_attribute) (file, attribute, type, value_p, flags, cancellable, error);
3911 * g_file_set_attributes_from_info:
3912 * @file: input #GFile.
3913 * @info: a #GFileInfo.
3914 * @flags: #GFileQueryInfoFlags
3915 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
3916 * @error: a #GError, or %NULL
3918 * Tries to set all attributes in the #GFileInfo on the target values,
3919 * not stopping on the first error.
3921 * If there is any error during this operation then @error will be set to
3922 * the first error. Error on particular fields are flagged by setting
3923 * the "status" field in the attribute value to
3924 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect
3927 * If @cancellable is not %NULL, then the operation can be cancelled by
3928 * triggering the cancellable object from another thread. If the operation
3929 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3931 * Returns: %TRUE if there was any error, %FALSE otherwise.
3934 g_file_set_attributes_from_info (GFile *file,
3936 GFileQueryInfoFlags flags,
3937 GCancellable *cancellable,
3942 g_return_val_if_fail (G_IS_FILE (file), FALSE);
3943 g_return_val_if_fail (G_IS_FILE_INFO (info), FALSE);
3945 if (g_cancellable_set_error_if_cancelled (cancellable, error))
3948 g_file_info_clear_status (info);
3950 iface = G_FILE_GET_IFACE (file);
3952 return (* iface->set_attributes_from_info) (file,
3961 g_file_real_set_attributes_from_info (GFile *file,
3963 GFileQueryInfoFlags flags,
3964 GCancellable *cancellable,
3970 GFileAttributeValue *value;
3974 attributes = g_file_info_list_attributes (info, NULL);
3976 for (i = 0; attributes[i] != NULL; i++)
3978 value = _g_file_info_get_attribute_value (info, attributes[i]);
3980 if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET)
3983 if (!g_file_set_attribute (file, attributes[i],
3984 value->type, _g_file_attribute_value_peek_as_pointer (value),
3985 flags, cancellable, error))
3987 value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING;
3989 /* Don't set error multiple times */
3993 value->status = G_FILE_ATTRIBUTE_STATUS_SET;
3996 g_strfreev (attributes);
4002 * g_file_set_attributes_async:
4003 * @file: input #GFile.
4004 * @info: a #GFileInfo.
4005 * @flags: a #GFileQueryInfoFlags.
4006 * @io_priority: the <link linkend="io-priority">I/O priority</link>
4008 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4009 * @callback: (scope async): a #GAsyncReadyCallback.
4010 * @user_data: (closure): a #gpointer.
4012 * Asynchronously sets the attributes of @file with @info.
4014 * For more details, see g_file_set_attributes_from_info() which is
4015 * the synchronous version of this call.
4017 * When the operation is finished, @callback will be called. You can then call
4018 * g_file_set_attributes_finish() to get the result of the operation.
4021 g_file_set_attributes_async (GFile *file,
4023 GFileQueryInfoFlags flags,
4025 GCancellable *cancellable,
4026 GAsyncReadyCallback callback,
4031 g_return_if_fail (G_IS_FILE (file));
4032 g_return_if_fail (G_IS_FILE_INFO (info));
4034 iface = G_FILE_GET_IFACE (file);
4035 (* iface->set_attributes_async) (file,
4045 * g_file_set_attributes_finish:
4046 * @file: input #GFile.
4047 * @result: a #GAsyncResult.
4048 * @info: (out) (transfer full): a #GFileInfo.
4049 * @error: a #GError, or %NULL
4051 * Finishes setting an attribute started in g_file_set_attributes_async().
4053 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4056 g_file_set_attributes_finish (GFile *file,
4057 GAsyncResult *result,
4063 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4064 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4066 /* No standard handling of errors here, as we must set info even
4069 iface = G_FILE_GET_IFACE (file);
4070 return (* iface->set_attributes_finish) (file, result, info, error);
4074 * g_file_set_attribute_string:
4075 * @file: input #GFile.
4076 * @attribute: a string containing the attribute's name.
4077 * @value: a string containing the attribute's value.
4078 * @flags: #GFileQueryInfoFlags.
4079 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4080 * @error: a #GError, or %NULL
4082 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4083 * If @attribute is of a different type, this operation will fail.
4085 * If @cancellable is not %NULL, then the operation can be cancelled by
4086 * triggering the cancellable object from another thread. If the operation
4087 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4089 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4092 g_file_set_attribute_string (GFile *file,
4093 const char *attribute,
4095 GFileQueryInfoFlags flags,
4096 GCancellable *cancellable,
4099 return g_file_set_attribute (file, attribute,
4100 G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value,
4101 flags, cancellable, error);
4105 * g_file_set_attribute_byte_string:
4106 * @file: input #GFile.
4107 * @attribute: a string containing the attribute's name.
4108 * @value: a string containing the attribute's new value.
4109 * @flags: a #GFileQueryInfoFlags.
4110 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4111 * @error: a #GError, or %NULL
4113 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4114 * If @attribute is of a different type, this operation will fail,
4117 * If @cancellable is not %NULL, then the operation can be cancelled by
4118 * triggering the cancellable object from another thread. If the operation
4119 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4121 * Returns: %TRUE if the @attribute was successfully set to @value
4122 * in the @file, %FALSE otherwise.
4125 g_file_set_attribute_byte_string (GFile *file,
4126 const char *attribute,
4128 GFileQueryInfoFlags flags,
4129 GCancellable *cancellable,
4132 return g_file_set_attribute (file, attribute,
4133 G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value,
4134 flags, cancellable, error);
4138 * g_file_set_attribute_uint32:
4139 * @file: input #GFile.
4140 * @attribute: a string containing the attribute's name.
4141 * @value: a #guint32 containing the attribute's new value.
4142 * @flags: a #GFileQueryInfoFlags.
4143 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4144 * @error: a #GError, or %NULL
4146 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4147 * If @attribute is of a different type, this operation will fail.
4149 * If @cancellable is not %NULL, then the operation can be cancelled by
4150 * triggering the cancellable object from another thread. If the operation
4151 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4153 * Returns: %TRUE if the @attribute was successfully set to @value
4154 * in the @file, %FALSE otherwise.
4157 g_file_set_attribute_uint32 (GFile *file,
4158 const char *attribute,
4160 GFileQueryInfoFlags flags,
4161 GCancellable *cancellable,
4164 return g_file_set_attribute (file, attribute,
4165 G_FILE_ATTRIBUTE_TYPE_UINT32, &value,
4166 flags, cancellable, error);
4170 * g_file_set_attribute_int32:
4171 * @file: input #GFile.
4172 * @attribute: a string containing the attribute's name.
4173 * @value: a #gint32 containing the attribute's new value.
4174 * @flags: a #GFileQueryInfoFlags.
4175 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4176 * @error: a #GError, or %NULL
4178 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4179 * If @attribute is of a different type, this operation will fail.
4181 * If @cancellable is not %NULL, then the operation can be cancelled by
4182 * triggering the cancellable object from another thread. If the operation
4183 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4185 * Returns: %TRUE if the @attribute was successfully set to @value
4186 * in the @file, %FALSE otherwise.
4189 g_file_set_attribute_int32 (GFile *file,
4190 const char *attribute,
4192 GFileQueryInfoFlags flags,
4193 GCancellable *cancellable,
4196 return g_file_set_attribute (file, attribute,
4197 G_FILE_ATTRIBUTE_TYPE_INT32, &value,
4198 flags, cancellable, error);
4202 * g_file_set_attribute_uint64:
4203 * @file: input #GFile.
4204 * @attribute: a string containing the attribute's name.
4205 * @value: a #guint64 containing the attribute's new value.
4206 * @flags: a #GFileQueryInfoFlags.
4207 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4208 * @error: a #GError, or %NULL
4210 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4211 * If @attribute is of a different type, this operation will fail.
4213 * If @cancellable is not %NULL, then the operation can be cancelled by
4214 * triggering the cancellable object from another thread. If the operation
4215 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4217 * Returns: %TRUE if the @attribute was successfully set to @value
4218 * in the @file, %FALSE otherwise.
4221 g_file_set_attribute_uint64 (GFile *file,
4222 const char *attribute,
4224 GFileQueryInfoFlags flags,
4225 GCancellable *cancellable,
4228 return g_file_set_attribute (file, attribute,
4229 G_FILE_ATTRIBUTE_TYPE_UINT64, &value,
4230 flags, cancellable, error);
4234 * g_file_set_attribute_int64:
4235 * @file: input #GFile.
4236 * @attribute: a string containing the attribute's name.
4237 * @value: a #guint64 containing the attribute's new value.
4238 * @flags: a #GFileQueryInfoFlags.
4239 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4240 * @error: a #GError, or %NULL
4242 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4243 * If @attribute is of a different type, this operation will fail.
4245 * If @cancellable is not %NULL, then the operation can be cancelled by
4246 * triggering the cancellable object from another thread. If the operation
4247 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4249 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4252 g_file_set_attribute_int64 (GFile *file,
4253 const char *attribute,
4255 GFileQueryInfoFlags flags,
4256 GCancellable *cancellable,
4259 return g_file_set_attribute (file, attribute,
4260 G_FILE_ATTRIBUTE_TYPE_INT64, &value,
4261 flags, cancellable, error);
4265 * g_file_mount_mountable:
4266 * @file: input #GFile.
4267 * @flags: flags affecting the operation
4268 * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4269 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4270 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4271 * @user_data: (closure): the data to pass to callback function
4273 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4274 * Using @mount_operation, you can request callbacks when, for instance,
4275 * passwords are needed during authentication.
4277 * If @cancellable is not %NULL, then the operation can be cancelled by
4278 * triggering the cancellable object from another thread. If the operation
4279 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4281 * When the operation is finished, @callback will be called. You can then call
4282 * g_file_mount_mountable_finish() to get the result of the operation.
4285 g_file_mount_mountable (GFile *file,
4286 GMountMountFlags flags,
4287 GMountOperation *mount_operation,
4288 GCancellable *cancellable,
4289 GAsyncReadyCallback callback,
4294 g_return_if_fail (G_IS_FILE (file));
4296 iface = G_FILE_GET_IFACE (file);
4298 if (iface->mount_mountable == NULL)
4300 g_simple_async_report_error_in_idle (G_OBJECT (file),
4304 G_IO_ERROR_NOT_SUPPORTED,
4305 _("Operation not supported"));
4309 (* iface->mount_mountable) (file,
4318 * g_file_mount_mountable_finish:
4319 * @file: input #GFile.
4320 * @result: a #GAsyncResult.
4321 * @error: a #GError, or %NULL
4323 * Finishes a mount operation. See g_file_mount_mountable() for details.
4325 * Finish an asynchronous mount operation that was started
4326 * with g_file_mount_mountable().
4328 * Returns: (transfer full): a #GFile or %NULL on error.
4329 * Free the returned object with g_object_unref().
4332 g_file_mount_mountable_finish (GFile *file,
4333 GAsyncResult *result,
4338 g_return_val_if_fail (G_IS_FILE (file), NULL);
4339 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), NULL);
4341 if (g_async_result_legacy_propagate_error (result, error))
4344 iface = G_FILE_GET_IFACE (file);
4345 return (* iface->mount_mountable_finish) (file, result, error);
4349 * g_file_unmount_mountable:
4350 * @file: input #GFile.
4351 * @flags: flags affecting the operation
4352 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4353 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4354 * @user_data: (closure): the data to pass to callback function
4356 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4358 * If @cancellable is not %NULL, then the operation can be cancelled by
4359 * triggering the cancellable object from another thread. If the operation
4360 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4362 * When the operation is finished, @callback will be called. You can then call
4363 * g_file_unmount_mountable_finish() to get the result of the operation.
4365 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4368 g_file_unmount_mountable (GFile *file,
4369 GMountUnmountFlags flags,
4370 GCancellable *cancellable,
4371 GAsyncReadyCallback callback,
4376 g_return_if_fail (G_IS_FILE (file));
4378 iface = G_FILE_GET_IFACE (file);
4380 if (iface->unmount_mountable == NULL)
4382 g_simple_async_report_error_in_idle (G_OBJECT (file),
4386 G_IO_ERROR_NOT_SUPPORTED,
4387 _("Operation not supported"));
4391 (* iface->unmount_mountable) (file,
4399 * g_file_unmount_mountable_finish:
4400 * @file: input #GFile.
4401 * @result: a #GAsyncResult.
4402 * @error: a #GError, or %NULL
4404 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4406 * Finish an asynchronous unmount operation that was started
4407 * with g_file_unmount_mountable().
4409 * Returns: %TRUE if the operation finished successfully. %FALSE
4412 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead.
4415 g_file_unmount_mountable_finish (GFile *file,
4416 GAsyncResult *result,
4421 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4422 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4424 if (g_async_result_legacy_propagate_error (result, error))
4427 iface = G_FILE_GET_IFACE (file);
4428 return (* iface->unmount_mountable_finish) (file, result, error);
4432 * g_file_unmount_mountable_with_operation:
4433 * @file: input #GFile.
4434 * @flags: flags affecting the operation
4435 * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4436 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4437 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4438 * @user_data: (closure): the data to pass to callback function
4440 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4442 * If @cancellable is not %NULL, then the operation can be cancelled by
4443 * triggering the cancellable object from another thread. If the operation
4444 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4446 * When the operation is finished, @callback will be called. You can then call
4447 * g_file_unmount_mountable_finish() to get the result of the operation.
4452 g_file_unmount_mountable_with_operation (GFile *file,
4453 GMountUnmountFlags flags,
4454 GMountOperation *mount_operation,
4455 GCancellable *cancellable,
4456 GAsyncReadyCallback callback,
4461 g_return_if_fail (G_IS_FILE (file));
4463 iface = G_FILE_GET_IFACE (file);
4465 if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL)
4467 g_simple_async_report_error_in_idle (G_OBJECT (file),
4471 G_IO_ERROR_NOT_SUPPORTED,
4472 _("Operation not supported"));
4476 if (iface->unmount_mountable_with_operation != NULL)
4477 (* iface->unmount_mountable_with_operation) (file,
4484 (* iface->unmount_mountable) (file,
4492 * g_file_unmount_mountable_with_operation_finish:
4493 * @file: input #GFile.
4494 * @result: a #GAsyncResult.
4495 * @error: a #GError, or %NULL
4497 * Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details.
4499 * Finish an asynchronous unmount operation that was started
4500 * with g_file_unmount_mountable_with_operation().
4502 * Returns: %TRUE if the operation finished successfully. %FALSE
4508 g_file_unmount_mountable_with_operation_finish (GFile *file,
4509 GAsyncResult *result,
4514 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4515 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4517 if (g_async_result_legacy_propagate_error (result, error))
4520 iface = G_FILE_GET_IFACE (file);
4521 if (iface->unmount_mountable_with_operation_finish != NULL)
4522 return (* iface->unmount_mountable_with_operation_finish) (file, result, error);
4524 return (* iface->unmount_mountable_finish) (file, result, error);
4528 * g_file_eject_mountable:
4529 * @file: input #GFile.
4530 * @flags: flags affecting the operation
4531 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4532 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4533 * @user_data: (closure): the data to pass to callback function
4535 * Starts an asynchronous eject on a mountable.
4536 * When this operation has completed, @callback will be called with
4537 * @user_user data, and the operation can be finalized with
4538 * g_file_eject_mountable_finish().
4540 * If @cancellable is not %NULL, then the operation can be cancelled by
4541 * triggering the cancellable object from another thread. If the operation
4542 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4544 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
4547 g_file_eject_mountable (GFile *file,
4548 GMountUnmountFlags flags,
4549 GCancellable *cancellable,
4550 GAsyncReadyCallback callback,
4555 g_return_if_fail (G_IS_FILE (file));
4557 iface = G_FILE_GET_IFACE (file);
4559 if (iface->eject_mountable == NULL)
4561 g_simple_async_report_error_in_idle (G_OBJECT (file),
4565 G_IO_ERROR_NOT_SUPPORTED,
4566 _("Operation not supported"));
4570 (* iface->eject_mountable) (file,
4578 * g_file_eject_mountable_finish:
4579 * @file: input #GFile.
4580 * @result: a #GAsyncResult.
4581 * @error: a #GError, or %NULL
4583 * Finishes an asynchronous eject operation started by
4584 * g_file_eject_mountable().
4586 * Returns: %TRUE if the @file was ejected successfully. %FALSE
4589 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead.
4592 g_file_eject_mountable_finish (GFile *file,
4593 GAsyncResult *result,
4598 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4599 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4601 if (g_async_result_legacy_propagate_error (result, error))
4604 iface = G_FILE_GET_IFACE (file);
4605 return (* iface->eject_mountable_finish) (file, result, error);
4609 * g_file_eject_mountable_with_operation:
4610 * @file: input #GFile.
4611 * @flags: flags affecting the operation
4612 * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
4613 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4614 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
4615 * @user_data: (closure): the data to pass to callback function
4617 * Starts an asynchronous eject on a mountable.
4618 * When this operation has completed, @callback will be called with
4619 * @user_user data, and the operation can be finalized with
4620 * g_file_eject_mountable_with_operation_finish().
4622 * If @cancellable is not %NULL, then the operation can be cancelled by
4623 * triggering the cancellable object from another thread. If the operation
4624 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4629 g_file_eject_mountable_with_operation (GFile *file,
4630 GMountUnmountFlags flags,
4631 GMountOperation *mount_operation,
4632 GCancellable *cancellable,
4633 GAsyncReadyCallback callback,
4638 g_return_if_fail (G_IS_FILE (file));
4640 iface = G_FILE_GET_IFACE (file);
4642 if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL)
4644 g_simple_async_report_error_in_idle (G_OBJECT (file),
4648 G_IO_ERROR_NOT_SUPPORTED,
4649 _("Operation not supported"));
4653 if (iface->eject_mountable_with_operation != NULL)
4654 (* iface->eject_mountable_with_operation) (file,
4661 (* iface->eject_mountable) (file,
4669 * g_file_eject_mountable_with_operation_finish:
4670 * @file: input #GFile.
4671 * @result: a #GAsyncResult.
4672 * @error: a #GError, or %NULL
4674 * Finishes an asynchronous eject operation started by
4675 * g_file_eject_mountable_with_operation().
4677 * Returns: %TRUE if the @file was ejected successfully. %FALSE
4683 g_file_eject_mountable_with_operation_finish (GFile *file,
4684 GAsyncResult *result,
4689 g_return_val_if_fail (G_IS_FILE (file), FALSE);
4690 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
4692 if (g_async_result_legacy_propagate_error (result, error))
4695 iface = G_FILE_GET_IFACE (file);
4696 if (iface->eject_mountable_with_operation_finish != NULL)
4697 return (* iface->eject_mountable_with_operation_finish) (file, result, error);
4699 return (* iface->eject_mountable_finish) (file, result, error);
4703 * g_file_monitor_directory:
4704 * @file: input #GFile.
4705 * @flags: a set of #GFileMonitorFlags.
4706 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4707 * @error: a #GError, or %NULL.
4709 * Obtains a directory monitor for the given file.
4710 * This may fail if directory monitoring is not supported.
4712 * If @cancellable is not %NULL, then the operation can be cancelled by
4713 * triggering the cancellable object from another thread. If the operation
4714 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4716 * Virtual: monitor_dir
4717 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4718 * Free the returned object with g_object_unref().
4721 g_file_monitor_directory (GFile *file,
4722 GFileMonitorFlags flags,
4723 GCancellable *cancellable,
4728 g_return_val_if_fail (G_IS_FILE (file), NULL);
4730 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4733 iface = G_FILE_GET_IFACE (file);
4735 if (iface->monitor_dir == NULL)
4737 g_set_error_literal (error, G_IO_ERROR,
4738 G_IO_ERROR_NOT_SUPPORTED,
4739 _("Operation not supported"));
4743 return (* iface->monitor_dir) (file, flags, cancellable, error);
4747 * g_file_monitor_file:
4748 * @file: input #GFile.
4749 * @flags: a set of #GFileMonitorFlags.
4750 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
4751 * @error: a #GError, or %NULL.
4753 * Obtains a file monitor for the given file. If no file notification
4754 * mechanism exists, then regular polling of the file is used.
4756 * If @cancellable is not %NULL, then the operation can be cancelled by
4757 * triggering the cancellable object from another thread. If the operation
4758 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4760 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4761 * Free the returned object with g_object_unref().
4764 g_file_monitor_file (GFile *file,
4765 GFileMonitorFlags flags,
4766 GCancellable *cancellable,
4770 GFileMonitor *monitor;
4772 g_return_val_if_fail (G_IS_FILE (file), NULL);
4774 if (g_cancellable_set_error_if_cancelled (cancellable, error))
4777 iface = G_FILE_GET_IFACE (file);
4781 if (iface->monitor_file)
4782 monitor = (* iface->monitor_file) (file, flags, cancellable, NULL);
4784 /* Fallback to polling */
4785 if (monitor == NULL)
4786 monitor = _g_poll_file_monitor_new (file);
4793 * @file: input #GFile
4794 * @flags: a set of #GFileMonitorFlags
4795 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
4796 * @error: a #GError, or %NULL
4798 * Obtains a file or directory monitor for the given file, depending
4799 * on the type of the file.
4801 * If @cancellable is not %NULL, then the operation can be cancelled by
4802 * triggering the cancellable object from another thread. If the operation
4803 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4805 * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error.
4806 * Free the returned object with g_object_unref().
4811 g_file_monitor (GFile *file,
4812 GFileMonitorFlags flags,
4813 GCancellable *cancellable,
4816 if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY)
4817 return g_file_monitor_directory (file, flags, cancellable, error);
4819 return g_file_monitor_file (file, flags, cancellable, error);
4822 /********************************************
4823 * Default implementation of async ops *
4824 ********************************************/
4828 GFileQueryInfoFlags flags;
4830 } QueryInfoAsyncData;
4833 query_info_data_free (QueryInfoAsyncData *data)
4836 g_object_unref (data->info);
4837 g_free (data->attributes);
4842 query_info_async_thread (GSimpleAsyncResult *res,
4844 GCancellable *cancellable)
4846 GError *error = NULL;
4847 QueryInfoAsyncData *data;
4850 data = g_simple_async_result_get_op_res_gpointer (res);
4852 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
4855 g_simple_async_result_take_error (res, error);
4861 g_file_real_query_info_async (GFile *file,
4862 const char *attributes,
4863 GFileQueryInfoFlags flags,
4865 GCancellable *cancellable,
4866 GAsyncReadyCallback callback,
4869 GSimpleAsyncResult *res;
4870 QueryInfoAsyncData *data;
4872 data = g_new0 (QueryInfoAsyncData, 1);
4873 data->attributes = g_strdup (attributes);
4874 data->flags = flags;
4876 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async);
4877 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free);
4879 g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable);
4880 g_object_unref (res);
4884 g_file_real_query_info_finish (GFile *file,
4888 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4889 QueryInfoAsyncData *data;
4891 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_info_async);
4893 if (g_simple_async_result_propagate_error (simple, error))
4896 data = g_simple_async_result_get_op_res_gpointer (simple);
4898 return g_object_ref (data->info);
4906 } QueryFilesystemInfoAsyncData;
4909 query_filesystem_info_data_free (QueryFilesystemInfoAsyncData *data)
4912 g_object_unref (data->info);
4913 g_free (data->attributes);
4918 query_filesystem_info_async_thread (GSimpleAsyncResult *res,
4920 GCancellable *cancellable)
4922 GError *error = NULL;
4923 QueryFilesystemInfoAsyncData *data;
4926 data = g_simple_async_result_get_op_res_gpointer (res);
4928 info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error);
4931 g_simple_async_result_take_error (res, error);
4937 g_file_real_query_filesystem_info_async (GFile *file,
4938 const char *attributes,
4940 GCancellable *cancellable,
4941 GAsyncReadyCallback callback,
4944 GSimpleAsyncResult *res;
4945 QueryFilesystemInfoAsyncData *data;
4947 data = g_new0 (QueryFilesystemInfoAsyncData, 1);
4948 data->attributes = g_strdup (attributes);
4950 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async);
4951 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free);
4953 g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable);
4954 g_object_unref (res);
4958 g_file_real_query_filesystem_info_finish (GFile *file,
4962 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
4963 QueryFilesystemInfoAsyncData *data;
4965 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_query_filesystem_info_async);
4967 if (g_simple_async_result_propagate_error (simple, error))
4970 data = g_simple_async_result_get_op_res_gpointer (simple);
4972 return g_object_ref (data->info);
4979 GFileQueryInfoFlags flags;
4980 GFileEnumerator *enumerator;
4981 } EnumerateChildrenAsyncData;
4984 enumerate_children_data_free (EnumerateChildrenAsyncData *data)
4986 if (data->enumerator)
4987 g_object_unref (data->enumerator);
4988 g_free (data->attributes);
4993 enumerate_children_async_thread (GSimpleAsyncResult *res,
4995 GCancellable *cancellable)
4997 GError *error = NULL;
4998 EnumerateChildrenAsyncData *data;
4999 GFileEnumerator *enumerator;
5001 data = g_simple_async_result_get_op_res_gpointer (res);
5003 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5005 if (enumerator == NULL)
5006 g_simple_async_result_take_error (res, error);
5008 data->enumerator = enumerator;
5012 g_file_real_enumerate_children_async (GFile *file,
5013 const char *attributes,
5014 GFileQueryInfoFlags flags,
5016 GCancellable *cancellable,
5017 GAsyncReadyCallback callback,
5020 GSimpleAsyncResult *res;
5021 EnumerateChildrenAsyncData *data;
5023 data = g_new0 (EnumerateChildrenAsyncData, 1);
5024 data->attributes = g_strdup (attributes);
5025 data->flags = flags;
5027 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async);
5028 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free);
5030 g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable);
5031 g_object_unref (res);
5034 static GFileEnumerator *
5035 g_file_real_enumerate_children_finish (GFile *file,
5039 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5040 EnumerateChildrenAsyncData *data;
5042 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_enumerate_children_async);
5044 if (g_simple_async_result_propagate_error (simple, error))
5047 data = g_simple_async_result_get_op_res_gpointer (simple);
5048 if (data->enumerator)
5049 return g_object_ref (data->enumerator);
5055 open_read_async_thread (GSimpleAsyncResult *res,
5057 GCancellable *cancellable)
5060 GFileInputStream *stream;
5061 GError *error = NULL;
5063 iface = G_FILE_GET_IFACE (object);
5065 if (iface->read_fn == NULL)
5067 g_set_error_literal (&error, G_IO_ERROR,
5068 G_IO_ERROR_NOT_SUPPORTED,
5069 _("Operation not supported"));
5071 g_simple_async_result_take_error (res, error);
5076 stream = iface->read_fn (G_FILE (object), cancellable, &error);
5079 g_simple_async_result_take_error (res, error);
5081 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5085 g_file_real_read_async (GFile *file,
5087 GCancellable *cancellable,
5088 GAsyncReadyCallback callback,
5091 GSimpleAsyncResult *res;
5093 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async);
5095 g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable);
5096 g_object_unref (res);
5099 static GFileInputStream *
5100 g_file_real_read_finish (GFile *file,
5104 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5107 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_read_async);
5109 if (g_simple_async_result_propagate_error (simple, error))
5112 op = g_simple_async_result_get_op_res_gpointer (simple);
5114 return g_object_ref (op);
5120 append_to_async_thread (GSimpleAsyncResult *res,
5122 GCancellable *cancellable)
5125 GFileCreateFlags *data;
5126 GFileOutputStream *stream;
5127 GError *error = NULL;
5129 iface = G_FILE_GET_IFACE (object);
5131 data = g_simple_async_result_get_op_res_gpointer (res);
5133 stream = iface->append_to (G_FILE (object), *data, cancellable, &error);
5136 g_simple_async_result_take_error (res, error);
5138 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5142 g_file_real_append_to_async (GFile *file,
5143 GFileCreateFlags flags,
5145 GCancellable *cancellable,
5146 GAsyncReadyCallback callback,
5149 GFileCreateFlags *data;
5150 GSimpleAsyncResult *res;
5152 data = g_new0 (GFileCreateFlags, 1);
5155 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_append_to_async);
5156 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5158 g_simple_async_result_run_in_thread (res, append_to_async_thread, io_priority, cancellable);
5159 g_object_unref (res);
5162 static GFileOutputStream *
5163 g_file_real_append_to_finish (GFile *file,
5167 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5170 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_append_to_async);
5172 if (g_simple_async_result_propagate_error (simple, error))
5175 op = g_simple_async_result_get_op_res_gpointer (simple);
5177 return g_object_ref (op);
5183 create_async_thread (GSimpleAsyncResult *res,
5185 GCancellable *cancellable)
5188 GFileCreateFlags *data;
5189 GFileOutputStream *stream;
5190 GError *error = NULL;
5192 iface = G_FILE_GET_IFACE (object);
5194 data = g_simple_async_result_get_op_res_gpointer (res);
5196 stream = iface->create (G_FILE (object), *data, cancellable, &error);
5199 g_simple_async_result_take_error (res, error);
5201 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5205 g_file_real_create_async (GFile *file,
5206 GFileCreateFlags flags,
5208 GCancellable *cancellable,
5209 GAsyncReadyCallback callback,
5212 GFileCreateFlags *data;
5213 GSimpleAsyncResult *res;
5215 data = g_new0 (GFileCreateFlags, 1);
5218 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_async);
5219 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5221 g_simple_async_result_run_in_thread (res, create_async_thread, io_priority, cancellable);
5222 g_object_unref (res);
5225 static GFileOutputStream *
5226 g_file_real_create_finish (GFile *file,
5230 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5233 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_async);
5235 if (g_simple_async_result_propagate_error (simple, error))
5238 op = g_simple_async_result_get_op_res_gpointer (simple);
5240 return g_object_ref (op);
5246 GFileOutputStream *stream;
5248 gboolean make_backup;
5249 GFileCreateFlags flags;
5253 replace_async_data_free (ReplaceAsyncData *data)
5256 g_object_unref (data->stream);
5257 g_free (data->etag);
5262 replace_async_thread (GSimpleAsyncResult *res,
5264 GCancellable *cancellable)
5267 GFileOutputStream *stream;
5268 GError *error = NULL;
5269 ReplaceAsyncData *data;
5271 iface = G_FILE_GET_IFACE (object);
5273 data = g_simple_async_result_get_op_res_gpointer (res);
5275 stream = iface->replace (G_FILE (object),
5283 g_simple_async_result_take_error (res, error);
5285 data->stream = stream;
5289 g_file_real_replace_async (GFile *file,
5291 gboolean make_backup,
5292 GFileCreateFlags flags,
5294 GCancellable *cancellable,
5295 GAsyncReadyCallback callback,
5298 GSimpleAsyncResult *res;
5299 ReplaceAsyncData *data;
5301 data = g_new0 (ReplaceAsyncData, 1);
5302 data->etag = g_strdup (etag);
5303 data->make_backup = make_backup;
5304 data->flags = flags;
5306 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_async);
5307 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_async_data_free);
5309 g_simple_async_result_run_in_thread (res, replace_async_thread, io_priority, cancellable);
5310 g_object_unref (res);
5313 static GFileOutputStream *
5314 g_file_real_replace_finish (GFile *file,
5318 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5319 ReplaceAsyncData *data;
5321 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_async);
5323 if (g_simple_async_result_propagate_error (simple, error))
5326 data = g_simple_async_result_get_op_res_gpointer (simple);
5328 return g_object_ref (data->stream);
5334 delete_async_thread (GSimpleAsyncResult *res,
5336 GCancellable *cancellable)
5339 GError *error = NULL;
5341 iface = G_FILE_GET_IFACE (object);
5343 if (!iface->delete_file (G_FILE (object),
5346 g_simple_async_result_take_error (res, error);
5350 g_file_real_delete_async (GFile *file,
5352 GCancellable *cancellable,
5353 GAsyncReadyCallback callback,
5356 GSimpleAsyncResult *res;
5358 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_delete_async);
5359 g_simple_async_result_run_in_thread (res, delete_async_thread, io_priority, cancellable);
5360 g_object_unref (res);
5364 g_file_real_delete_finish (GFile *file,
5368 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5370 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_delete_async);
5372 if (g_simple_async_result_propagate_error (simple, error))
5379 open_readwrite_async_thread (GSimpleAsyncResult *res,
5381 GCancellable *cancellable)
5384 GFileIOStream *stream;
5385 GError *error = NULL;
5387 iface = G_FILE_GET_IFACE (object);
5389 if (iface->open_readwrite == NULL)
5391 g_set_error_literal (&error, G_IO_ERROR,
5392 G_IO_ERROR_NOT_SUPPORTED,
5393 _("Operation not supported"));
5395 g_simple_async_result_take_error (res, error);
5400 stream = iface->open_readwrite (G_FILE (object), cancellable, &error);
5403 g_simple_async_result_take_error (res, error);
5405 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5409 g_file_real_open_readwrite_async (GFile *file,
5411 GCancellable *cancellable,
5412 GAsyncReadyCallback callback,
5415 GSimpleAsyncResult *res;
5417 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_open_readwrite_async);
5419 g_simple_async_result_run_in_thread (res, open_readwrite_async_thread, io_priority, cancellable);
5420 g_object_unref (res);
5423 static GFileIOStream *
5424 g_file_real_open_readwrite_finish (GFile *file,
5428 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5431 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_open_readwrite_async);
5433 if (g_simple_async_result_propagate_error (simple, error))
5436 op = g_simple_async_result_get_op_res_gpointer (simple);
5438 return g_object_ref (op);
5444 create_readwrite_async_thread (GSimpleAsyncResult *res,
5446 GCancellable *cancellable)
5449 GFileCreateFlags *data;
5450 GFileIOStream *stream;
5451 GError *error = NULL;
5453 iface = G_FILE_GET_IFACE (object);
5455 data = g_simple_async_result_get_op_res_gpointer (res);
5457 if (iface->create_readwrite == NULL)
5459 g_set_error_literal (&error, G_IO_ERROR,
5460 G_IO_ERROR_NOT_SUPPORTED,
5461 _("Operation not supported"));
5463 g_simple_async_result_take_error (res, error);
5468 stream = iface->create_readwrite (G_FILE (object), *data, cancellable, &error);
5471 g_simple_async_result_take_error (res, error);
5473 g_simple_async_result_set_op_res_gpointer (res, stream, g_object_unref);
5477 g_file_real_create_readwrite_async (GFile *file,
5478 GFileCreateFlags flags,
5480 GCancellable *cancellable,
5481 GAsyncReadyCallback callback,
5484 GFileCreateFlags *data;
5485 GSimpleAsyncResult *res;
5487 data = g_new0 (GFileCreateFlags, 1);
5490 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_create_readwrite_async);
5491 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)g_free);
5493 g_simple_async_result_run_in_thread (res, create_readwrite_async_thread, io_priority, cancellable);
5494 g_object_unref (res);
5497 static GFileIOStream *
5498 g_file_real_create_readwrite_finish (GFile *file,
5502 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5505 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_create_readwrite_async);
5507 if (g_simple_async_result_propagate_error (simple, error))
5510 op = g_simple_async_result_get_op_res_gpointer (simple);
5512 return g_object_ref (op);
5518 GFileIOStream *stream;
5520 gboolean make_backup;
5521 GFileCreateFlags flags;
5522 } ReplaceRWAsyncData;
5525 replace_rw_async_data_free (ReplaceRWAsyncData *data)
5528 g_object_unref (data->stream);
5529 g_free (data->etag);
5534 replace_readwrite_async_thread (GSimpleAsyncResult *res,
5536 GCancellable *cancellable)
5539 GFileIOStream *stream;
5540 GError *error = NULL;
5541 ReplaceRWAsyncData *data;
5543 iface = G_FILE_GET_IFACE (object);
5545 data = g_simple_async_result_get_op_res_gpointer (res);
5547 stream = iface->replace_readwrite (G_FILE (object),
5555 g_simple_async_result_take_error (res, error);
5557 data->stream = stream;
5561 g_file_real_replace_readwrite_async (GFile *file,
5563 gboolean make_backup,
5564 GFileCreateFlags flags,
5566 GCancellable *cancellable,
5567 GAsyncReadyCallback callback,
5570 GSimpleAsyncResult *res;
5571 ReplaceRWAsyncData *data;
5573 data = g_new0 (ReplaceRWAsyncData, 1);
5574 data->etag = g_strdup (etag);
5575 data->make_backup = make_backup;
5576 data->flags = flags;
5578 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_replace_readwrite_async);
5579 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_rw_async_data_free);
5581 g_simple_async_result_run_in_thread (res, replace_readwrite_async_thread, io_priority, cancellable);
5582 g_object_unref (res);
5585 static GFileIOStream *
5586 g_file_real_replace_readwrite_finish (GFile *file,
5590 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5591 ReplaceRWAsyncData *data;
5593 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_replace_readwrite_async);
5595 if (g_simple_async_result_propagate_error (simple, error))
5598 data = g_simple_async_result_get_op_res_gpointer (simple);
5600 return g_object_ref (data->stream);
5608 } SetDisplayNameAsyncData;
5611 set_display_name_data_free (SetDisplayNameAsyncData *data)
5613 g_free (data->name);
5615 g_object_unref (data->file);
5620 set_display_name_async_thread (GSimpleAsyncResult *res,
5622 GCancellable *cancellable)
5624 GError *error = NULL;
5625 SetDisplayNameAsyncData *data;
5628 data = g_simple_async_result_get_op_res_gpointer (res);
5630 file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error);
5633 g_simple_async_result_take_error (res, error);
5639 g_file_real_set_display_name_async (GFile *file,
5640 const char *display_name,
5642 GCancellable *cancellable,
5643 GAsyncReadyCallback callback,
5646 GSimpleAsyncResult *res;
5647 SetDisplayNameAsyncData *data;
5649 data = g_new0 (SetDisplayNameAsyncData, 1);
5650 data->name = g_strdup (display_name);
5652 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async);
5653 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free);
5655 g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable);
5656 g_object_unref (res);
5660 g_file_real_set_display_name_finish (GFile *file,
5664 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5665 SetDisplayNameAsyncData *data;
5667 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_display_name_async);
5669 if (g_simple_async_result_propagate_error (simple, error))
5672 data = g_simple_async_result_get_op_res_gpointer (simple);
5674 return g_object_ref (data->file);
5680 GFileQueryInfoFlags flags;
5687 set_info_data_free (SetInfoAsyncData *data)
5690 g_object_unref (data->info);
5692 g_error_free (data->error);
5697 set_info_async_thread (GSimpleAsyncResult *res,
5699 GCancellable *cancellable)
5701 SetInfoAsyncData *data;
5703 data = g_simple_async_result_get_op_res_gpointer (res);
5706 data->res = g_file_set_attributes_from_info (G_FILE (object),
5714 g_file_real_set_attributes_async (GFile *file,
5716 GFileQueryInfoFlags flags,
5718 GCancellable *cancellable,
5719 GAsyncReadyCallback callback,
5722 GSimpleAsyncResult *res;
5723 SetInfoAsyncData *data;
5725 data = g_new0 (SetInfoAsyncData, 1);
5726 data->info = g_file_info_dup (info);
5727 data->flags = flags;
5729 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async);
5730 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free);
5732 g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable);
5733 g_object_unref (res);
5737 g_file_real_set_attributes_finish (GFile *file,
5742 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5743 SetInfoAsyncData *data;
5745 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async);
5747 data = g_simple_async_result_get_op_res_gpointer (simple);
5750 *info = g_object_ref (data->info);
5752 if (error != NULL && data->error)
5753 *error = g_error_copy (data->error);
5759 find_enclosing_mount_async_thread (GSimpleAsyncResult *res,
5761 GCancellable *cancellable)
5763 GError *error = NULL;
5766 mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error);
5769 g_simple_async_result_take_error (res, error);
5771 g_simple_async_result_set_op_res_gpointer (res, mount, (GDestroyNotify)g_object_unref);
5775 g_file_real_find_enclosing_mount_async (GFile *file,
5777 GCancellable *cancellable,
5778 GAsyncReadyCallback callback,
5781 GSimpleAsyncResult *res;
5783 res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async);
5785 g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable);
5786 g_object_unref (res);
5790 g_file_real_find_enclosing_mount_finish (GFile *file,
5794 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5797 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_find_enclosing_mount_async);
5799 if (g_simple_async_result_propagate_error (simple, error))
5802 mount = g_simple_async_result_get_op_res_gpointer (simple);
5803 return g_object_ref (mount);
5810 GFileCopyFlags flags;
5811 GFileProgressCallback progress_cb;
5812 gpointer progress_cb_data;
5813 GIOSchedulerJob *job;
5817 copy_async_data_free (CopyAsyncData *data)
5819 g_object_unref (data->source);
5820 g_object_unref (data->destination);
5825 CopyAsyncData *data;
5826 goffset current_num_bytes;
5827 goffset total_num_bytes;
5831 copy_async_progress_in_main (gpointer user_data)
5833 ProgressData *progress = user_data;
5834 CopyAsyncData *data = progress->data;
5836 data->progress_cb (progress->current_num_bytes,
5837 progress->total_num_bytes,
5838 data->progress_cb_data);
5844 copy_async_progress_callback (goffset current_num_bytes,
5845 goffset total_num_bytes,
5848 CopyAsyncData *data = user_data;
5849 ProgressData *progress;
5851 progress = g_new (ProgressData, 1);
5852 progress->data = data;
5853 progress->current_num_bytes = current_num_bytes;
5854 progress->total_num_bytes = total_num_bytes;
5856 g_io_scheduler_job_send_to_mainloop_async (data->job,
5857 copy_async_progress_in_main,
5863 copy_async_thread (GIOSchedulerJob *job,
5864 GCancellable *cancellable,
5867 GSimpleAsyncResult *res;
5868 CopyAsyncData *data;
5873 data = g_simple_async_result_get_op_res_gpointer (res);
5877 result = g_file_copy (data->source,
5881 (data->progress_cb != NULL) ? copy_async_progress_callback : NULL,
5886 g_simple_async_result_take_error (res, error);
5888 g_simple_async_result_complete_in_idle (res);
5894 g_file_real_copy_async (GFile *source,
5896 GFileCopyFlags flags,
5898 GCancellable *cancellable,
5899 GFileProgressCallback progress_callback,
5900 gpointer progress_callback_data,
5901 GAsyncReadyCallback callback,
5904 GSimpleAsyncResult *res;
5905 CopyAsyncData *data;
5907 data = g_new0 (CopyAsyncData, 1);
5908 data->source = g_object_ref (source);
5909 data->destination = g_object_ref (destination);
5910 data->flags = flags;
5911 data->progress_cb = progress_callback;
5912 data->progress_cb_data = progress_callback_data;
5914 res = g_simple_async_result_new (G_OBJECT (source), callback, user_data, g_file_real_copy_async);
5915 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)copy_async_data_free);
5917 g_io_scheduler_push_job (copy_async_thread, res, g_object_unref, io_priority, cancellable);
5921 g_file_real_copy_finish (GFile *file,
5925 GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res);
5927 if (g_simple_async_result_propagate_error (simple, error))
5934 /********************************************
5935 * Default VFS operations *
5936 ********************************************/
5939 * g_file_new_for_path:
5940 * @path: a string containing a relative or absolute path. The string
5941 * must be encoded in the glib filename encoding.
5943 * Constructs a #GFile for a given path. This operation never
5944 * fails, but the returned object might not support any I/O
5945 * operation if @path is malformed.
5947 * Returns: (transfer full): a new #GFile for the given @path.
5948 * Free the returned object with g_object_unref().
5951 g_file_new_for_path (const char *path)
5953 g_return_val_if_fail (path != NULL, NULL);
5955 return g_vfs_get_file_for_path (g_vfs_get_default (), path);
5959 * g_file_new_for_uri:
5960 * @uri: a UTF8 string containing a URI.
5962 * Constructs a #GFile for a given URI. This operation never
5963 * fails, but the returned object might not support any I/O
5964 * operation if @uri is malformed or if the uri type is
5967 * Returns: (transfer full): a new #GFile for the given @uri.
5968 * Free the returned object with g_object_unref().
5971 g_file_new_for_uri (const char *uri)
5973 g_return_val_if_fail (uri != NULL, NULL);
5975 return g_vfs_get_file_for_uri (g_vfs_get_default (), uri);
5980 * @tmpl: (type filename) (allow-none): Template for the file
5981 * name, as in g_file_open_tmp(), or %NULL for a default template.
5982 * @iostream: (out): on return, a #GFileIOStream for the created file.
5983 * @error: a #GError, or %NULL
5985 * Opens a file in the preferred directory for temporary files (as
5986 * returned by g_get_tmp_dir()) and returns a #GFile and
5987 * #GFileIOStream pointing to it.
5989 * @tmpl should be a string in the GLib file name encoding
5990 * containing a sequence of six 'X' characters, and containing no
5991 * directory components. If it is %NULL, a default template is used.
5993 * Unlike the other #GFile constructors, this will return %NULL if
5994 * a temporary file could not be created.
5996 * Returns: (transfer full): a new #GFile.
5997 * Free the returned object with g_object_unref().
6002 g_file_new_tmp (const char *tmpl,
6003 GFileIOStream **iostream,
6009 GFileOutputStream *output;
6011 g_return_val_if_fail (iostream != NULL, NULL);
6013 fd = g_file_open_tmp (tmpl, &path, error);
6017 file = g_file_new_for_path (path);
6019 output = _g_local_file_output_stream_new (fd);
6020 *iostream = _g_local_file_io_stream_new (G_LOCAL_FILE_OUTPUT_STREAM (output));
6022 g_object_unref (output);
6029 * g_file_parse_name:
6030 * @parse_name: a file name or path to be parsed.
6032 * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()).
6033 * This operation never fails, but the returned object might not support any I/O
6034 * operation if the @parse_name cannot be parsed.
6036 * Returns: (transfer full): a new #GFile.
6039 g_file_parse_name (const char *parse_name)
6041 g_return_val_if_fail (parse_name != NULL, NULL);
6043 return g_vfs_parse_name (g_vfs_get_default (), parse_name);
6047 is_valid_scheme_character (char c)
6049 return g_ascii_isalnum (c) || c == '+' || c == '-' || c == '.';
6052 /* Following RFC 2396, valid schemes are built like:
6053 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6056 has_valid_scheme (const char *uri)
6062 if (!g_ascii_isalpha (*p))
6067 } while (is_valid_scheme_character (*p));
6073 * g_file_new_for_commandline_arg:
6074 * @arg: a command line string.
6076 * Creates a #GFile with the given argument from the command line. The value of
6077 * @arg can be either a URI, an absolute path or a relative path resolved
6078 * relative to the current working directory.
6079 * This operation never fails, but the returned object might not support any
6080 * I/O operation if @arg points to a malformed path.
6082 * Returns: (transfer full): a new #GFile.
6083 * Free the returned object with g_object_unref().
6086 g_file_new_for_commandline_arg (const char *arg)
6092 g_return_val_if_fail (arg != NULL, NULL);
6094 if (g_path_is_absolute (arg))
6095 return g_file_new_for_path (arg);
6097 if (has_valid_scheme (arg))
6098 return g_file_new_for_uri (arg);
6100 current_dir = g_get_current_dir ();
6101 filename = g_build_filename (current_dir, arg, NULL);
6102 g_free (current_dir);
6104 file = g_file_new_for_path (filename);
6111 * g_file_mount_enclosing_volume:
6112 * @location: input #GFile.
6113 * @flags: flags affecting the operation
6114 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction.
6115 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
6116 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
6117 * @user_data: the data to pass to callback function
6119 * Starts a @mount_operation, mounting the volume that contains the file @location.
6121 * When this operation has completed, @callback will be called with
6122 * @user_user data, and the operation can be finalized with
6123 * g_file_mount_enclosing_volume_finish().
6125 * If @cancellable is not %NULL, then the operation can be cancelled by
6126 * triggering the cancellable object from another thread. If the operation
6127 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6130 g_file_mount_enclosing_volume (GFile *location,
6131 GMountMountFlags flags,
6132 GMountOperation *mount_operation,
6133 GCancellable *cancellable,
6134 GAsyncReadyCallback callback,
6139 g_return_if_fail (G_IS_FILE (location));
6141 iface = G_FILE_GET_IFACE (location);
6143 if (iface->mount_enclosing_volume == NULL)
6145 g_simple_async_report_error_in_idle (G_OBJECT (location),
6146 callback, user_data,
6147 G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
6148 _("volume doesn't implement mount"));
6153 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6158 * g_file_mount_enclosing_volume_finish:
6159 * @location: input #GFile.
6160 * @result: a #GAsyncResult.
6161 * @error: a #GError, or %NULL
6163 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6165 * Returns: %TRUE if successful. If an error
6166 * has occurred, this function will return %FALSE and set @error
6167 * appropriately if present.
6170 g_file_mount_enclosing_volume_finish (GFile *location,
6171 GAsyncResult *result,
6176 g_return_val_if_fail (G_IS_FILE (location), FALSE);
6177 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
6179 if (g_async_result_legacy_propagate_error (result, error))
6182 iface = G_FILE_GET_IFACE (location);
6184 return (* iface->mount_enclosing_volume_finish) (location, result, error);
6187 /********************************************
6188 * Utility functions *
6189 ********************************************/
6192 * g_file_query_default_handler:
6193 * @file: a #GFile to open.
6194 * @cancellable: optional #GCancellable object, %NULL to ignore.
6195 * @error: a #GError, or %NULL
6197 * Returns the #GAppInfo that is registered as the default
6198 * application to handle the file specified by @file.
6200 * If @cancellable is not %NULL, then the operation can be cancelled by
6201 * triggering the cancellable object from another thread. If the operation
6202 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6204 * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors.
6205 * When you are done with it, release it with g_object_unref()
6208 g_file_query_default_handler (GFile *file,
6209 GCancellable *cancellable,
6213 const char *content_type;
6218 uri_scheme = g_file_get_uri_scheme (file);
6219 if (uri_scheme && uri_scheme[0] != '\0')
6221 appinfo = g_app_info_get_default_for_uri_scheme (uri_scheme);
6222 g_free (uri_scheme);
6224 if (appinfo != NULL)
6228 info = g_file_query_info (file,
6229 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6238 content_type = g_file_info_get_content_type (info);
6241 /* Don't use is_native(), as we want to support fuse paths if available */
6242 path = g_file_get_path (file);
6243 appinfo = g_app_info_get_default_for_type (content_type,
6248 g_object_unref (info);
6250 if (appinfo != NULL)
6253 g_set_error_literal (error, G_IO_ERROR,
6254 G_IO_ERROR_NOT_SUPPORTED,
6255 _("No application is registered as handling this file"));
6261 #define GET_CONTENT_BLOCK_SIZE 8192
6264 * g_file_load_contents:
6265 * @file: input #GFile.
6266 * @cancellable: optional #GCancellable object, %NULL to ignore.
6267 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6268 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6269 * or %NULL if the length is not needed
6270 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6271 * or %NULL if the entity tag is not needed
6272 * @error: a #GError, or %NULL
6274 * Loads the content of the file into memory. The data is always
6275 * zero-terminated, but this is not included in the resultant @length.
6276 * The returned @content should be freed with g_free() when no longer
6279 * If @cancellable is not %NULL, then the operation can be cancelled by
6280 * triggering the cancellable object from another thread. If the operation
6281 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6283 * Returns: %TRUE if the @file's contents were successfully loaded.
6284 * %FALSE if there were errors.
6287 g_file_load_contents (GFile *file,
6288 GCancellable *cancellable,
6294 GFileInputStream *in;
6295 GByteArray *content;
6300 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6301 g_return_val_if_fail (contents != NULL, FALSE);
6303 in = g_file_read (file, cancellable, error);
6307 content = g_byte_array_new ();
6310 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6311 while ((res = g_input_stream_read (G_INPUT_STREAM (in),
6312 content->data + pos,
6313 GET_CONTENT_BLOCK_SIZE,
6314 cancellable, error)) > 0)
6317 g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1);
6324 info = g_file_input_stream_query_info (in,
6325 G_FILE_ATTRIBUTE_ETAG_VALUE,
6330 *etag_out = g_strdup (g_file_info_get_etag (info));
6331 g_object_unref (info);
6335 /* Ignore errors on close */
6336 g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL);
6337 g_object_unref (in);
6341 /* error is set already */
6342 g_byte_array_free (content, TRUE);
6349 /* Zero terminate (we got an extra byte allocated for this */
6350 content->data[pos] = 0;
6352 *contents = (char *)g_byte_array_free (content, FALSE);
6360 GCancellable *cancellable;
6361 GFileReadMoreCallback read_more_callback;
6362 GAsyncReadyCallback callback;
6364 GByteArray *content;
6371 load_contents_data_free (LoadContentsData *data)
6374 g_error_free (data->error);
6375 if (data->cancellable)
6376 g_object_unref (data->cancellable);
6378 g_byte_array_free (data->content, TRUE);
6379 g_free (data->etag);
6380 g_object_unref (data->file);
6385 load_contents_close_callback (GObject *obj,
6386 GAsyncResult *close_res,
6389 GInputStream *stream = G_INPUT_STREAM (obj);
6390 LoadContentsData *data = user_data;
6391 GSimpleAsyncResult *res;
6393 /* Ignore errors here, we're only reading anyway */
6394 g_input_stream_close_finish (stream, close_res, NULL);
6395 g_object_unref (stream);
6397 res = g_simple_async_result_new (G_OBJECT (data->file),
6400 g_file_load_contents_async);
6401 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free);
6402 g_simple_async_result_complete (res);
6403 g_object_unref (res);
6407 load_contents_fstat_callback (GObject *obj,
6408 GAsyncResult *stat_res,
6411 GInputStream *stream = G_INPUT_STREAM (obj);
6412 LoadContentsData *data = user_data;
6415 info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream),
6419 data->etag = g_strdup (g_file_info_get_etag (info));
6420 g_object_unref (info);
6423 g_input_stream_close_async (stream, 0,
6425 load_contents_close_callback, data);
6429 load_contents_read_callback (GObject *obj,
6430 GAsyncResult *read_res,
6433 GInputStream *stream = G_INPUT_STREAM (obj);
6434 LoadContentsData *data = user_data;
6435 GError *error = NULL;
6438 read_size = g_input_stream_read_finish (stream, read_res, &error);
6442 /* Error or EOF, close the file */
6443 data->error = error;
6444 g_input_stream_close_async (stream, 0,
6446 load_contents_close_callback, data);
6448 else if (read_size == 0)
6450 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6451 G_FILE_ATTRIBUTE_ETAG_VALUE,
6454 load_contents_fstat_callback,
6457 else if (read_size > 0)
6459 data->pos += read_size;
6461 g_byte_array_set_size (data->content,
6462 data->pos + GET_CONTENT_BLOCK_SIZE);
6465 if (data->read_more_callback &&
6466 !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data))
6467 g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream),
6468 G_FILE_ATTRIBUTE_ETAG_VALUE,
6471 load_contents_fstat_callback,
6474 g_input_stream_read_async (stream,
6475 data->content->data + data->pos,
6476 GET_CONTENT_BLOCK_SIZE,
6479 load_contents_read_callback,
6485 load_contents_open_callback (GObject *obj,
6486 GAsyncResult *open_res,
6489 GFile *file = G_FILE (obj);
6490 GFileInputStream *stream;
6491 LoadContentsData *data = user_data;
6492 GError *error = NULL;
6493 GSimpleAsyncResult *res;
6495 stream = g_file_read_finish (file, open_res, &error);
6499 g_byte_array_set_size (data->content,
6500 data->pos + GET_CONTENT_BLOCK_SIZE);
6501 g_input_stream_read_async (G_INPUT_STREAM (stream),
6502 data->content->data + data->pos,
6503 GET_CONTENT_BLOCK_SIZE,
6506 load_contents_read_callback,
6512 res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6516 g_simple_async_result_complete (res);
6517 load_contents_data_free (data);
6518 g_object_unref (res);
6523 * g_file_load_partial_contents_async: (skip)
6524 * @file: input #GFile.
6525 * @cancellable: optional #GCancellable object, %NULL to ignore.
6526 * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read.
6527 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6528 * @user_data: the data to pass to the callback functions.
6530 * Reads the partial contents of a file. A #GFileReadMoreCallback should be
6531 * used to stop reading from the file when appropriate, else this function
6532 * will behave exactly as g_file_load_contents_async(). This operation
6533 * can be finished by g_file_load_partial_contents_finish().
6535 * Users of this function should be aware that @user_data is passed to
6536 * both the @read_more_callback and the @callback.
6538 * If @cancellable is not %NULL, then the operation can be cancelled by
6539 * triggering the cancellable object from another thread. If the operation
6540 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6543 g_file_load_partial_contents_async (GFile *file,
6544 GCancellable *cancellable,
6545 GFileReadMoreCallback read_more_callback,
6546 GAsyncReadyCallback callback,
6549 LoadContentsData *data;
6551 g_return_if_fail (G_IS_FILE (file));
6553 data = g_new0 (LoadContentsData, 1);
6556 data->cancellable = g_object_ref (cancellable);
6557 data->read_more_callback = read_more_callback;
6558 data->callback = callback;
6559 data->user_data = user_data;
6560 data->content = g_byte_array_new ();
6561 data->file = g_object_ref (file);
6563 g_file_read_async (file,
6566 load_contents_open_callback,
6571 * g_file_load_partial_contents_finish:
6572 * @file: input #GFile.
6573 * @res: a #GAsyncResult.
6574 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6575 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6576 * or %NULL if the length is not needed
6577 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6578 * or %NULL if the entity tag is not needed
6579 * @error: a #GError, or %NULL
6581 * Finishes an asynchronous partial load operation that was started
6582 * with g_file_load_partial_contents_async(). The data is always
6583 * zero-terminated, but this is not included in the resultant @length.
6584 * The returned @content should be freed with g_free() when no longer
6587 * Returns: %TRUE if the load was successful. If %FALSE and @error is
6588 * present, it will be set appropriately.
6591 g_file_load_partial_contents_finish (GFile *file,
6598 GSimpleAsyncResult *simple;
6599 LoadContentsData *data;
6601 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6602 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
6603 g_return_val_if_fail (contents != NULL, FALSE);
6605 simple = G_SIMPLE_ASYNC_RESULT (res);
6607 if (g_simple_async_result_propagate_error (simple, error))
6610 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async);
6612 data = g_simple_async_result_get_op_res_gpointer (simple);
6616 g_propagate_error (error, data->error);
6625 *length = data->pos;
6629 *etag_out = data->etag;
6633 /* Zero terminate */
6634 g_byte_array_set_size (data->content, data->pos + 1);
6635 data->content->data[data->pos] = 0;
6637 *contents = (char *)g_byte_array_free (data->content, FALSE);
6638 data->content = NULL;
6644 * g_file_load_contents_async:
6645 * @file: input #GFile.
6646 * @cancellable: optional #GCancellable object, %NULL to ignore.
6647 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6648 * @user_data: the data to pass to callback function
6650 * Starts an asynchronous load of the @file's contents.
6652 * For more details, see g_file_load_contents() which is
6653 * the synchronous version of this call.
6655 * When the load operation has completed, @callback will be called
6656 * with @user data. To finish the operation, call
6657 * g_file_load_contents_finish() with the #GAsyncResult returned by
6660 * If @cancellable is not %NULL, then the operation can be cancelled by
6661 * triggering the cancellable object from another thread. If the operation
6662 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6665 g_file_load_contents_async (GFile *file,
6666 GCancellable *cancellable,
6667 GAsyncReadyCallback callback,
6670 g_file_load_partial_contents_async (file,
6673 callback, user_data);
6677 * g_file_load_contents_finish:
6678 * @file: input #GFile.
6679 * @res: a #GAsyncResult.
6680 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file.
6681 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6682 * or %NULL if the length is not needed
6683 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6684 * or %NULL if the entity tag is not needed
6685 * @error: a #GError, or %NULL
6687 * Finishes an asynchronous load of the @file's contents.
6688 * The contents are placed in @contents, and @length is set to the
6689 * size of the @contents string. The @content should be freed with
6690 * g_free() when no longer needed. If @etag_out is present, it will be
6691 * set to the new entity tag for the @file.
6693 * Returns: %TRUE if the load was successful. If %FALSE and @error is
6694 * present, it will be set appropriately.
6697 g_file_load_contents_finish (GFile *file,
6704 return g_file_load_partial_contents_finish (file,
6713 * g_file_replace_contents:
6714 * @file: input #GFile.
6715 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file.
6716 * @length: the length of @contents in bytes.
6717 * @etag: (allow-none): the old <link linkend="gfile-etag">entity tag</link>
6718 * for the document, or %NULL
6719 * @make_backup: %TRUE if a backup should be created.
6720 * @flags: a set of #GFileCreateFlags.
6721 * @new_etag: (allow-none) (out): a location to a new <link linkend="gfile-etag">entity tag</link>
6722 * for the document. This should be freed with g_free() when no longer
6724 * @cancellable: optional #GCancellable object, %NULL to ignore.
6725 * @error: a #GError, or %NULL
6727 * Replaces the contents of @file with @contents of @length bytes.
6729 * If @etag is specified (not %NULL) any existing file must have that etag, or
6730 * the error %G_IO_ERROR_WRONG_ETAG will be returned.
6732 * If @make_backup is %TRUE, this function will attempt to make a backup of @file.
6734 * If @cancellable is not %NULL, then the operation can be cancelled by
6735 * triggering the cancellable object from another thread. If the operation
6736 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6738 * The returned @new_etag can be used to verify that the file hasn't changed the
6739 * next time it is saved over.
6741 * Returns: %TRUE if successful. If an error
6742 * has occurred, this function will return %FALSE and set @error
6743 * appropriately if present.
6746 g_file_replace_contents (GFile *file,
6747 const char *contents,
6750 gboolean make_backup,
6751 GFileCreateFlags flags,
6753 GCancellable *cancellable,
6756 GFileOutputStream *out;
6757 gsize pos, remainder;
6761 g_return_val_if_fail (G_IS_FILE (file), FALSE);
6762 g_return_val_if_fail (contents != NULL, FALSE);
6764 out = g_file_replace (file, etag, make_backup, flags, cancellable, error);
6770 while (remainder > 0 &&
6771 (res = g_output_stream_write (G_OUTPUT_STREAM (out),
6773 MIN (remainder, GET_CONTENT_BLOCK_SIZE),
6781 if (remainder > 0 && res < 0)
6783 /* Ignore errors on close */
6784 g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, NULL);
6785 g_object_unref (out);
6787 /* error is set already */
6791 ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error);
6794 *new_etag = g_file_output_stream_get_etag (out);
6796 g_object_unref (out);
6804 GCancellable *cancellable;
6805 GAsyncReadyCallback callback;
6807 const char *content;
6811 } ReplaceContentsData;
6814 replace_contents_data_free (ReplaceContentsData *data)
6817 g_error_free (data->error);
6818 if (data->cancellable)
6819 g_object_unref (data->cancellable);
6820 g_object_unref (data->file);
6821 g_free (data->etag);
6826 replace_contents_close_callback (GObject *obj,
6827 GAsyncResult *close_res,
6830 GOutputStream *stream = G_OUTPUT_STREAM (obj);
6831 ReplaceContentsData *data = user_data;
6832 GSimpleAsyncResult *res;
6834 /* Ignore errors here, we're only reading anyway */
6835 g_output_stream_close_finish (stream, close_res, NULL);
6836 g_object_unref (stream);
6838 data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream));
6840 res = g_simple_async_result_new (G_OBJECT (data->file),
6843 g_file_replace_contents_async);
6844 g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free);
6845 g_simple_async_result_complete (res);
6846 g_object_unref (res);
6850 replace_contents_write_callback (GObject *obj,
6851 GAsyncResult *read_res,
6854 GOutputStream *stream = G_OUTPUT_STREAM (obj);
6855 ReplaceContentsData *data = user_data;
6856 GError *error = NULL;
6859 write_size = g_output_stream_write_finish (stream, read_res, &error);
6861 if (write_size <= 0)
6863 /* Error or EOF, close the file */
6865 data->error = error;
6866 g_output_stream_close_async (stream, 0,
6868 replace_contents_close_callback, data);
6870 else if (write_size > 0)
6872 data->pos += write_size;
6874 if (data->pos >= data->length)
6875 g_output_stream_close_async (stream, 0,
6877 replace_contents_close_callback, data);
6879 g_output_stream_write_async (stream,
6880 data->content + data->pos,
6881 data->length - data->pos,
6884 replace_contents_write_callback,
6890 replace_contents_open_callback (GObject *obj,
6891 GAsyncResult *open_res,
6894 GFile *file = G_FILE (obj);
6895 GFileOutputStream *stream;
6896 ReplaceContentsData *data = user_data;
6897 GError *error = NULL;
6898 GSimpleAsyncResult *res;
6900 stream = g_file_replace_finish (file, open_res, &error);
6904 g_output_stream_write_async (G_OUTPUT_STREAM (stream),
6905 data->content + data->pos,
6906 data->length - data->pos,
6909 replace_contents_write_callback,
6915 res = g_simple_async_result_new_take_error (G_OBJECT (data->file),
6919 g_simple_async_result_complete (res);
6920 replace_contents_data_free (data);
6921 g_object_unref (res);
6926 * g_file_replace_contents_async:
6927 * @file: input #GFile.
6928 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with.
6929 * @length: the length of @contents in bytes.
6930 * @etag: (allow-none): a new <link linkend="gfile-etag">entity tag</link> for the @file, or %NULL
6931 * @make_backup: %TRUE if a backup should be created.
6932 * @flags: a set of #GFileCreateFlags.
6933 * @cancellable: optional #GCancellable object, %NULL to ignore.
6934 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6935 * @user_data: the data to pass to callback function
6937 * Starts an asynchronous replacement of @file with the given
6938 * @contents of @length bytes. @etag will replace the document's
6939 * current entity tag.
6941 * When this operation has completed, @callback will be called with
6942 * @user_user data, and the operation can be finalized with
6943 * g_file_replace_contents_finish().
6945 * If @cancellable is not %NULL, then the operation can be cancelled by
6946 * triggering the cancellable object from another thread. If the operation
6947 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6949 * If @make_backup is %TRUE, this function will attempt to
6950 * make a backup of @file.
6953 g_file_replace_contents_async (GFile *file,
6954 const char *contents,
6957 gboolean make_backup,
6958 GFileCreateFlags flags,
6959 GCancellable *cancellable,
6960 GAsyncReadyCallback callback,
6963 ReplaceContentsData *data;
6965 g_return_if_fail (G_IS_FILE (file));
6966 g_return_if_fail (contents != NULL);
6968 data = g_new0 (ReplaceContentsData, 1);
6971 data->cancellable = g_object_ref (cancellable);
6972 data->callback = callback;
6973 data->user_data = user_data;
6974 data->content = contents;
6975 data->length = length;
6977 data->file = g_object_ref (file);
6979 g_file_replace_async (file,
6985 replace_contents_open_callback,
6990 * g_file_replace_contents_finish:
6991 * @file: input #GFile.
6992 * @res: a #GAsyncResult.
6993 * @new_etag: (out) (allow-none): a location of a new <link linkend="gfile-etag">entity tag</link>
6994 * for the document. This should be freed with g_free() when it is no
6995 * longer needed, or %NULL
6996 * @error: a #GError, or %NULL
6998 * Finishes an asynchronous replace of the given @file. See
6999 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7000 * tag for the document, if present.
7002 * Returns: %TRUE on success, %FALSE on failure.
7005 g_file_replace_contents_finish (GFile *file,
7010 GSimpleAsyncResult *simple;
7011 ReplaceContentsData *data;
7013 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7014 g_return_val_if_fail (G_IS_SIMPLE_ASYNC_RESULT (res), FALSE);
7016 simple = G_SIMPLE_ASYNC_RESULT (res);
7018 if (g_simple_async_result_propagate_error (simple, error))
7021 g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async);
7023 data = g_simple_async_result_get_op_res_gpointer (simple);
7027 g_propagate_error (error, data->error);
7035 *new_etag = data->etag;
7036 data->etag = NULL; /* Take ownership */
7043 * g_file_start_mountable:
7044 * @file: input #GFile.
7045 * @flags: flags affecting the operation
7046 * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
7047 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7048 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7049 * @user_data: the data to pass to callback function
7051 * Starts a file of type G_FILE_TYPE_MOUNTABLE.
7052 * Using @start_operation, you can request callbacks when, for instance,
7053 * passwords are needed during authentication.
7055 * If @cancellable is not %NULL, then the operation can be cancelled by
7056 * triggering the cancellable object from another thread. If the operation
7057 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7059 * When the operation is finished, @callback will be called. You can then call
7060 * g_file_mount_mountable_finish() to get the result of the operation.
7065 g_file_start_mountable (GFile *file,
7066 GDriveStartFlags flags,
7067 GMountOperation *start_operation,
7068 GCancellable *cancellable,
7069 GAsyncReadyCallback callback,
7074 g_return_if_fail (G_IS_FILE (file));
7076 iface = G_FILE_GET_IFACE (file);
7078 if (iface->start_mountable == NULL)
7080 g_simple_async_report_error_in_idle (G_OBJECT (file),
7084 G_IO_ERROR_NOT_SUPPORTED,
7085 _("Operation not supported"));
7089 (* iface->start_mountable) (file,
7098 * g_file_start_mountable_finish:
7099 * @file: input #GFile.
7100 * @result: a #GAsyncResult.
7101 * @error: a #GError, or %NULL
7103 * Finishes a start operation. See g_file_start_mountable() for details.
7105 * Finish an asynchronous start operation that was started
7106 * with g_file_start_mountable().
7108 * Returns: %TRUE if the operation finished successfully. %FALSE
7114 g_file_start_mountable_finish (GFile *file,
7115 GAsyncResult *result,
7120 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7121 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7123 if (g_async_result_legacy_propagate_error (result, error))
7126 iface = G_FILE_GET_IFACE (file);
7127 return (* iface->start_mountable_finish) (file, result, error);
7131 * g_file_stop_mountable:
7132 * @file: input #GFile.
7133 * @flags: flags affecting the operation
7134 * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction.
7135 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
7136 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7137 * @user_data: the data to pass to callback function
7139 * Stops a file of type G_FILE_TYPE_MOUNTABLE.
7141 * If @cancellable is not %NULL, then the operation can be cancelled by
7142 * triggering the cancellable object from another thread. If the operation
7143 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7145 * When the operation is finished, @callback will be called. You can then call
7146 * g_file_stop_mountable_finish() to get the result of the operation.
7151 g_file_stop_mountable (GFile *file,
7152 GMountUnmountFlags flags,
7153 GMountOperation *mount_operation,
7154 GCancellable *cancellable,
7155 GAsyncReadyCallback callback,
7160 g_return_if_fail (G_IS_FILE (file));
7162 iface = G_FILE_GET_IFACE (file);
7164 if (iface->stop_mountable == NULL)
7166 g_simple_async_report_error_in_idle (G_OBJECT (file),
7170 G_IO_ERROR_NOT_SUPPORTED,
7171 _("Operation not supported"));
7175 (* iface->stop_mountable) (file,
7184 * g_file_stop_mountable_finish:
7185 * @file: input #GFile.
7186 * @result: a #GAsyncResult.
7187 * @error: a #GError, or %NULL
7189 * Finishes an stop operation, see g_file_stop_mountable() for details.
7191 * Finish an asynchronous stop operation that was started
7192 * with g_file_stop_mountable().
7194 * Returns: %TRUE if the operation finished successfully. %FALSE
7200 g_file_stop_mountable_finish (GFile *file,
7201 GAsyncResult *result,
7206 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7207 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7209 if (g_async_result_legacy_propagate_error (result, error))
7212 iface = G_FILE_GET_IFACE (file);
7213 return (* iface->stop_mountable_finish) (file, result, error);
7217 * g_file_poll_mountable:
7218 * @file: input #GFile.
7219 * @cancellable: optional #GCancellable object, %NULL to ignore.
7220 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL.
7221 * @user_data: the data to pass to callback function
7223 * Polls a file of type G_FILE_TYPE_MOUNTABLE.
7225 * If @cancellable is not %NULL, then the operation can be cancelled by
7226 * triggering the cancellable object from another thread. If the operation
7227 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7229 * When the operation is finished, @callback will be called. You can then call
7230 * g_file_mount_mountable_finish() to get the result of the operation.
7235 g_file_poll_mountable (GFile *file,
7236 GCancellable *cancellable,
7237 GAsyncReadyCallback callback,
7242 g_return_if_fail (G_IS_FILE (file));
7244 iface = G_FILE_GET_IFACE (file);
7246 if (iface->poll_mountable == NULL)
7248 g_simple_async_report_error_in_idle (G_OBJECT (file),
7252 G_IO_ERROR_NOT_SUPPORTED,
7253 _("Operation not supported"));
7257 (* iface->poll_mountable) (file,
7264 * g_file_poll_mountable_finish:
7265 * @file: input #GFile.
7266 * @result: a #GAsyncResult.
7267 * @error: a #GError, or %NULL
7269 * Finishes a poll operation. See g_file_poll_mountable() for details.
7271 * Finish an asynchronous poll operation that was polled
7272 * with g_file_poll_mountable().
7274 * Returns: %TRUE if the operation finished successfully. %FALSE
7280 g_file_poll_mountable_finish (GFile *file,
7281 GAsyncResult *result,
7286 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7287 g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);
7289 if (g_async_result_legacy_propagate_error (result, error))
7292 iface = G_FILE_GET_IFACE (file);
7293 return (* iface->poll_mountable_finish) (file, result, error);
7297 * g_file_supports_thread_contexts:
7300 * Checks if @file supports <link
7301 * linkend="g-main-context-push-thread-default-context">thread-default
7302 * contexts</link>. If this returns %FALSE, you cannot perform
7303 * asynchronous operations on @file in a thread that has a
7304 * thread-default context.
7306 * Returns: Whether or not @file supports thread-default contexts.
7311 g_file_supports_thread_contexts (GFile *file)
7315 g_return_val_if_fail (G_IS_FILE (file), FALSE);
7317 iface = G_FILE_GET_IFACE (file);
7318 return iface->supports_thread_contexts;