| blob | c17aeb040da7804593d6315be328e7d9adacb360 |
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 * This call does no blocking I/O.
706 *
707 * Returns: (transfer full): a new #GFile that is a duplicate
708 * of the given #GFile.
709 */
710 GFile *
712 {
720 }
722 /**
723 * g_file_hash:
724 * @file: (type GFile): #gconstpointer to a #GFile
725 *
726 * Creates a hash value for a #GFile.
727 *
728 * This call does no blocking I/O.
729 *
730 * Virtual: hash
731 * Returns: 0 if @file is not a valid #GFile, otherwise an
732 * integer that can be used as hash value for the #GFile.
733 * This function is intended for easily hashing a #GFile to
734 * add to a #GHashTable or similar data structure.
735 */
736 guint
738 {
746 }
748 /**
749 * g_file_equal:
750 * @file1: the first #GFile
751 * @file2: the second #GFile
752 *
753 * Checks if the two given #GFiles refer to the same file.
754 *
755 * Note that two #GFiles that differ can still refer to the same
756 * file on the filesystem due to various forms of filename
757 * aliasing.
758 *
759 * This call does no blocking I/O.
760 *
761 * Returns: %TRUE if @file1 and @file2 are equal.
762 */
763 gboolean
766 {
781 }
784 /**
785 * g_file_get_parent:
786 * @file: input #GFile
787 *
788 * Gets the parent directory for the @file.
789 * If the @file represents the root directory of the
790 * file system, then %NULL will be returned.
791 *
792 * This call does no blocking I/O.
793 *
794 * Returns: (nullable) (transfer full): a #GFile structure to the
795 * parent of the given #GFile or %NULL if there is no parent. Free
796 * the returned object with g_object_unref().
797 */
798 GFile *
800 {
808 }
810 /**
811 * g_file_has_parent:
812 * @file: input #GFile
813 * @parent: (nullable): the parent to check for, or %NULL
814 *
815 * Checks if @file has a parent, and optionally, if it is @parent.
816 *
817 * If @parent is %NULL then this function returns %TRUE if @file has any
818 * parent at all. If @parent is non-%NULL then %TRUE is only returned
819 * if @file is an immediate child of @parent.
820 *
821 * Returns: %TRUE if @file is an immediate child of @parent (or any parent in
822 * the case that @parent is %NULL).
823 *
824 * Since: 2.24
825 */
826 gboolean
829 {
831 gboolean result;
839 {
842 else
846 }
847 else
851 }
853 /**
854 * g_file_get_child:
855 * @file: input #GFile
856 * @name: (type filename): string containing the child's basename
857 *
858 * Gets a child of @file with basename equal to @name.
859 *
860 * Note that the file with that specific name might not exist, but
861 * you can still have a #GFile that points to it. You can use this
862 * for instance to create that file.
863 *
864 * This call does no blocking I/O.
865 *
866 * Returns: (transfer full): a #GFile to a child specified by @name.
867 * Free the returned object with g_object_unref().
868 */
869 GFile *
872 {
877 }
879 /**
880 * g_file_get_child_for_display_name:
881 * @file: input #GFile
882 * @display_name: string to a possible child
883 * @error: return location for an error
884 *
885 * Gets the child of @file for a given @display_name (i.e. a UTF-8
886 * version of the name). If this function fails, it returns %NULL
887 * and @error will be set. This is very useful when constructing a
888 * #GFile for a new file and the user entered the filename in the
889 * user interface, for instance when you select a directory and
890 * type a filename in the file selector.
891 *
892 * This call does no blocking I/O.
893 *
894 * Returns: (transfer full): a #GFile to the specified child, or
895 * %NULL if the display name couldn't be converted.
896 * Free the returned object with g_object_unref().
897 */
898 GFile *
902 {
911 }
913 /**
914 * g_file_has_prefix:
915 * @file: input #GFile
916 * @prefix: input #GFile
917 *
918 * Checks whether @file has the prefix specified by @prefix.
919 *
920 * In other words, if the names of initial elements of @file's
921 * pathname match @prefix. Only full pathname elements are matched,
922 * so a path like /foo is not considered a prefix of /foobar, only
923 * of /foo/bar.
924 *
925 * A #GFile is not a prefix of itself. If you want to check for
926 * equality, use g_file_equal().
927 *
928 * This call does no I/O, as it works purely on names. As such it can
929 * sometimes return %FALSE even if @file is inside a @prefix (from a
930 * filesystem point of view), because the prefix of @file is an alias
931 * of @prefix.
932 *
933 * Virtual: prefix_matches
934 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix,
935 * %FALSE otherwise.
936 */
937 gboolean
940 {
951 /* The vtable function differs in arg order since
952 * we're using the old contains_file call
953 */
955 }
957 /**
958 * g_file_get_relative_path:
959 * @parent: input #GFile
960 * @descendant: input #GFile
961 *
962 * Gets the path for @descendant relative to @parent.
963 *
964 * This call does no blocking I/O.
965 *
966 * Returns: (type filename) (nullable): string with the relative path from
967 * @descendant to @parent, or %NULL if @descendant doesn't have @parent as
968 * prefix. The returned string should be freed with g_free() when
969 * no longer needed.
970 */
974 {
986 }
988 /**
989 * g_file_resolve_relative_path:
990 * @file: input #GFile
991 * @relative_path: (type filename): a given relative path string
992 *
993 * Resolves a relative path for @file to an absolute path.
994 *
995 * This call does no blocking I/O.
996 *
997 * Returns: (transfer full): #GFile to the resolved path.
998 * %NULL if @relative_path is %NULL or if @file is invalid.
999 * Free the returned object with g_object_unref().
1000 */
1001 GFile *
1004 {
1013 }
1015 /**
1016 * g_file_enumerate_children:
1017 * @file: input #GFile
1018 * @attributes: an attribute query string
1019 * @flags: a set of #GFileQueryInfoFlags
1020 * @cancellable: (nullable): optional #GCancellable object,
1021 * %NULL to ignore
1022 * @error: #GError for error reporting
1023 *
1024 * Gets the requested information about the files in a directory.
1025 * The result is a #GFileEnumerator object that will give out
1026 * #GFileInfo objects for all the files in the directory.
1027 *
1028 * The @attributes value is a string that specifies the file
1029 * attributes that should be gathered. It is not an error if
1030 * it's not possible to read a particular requested attribute
1031 * from a file - it just won't be set. @attributes should
1032 * be a comma-separated list of attributes or attribute wildcards.
1033 * The wildcard "*" means all attributes, and a wildcard like
1034 * "standard::*" means all attributes in the standard namespace.
1035 * An example attribute query be "standard::*,owner::user".
1036 * The standard attributes are available as defines, like
1037 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1038 *
1039 * If @cancellable is not %NULL, then the operation can be cancelled
1040 * by triggering the cancellable object from another thread. If the
1041 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1042 * returned.
1043 *
1044 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1045 * be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY
1046 * error will be returned. Other errors are possible too.
1047 *
1048 * Returns: (transfer full): A #GFileEnumerator if successful,
1049 * %NULL on error. Free the returned object with g_object_unref().
1050 */
1051 GFileEnumerator *
1054 GFileQueryInfoFlags flags,
1057 {
1068 {
1070 G_IO_ERROR_NOT_SUPPORTED,
1073 }
1077 }
1079 /**
1080 * g_file_enumerate_children_async:
1081 * @file: input #GFile
1082 * @attributes: an attribute query string
1083 * @flags: a set of #GFileQueryInfoFlags
1084 * @io_priority: the [I/O priority][io-priority] of the request
1085 * @cancellable: (nullable): optional #GCancellable object,
1086 * %NULL to ignore
1087 * @callback: (scope async): a #GAsyncReadyCallback to call when the
1088 * request is satisfied
1089 * @user_data: (closure): the data to pass to callback function
1090 *
1091 * Asynchronously gets the requested information about the files
1092 * in a directory. The result is a #GFileEnumerator object that will
1093 * give out #GFileInfo objects for all the files in the directory.
1094 *
1095 * For more details, see g_file_enumerate_children() which is
1096 * the synchronous version of this call.
1097 *
1098 * When the operation is finished, @callback will be called. You can
1099 * then call g_file_enumerate_children_finish() to get the result of
1100 * the operation.
1101 */
1102 void
1105 GFileQueryInfoFlags flags,
1108 GAsyncReadyCallback callback,
1109 gpointer user_data)
1110 {
1117 attributes,
1118 flags,
1119 io_priority,
1120 cancellable,
1121 callback,
1122 user_data);
1123 }
1125 /**
1126 * g_file_enumerate_children_finish:
1127 * @file: input #GFile
1128 * @res: a #GAsyncResult
1129 * @error: a #GError
1130 *
1131 * Finishes an async enumerate children operation.
1132 * See g_file_enumerate_children_async().
1133 *
1134 * Returns: (transfer full): a #GFileEnumerator or %NULL
1135 * if an error occurred.
1136 * Free the returned object with g_object_unref().
1137 */
1138 GFileEnumerator *
1142 {
1153 }
1155 /**
1156 * g_file_query_exists:
1157 * @file: input #GFile
1158 * @cancellable: (nullable): optional #GCancellable object,
1159 * %NULL to ignore
1160 *
1161 * Utility function to check if a particular file exists. This is
1162 * implemented using g_file_query_info() and as such does blocking I/O.
1163 *
1164 * 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)
1165 * and then execute something based on the outcome of that, because the
1166 * file might have been created or removed in between the operations. The
1167 * general approach to handling that is to not check, but just do the
1168 * operation and handle the errors as they come.
1169 *
1170 * As an example of race-free checking, take the case of reading a file,
1171 * and if it doesn't exist, creating it. There are two racy versions: read
1172 * it, and on error create it; and: check if it exists, if not create it.
1173 * These can both result in two processes creating the file (with perhaps
1174 * a partially written file as the result). The correct approach is to
1175 * always try to create the file with g_file_create() which will either
1176 * atomically create the file or fail with a %G_IO_ERROR_EXISTS error.
1177 *
1178 * However, in many cases an existence check is useful in a user interface,
1179 * for instance to make a menu item sensitive/insensitive, so that you don't
1180 * have to fool users that something is possible and then just show an error
1181 * dialog. If you do this, you should make sure to also handle the errors
1182 * that can happen due to races when you execute the operation.
1183 *
1184 * Returns: %TRUE if the file exists (and can be detected without error),
1185 * %FALSE otherwise (or if cancelled).
1186 */
1187 gboolean
1190 {
1198 {
1201 }
1204 }
1206 /**
1207 * g_file_query_file_type:
1208 * @file: input #GFile
1209 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info()
1210 * @cancellable: (nullable): optional #GCancellable object,
1211 * %NULL to ignore
1212 *
1213 * Utility function to inspect the #GFileType of a file. This is
1214 * implemented using g_file_query_info() and as such does blocking I/O.
1215 *
1216 * The primary use case of this method is to check if a file is
1217 * a regular file, directory, or symlink.
1218 *
1219 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN
1220 * if the file does not exist
1221 *
1222 * Since: 2.18
1223 */
1224 GFileType
1226 GFileQueryInfoFlags flags,
1228 {
1230 GFileType file_type;
1236 {
1239 }
1240 else
1244 }
1246 /**
1247 * g_file_query_info:
1248 * @file: input #GFile
1249 * @attributes: an attribute query string
1250 * @flags: a set of #GFileQueryInfoFlags
1251 * @cancellable: (nullable): optional #GCancellable object,
1252 * %NULL to ignore
1253 * @error: a #GError
1254 *
1255 * Gets the requested information about specified @file.
1256 * The result is a #GFileInfo object that contains key-value
1257 * attributes (such as the type or size of the file).
1258 *
1259 * The @attributes value is a string that specifies the file
1260 * attributes that should be gathered. It is not an error if
1261 * it's not possible to read a particular requested attribute
1262 * from a file - it just won't be set. @attributes should be a
1263 * comma-separated list of attributes or attribute wildcards.
1264 * The wildcard "*" means all attributes, and a wildcard like
1265 * "standard::*" means all attributes in the standard namespace.
1266 * An example attribute query be "standard::*,owner::user".
1267 * The standard attributes are available as defines, like
1268 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1269 *
1270 * If @cancellable is not %NULL, then the operation can be cancelled
1271 * by triggering the cancellable object from another thread. If the
1272 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1273 * returned.
1274 *
1275 * For symlinks, normally the information about the target of the
1276 * symlink is returned, rather than information about the symlink
1277 * itself. However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
1278 * in @flags the information about the symlink itself will be returned.
1279 * Also, for symlinks that point to non-existing files the information
1280 * about the symlink itself will be returned.
1281 *
1282 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1283 * returned. Other errors are possible too, and depend on what kind of
1284 * filesystem the file is on.
1285 *
1286 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL
1287 * on error. Free the returned object with g_object_unref().
1288 */
1289 GFileInfo *
1292 GFileQueryInfoFlags flags,
1295 {
1306 {
1308 G_IO_ERROR_NOT_SUPPORTED,
1311 }
1314 }
1316 /**
1317 * g_file_query_info_async:
1318 * @file: input #GFile
1319 * @attributes: an attribute query string
1320 * @flags: a set of #GFileQueryInfoFlags
1321 * @io_priority: the [I/O priority][io-priority] of the request
1322 * @cancellable: (nullable): optional #GCancellable object,
1323 * %NULL to ignore
1324 * @callback: (scope async): a #GAsyncReadyCallback to call when the
1325 * request is satisfied
1326 * @user_data: (closure): the data to pass to callback function
1327 *
1328 * Asynchronously gets the requested information about specified @file.
1329 * The result is a #GFileInfo object that contains key-value attributes
1330 * (such as type or size for the file).
1331 *
1332 * For more details, see g_file_query_info() which is the synchronous
1333 * version of this call.
1334 *
1335 * When the operation is finished, @callback will be called. You can
1336 * then call g_file_query_info_finish() to get the result of the operation.
1337 */
1338 void
1341 GFileQueryInfoFlags flags,
1344 GAsyncReadyCallback callback,
1345 gpointer user_data)
1346 {
1353 attributes,
1354 flags,
1355 io_priority,
1356 cancellable,
1357 callback,
1358 user_data);
1359 }
1361 /**
1362 * g_file_query_info_finish:
1363 * @file: input #GFile
1364 * @res: a #GAsyncResult
1365 * @error: a #GError
1366 *
1367 * Finishes an asynchronous file info query.
1368 * See g_file_query_info_async().
1369 *
1370 * Returns: (transfer full): #GFileInfo for given @file
1371 * or %NULL on error. Free the returned object with
1372 * g_object_unref().
1373 */
1374 GFileInfo *
1378 {
1389 }
1391 /**
1392 * g_file_query_filesystem_info:
1393 * @file: input #GFile
1394 * @attributes: an attribute query string
1395 * @cancellable: (nullable): optional #GCancellable object,
1396 * %NULL to ignore
1397 * @error: a #GError
1398 *
1399 * Similar to g_file_query_info(), but obtains information
1400 * about the filesystem the @file is on, rather than the file itself.
1401 * For instance the amount of space available and the type of
1402 * the filesystem.
1403 *
1404 * The @attributes value is a string that specifies the attributes
1405 * that should be gathered. It is not an error if it's not possible
1406 * to read a particular requested attribute from a file - it just
1407 * won't be set. @attributes should be a comma-separated list of
1408 * attributes or attribute wildcards. The wildcard "*" means all
1409 * attributes, and a wildcard like "filesystem::*" means all attributes
1410 * in the filesystem namespace. The standard namespace for filesystem
1411 * attributes is "filesystem". Common attributes of interest are
1412 * #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
1413 * in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
1414 * and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1415 *
1416 * If @cancellable is not %NULL, then the operation can be cancelled
1417 * by triggering the cancellable object from another thread. If the
1418 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1419 * returned.
1420 *
1421 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1422 * be returned. Other errors are possible too, and depend on what
1423 * kind of filesystem the file is on.
1424 *
1425 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1426 * Free the returned object with g_object_unref().
1427 */
1428 GFileInfo *
1433 {
1444 {
1446 G_IO_ERROR_NOT_SUPPORTED,
1449 }
1452 }
1454 /**
1455 * g_file_query_filesystem_info_async:
1456 * @file: input #GFile
1457 * @attributes: an attribute query string
1458 * @io_priority: the [I/O priority][io-priority] of the request
1459 * @cancellable: (nullable): optional #GCancellable object,
1460 * %NULL to ignore
1461 * @callback: (scope async): a #GAsyncReadyCallback to call
1462 * when the request is satisfied
1463 * @user_data: (closure): the data to pass to callback function
1464 *
1465 * Asynchronously gets the requested information about the filesystem
1466 * that the specified @file is on. The result is a #GFileInfo object
1467 * that contains key-value attributes (such as type or size for the
1468 * file).
1469 *
1470 * For more details, see g_file_query_filesystem_info() which is the
1471 * synchronous version of this call.
1472 *
1473 * When the operation is finished, @callback will be called. You can
1474 * then call g_file_query_info_finish() to get the result of the
1475 * operation.
1476 */
1477 void
1482 GAsyncReadyCallback callback,
1483 gpointer user_data)
1484 {
1491 attributes,
1492 io_priority,
1493 cancellable,
1494 callback,
1495 user_data);
1496 }
1498 /**
1499 * g_file_query_filesystem_info_finish:
1500 * @file: input #GFile
1501 * @res: a #GAsyncResult
1502 * @error: a #GError
1503 *
1504 * Finishes an asynchronous filesystem info query.
1505 * See g_file_query_filesystem_info_async().
1506 *
1507 * Returns: (transfer full): #GFileInfo for given @file
1508 * or %NULL on error.
1509 * Free the returned object with g_object_unref().
1510 */
1511 GFileInfo *
1515 {
1526 }
1528 /**
1529 * g_file_find_enclosing_mount:
1530 * @file: input #GFile
1531 * @cancellable: (nullable): optional #GCancellable object,
1532 * %NULL to ignore
1533 * @error: a #GError
1534 *
1535 * Gets a #GMount for the #GFile.
1536 *
1537 * If the #GFileIface for @file does not have a mount (e.g.
1538 * possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND
1539 * and %NULL will be returned.
1540 *
1541 * If @cancellable is not %NULL, then the operation can be cancelled by
1542 * triggering the cancellable object from another thread. If the operation
1543 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1544 *
1545 * Returns: (transfer full): a #GMount where the @file is located
1546 * or %NULL on error.
1547 * Free the returned object with g_object_unref().
1548 */
1549 GMount *
1553 {
1563 {
1566 /* Translators: This is an error message when
1567 * trying to find the enclosing (user visible)
1568 * mount of a file, but none exists.
1569 */
1572 }
1575 }
1577 /**
1578 * g_file_find_enclosing_mount_async:
1579 * @file: a #GFile
1580 * @io_priority: the [I/O priority][io-priority] of the request
1581 * @cancellable: (nullable): optional #GCancellable object,
1582 * %NULL to ignore
1583 * @callback: (scope async): a #GAsyncReadyCallback to call
1584 * when the request is satisfied
1585 * @user_data: (closure): the data to pass to callback function
1586 *
1587 * Asynchronously gets the mount for the file.
1588 *
1589 * For more details, see g_file_find_enclosing_mount() which is
1590 * the synchronous version of this call.
1591 *
1592 * When the operation is finished, @callback will be called.
1593 * You can then call g_file_find_enclosing_mount_finish() to
1594 * get the result of the operation.
1595 */
1596 void
1600 GAsyncReadyCallback callback,
1601 gpointer user_data)
1602 {
1609 io_priority,
1610 cancellable,
1611 callback,
1612 user_data);
1613 }
1615 /**
1616 * g_file_find_enclosing_mount_finish:
1617 * @file: a #GFile
1618 * @res: a #GAsyncResult
1619 * @error: a #GError
1620 *
1621 * Finishes an asynchronous find mount request.
1622 * See g_file_find_enclosing_mount_async().
1623 *
1624 * Returns: (transfer full): #GMount for given @file or %NULL on error.
1625 * Free the returned object with g_object_unref().
1626 */
1627 GMount *
1631 {
1642 }
1645 /**
1646 * g_file_read:
1647 * @file: #GFile to read
1648 * @cancellable: (nullable): a #GCancellable
1649 * @error: a #GError, or %NULL
1650 *
1651 * Opens a file for reading. The result is a #GFileInputStream that
1652 * can be used to read the contents of the file.
1653 *
1654 * If @cancellable is not %NULL, then the operation can be cancelled by
1655 * triggering the cancellable object from another thread. If the operation
1656 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1657 *
1658 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1659 * returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1660 * error will be returned. Other errors are possible too, and depend
1661 * on what kind of filesystem the file is on.
1662 *
1663 * Virtual: read_fn
1664 * Returns: (transfer full): #GFileInputStream or %NULL on error.
1665 * Free the returned object with g_object_unref().
1666 */
1667 GFileInputStream *
1671 {
1682 {
1684 G_IO_ERROR_NOT_SUPPORTED,
1687 }
1690 }
1692 /**
1693 * g_file_append_to:
1694 * @file: input #GFile
1695 * @flags: a set of #GFileCreateFlags
1696 * @cancellable: (nullable): optional #GCancellable object,
1697 * %NULL to ignore
1698 * @error: a #GError, or %NULL
1699 *
1700 * Gets an output stream for appending data to the file.
1701 * If the file doesn't already exist it is created.
1702 *
1703 * By default files created are generally readable by everyone,
1704 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1705 * will be made readable only to the current user, to the level that
1706 * is supported on the target filesystem.
1707 *
1708 * If @cancellable is not %NULL, then the operation can be cancelled
1709 * by triggering the cancellable object from another thread. If the
1710 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1711 * returned.
1712 *
1713 * Some file systems don't allow all file names, and may return an
1714 * %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the
1715 * %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are
1716 * possible too, and depend on what kind of filesystem the file is on.
1717 *
1718 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1719 * Free the returned object with g_object_unref().
1720 */
1721 GFileOutputStream *
1723 GFileCreateFlags flags,
1726 {
1737 {
1739 G_IO_ERROR_NOT_SUPPORTED,
1742 }
1745 }
1747 /**
1748 * g_file_create:
1749 * @file: input #GFile
1750 * @flags: a set of #GFileCreateFlags
1751 * @cancellable: (nullable): optional #GCancellable object,
1752 * %NULL to ignore
1753 * @error: a #GError, or %NULL
1754 *
1755 * Creates a new file and returns an output stream for writing to it.
1756 * The file must not already exist.
1757 *
1758 * By default files created are generally readable by everyone,
1759 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1760 * will be made readable only to the current user, to the level
1761 * that is supported on the target filesystem.
1762 *
1763 * If @cancellable is not %NULL, then the operation can be cancelled
1764 * by triggering the cancellable object from another thread. If the
1765 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1766 * returned.
1767 *
1768 * If a file or directory with this name already exists the
1769 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1770 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1771 * error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will
1772 * be returned. Other errors are possible too, and depend on what kind
1773 * of filesystem the file is on.
1774 *
1775 * Returns: (transfer full): a #GFileOutputStream for the newly created
1776 * file, or %NULL on error.
1777 * Free the returned object with g_object_unref().
1778 */
1779 GFileOutputStream *
1781 GFileCreateFlags flags,
1784 {
1795 {
1797 G_IO_ERROR_NOT_SUPPORTED,
1800 }
1803 }
1805 /**
1806 * g_file_replace:
1807 * @file: input #GFile
1808 * @etag: (nullable): an optional [entity tag][gfile-etag]
1809 * for the current #GFile, or #NULL to ignore
1810 * @make_backup: %TRUE if a backup should be created
1811 * @flags: a set of #GFileCreateFlags
1812 * @cancellable: (nullable): optional #GCancellable object,
1813 * %NULL to ignore
1814 * @error: a #GError, or %NULL
1815 *
1816 * Returns an output stream for overwriting the file, possibly
1817 * creating a backup copy of the file first. If the file doesn't exist,
1818 * it will be created.
1819 *
1820 * This will try to replace the file in the safest way possible so
1821 * that any errors during the writing will not affect an already
1822 * existing copy of the file. For instance, for local files it
1823 * may write to a temporary file and then atomically rename over
1824 * the destination when the stream is closed.
1825 *
1826 * By default files created are generally readable by everyone,
1827 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1828 * will be made readable only to the current user, to the level that
1829 * is supported on the target filesystem.
1830 *
1831 * If @cancellable is not %NULL, then the operation can be cancelled
1832 * by triggering the cancellable object from another thread. If the
1833 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1834 * returned.
1835 *
1836 * If you pass in a non-%NULL @etag value and @file already exists, then
1837 * this value is compared to the current entity tag of the file, and if
1838 * they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
1839 * generally means that the file has been changed since you last read
1840 * it. You can get the new etag from g_file_output_stream_get_etag()
1841 * after you've finished writing and closed the #GFileOutputStream. When
1842 * you load a new file you can use g_file_input_stream_query_info() to
1843 * get the etag of the file.
1844 *
1845 * If @make_backup is %TRUE, this function will attempt to make a
1846 * backup of the current file before overwriting it. If this fails
1847 * a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
1848 * want to replace anyway, try again with @make_backup set to %FALSE.
1849 *
1850 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will
1851 * be returned, and if the file is some other form of non-regular file
1852 * then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some
1853 * file systems don't allow all file names, and may return an
1854 * %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long
1855 * %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are
1856 * possible too, and depend on what kind of filesystem the file is on.
1857 *
1858 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1859 * Free the returned object with g_object_unref().
1860 */
1861 GFileOutputStream *
1864 gboolean make_backup,
1865 GFileCreateFlags flags,
1868 {
1879 {
1881 G_IO_ERROR_NOT_SUPPORTED,
1884 }
1886 /* Handle empty tag string as NULL in consistent way. */
1891 }
1893 /**
1894 * g_file_open_readwrite:
1895 * @file: #GFile to open
1896 * @cancellable: (nullable): a #GCancellable
1897 * @error: a #GError, or %NULL
1898 *
1899 * Opens an existing file for reading and writing. The result is
1900 * a #GFileIOStream that can be used to read and write the contents
1901 * of the file.
1902 *
1903 * If @cancellable is not %NULL, then the operation can be cancelled
1904 * by triggering the cancellable object from another thread. If the
1905 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1906 * returned.
1907 *
1908 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1909 * be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1910 * error will be returned. Other errors are possible too, and depend on
1911 * what kind of filesystem the file is on. Note that in many non-local
1912 * file cases read and write streams are not supported, so make sure you
1913 * really need to do read and write streaming, rather than just opening
1914 * for reading or writing.
1915 *
1916 * Returns: (transfer full): #GFileIOStream or %NULL on error.
1917 * Free the returned object with g_object_unref().
1918 *
1919 * Since: 2.22
1920 */
1921 GFileIOStream *
1925 {
1936 {
1938 G_IO_ERROR_NOT_SUPPORTED,
1941 }
1944 }
1946 /**
1947 * g_file_create_readwrite:
1948 * @file: a #GFile
1949 * @flags: a set of #GFileCreateFlags
1950 * @cancellable: (nullable): optional #GCancellable object,
1951 * %NULL to ignore
1952 * @error: return location for a #GError, or %NULL
1953 *
1954 * Creates a new file and returns a stream for reading and
1955 * writing to it. The file must not already exist.
1956 *
1957 * By default files created are generally readable by everyone,
1958 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1959 * will be made readable only to the current user, to the level
1960 * that is supported on the target filesystem.
1961 *
1962 * If @cancellable is not %NULL, then the operation can be cancelled
1963 * by triggering the cancellable object from another thread. If the
1964 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1965 * returned.
1966 *
1967 * If a file or directory with this name already exists, the
1968 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1969 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1970 * error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG
1971 * will be returned. Other errors are possible too, and depend on what
1972 * kind of filesystem the file is on.
1973 *
1974 * Note that in many non-local file cases read and write streams are
1975 * not supported, so make sure you really need to do read and write
1976 * streaming, rather than just opening for reading or writing.
1977 *
1978 * Returns: (transfer full): a #GFileIOStream for the newly created
1979 * file, or %NULL on error.
1980 * Free the returned object with g_object_unref().
1981 *
1982 * Since: 2.22
1983 */
1984 GFileIOStream *
1986 GFileCreateFlags flags,
1989 {
2000 {
2002 G_IO_ERROR_NOT_SUPPORTED,
2005 }
2008 }
2010 /**
2011 * g_file_replace_readwrite:
2012 * @file: a #GFile
2013 * @etag: (nullable): an optional [entity tag][gfile-etag]
2014 * for the current #GFile, or #NULL to ignore
2015 * @make_backup: %TRUE if a backup should be created
2016 * @flags: a set of #GFileCreateFlags
2017 * @cancellable: (nullable): optional #GCancellable object,
2018 * %NULL to ignore
2019 * @error: return location for a #GError, or %NULL
2020 *
2021 * Returns an output stream for overwriting the file in readwrite mode,
2022 * possibly creating a backup copy of the file first. If the file doesn't
2023 * exist, it will be created.
2024 *
2025 * For details about the behaviour, see g_file_replace() which does the
2026 * same thing but returns an output stream only.
2027 *
2028 * Note that in many non-local file cases read and write streams are not
2029 * supported, so make sure you really need to do read and write streaming,
2030 * rather than just opening for reading or writing.
2031 *
2032 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2033 * Free the returned object with g_object_unref().
2034 *
2035 * Since: 2.22
2036 */
2037 GFileIOStream *
2040 gboolean make_backup,
2041 GFileCreateFlags flags,
2044 {
2055 {
2057 G_IO_ERROR_NOT_SUPPORTED,
2060 }
2063 }
2065 /**
2066 * g_file_read_async:
2067 * @file: input #GFile
2068 * @io_priority: the [I/O priority][io-priority] of the request
2069 * @cancellable: (nullable): optional #GCancellable object,
2070 * %NULL to ignore
2071 * @callback: (scope async): a #GAsyncReadyCallback to call
2072 * when the request is satisfied
2073 * @user_data: (closure): the data to pass to callback function
2074 *
2075 * Asynchronously opens @file for reading.
2076 *
2077 * For more details, see g_file_read() which is
2078 * the synchronous version of this call.
2079 *
2080 * When the operation is finished, @callback will be called.
2081 * You can then call g_file_read_finish() to get the result
2082 * of the operation.
2083 */
2084 void
2088 GAsyncReadyCallback callback,
2089 gpointer user_data)
2090 {
2097 io_priority,
2098 cancellable,
2099 callback,
2100 user_data);
2101 }
2103 /**
2104 * g_file_read_finish:
2105 * @file: input #GFile
2106 * @res: a #GAsyncResult
2107 * @error: a #GError, or %NULL
2108 *
2109 * Finishes an asynchronous file read operation started with
2110 * g_file_read_async().
2111 *
2112 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
2113 * Free the returned object with g_object_unref().
2114 */
2115 GFileInputStream *
2119 {
2130 }
2132 /**
2133 * g_file_append_to_async:
2134 * @file: input #GFile
2135 * @flags: a set of #GFileCreateFlags
2136 * @io_priority: the [I/O priority][io-priority] of the request
2137 * @cancellable: (nullable): optional #GCancellable object,
2138 * %NULL to ignore
2139 * @callback: (scope async): a #GAsyncReadyCallback to call
2140 * when the request is satisfied
2141 * @user_data: (closure): the data to pass to callback function
2142 *
2143 * Asynchronously opens @file for appending.
2144 *
2145 * For more details, see g_file_append_to() which is
2146 * the synchronous version of this call.
2147 *
2148 * When the operation is finished, @callback will be called.
2149 * You can then call g_file_append_to_finish() to get the result
2150 * of the operation.
2151 */
2152 void
2154 GFileCreateFlags flags,
2157 GAsyncReadyCallback callback,
2158 gpointer user_data)
2159 {
2166 flags,
2167 io_priority,
2168 cancellable,
2169 callback,
2170 user_data);
2171 }
2173 /**
2174 * g_file_append_to_finish:
2175 * @file: input #GFile
2176 * @res: #GAsyncResult
2177 * @error: a #GError, or %NULL
2178 *
2179 * Finishes an asynchronous file append operation started with
2180 * g_file_append_to_async().
2181 *
2182 * Returns: (transfer full): a valid #GFileOutputStream
2183 * or %NULL on error.
2184 * Free the returned object with g_object_unref().
2185 */
2186 GFileOutputStream *
2190 {
2201 }
2203 /**
2204 * g_file_create_async:
2205 * @file: input #GFile
2206 * @flags: a set of #GFileCreateFlags
2207 * @io_priority: the [I/O priority][io-priority] of the request
2208 * @cancellable: (nullable): optional #GCancellable object,
2209 * %NULL to ignore
2210 * @callback: (scope async): a #GAsyncReadyCallback to call
2211 * when the request is satisfied
2212 * @user_data: (closure): the data to pass to callback function
2213 *
2214 * Asynchronously creates a new file and returns an output stream
2215 * for writing to it. The file must not already exist.
2216 *
2217 * For more details, see g_file_create() which is
2218 * the synchronous version of this call.
2219 *
2220 * When the operation is finished, @callback will be called.
2221 * You can then call g_file_create_finish() to get the result
2222 * of the operation.
2223 */
2224 void
2226 GFileCreateFlags flags,
2229 GAsyncReadyCallback callback,
2230 gpointer user_data)
2231 {
2238 flags,
2239 io_priority,
2240 cancellable,
2241 callback,
2242 user_data);
2243 }
2245 /**
2246 * g_file_create_finish:
2247 * @file: input #GFile
2248 * @res: a #GAsyncResult
2249 * @error: a #GError, or %NULL
2250 *
2251 * Finishes an asynchronous file create operation started with
2252 * g_file_create_async().
2253 *
2254 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2255 * Free the returned object with g_object_unref().
2256 */
2257 GFileOutputStream *
2261 {
2272 }
2274 /**
2275 * g_file_replace_async:
2276 * @file: input #GFile
2277 * @etag: (nullable): an [entity tag][gfile-etag] for the current #GFile,
2278 * or %NULL to ignore
2279 * @make_backup: %TRUE if a backup should be created
2280 * @flags: a set of #GFileCreateFlags
2281 * @io_priority: the [I/O priority][io-priority] of the request
2282 * @cancellable: (nullable): optional #GCancellable object,
2283 * %NULL to ignore
2284 * @callback: (scope async): a #GAsyncReadyCallback to call
2285 * when the request is satisfied
2286 * @user_data: (closure): the data to pass to callback function
2287 *
2288 * Asynchronously overwrites the file, replacing the contents,
2289 * possibly creating a backup copy of the file first.
2290 *
2291 * For more details, see g_file_replace() which is
2292 * the synchronous version of this call.
2293 *
2294 * When the operation is finished, @callback will be called.
2295 * You can then call g_file_replace_finish() to get the result
2296 * of the operation.
2297 */
2298 void
2301 gboolean make_backup,
2302 GFileCreateFlags flags,
2305 GAsyncReadyCallback callback,
2306 gpointer user_data)
2307 {
2314 etag,
2315 make_backup,
2316 flags,
2317 io_priority,
2318 cancellable,
2319 callback,
2320 user_data);
2321 }
2323 /**
2324 * g_file_replace_finish:
2325 * @file: input #GFile
2326 * @res: a #GAsyncResult
2327 * @error: a #GError, or %NULL
2328 *
2329 * Finishes an asynchronous file replace operation started with
2330 * g_file_replace_async().
2331 *
2332 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2333 * Free the returned object with g_object_unref().
2334 */
2335 GFileOutputStream *
2339 {
2350 }
2352 /**
2353 * g_file_open_readwrite_async
2354 * @file: input #GFile
2355 * @io_priority: the [I/O priority][io-priority] of the request
2356 * @cancellable: (nullable): optional #GCancellable object,
2357 * %NULL to ignore
2358 * @callback: (scope async): a #GAsyncReadyCallback to call
2359 * when the request is satisfied
2360 * @user_data: (closure): the data to pass to callback function
2361 *
2362 * Asynchronously opens @file for reading and writing.
2363 *
2364 * For more details, see g_file_open_readwrite() which is
2365 * the synchronous version of this call.
2366 *
2367 * When the operation is finished, @callback will be called.
2368 * You can then call g_file_open_readwrite_finish() to get
2369 * the result of the operation.
2370 *
2371 * Since: 2.22
2372 */
2373 void
2377 GAsyncReadyCallback callback,
2378 gpointer user_data)
2379 {
2386 io_priority,
2387 cancellable,
2388 callback,
2389 user_data);
2390 }
2392 /**
2393 * g_file_open_readwrite_finish:
2394 * @file: input #GFile
2395 * @res: a #GAsyncResult
2396 * @error: a #GError, or %NULL
2397 *
2398 * Finishes an asynchronous file read operation started with
2399 * g_file_open_readwrite_async().
2400 *
2401 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2402 * Free the returned object with g_object_unref().
2403 *
2404 * Since: 2.22
2405 */
2406 GFileIOStream *
2410 {
2421 }
2423 /**
2424 * g_file_create_readwrite_async:
2425 * @file: input #GFile
2426 * @flags: a set of #GFileCreateFlags
2427 * @io_priority: the [I/O priority][io-priority] of the request
2428 * @cancellable: (nullable): optional #GCancellable object,
2429 * %NULL to ignore
2430 * @callback: (scope async): a #GAsyncReadyCallback to call
2431 * when the request is satisfied
2432 * @user_data: (closure): the data to pass to callback function
2433 *
2434 * Asynchronously creates a new file and returns a stream
2435 * for reading and writing to it. The file must not already exist.
2436 *
2437 * For more details, see g_file_create_readwrite() which is
2438 * the synchronous version of this call.
2439 *
2440 * When the operation is finished, @callback will be called.
2441 * You can then call g_file_create_readwrite_finish() to get
2442 * the result of the operation.
2443 *
2444 * Since: 2.22
2445 */
2446 void
2448 GFileCreateFlags flags,
2451 GAsyncReadyCallback callback,
2452 gpointer user_data)
2453 {
2460 flags,
2461 io_priority,
2462 cancellable,
2463 callback,
2464 user_data);
2465 }
2467 /**
2468 * g_file_create_readwrite_finish:
2469 * @file: input #GFile
2470 * @res: a #GAsyncResult
2471 * @error: a #GError, or %NULL
2472 *
2473 * Finishes an asynchronous file create operation started with
2474 * g_file_create_readwrite_async().
2475 *
2476 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2477 * Free the returned object with g_object_unref().
2478 *
2479 * Since: 2.22
2480 */
2481 GFileIOStream *
2485 {
2496 }
2498 /**
2499 * g_file_replace_readwrite_async:
2500 * @file: input #GFile
2501 * @etag: (nullable): an [entity tag][gfile-etag] for the current #GFile,
2502 * or %NULL to ignore
2503 * @make_backup: %TRUE if a backup should be created
2504 * @flags: a set of #GFileCreateFlags
2505 * @io_priority: the [I/O priority][io-priority] of the request
2506 * @cancellable: (nullable): optional #GCancellable object,
2507 * %NULL to ignore
2508 * @callback: (scope async): a #GAsyncReadyCallback to call
2509 * when the request is satisfied
2510 * @user_data: (closure): the data to pass to callback function
2511 *
2512 * Asynchronously overwrites the file in read-write mode,
2513 * replacing the contents, possibly creating a backup copy
2514 * of the file first.
2515 *
2516 * For more details, see g_file_replace_readwrite() which is
2517 * the synchronous version of this call.
2518 *
2519 * When the operation is finished, @callback will be called.
2520 * You can then call g_file_replace_readwrite_finish() to get
2521 * the result of the operation.
2522 *
2523 * Since: 2.22
2524 */
2525 void
2528 gboolean make_backup,
2529 GFileCreateFlags flags,
2532 GAsyncReadyCallback callback,
2533 gpointer user_data)
2534 {
2541 etag,
2542 make_backup,
2543 flags,
2544 io_priority,
2545 cancellable,
2546 callback,
2547 user_data);
2548 }
2550 /**
2551 * g_file_replace_readwrite_finish:
2552 * @file: input #GFile
2553 * @res: a #GAsyncResult
2554 * @error: a #GError, or %NULL
2555 *
2556 * Finishes an asynchronous file replace operation started with
2557 * g_file_replace_readwrite_async().
2558 *
2559 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2560 * Free the returned object with g_object_unref().
2561 *
2562 * Since: 2.22
2563 */
2564 GFileIOStream *
2568 {
2579 }
2581 static gboolean
2583 GFileCopyFlags flags,
2587 {
2589 gboolean tried_delete;
2591 GFileType file_type;
2595 retry:
2598 {
2599 /* Maybe it already existed, and we want to overwrite? */
2602 {
2605 /* Don't overwrite if the destination is a directory */
2607 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2610 {
2615 {
2619 }
2620 }
2627 }
2628 /* Nah, fail */
2631 }
2634 }
2639 GFileCopyFlags flags,
2642 {
2646 GFileType file_type;
2653 /* There was an error opening the source, try to set a good error for it: */
2655 {
2656 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2657 * as that is less useful to the app. Better check for errors on the
2658 * target instead.
2659 */
2664 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2668 {
2673 {
2675 {
2679 }
2680 /* continue to would_recurse error */
2681 }
2682 else
2683 {
2687 }
2688 }
2689 else
2690 {
2691 /* Error getting info from target, return that error
2692 * (except for NOT_FOUND, which is no error here)
2693 */
2696 {
2699 }
2701 }
2706 }
2710 }
2712 static gboolean
2714 gboolean copy_all_attributes,
2715 gboolean skip_perms)
2716 {
2723 }
2725 static gboolean
2727 GFileCopyFlags flags,
2731 {
2735 gboolean first;
2737 gboolean copy_all_attributes;
2738 gboolean skip_perms;
2743 /* Ignore errors here, if the target supports no attributes there is
2744 * nothing to copy. We still honor the cancellable though.
2745 */
2761 {
2763 {
2765 {
2768 else
2772 }
2773 }
2774 }
2777 {
2779 {
2781 {
2784 else
2789 }
2790 }
2791 }
2796 out:
2805 }
2807 /**
2808 * g_file_copy_attributes:
2809 * @source: a #GFile with attributes
2810 * @destination: a #GFile to copy attributes to
2811 * @flags: a set of #GFileCopyFlags
2812 * @cancellable: (nullable): optional #GCancellable object,
2813 * %NULL to ignore
2814 * @error: a #GError, %NULL to ignore
2815 *
2816 * Copies the file attributes from @source to @destination.
2817 *
2818 * Normally only a subset of the file attributes are copied,
2819 * those that are copies in a normal file copy operation
2820 * (which for instance does not include e.g. owner). However
2821 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2822 * all the metadata that is possible to copy is copied. This
2823 * is useful when implementing move by copy + delete source.
2824 *
2825 * Returns: %TRUE if the attributes were copied successfully,
2826 * %FALSE otherwise.
2827 */
2828 gboolean
2831 GFileCopyFlags flags,
2834 {
2836 gboolean res;
2838 gboolean source_nofollow_symlinks;
2846 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2847 * we just don't copy it.
2848 */
2851 cancellable,
2852 NULL);
2858 {
2860 info,
2861 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2862 cancellable,
2863 error);
2865 }
2868 }
2870 /* 256k minus malloc overhead */
2871 #define STREAM_BUFFER_SIZE (1024*256 - 2 *sizeof(gpointer))
2873 static gboolean
2878 GFileProgressCallback progress_callback,
2879 gpointer progress_callback_data,
2881 {
2882 gssize n_read;
2883 gsize n_written;
2884 goffset current_size;
2886 gboolean res;
2887 goffset total_size;
2891 /* avoid performance impact of querying total size when it's not needed */
2893 {
2895 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2898 {
2902 }
2905 {
2907 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2908 G_FILE_QUERY_INFO_NONE,
2911 {
2915 }
2916 }
2917 }
2926 {
2929 {
2932 }
2945 }
2948 /* Make sure we send full copied size */
2953 }
2955 #ifdef HAVE_SPLICE
2957 static gboolean
2965 {
2968 retry:
2972 {
2980 else
2987 }
2991 }
2993 static gboolean
2997 GFileProgressCallback progress_callback,
2998 gpointer progress_callback_data,
3000 {
3003 gboolean res;
3004 goffset total_size;
3005 loff_t offset_in;
3006 loff_t offset_out;
3015 #if defined(F_SETPIPE_SZ) && defined(F_GETPIPE_SZ)
3016 /* Try a 1MiB buffer for improved throughput. If that fails, use the default
3017 * pipe size. See: https://bugzilla.gnome.org/791457 */
3020 {
3026 {
3031 }
3032 }
3033 #else
3034 /* If #F_GETPIPE_SZ isn’t available, assume we’re on Linux < 2.6.35,
3035 * but ≥ 2.6.11, meaning the pipe capacity is 64KiB. Ignore the possibility of
3036 * running on Linux < 2.6.11 (where the capacity was the system page size,
3037 * typically 4KiB) because it’s ancient. See pipe(7). */
3039 #endif
3044 /* avoid performance impact of querying total size when it's not needed */
3046 {
3051 }
3059 {
3070 {
3073 }
3076 {
3084 }
3088 }
3090 /* Make sure we send full copied size */
3100 out:
3107 }
3108 #endif
3110 #ifdef __linux__
3111 static gboolean
3116 GFileProgressCallback progress_callback,
3117 gpointer progress_callback_data,
3119 {
3120 goffset source_size;
3130 /* Btrfs clone ioctl properties:
3131 * - Works at the inode level
3132 * - Doesn't work with directories
3133 * - Always follows symlinks (source and destination)
3134 *
3135 * By the time we get here, *in and *out are both regular files */
3140 {
3143 G_IO_ERROR_NOT_SUPPORTED,
3147 G_IO_ERROR_NOT_SUPPORTED,
3149 else
3150 /* Most probably something odd happened; retry with fallback */
3152 G_IO_ERROR_NOT_SUPPORTED,
3154 /* We retry with fallback for all error cases because Btrfs is currently
3155 * unstable, and so we can't trust it to do clone properly.
3156 * In addition, any hard errors here would cause the same failure in the
3157 * fallback manual copy as well. */
3159 }
3161 /* Make sure we send full copied size */
3166 }
3167 #endif
3169 static gboolean
3172 GFileCopyFlags flags,
3174 GFileProgressCallback progress_callback,
3175 gpointer progress_callback_data,
3177 {
3187 /* need to know the file type */
3190 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3191 cancellable,
3192 error);
3196 /* Maybe copy the symlink? */
3199 {
3202 {
3208 }
3209 /* ... else fall back on a regular file copy */
3210 }
3211 /* Handle "special" files (pipes, device nodes, ...)? */
3213 {
3214 /* FIXME: could try to recreate device nodes and others? */
3218 }
3220 /* Everything else should just fall back on a regular copy. */
3232 {
3235 /* Ok, ditch the previous lightweight info (on Unix we just
3236 * called lstat()); at this point we gather all the information
3237 * we need about the source from the opened file descriptor.
3238 */
3244 {
3245 /* Not all gvfs backends implement query_info_on_read(), we
3246 * can just fall back to the pathname again.
3247 * https://bugzilla.gnome.org/706254
3248 */
3250 {
3254 }
3255 else
3256 {
3260 }
3261 }
3267 }
3269 /* In the local file path, we pass down the source info which
3270 * includes things like unix::mode, to ensure that the target file
3271 * is not created with different permissions from the source file.
3272 *
3273 * If a future API like g_file_replace_with_info() is added, switch
3274 * this code to use that.
3275 */
3277 {
3279 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3282 G_FILE_CREATE_REPLACE_DESTINATION,
3283 info,
3285 else
3286 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3289 }
3291 {
3293 NULL,
3295 G_FILE_CREATE_REPLACE_DESTINATION,
3297 }
3298 else
3299 {
3301 }
3306 #ifdef __linux__
3308 {
3314 {
3316 {
3318 }
3319 else
3320 {
3323 }
3324 }
3325 else
3326 {
3329 }
3330 }
3331 #endif
3333 #ifdef HAVE_SPLICE
3335 {
3341 {
3343 {
3345 }
3346 else
3347 {
3350 }
3351 }
3352 else
3353 {
3356 }
3357 }
3359 #endif
3361 /* A plain read/write loop */
3364 error))
3368 out:
3370 {
3371 /* Don't care about errors in source here */
3374 }
3377 {
3378 /* But write errors on close are bad! */
3382 }
3384 /* Ignore errors here. Failure to copy metadata is not a hard error */
3385 /* TODO: set these attributes /before/ we do the rename() on Unix */
3387 {
3389 info,
3390 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3391 cancellable,
3392 NULL);
3393 }
3398 }
3400 /**
3401 * g_file_copy:
3402 * @source: input #GFile
3403 * @destination: destination #GFile
3404 * @flags: set of #GFileCopyFlags
3405 * @cancellable: (nullable): optional #GCancellable object,
3406 * %NULL to ignore
3407 * @progress_callback: (nullable) (scope call): function to callback with
3408 * progress information, or %NULL if progress information is not needed
3409 * @progress_callback_data: (closure): user data to pass to @progress_callback
3410 * @error: #GError to set on error, or %NULL
3411 *
3412 * Copies the file @source to the location specified by @destination.
3413 * Can not handle recursive copies of directories.
3414 *
3415 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3416 * existing @destination file is overwritten.
3417 *
3418 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3419 * will be copied as symlinks, otherwise the target of the
3420 * @source symlink will be copied.
3421 *
3422 * If the flag #G_FILE_COPY_ALL_METADATA is specified then all the metadata
3423 * that is possible to copy is copied, not just the default subset (which,
3424 * for instance, does not include the owner, see #GFileInfo).
3425 *
3426 * If @cancellable is not %NULL, then the operation can be cancelled by
3427 * triggering the cancellable object from another thread. If the operation
3428 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3429 *
3430 * If @progress_callback is not %NULL, then the operation can be monitored
3431 * by setting this to a #GFileProgressCallback function.
3432 * @progress_callback_data will be passed to this function. It is guaranteed
3433 * that this callback will be called after all data has been transferred with
3434 * the total number of bytes copied during the operation.
3435 *
3436 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3437 * is returned, independent on the status of the @destination.
3438 *
3439 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3440 * the error %G_IO_ERROR_EXISTS is returned.
3441 *
3442 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3443 * error is returned. If trying to overwrite a directory with a directory the
3444 * %G_IO_ERROR_WOULD_MERGE error is returned.
3445 *
3446 * If the source is a directory and the target does not exist, or
3447 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3448 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3449 *
3450 * If you are interested in copying the #GFile object itself (not the on-disk
3451 * file), see g_file_dup().
3452 *
3453 * Returns: %TRUE on success, %FALSE otherwise.
3454 */
3455 gboolean
3458 GFileCopyFlags flags,
3460 GFileProgressCallback progress_callback,
3461 gpointer progress_callback_data,
3463 {
3466 gboolean res;
3476 {
3487 {
3490 }
3491 else
3493 }
3495 /* If the types are different, and the destination method failed
3496 * also try the source method
3497 */
3499 {
3503 {
3514 {
3517 }
3518 else
3520 }
3521 }
3525 error);
3526 }
3528 /**
3529 * g_file_copy_async:
3530 * @source: input #GFile
3531 * @destination: destination #GFile
3532 * @flags: set of #GFileCopyFlags
3533 * @io_priority: the [I/O priority][io-priority] of the request
3534 * @cancellable: (nullable): optional #GCancellable object,
3535 * %NULL to ignore
3536 * @progress_callback: (nullable) (scope notified): function to callback with progress
3537 * information, or %NULL if progress information is not needed
3538 * @progress_callback_data: (closure progress_callback) (nullable): user data to pass to @progress_callback
3539 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3540 * @user_data: (closure callback): the data to pass to callback function
3541 *
3542 * Copies the file @source to the location specified by @destination
3543 * asynchronously. For details of the behaviour, see g_file_copy().
3544 *
3545 * If @progress_callback is not %NULL, then that function that will be called
3546 * just like in g_file_copy(). The callback will run in the default main context
3547 * of the thread calling g_file_copy_async() — the same context as @callback is
3548 * run in.
3549 *
3550 * When the operation is finished, @callback will be called. You can then call
3551 * g_file_copy_finish() to get the result of the operation.
3552 */
3553 void
3556 GFileCopyFlags flags,
3559 GFileProgressCallback progress_callback,
3560 gpointer progress_callback_data,
3561 GAsyncReadyCallback callback,
3562 gpointer user_data)
3563 {
3571 destination,
3572 flags,
3573 io_priority,
3574 cancellable,
3575 progress_callback,
3576 progress_callback_data,
3577 callback,
3578 user_data);
3579 }
3581 /**
3582 * g_file_copy_finish:
3583 * @file: input #GFile
3584 * @res: a #GAsyncResult
3585 * @error: a #GError, or %NULL
3586 *
3587 * Finishes copying the file started with g_file_copy_async().
3588 *
3589 * Returns: a %TRUE on success, %FALSE on error.
3590 */
3591 gboolean
3595 {
3606 }
3608 /**
3609 * g_file_move:
3610 * @source: #GFile pointing to the source location
3611 * @destination: #GFile pointing to the destination location
3612 * @flags: set of #GFileCopyFlags
3613 * @cancellable: (nullable): optional #GCancellable object,
3614 * %NULL to ignore
3615 * @progress_callback: (nullable) (scope call): #GFileProgressCallback
3616 * function for updates
3617 * @progress_callback_data: (closure): gpointer to user data for
3618 * the callback function
3619 * @error: #GError for returning error conditions, or %NULL
3620 *
3621 * Tries to move the file or directory @source to the location specified
3622 * by @destination. If native move operations are supported then this is
3623 * used, otherwise a copy + delete fallback is used. The native
3624 * implementation may support moving directories (for instance on moves
3625 * inside the same filesystem), but the fallback code does not.
3626 *
3627 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3628 * existing @destination file is overwritten.
3629 *
3630 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3631 * will be copied as symlinks, otherwise the target of the
3632 * @source symlink will be copied.
3633 *
3634 * If @cancellable is not %NULL, then the operation can be cancelled by
3635 * triggering the cancellable object from another thread. If the operation
3636 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3637 *
3638 * If @progress_callback is not %NULL, then the operation can be monitored
3639 * by setting this to a #GFileProgressCallback function.
3640 * @progress_callback_data will be passed to this function. It is
3641 * guaranteed that this callback will be called after all data has been
3642 * transferred with the total number of bytes copied during the operation.
3643 *
3644 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3645 * error is returned, independent on the status of the @destination.
3646 *
3647 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3648 * then the error %G_IO_ERROR_EXISTS is returned.
3649 *
3650 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3651 * error is returned. If trying to overwrite a directory with a directory the
3652 * %G_IO_ERROR_WOULD_MERGE error is returned.
3653 *
3654 * If the source is a directory and the target does not exist, or
3655 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3656 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3657 * move operation isn't available).
3658 *
3659 * Returns: %TRUE on successful move, %FALSE otherwise.
3660 */
3661 gboolean
3664 GFileCopyFlags flags,
3666 GFileProgressCallback progress_callback,
3667 gpointer progress_callback_data,
3669 {
3672 gboolean res;
3682 {
3693 {
3696 }
3697 else
3699 }
3701 /* If the types are different, and the destination method failed
3702 * also try the source method
3703 */
3705 {
3709 {
3720 {
3723 }
3724 else
3726 }
3727 }
3730 {
3732 G_IO_ERROR_NOT_SUPPORTED,
3735 }
3740 error))
3744 }
3746 /**
3747 * g_file_make_directory:
3748 * @file: input #GFile
3749 * @cancellable: (nullable): optional #GCancellable object,
3750 * %NULL to ignore
3751 * @error: a #GError, or %NULL
3752 *
3753 * Creates a directory. Note that this will only create a child directory
3754 * of the immediate parent directory of the path or URI given by the #GFile.
3755 * To recursively create directories, see g_file_make_directory_with_parents().
3756 * This function will fail if the parent directory does not exist, setting
3757 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3758 * creating directories, this function will fail, setting @error to
3759 * %G_IO_ERROR_NOT_SUPPORTED.
3760 *
3761 * For a local #GFile the newly created directory will have the default
3762 * (current) ownership and permissions of the current process.
3763 *
3764 * If @cancellable is not %NULL, then the operation can be cancelled by
3765 * triggering the cancellable object from another thread. If the operation
3766 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3767 *
3768 * Returns: %TRUE on successful creation, %FALSE otherwise.
3769 */
3770 gboolean
3774 {
3785 {
3787 G_IO_ERROR_NOT_SUPPORTED,
3790 }
3793 }
3795 /**
3796 * g_file_make_directory_async:
3797 * @file: input #GFile
3798 * @io_priority: the [I/O priority][io-priority] of the request
3799 * @cancellable: (nullable): optional #GCancellable object,
3800 * %NULL to ignore
3801 * @callback: a #GAsyncReadyCallback to call
3802 * when the request is satisfied
3803 * @user_data: the data to pass to callback function
3804 *
3805 * Asynchronously creates a directory.
3806 *
3807 * Virtual: make_directory_async
3808 * Since: 2.38
3809 */
3810 void
3814 GAsyncReadyCallback callback,
3815 gpointer user_data)
3816 {
3823 io_priority,
3824 cancellable,
3825 callback,
3826 user_data);
3827 }
3829 /**
3830 * g_file_make_directory_finish:
3831 * @file: input #GFile
3832 * @result: a #GAsyncResult
3833 * @error: a #GError, or %NULL
3834 *
3835 * Finishes an asynchronous directory creation, started with
3836 * g_file_make_directory_async().
3837 *
3838 * Virtual: make_directory_finish
3839 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3840 * Since: 2.38
3841 */
3842 gboolean
3846 {
3854 }
3856 /**
3857 * g_file_make_directory_with_parents:
3858 * @file: input #GFile
3859 * @cancellable: (nullable): optional #GCancellable object,
3860 * %NULL to ignore
3861 * @error: a #GError, or %NULL
3862 *
3863 * Creates a directory and any parent directories that may not
3864 * exist similar to 'mkdir -p'. If the file system does not support
3865 * creating directories, this function will fail, setting @error to
3866 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3867 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3868 * the similar g_mkdir_with_parents().
3869 *
3870 * For a local #GFile the newly created directories will have the default
3871 * (current) ownership and permissions of the current process.
3872 *
3873 * If @cancellable is not %NULL, then the operation can be cancelled by
3874 * triggering the cancellable object from another thread. If the operation
3875 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3876 *
3877 * Returns: %TRUE if all directories have been successfully created, %FALSE
3878 * otherwise.
3879 *
3880 * Since: 2.18
3881 */
3882 gboolean
3886 {
3896 /* Try for the simple case of not having to create any parent
3897 * directories. If any parent directory needs to be created, this
3898 * call will fail with NOT_FOUND. If that happens, then that value of
3899 * my_error persists into the while loop below.
3900 */
3903 {
3907 }
3911 /* Creates the parent directories as needed. In case any particular
3912 * creation operation fails for lack of other parent directories
3913 * (NOT_FOUND), the directory is added to a list of directories to
3914 * create later, and the value of my_error is retained until the next
3915 * iteration of the loop. After the loop my_error should either be
3916 * empty or contain a real failure condition.
3917 */
3919 {
3928 /* Another process may have created the directory in between the
3929 * G_IO_ERROR_NOT_FOUND and now
3930 */
3939 else
3941 }
3943 /* All directories should be able to be created now, so an error at
3944 * this point means the whole operation must fail -- except an EXISTS
3945 * error, which means that another process already created the
3946 * directory in between the previous failure and now.
3947 */
3949 {
3953 }
3958 /* Clean up */
3960 {
3963 }
3965 /* At this point an error in my_error means a that something
3966 * unexpected failed in either of the loops above, so the whole
3967 * operation must fail.
3968 */
3970 {
3973 }
3976 }
3978 /**
3979 * g_file_make_symbolic_link:
3980 * @file: a #GFile with the name of the symlink to create
3981 * @symlink_value: (type filename): a string with the path for the target
3982 * of the new symlink
3983 * @cancellable: (nullable): optional #GCancellable object,
3984 * %NULL to ignore
3985 * @error: a #GError
3986 *
3987 * Creates a symbolic link named @file which contains the string
3988 * @symlink_value.
3989 *
3990 * If @cancellable is not %NULL, then the operation can be cancelled by
3991 * triggering the cancellable object from another thread. If the operation
3992 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3993 *
3994 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3995 */
3996 gboolean
4001 {
4011 {
4013 G_IO_ERROR_INVALID_ARGUMENT,
4016 }
4021 {
4023 G_IO_ERROR_NOT_SUPPORTED,
4026 }
4029 }
4031 /**
4032 * g_file_delete:
4033 * @file: input #GFile
4034 * @cancellable: (nullable): optional #GCancellable object,
4035 * %NULL to ignore
4036 * @error: a #GError, or %NULL
4037 *
4038 * Deletes a file. If the @file is a directory, it will only be
4039 * deleted if it is empty. This has the same semantics as g_unlink().
4040 *
4041 * If @cancellable is not %NULL, then the operation can be cancelled by
4042 * triggering the cancellable object from another thread. If the operation
4043 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4044 *
4045 * Virtual: delete_file
4046 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
4047 */
4048 gboolean
4052 {
4063 {
4065 G_IO_ERROR_NOT_SUPPORTED,
4068 }
4071 }
4073 /**
4074 * g_file_delete_async:
4075 * @file: input #GFile
4076 * @io_priority: the [I/O priority][io-priority] of the request
4077 * @cancellable: (nullable): optional #GCancellable object,
4078 * %NULL to ignore
4079 * @callback: a #GAsyncReadyCallback to call
4080 * when the request is satisfied
4081 * @user_data: the data to pass to callback function
4082 *
4083 * Asynchronously delete a file. If the @file is a directory, it will
4084 * only be deleted if it is empty. This has the same semantics as
4085 * g_unlink().
4086 *
4087 * Virtual: delete_file_async
4088 * Since: 2.34
4089 */
4090 void
4094 GAsyncReadyCallback callback,
4095 gpointer user_data)
4096 {
4103 io_priority,
4104 cancellable,
4105 callback,
4106 user_data);
4107 }
4109 /**
4110 * g_file_delete_finish:
4111 * @file: input #GFile
4112 * @result: a #GAsyncResult
4113 * @error: a #GError, or %NULL
4114 *
4115 * Finishes deleting a file started with g_file_delete_async().
4116 *
4117 * Virtual: delete_file_finish
4118 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
4119 * Since: 2.34
4120 **/
4121 gboolean
4125 {
4136 }
4138 /**
4139 * g_file_trash:
4140 * @file: #GFile to send to trash
4141 * @cancellable: (nullable): optional #GCancellable object,
4142 * %NULL to ignore
4143 * @error: a #GError, or %NULL
4144 *
4145 * Sends @file to the "Trashcan", if possible. This is similar to
4146 * deleting it, but the user can recover it before emptying the trashcan.
4147 * Not all file systems support trashing, so this call can return the
4148 * %G_IO_ERROR_NOT_SUPPORTED error.
4149 *
4150 * If @cancellable is not %NULL, then the operation can be cancelled by
4151 * triggering the cancellable object from another thread. If the operation
4152 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4153 *
4154 * Virtual: trash
4155 * Returns: %TRUE on successful trash, %FALSE otherwise.
4156 */
4157 gboolean
4161 {
4172 {
4177 }
4180 }
4182 /**
4183 * g_file_trash_async:
4184 * @file: input #GFile
4185 * @io_priority: the [I/O priority][io-priority] of the request
4186 * @cancellable: (nullable): optional #GCancellable object,
4187 * %NULL to ignore
4188 * @callback: a #GAsyncReadyCallback to call
4189 * when the request is satisfied
4190 * @user_data: the data to pass to callback function
4191 *
4192 * Asynchronously sends @file to the Trash location, if possible.
4193 *
4194 * Virtual: trash_async
4195 * Since: 2.38
4196 */
4197 void
4201 GAsyncReadyCallback callback,
4202 gpointer user_data)
4203 {
4210 io_priority,
4211 cancellable,
4212 callback,
4213 user_data);
4214 }
4216 /**
4217 * g_file_trash_finish:
4218 * @file: input #GFile
4219 * @result: a #GAsyncResult
4220 * @error: a #GError, or %NULL
4221 *
4222 * Finishes an asynchronous file trashing operation, started with
4223 * g_file_trash_async().
4224 *
4225 * Virtual: trash_finish
4226 * Returns: %TRUE on successful trash, %FALSE otherwise.
4227 * Since: 2.38
4228 */
4229 gboolean
4233 {
4241 }
4243 /**
4244 * g_file_set_display_name:
4245 * @file: input #GFile
4246 * @display_name: a string
4247 * @cancellable: (nullable): optional #GCancellable object,
4248 * %NULL to ignore
4249 * @error: a #GError, or %NULL
4250 *
4251 * Renames @file to the specified display name.
4252 *
4253 * The display name is converted from UTF-8 to the correct encoding
4254 * for the target filesystem if possible and the @file is renamed to this.
4255 *
4256 * If you want to implement a rename operation in the user interface the
4257 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4258 * initial value in the rename widget, and then the result after editing
4259 * should be passed to g_file_set_display_name().
4260 *
4261 * On success the resulting converted filename is returned.
4262 *
4263 * If @cancellable is not %NULL, then the operation can be cancelled by
4264 * triggering the cancellable object from another thread. If the operation
4265 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4266 *
4267 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4268 * or %NULL if there was an error.
4269 * Free the returned object with g_object_unref().
4270 */
4271 GFile *
4276 {
4283 {
4285 G_IO_ERROR,
4286 G_IO_ERROR_INVALID_ARGUMENT,
4289 }
4297 }
4299 /**
4300 * g_file_set_display_name_async:
4301 * @file: input #GFile
4302 * @display_name: a string
4303 * @io_priority: the [I/O priority][io-priority] of the request
4304 * @cancellable: (nullable): optional #GCancellable object,
4305 * %NULL to ignore
4306 * @callback: (scope async): a #GAsyncReadyCallback to call
4307 * when the request is satisfied
4308 * @user_data: (closure): the data to pass to callback function
4309 *
4310 * Asynchronously sets the display name for a given #GFile.
4311 *
4312 * For more details, see g_file_set_display_name() which is
4313 * the synchronous version of this call.
4314 *
4315 * When the operation is finished, @callback will be called.
4316 * You can then call g_file_set_display_name_finish() to get
4317 * the result of the operation.
4318 */
4319 void
4322 gint io_priority,
4324 GAsyncReadyCallback callback,
4325 gpointer user_data)
4326 {
4334 display_name,
4335 io_priority,
4336 cancellable,
4337 callback,
4338 user_data);
4339 }
4341 /**
4342 * g_file_set_display_name_finish:
4343 * @file: input #GFile
4344 * @res: a #GAsyncResult
4345 * @error: a #GError, or %NULL
4346 *
4347 * Finishes setting a display name started with
4348 * g_file_set_display_name_async().
4349 *
4350 * Returns: (transfer full): a #GFile or %NULL on error.
4351 * Free the returned object with g_object_unref().
4352 */
4353 GFile *
4357 {
4368 }
4370 /**
4371 * g_file_query_settable_attributes:
4372 * @file: input #GFile
4373 * @cancellable: (nullable): optional #GCancellable object,
4374 * %NULL to ignore
4375 * @error: a #GError, or %NULL
4376 *
4377 * Obtain the list of settable attributes for the file.
4378 *
4379 * Returns the type and full attribute name of all the attributes
4380 * that can be set on this file. This doesn't mean setting it will
4381 * always succeed though, you might get an access failure, or some
4382 * specific file may not support a specific attribute.
4383 *
4384 * If @cancellable is not %NULL, then the operation can be cancelled by
4385 * triggering the cancellable object from another thread. If the operation
4386 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4387 *
4388 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4389 * When you are done with it, release it with
4390 * g_file_attribute_info_list_unref()
4391 */
4392 GFileAttributeInfoList *
4396 {
4415 {
4417 {
4420 }
4421 else
4423 }
4426 }
4428 /**
4429 * g_file_query_writable_namespaces:
4430 * @file: input #GFile
4431 * @cancellable: (nullable): optional #GCancellable object,
4432 * %NULL to ignore
4433 * @error: a #GError, or %NULL
4434 *
4435 * Obtain the list of attribute namespaces where new attributes
4436 * can be created by a user. An example of this is extended
4437 * attributes (in the "xattr" namespace).
4438 *
4439 * If @cancellable is not %NULL, then the operation can be cancelled by
4440 * triggering the cancellable object from another thread. If the operation
4441 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4442 *
4443 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4444 * When you are done with it, release it with
4445 * g_file_attribute_info_list_unref()
4446 */
4447 GFileAttributeInfoList *
4451 {
4470 {
4473 }
4476 {
4478 {
4480 }
4481 else
4483 }
4486 }
4488 /**
4489 * g_file_set_attribute:
4490 * @file: input #GFile
4491 * @attribute: a string containing the attribute's name
4492 * @type: The type of the attribute
4493 * @value_p: (nullable): a pointer to the value (or the pointer
4494 * itself if the type is a pointer type)
4495 * @flags: a set of #GFileQueryInfoFlags
4496 * @cancellable: (nullable): optional #GCancellable object,
4497 * %NULL to ignore
4498 * @error: a #GError, or %NULL
4499 *
4500 * Sets an attribute in the file with attribute name @attribute to @value.
4501 *
4502 * Some attributes can be unset by setting @type to
4503 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4504 *
4505 * If @cancellable is not %NULL, then the operation can be cancelled by
4506 * triggering the cancellable object from another thread. If the operation
4507 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4508 *
4509 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4510 */
4511 gboolean
4514 GFileAttributeType type,
4515 gpointer value_p,
4516 GFileQueryInfoFlags flags,
4519 {
4531 {
4533 G_IO_ERROR_NOT_SUPPORTED,
4536 }
4539 }
4541 /**
4542 * g_file_set_attributes_from_info:
4543 * @file: input #GFile
4544 * @info: a #GFileInfo
4545 * @flags: #GFileQueryInfoFlags
4546 * @cancellable: (nullable): optional #GCancellable object,
4547 * %NULL to ignore
4548 * @error: a #GError, or %NULL
4549 *
4550 * Tries to set all attributes in the #GFileInfo on the target
4551 * values, not stopping on the first error.
4552 *
4553 * If there is any error during this operation then @error will
4554 * be set to the first error. Error on particular fields are flagged
4555 * by setting the "status" field in the attribute value to
4556 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4557 * also detect further errors.
4558 *
4559 * If @cancellable is not %NULL, then the operation can be cancelled by
4560 * triggering the cancellable object from another thread. If the operation
4561 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4562 *
4563 * Returns: %FALSE if there was any error, %TRUE otherwise.
4564 */
4565 gboolean
4568 GFileQueryInfoFlags flags,
4571 {
4585 info,
4586 flags,
4587 cancellable,
4588 error);
4589 }
4591 static gboolean
4594 GFileQueryInfoFlags flags,
4597 {
4600 gboolean res;
4608 {
4617 {
4620 /* Don't set error multiple times */
4622 }
4623 else
4625 }
4630 }
4632 /**
4633 * g_file_set_attributes_async:
4634 * @file: input #GFile
4635 * @info: a #GFileInfo
4636 * @flags: a #GFileQueryInfoFlags
4637 * @io_priority: the [I/O priority][io-priority] of the request
4638 * @cancellable: (nullable): optional #GCancellable object,
4639 * %NULL to ignore
4640 * @callback: (scope async): a #GAsyncReadyCallback
4641 * @user_data: (closure): a #gpointer
4642 *
4643 * Asynchronously sets the attributes of @file with @info.
4644 *
4645 * For more details, see g_file_set_attributes_from_info(),
4646 * which is the synchronous version of this call.
4647 *
4648 * When the operation is finished, @callback will be called.
4649 * You can then call g_file_set_attributes_finish() to get
4650 * the result of the operation.
4651 */
4652 void
4655 GFileQueryInfoFlags flags,
4658 GAsyncReadyCallback callback,
4659 gpointer user_data)
4660 {
4668 info,
4669 flags,
4670 io_priority,
4671 cancellable,
4672 callback,
4673 user_data);
4674 }
4676 /**
4677 * g_file_set_attributes_finish:
4678 * @file: input #GFile
4679 * @result: a #GAsyncResult
4680 * @info: (out) (transfer full): a #GFileInfo
4681 * @error: a #GError, or %NULL
4682 *
4683 * Finishes setting an attribute started in g_file_set_attributes_async().
4684 *
4685 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4686 */
4687 gboolean
4692 {
4698 /* No standard handling of errors here, as we must set info even
4699 * on errors
4700 */
4703 }
4705 /**
4706 * g_file_set_attribute_string:
4707 * @file: input #GFile
4708 * @attribute: a string containing the attribute's name
4709 * @value: a string containing the attribute's value
4710 * @flags: #GFileQueryInfoFlags
4711 * @cancellable: (nullable): optional #GCancellable object,
4712 * %NULL to ignore
4713 * @error: a #GError, or %NULL
4714 *
4715 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4716 * If @attribute is of a different type, this operation will fail.
4717 *
4718 * If @cancellable is not %NULL, then the operation can be cancelled by
4719 * triggering the cancellable object from another thread. If the operation
4720 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4721 *
4722 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4723 */
4724 gboolean
4728 GFileQueryInfoFlags flags,
4731 {
4735 }
4737 /**
4738 * g_file_set_attribute_byte_string:
4739 * @file: input #GFile
4740 * @attribute: a string containing the attribute's name
4741 * @value: a string containing the attribute's new value
4742 * @flags: a #GFileQueryInfoFlags
4743 * @cancellable: (nullable): optional #GCancellable object,
4744 * %NULL to ignore
4745 * @error: a #GError, or %NULL
4746 *
4747 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4748 * If @attribute is of a different type, this operation will fail,
4749 * returning %FALSE.
4750 *
4751 * If @cancellable is not %NULL, then the operation can be cancelled by
4752 * triggering the cancellable object from another thread. If the operation
4753 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4754 *
4755 * Returns: %TRUE if the @attribute was successfully set to @value
4756 * in the @file, %FALSE otherwise.
4757 */
4758 gboolean
4762 GFileQueryInfoFlags flags,
4765 {
4769 }
4771 /**
4772 * g_file_set_attribute_uint32:
4773 * @file: input #GFile
4774 * @attribute: a string containing the attribute's name
4775 * @value: a #guint32 containing the attribute's new value
4776 * @flags: a #GFileQueryInfoFlags
4777 * @cancellable: (nullable): optional #GCancellable object,
4778 * %NULL to ignore
4779 * @error: a #GError, or %NULL
4780 *
4781 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4782 * If @attribute is of a different type, this operation will fail.
4783 *
4784 * If @cancellable is not %NULL, then the operation can be cancelled by
4785 * triggering the cancellable object from another thread. If the operation
4786 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4787 *
4788 * Returns: %TRUE if the @attribute was successfully set to @value
4789 * in the @file, %FALSE otherwise.
4790 */
4791 gboolean
4794 guint32 value,
4795 GFileQueryInfoFlags flags,
4798 {
4802 }
4804 /**
4805 * g_file_set_attribute_int32:
4806 * @file: input #GFile
4807 * @attribute: a string containing the attribute's name
4808 * @value: a #gint32 containing the attribute's new value
4809 * @flags: a #GFileQueryInfoFlags
4810 * @cancellable: (nullable): optional #GCancellable object,
4811 * %NULL to ignore
4812 * @error: a #GError, or %NULL
4813 *
4814 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4815 * If @attribute is of a different type, this operation will fail.
4816 *
4817 * If @cancellable is not %NULL, then the operation can be cancelled by
4818 * triggering the cancellable object from another thread. If the operation
4819 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4820 *
4821 * Returns: %TRUE if the @attribute was successfully set to @value
4822 * in the @file, %FALSE otherwise.
4823 */
4824 gboolean
4827 gint32 value,
4828 GFileQueryInfoFlags flags,
4831 {
4835 }
4837 /**
4838 * g_file_set_attribute_uint64:
4839 * @file: input #GFile
4840 * @attribute: a string containing the attribute's name
4841 * @value: a #guint64 containing the attribute's new value
4842 * @flags: a #GFileQueryInfoFlags
4843 * @cancellable: (nullable): optional #GCancellable object,
4844 * %NULL to ignore
4845 * @error: a #GError, or %NULL
4846 *
4847 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4848 * If @attribute is of a different type, this operation will fail.
4849 *
4850 * If @cancellable is not %NULL, then the operation can be cancelled by
4851 * triggering the cancellable object from another thread. If the operation
4852 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4853 *
4854 * Returns: %TRUE if the @attribute was successfully set to @value
4855 * in the @file, %FALSE otherwise.
4856 */
4857 gboolean
4860 guint64 value,
4861 GFileQueryInfoFlags flags,
4864 {
4868 }
4870 /**
4871 * g_file_set_attribute_int64:
4872 * @file: input #GFile
4873 * @attribute: a string containing the attribute's name
4874 * @value: a #guint64 containing the attribute's new value
4875 * @flags: a #GFileQueryInfoFlags
4876 * @cancellable: (nullable): optional #GCancellable object,
4877 * %NULL to ignore
4878 * @error: a #GError, or %NULL
4879 *
4880 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4881 * If @attribute is of a different type, this operation will fail.
4882 *
4883 * If @cancellable is not %NULL, then the operation can be cancelled by
4884 * triggering the cancellable object from another thread. If the operation
4885 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4886 *
4887 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4888 */
4889 gboolean
4892 gint64 value,
4893 GFileQueryInfoFlags flags,
4896 {
4900 }
4902 /**
4903 * g_file_mount_mountable:
4904 * @file: input #GFile
4905 * @flags: flags affecting the operation
4906 * @mount_operation: (nullable): a #GMountOperation,
4907 * or %NULL to avoid user interaction
4908 * @cancellable: (nullable): optional #GCancellable object,
4909 * %NULL to ignore
4910 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4911 * when the request is satisfied, or %NULL
4912 * @user_data: (closure): the data to pass to callback function
4913 *
4914 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4915 * Using @mount_operation, you can request callbacks when, for instance,
4916 * passwords are needed during authentication.
4917 *
4918 * If @cancellable is not %NULL, then the operation can be cancelled by
4919 * triggering the cancellable object from another thread. If the operation
4920 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4921 *
4922 * When the operation is finished, @callback will be called.
4923 * You can then call g_file_mount_mountable_finish() to get
4924 * the result of the operation.
4925 */
4926 void
4928 GMountMountFlags flags,
4931 GAsyncReadyCallback callback,
4932 gpointer user_data)
4933 {
4941 {
4943 g_file_mount_mountable,
4947 }
4950 flags,
4951 mount_operation,
4952 cancellable,
4953 callback,
4954 user_data);
4955 }
4957 /**
4958 * g_file_mount_mountable_finish:
4959 * @file: input #GFile
4960 * @result: a #GAsyncResult
4961 * @error: a #GError, or %NULL
4962 *
4963 * Finishes a mount operation. See g_file_mount_mountable() for details.
4964 *
4965 * Finish an asynchronous mount operation that was started
4966 * with g_file_mount_mountable().
4967 *
4968 * Returns: (transfer full): a #GFile or %NULL on error.
4969 * Free the returned object with g_object_unref().
4970 */
4971 GFile *
4975 {
4988 }
4990 /**
4991 * g_file_unmount_mountable:
4992 * @file: input #GFile
4993 * @flags: flags affecting the operation
4994 * @cancellable: (nullable): optional #GCancellable object,
4995 * %NULL to ignore
4996 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4997 * when the request is satisfied, or %NULL
4998 * @user_data: (closure): the data to pass to callback function
4999 *
5000 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
5001 *
5002 * If @cancellable is not %NULL, then the operation can be cancelled by
5003 * triggering the cancellable object from another thread. If the operation
5004 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5005 *
5006 * When the operation is finished, @callback will be called.
5007 * You can then call g_file_unmount_mountable_finish() to get
5008 * the result of the operation.
5009 *
5010 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
5011 */
5012 void
5014 GMountUnmountFlags flags,
5016 GAsyncReadyCallback callback,
5017 gpointer user_data)
5018 {
5026 {
5028 g_file_unmount_mountable_with_operation,
5032 }
5035 flags,
5036 cancellable,
5037 callback,
5038 user_data);
5039 }
5041 /**
5042 * g_file_unmount_mountable_finish:
5043 * @file: input #GFile
5044 * @result: a #GAsyncResult
5045 * @error: a #GError, or %NULL
5046 *
5047 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
5048 *
5049 * Finish an asynchronous unmount operation that was started
5050 * with g_file_unmount_mountable().
5051 *
5052 * Returns: %TRUE if the operation finished successfully.
5053 * %FALSE otherwise.
5054 *
5055 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
5056 * instead.
5057 */
5058 gboolean
5062 {
5075 }
5077 /**
5078 * g_file_unmount_mountable_with_operation:
5079 * @file: input #GFile
5080 * @flags: flags affecting the operation
5081 * @mount_operation: (nullable): a #GMountOperation,
5082 * or %NULL to avoid user interaction
5083 * @cancellable: (nullable): optional #GCancellable object,
5084 * %NULL to ignore
5085 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5086 * when the request is satisfied, or %NULL
5087 * @user_data: (closure): the data to pass to callback function
5088 *
5089 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
5090 *
5091 * If @cancellable is not %NULL, then the operation can be cancelled by
5092 * triggering the cancellable object from another thread. If the operation
5093 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5094 *
5095 * When the operation is finished, @callback will be called.
5096 * You can then call g_file_unmount_mountable_finish() to get
5097 * the result of the operation.
5098 *
5099 * Since: 2.22
5100 */
5101 void
5103 GMountUnmountFlags flags,
5106 GAsyncReadyCallback callback,
5107 gpointer user_data)
5108 {
5116 {
5118 g_file_unmount_mountable_with_operation,
5122 }
5126 flags,
5127 mount_operation,
5128 cancellable,
5129 callback,
5130 user_data);
5131 else
5133 flags,
5134 cancellable,
5135 callback,
5136 user_data);
5137 }
5139 /**
5140 * g_file_unmount_mountable_with_operation_finish:
5141 * @file: input #GFile
5142 * @result: a #GAsyncResult
5143 * @error: a #GError, or %NULL
5144 *
5145 * Finishes an unmount operation,
5146 * see g_file_unmount_mountable_with_operation() for details.
5147 *
5148 * Finish an asynchronous unmount operation that was started
5149 * with g_file_unmount_mountable_with_operation().
5150 *
5151 * Returns: %TRUE if the operation finished successfully.
5152 * %FALSE otherwise.
5153 *
5154 * Since: 2.22
5155 */
5156 gboolean
5160 {
5174 else
5176 }
5178 /**
5179 * g_file_eject_mountable:
5180 * @file: input #GFile
5181 * @flags: flags affecting the operation
5182 * @cancellable: (nullable): optional #GCancellable object,
5183 * %NULL to ignore
5184 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5185 * when the request is satisfied, or %NULL
5186 * @user_data: (closure): the data to pass to callback function
5187 *
5188 * Starts an asynchronous eject on a mountable.
5189 * When this operation has completed, @callback will be called with
5190 * @user_user data, and the operation can be finalized with
5191 * g_file_eject_mountable_finish().
5192 *
5193 * If @cancellable is not %NULL, then the operation can be cancelled by
5194 * triggering the cancellable object from another thread. If the operation
5195 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5196 *
5197 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5198 */
5199 void
5201 GMountUnmountFlags flags,
5203 GAsyncReadyCallback callback,
5204 gpointer user_data)
5205 {
5213 {
5215 g_file_eject_mountable_with_operation,
5219 }
5222 flags,
5223 cancellable,
5224 callback,
5225 user_data);
5226 }
5228 /**
5229 * g_file_eject_mountable_finish:
5230 * @file: input #GFile
5231 * @result: a #GAsyncResult
5232 * @error: a #GError, or %NULL
5233 *
5234 * Finishes an asynchronous eject operation started by
5235 * g_file_eject_mountable().
5236 *
5237 * Returns: %TRUE if the @file was ejected successfully.
5238 * %FALSE otherwise.
5239 *
5240 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5241 * instead.
5242 */
5243 gboolean
5247 {
5260 }
5262 /**
5263 * g_file_eject_mountable_with_operation:
5264 * @file: input #GFile
5265 * @flags: flags affecting the operation
5266 * @mount_operation: (nullable): a #GMountOperation,
5267 * or %NULL to avoid user interaction
5268 * @cancellable: (nullable): optional #GCancellable object,
5269 * %NULL to ignore
5270 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5271 * when the request is satisfied, or %NULL
5272 * @user_data: (closure): the data to pass to callback function
5273 *
5274 * Starts an asynchronous eject on a mountable.
5275 * When this operation has completed, @callback will be called with
5276 * @user_user data, and the operation can be finalized with
5277 * g_file_eject_mountable_with_operation_finish().
5278 *
5279 * If @cancellable is not %NULL, then the operation can be cancelled by
5280 * triggering the cancellable object from another thread. If the operation
5281 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5282 *
5283 * Since: 2.22
5284 */
5285 void
5287 GMountUnmountFlags flags,
5290 GAsyncReadyCallback callback,
5291 gpointer user_data)
5292 {
5300 {
5302 g_file_eject_mountable_with_operation,
5306 }
5310 flags,
5311 mount_operation,
5312 cancellable,
5313 callback,
5314 user_data);
5315 else
5317 flags,
5318 cancellable,
5319 callback,
5320 user_data);
5321 }
5323 /**
5324 * g_file_eject_mountable_with_operation_finish:
5325 * @file: input #GFile
5326 * @result: a #GAsyncResult
5327 * @error: a #GError, or %NULL
5328 *
5329 * Finishes an asynchronous eject operation started by
5330 * g_file_eject_mountable_with_operation().
5331 *
5332 * Returns: %TRUE if the @file was ejected successfully.
5333 * %FALSE otherwise.
5334 *
5335 * Since: 2.22
5336 */
5337 gboolean
5341 {
5355 else
5357 }
5359 /**
5360 * g_file_monitor_directory:
5361 * @file: input #GFile
5362 * @flags: a set of #GFileMonitorFlags
5363 * @cancellable: (nullable): optional #GCancellable object,
5364 * %NULL to ignore
5365 * @error: a #GError, or %NULL
5366 *
5367 * Obtains a directory monitor for the given file.
5368 * This may fail if directory monitoring is not supported.
5369 *
5370 * If @cancellable is not %NULL, then the operation can be cancelled by
5371 * triggering the cancellable object from another thread. If the operation
5372 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5373 *
5374 * It does not make sense for @flags to contain
5375 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5376 * directories. It is not possible to monitor all the files in a
5377 * directory for changes made via hard links; if you want to do this then
5378 * you must register individual watches with g_file_monitor().
5379 *
5380 * Virtual: monitor_dir
5381 * Returns: (transfer full): a #GFileMonitor for the given @file,
5382 * or %NULL on error.
5383 * Free the returned object with g_object_unref().
5384 */
5385 GFileMonitor *
5387 GFileMonitorFlags flags,
5390 {
5402 {
5404 G_IO_ERROR_NOT_SUPPORTED,
5407 }
5410 }
5412 /**
5413 * g_file_monitor_file:
5414 * @file: input #GFile
5415 * @flags: a set of #GFileMonitorFlags
5416 * @cancellable: (nullable): optional #GCancellable object,
5417 * %NULL to ignore
5418 * @error: a #GError, or %NULL
5419 *
5420 * Obtains a file monitor for the given file. If no file notification
5421 * mechanism exists, then regular polling of the file is used.
5422 *
5423 * If @cancellable is not %NULL, then the operation can be cancelled by
5424 * triggering the cancellable object from another thread. If the operation
5425 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5426 *
5427 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5428 * will also attempt to report changes made to the file via another
5429 * filename (ie, a hard link). Without this flag, you can only rely on
5430 * changes made through the filename contained in @file to be
5431 * reported. Using this flag may result in an increase in resource
5432 * usage, and may not have any effect depending on the #GFileMonitor
5433 * backend and/or filesystem type.
5434 *
5435 * Returns: (transfer full): a #GFileMonitor for the given @file,
5436 * or %NULL on error.
5437 * Free the returned object with g_object_unref().
5438 */
5439 GFileMonitor *
5441 GFileMonitorFlags flags,
5444 {
5460 /* Fallback to polling */
5465 }
5467 /**
5468 * g_file_monitor:
5469 * @file: input #GFile
5470 * @flags: a set of #GFileMonitorFlags
5471 * @cancellable: (nullable): optional #GCancellable object,
5472 * %NULL to ignore
5473 * @error: a #GError, or %NULL
5474 *
5475 * Obtains a file or directory monitor for the given file,
5476 * depending on the type of the file.
5477 *
5478 * If @cancellable is not %NULL, then the operation can be cancelled by
5479 * triggering the cancellable object from another thread. If the operation
5480 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5481 *
5482 * Returns: (transfer full): a #GFileMonitor for the given @file,
5483 * or %NULL on error.
5484 * Free the returned object with g_object_unref().
5485 *
5486 * Since: 2.18
5487 */
5488 GFileMonitor *
5490 GFileMonitorFlags flags,
5493 {
5498 else
5500 }
5502 /********************************************
5503 * Default implementation of async ops *
5504 ********************************************/
5508 GFileQueryInfoFlags flags;
5511 static void
5513 {
5516 }
5518 static void
5520 gpointer object,
5521 gpointer task_data,
5523 {
5528 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5531 else
5533 }
5535 static void
5538 GFileQueryInfoFlags flags,
5541 GAsyncReadyCallback callback,
5542 gpointer user_data)
5543 {
5557 }
5563 {
5567 }
5569 static void
5571 gpointer object,
5572 gpointer task_data,
5574 {
5582 else
5584 }
5586 static void
5591 GAsyncReadyCallback callback,
5592 gpointer user_data)
5593 {
5602 }
5608 {
5612 }
5614 static void
5616 gpointer object,
5617 gpointer task_data,
5619 {
5624 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5627 else
5629 }
5631 static void
5634 GFileQueryInfoFlags flags,
5637 GAsyncReadyCallback callback,
5638 gpointer user_data)
5639 {
5653 }
5659 {
5663 }
5665 static void
5667 gpointer object,
5668 gpointer task_data,
5670 {
5677 else
5679 }
5681 static void
5685 GAsyncReadyCallback callback,
5686 gpointer user_data)
5687 {
5695 }
5701 {
5705 }
5707 static void
5709 gpointer source_object,
5710 gpointer task_data,
5712 {
5720 else
5722 }
5724 static void
5726 GFileCreateFlags flags,
5729 GAsyncReadyCallback callback,
5730 gpointer user_data)
5731 {
5745 }
5751 {
5755 }
5757 static void
5759 gpointer source_object,
5760 gpointer task_data,
5762 {
5770 else
5772 }
5774 static void
5776 GFileCreateFlags flags,
5779 GAsyncReadyCallback callback,
5780 gpointer user_data)
5781 {
5795 }
5801 {
5805 }
5810 gboolean make_backup;
5811 GFileCreateFlags flags;
5814 static void
5816 {
5821 }
5823 static void
5825 gpointer source_object,
5826 gpointer task_data,
5828 {
5837 cancellable,
5842 else
5844 }
5846 static void
5849 gboolean make_backup,
5850 GFileCreateFlags flags,
5853 GAsyncReadyCallback callback,
5854 gpointer user_data)
5855 {
5871 }
5877 {
5881 }
5883 static void
5885 gpointer object,
5886 gpointer task_data,
5888 {
5893 else
5895 }
5897 static void
5901 GAsyncReadyCallback callback,
5902 gpointer user_data)
5903 {
5911 }
5913 static gboolean
5917 {
5921 }
5923 static void
5925 gpointer object,
5926 gpointer task_data,
5928 {
5933 else
5935 }
5937 static void
5941 GAsyncReadyCallback callback,
5942 gpointer user_data)
5943 {
5951 }
5953 static gboolean
5957 {
5961 }
5963 static void
5965 gpointer object,
5966 gpointer task_data,
5968 {
5973 else
5975 }
5977 static void
5981 GAsyncReadyCallback callback,
5982 gpointer user_data)
5983 {
5991 }
5993 static gboolean
5997 {
6001 }
6003 static void
6005 gpointer object,
6006 gpointer task_data,
6008 {
6016 else
6018 }
6020 static void
6024 GAsyncReadyCallback callback,
6025 gpointer user_data)
6026 {
6035 }
6041 {
6045 }
6047 static void
6049 gpointer object,
6050 gpointer task_data,
6052 {
6061 else
6063 }
6065 static void
6067 GFileCreateFlags flags,
6070 GAsyncReadyCallback callback,
6071 gpointer user_data)
6072 {
6086 }
6092 {
6096 }
6100 gboolean make_backup;
6101 GFileCreateFlags flags;
6104 static void
6106 {
6109 }
6111 static void
6113 gpointer object,
6114 gpointer task_data,
6116 {
6125 cancellable,
6130 else
6132 }
6134 static void
6137 gboolean make_backup,
6138 GFileCreateFlags flags,
6141 GAsyncReadyCallback callback,
6142 gpointer user_data)
6143 {
6159 }
6165 {
6169 }
6171 static void
6173 gpointer object,
6174 gpointer task_data,
6176 {
6185 else
6187 }
6189 static void
6194 GAsyncReadyCallback callback,
6195 gpointer user_data)
6196 {
6206 }
6212 {
6216 }
6219 GFileQueryInfoFlags flags;
6221 gboolean res;
6225 static void
6227 {
6233 }
6235 static void
6237 gpointer object,
6238 gpointer task_data,
6240 {
6247 cancellable,
6249 }
6251 static void
6254 GFileQueryInfoFlags flags,
6257 GAsyncReadyCallback callback,
6258 gpointer user_data)
6259 {
6274 }
6276 static gboolean
6281 {
6295 }
6297 static void
6299 gpointer object,
6300 gpointer task_data,
6302 {
6310 else
6312 }
6314 static void
6318 GAsyncReadyCallback callback,
6319 gpointer user_data)
6320 {
6329 }
6335 {
6339 }
6345 GFileCopyFlags flags;
6346 GFileProgressCallback progress_cb;
6347 gpointer progress_cb_data;
6350 static void
6352 {
6356 }
6360 goffset current_num_bytes;
6361 goffset total_num_bytes;
6364 static gboolean
6366 {
6375 }
6377 static void
6379 goffset total_num_bytes,
6380 gpointer user_data)
6381 {
6393 copy_async_progress_in_main,
6394 progress,
6395 g_free);
6396 }
6398 static void
6400 gpointer source,
6401 gpointer task_data,
6403 {
6405 gboolean result;
6411 cancellable,
6413 task,
6417 else
6419 }
6421 static void
6424 GFileCopyFlags flags,
6427 GFileProgressCallback progress_callback,
6428 gpointer progress_callback_data,
6429 GAsyncReadyCallback callback,
6430 gpointer user_data)
6431 {
6448 }
6450 static gboolean
6454 {
6458 }
6461 /********************************************
6462 * Default VFS operations *
6463 ********************************************/
6465 /**
6466 * g_file_new_for_path:
6467 * @path: (type filename): a string containing a relative or absolute path.
6468 * The string must be encoded in the glib filename encoding.
6469 *
6470 * Constructs a #GFile for a given path. This operation never
6471 * fails, but the returned object might not support any I/O
6472 * operation if @path is malformed.
6473 *
6474 * Returns: (transfer full): a new #GFile for the given @path.
6475 * Free the returned object with g_object_unref().
6476 */
6477 GFile *
6479 {
6483 }
6485 /**
6486 * g_file_new_for_uri:
6487 * @uri: a UTF-8 string containing a URI
6488 *
6489 * Constructs a #GFile for a given URI. This operation never
6490 * fails, but the returned object might not support any I/O
6491 * operation if @uri is malformed or if the uri type is
6492 * not supported.
6493 *
6494 * Returns: (transfer full): a new #GFile for the given @uri.
6495 * Free the returned object with g_object_unref().
6496 */
6497 GFile *
6499 {
6503 }
6505 /**
6506 * g_file_new_tmp:
6507 * @tmpl: (type filename) (nullable): Template for the file
6508 * name, as in g_file_open_tmp(), or %NULL for a default template
6509 * @iostream: (out): on return, a #GFileIOStream for the created file
6510 * @error: a #GError, or %NULL
6511 *
6512 * Opens a file in the preferred directory for temporary files (as
6513 * returned by g_get_tmp_dir()) and returns a #GFile and
6514 * #GFileIOStream pointing to it.
6515 *
6516 * @tmpl should be a string in the GLib file name encoding
6517 * containing a sequence of six 'X' characters, and containing no
6518 * directory components. If it is %NULL, a default template is used.
6519 *
6520 * Unlike the other #GFile constructors, this will return %NULL if
6521 * a temporary file could not be created.
6522 *
6523 * Returns: (transfer full): a new #GFile.
6524 * Free the returned object with g_object_unref().
6525 *
6526 * Since: 2.32
6527 */
6528 GFile *
6532 {
6533 gint fd;
6553 }
6555 /**
6556 * g_file_parse_name:
6557 * @parse_name: a file name or path to be parsed
6558 *
6559 * Constructs a #GFile with the given @parse_name (i.e. something
6560 * given by g_file_get_parse_name()). This operation never fails,
6561 * but the returned object might not support any I/O operation if
6562 * the @parse_name cannot be parsed.
6563 *
6564 * Returns: (transfer full): a new #GFile.
6565 */
6566 GFile *
6568 {
6572 }
6574 /**
6575 * g_file_new_build_filename:
6576 * @first_element: (type filename): the first element in the path
6577 * @...: remaining elements in path, terminated by %NULL
6578 *
6579 * Constructs a #GFile from a series of elements using the correct
6580 * separator for filenames.
6581 *
6582 * Using this function is equivalent to calling g_build_filename(),
6583 * followed by g_file_new_for_path() on the result.
6584 *
6585 * Returns: (transfer full): a new #GFile
6586 *
6587 * Since: 2.56
6588 */
6589 GFile *
6591 ...)
6592 {
6607 }
6609 static gboolean
6611 {
6613 }
6615 /* Following RFC 2396, valid schemes are built like:
6616 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6617 */
6618 static gboolean
6620 {
6629 p++;
6633 }
6638 {
6649 {
6655 }
6656 else
6663 }
6665 /**
6666 * g_file_new_for_commandline_arg:
6667 * @arg: (type filename): a command line string
6668 *
6669 * Creates a #GFile with the given argument from the command line.
6670 * The value of @arg can be either a URI, an absolute path or a
6671 * relative path resolved relative to the current working directory.
6672 * This operation never fails, but the returned object might not
6673 * support any I/O operation if @arg points to a malformed path.
6674 *
6675 * Note that on Windows, this function expects its argument to be in
6676 * UTF-8 -- not the system code page. This means that you
6677 * should not use this function with string from argv as it is passed
6678 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6679 * the commandline. #GApplication also uses UTF-8 but
6680 * g_application_command_line_create_file_for_arg() may be more useful
6681 * for you there. It is also always possible to use this function with
6682 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6683 *
6684 * Returns: (transfer full): a new #GFile.
6685 * Free the returned object with g_object_unref().
6686 */
6687 GFile *
6689 {
6693 }
6695 /**
6696 * g_file_new_for_commandline_arg_and_cwd:
6697 * @arg: (type filename): a command line string
6698 * @cwd: (type filename): the current working directory of the commandline
6699 *
6700 * Creates a #GFile with the given argument from the command line.
6701 *
6702 * This function is similar to g_file_new_for_commandline_arg() except
6703 * that it allows for passing the current working directory as an
6704 * argument instead of using the current working directory of the
6705 * process.
6706 *
6707 * This is useful if the commandline argument was given in a context
6708 * other than the invocation of the current process.
6709 *
6710 * See also g_application_command_line_create_file_for_arg().
6711 *
6712 * Returns: (transfer full): a new #GFile
6713 *
6714 * Since: 2.36
6715 **/
6716 GFile *
6719 {
6724 }
6726 /**
6727 * g_file_mount_enclosing_volume:
6728 * @location: input #GFile
6729 * @flags: flags affecting the operation
6730 * @mount_operation: (nullable): a #GMountOperation
6731 * or %NULL to avoid user interaction
6732 * @cancellable: (nullable): optional #GCancellable object,
6733 * %NULL to ignore
6734 * @callback: (nullable): a #GAsyncReadyCallback to call
6735 * when the request is satisfied, or %NULL
6736 * @user_data: the data to pass to callback function
6737 *
6738 * Starts a @mount_operation, mounting the volume that contains
6739 * the file @location.
6740 *
6741 * When this operation has completed, @callback will be called with
6742 * @user_user data, and the operation can be finalized with
6743 * g_file_mount_enclosing_volume_finish().
6744 *
6745 * If @cancellable is not %NULL, then the operation can be cancelled by
6746 * triggering the cancellable object from another thread. If the operation
6747 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6748 */
6749 void
6751 GMountMountFlags flags,
6754 GAsyncReadyCallback callback,
6755 gpointer user_data)
6756 {
6764 {
6766 g_file_mount_enclosing_volume,
6770 }
6772 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6774 }
6776 /**
6777 * g_file_mount_enclosing_volume_finish:
6778 * @location: input #GFile
6779 * @result: a #GAsyncResult
6780 * @error: a #GError, or %NULL
6781 *
6782 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6783 *
6784 * Returns: %TRUE if successful. If an error has occurred,
6785 * this function will return %FALSE and set @error
6786 * appropriately if present.
6787 */
6788 gboolean
6792 {
6806 }
6808 /********************************************
6809 * Utility functions *
6810 ********************************************/
6812 /**
6813 * g_file_query_default_handler:
6814 * @file: a #GFile to open
6815 * @cancellable: optional #GCancellable object, %NULL to ignore
6816 * @error: a #GError, or %NULL
6817 *
6818 * Returns the #GAppInfo that is registered as the default
6819 * application to handle the file specified by @file.
6820 *
6821 * If @cancellable is not %NULL, then the operation can be cancelled by
6822 * triggering the cancellable object from another thread. If the operation
6823 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6824 *
6825 * Returns: (transfer full): a #GAppInfo if the handle was found,
6826 * %NULL if there were errors.
6827 * When you are done with it, release it with g_object_unref()
6828 */
6829 GAppInfo *
6833 {
6842 {
6848 }
6851 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6853 cancellable,
6854 error);
6862 {
6863 /* Don't use is_native(), as we want to support fuse paths if available */
6868 }
6876 G_IO_ERROR_NOT_SUPPORTED,
6879 }
6881 #define GET_CONTENT_BLOCK_SIZE 8192
6883 /**
6884 * g_file_load_contents:
6885 * @file: input #GFile
6886 * @cancellable: optional #GCancellable object, %NULL to ignore
6887 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6888 * @length: (out) (optional): a location to place the length of the contents of the file,
6889 * or %NULL if the length is not needed
6890 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
6891 * or %NULL if the entity tag is not needed
6892 * @error: a #GError, or %NULL
6893 *
6894 * Loads the content of the file into memory. The data is always
6895 * zero-terminated, but this is not included in the resultant @length.
6896 * The returned @content should be freed with g_free() when no longer
6897 * needed.
6898 *
6899 * If @cancellable is not %NULL, then the operation can be cancelled by
6900 * triggering the cancellable object from another thread. If the operation
6901 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6902 *
6903 * Returns: %TRUE if the @file's contents were successfully loaded.
6904 * %FALSE if there were errors.
6905 */
6906 gboolean
6913 {
6916 gsize pos;
6917 gssize res;
6933 GET_CONTENT_BLOCK_SIZE,
6935 {
6938 }
6941 {
6945 G_FILE_ATTRIBUTE_ETAG_VALUE,
6946 cancellable,
6947 NULL);
6949 {
6952 }
6953 }
6955 /* Ignore errors on close */
6960 {
6961 /* error is set already */
6964 }
6969 /* Zero terminate (we got an extra byte allocated for this */
6975 }
6979 GFileReadMoreCallback read_more_callback;
6981 gsize pos;
6986 static void
6988 {
6993 }
6995 static void
6998 gpointer user_data)
6999 {
7003 /* Ignore errors here, we're only reading anyway */
7009 }
7011 static void
7014 gpointer user_data)
7015 {
7023 {
7026 }
7031 }
7033 static void
7036 gpointer user_data)
7037 {
7041 gssize read_size;
7046 {
7050 /* Close the file ignoring any error */
7053 }
7055 {
7057 G_FILE_ATTRIBUTE_ETAG_VALUE,
7060 load_contents_fstat_callback,
7061 data);
7062 }
7064 {
7075 G_FILE_ATTRIBUTE_ETAG_VALUE,
7078 load_contents_fstat_callback,
7079 data);
7080 else
7083 GET_CONTENT_BLOCK_SIZE,
7086 load_contents_read_callback,
7087 data);
7088 }
7089 }
7091 static void
7094 gpointer user_data)
7095 {
7104 {
7109 GET_CONTENT_BLOCK_SIZE,
7112 load_contents_read_callback,
7113 data);
7114 }
7115 else
7116 {
7119 }
7120 }
7122 /**
7123 * g_file_load_partial_contents_async: (skip)
7124 * @file: input #GFile
7125 * @cancellable: optional #GCancellable object, %NULL to ignore
7126 * @read_more_callback: (scope call) (closure user_data): a
7127 * #GFileReadMoreCallback to receive partial data
7128 * and to specify whether further data should be read
7129 * @callback: (scope async) (closure user_data): a #GAsyncReadyCallback to call
7130 * when the request is satisfied
7131 * @user_data: the data to pass to the callback functions
7132 *
7133 * Reads the partial contents of a file. A #GFileReadMoreCallback should
7134 * be used to stop reading from the file when appropriate, else this
7135 * function will behave exactly as g_file_load_contents_async(). This
7136 * operation can be finished by g_file_load_partial_contents_finish().
7137 *
7138 * Users of this function should be aware that @user_data is passed to
7139 * both the @read_more_callback and the @callback.
7140 *
7141 * If @cancellable is not %NULL, then the operation can be cancelled by
7142 * triggering the cancellable object from another thread. If the operation
7143 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7144 */
7145 void
7148 GFileReadMoreCallback read_more_callback,
7149 GAsyncReadyCallback callback,
7150 gpointer user_data)
7151 {
7167 load_contents_open_callback,
7168 data);
7169 }
7171 /**
7172 * g_file_load_partial_contents_finish:
7173 * @file: input #GFile
7174 * @res: a #GAsyncResult
7175 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7176 * @length: (out) (optional): a location to place the length of the contents of the file,
7177 * or %NULL if the length is not needed
7178 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7179 * or %NULL if the entity tag is not needed
7180 * @error: a #GError, or %NULL
7181 *
7182 * Finishes an asynchronous partial load operation that was started
7183 * with g_file_load_partial_contents_async(). The data is always
7184 * zero-terminated, but this is not included in the resultant @length.
7185 * The returned @content should be freed with g_free() when no longer
7186 * needed.
7187 *
7188 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7189 * present, it will be set appropriately.
7190 */
7191 gboolean
7198 {
7209 {
7213 }
7221 {
7224 }
7226 /* Zero terminate */
7234 }
7236 /**
7237 * g_file_load_contents_async:
7238 * @file: input #GFile
7239 * @cancellable: optional #GCancellable object, %NULL to ignore
7240 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7241 * @user_data: the data to pass to callback function
7242 *
7243 * Starts an asynchronous load of the @file's contents.
7244 *
7245 * For more details, see g_file_load_contents() which is
7246 * the synchronous version of this call.
7247 *
7248 * When the load operation has completed, @callback will be called
7249 * with @user data. To finish the operation, call
7250 * g_file_load_contents_finish() with the #GAsyncResult returned by
7251 * the @callback.
7252 *
7253 * If @cancellable is not %NULL, then the operation can be cancelled by
7254 * triggering the cancellable object from another thread. If the operation
7255 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7256 */
7257 void
7260 GAsyncReadyCallback callback,
7261 gpointer user_data)
7262 {
7264 cancellable,
7265 NULL,
7267 }
7269 /**
7270 * g_file_load_contents_finish:
7271 * @file: input #GFile
7272 * @res: a #GAsyncResult
7273 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7274 * @length: (out) (optional): a location to place the length of the contents of the file,
7275 * or %NULL if the length is not needed
7276 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7277 * or %NULL if the entity tag is not needed
7278 * @error: a #GError, or %NULL
7279 *
7280 * Finishes an asynchronous load of the @file's contents.
7281 * The contents are placed in @contents, and @length is set to the
7282 * size of the @contents string. The @content should be freed with
7283 * g_free() when no longer needed. If @etag_out is present, it will be
7284 * set to the new entity tag for the @file.
7285 *
7286 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7287 * present, it will be set appropriately.
7288 */
7289 gboolean
7296 {
7298 res,
7299 contents,
7300 length,
7301 etag_out,
7302 error);
7303 }
7305 /**
7306 * g_file_replace_contents:
7307 * @file: input #GFile
7308 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7309 * @length: the length of @contents in bytes
7310 * @etag: (nullable): the old [entity-tag][gfile-etag] for the document,
7311 * or %NULL
7312 * @make_backup: %TRUE if a backup should be created
7313 * @flags: a set of #GFileCreateFlags
7314 * @new_etag: (out) (optional): a location to a new [entity tag][gfile-etag]
7315 * for the document. This should be freed with g_free() when no longer
7316 * needed, or %NULL
7317 * @cancellable: optional #GCancellable object, %NULL to ignore
7318 * @error: a #GError, or %NULL
7319 *
7320 * Replaces the contents of @file with @contents of @length bytes.
7321 *
7322 * If @etag is specified (not %NULL), any existing file must have that etag,
7323 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7324 *
7325 * If @make_backup is %TRUE, this function will attempt to make a backup
7326 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7327 * file contents in the safest way possible. For example, atomic renames are
7328 * used when replacing local files’ contents.
7329 *
7330 * If @cancellable is not %NULL, then the operation can be cancelled by
7331 * triggering the cancellable object from another thread. If the operation
7332 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7333 *
7334 * The returned @new_etag can be used to verify that the file hasn't
7335 * changed the next time it is saved over.
7336 *
7337 * Returns: %TRUE if successful. If an error has occurred, this function
7338 * will return %FALSE and set @error appropriately if present.
7339 */
7340 gboolean
7343 gsize length,
7345 gboolean make_backup,
7346 GFileCreateFlags flags,
7350 {
7353 gssize res;
7354 gboolean ret;
7369 cancellable,
7371 {
7374 }
7377 {
7378 /* Ignore errors on close */
7382 /* error is set already */
7384 }
7394 }
7399 gsize pos;
7401 gboolean failed;
7404 static void
7406 {
7410 }
7412 static void
7415 gpointer user_data)
7416 {
7420 /* Ignore errors here, we're only reading anyway */
7425 {
7428 }
7430 }
7432 static void
7435 gpointer user_data)
7436 {
7440 gssize write_size;
7445 {
7446 /* Error or EOF, close the file */
7448 {
7451 }
7455 }
7457 {
7459 gsize length;
7468 else
7474 replace_contents_write_callback,
7475 data);
7476 }
7477 }
7479 static void
7482 gpointer user_data)
7483 {
7492 {
7494 gsize length;
7502 replace_contents_write_callback,
7503 data);
7504 }
7505 else
7506 {
7509 }
7510 }
7512 /**
7513 * g_file_replace_contents_async:
7514 * @file: input #GFile
7515 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7516 * @length: the length of @contents in bytes
7517 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7518 * @make_backup: %TRUE if a backup should be created
7519 * @flags: a set of #GFileCreateFlags
7520 * @cancellable: optional #GCancellable object, %NULL to ignore
7521 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7522 * @user_data: the data to pass to callback function
7523 *
7524 * Starts an asynchronous replacement of @file with the given
7525 * @contents of @length bytes. @etag will replace the document's
7526 * current entity tag.
7527 *
7528 * When this operation has completed, @callback will be called with
7529 * @user_user data, and the operation can be finalized with
7530 * g_file_replace_contents_finish().
7531 *
7532 * If @cancellable is not %NULL, then the operation can be cancelled by
7533 * triggering the cancellable object from another thread. If the operation
7534 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7535 *
7536 * If @make_backup is %TRUE, this function will attempt to
7537 * make a backup of @file.
7538 *
7539 * Note that no copy of @content will be made, so it must stay valid
7540 * until @callback is called. See g_file_replace_contents_bytes_async()
7541 * for a #GBytes version that will automatically hold a reference to the
7542 * contents (without copying) for the duration of the call.
7543 */
7544 void
7547 gsize length,
7549 gboolean make_backup,
7550 GFileCreateFlags flags,
7552 GAsyncReadyCallback callback,
7553 gpointer user_data)
7554 {
7561 }
7563 /**
7564 * g_file_replace_contents_bytes_async:
7565 * @file: input #GFile
7566 * @contents: a #GBytes
7567 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7568 * @make_backup: %TRUE if a backup should be created
7569 * @flags: a set of #GFileCreateFlags
7570 * @cancellable: optional #GCancellable object, %NULL to ignore
7571 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7572 * @user_data: the data to pass to callback function
7573 *
7574 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7575 * This function will keep a ref on @contents until the operation is done.
7576 * Unlike g_file_replace_contents_async() this allows forgetting about the
7577 * content without waiting for the callback.
7578 *
7579 * When this operation has completed, @callback will be called with
7580 * @user_user data, and the operation can be finalized with
7581 * g_file_replace_contents_finish().
7582 *
7583 * Since: 2.40
7584 */
7585 void
7589 gboolean make_backup,
7590 GFileCreateFlags flags,
7592 GAsyncReadyCallback callback,
7593 gpointer user_data)
7594 {
7609 etag,
7610 make_backup,
7611 flags,
7614 replace_contents_open_callback,
7615 data);
7616 }
7618 /**
7619 * g_file_replace_contents_finish:
7620 * @file: input #GFile
7621 * @res: a #GAsyncResult
7622 * @new_etag: (out) (optional): a location of a new [entity tag][gfile-etag]
7623 * for the document. This should be freed with g_free() when it is no
7624 * longer needed, or %NULL
7625 * @error: a #GError, or %NULL
7626 *
7627 * Finishes an asynchronous replace of the given @file. See
7628 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7629 * tag for the document, if present.
7630 *
7631 * Returns: %TRUE on success, %FALSE on failure.
7632 */
7633 gboolean
7638 {
7653 {
7656 }
7659 }
7661 gboolean
7663 GFileMeasureFlags flags,
7665 GFileMeasureProgressCallback progress_callback,
7666 gpointer progress_data,
7671 {
7675 }
7678 {
7679 GFileMeasureFlags flags;
7680 GFileMeasureProgressCallback progress_callback;
7681 gpointer progress_data;
7685 {
7686 guint64 disk_usage;
7687 guint64 num_dirs;
7688 guint64 num_files;
7692 {
7693 GFileMeasureProgressCallback callback;
7694 gpointer user_data;
7695 gboolean reporting;
7696 guint64 current_size;
7697 guint64 num_dirs;
7698 guint64 num_files;
7701 static gboolean
7703 {
7711 }
7713 static void
7715 guint64 current_size,
7716 guint64 num_dirs,
7717 guint64 num_files,
7718 gpointer user_data)
7719 {
7720 MeasureProgress progress;
7735 measure_disk_usage_invoke_progress,
7737 g_free);
7738 }
7740 static void
7742 gpointer source_object,
7743 gpointer task_data,
7745 {
7755 else
7757 }
7759 static void
7761 GFileMeasureFlags flags,
7762 gint io_priority,
7764 GFileMeasureProgressCallback progress_callback,
7765 gpointer progress_data,
7766 GAsyncReadyCallback callback,
7767 gpointer user_data)
7768 {
7769 MeasureTaskData data;
7783 }
7785 static gboolean
7792 {
7814 }
7816 /**
7817 * g_file_measure_disk_usage:
7818 * @file: a #GFile
7819 * @flags: #GFileMeasureFlags
7820 * @cancellable: (nullable): optional #GCancellable
7821 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7822 * @progress_data: user_data for @progress_callback
7823 * @disk_usage: (out) (optional): the number of bytes of disk space used
7824 * @num_dirs: (out) (optional): the number of directories encountered
7825 * @num_files: (out) (optional): the number of non-directories encountered
7826 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7827 *
7828 * Recursively measures the disk usage of @file.
7829 *
7830 * This is essentially an analog of the 'du' command, but it also
7831 * reports the number of directories and non-directory files encountered
7832 * (including things like symbolic links).
7833 *
7834 * By default, errors are only reported against the toplevel file
7835 * itself. Errors found while recursing are silently ignored, unless
7836 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7837 *
7838 * The returned size, @disk_usage, is in bytes and should be formatted
7839 * with g_format_size() in order to get something reasonable for showing
7840 * in a user interface.
7841 *
7842 * @progress_callback and @progress_data can be given to request
7843 * periodic progress updates while scanning. See the documentation for
7844 * #GFileMeasureProgressCallback for information about when and how the
7845 * callback will be invoked.
7846 *
7847 * Returns: %TRUE if successful, with the out parameters set.
7848 * %FALSE otherwise, with @error set.
7849 *
7850 * Since: 2.38
7851 **/
7852 gboolean
7854 GFileMeasureFlags flags,
7856 GFileMeasureProgressCallback progress_callback,
7857 gpointer progress_data,
7862 {
7870 error);
7871 }
7873 /**
7874 * g_file_measure_disk_usage_async:
7875 * @file: a #GFile
7876 * @flags: #GFileMeasureFlags
7877 * @io_priority: the [I/O priority][io-priority] of the request
7878 * @cancellable: (nullable): optional #GCancellable
7879 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7880 * @progress_data: user_data for @progress_callback
7881 * @callback: (nullable): a #GAsyncReadyCallback to call when complete
7882 * @user_data: the data to pass to callback function
7883 *
7884 * Recursively measures the disk usage of @file.
7885 *
7886 * This is the asynchronous version of g_file_measure_disk_usage(). See
7887 * there for more information.
7888 *
7889 * Since: 2.38
7890 **/
7891 void
7893 GFileMeasureFlags flags,
7894 gint io_priority,
7896 GFileMeasureProgressCallback progress_callback,
7897 gpointer progress_data,
7898 GAsyncReadyCallback callback,
7899 gpointer user_data)
7900 {
7907 }
7909 /**
7910 * g_file_measure_disk_usage_finish:
7911 * @file: a #GFile
7912 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7913 * @disk_usage: (out) (optional): the number of bytes of disk space used
7914 * @num_dirs: (out) (optional): the number of directories encountered
7915 * @num_files: (out) (optional): the number of non-directories encountered
7916 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7917 *
7918 * Collects the results from an earlier call to
7919 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7920 * more information.
7921 *
7922 * Returns: %TRUE if successful, with the out parameters set.
7923 * %FALSE otherwise, with @error set.
7924 *
7925 * Since: 2.38
7926 **/
7927 gboolean
7934 {
7938 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7939 }
7941 /**
7942 * g_file_start_mountable:
7943 * @file: input #GFile
7944 * @flags: flags affecting the operation
7945 * @start_operation: (nullable): a #GMountOperation, or %NULL to avoid user interaction
7946 * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
7947 * @callback: (nullable): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7948 * @user_data: the data to pass to callback function
7949 *
7950 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7951 * Using @start_operation, you can request callbacks when, for instance,
7952 * passwords are needed during authentication.
7953 *
7954 * If @cancellable is not %NULL, then the operation can be cancelled by
7955 * triggering the cancellable object from another thread. If the operation
7956 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7957 *
7958 * When the operation is finished, @callback will be called.
7959 * You can then call g_file_mount_mountable_finish() to get
7960 * the result of the operation.
7961 *
7962 * Since: 2.22
7963 */
7964 void
7966 GDriveStartFlags flags,
7969 GAsyncReadyCallback callback,
7970 gpointer user_data)
7971 {
7979 {
7981 g_file_start_mountable,
7985 }
7988 flags,
7989 start_operation,
7990 cancellable,
7991 callback,
7992 user_data);
7993 }
7995 /**
7996 * g_file_start_mountable_finish:
7997 * @file: input #GFile
7998 * @result: a #GAsyncResult
7999 * @error: a #GError, or %NULL
8000 *
8001 * Finishes a start operation. See g_file_start_mountable() for details.
8002 *
8003 * Finish an asynchronous start operation that was started
8004 * with g_file_start_mountable().
8005 *
8006 * Returns: %TRUE if the operation finished successfully. %FALSE
8007 * otherwise.
8008 *
8009 * Since: 2.22
8010 */
8011 gboolean
8015 {
8028 }
8030 /**
8031 * g_file_stop_mountable:
8032 * @file: input #GFile
8033 * @flags: flags affecting the operation
8034 * @mount_operation: (nullable): a #GMountOperation,
8035 * or %NULL to avoid user interaction.
8036 * @cancellable: (nullable): optional #GCancellable object,
8037 * %NULL to ignore
8038 * @callback: (nullable): a #GAsyncReadyCallback to call
8039 * when the request is satisfied, or %NULL
8040 * @user_data: the data to pass to callback function
8041 *
8042 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
8043 *
8044 * If @cancellable is not %NULL, then the operation can be cancelled by
8045 * triggering the cancellable object from another thread. If the operation
8046 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8047 *
8048 * When the operation is finished, @callback will be called.
8049 * You can then call g_file_stop_mountable_finish() to get
8050 * the result of the operation.
8051 *
8052 * Since: 2.22
8053 */
8054 void
8056 GMountUnmountFlags flags,
8059 GAsyncReadyCallback callback,
8060 gpointer user_data)
8061 {
8069 {
8071 g_file_stop_mountable,
8075 }
8078 flags,
8079 mount_operation,
8080 cancellable,
8081 callback,
8082 user_data);
8083 }
8085 /**
8086 * g_file_stop_mountable_finish:
8087 * @file: input #GFile
8088 * @result: a #GAsyncResult
8089 * @error: a #GError, or %NULL
8090 *
8091 * Finishes an stop operation, see g_file_stop_mountable() for details.
8092 *
8093 * Finish an asynchronous stop operation that was started
8094 * with g_file_stop_mountable().
8095 *
8096 * Returns: %TRUE if the operation finished successfully.
8097 * %FALSE otherwise.
8098 *
8099 * Since: 2.22
8100 */
8101 gboolean
8105 {
8118 }
8120 /**
8121 * g_file_poll_mountable:
8122 * @file: input #GFile
8123 * @cancellable: optional #GCancellable object, %NULL to ignore
8124 * @callback: (nullable): a #GAsyncReadyCallback to call
8125 * when the request is satisfied, or %NULL
8126 * @user_data: the data to pass to callback function
8127 *
8128 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
8129 *
8130 * If @cancellable is not %NULL, then the operation can be cancelled by
8131 * triggering the cancellable object from another thread. If the operation
8132 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8133 *
8134 * When the operation is finished, @callback will be called.
8135 * You can then call g_file_mount_mountable_finish() to get
8136 * the result of the operation.
8137 *
8138 * Since: 2.22
8139 */
8140 void
8143 GAsyncReadyCallback callback,
8144 gpointer user_data)
8145 {
8153 {
8155 g_file_poll_mountable,
8159 }
8162 cancellable,
8163 callback,
8164 user_data);
8165 }
8167 /**
8168 * g_file_poll_mountable_finish:
8169 * @file: input #GFile
8170 * @result: a #GAsyncResult
8171 * @error: a #GError, or %NULL
8172 *
8173 * Finishes a poll operation. See g_file_poll_mountable() for details.
8174 *
8175 * Finish an asynchronous poll operation that was polled
8176 * with g_file_poll_mountable().
8177 *
8178 * Returns: %TRUE if the operation finished successfully. %FALSE
8179 * otherwise.
8180 *
8181 * Since: 2.22
8182 */
8183 gboolean
8187 {
8200 }
8202 /**
8203 * g_file_supports_thread_contexts:
8204 * @file: a #GFile
8205 *
8206 * Checks if @file supports
8207 * [thread-default contexts][g-main-context-push-thread-default-context].
8208 * If this returns %FALSE, you cannot perform asynchronous operations on
8209 * @file in a thread that has a thread-default context.
8210 *
8211 * Returns: Whether or not @file supports thread-default contexts.
8212 *
8213 * Since: 2.22
8214 */
8215 gboolean
8217 {
8224 }
8226 /**
8227 * g_file_load_bytes:
8228 * @file: a #GFile
8229 * @cancellable: (nullable): a #GCancellable or %NULL
8230 * @etag_out: (out) (nullable) (optional): a location to place the current
8231 * entity tag for the file, or %NULL if the entity tag is not needed
8232 * @error: a location for a #GError or %NULL
8233 *
8234 * Loads the contents of @file and returns it as #GBytes.
8235 *
8236 * If @file is a resource:// based URI, the resulting bytes will reference the
8237 * embedded resource instead of a copy. Otherwise, this is equivalent to calling
8238 * g_file_load_contents() and g_bytes_new_take().
8239 *
8240 * For resources, @etag_out will be set to %NULL.
8241 *
8242 * The data contained in the resulting #GBytes is always zero-terminated, but
8243 * this is not included in the #GBytes length. The resulting #GBytes should be
8244 * freed with g_bytes_unref() when no longer in use.
8245 *
8246 * Returns: (transfer full): a #GBytes or %NULL and @error is set
8247 *
8248 * Since: 2.56
8249 */
8250 GBytes *
8255 {
8257 gsize len;
8267 {
8279 }
8281 /* contents is guaranteed to be \0 terminated */
8286 }
8288 static void
8291 gpointer user_data)
8292 {
8305 else
8311 }
8313 /**
8314 * g_file_load_bytes_async:
8315 * @file: a #GFile
8316 * @cancellable: (nullable): a #GCancellable or %NULL
8317 * @callback: (scope async): a #GAsyncReadyCallback to call when the
8318 * request is satisfied
8319 * @user_data: (closure): the data to pass to callback function
8320 *
8321 * Asynchronously loads the contents of @file as #GBytes.
8322 *
8323 * If @file is a resource:// based URI, the resulting bytes will reference the
8324 * embedded resource instead of a copy. Otherwise, this is equivalent to calling
8325 * g_file_load_contents_async() and g_bytes_new_take().
8326 *
8327 * @callback should call g_file_load_bytes_finish() to get the result of this
8328 * asynchronous operation.
8329 *
8330 * See g_file_load_bytes() for more information.
8331 *
8332 * Since: 2.56
8333 */
8334 void
8337 GAsyncReadyCallback callback,
8338 gpointer user_data)
8339 {
8351 {
8353 cancellable,
8354 g_file_load_bytes_cb,
8357 }
8363 else
8369 }
8371 /**
8372 * g_file_load_bytes_finish:
8373 * @file: a #GFile
8374 * @result: a #GAsyncResult provided to the callback
8375 * @etag_out: (out) (nullable) (optional): a location to place the current
8376 * entity tag for the file, or %NULL if the entity tag is not needed
8377 * @error: a location for a #GError, or %NULL
8378 *
8379 * Completes an asynchronous request to g_file_load_bytes_async().
8380 *
8381 * For resources, @etag_out will be set to %NULL.
8382 *
8383 * The data contained in the resulting #GBytes is always zero-terminated, but
8384 * this is not included in the #GBytes length. The resulting #GBytes should be
8385 * freed with g_bytes_unref() when no longer in use.
8386 *
8387 * See g_file_load_bytes() for more information.
8388 *
8389 * Returns: (transfer full): a #GBytes or %NULL and @error is set
8390 *
8391 * Since: 2.56
8392 */
8393 GBytes *
8398 {
8412 }