| blob | a5709a4cc8074e4597fd287270bfacac6ad81731 |
1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
4 *
5 * Copyright (C) 2006-2007 Red Hat, Inc.
6 *
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
11 *
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
16 *
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
19 *
20 * Author: Alexander Larsson <alexl@redhat.com>
21 */
25 #ifdef __linux__
26 #include <sys/ioctl.h>
27 #include <errno.h>
28 /* See linux.git/fs/btrfs/ioctl.h */
29 #define BTRFS_IOCTL_MAGIC 0x94
30 #define BTRFS_IOC_CLONE _IOW(BTRFS_IOCTL_MAGIC, 9, int)
31 #endif
33 #ifdef HAVE_SPLICE
34 #include <sys/stat.h>
35 #include <unistd.h>
36 #include <fcntl.h>
37 #include <errno.h>
38 #endif
40 #include <string.h>
41 #include <sys/types.h>
45 #ifdef G_OS_UNIX
47 #endif
65 /**
66 * SECTION:gfile
67 * @short_description: File and Directory Handling
68 * @include: gio/gio.h
69 * @see_also: #GFileInfo, #GFileEnumerator
70 *
71 * #GFile is a high level abstraction for manipulating files on a
72 * virtual file system. #GFiles are lightweight, immutable objects
73 * that do no I/O upon creation. It is necessary to understand that
74 * #GFile objects do not represent files, merely an identifier for a
75 * file. All file content I/O is implemented as streaming operations
76 * (see #GInputStream and #GOutputStream).
77 *
78 * To construct a #GFile, you can use:
79 * - g_file_new_for_path() if you have a path.
80 * - g_file_new_for_uri() if you have a URI.
81 * - g_file_new_for_commandline_arg() for a command line argument.
82 * - g_file_new_tmp() to create a temporary file from a template.
83 * - g_file_parse_name() from a UTF-8 string gotten from g_file_get_parse_name().
84 * - g_file_new_build_filename() to create a file from path elements.
85 *
86 * One way to think of a #GFile is as an abstraction of a pathname. For
87 * normal files the system pathname is what is stored internally, but as
88 * #GFiles are extensible it could also be something else that corresponds
89 * to a pathname in a userspace implementation of a filesystem.
90 *
91 * #GFiles make up hierarchies of directories and files that correspond to
92 * the files on a filesystem. You can move through the file system with
93 * #GFile using g_file_get_parent() to get an identifier for the parent
94 * directory, g_file_get_child() to get a child within a directory,
95 * g_file_resolve_relative_path() to resolve a relative path between two
96 * #GFiles. There can be multiple hierarchies, so you may not end up at
97 * the same root if you repeatedly call g_file_get_parent() on two different
98 * files.
99 *
100 * All #GFiles have a basename (get with g_file_get_basename()). These names
101 * are byte strings that are used to identify the file on the filesystem
102 * (relative to its parent directory) and there is no guarantees that they
103 * have any particular charset encoding or even make any sense at all. If
104 * you want to use filenames in a user interface you should use the display
105 * name that you can get by requesting the
106 * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
107 * This is guaranteed to be in UTF-8 and can be used in a user interface.
108 * But always store the real basename or the #GFile to use to actually
109 * access the file, because there is no way to go from a display name to
110 * the actual name.
111 *
112 * Using #GFile as an identifier has the same weaknesses as using a path
113 * in that there may be multiple aliases for the same file. For instance,
114 * hard or soft links may cause two different #GFiles to refer to the same
115 * file. Other possible causes for aliases are: case insensitive filesystems,
116 * short and long names on FAT/NTFS, or bind mounts in Linux. If you want to
117 * check if two #GFiles point to the same file you can query for the
118 * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
119 * canonicalization of pathnames passed in, so that trivial differences in
120 * the path string used at creation (duplicated slashes, slash at end of
121 * path, "." or ".." path segments, etc) does not create different #GFiles.
122 *
123 * Many #GFile operations have both synchronous and asynchronous versions
124 * to suit your application. Asynchronous versions of synchronous functions
125 * simply have _async() appended to their function names. The asynchronous
126 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
127 * the operation, producing a GAsyncResult which is then passed to the
128 * function's matching _finish() operation.
129 *
130 * It is highly recommended to use asynchronous calls when running within a
131 * shared main loop, such as in the main thread of an application. This avoids
132 * I/O operations blocking other sources on the main loop from being dispatched.
133 * Synchronous I/O operations should be performed from worker threads. See the
134 * [introduction to asynchronous programming section][async-programming] for
135 * more.
136 *
137 * Some #GFile operations almost always take a noticeable amount of time, and
138 * so do not have synchronous analogs. Notable cases include:
139 * - g_file_mount_mountable() to mount a mountable file.
140 * - g_file_unmount_mountable_with_operation() to unmount a mountable file.
141 * - g_file_eject_mountable_with_operation() to eject a mountable file.
142 *
143 * ## Entity Tags # {#gfile-etag}
144 *
145 * One notable feature of #GFiles are entity tags, or "etags" for
146 * short. Entity tags are somewhat like a more abstract version of the
147 * traditional mtime, and can be used to quickly determine if the file
148 * has been modified from the version on the file system. See the
149 * HTTP 1.1
150 * [specification](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
151 * for HTTP Etag headers, which are a very similar concept.
152 */
156 GFileQueryInfoFlags flags,
159 GAsyncReadyCallback callback,
160 gpointer user_data);
168 GAsyncReadyCallback callback,
169 gpointer user_data);
175 GFileQueryInfoFlags flags,
178 GAsyncReadyCallback callback,
179 gpointer user_data);
186 GAsyncReadyCallback callback,
187 gpointer user_data);
192 GFileCreateFlags flags,
195 GAsyncReadyCallback callback,
196 gpointer user_data);
201 GFileCreateFlags flags,
204 GAsyncReadyCallback callback,
205 gpointer user_data);
211 gboolean make_backup,
212 GFileCreateFlags flags,
215 GAsyncReadyCallback callback,
216 gpointer user_data);
223 GAsyncReadyCallback callback,
224 gpointer user_data);
231 GAsyncReadyCallback callback,
232 gpointer user_data);
239 GAsyncReadyCallback callback,
240 gpointer user_data);
247 GAsyncReadyCallback callback,
248 gpointer user_data);
253 GFileCreateFlags flags,
256 GAsyncReadyCallback callback,
257 gpointer user_data);
263 gboolean make_backup,
264 GFileCreateFlags flags,
267 GAsyncReadyCallback callback,
268 gpointer user_data);
274 GFileQueryInfoFlags flags,
281 GAsyncReadyCallback callback,
282 gpointer user_data);
288 GFileQueryInfoFlags flags,
291 GAsyncReadyCallback callback,
292 gpointer user_data);
300 GAsyncReadyCallback callback,
301 gpointer user_data);
307 GFileCopyFlags flags,
310 GFileProgressCallback progress_callback,
311 gpointer progress_callback_data,
312 GAsyncReadyCallback callback,
313 gpointer user_data);
319 GFileMeasureFlags flags,
321 GFileMeasureProgressCallback progress_callback,
322 gpointer progress_data,
328 GFileMeasureFlags flags,
329 gint io_priority,
331 GFileMeasureProgressCallback progress_callback,
332 gpointer progress_data,
333 GAsyncReadyCallback callback,
334 gpointer user_data);
345 static void
347 {
386 }
389 /**
390 * g_file_is_native:
391 * @file: input #GFile
392 *
393 * Checks to see if a file is native to the platform.
394 *
395 * A native file is one expressed in the platform-native filename format,
396 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
397 * as it might be on a locally mounted remote filesystem.
398 *
399 * On some systems non-native files may be available using the native
400 * filesystem via a userspace filesystem (FUSE), in these cases this call
401 * will return %FALSE, but g_file_get_path() will still return a native path.
402 *
403 * This call does no blocking I/O.
404 *
405 * Returns: %TRUE if @file is native
406 */
407 gboolean
409 {
417 }
420 /**
421 * g_file_has_uri_scheme:
422 * @file: input #GFile
423 * @uri_scheme: a string containing a URI scheme
424 *
425 * Checks to see if a #GFile has a given URI scheme.
426 *
427 * This call does no blocking I/O.
428 *
429 * Returns: %TRUE if #GFile's backend supports the
430 * given URI scheme, %FALSE if URI scheme is %NULL,
431 * not supported, or #GFile is invalid.
432 */
433 gboolean
436 {
445 }
448 /**
449 * g_file_get_uri_scheme:
450 * @file: input #GFile
451 *
452 * Gets the URI scheme for a #GFile.
453 * RFC 3986 decodes the scheme as:
454 * |[
455 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
456 * ]|
457 * Common schemes include "file", "http", "ftp", etc.
458 *
459 * This call does no blocking I/O.
460 *
461 * Returns: a string containing the URI scheme for the given
462 * #GFile. The returned string should be freed with g_free()
463 * when no longer needed.
464 */
467 {
475 }
478 /**
479 * g_file_get_basename:
480 * @file: input #GFile
481 *
482 * Gets the base name (the last component of the path) for a given #GFile.
483 *
484 * If called for the top level of a system (such as the filesystem root
485 * or a uri like sftp://host/) it will return a single directory separator
486 * (and on Windows, possibly a drive letter).
487 *
488 * The base name is a byte string (not UTF-8). It has no defined encoding
489 * or rules other than it may not contain zero bytes. If you want to use
490 * filenames in a user interface you should use the display name that you
491 * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
492 * attribute with g_file_query_info().
493 *
494 * This call does no blocking I/O.
495 *
496 * Returns: (type filename) (nullable): string containing the #GFile's
497 * base name, or %NULL if given #GFile is invalid. The returned string
498 * should be freed with g_free() when no longer needed.
499 */
502 {
510 }
512 /**
513 * g_file_get_path:
514 * @file: input #GFile
515 *
516 * Gets the local pathname for #GFile, if one exists. If non-%NULL, this is
517 * guaranteed to be an absolute, canonical path. It might contain symlinks.
518 *
519 * This call does no blocking I/O.
520 *
521 * Returns: (type filename) (nullable): string containing the #GFile's path,
522 * or %NULL if no such path exists. The returned string should be freed
523 * with g_free() when no longer needed.
524 */
527 {
535 }
537 /* Original commit introducing this in libgsystem:
538 *
539 * fileutil: Handle recent: and trash: URIs
540 *
541 * The gs_file_get_path_cached() was rather brittle in its handling
542 * of URIs. It would assert() when a GFile didn't have a backing path
543 * (such as when handling trash: or recent: URIs), and didn't know
544 * how to get the target URI for those items either.
545 *
546 * Make sure that we do not assert() when a backing path cannot be
547 * found, and handle recent: and trash: URIs.
548 *
549 * https://bugzilla.gnome.org/show_bug.cgi?id=708435
550 */
553 {
558 info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TARGET_URI, G_FILE_QUERY_INFO_NONE, NULL, NULL);
566 }
570 {
577 /* We need to be careful about threading, as two threads calling
578 * g_file_peek_path() on the same file could race: both would see
579 * (g_object_get_qdata(…) == NULL) to begin with, both would generate and add
580 * the path, but the second thread to add it would end up freeing the path
581 * set by the first thread. The first thread would still return the pointer
582 * to that freed path, though, resulting an a read-after-free. Handle that
583 * with a compare-and-swap loop. The g_object_*_qdata() functions are atomic. */
586 {
597 else
602 /* By passing NULL here, we ensure we never replace existing data: */
607 else
609 }
612 }
614 /**
615 * g_file_peek_path:
616 * @file: input #GFile
617 *
618 * Exactly like g_file_get_path(), but caches the result via
619 * g_object_set_qdata_full(). This is useful for example in C
620 * applications which mix `g_file_*` APIs with native ones. It
621 * also avoids an extra duplicated string when possible, so will be
622 * generally more efficient.
623 *
624 * This call does no blocking I/O.
625 *
626 * Returns: (type filename) (nullable): string containing the #GFile's path,
627 * or %NULL if no such path exists. The returned string is owned by @file.
628 * Since: 2.56
629 */
632 {
636 }
638 /**
639 * g_file_get_uri:
640 * @file: input #GFile
641 *
642 * Gets the URI for the @file.
643 *
644 * This call does no blocking I/O.
645 *
646 * Returns: a string containing the #GFile's URI.
647 * The returned string should be freed with g_free()
648 * when no longer needed.
649 */
652 {
660 }
662 /**
663 * g_file_get_parse_name:
664 * @file: input #GFile
665 *
666 * Gets the parse name of the @file.
667 * A parse name is a UTF-8 string that describes the
668 * file such that one can get the #GFile back using
669 * g_file_parse_name().
670 *
671 * This is generally used to show the #GFile as a nice
672 * full-pathname kind of string in a user interface,
673 * like in a location entry.
674 *
675 * For local files with names that can safely be converted
676 * to UTF-8 the pathname is used, otherwise the IRI is used
677 * (a form of URI that allows UTF-8 characters unescaped).
678 *
679 * This call does no blocking I/O.
680 *
681 * Returns: a string containing the #GFile's parse name.
682 * The returned string should be freed with g_free()
683 * when no longer needed.
684 */
687 {
695 }
697 /**
698 * g_file_dup:
699 * @file: input #GFile
700 *
701 * Duplicates a #GFile handle. This operation does not duplicate
702 * the actual file or directory represented by the #GFile; see
703 * g_file_copy() if attempting to copy a file.
704 *
705 * g_file_dup() is useful when a second handle is needed to the same underlying
706 * file, for use in a separate thread (#GFile is not thread-safe). For use
707 * within the same thread, use g_object_ref() to increment the existing object’s
708 * reference count.
709 *
710 * This call does no blocking I/O.
711 *
712 * Returns: (transfer full): a new #GFile that is a duplicate
713 * of the given #GFile.
714 */
715 GFile *
717 {
725 }
727 /**
728 * g_file_hash:
729 * @file: (type GFile): #gconstpointer to a #GFile
730 *
731 * Creates a hash value for a #GFile.
732 *
733 * This call does no blocking I/O.
734 *
735 * Virtual: hash
736 * Returns: 0 if @file is not a valid #GFile, otherwise an
737 * integer that can be used as hash value for the #GFile.
738 * This function is intended for easily hashing a #GFile to
739 * add to a #GHashTable or similar data structure.
740 */
741 guint
743 {
751 }
753 /**
754 * g_file_equal:
755 * @file1: the first #GFile
756 * @file2: the second #GFile
757 *
758 * Checks if the two given #GFiles refer to the same file.
759 *
760 * Note that two #GFiles that differ can still refer to the same
761 * file on the filesystem due to various forms of filename
762 * aliasing.
763 *
764 * This call does no blocking I/O.
765 *
766 * Returns: %TRUE if @file1 and @file2 are equal.
767 */
768 gboolean
771 {
786 }
789 /**
790 * g_file_get_parent:
791 * @file: input #GFile
792 *
793 * Gets the parent directory for the @file.
794 * If the @file represents the root directory of the
795 * file system, then %NULL will be returned.
796 *
797 * This call does no blocking I/O.
798 *
799 * Returns: (nullable) (transfer full): a #GFile structure to the
800 * parent of the given #GFile or %NULL if there is no parent. Free
801 * the returned object with g_object_unref().
802 */
803 GFile *
805 {
813 }
815 /**
816 * g_file_has_parent:
817 * @file: input #GFile
818 * @parent: (nullable): the parent to check for, or %NULL
819 *
820 * Checks if @file has a parent, and optionally, if it is @parent.
821 *
822 * If @parent is %NULL then this function returns %TRUE if @file has any
823 * parent at all. If @parent is non-%NULL then %TRUE is only returned
824 * if @file is an immediate child of @parent.
825 *
826 * Returns: %TRUE if @file is an immediate child of @parent (or any parent in
827 * the case that @parent is %NULL).
828 *
829 * Since: 2.24
830 */
831 gboolean
834 {
836 gboolean result;
844 {
847 else
851 }
852 else
856 }
858 /**
859 * g_file_get_child:
860 * @file: input #GFile
861 * @name: (type filename): string containing the child's basename
862 *
863 * Gets a child of @file with basename equal to @name.
864 *
865 * Note that the file with that specific name might not exist, but
866 * you can still have a #GFile that points to it. You can use this
867 * for instance to create that file.
868 *
869 * This call does no blocking I/O.
870 *
871 * Returns: (transfer full): a #GFile to a child specified by @name.
872 * Free the returned object with g_object_unref().
873 */
874 GFile *
877 {
882 }
884 /**
885 * g_file_get_child_for_display_name:
886 * @file: input #GFile
887 * @display_name: string to a possible child
888 * @error: return location for an error
889 *
890 * Gets the child of @file for a given @display_name (i.e. a UTF-8
891 * version of the name). If this function fails, it returns %NULL
892 * and @error will be set. This is very useful when constructing a
893 * #GFile for a new file and the user entered the filename in the
894 * user interface, for instance when you select a directory and
895 * type a filename in the file selector.
896 *
897 * This call does no blocking I/O.
898 *
899 * Returns: (transfer full): a #GFile to the specified child, or
900 * %NULL if the display name couldn't be converted.
901 * Free the returned object with g_object_unref().
902 */
903 GFile *
907 {
916 }
918 /**
919 * g_file_has_prefix:
920 * @file: input #GFile
921 * @prefix: input #GFile
922 *
923 * Checks whether @file has the prefix specified by @prefix.
924 *
925 * In other words, if the names of initial elements of @file's
926 * pathname match @prefix. Only full pathname elements are matched,
927 * so a path like /foo is not considered a prefix of /foobar, only
928 * of /foo/bar.
929 *
930 * A #GFile is not a prefix of itself. If you want to check for
931 * equality, use g_file_equal().
932 *
933 * This call does no I/O, as it works purely on names. As such it can
934 * sometimes return %FALSE even if @file is inside a @prefix (from a
935 * filesystem point of view), because the prefix of @file is an alias
936 * of @prefix.
937 *
938 * Virtual: prefix_matches
939 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix,
940 * %FALSE otherwise.
941 */
942 gboolean
945 {
956 /* The vtable function differs in arg order since
957 * we're using the old contains_file call
958 */
960 }
962 /**
963 * g_file_get_relative_path:
964 * @parent: input #GFile
965 * @descendant: input #GFile
966 *
967 * Gets the path for @descendant relative to @parent.
968 *
969 * This call does no blocking I/O.
970 *
971 * Returns: (type filename) (nullable): string with the relative path from
972 * @descendant to @parent, or %NULL if @descendant doesn't have @parent as
973 * prefix. The returned string should be freed with g_free() when
974 * no longer needed.
975 */
979 {
991 }
993 /**
994 * g_file_resolve_relative_path:
995 * @file: input #GFile
996 * @relative_path: (type filename): a given relative path string
997 *
998 * Resolves a relative path for @file to an absolute path.
999 *
1000 * This call does no blocking I/O.
1001 *
1002 * Returns: (transfer full): #GFile to the resolved path.
1003 * %NULL if @relative_path is %NULL or if @file is invalid.
1004 * Free the returned object with g_object_unref().
1005 */
1006 GFile *
1009 {
1018 }
1020 /**
1021 * g_file_enumerate_children:
1022 * @file: input #GFile
1023 * @attributes: an attribute query string
1024 * @flags: a set of #GFileQueryInfoFlags
1025 * @cancellable: (nullable): optional #GCancellable object,
1026 * %NULL to ignore
1027 * @error: #GError for error reporting
1028 *
1029 * Gets the requested information about the files in a directory.
1030 * The result is a #GFileEnumerator object that will give out
1031 * #GFileInfo objects for all the files in the directory.
1032 *
1033 * The @attributes value is a string that specifies the file
1034 * attributes that should be gathered. It is not an error if
1035 * it's not possible to read a particular requested attribute
1036 * from a file - it just won't be set. @attributes should
1037 * be a comma-separated list of attributes or attribute wildcards.
1038 * The wildcard "*" means all attributes, and a wildcard like
1039 * "standard::*" means all attributes in the standard namespace.
1040 * An example attribute query be "standard::*,owner::user".
1041 * The standard attributes are available as defines, like
1042 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1043 *
1044 * If @cancellable is not %NULL, then the operation can be cancelled
1045 * by triggering the cancellable object from another thread. If the
1046 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1047 * returned.
1048 *
1049 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1050 * be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY
1051 * error will be returned. Other errors are possible too.
1052 *
1053 * Returns: (transfer full): A #GFileEnumerator if successful,
1054 * %NULL on error. Free the returned object with g_object_unref().
1055 */
1056 GFileEnumerator *
1059 GFileQueryInfoFlags flags,
1062 {
1073 {
1075 G_IO_ERROR_NOT_SUPPORTED,
1078 }
1082 }
1084 /**
1085 * g_file_enumerate_children_async:
1086 * @file: input #GFile
1087 * @attributes: an attribute query string
1088 * @flags: a set of #GFileQueryInfoFlags
1089 * @io_priority: the [I/O priority][io-priority] of the request
1090 * @cancellable: (nullable): optional #GCancellable object,
1091 * %NULL to ignore
1092 * @callback: (scope async): a #GAsyncReadyCallback to call when the
1093 * request is satisfied
1094 * @user_data: (closure): the data to pass to callback function
1095 *
1096 * Asynchronously gets the requested information about the files
1097 * in a directory. The result is a #GFileEnumerator object that will
1098 * give out #GFileInfo objects for all the files in the directory.
1099 *
1100 * For more details, see g_file_enumerate_children() which is
1101 * the synchronous version of this call.
1102 *
1103 * When the operation is finished, @callback will be called. You can
1104 * then call g_file_enumerate_children_finish() to get the result of
1105 * the operation.
1106 */
1107 void
1110 GFileQueryInfoFlags flags,
1113 GAsyncReadyCallback callback,
1114 gpointer user_data)
1115 {
1122 attributes,
1123 flags,
1124 io_priority,
1125 cancellable,
1126 callback,
1127 user_data);
1128 }
1130 /**
1131 * g_file_enumerate_children_finish:
1132 * @file: input #GFile
1133 * @res: a #GAsyncResult
1134 * @error: a #GError
1135 *
1136 * Finishes an async enumerate children operation.
1137 * See g_file_enumerate_children_async().
1138 *
1139 * Returns: (transfer full): a #GFileEnumerator or %NULL
1140 * if an error occurred.
1141 * Free the returned object with g_object_unref().
1142 */
1143 GFileEnumerator *
1147 {
1158 }
1160 /**
1161 * g_file_query_exists:
1162 * @file: input #GFile
1163 * @cancellable: (nullable): optional #GCancellable object,
1164 * %NULL to ignore
1165 *
1166 * Utility function to check if a particular file exists. This is
1167 * implemented using g_file_query_info() and as such does blocking I/O.
1168 *
1169 * Note that in many cases it is [racy to first check for file existence](https://en.wikipedia.org/wiki/Time_of_check_to_time_of_use)
1170 * and then execute something based on the outcome of that, because the
1171 * file might have been created or removed in between the operations. The
1172 * general approach to handling that is to not check, but just do the
1173 * operation and handle the errors as they come.
1174 *
1175 * As an example of race-free checking, take the case of reading a file,
1176 * and if it doesn't exist, creating it. There are two racy versions: read
1177 * it, and on error create it; and: check if it exists, if not create it.
1178 * These can both result in two processes creating the file (with perhaps
1179 * a partially written file as the result). The correct approach is to
1180 * always try to create the file with g_file_create() which will either
1181 * atomically create the file or fail with a %G_IO_ERROR_EXISTS error.
1182 *
1183 * However, in many cases an existence check is useful in a user interface,
1184 * for instance to make a menu item sensitive/insensitive, so that you don't
1185 * have to fool users that something is possible and then just show an error
1186 * dialog. If you do this, you should make sure to also handle the errors
1187 * that can happen due to races when you execute the operation.
1188 *
1189 * Returns: %TRUE if the file exists (and can be detected without error),
1190 * %FALSE otherwise (or if cancelled).
1191 */
1192 gboolean
1195 {
1203 {
1206 }
1209 }
1211 /**
1212 * g_file_query_file_type:
1213 * @file: input #GFile
1214 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info()
1215 * @cancellable: (nullable): optional #GCancellable object,
1216 * %NULL to ignore
1217 *
1218 * Utility function to inspect the #GFileType of a file. This is
1219 * implemented using g_file_query_info() and as such does blocking I/O.
1220 *
1221 * The primary use case of this method is to check if a file is
1222 * a regular file, directory, or symlink.
1223 *
1224 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN
1225 * if the file does not exist
1226 *
1227 * Since: 2.18
1228 */
1229 GFileType
1231 GFileQueryInfoFlags flags,
1233 {
1235 GFileType file_type;
1241 {
1244 }
1245 else
1249 }
1251 /**
1252 * g_file_query_info:
1253 * @file: input #GFile
1254 * @attributes: an attribute query string
1255 * @flags: a set of #GFileQueryInfoFlags
1256 * @cancellable: (nullable): optional #GCancellable object,
1257 * %NULL to ignore
1258 * @error: a #GError
1259 *
1260 * Gets the requested information about specified @file.
1261 * The result is a #GFileInfo object that contains key-value
1262 * attributes (such as the type or size of the file).
1263 *
1264 * The @attributes value is a string that specifies the file
1265 * attributes that should be gathered. It is not an error if
1266 * it's not possible to read a particular requested attribute
1267 * from a file - it just won't be set. @attributes should be a
1268 * comma-separated list of attributes or attribute wildcards.
1269 * The wildcard "*" means all attributes, and a wildcard like
1270 * "standard::*" means all attributes in the standard namespace.
1271 * An example attribute query be "standard::*,owner::user".
1272 * The standard attributes are available as defines, like
1273 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1274 *
1275 * If @cancellable is not %NULL, then the operation can be cancelled
1276 * by triggering the cancellable object from another thread. If the
1277 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1278 * returned.
1279 *
1280 * For symlinks, normally the information about the target of the
1281 * symlink is returned, rather than information about the symlink
1282 * itself. However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
1283 * in @flags the information about the symlink itself will be returned.
1284 * Also, for symlinks that point to non-existing files the information
1285 * about the symlink itself will be returned.
1286 *
1287 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1288 * returned. Other errors are possible too, and depend on what kind of
1289 * filesystem the file is on.
1290 *
1291 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL
1292 * on error. Free the returned object with g_object_unref().
1293 */
1294 GFileInfo *
1297 GFileQueryInfoFlags flags,
1300 {
1311 {
1313 G_IO_ERROR_NOT_SUPPORTED,
1316 }
1319 }
1321 /**
1322 * g_file_query_info_async:
1323 * @file: input #GFile
1324 * @attributes: an attribute query string
1325 * @flags: a set of #GFileQueryInfoFlags
1326 * @io_priority: the [I/O priority][io-priority] of the request
1327 * @cancellable: (nullable): optional #GCancellable object,
1328 * %NULL to ignore
1329 * @callback: (scope async): a #GAsyncReadyCallback to call when the
1330 * request is satisfied
1331 * @user_data: (closure): the data to pass to callback function
1332 *
1333 * Asynchronously gets the requested information about specified @file.
1334 * The result is a #GFileInfo object that contains key-value attributes
1335 * (such as type or size for the file).
1336 *
1337 * For more details, see g_file_query_info() which is the synchronous
1338 * version of this call.
1339 *
1340 * When the operation is finished, @callback will be called. You can
1341 * then call g_file_query_info_finish() to get the result of the operation.
1342 */
1343 void
1346 GFileQueryInfoFlags flags,
1349 GAsyncReadyCallback callback,
1350 gpointer user_data)
1351 {
1358 attributes,
1359 flags,
1360 io_priority,
1361 cancellable,
1362 callback,
1363 user_data);
1364 }
1366 /**
1367 * g_file_query_info_finish:
1368 * @file: input #GFile
1369 * @res: a #GAsyncResult
1370 * @error: a #GError
1371 *
1372 * Finishes an asynchronous file info query.
1373 * See g_file_query_info_async().
1374 *
1375 * Returns: (transfer full): #GFileInfo for given @file
1376 * or %NULL on error. Free the returned object with
1377 * g_object_unref().
1378 */
1379 GFileInfo *
1383 {
1394 }
1396 /**
1397 * g_file_query_filesystem_info:
1398 * @file: input #GFile
1399 * @attributes: an attribute query string
1400 * @cancellable: (nullable): optional #GCancellable object,
1401 * %NULL to ignore
1402 * @error: a #GError
1403 *
1404 * Similar to g_file_query_info(), but obtains information
1405 * about the filesystem the @file is on, rather than the file itself.
1406 * For instance the amount of space available and the type of
1407 * the filesystem.
1408 *
1409 * The @attributes value is a string that specifies the attributes
1410 * that should be gathered. It is not an error if it's not possible
1411 * to read a particular requested attribute from a file - it just
1412 * won't be set. @attributes should be a comma-separated list of
1413 * attributes or attribute wildcards. The wildcard "*" means all
1414 * attributes, and a wildcard like "filesystem::*" means all attributes
1415 * in the filesystem namespace. The standard namespace for filesystem
1416 * attributes is "filesystem". Common attributes of interest are
1417 * #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
1418 * in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
1419 * and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1420 *
1421 * If @cancellable is not %NULL, then the operation can be cancelled
1422 * by triggering the cancellable object from another thread. If the
1423 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1424 * returned.
1425 *
1426 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1427 * be returned. Other errors are possible too, and depend on what
1428 * kind of filesystem the file is on.
1429 *
1430 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1431 * Free the returned object with g_object_unref().
1432 */
1433 GFileInfo *
1438 {
1449 {
1451 G_IO_ERROR_NOT_SUPPORTED,
1454 }
1457 }
1459 /**
1460 * g_file_query_filesystem_info_async:
1461 * @file: input #GFile
1462 * @attributes: an attribute query string
1463 * @io_priority: the [I/O priority][io-priority] of the request
1464 * @cancellable: (nullable): optional #GCancellable object,
1465 * %NULL to ignore
1466 * @callback: (scope async): a #GAsyncReadyCallback to call
1467 * when the request is satisfied
1468 * @user_data: (closure): the data to pass to callback function
1469 *
1470 * Asynchronously gets the requested information about the filesystem
1471 * that the specified @file is on. The result is a #GFileInfo object
1472 * that contains key-value attributes (such as type or size for the
1473 * file).
1474 *
1475 * For more details, see g_file_query_filesystem_info() which is the
1476 * synchronous version of this call.
1477 *
1478 * When the operation is finished, @callback will be called. You can
1479 * then call g_file_query_info_finish() to get the result of the
1480 * operation.
1481 */
1482 void
1487 GAsyncReadyCallback callback,
1488 gpointer user_data)
1489 {
1496 attributes,
1497 io_priority,
1498 cancellable,
1499 callback,
1500 user_data);
1501 }
1503 /**
1504 * g_file_query_filesystem_info_finish:
1505 * @file: input #GFile
1506 * @res: a #GAsyncResult
1507 * @error: a #GError
1508 *
1509 * Finishes an asynchronous filesystem info query.
1510 * See g_file_query_filesystem_info_async().
1511 *
1512 * Returns: (transfer full): #GFileInfo for given @file
1513 * or %NULL on error.
1514 * Free the returned object with g_object_unref().
1515 */
1516 GFileInfo *
1520 {
1531 }
1533 /**
1534 * g_file_find_enclosing_mount:
1535 * @file: input #GFile
1536 * @cancellable: (nullable): optional #GCancellable object,
1537 * %NULL to ignore
1538 * @error: a #GError
1539 *
1540 * Gets a #GMount for the #GFile.
1541 *
1542 * If the #GFileIface for @file does not have a mount (e.g.
1543 * possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND
1544 * and %NULL will be returned.
1545 *
1546 * If @cancellable is not %NULL, then the operation can be cancelled by
1547 * triggering the cancellable object from another thread. If the operation
1548 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1549 *
1550 * Returns: (transfer full): a #GMount where the @file is located
1551 * or %NULL on error.
1552 * Free the returned object with g_object_unref().
1553 */
1554 GMount *
1558 {
1568 {
1571 /* Translators: This is an error message when
1572 * trying to find the enclosing (user visible)
1573 * mount of a file, but none exists.
1574 */
1577 }
1580 }
1582 /**
1583 * g_file_find_enclosing_mount_async:
1584 * @file: a #GFile
1585 * @io_priority: the [I/O priority][io-priority] of the request
1586 * @cancellable: (nullable): optional #GCancellable object,
1587 * %NULL to ignore
1588 * @callback: (scope async): a #GAsyncReadyCallback to call
1589 * when the request is satisfied
1590 * @user_data: (closure): the data to pass to callback function
1591 *
1592 * Asynchronously gets the mount for the file.
1593 *
1594 * For more details, see g_file_find_enclosing_mount() which is
1595 * the synchronous version of this call.
1596 *
1597 * When the operation is finished, @callback will be called.
1598 * You can then call g_file_find_enclosing_mount_finish() to
1599 * get the result of the operation.
1600 */
1601 void
1605 GAsyncReadyCallback callback,
1606 gpointer user_data)
1607 {
1614 io_priority,
1615 cancellable,
1616 callback,
1617 user_data);
1618 }
1620 /**
1621 * g_file_find_enclosing_mount_finish:
1622 * @file: a #GFile
1623 * @res: a #GAsyncResult
1624 * @error: a #GError
1625 *
1626 * Finishes an asynchronous find mount request.
1627 * See g_file_find_enclosing_mount_async().
1628 *
1629 * Returns: (transfer full): #GMount for given @file or %NULL on error.
1630 * Free the returned object with g_object_unref().
1631 */
1632 GMount *
1636 {
1647 }
1650 /**
1651 * g_file_read:
1652 * @file: #GFile to read
1653 * @cancellable: (nullable): a #GCancellable
1654 * @error: a #GError, or %NULL
1655 *
1656 * Opens a file for reading. The result is a #GFileInputStream that
1657 * can be used to read the contents of the file.
1658 *
1659 * If @cancellable is not %NULL, then the operation can be cancelled by
1660 * triggering the cancellable object from another thread. If the operation
1661 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1662 *
1663 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1664 * returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1665 * error will be returned. Other errors are possible too, and depend
1666 * on what kind of filesystem the file is on.
1667 *
1668 * Virtual: read_fn
1669 * Returns: (transfer full): #GFileInputStream or %NULL on error.
1670 * Free the returned object with g_object_unref().
1671 */
1672 GFileInputStream *
1676 {
1687 {
1689 G_IO_ERROR_NOT_SUPPORTED,
1692 }
1695 }
1697 /**
1698 * g_file_append_to:
1699 * @file: input #GFile
1700 * @flags: a set of #GFileCreateFlags
1701 * @cancellable: (nullable): optional #GCancellable object,
1702 * %NULL to ignore
1703 * @error: a #GError, or %NULL
1704 *
1705 * Gets an output stream for appending data to the file.
1706 * If the file doesn't already exist it is created.
1707 *
1708 * By default files created are generally readable by everyone,
1709 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1710 * will be made readable only to the current user, to the level that
1711 * is supported on the target filesystem.
1712 *
1713 * If @cancellable is not %NULL, then the operation can be cancelled
1714 * by triggering the cancellable object from another thread. If the
1715 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1716 * returned.
1717 *
1718 * Some file systems don't allow all file names, and may return an
1719 * %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the
1720 * %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are
1721 * possible too, and depend on what kind of filesystem the file is on.
1722 *
1723 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1724 * Free the returned object with g_object_unref().
1725 */
1726 GFileOutputStream *
1728 GFileCreateFlags flags,
1731 {
1742 {
1744 G_IO_ERROR_NOT_SUPPORTED,
1747 }
1750 }
1752 /**
1753 * g_file_create:
1754 * @file: input #GFile
1755 * @flags: a set of #GFileCreateFlags
1756 * @cancellable: (nullable): optional #GCancellable object,
1757 * %NULL to ignore
1758 * @error: a #GError, or %NULL
1759 *
1760 * Creates a new file and returns an output stream for writing to it.
1761 * The file must not already exist.
1762 *
1763 * By default files created are generally readable by everyone,
1764 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1765 * will be made readable only to the current user, to the level
1766 * that is supported on the target filesystem.
1767 *
1768 * If @cancellable is not %NULL, then the operation can be cancelled
1769 * by triggering the cancellable object from another thread. If the
1770 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1771 * returned.
1772 *
1773 * If a file or directory with this name already exists the
1774 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1775 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1776 * error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will
1777 * be returned. Other errors are possible too, and depend on what kind
1778 * of filesystem the file is on.
1779 *
1780 * Returns: (transfer full): a #GFileOutputStream for the newly created
1781 * file, or %NULL on error.
1782 * Free the returned object with g_object_unref().
1783 */
1784 GFileOutputStream *
1786 GFileCreateFlags flags,
1789 {
1800 {
1802 G_IO_ERROR_NOT_SUPPORTED,
1805 }
1808 }
1810 /**
1811 * g_file_replace:
1812 * @file: input #GFile
1813 * @etag: (nullable): an optional [entity tag][gfile-etag]
1814 * for the current #GFile, or #NULL to ignore
1815 * @make_backup: %TRUE if a backup should be created
1816 * @flags: a set of #GFileCreateFlags
1817 * @cancellable: (nullable): optional #GCancellable object,
1818 * %NULL to ignore
1819 * @error: a #GError, or %NULL
1820 *
1821 * Returns an output stream for overwriting the file, possibly
1822 * creating a backup copy of the file first. If the file doesn't exist,
1823 * it will be created.
1824 *
1825 * This will try to replace the file in the safest way possible so
1826 * that any errors during the writing will not affect an already
1827 * existing copy of the file. For instance, for local files it
1828 * may write to a temporary file and then atomically rename over
1829 * the destination when the stream is closed.
1830 *
1831 * By default files created are generally readable by everyone,
1832 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1833 * will be made readable only to the current user, to the level that
1834 * is supported on the target filesystem.
1835 *
1836 * If @cancellable is not %NULL, then the operation can be cancelled
1837 * by triggering the cancellable object from another thread. If the
1838 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1839 * returned.
1840 *
1841 * If you pass in a non-%NULL @etag value and @file already exists, then
1842 * this value is compared to the current entity tag of the file, and if
1843 * they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
1844 * generally means that the file has been changed since you last read
1845 * it. You can get the new etag from g_file_output_stream_get_etag()
1846 * after you've finished writing and closed the #GFileOutputStream. When
1847 * you load a new file you can use g_file_input_stream_query_info() to
1848 * get the etag of the file.
1849 *
1850 * If @make_backup is %TRUE, this function will attempt to make a
1851 * backup of the current file before overwriting it. If this fails
1852 * a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
1853 * want to replace anyway, try again with @make_backup set to %FALSE.
1854 *
1855 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will
1856 * be returned, and if the file is some other form of non-regular file
1857 * then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some
1858 * file systems don't allow all file names, and may return an
1859 * %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long
1860 * %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are
1861 * possible too, and depend on what kind of filesystem the file is on.
1862 *
1863 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1864 * Free the returned object with g_object_unref().
1865 */
1866 GFileOutputStream *
1869 gboolean make_backup,
1870 GFileCreateFlags flags,
1873 {
1884 {
1886 G_IO_ERROR_NOT_SUPPORTED,
1889 }
1891 /* Handle empty tag string as NULL in consistent way. */
1896 }
1898 /**
1899 * g_file_open_readwrite:
1900 * @file: #GFile to open
1901 * @cancellable: (nullable): a #GCancellable
1902 * @error: a #GError, or %NULL
1903 *
1904 * Opens an existing file for reading and writing. The result is
1905 * a #GFileIOStream that can be used to read and write the contents
1906 * of the file.
1907 *
1908 * If @cancellable is not %NULL, then the operation can be cancelled
1909 * by triggering the cancellable object from another thread. If the
1910 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1911 * returned.
1912 *
1913 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1914 * be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1915 * error will be returned. Other errors are possible too, and depend on
1916 * what kind of filesystem the file is on. Note that in many non-local
1917 * file cases read and write streams are not supported, so make sure you
1918 * really need to do read and write streaming, rather than just opening
1919 * for reading or writing.
1920 *
1921 * Returns: (transfer full): #GFileIOStream or %NULL on error.
1922 * Free the returned object with g_object_unref().
1923 *
1924 * Since: 2.22
1925 */
1926 GFileIOStream *
1930 {
1941 {
1943 G_IO_ERROR_NOT_SUPPORTED,
1946 }
1949 }
1951 /**
1952 * g_file_create_readwrite:
1953 * @file: a #GFile
1954 * @flags: a set of #GFileCreateFlags
1955 * @cancellable: (nullable): optional #GCancellable object,
1956 * %NULL to ignore
1957 * @error: return location for a #GError, or %NULL
1958 *
1959 * Creates a new file and returns a stream for reading and
1960 * writing to it. The file must not already exist.
1961 *
1962 * By default files created are generally readable by everyone,
1963 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1964 * will be made readable only to the current user, to the level
1965 * that is supported on the target filesystem.
1966 *
1967 * If @cancellable is not %NULL, then the operation can be cancelled
1968 * by triggering the cancellable object from another thread. If the
1969 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1970 * returned.
1971 *
1972 * If a file or directory with this name already exists, the
1973 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1974 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1975 * error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG
1976 * will be returned. Other errors are possible too, and depend on what
1977 * kind of filesystem the file is on.
1978 *
1979 * Note that in many non-local file cases read and write streams are
1980 * not supported, so make sure you really need to do read and write
1981 * streaming, rather than just opening for reading or writing.
1982 *
1983 * Returns: (transfer full): a #GFileIOStream for the newly created
1984 * file, or %NULL on error.
1985 * Free the returned object with g_object_unref().
1986 *
1987 * Since: 2.22
1988 */
1989 GFileIOStream *
1991 GFileCreateFlags flags,
1994 {
2005 {
2007 G_IO_ERROR_NOT_SUPPORTED,
2010 }
2013 }
2015 /**
2016 * g_file_replace_readwrite:
2017 * @file: a #GFile
2018 * @etag: (nullable): an optional [entity tag][gfile-etag]
2019 * for the current #GFile, or #NULL to ignore
2020 * @make_backup: %TRUE if a backup should be created
2021 * @flags: a set of #GFileCreateFlags
2022 * @cancellable: (nullable): optional #GCancellable object,
2023 * %NULL to ignore
2024 * @error: return location for a #GError, or %NULL
2025 *
2026 * Returns an output stream for overwriting the file in readwrite mode,
2027 * possibly creating a backup copy of the file first. If the file doesn't
2028 * exist, it will be created.
2029 *
2030 * For details about the behaviour, see g_file_replace() which does the
2031 * same thing but returns an output stream only.
2032 *
2033 * Note that in many non-local file cases read and write streams are not
2034 * supported, so make sure you really need to do read and write streaming,
2035 * rather than just opening for reading or writing.
2036 *
2037 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2038 * Free the returned object with g_object_unref().
2039 *
2040 * Since: 2.22
2041 */
2042 GFileIOStream *
2045 gboolean make_backup,
2046 GFileCreateFlags flags,
2049 {
2060 {
2062 G_IO_ERROR_NOT_SUPPORTED,
2065 }
2068 }
2070 /**
2071 * g_file_read_async:
2072 * @file: input #GFile
2073 * @io_priority: the [I/O priority][io-priority] of the request
2074 * @cancellable: (nullable): optional #GCancellable object,
2075 * %NULL to ignore
2076 * @callback: (scope async): a #GAsyncReadyCallback to call
2077 * when the request is satisfied
2078 * @user_data: (closure): the data to pass to callback function
2079 *
2080 * Asynchronously opens @file for reading.
2081 *
2082 * For more details, see g_file_read() which is
2083 * the synchronous version of this call.
2084 *
2085 * When the operation is finished, @callback will be called.
2086 * You can then call g_file_read_finish() to get the result
2087 * of the operation.
2088 */
2089 void
2093 GAsyncReadyCallback callback,
2094 gpointer user_data)
2095 {
2102 io_priority,
2103 cancellable,
2104 callback,
2105 user_data);
2106 }
2108 /**
2109 * g_file_read_finish:
2110 * @file: input #GFile
2111 * @res: a #GAsyncResult
2112 * @error: a #GError, or %NULL
2113 *
2114 * Finishes an asynchronous file read operation started with
2115 * g_file_read_async().
2116 *
2117 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
2118 * Free the returned object with g_object_unref().
2119 */
2120 GFileInputStream *
2124 {
2135 }
2137 /**
2138 * g_file_append_to_async:
2139 * @file: input #GFile
2140 * @flags: a set of #GFileCreateFlags
2141 * @io_priority: the [I/O priority][io-priority] of the request
2142 * @cancellable: (nullable): optional #GCancellable object,
2143 * %NULL to ignore
2144 * @callback: (scope async): a #GAsyncReadyCallback to call
2145 * when the request is satisfied
2146 * @user_data: (closure): the data to pass to callback function
2147 *
2148 * Asynchronously opens @file for appending.
2149 *
2150 * For more details, see g_file_append_to() which is
2151 * the synchronous version of this call.
2152 *
2153 * When the operation is finished, @callback will be called.
2154 * You can then call g_file_append_to_finish() to get the result
2155 * of the operation.
2156 */
2157 void
2159 GFileCreateFlags flags,
2162 GAsyncReadyCallback callback,
2163 gpointer user_data)
2164 {
2171 flags,
2172 io_priority,
2173 cancellable,
2174 callback,
2175 user_data);
2176 }
2178 /**
2179 * g_file_append_to_finish:
2180 * @file: input #GFile
2181 * @res: #GAsyncResult
2182 * @error: a #GError, or %NULL
2183 *
2184 * Finishes an asynchronous file append operation started with
2185 * g_file_append_to_async().
2186 *
2187 * Returns: (transfer full): a valid #GFileOutputStream
2188 * or %NULL on error.
2189 * Free the returned object with g_object_unref().
2190 */
2191 GFileOutputStream *
2195 {
2206 }
2208 /**
2209 * g_file_create_async:
2210 * @file: input #GFile
2211 * @flags: a set of #GFileCreateFlags
2212 * @io_priority: the [I/O priority][io-priority] of the request
2213 * @cancellable: (nullable): optional #GCancellable object,
2214 * %NULL to ignore
2215 * @callback: (scope async): a #GAsyncReadyCallback to call
2216 * when the request is satisfied
2217 * @user_data: (closure): the data to pass to callback function
2218 *
2219 * Asynchronously creates a new file and returns an output stream
2220 * for writing to it. The file must not already exist.
2221 *
2222 * For more details, see g_file_create() which is
2223 * the synchronous version of this call.
2224 *
2225 * When the operation is finished, @callback will be called.
2226 * You can then call g_file_create_finish() to get the result
2227 * of the operation.
2228 */
2229 void
2231 GFileCreateFlags flags,
2234 GAsyncReadyCallback callback,
2235 gpointer user_data)
2236 {
2243 flags,
2244 io_priority,
2245 cancellable,
2246 callback,
2247 user_data);
2248 }
2250 /**
2251 * g_file_create_finish:
2252 * @file: input #GFile
2253 * @res: a #GAsyncResult
2254 * @error: a #GError, or %NULL
2255 *
2256 * Finishes an asynchronous file create operation started with
2257 * g_file_create_async().
2258 *
2259 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2260 * Free the returned object with g_object_unref().
2261 */
2262 GFileOutputStream *
2266 {
2277 }
2279 /**
2280 * g_file_replace_async:
2281 * @file: input #GFile
2282 * @etag: (nullable): an [entity tag][gfile-etag] for the current #GFile,
2283 * or %NULL to ignore
2284 * @make_backup: %TRUE if a backup should be created
2285 * @flags: a set of #GFileCreateFlags
2286 * @io_priority: the [I/O priority][io-priority] of the request
2287 * @cancellable: (nullable): optional #GCancellable object,
2288 * %NULL to ignore
2289 * @callback: (scope async): a #GAsyncReadyCallback to call
2290 * when the request is satisfied
2291 * @user_data: (closure): the data to pass to callback function
2292 *
2293 * Asynchronously overwrites the file, replacing the contents,
2294 * possibly creating a backup copy of the file first.
2295 *
2296 * For more details, see g_file_replace() which is
2297 * the synchronous version of this call.
2298 *
2299 * When the operation is finished, @callback will be called.
2300 * You can then call g_file_replace_finish() to get the result
2301 * of the operation.
2302 */
2303 void
2306 gboolean make_backup,
2307 GFileCreateFlags flags,
2310 GAsyncReadyCallback callback,
2311 gpointer user_data)
2312 {
2319 etag,
2320 make_backup,
2321 flags,
2322 io_priority,
2323 cancellable,
2324 callback,
2325 user_data);
2326 }
2328 /**
2329 * g_file_replace_finish:
2330 * @file: input #GFile
2331 * @res: a #GAsyncResult
2332 * @error: a #GError, or %NULL
2333 *
2334 * Finishes an asynchronous file replace operation started with
2335 * g_file_replace_async().
2336 *
2337 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2338 * Free the returned object with g_object_unref().
2339 */
2340 GFileOutputStream *
2344 {
2355 }
2357 /**
2358 * g_file_open_readwrite_async
2359 * @file: input #GFile
2360 * @io_priority: the [I/O priority][io-priority] of the request
2361 * @cancellable: (nullable): optional #GCancellable object,
2362 * %NULL to ignore
2363 * @callback: (scope async): a #GAsyncReadyCallback to call
2364 * when the request is satisfied
2365 * @user_data: (closure): the data to pass to callback function
2366 *
2367 * Asynchronously opens @file for reading and writing.
2368 *
2369 * For more details, see g_file_open_readwrite() which is
2370 * the synchronous version of this call.
2371 *
2372 * When the operation is finished, @callback will be called.
2373 * You can then call g_file_open_readwrite_finish() to get
2374 * the result of the operation.
2375 *
2376 * Since: 2.22
2377 */
2378 void
2382 GAsyncReadyCallback callback,
2383 gpointer user_data)
2384 {
2391 io_priority,
2392 cancellable,
2393 callback,
2394 user_data);
2395 }
2397 /**
2398 * g_file_open_readwrite_finish:
2399 * @file: input #GFile
2400 * @res: a #GAsyncResult
2401 * @error: a #GError, or %NULL
2402 *
2403 * Finishes an asynchronous file read operation started with
2404 * g_file_open_readwrite_async().
2405 *
2406 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2407 * Free the returned object with g_object_unref().
2408 *
2409 * Since: 2.22
2410 */
2411 GFileIOStream *
2415 {
2426 }
2428 /**
2429 * g_file_create_readwrite_async:
2430 * @file: input #GFile
2431 * @flags: a set of #GFileCreateFlags
2432 * @io_priority: the [I/O priority][io-priority] of the request
2433 * @cancellable: (nullable): optional #GCancellable object,
2434 * %NULL to ignore
2435 * @callback: (scope async): a #GAsyncReadyCallback to call
2436 * when the request is satisfied
2437 * @user_data: (closure): the data to pass to callback function
2438 *
2439 * Asynchronously creates a new file and returns a stream
2440 * for reading and writing to it. The file must not already exist.
2441 *
2442 * For more details, see g_file_create_readwrite() which is
2443 * the synchronous version of this call.
2444 *
2445 * When the operation is finished, @callback will be called.
2446 * You can then call g_file_create_readwrite_finish() to get
2447 * the result of the operation.
2448 *
2449 * Since: 2.22
2450 */
2451 void
2453 GFileCreateFlags flags,
2456 GAsyncReadyCallback callback,
2457 gpointer user_data)
2458 {
2465 flags,
2466 io_priority,
2467 cancellable,
2468 callback,
2469 user_data);
2470 }
2472 /**
2473 * g_file_create_readwrite_finish:
2474 * @file: input #GFile
2475 * @res: a #GAsyncResult
2476 * @error: a #GError, or %NULL
2477 *
2478 * Finishes an asynchronous file create operation started with
2479 * g_file_create_readwrite_async().
2480 *
2481 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2482 * Free the returned object with g_object_unref().
2483 *
2484 * Since: 2.22
2485 */
2486 GFileIOStream *
2490 {
2501 }
2503 /**
2504 * g_file_replace_readwrite_async:
2505 * @file: input #GFile
2506 * @etag: (nullable): an [entity tag][gfile-etag] for the current #GFile,
2507 * or %NULL to ignore
2508 * @make_backup: %TRUE if a backup should be created
2509 * @flags: a set of #GFileCreateFlags
2510 * @io_priority: the [I/O priority][io-priority] of the request
2511 * @cancellable: (nullable): optional #GCancellable object,
2512 * %NULL to ignore
2513 * @callback: (scope async): a #GAsyncReadyCallback to call
2514 * when the request is satisfied
2515 * @user_data: (closure): the data to pass to callback function
2516 *
2517 * Asynchronously overwrites the file in read-write mode,
2518 * replacing the contents, possibly creating a backup copy
2519 * of the file first.
2520 *
2521 * For more details, see g_file_replace_readwrite() which is
2522 * the synchronous version of this call.
2523 *
2524 * When the operation is finished, @callback will be called.
2525 * You can then call g_file_replace_readwrite_finish() to get
2526 * the result of the operation.
2527 *
2528 * Since: 2.22
2529 */
2530 void
2533 gboolean make_backup,
2534 GFileCreateFlags flags,
2537 GAsyncReadyCallback callback,
2538 gpointer user_data)
2539 {
2546 etag,
2547 make_backup,
2548 flags,
2549 io_priority,
2550 cancellable,
2551 callback,
2552 user_data);
2553 }
2555 /**
2556 * g_file_replace_readwrite_finish:
2557 * @file: input #GFile
2558 * @res: a #GAsyncResult
2559 * @error: a #GError, or %NULL
2560 *
2561 * Finishes an asynchronous file replace operation started with
2562 * g_file_replace_readwrite_async().
2563 *
2564 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2565 * Free the returned object with g_object_unref().
2566 *
2567 * Since: 2.22
2568 */
2569 GFileIOStream *
2573 {
2584 }
2586 static gboolean
2588 GFileCopyFlags flags,
2592 {
2594 gboolean tried_delete;
2596 GFileType file_type;
2600 retry:
2603 {
2604 /* Maybe it already existed, and we want to overwrite? */
2607 {
2610 /* Don't overwrite if the destination is a directory */
2612 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2615 {
2620 {
2624 }
2625 }
2632 }
2633 /* Nah, fail */
2636 }
2639 }
2644 GFileCopyFlags flags,
2647 {
2651 GFileType file_type;
2658 /* There was an error opening the source, try to set a good error for it: */
2660 {
2661 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2662 * as that is less useful to the app. Better check for errors on the
2663 * target instead.
2664 */
2669 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2673 {
2678 {
2680 {
2684 }
2685 /* continue to would_recurse error */
2686 }
2687 else
2688 {
2692 }
2693 }
2694 else
2695 {
2696 /* Error getting info from target, return that error
2697 * (except for NOT_FOUND, which is no error here)
2698 */
2701 {
2704 }
2706 }
2711 }
2715 }
2717 static gboolean
2719 gboolean copy_all_attributes,
2720 gboolean skip_perms)
2721 {
2728 }
2730 static gboolean
2732 GFileCopyFlags flags,
2736 {
2740 gboolean first;
2742 gboolean copy_all_attributes;
2743 gboolean skip_perms;
2748 /* Ignore errors here, if the target supports no attributes there is
2749 * nothing to copy. We still honor the cancellable though.
2750 */
2766 {
2768 {
2770 {
2773 else
2777 }
2778 }
2779 }
2782 {
2784 {
2786 {
2789 else
2794 }
2795 }
2796 }
2801 out:
2810 }
2812 /**
2813 * g_file_copy_attributes:
2814 * @source: a #GFile with attributes
2815 * @destination: a #GFile to copy attributes to
2816 * @flags: a set of #GFileCopyFlags
2817 * @cancellable: (nullable): optional #GCancellable object,
2818 * %NULL to ignore
2819 * @error: a #GError, %NULL to ignore
2820 *
2821 * Copies the file attributes from @source to @destination.
2822 *
2823 * Normally only a subset of the file attributes are copied,
2824 * those that are copies in a normal file copy operation
2825 * (which for instance does not include e.g. owner). However
2826 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2827 * all the metadata that is possible to copy is copied. This
2828 * is useful when implementing move by copy + delete source.
2829 *
2830 * Returns: %TRUE if the attributes were copied successfully,
2831 * %FALSE otherwise.
2832 */
2833 gboolean
2836 GFileCopyFlags flags,
2839 {
2841 gboolean res;
2843 gboolean source_nofollow_symlinks;
2851 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2852 * we just don't copy it.
2853 */
2856 cancellable,
2857 NULL);
2863 {
2865 info,
2866 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2867 cancellable,
2868 error);
2870 }
2873 }
2875 /* 256k minus malloc overhead */
2876 #define STREAM_BUFFER_SIZE (1024*256 - 2 *sizeof(gpointer))
2878 static gboolean
2883 GFileProgressCallback progress_callback,
2884 gpointer progress_callback_data,
2886 {
2887 gssize n_read;
2888 gsize n_written;
2889 goffset current_size;
2891 gboolean res;
2892 goffset total_size;
2896 /* avoid performance impact of querying total size when it's not needed */
2898 {
2900 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2903 {
2907 }
2910 {
2912 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2913 G_FILE_QUERY_INFO_NONE,
2916 {
2920 }
2921 }
2922 }
2931 {
2934 {
2937 }
2950 }
2953 /* Make sure we send full copied size */
2958 }
2960 #ifdef HAVE_SPLICE
2962 static gboolean
2970 {
2973 retry:
2977 {
2985 else
2992 }
2996 }
2998 static gboolean
3002 GFileProgressCallback progress_callback,
3003 gpointer progress_callback_data,
3005 {
3008 gboolean res;
3009 goffset total_size;
3010 loff_t offset_in;
3011 loff_t offset_out;
3020 #if defined(F_SETPIPE_SZ) && defined(F_GETPIPE_SZ)
3021 /* Try a 1MiB buffer for improved throughput. If that fails, use the default
3022 * pipe size. See: https://bugzilla.gnome.org/791457 */
3025 {
3031 {
3036 }
3037 }
3038 #else
3039 /* If #F_GETPIPE_SZ isn’t available, assume we’re on Linux < 2.6.35,
3040 * but ≥ 2.6.11, meaning the pipe capacity is 64KiB. Ignore the possibility of
3041 * running on Linux < 2.6.11 (where the capacity was the system page size,
3042 * typically 4KiB) because it’s ancient. See pipe(7). */
3044 #endif
3049 /* avoid performance impact of querying total size when it's not needed */
3051 {
3056 }
3064 {
3075 {
3078 }
3081 {
3089 }
3093 }
3095 /* Make sure we send full copied size */
3105 out:
3112 }
3113 #endif
3115 #ifdef __linux__
3116 static gboolean
3121 GFileProgressCallback progress_callback,
3122 gpointer progress_callback_data,
3124 {
3125 goffset source_size;
3135 /* Btrfs clone ioctl properties:
3136 * - Works at the inode level
3137 * - Doesn't work with directories
3138 * - Always follows symlinks (source and destination)
3139 *
3140 * By the time we get here, *in and *out are both regular files */
3145 {
3148 G_IO_ERROR_NOT_SUPPORTED,
3152 G_IO_ERROR_NOT_SUPPORTED,
3154 else
3155 /* Most probably something odd happened; retry with fallback */
3157 G_IO_ERROR_NOT_SUPPORTED,
3159 /* We retry with fallback for all error cases because Btrfs is currently
3160 * unstable, and so we can't trust it to do clone properly.
3161 * In addition, any hard errors here would cause the same failure in the
3162 * fallback manual copy as well. */
3164 }
3166 /* Make sure we send full copied size */
3171 }
3172 #endif
3174 static gboolean
3177 GFileCopyFlags flags,
3179 GFileProgressCallback progress_callback,
3180 gpointer progress_callback_data,
3182 {
3192 /* need to know the file type */
3195 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3196 cancellable,
3197 error);
3201 /* Maybe copy the symlink? */
3204 {
3207 {
3213 }
3214 /* ... else fall back on a regular file copy */
3215 }
3216 /* Handle "special" files (pipes, device nodes, ...)? */
3218 {
3219 /* FIXME: could try to recreate device nodes and others? */
3223 }
3225 /* Everything else should just fall back on a regular copy. */
3237 {
3240 /* Ok, ditch the previous lightweight info (on Unix we just
3241 * called lstat()); at this point we gather all the information
3242 * we need about the source from the opened file descriptor.
3243 */
3249 {
3250 /* Not all gvfs backends implement query_info_on_read(), we
3251 * can just fall back to the pathname again.
3252 * https://bugzilla.gnome.org/706254
3253 */
3255 {
3259 }
3260 else
3261 {
3265 }
3266 }
3272 }
3274 /* In the local file path, we pass down the source info which
3275 * includes things like unix::mode, to ensure that the target file
3276 * is not created with different permissions from the source file.
3277 *
3278 * If a future API like g_file_replace_with_info() is added, switch
3279 * this code to use that.
3280 */
3282 {
3284 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3287 G_FILE_CREATE_REPLACE_DESTINATION,
3288 info,
3290 else
3291 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3294 }
3296 {
3298 NULL,
3300 G_FILE_CREATE_REPLACE_DESTINATION,
3302 }
3303 else
3304 {
3306 }
3311 #ifdef __linux__
3313 {
3319 {
3321 {
3323 }
3324 else
3325 {
3328 }
3329 }
3330 else
3331 {
3334 }
3335 }
3336 #endif
3338 #ifdef HAVE_SPLICE
3340 {
3346 {
3348 {
3350 }
3351 else
3352 {
3355 }
3356 }
3357 else
3358 {
3361 }
3362 }
3364 #endif
3366 /* A plain read/write loop */
3369 error))
3373 out:
3375 {
3376 /* Don't care about errors in source here */
3379 }
3382 {
3383 /* But write errors on close are bad! */
3387 }
3389 /* Ignore errors here. Failure to copy metadata is not a hard error */
3390 /* TODO: set these attributes /before/ we do the rename() on Unix */
3392 {
3394 info,
3395 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3396 cancellable,
3397 NULL);
3398 }
3403 }
3405 /**
3406 * g_file_copy:
3407 * @source: input #GFile
3408 * @destination: destination #GFile
3409 * @flags: set of #GFileCopyFlags
3410 * @cancellable: (nullable): optional #GCancellable object,
3411 * %NULL to ignore
3412 * @progress_callback: (nullable) (scope call): function to callback with
3413 * progress information, or %NULL if progress information is not needed
3414 * @progress_callback_data: (closure): user data to pass to @progress_callback
3415 * @error: #GError to set on error, or %NULL
3416 *
3417 * Copies the file @source to the location specified by @destination.
3418 * Can not handle recursive copies of directories.
3419 *
3420 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3421 * existing @destination file is overwritten.
3422 *
3423 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3424 * will be copied as symlinks, otherwise the target of the
3425 * @source symlink will be copied.
3426 *
3427 * If the flag #G_FILE_COPY_ALL_METADATA is specified then all the metadata
3428 * that is possible to copy is copied, not just the default subset (which,
3429 * for instance, does not include the owner, see #GFileInfo).
3430 *
3431 * If @cancellable is not %NULL, then the operation can be cancelled by
3432 * triggering the cancellable object from another thread. If the operation
3433 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3434 *
3435 * If @progress_callback is not %NULL, then the operation can be monitored
3436 * by setting this to a #GFileProgressCallback function.
3437 * @progress_callback_data will be passed to this function. It is guaranteed
3438 * that this callback will be called after all data has been transferred with
3439 * the total number of bytes copied during the operation.
3440 *
3441 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3442 * is returned, independent on the status of the @destination.
3443 *
3444 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3445 * the error %G_IO_ERROR_EXISTS is returned.
3446 *
3447 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3448 * error is returned. If trying to overwrite a directory with a directory the
3449 * %G_IO_ERROR_WOULD_MERGE error is returned.
3450 *
3451 * If the source is a directory and the target does not exist, or
3452 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3453 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3454 *
3455 * If you are interested in copying the #GFile object itself (not the on-disk
3456 * file), see g_file_dup().
3457 *
3458 * Returns: %TRUE on success, %FALSE otherwise.
3459 */
3460 gboolean
3463 GFileCopyFlags flags,
3465 GFileProgressCallback progress_callback,
3466 gpointer progress_callback_data,
3468 {
3471 gboolean res;
3481 {
3492 {
3495 }
3496 else
3498 }
3500 /* If the types are different, and the destination method failed
3501 * also try the source method
3502 */
3504 {
3508 {
3519 {
3522 }
3523 else
3525 }
3526 }
3530 error);
3531 }
3533 /**
3534 * g_file_copy_async:
3535 * @source: input #GFile
3536 * @destination: destination #GFile
3537 * @flags: set of #GFileCopyFlags
3538 * @io_priority: the [I/O priority][io-priority] of the request
3539 * @cancellable: (nullable): optional #GCancellable object,
3540 * %NULL to ignore
3541 * @progress_callback: (nullable) (scope notified): function to callback with progress
3542 * information, or %NULL if progress information is not needed
3543 * @progress_callback_data: (closure progress_callback) (nullable): user data to pass to @progress_callback
3544 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3545 * @user_data: (closure callback): the data to pass to callback function
3546 *
3547 * Copies the file @source to the location specified by @destination
3548 * asynchronously. For details of the behaviour, see g_file_copy().
3549 *
3550 * If @progress_callback is not %NULL, then that function that will be called
3551 * just like in g_file_copy(). The callback will run in the default main context
3552 * of the thread calling g_file_copy_async() — the same context as @callback is
3553 * run in.
3554 *
3555 * When the operation is finished, @callback will be called. You can then call
3556 * g_file_copy_finish() to get the result of the operation.
3557 */
3558 void
3561 GFileCopyFlags flags,
3564 GFileProgressCallback progress_callback,
3565 gpointer progress_callback_data,
3566 GAsyncReadyCallback callback,
3567 gpointer user_data)
3568 {
3576 destination,
3577 flags,
3578 io_priority,
3579 cancellable,
3580 progress_callback,
3581 progress_callback_data,
3582 callback,
3583 user_data);
3584 }
3586 /**
3587 * g_file_copy_finish:
3588 * @file: input #GFile
3589 * @res: a #GAsyncResult
3590 * @error: a #GError, or %NULL
3591 *
3592 * Finishes copying the file started with g_file_copy_async().
3593 *
3594 * Returns: a %TRUE on success, %FALSE on error.
3595 */
3596 gboolean
3600 {
3611 }
3613 /**
3614 * g_file_move:
3615 * @source: #GFile pointing to the source location
3616 * @destination: #GFile pointing to the destination location
3617 * @flags: set of #GFileCopyFlags
3618 * @cancellable: (nullable): optional #GCancellable object,
3619 * %NULL to ignore
3620 * @progress_callback: (nullable) (scope call): #GFileProgressCallback
3621 * function for updates
3622 * @progress_callback_data: (closure): gpointer to user data for
3623 * the callback function
3624 * @error: #GError for returning error conditions, or %NULL
3625 *
3626 * Tries to move the file or directory @source to the location specified
3627 * by @destination. If native move operations are supported then this is
3628 * used, otherwise a copy + delete fallback is used. The native
3629 * implementation may support moving directories (for instance on moves
3630 * inside the same filesystem), but the fallback code does not.
3631 *
3632 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3633 * existing @destination file is overwritten.
3634 *
3635 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3636 * will be copied as symlinks, otherwise the target of the
3637 * @source symlink will be copied.
3638 *
3639 * If @cancellable is not %NULL, then the operation can be cancelled by
3640 * triggering the cancellable object from another thread. If the operation
3641 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3642 *
3643 * If @progress_callback is not %NULL, then the operation can be monitored
3644 * by setting this to a #GFileProgressCallback function.
3645 * @progress_callback_data will be passed to this function. It is
3646 * guaranteed that this callback will be called after all data has been
3647 * transferred with the total number of bytes copied during the operation.
3648 *
3649 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3650 * error is returned, independent on the status of the @destination.
3651 *
3652 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3653 * then the error %G_IO_ERROR_EXISTS is returned.
3654 *
3655 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3656 * error is returned. If trying to overwrite a directory with a directory the
3657 * %G_IO_ERROR_WOULD_MERGE error is returned.
3658 *
3659 * If the source is a directory and the target does not exist, or
3660 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3661 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3662 * move operation isn't available).
3663 *
3664 * Returns: %TRUE on successful move, %FALSE otherwise.
3665 */
3666 gboolean
3669 GFileCopyFlags flags,
3671 GFileProgressCallback progress_callback,
3672 gpointer progress_callback_data,
3674 {
3677 gboolean res;
3687 {
3698 {
3701 }
3702 else
3704 }
3706 /* If the types are different, and the destination method failed
3707 * also try the source method
3708 */
3710 {
3714 {
3725 {
3728 }
3729 else
3731 }
3732 }
3735 {
3737 G_IO_ERROR_NOT_SUPPORTED,
3740 }
3745 error))
3749 }
3751 /**
3752 * g_file_make_directory:
3753 * @file: input #GFile
3754 * @cancellable: (nullable): optional #GCancellable object,
3755 * %NULL to ignore
3756 * @error: a #GError, or %NULL
3757 *
3758 * Creates a directory. Note that this will only create a child directory
3759 * of the immediate parent directory of the path or URI given by the #GFile.
3760 * To recursively create directories, see g_file_make_directory_with_parents().
3761 * This function will fail if the parent directory does not exist, setting
3762 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3763 * creating directories, this function will fail, setting @error to
3764 * %G_IO_ERROR_NOT_SUPPORTED.
3765 *
3766 * For a local #GFile the newly created directory will have the default
3767 * (current) ownership and permissions of the current process.
3768 *
3769 * If @cancellable is not %NULL, then the operation can be cancelled by
3770 * triggering the cancellable object from another thread. If the operation
3771 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3772 *
3773 * Returns: %TRUE on successful creation, %FALSE otherwise.
3774 */
3775 gboolean
3779 {
3790 {
3792 G_IO_ERROR_NOT_SUPPORTED,
3795 }
3798 }
3800 /**
3801 * g_file_make_directory_async:
3802 * @file: input #GFile
3803 * @io_priority: the [I/O priority][io-priority] of the request
3804 * @cancellable: (nullable): optional #GCancellable object,
3805 * %NULL to ignore
3806 * @callback: a #GAsyncReadyCallback to call
3807 * when the request is satisfied
3808 * @user_data: the data to pass to callback function
3809 *
3810 * Asynchronously creates a directory.
3811 *
3812 * Virtual: make_directory_async
3813 * Since: 2.38
3814 */
3815 void
3819 GAsyncReadyCallback callback,
3820 gpointer user_data)
3821 {
3828 io_priority,
3829 cancellable,
3830 callback,
3831 user_data);
3832 }
3834 /**
3835 * g_file_make_directory_finish:
3836 * @file: input #GFile
3837 * @result: a #GAsyncResult
3838 * @error: a #GError, or %NULL
3839 *
3840 * Finishes an asynchronous directory creation, started with
3841 * g_file_make_directory_async().
3842 *
3843 * Virtual: make_directory_finish
3844 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3845 * Since: 2.38
3846 */
3847 gboolean
3851 {
3859 }
3861 /**
3862 * g_file_make_directory_with_parents:
3863 * @file: input #GFile
3864 * @cancellable: (nullable): optional #GCancellable object,
3865 * %NULL to ignore
3866 * @error: a #GError, or %NULL
3867 *
3868 * Creates a directory and any parent directories that may not
3869 * exist similar to 'mkdir -p'. If the file system does not support
3870 * creating directories, this function will fail, setting @error to
3871 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3872 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3873 * the similar g_mkdir_with_parents().
3874 *
3875 * For a local #GFile the newly created directories will have the default
3876 * (current) ownership and permissions of the current process.
3877 *
3878 * If @cancellable is not %NULL, then the operation can be cancelled by
3879 * triggering the cancellable object from another thread. If the operation
3880 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3881 *
3882 * Returns: %TRUE if all directories have been successfully created, %FALSE
3883 * otherwise.
3884 *
3885 * Since: 2.18
3886 */
3887 gboolean
3891 {
3901 /* Try for the simple case of not having to create any parent
3902 * directories. If any parent directory needs to be created, this
3903 * call will fail with NOT_FOUND. If that happens, then that value of
3904 * my_error persists into the while loop below.
3905 */
3908 {
3912 }
3916 /* Creates the parent directories as needed. In case any particular
3917 * creation operation fails for lack of other parent directories
3918 * (NOT_FOUND), the directory is added to a list of directories to
3919 * create later, and the value of my_error is retained until the next
3920 * iteration of the loop. After the loop my_error should either be
3921 * empty or contain a real failure condition.
3922 */
3924 {
3933 /* Another process may have created the directory in between the
3934 * G_IO_ERROR_NOT_FOUND and now
3935 */
3944 else
3946 }
3948 /* All directories should be able to be created now, so an error at
3949 * this point means the whole operation must fail -- except an EXISTS
3950 * error, which means that another process already created the
3951 * directory in between the previous failure and now.
3952 */
3954 {
3958 }
3963 /* Clean up */
3965 {
3968 }
3970 /* At this point an error in my_error means a that something
3971 * unexpected failed in either of the loops above, so the whole
3972 * operation must fail.
3973 */
3975 {
3978 }
3981 }
3983 /**
3984 * g_file_make_symbolic_link:
3985 * @file: a #GFile with the name of the symlink to create
3986 * @symlink_value: (type filename): a string with the path for the target
3987 * of the new symlink
3988 * @cancellable: (nullable): optional #GCancellable object,
3989 * %NULL to ignore
3990 * @error: a #GError
3991 *
3992 * Creates a symbolic link named @file which contains the string
3993 * @symlink_value.
3994 *
3995 * If @cancellable is not %NULL, then the operation can be cancelled by
3996 * triggering the cancellable object from another thread. If the operation
3997 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3998 *
3999 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
4000 */
4001 gboolean
4006 {
4016 {
4018 G_IO_ERROR_INVALID_ARGUMENT,
4021 }
4026 {
4028 G_IO_ERROR_NOT_SUPPORTED,
4031 }
4034 }
4036 /**
4037 * g_file_delete:
4038 * @file: input #GFile
4039 * @cancellable: (nullable): optional #GCancellable object,
4040 * %NULL to ignore
4041 * @error: a #GError, or %NULL
4042 *
4043 * Deletes a file. If the @file is a directory, it will only be
4044 * deleted if it is empty. This has the same semantics as g_unlink().
4045 *
4046 * If @cancellable is not %NULL, then the operation can be cancelled by
4047 * triggering the cancellable object from another thread. If the operation
4048 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4049 *
4050 * Virtual: delete_file
4051 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
4052 */
4053 gboolean
4057 {
4068 {
4070 G_IO_ERROR_NOT_SUPPORTED,
4073 }
4076 }
4078 /**
4079 * g_file_delete_async:
4080 * @file: input #GFile
4081 * @io_priority: the [I/O priority][io-priority] of the request
4082 * @cancellable: (nullable): optional #GCancellable object,
4083 * %NULL to ignore
4084 * @callback: a #GAsyncReadyCallback to call
4085 * when the request is satisfied
4086 * @user_data: the data to pass to callback function
4087 *
4088 * Asynchronously delete a file. If the @file is a directory, it will
4089 * only be deleted if it is empty. This has the same semantics as
4090 * g_unlink().
4091 *
4092 * Virtual: delete_file_async
4093 * Since: 2.34
4094 */
4095 void
4099 GAsyncReadyCallback callback,
4100 gpointer user_data)
4101 {
4108 io_priority,
4109 cancellable,
4110 callback,
4111 user_data);
4112 }
4114 /**
4115 * g_file_delete_finish:
4116 * @file: input #GFile
4117 * @result: a #GAsyncResult
4118 * @error: a #GError, or %NULL
4119 *
4120 * Finishes deleting a file started with g_file_delete_async().
4121 *
4122 * Virtual: delete_file_finish
4123 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
4124 * Since: 2.34
4125 **/
4126 gboolean
4130 {
4141 }
4143 /**
4144 * g_file_trash:
4145 * @file: #GFile to send to trash
4146 * @cancellable: (nullable): optional #GCancellable object,
4147 * %NULL to ignore
4148 * @error: a #GError, or %NULL
4149 *
4150 * Sends @file to the "Trashcan", if possible. This is similar to
4151 * deleting it, but the user can recover it before emptying the trashcan.
4152 * Not all file systems support trashing, so this call can return the
4153 * %G_IO_ERROR_NOT_SUPPORTED error.
4154 *
4155 * If @cancellable is not %NULL, then the operation can be cancelled by
4156 * triggering the cancellable object from another thread. If the operation
4157 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4158 *
4159 * Virtual: trash
4160 * Returns: %TRUE on successful trash, %FALSE otherwise.
4161 */
4162 gboolean
4166 {
4177 {
4182 }
4185 }
4187 /**
4188 * g_file_trash_async:
4189 * @file: input #GFile
4190 * @io_priority: the [I/O priority][io-priority] of the request
4191 * @cancellable: (nullable): optional #GCancellable object,
4192 * %NULL to ignore
4193 * @callback: a #GAsyncReadyCallback to call
4194 * when the request is satisfied
4195 * @user_data: the data to pass to callback function
4196 *
4197 * Asynchronously sends @file to the Trash location, if possible.
4198 *
4199 * Virtual: trash_async
4200 * Since: 2.38
4201 */
4202 void
4206 GAsyncReadyCallback callback,
4207 gpointer user_data)
4208 {
4215 io_priority,
4216 cancellable,
4217 callback,
4218 user_data);
4219 }
4221 /**
4222 * g_file_trash_finish:
4223 * @file: input #GFile
4224 * @result: a #GAsyncResult
4225 * @error: a #GError, or %NULL
4226 *
4227 * Finishes an asynchronous file trashing operation, started with
4228 * g_file_trash_async().
4229 *
4230 * Virtual: trash_finish
4231 * Returns: %TRUE on successful trash, %FALSE otherwise.
4232 * Since: 2.38
4233 */
4234 gboolean
4238 {
4246 }
4248 /**
4249 * g_file_set_display_name:
4250 * @file: input #GFile
4251 * @display_name: a string
4252 * @cancellable: (nullable): optional #GCancellable object,
4253 * %NULL to ignore
4254 * @error: a #GError, or %NULL
4255 *
4256 * Renames @file to the specified display name.
4257 *
4258 * The display name is converted from UTF-8 to the correct encoding
4259 * for the target filesystem if possible and the @file is renamed to this.
4260 *
4261 * If you want to implement a rename operation in the user interface the
4262 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4263 * initial value in the rename widget, and then the result after editing
4264 * should be passed to g_file_set_display_name().
4265 *
4266 * On success the resulting converted filename is returned.
4267 *
4268 * If @cancellable is not %NULL, then the operation can be cancelled by
4269 * triggering the cancellable object from another thread. If the operation
4270 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4271 *
4272 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4273 * or %NULL if there was an error.
4274 * Free the returned object with g_object_unref().
4275 */
4276 GFile *
4281 {
4288 {
4290 G_IO_ERROR,
4291 G_IO_ERROR_INVALID_ARGUMENT,
4294 }
4302 }
4304 /**
4305 * g_file_set_display_name_async:
4306 * @file: input #GFile
4307 * @display_name: a string
4308 * @io_priority: the [I/O priority][io-priority] of the request
4309 * @cancellable: (nullable): optional #GCancellable object,
4310 * %NULL to ignore
4311 * @callback: (scope async): a #GAsyncReadyCallback to call
4312 * when the request is satisfied
4313 * @user_data: (closure): the data to pass to callback function
4314 *
4315 * Asynchronously sets the display name for a given #GFile.
4316 *
4317 * For more details, see g_file_set_display_name() which is
4318 * the synchronous version of this call.
4319 *
4320 * When the operation is finished, @callback will be called.
4321 * You can then call g_file_set_display_name_finish() to get
4322 * the result of the operation.
4323 */
4324 void
4327 gint io_priority,
4329 GAsyncReadyCallback callback,
4330 gpointer user_data)
4331 {
4339 display_name,
4340 io_priority,
4341 cancellable,
4342 callback,
4343 user_data);
4344 }
4346 /**
4347 * g_file_set_display_name_finish:
4348 * @file: input #GFile
4349 * @res: a #GAsyncResult
4350 * @error: a #GError, or %NULL
4351 *
4352 * Finishes setting a display name started with
4353 * g_file_set_display_name_async().
4354 *
4355 * Returns: (transfer full): a #GFile or %NULL on error.
4356 * Free the returned object with g_object_unref().
4357 */
4358 GFile *
4362 {
4373 }
4375 /**
4376 * g_file_query_settable_attributes:
4377 * @file: input #GFile
4378 * @cancellable: (nullable): optional #GCancellable object,
4379 * %NULL to ignore
4380 * @error: a #GError, or %NULL
4381 *
4382 * Obtain the list of settable attributes for the file.
4383 *
4384 * Returns the type and full attribute name of all the attributes
4385 * that can be set on this file. This doesn't mean setting it will
4386 * always succeed though, you might get an access failure, or some
4387 * specific file may not support a specific attribute.
4388 *
4389 * If @cancellable is not %NULL, then the operation can be cancelled by
4390 * triggering the cancellable object from another thread. If the operation
4391 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4392 *
4393 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4394 * When you are done with it, release it with
4395 * g_file_attribute_info_list_unref()
4396 */
4397 GFileAttributeInfoList *
4401 {
4420 {
4422 {
4425 }
4426 else
4428 }
4431 }
4433 /**
4434 * g_file_query_writable_namespaces:
4435 * @file: input #GFile
4436 * @cancellable: (nullable): optional #GCancellable object,
4437 * %NULL to ignore
4438 * @error: a #GError, or %NULL
4439 *
4440 * Obtain the list of attribute namespaces where new attributes
4441 * can be created by a user. An example of this is extended
4442 * attributes (in the "xattr" namespace).
4443 *
4444 * If @cancellable is not %NULL, then the operation can be cancelled by
4445 * triggering the cancellable object from another thread. If the operation
4446 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4447 *
4448 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4449 * When you are done with it, release it with
4450 * g_file_attribute_info_list_unref()
4451 */
4452 GFileAttributeInfoList *
4456 {
4475 {
4478 }
4481 {
4483 {
4485 }
4486 else
4488 }
4491 }
4493 /**
4494 * g_file_set_attribute:
4495 * @file: input #GFile
4496 * @attribute: a string containing the attribute's name
4497 * @type: The type of the attribute
4498 * @value_p: (nullable): a pointer to the value (or the pointer
4499 * itself if the type is a pointer type)
4500 * @flags: a set of #GFileQueryInfoFlags
4501 * @cancellable: (nullable): optional #GCancellable object,
4502 * %NULL to ignore
4503 * @error: a #GError, or %NULL
4504 *
4505 * Sets an attribute in the file with attribute name @attribute to @value.
4506 *
4507 * Some attributes can be unset by setting @type to
4508 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4509 *
4510 * If @cancellable is not %NULL, then the operation can be cancelled by
4511 * triggering the cancellable object from another thread. If the operation
4512 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4513 *
4514 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4515 */
4516 gboolean
4519 GFileAttributeType type,
4520 gpointer value_p,
4521 GFileQueryInfoFlags flags,
4524 {
4536 {
4538 G_IO_ERROR_NOT_SUPPORTED,
4541 }
4544 }
4546 /**
4547 * g_file_set_attributes_from_info:
4548 * @file: input #GFile
4549 * @info: a #GFileInfo
4550 * @flags: #GFileQueryInfoFlags
4551 * @cancellable: (nullable): optional #GCancellable object,
4552 * %NULL to ignore
4553 * @error: a #GError, or %NULL
4554 *
4555 * Tries to set all attributes in the #GFileInfo on the target
4556 * values, not stopping on the first error.
4557 *
4558 * If there is any error during this operation then @error will
4559 * be set to the first error. Error on particular fields are flagged
4560 * by setting the "status" field in the attribute value to
4561 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4562 * also detect further errors.
4563 *
4564 * If @cancellable is not %NULL, then the operation can be cancelled by
4565 * triggering the cancellable object from another thread. If the operation
4566 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4567 *
4568 * Returns: %FALSE if there was any error, %TRUE otherwise.
4569 */
4570 gboolean
4573 GFileQueryInfoFlags flags,
4576 {
4590 info,
4591 flags,
4592 cancellable,
4593 error);
4594 }
4596 static gboolean
4599 GFileQueryInfoFlags flags,
4602 {
4605 gboolean res;
4613 {
4622 {
4625 /* Don't set error multiple times */
4627 }
4628 else
4630 }
4635 }
4637 /**
4638 * g_file_set_attributes_async:
4639 * @file: input #GFile
4640 * @info: a #GFileInfo
4641 * @flags: a #GFileQueryInfoFlags
4642 * @io_priority: the [I/O priority][io-priority] of the request
4643 * @cancellable: (nullable): optional #GCancellable object,
4644 * %NULL to ignore
4645 * @callback: (scope async): a #GAsyncReadyCallback
4646 * @user_data: (closure): a #gpointer
4647 *
4648 * Asynchronously sets the attributes of @file with @info.
4649 *
4650 * For more details, see g_file_set_attributes_from_info(),
4651 * which is the synchronous version of this call.
4652 *
4653 * When the operation is finished, @callback will be called.
4654 * You can then call g_file_set_attributes_finish() to get
4655 * the result of the operation.
4656 */
4657 void
4660 GFileQueryInfoFlags flags,
4663 GAsyncReadyCallback callback,
4664 gpointer user_data)
4665 {
4673 info,
4674 flags,
4675 io_priority,
4676 cancellable,
4677 callback,
4678 user_data);
4679 }
4681 /**
4682 * g_file_set_attributes_finish:
4683 * @file: input #GFile
4684 * @result: a #GAsyncResult
4685 * @info: (out) (transfer full): a #GFileInfo
4686 * @error: a #GError, or %NULL
4687 *
4688 * Finishes setting an attribute started in g_file_set_attributes_async().
4689 *
4690 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4691 */
4692 gboolean
4697 {
4703 /* No standard handling of errors here, as we must set info even
4704 * on errors
4705 */
4708 }
4710 /**
4711 * g_file_set_attribute_string:
4712 * @file: input #GFile
4713 * @attribute: a string containing the attribute's name
4714 * @value: a string containing the attribute's value
4715 * @flags: #GFileQueryInfoFlags
4716 * @cancellable: (nullable): optional #GCancellable object,
4717 * %NULL to ignore
4718 * @error: a #GError, or %NULL
4719 *
4720 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4721 * If @attribute is of a different type, this operation will fail.
4722 *
4723 * If @cancellable is not %NULL, then the operation can be cancelled by
4724 * triggering the cancellable object from another thread. If the operation
4725 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4726 *
4727 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4728 */
4729 gboolean
4733 GFileQueryInfoFlags flags,
4736 {
4740 }
4742 /**
4743 * g_file_set_attribute_byte_string:
4744 * @file: input #GFile
4745 * @attribute: a string containing the attribute's name
4746 * @value: a string containing the attribute's new value
4747 * @flags: a #GFileQueryInfoFlags
4748 * @cancellable: (nullable): optional #GCancellable object,
4749 * %NULL to ignore
4750 * @error: a #GError, or %NULL
4751 *
4752 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4753 * If @attribute is of a different type, this operation will fail,
4754 * returning %FALSE.
4755 *
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.
4759 *
4760 * Returns: %TRUE if the @attribute was successfully set to @value
4761 * in the @file, %FALSE otherwise.
4762 */
4763 gboolean
4767 GFileQueryInfoFlags flags,
4770 {
4774 }
4776 /**
4777 * g_file_set_attribute_uint32:
4778 * @file: input #GFile
4779 * @attribute: a string containing the attribute's name
4780 * @value: a #guint32 containing the attribute's new value
4781 * @flags: a #GFileQueryInfoFlags
4782 * @cancellable: (nullable): optional #GCancellable object,
4783 * %NULL to ignore
4784 * @error: a #GError, or %NULL
4785 *
4786 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4787 * If @attribute is of a different type, this operation will fail.
4788 *
4789 * If @cancellable is not %NULL, then the operation can be cancelled by
4790 * triggering the cancellable object from another thread. If the operation
4791 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4792 *
4793 * Returns: %TRUE if the @attribute was successfully set to @value
4794 * in the @file, %FALSE otherwise.
4795 */
4796 gboolean
4799 guint32 value,
4800 GFileQueryInfoFlags flags,
4803 {
4807 }
4809 /**
4810 * g_file_set_attribute_int32:
4811 * @file: input #GFile
4812 * @attribute: a string containing the attribute's name
4813 * @value: a #gint32 containing the attribute's new value
4814 * @flags: a #GFileQueryInfoFlags
4815 * @cancellable: (nullable): optional #GCancellable object,
4816 * %NULL to ignore
4817 * @error: a #GError, or %NULL
4818 *
4819 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4820 * If @attribute is of a different type, this operation will fail.
4821 *
4822 * If @cancellable is not %NULL, then the operation can be cancelled by
4823 * triggering the cancellable object from another thread. If the operation
4824 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4825 *
4826 * Returns: %TRUE if the @attribute was successfully set to @value
4827 * in the @file, %FALSE otherwise.
4828 */
4829 gboolean
4832 gint32 value,
4833 GFileQueryInfoFlags flags,
4836 {
4840 }
4842 /**
4843 * g_file_set_attribute_uint64:
4844 * @file: input #GFile
4845 * @attribute: a string containing the attribute's name
4846 * @value: a #guint64 containing the attribute's new value
4847 * @flags: a #GFileQueryInfoFlags
4848 * @cancellable: (nullable): optional #GCancellable object,
4849 * %NULL to ignore
4850 * @error: a #GError, or %NULL
4851 *
4852 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4853 * If @attribute is of a different type, this operation will fail.
4854 *
4855 * If @cancellable is not %NULL, then the operation can be cancelled by
4856 * triggering the cancellable object from another thread. If the operation
4857 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4858 *
4859 * Returns: %TRUE if the @attribute was successfully set to @value
4860 * in the @file, %FALSE otherwise.
4861 */
4862 gboolean
4865 guint64 value,
4866 GFileQueryInfoFlags flags,
4869 {
4873 }
4875 /**
4876 * g_file_set_attribute_int64:
4877 * @file: input #GFile
4878 * @attribute: a string containing the attribute's name
4879 * @value: a #guint64 containing the attribute's new value
4880 * @flags: a #GFileQueryInfoFlags
4881 * @cancellable: (nullable): optional #GCancellable object,
4882 * %NULL to ignore
4883 * @error: a #GError, or %NULL
4884 *
4885 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4886 * If @attribute is of a different type, this operation will fail.
4887 *
4888 * If @cancellable is not %NULL, then the operation can be cancelled by
4889 * triggering the cancellable object from another thread. If the operation
4890 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4891 *
4892 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4893 */
4894 gboolean
4897 gint64 value,
4898 GFileQueryInfoFlags flags,
4901 {
4905 }
4907 /**
4908 * g_file_mount_mountable:
4909 * @file: input #GFile
4910 * @flags: flags affecting the operation
4911 * @mount_operation: (nullable): a #GMountOperation,
4912 * or %NULL to avoid user interaction
4913 * @cancellable: (nullable): optional #GCancellable object,
4914 * %NULL to ignore
4915 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4916 * when the request is satisfied, or %NULL
4917 * @user_data: (closure): the data to pass to callback function
4918 *
4919 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4920 * Using @mount_operation, you can request callbacks when, for instance,
4921 * passwords are needed during authentication.
4922 *
4923 * If @cancellable is not %NULL, then the operation can be cancelled by
4924 * triggering the cancellable object from another thread. If the operation
4925 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4926 *
4927 * When the operation is finished, @callback will be called.
4928 * You can then call g_file_mount_mountable_finish() to get
4929 * the result of the operation.
4930 */
4931 void
4933 GMountMountFlags flags,
4936 GAsyncReadyCallback callback,
4937 gpointer user_data)
4938 {
4946 {
4948 g_file_mount_mountable,
4952 }
4955 flags,
4956 mount_operation,
4957 cancellable,
4958 callback,
4959 user_data);
4960 }
4962 /**
4963 * g_file_mount_mountable_finish:
4964 * @file: input #GFile
4965 * @result: a #GAsyncResult
4966 * @error: a #GError, or %NULL
4967 *
4968 * Finishes a mount operation. See g_file_mount_mountable() for details.
4969 *
4970 * Finish an asynchronous mount operation that was started
4971 * with g_file_mount_mountable().
4972 *
4973 * Returns: (transfer full): a #GFile or %NULL on error.
4974 * Free the returned object with g_object_unref().
4975 */
4976 GFile *
4980 {
4993 }
4995 /**
4996 * g_file_unmount_mountable:
4997 * @file: input #GFile
4998 * @flags: flags affecting the operation
4999 * @cancellable: (nullable): optional #GCancellable object,
5000 * %NULL to ignore
5001 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5002 * when the request is satisfied, or %NULL
5003 * @user_data: (closure): the data to pass to callback function
5004 *
5005 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
5006 *
5007 * If @cancellable is not %NULL, then the operation can be cancelled by
5008 * triggering the cancellable object from another thread. If the operation
5009 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5010 *
5011 * When the operation is finished, @callback will be called.
5012 * You can then call g_file_unmount_mountable_finish() to get
5013 * the result of the operation.
5014 *
5015 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
5016 */
5017 void
5019 GMountUnmountFlags flags,
5021 GAsyncReadyCallback callback,
5022 gpointer user_data)
5023 {
5031 {
5033 g_file_unmount_mountable_with_operation,
5037 }
5040 flags,
5041 cancellable,
5042 callback,
5043 user_data);
5044 }
5046 /**
5047 * g_file_unmount_mountable_finish:
5048 * @file: input #GFile
5049 * @result: a #GAsyncResult
5050 * @error: a #GError, or %NULL
5051 *
5052 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
5053 *
5054 * Finish an asynchronous unmount operation that was started
5055 * with g_file_unmount_mountable().
5056 *
5057 * Returns: %TRUE if the operation finished successfully.
5058 * %FALSE otherwise.
5059 *
5060 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
5061 * instead.
5062 */
5063 gboolean
5067 {
5080 }
5082 /**
5083 * g_file_unmount_mountable_with_operation:
5084 * @file: input #GFile
5085 * @flags: flags affecting the operation
5086 * @mount_operation: (nullable): a #GMountOperation,
5087 * or %NULL to avoid user interaction
5088 * @cancellable: (nullable): optional #GCancellable object,
5089 * %NULL to ignore
5090 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5091 * when the request is satisfied, or %NULL
5092 * @user_data: (closure): the data to pass to callback function
5093 *
5094 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
5095 *
5096 * If @cancellable is not %NULL, then the operation can be cancelled by
5097 * triggering the cancellable object from another thread. If the operation
5098 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5099 *
5100 * When the operation is finished, @callback will be called.
5101 * You can then call g_file_unmount_mountable_finish() to get
5102 * the result of the operation.
5103 *
5104 * Since: 2.22
5105 */
5106 void
5108 GMountUnmountFlags flags,
5111 GAsyncReadyCallback callback,
5112 gpointer user_data)
5113 {
5121 {
5123 g_file_unmount_mountable_with_operation,
5127 }
5131 flags,
5132 mount_operation,
5133 cancellable,
5134 callback,
5135 user_data);
5136 else
5138 flags,
5139 cancellable,
5140 callback,
5141 user_data);
5142 }
5144 /**
5145 * g_file_unmount_mountable_with_operation_finish:
5146 * @file: input #GFile
5147 * @result: a #GAsyncResult
5148 * @error: a #GError, or %NULL
5149 *
5150 * Finishes an unmount operation,
5151 * see g_file_unmount_mountable_with_operation() for details.
5152 *
5153 * Finish an asynchronous unmount operation that was started
5154 * with g_file_unmount_mountable_with_operation().
5155 *
5156 * Returns: %TRUE if the operation finished successfully.
5157 * %FALSE otherwise.
5158 *
5159 * Since: 2.22
5160 */
5161 gboolean
5165 {
5179 else
5181 }
5183 /**
5184 * g_file_eject_mountable:
5185 * @file: input #GFile
5186 * @flags: flags affecting the operation
5187 * @cancellable: (nullable): optional #GCancellable object,
5188 * %NULL to ignore
5189 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5190 * when the request is satisfied, or %NULL
5191 * @user_data: (closure): the data to pass to callback function
5192 *
5193 * Starts an asynchronous eject on a mountable.
5194 * When this operation has completed, @callback will be called with
5195 * @user_user data, and the operation can be finalized with
5196 * g_file_eject_mountable_finish().
5197 *
5198 * If @cancellable is not %NULL, then the operation can be cancelled by
5199 * triggering the cancellable object from another thread. If the operation
5200 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5201 *
5202 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5203 */
5204 void
5206 GMountUnmountFlags flags,
5208 GAsyncReadyCallback callback,
5209 gpointer user_data)
5210 {
5218 {
5220 g_file_eject_mountable_with_operation,
5224 }
5227 flags,
5228 cancellable,
5229 callback,
5230 user_data);
5231 }
5233 /**
5234 * g_file_eject_mountable_finish:
5235 * @file: input #GFile
5236 * @result: a #GAsyncResult
5237 * @error: a #GError, or %NULL
5238 *
5239 * Finishes an asynchronous eject operation started by
5240 * g_file_eject_mountable().
5241 *
5242 * Returns: %TRUE if the @file was ejected successfully.
5243 * %FALSE otherwise.
5244 *
5245 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5246 * instead.
5247 */
5248 gboolean
5252 {
5265 }
5267 /**
5268 * g_file_eject_mountable_with_operation:
5269 * @file: input #GFile
5270 * @flags: flags affecting the operation
5271 * @mount_operation: (nullable): a #GMountOperation,
5272 * or %NULL to avoid user interaction
5273 * @cancellable: (nullable): optional #GCancellable object,
5274 * %NULL to ignore
5275 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5276 * when the request is satisfied, or %NULL
5277 * @user_data: (closure): the data to pass to callback function
5278 *
5279 * Starts an asynchronous eject on a mountable.
5280 * When this operation has completed, @callback will be called with
5281 * @user_user data, and the operation can be finalized with
5282 * g_file_eject_mountable_with_operation_finish().
5283 *
5284 * If @cancellable is not %NULL, then the operation can be cancelled by
5285 * triggering the cancellable object from another thread. If the operation
5286 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5287 *
5288 * Since: 2.22
5289 */
5290 void
5292 GMountUnmountFlags flags,
5295 GAsyncReadyCallback callback,
5296 gpointer user_data)
5297 {
5305 {
5307 g_file_eject_mountable_with_operation,
5311 }
5315 flags,
5316 mount_operation,
5317 cancellable,
5318 callback,
5319 user_data);
5320 else
5322 flags,
5323 cancellable,
5324 callback,
5325 user_data);
5326 }
5328 /**
5329 * g_file_eject_mountable_with_operation_finish:
5330 * @file: input #GFile
5331 * @result: a #GAsyncResult
5332 * @error: a #GError, or %NULL
5333 *
5334 * Finishes an asynchronous eject operation started by
5335 * g_file_eject_mountable_with_operation().
5336 *
5337 * Returns: %TRUE if the @file was ejected successfully.
5338 * %FALSE otherwise.
5339 *
5340 * Since: 2.22
5341 */
5342 gboolean
5346 {
5360 else
5362 }
5364 /**
5365 * g_file_monitor_directory:
5366 * @file: input #GFile
5367 * @flags: a set of #GFileMonitorFlags
5368 * @cancellable: (nullable): optional #GCancellable object,
5369 * %NULL to ignore
5370 * @error: a #GError, or %NULL
5371 *
5372 * Obtains a directory monitor for the given file.
5373 * This may fail if directory monitoring is not supported.
5374 *
5375 * If @cancellable is not %NULL, then the operation can be cancelled by
5376 * triggering the cancellable object from another thread. If the operation
5377 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5378 *
5379 * It does not make sense for @flags to contain
5380 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5381 * directories. It is not possible to monitor all the files in a
5382 * directory for changes made via hard links; if you want to do this then
5383 * you must register individual watches with g_file_monitor().
5384 *
5385 * Virtual: monitor_dir
5386 * Returns: (transfer full): a #GFileMonitor for the given @file,
5387 * or %NULL on error.
5388 * Free the returned object with g_object_unref().
5389 */
5390 GFileMonitor *
5392 GFileMonitorFlags flags,
5395 {
5407 {
5409 G_IO_ERROR_NOT_SUPPORTED,
5412 }
5415 }
5417 /**
5418 * g_file_monitor_file:
5419 * @file: input #GFile
5420 * @flags: a set of #GFileMonitorFlags
5421 * @cancellable: (nullable): optional #GCancellable object,
5422 * %NULL to ignore
5423 * @error: a #GError, or %NULL
5424 *
5425 * Obtains a file monitor for the given file. If no file notification
5426 * mechanism exists, then regular polling of the file is used.
5427 *
5428 * If @cancellable is not %NULL, then the operation can be cancelled by
5429 * triggering the cancellable object from another thread. If the operation
5430 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5431 *
5432 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5433 * will also attempt to report changes made to the file via another
5434 * filename (ie, a hard link). Without this flag, you can only rely on
5435 * changes made through the filename contained in @file to be
5436 * reported. Using this flag may result in an increase in resource
5437 * usage, and may not have any effect depending on the #GFileMonitor
5438 * backend and/or filesystem type.
5439 *
5440 * Returns: (transfer full): a #GFileMonitor for the given @file,
5441 * or %NULL on error.
5442 * Free the returned object with g_object_unref().
5443 */
5444 GFileMonitor *
5446 GFileMonitorFlags flags,
5449 {
5465 /* Fallback to polling */
5470 }
5472 /**
5473 * g_file_monitor:
5474 * @file: input #GFile
5475 * @flags: a set of #GFileMonitorFlags
5476 * @cancellable: (nullable): optional #GCancellable object,
5477 * %NULL to ignore
5478 * @error: a #GError, or %NULL
5479 *
5480 * Obtains a file or directory monitor for the given file,
5481 * depending on the type of the file.
5482 *
5483 * If @cancellable is not %NULL, then the operation can be cancelled by
5484 * triggering the cancellable object from another thread. If the operation
5485 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5486 *
5487 * Returns: (transfer full): a #GFileMonitor for the given @file,
5488 * or %NULL on error.
5489 * Free the returned object with g_object_unref().
5490 *
5491 * Since: 2.18
5492 */
5493 GFileMonitor *
5495 GFileMonitorFlags flags,
5498 {
5503 else
5505 }
5507 /********************************************
5508 * Default implementation of async ops *
5509 ********************************************/
5513 GFileQueryInfoFlags flags;
5516 static void
5518 {
5521 }
5523 static void
5525 gpointer object,
5526 gpointer task_data,
5528 {
5533 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5536 else
5538 }
5540 static void
5543 GFileQueryInfoFlags flags,
5546 GAsyncReadyCallback callback,
5547 gpointer user_data)
5548 {
5562 }
5568 {
5572 }
5574 static void
5576 gpointer object,
5577 gpointer task_data,
5579 {
5587 else
5589 }
5591 static void
5596 GAsyncReadyCallback callback,
5597 gpointer user_data)
5598 {
5607 }
5613 {
5617 }
5619 static void
5621 gpointer object,
5622 gpointer task_data,
5624 {
5629 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5632 else
5634 }
5636 static void
5639 GFileQueryInfoFlags flags,
5642 GAsyncReadyCallback callback,
5643 gpointer user_data)
5644 {
5658 }
5664 {
5668 }
5670 static void
5672 gpointer object,
5673 gpointer task_data,
5675 {
5682 else
5684 }
5686 static void
5690 GAsyncReadyCallback callback,
5691 gpointer user_data)
5692 {
5700 }
5706 {
5710 }
5712 static void
5714 gpointer source_object,
5715 gpointer task_data,
5717 {
5725 else
5727 }
5729 static void
5731 GFileCreateFlags flags,
5734 GAsyncReadyCallback callback,
5735 gpointer user_data)
5736 {
5750 }
5756 {
5760 }
5762 static void
5764 gpointer source_object,
5765 gpointer task_data,
5767 {
5775 else
5777 }
5779 static void
5781 GFileCreateFlags flags,
5784 GAsyncReadyCallback callback,
5785 gpointer user_data)
5786 {
5800 }
5806 {
5810 }
5815 gboolean make_backup;
5816 GFileCreateFlags flags;
5819 static void
5821 {
5826 }
5828 static void
5830 gpointer source_object,
5831 gpointer task_data,
5833 {
5842 cancellable,
5847 else
5849 }
5851 static void
5854 gboolean make_backup,
5855 GFileCreateFlags flags,
5858 GAsyncReadyCallback callback,
5859 gpointer user_data)
5860 {
5876 }
5882 {
5886 }
5888 static void
5890 gpointer object,
5891 gpointer task_data,
5893 {
5898 else
5900 }
5902 static void
5906 GAsyncReadyCallback callback,
5907 gpointer user_data)
5908 {
5916 }
5918 static gboolean
5922 {
5926 }
5928 static void
5930 gpointer object,
5931 gpointer task_data,
5933 {
5938 else
5940 }
5942 static void
5946 GAsyncReadyCallback callback,
5947 gpointer user_data)
5948 {
5956 }
5958 static gboolean
5962 {
5966 }
5968 static void
5970 gpointer object,
5971 gpointer task_data,
5973 {
5978 else
5980 }
5982 static void
5986 GAsyncReadyCallback callback,
5987 gpointer user_data)
5988 {
5996 }
5998 static gboolean
6002 {
6006 }
6008 static void
6010 gpointer object,
6011 gpointer task_data,
6013 {
6021 else
6023 }
6025 static void
6029 GAsyncReadyCallback callback,
6030 gpointer user_data)
6031 {
6040 }
6046 {
6050 }
6052 static void
6054 gpointer object,
6055 gpointer task_data,
6057 {
6066 else
6068 }
6070 static void
6072 GFileCreateFlags flags,
6075 GAsyncReadyCallback callback,
6076 gpointer user_data)
6077 {
6091 }
6097 {
6101 }
6105 gboolean make_backup;
6106 GFileCreateFlags flags;
6109 static void
6111 {
6114 }
6116 static void
6118 gpointer object,
6119 gpointer task_data,
6121 {
6130 cancellable,
6135 else
6137 }
6139 static void
6142 gboolean make_backup,
6143 GFileCreateFlags flags,
6146 GAsyncReadyCallback callback,
6147 gpointer user_data)
6148 {
6164 }
6170 {
6174 }
6176 static void
6178 gpointer object,
6179 gpointer task_data,
6181 {
6190 else
6192 }
6194 static void
6199 GAsyncReadyCallback callback,
6200 gpointer user_data)
6201 {
6211 }
6217 {
6221 }
6224 GFileQueryInfoFlags flags;
6226 gboolean res;
6230 static void
6232 {
6238 }
6240 static void
6242 gpointer object,
6243 gpointer task_data,
6245 {
6252 cancellable,
6254 }
6256 static void
6259 GFileQueryInfoFlags flags,
6262 GAsyncReadyCallback callback,
6263 gpointer user_data)
6264 {
6279 }
6281 static gboolean
6286 {
6300 }
6302 static void
6304 gpointer object,
6305 gpointer task_data,
6307 {
6315 else
6317 }
6319 static void
6323 GAsyncReadyCallback callback,
6324 gpointer user_data)
6325 {
6334 }
6340 {
6344 }
6350 GFileCopyFlags flags;
6351 GFileProgressCallback progress_cb;
6352 gpointer progress_cb_data;
6355 static void
6357 {
6361 }
6365 goffset current_num_bytes;
6366 goffset total_num_bytes;
6369 static gboolean
6371 {
6380 }
6382 static void
6384 goffset total_num_bytes,
6385 gpointer user_data)
6386 {
6398 copy_async_progress_in_main,
6399 progress,
6400 g_free);
6401 }
6403 static void
6405 gpointer source,
6406 gpointer task_data,
6408 {
6410 gboolean result;
6416 cancellable,
6418 task,
6422 else
6424 }
6426 static void
6429 GFileCopyFlags flags,
6432 GFileProgressCallback progress_callback,
6433 gpointer progress_callback_data,
6434 GAsyncReadyCallback callback,
6435 gpointer user_data)
6436 {
6453 }
6455 static gboolean
6459 {
6463 }
6466 /********************************************
6467 * Default VFS operations *
6468 ********************************************/
6470 /**
6471 * g_file_new_for_path:
6472 * @path: (type filename): a string containing a relative or absolute path.
6473 * The string must be encoded in the glib filename encoding.
6474 *
6475 * Constructs a #GFile for a given path. This operation never
6476 * fails, but the returned object might not support any I/O
6477 * operation if @path is malformed.
6478 *
6479 * Returns: (transfer full): a new #GFile for the given @path.
6480 * Free the returned object with g_object_unref().
6481 */
6482 GFile *
6484 {
6488 }
6490 /**
6491 * g_file_new_for_uri:
6492 * @uri: a UTF-8 string containing a URI
6493 *
6494 * Constructs a #GFile for a given URI. This operation never
6495 * fails, but the returned object might not support any I/O
6496 * operation if @uri is malformed or if the uri type is
6497 * not supported.
6498 *
6499 * Returns: (transfer full): a new #GFile for the given @uri.
6500 * Free the returned object with g_object_unref().
6501 */
6502 GFile *
6504 {
6508 }
6510 /**
6511 * g_file_new_tmp:
6512 * @tmpl: (type filename) (nullable): Template for the file
6513 * name, as in g_file_open_tmp(), or %NULL for a default template
6514 * @iostream: (out): on return, a #GFileIOStream for the created file
6515 * @error: a #GError, or %NULL
6516 *
6517 * Opens a file in the preferred directory for temporary files (as
6518 * returned by g_get_tmp_dir()) and returns a #GFile and
6519 * #GFileIOStream pointing to it.
6520 *
6521 * @tmpl should be a string in the GLib file name encoding
6522 * containing a sequence of six 'X' characters, and containing no
6523 * directory components. If it is %NULL, a default template is used.
6524 *
6525 * Unlike the other #GFile constructors, this will return %NULL if
6526 * a temporary file could not be created.
6527 *
6528 * Returns: (transfer full): a new #GFile.
6529 * Free the returned object with g_object_unref().
6530 *
6531 * Since: 2.32
6532 */
6533 GFile *
6537 {
6538 gint fd;
6558 }
6560 /**
6561 * g_file_parse_name:
6562 * @parse_name: a file name or path to be parsed
6563 *
6564 * Constructs a #GFile with the given @parse_name (i.e. something
6565 * given by g_file_get_parse_name()). This operation never fails,
6566 * but the returned object might not support any I/O operation if
6567 * the @parse_name cannot be parsed.
6568 *
6569 * Returns: (transfer full): a new #GFile.
6570 */
6571 GFile *
6573 {
6577 }
6579 /**
6580 * g_file_new_build_filename:
6581 * @first_element: (type filename): the first element in the path
6582 * @...: remaining elements in path, terminated by %NULL
6583 *
6584 * Constructs a #GFile from a series of elements using the correct
6585 * separator for filenames.
6586 *
6587 * Using this function is equivalent to calling g_build_filename(),
6588 * followed by g_file_new_for_path() on the result.
6589 *
6590 * Returns: (transfer full): a new #GFile
6591 *
6592 * Since: 2.56
6593 */
6594 GFile *
6596 ...)
6597 {
6612 }
6614 static gboolean
6616 {
6618 }
6620 /* Following RFC 2396, valid schemes are built like:
6621 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6622 */
6623 static gboolean
6625 {
6634 p++;
6638 }
6643 {
6654 {
6660 }
6661 else
6668 }
6670 /**
6671 * g_file_new_for_commandline_arg:
6672 * @arg: (type filename): a command line string
6673 *
6674 * Creates a #GFile with the given argument from the command line.
6675 * The value of @arg can be either a URI, an absolute path or a
6676 * relative path resolved relative to the current working directory.
6677 * This operation never fails, but the returned object might not
6678 * support any I/O operation if @arg points to a malformed path.
6679 *
6680 * Note that on Windows, this function expects its argument to be in
6681 * UTF-8 -- not the system code page. This means that you
6682 * should not use this function with string from argv as it is passed
6683 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6684 * the commandline. #GApplication also uses UTF-8 but
6685 * g_application_command_line_create_file_for_arg() may be more useful
6686 * for you there. It is also always possible to use this function with
6687 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6688 *
6689 * Returns: (transfer full): a new #GFile.
6690 * Free the returned object with g_object_unref().
6691 */
6692 GFile *
6694 {
6698 }
6700 /**
6701 * g_file_new_for_commandline_arg_and_cwd:
6702 * @arg: (type filename): a command line string
6703 * @cwd: (type filename): the current working directory of the commandline
6704 *
6705 * Creates a #GFile with the given argument from the command line.
6706 *
6707 * This function is similar to g_file_new_for_commandline_arg() except
6708 * that it allows for passing the current working directory as an
6709 * argument instead of using the current working directory of the
6710 * process.
6711 *
6712 * This is useful if the commandline argument was given in a context
6713 * other than the invocation of the current process.
6714 *
6715 * See also g_application_command_line_create_file_for_arg().
6716 *
6717 * Returns: (transfer full): a new #GFile
6718 *
6719 * Since: 2.36
6720 **/
6721 GFile *
6724 {
6729 }
6731 /**
6732 * g_file_mount_enclosing_volume:
6733 * @location: input #GFile
6734 * @flags: flags affecting the operation
6735 * @mount_operation: (nullable): a #GMountOperation
6736 * or %NULL to avoid user interaction
6737 * @cancellable: (nullable): optional #GCancellable object,
6738 * %NULL to ignore
6739 * @callback: (nullable): a #GAsyncReadyCallback to call
6740 * when the request is satisfied, or %NULL
6741 * @user_data: the data to pass to callback function
6742 *
6743 * Starts a @mount_operation, mounting the volume that contains
6744 * the file @location.
6745 *
6746 * When this operation has completed, @callback will be called with
6747 * @user_user data, and the operation can be finalized with
6748 * g_file_mount_enclosing_volume_finish().
6749 *
6750 * If @cancellable is not %NULL, then the operation can be cancelled by
6751 * triggering the cancellable object from another thread. If the operation
6752 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6753 */
6754 void
6756 GMountMountFlags flags,
6759 GAsyncReadyCallback callback,
6760 gpointer user_data)
6761 {
6769 {
6771 g_file_mount_enclosing_volume,
6775 }
6777 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6779 }
6781 /**
6782 * g_file_mount_enclosing_volume_finish:
6783 * @location: input #GFile
6784 * @result: a #GAsyncResult
6785 * @error: a #GError, or %NULL
6786 *
6787 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6788 *
6789 * Returns: %TRUE if successful. If an error has occurred,
6790 * this function will return %FALSE and set @error
6791 * appropriately if present.
6792 */
6793 gboolean
6797 {
6811 }
6813 /********************************************
6814 * Utility functions *
6815 ********************************************/
6817 /**
6818 * g_file_query_default_handler:
6819 * @file: a #GFile to open
6820 * @cancellable: optional #GCancellable object, %NULL to ignore
6821 * @error: a #GError, or %NULL
6822 *
6823 * Returns the #GAppInfo that is registered as the default
6824 * application to handle the file specified by @file.
6825 *
6826 * If @cancellable is not %NULL, then the operation can be cancelled by
6827 * triggering the cancellable object from another thread. If the operation
6828 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6829 *
6830 * Returns: (transfer full): a #GAppInfo if the handle was found,
6831 * %NULL if there were errors.
6832 * When you are done with it, release it with g_object_unref()
6833 */
6834 GAppInfo *
6838 {
6847 {
6853 }
6856 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6858 cancellable,
6859 error);
6867 {
6868 /* Don't use is_native(), as we want to support fuse paths if available */
6873 }
6881 G_IO_ERROR_NOT_SUPPORTED,
6884 }
6886 #define GET_CONTENT_BLOCK_SIZE 8192
6888 /**
6889 * g_file_load_contents:
6890 * @file: input #GFile
6891 * @cancellable: optional #GCancellable object, %NULL to ignore
6892 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6893 * @length: (out) (optional): a location to place the length of the contents of the file,
6894 * or %NULL if the length is not needed
6895 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
6896 * or %NULL if the entity tag is not needed
6897 * @error: a #GError, or %NULL
6898 *
6899 * Loads the content of the file into memory. The data is always
6900 * zero-terminated, but this is not included in the resultant @length.
6901 * The returned @content should be freed with g_free() when no longer
6902 * needed.
6903 *
6904 * If @cancellable is not %NULL, then the operation can be cancelled by
6905 * triggering the cancellable object from another thread. If the operation
6906 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6907 *
6908 * Returns: %TRUE if the @file's contents were successfully loaded.
6909 * %FALSE if there were errors.
6910 */
6911 gboolean
6918 {
6921 gsize pos;
6922 gssize res;
6938 GET_CONTENT_BLOCK_SIZE,
6940 {
6943 }
6946 {
6950 G_FILE_ATTRIBUTE_ETAG_VALUE,
6951 cancellable,
6952 NULL);
6954 {
6957 }
6958 }
6960 /* Ignore errors on close */
6965 {
6966 /* error is set already */
6969 }
6974 /* Zero terminate (we got an extra byte allocated for this */
6980 }
6984 GFileReadMoreCallback read_more_callback;
6986 gsize pos;
6991 static void
6993 {
6998 }
7000 static void
7003 gpointer user_data)
7004 {
7008 /* Ignore errors here, we're only reading anyway */
7014 }
7016 static void
7019 gpointer user_data)
7020 {
7028 {
7031 }
7036 }
7038 static void
7041 gpointer user_data)
7042 {
7046 gssize read_size;
7051 {
7055 /* Close the file ignoring any error */
7058 }
7060 {
7062 G_FILE_ATTRIBUTE_ETAG_VALUE,
7065 load_contents_fstat_callback,
7066 data);
7067 }
7069 {
7080 G_FILE_ATTRIBUTE_ETAG_VALUE,
7083 load_contents_fstat_callback,
7084 data);
7085 else
7088 GET_CONTENT_BLOCK_SIZE,
7091 load_contents_read_callback,
7092 data);
7093 }
7094 }
7096 static void
7099 gpointer user_data)
7100 {
7109 {
7114 GET_CONTENT_BLOCK_SIZE,
7117 load_contents_read_callback,
7118 data);
7119 }
7120 else
7121 {
7124 }
7125 }
7127 /**
7128 * g_file_load_partial_contents_async: (skip)
7129 * @file: input #GFile
7130 * @cancellable: optional #GCancellable object, %NULL to ignore
7131 * @read_more_callback: (scope call) (closure user_data): a
7132 * #GFileReadMoreCallback to receive partial data
7133 * and to specify whether further data should be read
7134 * @callback: (scope async) (closure user_data): a #GAsyncReadyCallback to call
7135 * when the request is satisfied
7136 * @user_data: the data to pass to the callback functions
7137 *
7138 * Reads the partial contents of a file. A #GFileReadMoreCallback should
7139 * be used to stop reading from the file when appropriate, else this
7140 * function will behave exactly as g_file_load_contents_async(). This
7141 * operation can be finished by g_file_load_partial_contents_finish().
7142 *
7143 * Users of this function should be aware that @user_data is passed to
7144 * both the @read_more_callback and the @callback.
7145 *
7146 * If @cancellable is not %NULL, then the operation can be cancelled by
7147 * triggering the cancellable object from another thread. If the operation
7148 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7149 */
7150 void
7153 GFileReadMoreCallback read_more_callback,
7154 GAsyncReadyCallback callback,
7155 gpointer user_data)
7156 {
7172 load_contents_open_callback,
7173 data);
7174 }
7176 /**
7177 * g_file_load_partial_contents_finish:
7178 * @file: input #GFile
7179 * @res: a #GAsyncResult
7180 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7181 * @length: (out) (optional): a location to place the length of the contents of the file,
7182 * or %NULL if the length is not needed
7183 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7184 * or %NULL if the entity tag is not needed
7185 * @error: a #GError, or %NULL
7186 *
7187 * Finishes an asynchronous partial load operation that was started
7188 * with g_file_load_partial_contents_async(). The data is always
7189 * zero-terminated, but this is not included in the resultant @length.
7190 * The returned @content should be freed with g_free() when no longer
7191 * needed.
7192 *
7193 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7194 * present, it will be set appropriately.
7195 */
7196 gboolean
7203 {
7214 {
7218 }
7226 {
7229 }
7231 /* Zero terminate */
7239 }
7241 /**
7242 * g_file_load_contents_async:
7243 * @file: input #GFile
7244 * @cancellable: optional #GCancellable object, %NULL to ignore
7245 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7246 * @user_data: the data to pass to callback function
7247 *
7248 * Starts an asynchronous load of the @file's contents.
7249 *
7250 * For more details, see g_file_load_contents() which is
7251 * the synchronous version of this call.
7252 *
7253 * When the load operation has completed, @callback will be called
7254 * with @user data. To finish the operation, call
7255 * g_file_load_contents_finish() with the #GAsyncResult returned by
7256 * the @callback.
7257 *
7258 * If @cancellable is not %NULL, then the operation can be cancelled by
7259 * triggering the cancellable object from another thread. If the operation
7260 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7261 */
7262 void
7265 GAsyncReadyCallback callback,
7266 gpointer user_data)
7267 {
7269 cancellable,
7270 NULL,
7272 }
7274 /**
7275 * g_file_load_contents_finish:
7276 * @file: input #GFile
7277 * @res: a #GAsyncResult
7278 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7279 * @length: (out) (optional): a location to place the length of the contents of the file,
7280 * or %NULL if the length is not needed
7281 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7282 * or %NULL if the entity tag is not needed
7283 * @error: a #GError, or %NULL
7284 *
7285 * Finishes an asynchronous load of the @file's contents.
7286 * The contents are placed in @contents, and @length is set to the
7287 * size of the @contents string. The @content should be freed with
7288 * g_free() when no longer needed. If @etag_out is present, it will be
7289 * set to the new entity tag for the @file.
7290 *
7291 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7292 * present, it will be set appropriately.
7293 */
7294 gboolean
7301 {
7303 res,
7304 contents,
7305 length,
7306 etag_out,
7307 error);
7308 }
7310 /**
7311 * g_file_replace_contents:
7312 * @file: input #GFile
7313 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7314 * @length: the length of @contents in bytes
7315 * @etag: (nullable): the old [entity-tag][gfile-etag] for the document,
7316 * or %NULL
7317 * @make_backup: %TRUE if a backup should be created
7318 * @flags: a set of #GFileCreateFlags
7319 * @new_etag: (out) (optional): a location to a new [entity tag][gfile-etag]
7320 * for the document. This should be freed with g_free() when no longer
7321 * needed, or %NULL
7322 * @cancellable: optional #GCancellable object, %NULL to ignore
7323 * @error: a #GError, or %NULL
7324 *
7325 * Replaces the contents of @file with @contents of @length bytes.
7326 *
7327 * If @etag is specified (not %NULL), any existing file must have that etag,
7328 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7329 *
7330 * If @make_backup is %TRUE, this function will attempt to make a backup
7331 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7332 * file contents in the safest way possible. For example, atomic renames are
7333 * used when replacing local files’ contents.
7334 *
7335 * If @cancellable is not %NULL, then the operation can be cancelled by
7336 * triggering the cancellable object from another thread. If the operation
7337 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7338 *
7339 * The returned @new_etag can be used to verify that the file hasn't
7340 * changed the next time it is saved over.
7341 *
7342 * Returns: %TRUE if successful. If an error has occurred, this function
7343 * will return %FALSE and set @error appropriately if present.
7344 */
7345 gboolean
7348 gsize length,
7350 gboolean make_backup,
7351 GFileCreateFlags flags,
7355 {
7358 gssize res;
7359 gboolean ret;
7374 cancellable,
7376 {
7379 }
7382 {
7383 /* Ignore errors on close */
7387 /* error is set already */
7389 }
7399 }
7404 gsize pos;
7406 gboolean failed;
7409 static void
7411 {
7415 }
7417 static void
7420 gpointer user_data)
7421 {
7425 /* Ignore errors here, we're only reading anyway */
7430 {
7433 }
7435 }
7437 static void
7440 gpointer user_data)
7441 {
7445 gssize write_size;
7450 {
7451 /* Error or EOF, close the file */
7453 {
7456 }
7460 }
7462 {
7464 gsize length;
7473 else
7479 replace_contents_write_callback,
7480 data);
7481 }
7482 }
7484 static void
7487 gpointer user_data)
7488 {
7497 {
7499 gsize length;
7507 replace_contents_write_callback,
7508 data);
7509 }
7510 else
7511 {
7514 }
7515 }
7517 /**
7518 * g_file_replace_contents_async:
7519 * @file: input #GFile
7520 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7521 * @length: the length of @contents in bytes
7522 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7523 * @make_backup: %TRUE if a backup should be created
7524 * @flags: a set of #GFileCreateFlags
7525 * @cancellable: optional #GCancellable object, %NULL to ignore
7526 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7527 * @user_data: the data to pass to callback function
7528 *
7529 * Starts an asynchronous replacement of @file with the given
7530 * @contents of @length bytes. @etag will replace the document's
7531 * current entity tag.
7532 *
7533 * When this operation has completed, @callback will be called with
7534 * @user_user data, and the operation can be finalized with
7535 * g_file_replace_contents_finish().
7536 *
7537 * If @cancellable is not %NULL, then the operation can be cancelled by
7538 * triggering the cancellable object from another thread. If the operation
7539 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7540 *
7541 * If @make_backup is %TRUE, this function will attempt to
7542 * make a backup of @file.
7543 *
7544 * Note that no copy of @content will be made, so it must stay valid
7545 * until @callback is called. See g_file_replace_contents_bytes_async()
7546 * for a #GBytes version that will automatically hold a reference to the
7547 * contents (without copying) for the duration of the call.
7548 */
7549 void
7552 gsize length,
7554 gboolean make_backup,
7555 GFileCreateFlags flags,
7557 GAsyncReadyCallback callback,
7558 gpointer user_data)
7559 {
7566 }
7568 /**
7569 * g_file_replace_contents_bytes_async:
7570 * @file: input #GFile
7571 * @contents: a #GBytes
7572 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7573 * @make_backup: %TRUE if a backup should be created
7574 * @flags: a set of #GFileCreateFlags
7575 * @cancellable: optional #GCancellable object, %NULL to ignore
7576 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7577 * @user_data: the data to pass to callback function
7578 *
7579 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7580 * This function will keep a ref on @contents until the operation is done.
7581 * Unlike g_file_replace_contents_async() this allows forgetting about the
7582 * content without waiting for the callback.
7583 *
7584 * When this operation has completed, @callback will be called with
7585 * @user_user data, and the operation can be finalized with
7586 * g_file_replace_contents_finish().
7587 *
7588 * Since: 2.40
7589 */
7590 void
7594 gboolean make_backup,
7595 GFileCreateFlags flags,
7597 GAsyncReadyCallback callback,
7598 gpointer user_data)
7599 {
7614 etag,
7615 make_backup,
7616 flags,
7619 replace_contents_open_callback,
7620 data);
7621 }
7623 /**
7624 * g_file_replace_contents_finish:
7625 * @file: input #GFile
7626 * @res: a #GAsyncResult
7627 * @new_etag: (out) (optional): a location of a new [entity tag][gfile-etag]
7628 * for the document. This should be freed with g_free() when it is no
7629 * longer needed, or %NULL
7630 * @error: a #GError, or %NULL
7631 *
7632 * Finishes an asynchronous replace of the given @file. See
7633 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7634 * tag for the document, if present.
7635 *
7636 * Returns: %TRUE on success, %FALSE on failure.
7637 */
7638 gboolean
7643 {
7658 {
7661 }
7664 }
7666 gboolean
7668 GFileMeasureFlags flags,
7670 GFileMeasureProgressCallback progress_callback,
7671 gpointer progress_data,
7676 {
7680 }
7683 {
7684 GFileMeasureFlags flags;
7685 GFileMeasureProgressCallback progress_callback;
7686 gpointer progress_data;
7690 {
7691 guint64 disk_usage;
7692 guint64 num_dirs;
7693 guint64 num_files;
7697 {
7698 GFileMeasureProgressCallback callback;
7699 gpointer user_data;
7700 gboolean reporting;
7701 guint64 current_size;
7702 guint64 num_dirs;
7703 guint64 num_files;
7706 static gboolean
7708 {
7716 }
7718 static void
7720 guint64 current_size,
7721 guint64 num_dirs,
7722 guint64 num_files,
7723 gpointer user_data)
7724 {
7725 MeasureProgress progress;
7740 measure_disk_usage_invoke_progress,
7742 g_free);
7743 }
7745 static void
7747 gpointer source_object,
7748 gpointer task_data,
7750 {
7760 else
7762 }
7764 static void
7766 GFileMeasureFlags flags,
7767 gint io_priority,
7769 GFileMeasureProgressCallback progress_callback,
7770 gpointer progress_data,
7771 GAsyncReadyCallback callback,
7772 gpointer user_data)
7773 {
7774 MeasureTaskData data;
7788 }
7790 static gboolean
7797 {
7819 }
7821 /**
7822 * g_file_measure_disk_usage:
7823 * @file: a #GFile
7824 * @flags: #GFileMeasureFlags
7825 * @cancellable: (nullable): optional #GCancellable
7826 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7827 * @progress_data: user_data for @progress_callback
7828 * @disk_usage: (out) (optional): the number of bytes of disk space used
7829 * @num_dirs: (out) (optional): the number of directories encountered
7830 * @num_files: (out) (optional): the number of non-directories encountered
7831 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7832 *
7833 * Recursively measures the disk usage of @file.
7834 *
7835 * This is essentially an analog of the 'du' command, but it also
7836 * reports the number of directories and non-directory files encountered
7837 * (including things like symbolic links).
7838 *
7839 * By default, errors are only reported against the toplevel file
7840 * itself. Errors found while recursing are silently ignored, unless
7841 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7842 *
7843 * The returned size, @disk_usage, is in bytes and should be formatted
7844 * with g_format_size() in order to get something reasonable for showing
7845 * in a user interface.
7846 *
7847 * @progress_callback and @progress_data can be given to request
7848 * periodic progress updates while scanning. See the documentation for
7849 * #GFileMeasureProgressCallback for information about when and how the
7850 * callback will be invoked.
7851 *
7852 * Returns: %TRUE if successful, with the out parameters set.
7853 * %FALSE otherwise, with @error set.
7854 *
7855 * Since: 2.38
7856 **/
7857 gboolean
7859 GFileMeasureFlags flags,
7861 GFileMeasureProgressCallback progress_callback,
7862 gpointer progress_data,
7867 {
7875 error);
7876 }
7878 /**
7879 * g_file_measure_disk_usage_async:
7880 * @file: a #GFile
7881 * @flags: #GFileMeasureFlags
7882 * @io_priority: the [I/O priority][io-priority] of the request
7883 * @cancellable: (nullable): optional #GCancellable
7884 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7885 * @progress_data: user_data for @progress_callback
7886 * @callback: (nullable): a #GAsyncReadyCallback to call when complete
7887 * @user_data: the data to pass to callback function
7888 *
7889 * Recursively measures the disk usage of @file.
7890 *
7891 * This is the asynchronous version of g_file_measure_disk_usage(). See
7892 * there for more information.
7893 *
7894 * Since: 2.38
7895 **/
7896 void
7898 GFileMeasureFlags flags,
7899 gint io_priority,
7901 GFileMeasureProgressCallback progress_callback,
7902 gpointer progress_data,
7903 GAsyncReadyCallback callback,
7904 gpointer user_data)
7905 {
7912 }
7914 /**
7915 * g_file_measure_disk_usage_finish:
7916 * @file: a #GFile
7917 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7918 * @disk_usage: (out) (optional): the number of bytes of disk space used
7919 * @num_dirs: (out) (optional): the number of directories encountered
7920 * @num_files: (out) (optional): the number of non-directories encountered
7921 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7922 *
7923 * Collects the results from an earlier call to
7924 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7925 * more information.
7926 *
7927 * Returns: %TRUE if successful, with the out parameters set.
7928 * %FALSE otherwise, with @error set.
7929 *
7930 * Since: 2.38
7931 **/
7932 gboolean
7939 {
7943 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7944 }
7946 /**
7947 * g_file_start_mountable:
7948 * @file: input #GFile
7949 * @flags: flags affecting the operation
7950 * @start_operation: (nullable): a #GMountOperation, or %NULL to avoid user interaction
7951 * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
7952 * @callback: (nullable): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7953 * @user_data: the data to pass to callback function
7954 *
7955 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7956 * Using @start_operation, you can request callbacks when, for instance,
7957 * passwords are needed during authentication.
7958 *
7959 * If @cancellable is not %NULL, then the operation can be cancelled by
7960 * triggering the cancellable object from another thread. If the operation
7961 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7962 *
7963 * When the operation is finished, @callback will be called.
7964 * You can then call g_file_mount_mountable_finish() to get
7965 * the result of the operation.
7966 *
7967 * Since: 2.22
7968 */
7969 void
7971 GDriveStartFlags flags,
7974 GAsyncReadyCallback callback,
7975 gpointer user_data)
7976 {
7984 {
7986 g_file_start_mountable,
7990 }
7993 flags,
7994 start_operation,
7995 cancellable,
7996 callback,
7997 user_data);
7998 }
8000 /**
8001 * g_file_start_mountable_finish:
8002 * @file: input #GFile
8003 * @result: a #GAsyncResult
8004 * @error: a #GError, or %NULL
8005 *
8006 * Finishes a start operation. See g_file_start_mountable() for details.
8007 *
8008 * Finish an asynchronous start operation that was started
8009 * with g_file_start_mountable().
8010 *
8011 * Returns: %TRUE if the operation finished successfully. %FALSE
8012 * otherwise.
8013 *
8014 * Since: 2.22
8015 */
8016 gboolean
8020 {
8033 }
8035 /**
8036 * g_file_stop_mountable:
8037 * @file: input #GFile
8038 * @flags: flags affecting the operation
8039 * @mount_operation: (nullable): a #GMountOperation,
8040 * or %NULL to avoid user interaction.
8041 * @cancellable: (nullable): optional #GCancellable object,
8042 * %NULL to ignore
8043 * @callback: (nullable): a #GAsyncReadyCallback to call
8044 * when the request is satisfied, or %NULL
8045 * @user_data: the data to pass to callback function
8046 *
8047 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
8048 *
8049 * If @cancellable is not %NULL, then the operation can be cancelled by
8050 * triggering the cancellable object from another thread. If the operation
8051 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8052 *
8053 * When the operation is finished, @callback will be called.
8054 * You can then call g_file_stop_mountable_finish() to get
8055 * the result of the operation.
8056 *
8057 * Since: 2.22
8058 */
8059 void
8061 GMountUnmountFlags flags,
8064 GAsyncReadyCallback callback,
8065 gpointer user_data)
8066 {
8074 {
8076 g_file_stop_mountable,
8080 }
8083 flags,
8084 mount_operation,
8085 cancellable,
8086 callback,
8087 user_data);
8088 }
8090 /**
8091 * g_file_stop_mountable_finish:
8092 * @file: input #GFile
8093 * @result: a #GAsyncResult
8094 * @error: a #GError, or %NULL
8095 *
8096 * Finishes an stop operation, see g_file_stop_mountable() for details.
8097 *
8098 * Finish an asynchronous stop operation that was started
8099 * with g_file_stop_mountable().
8100 *
8101 * Returns: %TRUE if the operation finished successfully.
8102 * %FALSE otherwise.
8103 *
8104 * Since: 2.22
8105 */
8106 gboolean
8110 {
8123 }
8125 /**
8126 * g_file_poll_mountable:
8127 * @file: input #GFile
8128 * @cancellable: optional #GCancellable object, %NULL to ignore
8129 * @callback: (nullable): a #GAsyncReadyCallback to call
8130 * when the request is satisfied, or %NULL
8131 * @user_data: the data to pass to callback function
8132 *
8133 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
8134 *
8135 * If @cancellable is not %NULL, then the operation can be cancelled by
8136 * triggering the cancellable object from another thread. If the operation
8137 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8138 *
8139 * When the operation is finished, @callback will be called.
8140 * You can then call g_file_mount_mountable_finish() to get
8141 * the result of the operation.
8142 *
8143 * Since: 2.22
8144 */
8145 void
8148 GAsyncReadyCallback callback,
8149 gpointer user_data)
8150 {
8158 {
8160 g_file_poll_mountable,
8164 }
8167 cancellable,
8168 callback,
8169 user_data);
8170 }
8172 /**
8173 * g_file_poll_mountable_finish:
8174 * @file: input #GFile
8175 * @result: a #GAsyncResult
8176 * @error: a #GError, or %NULL
8177 *
8178 * Finishes a poll operation. See g_file_poll_mountable() for details.
8179 *
8180 * Finish an asynchronous poll operation that was polled
8181 * with g_file_poll_mountable().
8182 *
8183 * Returns: %TRUE if the operation finished successfully. %FALSE
8184 * otherwise.
8185 *
8186 * Since: 2.22
8187 */
8188 gboolean
8192 {
8205 }
8207 /**
8208 * g_file_supports_thread_contexts:
8209 * @file: a #GFile
8210 *
8211 * Checks if @file supports
8212 * [thread-default contexts][g-main-context-push-thread-default-context].
8213 * If this returns %FALSE, you cannot perform asynchronous operations on
8214 * @file in a thread that has a thread-default context.
8215 *
8216 * Returns: Whether or not @file supports thread-default contexts.
8217 *
8218 * Since: 2.22
8219 */
8220 gboolean
8222 {
8229 }
8231 /**
8232 * g_file_load_bytes:
8233 * @file: a #GFile
8234 * @cancellable: (nullable): a #GCancellable or %NULL
8235 * @etag_out: (out) (nullable) (optional): a location to place the current
8236 * entity tag for the file, or %NULL if the entity tag is not needed
8237 * @error: a location for a #GError or %NULL
8238 *
8239 * Loads the contents of @file and returns it as #GBytes.
8240 *
8241 * If @file is a resource:// based URI, the resulting bytes will reference the
8242 * embedded resource instead of a copy. Otherwise, this is equivalent to calling
8243 * g_file_load_contents() and g_bytes_new_take().
8244 *
8245 * For resources, @etag_out will be set to %NULL.
8246 *
8247 * The data contained in the resulting #GBytes is always zero-terminated, but
8248 * this is not included in the #GBytes length. The resulting #GBytes should be
8249 * freed with g_bytes_unref() when no longer in use.
8250 *
8251 * Returns: (transfer full): a #GBytes or %NULL and @error is set
8252 *
8253 * Since: 2.56
8254 */
8255 GBytes *
8260 {
8262 gsize len;
8272 {
8284 }
8286 /* contents is guaranteed to be \0 terminated */
8291 }
8293 static void
8296 gpointer user_data)
8297 {
8310 else
8316 }
8318 /**
8319 * g_file_load_bytes_async:
8320 * @file: a #GFile
8321 * @cancellable: (nullable): a #GCancellable or %NULL
8322 * @callback: (scope async): a #GAsyncReadyCallback to call when the
8323 * request is satisfied
8324 * @user_data: (closure): the data to pass to callback function
8325 *
8326 * Asynchronously loads the contents of @file as #GBytes.
8327 *
8328 * If @file is a resource:// based URI, the resulting bytes will reference the
8329 * embedded resource instead of a copy. Otherwise, this is equivalent to calling
8330 * g_file_load_contents_async() and g_bytes_new_take().
8331 *
8332 * @callback should call g_file_load_bytes_finish() to get the result of this
8333 * asynchronous operation.
8334 *
8335 * See g_file_load_bytes() for more information.
8336 *
8337 * Since: 2.56
8338 */
8339 void
8342 GAsyncReadyCallback callback,
8343 gpointer user_data)
8344 {
8356 {
8358 cancellable,
8359 g_file_load_bytes_cb,
8362 }
8368 else
8374 }
8376 /**
8377 * g_file_load_bytes_finish:
8378 * @file: a #GFile
8379 * @result: a #GAsyncResult provided to the callback
8380 * @etag_out: (out) (nullable) (optional): a location to place the current
8381 * entity tag for the file, or %NULL if the entity tag is not needed
8382 * @error: a location for a #GError, or %NULL
8383 *
8384 * Completes an asynchronous request to g_file_load_bytes_async().
8385 *
8386 * For resources, @etag_out will be set to %NULL.
8387 *
8388 * The data contained in the resulting #GBytes is always zero-terminated, but
8389 * this is not included in the #GBytes length. The resulting #GBytes should be
8390 * freed with g_bytes_unref() when no longer in use.
8391 *
8392 * See g_file_load_bytes() for more information.
8393 *
8394 * Returns: (transfer full): a #GBytes or %NULL and @error is set
8395 *
8396 * Since: 2.56
8397 */
8398 GBytes *
8403 {
8417 }