| blob | 334ad8ec3885a4f977b460bb18014e4c25d7bbf3 |
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 s 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 /* Try a 1MiB buffer for improved throughput. If that fails, use the default
3016 * pipe size. See: https://bugzilla.gnome.org/791457 */
3019 {
3025 {
3030 }
3031 }
3036 /* avoid performance impact of querying total size when it's not needed */
3038 {
3043 }
3051 {
3062 {
3065 }
3068 {
3076 }
3080 }
3082 /* Make sure we send full copied size */
3092 out:
3099 }
3100 #endif
3102 #ifdef __linux__
3103 static gboolean
3108 GFileProgressCallback progress_callback,
3109 gpointer progress_callback_data,
3111 {
3112 goffset source_size;
3122 /* Btrfs clone ioctl properties:
3123 * - Works at the inode level
3124 * - Doesn't work with directories
3125 * - Always follows symlinks (source and destination)
3126 *
3127 * By the time we get here, *in and *out are both regular files */
3132 {
3135 G_IO_ERROR_NOT_SUPPORTED,
3139 G_IO_ERROR_NOT_SUPPORTED,
3141 else
3142 /* Most probably something odd happened; retry with fallback */
3144 G_IO_ERROR_NOT_SUPPORTED,
3146 /* We retry with fallback for all error cases because Btrfs is currently
3147 * unstable, and so we can't trust it to do clone properly.
3148 * In addition, any hard errors here would cause the same failure in the
3149 * fallback manual copy as well. */
3151 }
3153 /* Make sure we send full copied size */
3158 }
3159 #endif
3161 static gboolean
3164 GFileCopyFlags flags,
3166 GFileProgressCallback progress_callback,
3167 gpointer progress_callback_data,
3169 {
3179 /* need to know the file type */
3182 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3183 cancellable,
3184 error);
3188 /* Maybe copy the symlink? */
3191 {
3194 {
3200 }
3201 /* ... else fall back on a regular file copy */
3202 }
3203 /* Handle "special" files (pipes, device nodes, ...)? */
3205 {
3206 /* FIXME: could try to recreate device nodes and others? */
3210 }
3212 /* Everything else should just fall back on a regular copy. */
3224 {
3227 /* Ok, ditch the previous lightweight info (on Unix we just
3228 * called lstat()); at this point we gather all the information
3229 * we need about the source from the opened file descriptor.
3230 */
3236 {
3237 /* Not all gvfs backends implement query_info_on_read(), we
3238 * can just fall back to the pathname again.
3239 * https://bugzilla.gnome.org/706254
3240 */
3242 {
3246 }
3247 else
3248 {
3252 }
3253 }
3259 }
3261 /* In the local file path, we pass down the source info which
3262 * includes things like unix::mode, to ensure that the target file
3263 * is not created with different permissions from the source file.
3264 *
3265 * If a future API like g_file_replace_with_info() is added, switch
3266 * this code to use that.
3267 */
3269 {
3271 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3274 G_FILE_CREATE_REPLACE_DESTINATION,
3275 info,
3277 else
3278 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3281 }
3283 {
3285 NULL,
3287 G_FILE_CREATE_REPLACE_DESTINATION,
3289 }
3290 else
3291 {
3293 }
3298 #ifdef __linux__
3300 {
3306 {
3308 {
3310 }
3311 else
3312 {
3315 }
3316 }
3317 else
3318 {
3321 }
3322 }
3323 #endif
3325 #ifdef HAVE_SPLICE
3327 {
3333 {
3335 {
3337 }
3338 else
3339 {
3342 }
3343 }
3344 else
3345 {
3348 }
3349 }
3351 #endif
3353 /* A plain read/write loop */
3356 error))
3360 out:
3362 {
3363 /* Don't care about errors in source here */
3366 }
3369 {
3370 /* But write errors on close are bad! */
3374 }
3376 /* Ignore errors here. Failure to copy metadata is not a hard error */
3377 /* TODO: set these attributes /before/ we do the rename() on Unix */
3379 {
3381 info,
3382 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3383 cancellable,
3384 NULL);
3385 }
3390 }
3392 /**
3393 * g_file_copy:
3394 * @source: input #GFile
3395 * @destination: destination #GFile
3396 * @flags: set of #GFileCopyFlags
3397 * @cancellable: (nullable): optional #GCancellable object,
3398 * %NULL to ignore
3399 * @progress_callback: (nullable) (scope call): function to callback with
3400 * progress information, or %NULL if progress information is not needed
3401 * @progress_callback_data: (closure): user data to pass to @progress_callback
3402 * @error: #GError to set on error, or %NULL
3403 *
3404 * Copies the file @source to the location specified by @destination.
3405 * Can not handle recursive copies of directories.
3406 *
3407 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3408 * existing @destination file is overwritten.
3409 *
3410 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3411 * will be copied as symlinks, otherwise the target of the
3412 * @source symlink will be copied.
3413 *
3414 * If the flag #G_FILE_COPY_ALL_METADATA is specified then all the metadata
3415 * that is possible to copy is copied, not just the default subset (which,
3416 * for instance, does not include the owner, see #GFileInfo).
3417 *
3418 * If @cancellable is not %NULL, then the operation can be cancelled by
3419 * triggering the cancellable object from another thread. If the operation
3420 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3421 *
3422 * If @progress_callback is not %NULL, then the operation can be monitored
3423 * by setting this to a #GFileProgressCallback function.
3424 * @progress_callback_data will be passed to this function. It is guaranteed
3425 * that this callback will be called after all data has been transferred with
3426 * the total number of bytes copied during the operation.
3427 *
3428 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3429 * is returned, independent on the status of the @destination.
3430 *
3431 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3432 * the error %G_IO_ERROR_EXISTS is returned.
3433 *
3434 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3435 * error is returned. If trying to overwrite a directory with a directory the
3436 * %G_IO_ERROR_WOULD_MERGE error is returned.
3437 *
3438 * If the source is a directory and the target does not exist, or
3439 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3440 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3441 *
3442 * If you are interested in copying the #GFile object itself (not the on-disk
3443 * file), see g_file_dup().
3444 *
3445 * Returns: %TRUE on success, %FALSE otherwise.
3446 */
3447 gboolean
3450 GFileCopyFlags flags,
3452 GFileProgressCallback progress_callback,
3453 gpointer progress_callback_data,
3455 {
3458 gboolean res;
3468 {
3479 {
3482 }
3483 else
3485 }
3487 /* If the types are different, and the destination method failed
3488 * also try the source method
3489 */
3491 {
3495 {
3506 {
3509 }
3510 else
3512 }
3513 }
3517 error);
3518 }
3520 /**
3521 * g_file_copy_async:
3522 * @source: input #GFile
3523 * @destination: destination #GFile
3524 * @flags: set of #GFileCopyFlags
3525 * @io_priority: the [I/O priority][io-priority] of the request
3526 * @cancellable: (nullable): optional #GCancellable object,
3527 * %NULL to ignore
3528 * @progress_callback: (nullable) (scope notified): function to callback with progress
3529 * information, or %NULL if progress information is not needed
3530 * @progress_callback_data: (closure progress_callback) (nullable): user data to pass to @progress_callback
3531 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3532 * @user_data: (closure callback): the data to pass to callback function
3533 *
3534 * Copies the file @source to the location specified by @destination
3535 * asynchronously. For details of the behaviour, see g_file_copy().
3536 *
3537 * If @progress_callback is not %NULL, then that function that will be called
3538 * just like in g_file_copy(). The callback will run in the default main context
3539 * of the thread calling g_file_copy_async() — the same context as @callback is
3540 * run in.
3541 *
3542 * When the operation is finished, @callback will be called. You can then call
3543 * g_file_copy_finish() to get the result of the operation.
3544 */
3545 void
3548 GFileCopyFlags flags,
3551 GFileProgressCallback progress_callback,
3552 gpointer progress_callback_data,
3553 GAsyncReadyCallback callback,
3554 gpointer user_data)
3555 {
3563 destination,
3564 flags,
3565 io_priority,
3566 cancellable,
3567 progress_callback,
3568 progress_callback_data,
3569 callback,
3570 user_data);
3571 }
3573 /**
3574 * g_file_copy_finish:
3575 * @file: input #GFile
3576 * @res: a #GAsyncResult
3577 * @error: a #GError, or %NULL
3578 *
3579 * Finishes copying the file started with g_file_copy_async().
3580 *
3581 * Returns: a %TRUE on success, %FALSE on error.
3582 */
3583 gboolean
3587 {
3598 }
3600 /**
3601 * g_file_move:
3602 * @source: #GFile pointing to the source location
3603 * @destination: #GFile pointing to the destination location
3604 * @flags: set of #GFileCopyFlags
3605 * @cancellable: (nullable): optional #GCancellable object,
3606 * %NULL to ignore
3607 * @progress_callback: (nullable) (scope call): #GFileProgressCallback
3608 * function for updates
3609 * @progress_callback_data: (closure): gpointer to user data for
3610 * the callback function
3611 * @error: #GError for returning error conditions, or %NULL
3612 *
3613 * Tries to move the file or directory @source to the location specified
3614 * by @destination. If native move operations are supported then this is
3615 * used, otherwise a copy + delete fallback is used. The native
3616 * implementation may support moving directories (for instance on moves
3617 * inside the same filesystem), but the fallback code does not.
3618 *
3619 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3620 * existing @destination file is overwritten.
3621 *
3622 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3623 * will be copied as symlinks, otherwise the target of the
3624 * @source symlink will be copied.
3625 *
3626 * If @cancellable is not %NULL, then the operation can be cancelled by
3627 * triggering the cancellable object from another thread. If the operation
3628 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3629 *
3630 * If @progress_callback is not %NULL, then the operation can be monitored
3631 * by setting this to a #GFileProgressCallback function.
3632 * @progress_callback_data will be passed to this function. It is
3633 * guaranteed that this callback will be called after all data has been
3634 * transferred with the total number of bytes copied during the operation.
3635 *
3636 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3637 * error is returned, independent on the status of the @destination.
3638 *
3639 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3640 * then the error %G_IO_ERROR_EXISTS is returned.
3641 *
3642 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3643 * error is returned. If trying to overwrite a directory with a directory the
3644 * %G_IO_ERROR_WOULD_MERGE error is returned.
3645 *
3646 * If the source is a directory and the target does not exist, or
3647 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3648 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3649 * move operation isn't available).
3650 *
3651 * Returns: %TRUE on successful move, %FALSE otherwise.
3652 */
3653 gboolean
3656 GFileCopyFlags flags,
3658 GFileProgressCallback progress_callback,
3659 gpointer progress_callback_data,
3661 {
3664 gboolean res;
3674 {
3685 {
3688 }
3689 else
3691 }
3693 /* If the types are different, and the destination method failed
3694 * also try the source method
3695 */
3697 {
3701 {
3712 {
3715 }
3716 else
3718 }
3719 }
3722 {
3724 G_IO_ERROR_NOT_SUPPORTED,
3727 }
3732 error))
3736 }
3738 /**
3739 * g_file_make_directory:
3740 * @file: input #GFile
3741 * @cancellable: (nullable): optional #GCancellable object,
3742 * %NULL to ignore
3743 * @error: a #GError, or %NULL
3744 *
3745 * Creates a directory. Note that this will only create a child directory
3746 * of the immediate parent directory of the path or URI given by the #GFile.
3747 * To recursively create directories, see g_file_make_directory_with_parents().
3748 * This function will fail if the parent directory does not exist, setting
3749 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3750 * creating directories, this function will fail, setting @error to
3751 * %G_IO_ERROR_NOT_SUPPORTED.
3752 *
3753 * For a local #GFile the newly created directory will have the default
3754 * (current) ownership and permissions of the current process.
3755 *
3756 * If @cancellable is not %NULL, then the operation can be cancelled by
3757 * triggering the cancellable object from another thread. If the operation
3758 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3759 *
3760 * Returns: %TRUE on successful creation, %FALSE otherwise.
3761 */
3762 gboolean
3766 {
3777 {
3779 G_IO_ERROR_NOT_SUPPORTED,
3782 }
3785 }
3787 /**
3788 * g_file_make_directory_async:
3789 * @file: input #GFile
3790 * @io_priority: the [I/O priority][io-priority] of the request
3791 * @cancellable: (nullable): optional #GCancellable object,
3792 * %NULL to ignore
3793 * @callback: a #GAsyncReadyCallback to call
3794 * when the request is satisfied
3795 * @user_data: the data to pass to callback function
3796 *
3797 * Asynchronously creates a directory.
3798 *
3799 * Virtual: make_directory_async
3800 * Since: 2.38
3801 */
3802 void
3806 GAsyncReadyCallback callback,
3807 gpointer user_data)
3808 {
3815 io_priority,
3816 cancellable,
3817 callback,
3818 user_data);
3819 }
3821 /**
3822 * g_file_make_directory_finish:
3823 * @file: input #GFile
3824 * @result: a #GAsyncResult
3825 * @error: a #GError, or %NULL
3826 *
3827 * Finishes an asynchronous directory creation, started with
3828 * g_file_make_directory_async().
3829 *
3830 * Virtual: make_directory_finish
3831 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3832 * Since: 2.38
3833 */
3834 gboolean
3838 {
3846 }
3848 /**
3849 * g_file_make_directory_with_parents:
3850 * @file: input #GFile
3851 * @cancellable: (nullable): optional #GCancellable object,
3852 * %NULL to ignore
3853 * @error: a #GError, or %NULL
3854 *
3855 * Creates a directory and any parent directories that may not
3856 * exist similar to 'mkdir -p'. If the file system does not support
3857 * creating directories, this function will fail, setting @error to
3858 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3859 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3860 * the similar g_mkdir_with_parents().
3861 *
3862 * For a local #GFile the newly created directories will have the default
3863 * (current) ownership and permissions of the current process.
3864 *
3865 * If @cancellable is not %NULL, then the operation can be cancelled by
3866 * triggering the cancellable object from another thread. If the operation
3867 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3868 *
3869 * Returns: %TRUE if all directories have been successfully created, %FALSE
3870 * otherwise.
3871 *
3872 * Since: 2.18
3873 */
3874 gboolean
3878 {
3888 /* Try for the simple case of not having to create any parent
3889 * directories. If any parent directory needs to be created, this
3890 * call will fail with NOT_FOUND. If that happens, then that value of
3891 * my_error persists into the while loop below.
3892 */
3895 {
3899 }
3903 /* Creates the parent directories as needed. In case any particular
3904 * creation operation fails for lack of other parent directories
3905 * (NOT_FOUND), the directory is added to a list of directories to
3906 * create later, and the value of my_error is retained until the next
3907 * iteration of the loop. After the loop my_error should either be
3908 * empty or contain a real failure condition.
3909 */
3911 {
3920 /* Another process may have created the directory in between the
3921 * G_IO_ERROR_NOT_FOUND and now
3922 */
3931 else
3933 }
3935 /* All directories should be able to be created now, so an error at
3936 * this point means the whole operation must fail -- except an EXISTS
3937 * error, which means that another process already created the
3938 * directory in between the previous failure and now.
3939 */
3941 {
3945 }
3950 /* Clean up */
3952 {
3955 }
3957 /* At this point an error in my_error means a that something
3958 * unexpected failed in either of the loops above, so the whole
3959 * operation must fail.
3960 */
3962 {
3965 }
3968 }
3970 /**
3971 * g_file_make_symbolic_link:
3972 * @file: a #GFile with the name of the symlink to create
3973 * @symlink_value: (type filename): a string with the path for the target
3974 * of the new symlink
3975 * @cancellable: (nullable): optional #GCancellable object,
3976 * %NULL to ignore
3977 * @error: a #GError
3978 *
3979 * Creates a symbolic link named @file which contains the string
3980 * @symlink_value.
3981 *
3982 * If @cancellable is not %NULL, then the operation can be cancelled by
3983 * triggering the cancellable object from another thread. If the operation
3984 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3985 *
3986 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3987 */
3988 gboolean
3993 {
4003 {
4005 G_IO_ERROR_INVALID_ARGUMENT,
4008 }
4013 {
4015 G_IO_ERROR_NOT_SUPPORTED,
4018 }
4021 }
4023 /**
4024 * g_file_delete:
4025 * @file: input #GFile
4026 * @cancellable: (nullable): optional #GCancellable object,
4027 * %NULL to ignore
4028 * @error: a #GError, or %NULL
4029 *
4030 * Deletes a file. If the @file is a directory, it will only be
4031 * deleted if it is empty. This has the same semantics as g_unlink().
4032 *
4033 * If @cancellable is not %NULL, then the operation can be cancelled by
4034 * triggering the cancellable object from another thread. If the operation
4035 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4036 *
4037 * Virtual: delete_file
4038 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
4039 */
4040 gboolean
4044 {
4055 {
4057 G_IO_ERROR_NOT_SUPPORTED,
4060 }
4063 }
4065 /**
4066 * g_file_delete_async:
4067 * @file: input #GFile
4068 * @io_priority: the [I/O priority][io-priority] of the request
4069 * @cancellable: (nullable): optional #GCancellable object,
4070 * %NULL to ignore
4071 * @callback: a #GAsyncReadyCallback to call
4072 * when the request is satisfied
4073 * @user_data: the data to pass to callback function
4074 *
4075 * Asynchronously delete a file. If the @file is a directory, it will
4076 * only be deleted if it is empty. This has the same semantics as
4077 * g_unlink().
4078 *
4079 * Virtual: delete_file_async
4080 * Since: 2.34
4081 */
4082 void
4086 GAsyncReadyCallback callback,
4087 gpointer user_data)
4088 {
4095 io_priority,
4096 cancellable,
4097 callback,
4098 user_data);
4099 }
4101 /**
4102 * g_file_delete_finish:
4103 * @file: input #GFile
4104 * @result: a #GAsyncResult
4105 * @error: a #GError, or %NULL
4106 *
4107 * Finishes deleting a file started with g_file_delete_async().
4108 *
4109 * Virtual: delete_file_finish
4110 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
4111 * Since: 2.34
4112 **/
4113 gboolean
4117 {
4128 }
4130 /**
4131 * g_file_trash:
4132 * @file: #GFile to send to trash
4133 * @cancellable: (nullable): optional #GCancellable object,
4134 * %NULL to ignore
4135 * @error: a #GError, or %NULL
4136 *
4137 * Sends @file to the "Trashcan", if possible. This is similar to
4138 * deleting it, but the user can recover it before emptying the trashcan.
4139 * Not all file systems support trashing, so this call can return the
4140 * %G_IO_ERROR_NOT_SUPPORTED error.
4141 *
4142 * If @cancellable is not %NULL, then the operation can be cancelled by
4143 * triggering the cancellable object from another thread. If the operation
4144 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4145 *
4146 * Virtual: trash
4147 * Returns: %TRUE on successful trash, %FALSE otherwise.
4148 */
4149 gboolean
4153 {
4164 {
4169 }
4172 }
4174 /**
4175 * g_file_trash_async:
4176 * @file: input #GFile
4177 * @io_priority: the [I/O priority][io-priority] of the request
4178 * @cancellable: (nullable): optional #GCancellable object,
4179 * %NULL to ignore
4180 * @callback: a #GAsyncReadyCallback to call
4181 * when the request is satisfied
4182 * @user_data: the data to pass to callback function
4183 *
4184 * Asynchronously sends @file to the Trash location, if possible.
4185 *
4186 * Virtual: trash_async
4187 * Since: 2.38
4188 */
4189 void
4193 GAsyncReadyCallback callback,
4194 gpointer user_data)
4195 {
4202 io_priority,
4203 cancellable,
4204 callback,
4205 user_data);
4206 }
4208 /**
4209 * g_file_trash_finish:
4210 * @file: input #GFile
4211 * @result: a #GAsyncResult
4212 * @error: a #GError, or %NULL
4213 *
4214 * Finishes an asynchronous file trashing operation, started with
4215 * g_file_trash_async().
4216 *
4217 * Virtual: trash_finish
4218 * Returns: %TRUE on successful trash, %FALSE otherwise.
4219 * Since: 2.38
4220 */
4221 gboolean
4225 {
4233 }
4235 /**
4236 * g_file_set_display_name:
4237 * @file: input #GFile
4238 * @display_name: a string
4239 * @cancellable: (nullable): optional #GCancellable object,
4240 * %NULL to ignore
4241 * @error: a #GError, or %NULL
4242 *
4243 * Renames @file to the specified display name.
4244 *
4245 * The display name is converted from UTF-8 to the correct encoding
4246 * for the target filesystem if possible and the @file is renamed to this.
4247 *
4248 * If you want to implement a rename operation in the user interface the
4249 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4250 * initial value in the rename widget, and then the result after editing
4251 * should be passed to g_file_set_display_name().
4252 *
4253 * On success the resulting converted filename is returned.
4254 *
4255 * If @cancellable is not %NULL, then the operation can be cancelled by
4256 * triggering the cancellable object from another thread. If the operation
4257 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4258 *
4259 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4260 * or %NULL if there was an error.
4261 * Free the returned object with g_object_unref().
4262 */
4263 GFile *
4268 {
4275 {
4277 G_IO_ERROR,
4278 G_IO_ERROR_INVALID_ARGUMENT,
4281 }
4289 }
4291 /**
4292 * g_file_set_display_name_async:
4293 * @file: input #GFile
4294 * @display_name: a string
4295 * @io_priority: the [I/O priority][io-priority] of the request
4296 * @cancellable: (nullable): optional #GCancellable object,
4297 * %NULL to ignore
4298 * @callback: (scope async): a #GAsyncReadyCallback to call
4299 * when the request is satisfied
4300 * @user_data: (closure): the data to pass to callback function
4301 *
4302 * Asynchronously sets the display name for a given #GFile.
4303 *
4304 * For more details, see g_file_set_display_name() which is
4305 * the synchronous version of this call.
4306 *
4307 * When the operation is finished, @callback will be called.
4308 * You can then call g_file_set_display_name_finish() to get
4309 * the result of the operation.
4310 */
4311 void
4314 gint io_priority,
4316 GAsyncReadyCallback callback,
4317 gpointer user_data)
4318 {
4326 display_name,
4327 io_priority,
4328 cancellable,
4329 callback,
4330 user_data);
4331 }
4333 /**
4334 * g_file_set_display_name_finish:
4335 * @file: input #GFile
4336 * @res: a #GAsyncResult
4337 * @error: a #GError, or %NULL
4338 *
4339 * Finishes setting a display name started with
4340 * g_file_set_display_name_async().
4341 *
4342 * Returns: (transfer full): a #GFile or %NULL on error.
4343 * Free the returned object with g_object_unref().
4344 */
4345 GFile *
4349 {
4360 }
4362 /**
4363 * g_file_query_settable_attributes:
4364 * @file: input #GFile
4365 * @cancellable: (nullable): optional #GCancellable object,
4366 * %NULL to ignore
4367 * @error: a #GError, or %NULL
4368 *
4369 * Obtain the list of settable attributes for the file.
4370 *
4371 * Returns the type and full attribute name of all the attributes
4372 * that can be set on this file. This doesn't mean setting it will
4373 * always succeed though, you might get an access failure, or some
4374 * specific file may not support a specific attribute.
4375 *
4376 * If @cancellable is not %NULL, then the operation can be cancelled by
4377 * triggering the cancellable object from another thread. If the operation
4378 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4379 *
4380 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4381 * When you are done with it, release it with
4382 * g_file_attribute_info_list_unref()
4383 */
4384 GFileAttributeInfoList *
4388 {
4407 {
4409 {
4412 }
4413 else
4415 }
4418 }
4420 /**
4421 * g_file_query_writable_namespaces:
4422 * @file: input #GFile
4423 * @cancellable: (nullable): optional #GCancellable object,
4424 * %NULL to ignore
4425 * @error: a #GError, or %NULL
4426 *
4427 * Obtain the list of attribute namespaces where new attributes
4428 * can be created by a user. An example of this is extended
4429 * attributes (in the "xattr" namespace).
4430 *
4431 * If @cancellable is not %NULL, then the operation can be cancelled by
4432 * triggering the cancellable object from another thread. If the operation
4433 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4434 *
4435 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4436 * When you are done with it, release it with
4437 * g_file_attribute_info_list_unref()
4438 */
4439 GFileAttributeInfoList *
4443 {
4462 {
4465 }
4468 {
4470 {
4472 }
4473 else
4475 }
4478 }
4480 /**
4481 * g_file_set_attribute:
4482 * @file: input #GFile
4483 * @attribute: a string containing the attribute's name
4484 * @type: The type of the attribute
4485 * @value_p: (nullable): a pointer to the value (or the pointer
4486 * itself if the type is a pointer type)
4487 * @flags: a set of #GFileQueryInfoFlags
4488 * @cancellable: (nullable): optional #GCancellable object,
4489 * %NULL to ignore
4490 * @error: a #GError, or %NULL
4491 *
4492 * Sets an attribute in the file with attribute name @attribute to @value.
4493 *
4494 * Some attributes can be unset by setting @type to
4495 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4496 *
4497 * If @cancellable is not %NULL, then the operation can be cancelled by
4498 * triggering the cancellable object from another thread. If the operation
4499 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4500 *
4501 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4502 */
4503 gboolean
4506 GFileAttributeType type,
4507 gpointer value_p,
4508 GFileQueryInfoFlags flags,
4511 {
4523 {
4525 G_IO_ERROR_NOT_SUPPORTED,
4528 }
4531 }
4533 /**
4534 * g_file_set_attributes_from_info:
4535 * @file: input #GFile
4536 * @info: a #GFileInfo
4537 * @flags: #GFileQueryInfoFlags
4538 * @cancellable: (nullable): optional #GCancellable object,
4539 * %NULL to ignore
4540 * @error: a #GError, or %NULL
4541 *
4542 * Tries to set all attributes in the #GFileInfo on the target
4543 * values, not stopping on the first error.
4544 *
4545 * If there is any error during this operation then @error will
4546 * be set to the first error. Error on particular fields are flagged
4547 * by setting the "status" field in the attribute value to
4548 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4549 * also detect further errors.
4550 *
4551 * If @cancellable is not %NULL, then the operation can be cancelled by
4552 * triggering the cancellable object from another thread. If the operation
4553 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4554 *
4555 * Returns: %FALSE if there was any error, %TRUE otherwise.
4556 */
4557 gboolean
4560 GFileQueryInfoFlags flags,
4563 {
4577 info,
4578 flags,
4579 cancellable,
4580 error);
4581 }
4583 static gboolean
4586 GFileQueryInfoFlags flags,
4589 {
4592 gboolean res;
4600 {
4609 {
4612 /* Don't set error multiple times */
4614 }
4615 else
4617 }
4622 }
4624 /**
4625 * g_file_set_attributes_async:
4626 * @file: input #GFile
4627 * @info: a #GFileInfo
4628 * @flags: a #GFileQueryInfoFlags
4629 * @io_priority: the [I/O priority][io-priority] of the request
4630 * @cancellable: (nullable): optional #GCancellable object,
4631 * %NULL to ignore
4632 * @callback: (scope async): a #GAsyncReadyCallback
4633 * @user_data: (closure): a #gpointer
4634 *
4635 * Asynchronously sets the attributes of @file with @info.
4636 *
4637 * For more details, see g_file_set_attributes_from_info(),
4638 * which is the synchronous version of this call.
4639 *
4640 * When the operation is finished, @callback will be called.
4641 * You can then call g_file_set_attributes_finish() to get
4642 * the result of the operation.
4643 */
4644 void
4647 GFileQueryInfoFlags flags,
4650 GAsyncReadyCallback callback,
4651 gpointer user_data)
4652 {
4660 info,
4661 flags,
4662 io_priority,
4663 cancellable,
4664 callback,
4665 user_data);
4666 }
4668 /**
4669 * g_file_set_attributes_finish:
4670 * @file: input #GFile
4671 * @result: a #GAsyncResult
4672 * @info: (out) (transfer full): a #GFileInfo
4673 * @error: a #GError, or %NULL
4674 *
4675 * Finishes setting an attribute started in g_file_set_attributes_async().
4676 *
4677 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4678 */
4679 gboolean
4684 {
4690 /* No standard handling of errors here, as we must set info even
4691 * on errors
4692 */
4695 }
4697 /**
4698 * g_file_set_attribute_string:
4699 * @file: input #GFile
4700 * @attribute: a string containing the attribute's name
4701 * @value: a string containing the attribute's value
4702 * @flags: #GFileQueryInfoFlags
4703 * @cancellable: (nullable): optional #GCancellable object,
4704 * %NULL to ignore
4705 * @error: a #GError, or %NULL
4706 *
4707 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4708 * If @attribute is of a different type, this operation will fail.
4709 *
4710 * If @cancellable is not %NULL, then the operation can be cancelled by
4711 * triggering the cancellable object from another thread. If the operation
4712 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4713 *
4714 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4715 */
4716 gboolean
4720 GFileQueryInfoFlags flags,
4723 {
4727 }
4729 /**
4730 * g_file_set_attribute_byte_string:
4731 * @file: input #GFile
4732 * @attribute: a string containing the attribute's name
4733 * @value: a string containing the attribute's new value
4734 * @flags: a #GFileQueryInfoFlags
4735 * @cancellable: (nullable): optional #GCancellable object,
4736 * %NULL to ignore
4737 * @error: a #GError, or %NULL
4738 *
4739 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4740 * If @attribute is of a different type, this operation will fail,
4741 * returning %FALSE.
4742 *
4743 * If @cancellable is not %NULL, then the operation can be cancelled by
4744 * triggering the cancellable object from another thread. If the operation
4745 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4746 *
4747 * Returns: %TRUE if the @attribute was successfully set to @value
4748 * in the @file, %FALSE otherwise.
4749 */
4750 gboolean
4754 GFileQueryInfoFlags flags,
4757 {
4761 }
4763 /**
4764 * g_file_set_attribute_uint32:
4765 * @file: input #GFile
4766 * @attribute: a string containing the attribute's name
4767 * @value: a #guint32 containing the attribute's new value
4768 * @flags: a #GFileQueryInfoFlags
4769 * @cancellable: (nullable): optional #GCancellable object,
4770 * %NULL to ignore
4771 * @error: a #GError, or %NULL
4772 *
4773 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4774 * If @attribute is of a different type, this operation will fail.
4775 *
4776 * If @cancellable is not %NULL, then the operation can be cancelled by
4777 * triggering the cancellable object from another thread. If the operation
4778 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4779 *
4780 * Returns: %TRUE if the @attribute was successfully set to @value
4781 * in the @file, %FALSE otherwise.
4782 */
4783 gboolean
4786 guint32 value,
4787 GFileQueryInfoFlags flags,
4790 {
4794 }
4796 /**
4797 * g_file_set_attribute_int32:
4798 * @file: input #GFile
4799 * @attribute: a string containing the attribute's name
4800 * @value: a #gint32 containing the attribute's new value
4801 * @flags: a #GFileQueryInfoFlags
4802 * @cancellable: (nullable): optional #GCancellable object,
4803 * %NULL to ignore
4804 * @error: a #GError, or %NULL
4805 *
4806 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4807 * If @attribute is of a different type, this operation will fail.
4808 *
4809 * If @cancellable is not %NULL, then the operation can be cancelled by
4810 * triggering the cancellable object from another thread. If the operation
4811 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4812 *
4813 * Returns: %TRUE if the @attribute was successfully set to @value
4814 * in the @file, %FALSE otherwise.
4815 */
4816 gboolean
4819 gint32 value,
4820 GFileQueryInfoFlags flags,
4823 {
4827 }
4829 /**
4830 * g_file_set_attribute_uint64:
4831 * @file: input #GFile
4832 * @attribute: a string containing the attribute's name
4833 * @value: a #guint64 containing the attribute's new value
4834 * @flags: a #GFileQueryInfoFlags
4835 * @cancellable: (nullable): optional #GCancellable object,
4836 * %NULL to ignore
4837 * @error: a #GError, or %NULL
4838 *
4839 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4840 * If @attribute is of a different type, this operation will fail.
4841 *
4842 * If @cancellable is not %NULL, then the operation can be cancelled by
4843 * triggering the cancellable object from another thread. If the operation
4844 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4845 *
4846 * Returns: %TRUE if the @attribute was successfully set to @value
4847 * in the @file, %FALSE otherwise.
4848 */
4849 gboolean
4852 guint64 value,
4853 GFileQueryInfoFlags flags,
4856 {
4860 }
4862 /**
4863 * g_file_set_attribute_int64:
4864 * @file: input #GFile
4865 * @attribute: a string containing the attribute's name
4866 * @value: a #guint64 containing the attribute's new value
4867 * @flags: a #GFileQueryInfoFlags
4868 * @cancellable: (nullable): optional #GCancellable object,
4869 * %NULL to ignore
4870 * @error: a #GError, or %NULL
4871 *
4872 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4873 * If @attribute is of a different type, this operation will fail.
4874 *
4875 * If @cancellable is not %NULL, then the operation can be cancelled by
4876 * triggering the cancellable object from another thread. If the operation
4877 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4878 *
4879 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4880 */
4881 gboolean
4884 gint64 value,
4885 GFileQueryInfoFlags flags,
4888 {
4892 }
4894 /**
4895 * g_file_mount_mountable:
4896 * @file: input #GFile
4897 * @flags: flags affecting the operation
4898 * @mount_operation: (nullable): a #GMountOperation,
4899 * or %NULL to avoid user interaction
4900 * @cancellable: (nullable): optional #GCancellable object,
4901 * %NULL to ignore
4902 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4903 * when the request is satisfied, or %NULL
4904 * @user_data: (closure): the data to pass to callback function
4905 *
4906 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4907 * Using @mount_operation, you can request callbacks when, for instance,
4908 * passwords are needed during authentication.
4909 *
4910 * If @cancellable is not %NULL, then the operation can be cancelled by
4911 * triggering the cancellable object from another thread. If the operation
4912 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4913 *
4914 * When the operation is finished, @callback will be called.
4915 * You can then call g_file_mount_mountable_finish() to get
4916 * the result of the operation.
4917 */
4918 void
4920 GMountMountFlags flags,
4923 GAsyncReadyCallback callback,
4924 gpointer user_data)
4925 {
4933 {
4935 g_file_mount_mountable,
4939 }
4942 flags,
4943 mount_operation,
4944 cancellable,
4945 callback,
4946 user_data);
4947 }
4949 /**
4950 * g_file_mount_mountable_finish:
4951 * @file: input #GFile
4952 * @result: a #GAsyncResult
4953 * @error: a #GError, or %NULL
4954 *
4955 * Finishes a mount operation. See g_file_mount_mountable() for details.
4956 *
4957 * Finish an asynchronous mount operation that was started
4958 * with g_file_mount_mountable().
4959 *
4960 * Returns: (transfer full): a #GFile or %NULL on error.
4961 * Free the returned object with g_object_unref().
4962 */
4963 GFile *
4967 {
4980 }
4982 /**
4983 * g_file_unmount_mountable:
4984 * @file: input #GFile
4985 * @flags: flags affecting the operation
4986 * @cancellable: (nullable): optional #GCancellable object,
4987 * %NULL to ignore
4988 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4989 * when the request is satisfied, or %NULL
4990 * @user_data: (closure): the data to pass to callback function
4991 *
4992 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4993 *
4994 * If @cancellable is not %NULL, then the operation can be cancelled by
4995 * triggering the cancellable object from another thread. If the operation
4996 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4997 *
4998 * When the operation is finished, @callback will be called.
4999 * You can then call g_file_unmount_mountable_finish() to get
5000 * the result of the operation.
5001 *
5002 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
5003 */
5004 void
5006 GMountUnmountFlags flags,
5008 GAsyncReadyCallback callback,
5009 gpointer user_data)
5010 {
5018 {
5020 g_file_unmount_mountable_with_operation,
5024 }
5027 flags,
5028 cancellable,
5029 callback,
5030 user_data);
5031 }
5033 /**
5034 * g_file_unmount_mountable_finish:
5035 * @file: input #GFile
5036 * @result: a #GAsyncResult
5037 * @error: a #GError, or %NULL
5038 *
5039 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
5040 *
5041 * Finish an asynchronous unmount operation that was started
5042 * with g_file_unmount_mountable().
5043 *
5044 * Returns: %TRUE if the operation finished successfully.
5045 * %FALSE otherwise.
5046 *
5047 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
5048 * instead.
5049 */
5050 gboolean
5054 {
5067 }
5069 /**
5070 * g_file_unmount_mountable_with_operation:
5071 * @file: input #GFile
5072 * @flags: flags affecting the operation
5073 * @mount_operation: (nullable): a #GMountOperation,
5074 * or %NULL to avoid user interaction
5075 * @cancellable: (nullable): optional #GCancellable object,
5076 * %NULL to ignore
5077 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5078 * when the request is satisfied, or %NULL
5079 * @user_data: (closure): the data to pass to callback function
5080 *
5081 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
5082 *
5083 * If @cancellable is not %NULL, then the operation can be cancelled by
5084 * triggering the cancellable object from another thread. If the operation
5085 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5086 *
5087 * When the operation is finished, @callback will be called.
5088 * You can then call g_file_unmount_mountable_finish() to get
5089 * the result of the operation.
5090 *
5091 * Since: 2.22
5092 */
5093 void
5095 GMountUnmountFlags flags,
5098 GAsyncReadyCallback callback,
5099 gpointer user_data)
5100 {
5108 {
5110 g_file_unmount_mountable_with_operation,
5114 }
5118 flags,
5119 mount_operation,
5120 cancellable,
5121 callback,
5122 user_data);
5123 else
5125 flags,
5126 cancellable,
5127 callback,
5128 user_data);
5129 }
5131 /**
5132 * g_file_unmount_mountable_with_operation_finish:
5133 * @file: input #GFile
5134 * @result: a #GAsyncResult
5135 * @error: a #GError, or %NULL
5136 *
5137 * Finishes an unmount operation,
5138 * see g_file_unmount_mountable_with_operation() for details.
5139 *
5140 * Finish an asynchronous unmount operation that was started
5141 * with g_file_unmount_mountable_with_operation().
5142 *
5143 * Returns: %TRUE if the operation finished successfully.
5144 * %FALSE otherwise.
5145 *
5146 * Since: 2.22
5147 */
5148 gboolean
5152 {
5166 else
5168 }
5170 /**
5171 * g_file_eject_mountable:
5172 * @file: input #GFile
5173 * @flags: flags affecting the operation
5174 * @cancellable: (nullable): optional #GCancellable object,
5175 * %NULL to ignore
5176 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5177 * when the request is satisfied, or %NULL
5178 * @user_data: (closure): the data to pass to callback function
5179 *
5180 * Starts an asynchronous eject on a mountable.
5181 * When this operation has completed, @callback will be called with
5182 * @user_user data, and the operation can be finalized with
5183 * g_file_eject_mountable_finish().
5184 *
5185 * If @cancellable is not %NULL, then the operation can be cancelled by
5186 * triggering the cancellable object from another thread. If the operation
5187 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5188 *
5189 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5190 */
5191 void
5193 GMountUnmountFlags flags,
5195 GAsyncReadyCallback callback,
5196 gpointer user_data)
5197 {
5205 {
5207 g_file_eject_mountable_with_operation,
5211 }
5214 flags,
5215 cancellable,
5216 callback,
5217 user_data);
5218 }
5220 /**
5221 * g_file_eject_mountable_finish:
5222 * @file: input #GFile
5223 * @result: a #GAsyncResult
5224 * @error: a #GError, or %NULL
5225 *
5226 * Finishes an asynchronous eject operation started by
5227 * g_file_eject_mountable().
5228 *
5229 * Returns: %TRUE if the @file was ejected successfully.
5230 * %FALSE otherwise.
5231 *
5232 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5233 * instead.
5234 */
5235 gboolean
5239 {
5252 }
5254 /**
5255 * g_file_eject_mountable_with_operation:
5256 * @file: input #GFile
5257 * @flags: flags affecting the operation
5258 * @mount_operation: (nullable): a #GMountOperation,
5259 * or %NULL to avoid user interaction
5260 * @cancellable: (nullable): optional #GCancellable object,
5261 * %NULL to ignore
5262 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5263 * when the request is satisfied, or %NULL
5264 * @user_data: (closure): the data to pass to callback function
5265 *
5266 * Starts an asynchronous eject on a mountable.
5267 * When this operation has completed, @callback will be called with
5268 * @user_user data, and the operation can be finalized with
5269 * g_file_eject_mountable_with_operation_finish().
5270 *
5271 * If @cancellable is not %NULL, then the operation can be cancelled by
5272 * triggering the cancellable object from another thread. If the operation
5273 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5274 *
5275 * Since: 2.22
5276 */
5277 void
5279 GMountUnmountFlags flags,
5282 GAsyncReadyCallback callback,
5283 gpointer user_data)
5284 {
5292 {
5294 g_file_eject_mountable_with_operation,
5298 }
5302 flags,
5303 mount_operation,
5304 cancellable,
5305 callback,
5306 user_data);
5307 else
5309 flags,
5310 cancellable,
5311 callback,
5312 user_data);
5313 }
5315 /**
5316 * g_file_eject_mountable_with_operation_finish:
5317 * @file: input #GFile
5318 * @result: a #GAsyncResult
5319 * @error: a #GError, or %NULL
5320 *
5321 * Finishes an asynchronous eject operation started by
5322 * g_file_eject_mountable_with_operation().
5323 *
5324 * Returns: %TRUE if the @file was ejected successfully.
5325 * %FALSE otherwise.
5326 *
5327 * Since: 2.22
5328 */
5329 gboolean
5333 {
5347 else
5349 }
5351 /**
5352 * g_file_monitor_directory:
5353 * @file: input #GFile
5354 * @flags: a set of #GFileMonitorFlags
5355 * @cancellable: (nullable): optional #GCancellable object,
5356 * %NULL to ignore
5357 * @error: a #GError, or %NULL
5358 *
5359 * Obtains a directory monitor for the given file.
5360 * This may fail if directory monitoring is not supported.
5361 *
5362 * If @cancellable is not %NULL, then the operation can be cancelled by
5363 * triggering the cancellable object from another thread. If the operation
5364 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5365 *
5366 * It does not make sense for @flags to contain
5367 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5368 * directories. It is not possible to monitor all the files in a
5369 * directory for changes made via hard links; if you want to do this then
5370 * you must register individual watches with g_file_monitor().
5371 *
5372 * Virtual: monitor_dir
5373 * Returns: (transfer full): a #GFileMonitor for the given @file,
5374 * or %NULL on error.
5375 * Free the returned object with g_object_unref().
5376 */
5377 GFileMonitor *
5379 GFileMonitorFlags flags,
5382 {
5394 {
5396 G_IO_ERROR_NOT_SUPPORTED,
5399 }
5402 }
5404 /**
5405 * g_file_monitor_file:
5406 * @file: input #GFile
5407 * @flags: a set of #GFileMonitorFlags
5408 * @cancellable: (nullable): optional #GCancellable object,
5409 * %NULL to ignore
5410 * @error: a #GError, or %NULL
5411 *
5412 * Obtains a file monitor for the given file. If no file notification
5413 * mechanism exists, then regular polling of the file is used.
5414 *
5415 * If @cancellable is not %NULL, then the operation can be cancelled by
5416 * triggering the cancellable object from another thread. If the operation
5417 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5418 *
5419 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5420 * will also attempt to report changes made to the file via another
5421 * filename (ie, a hard link). Without this flag, you can only rely on
5422 * changes made through the filename contained in @file to be
5423 * reported. Using this flag may result in an increase in resource
5424 * usage, and may not have any effect depending on the #GFileMonitor
5425 * backend and/or filesystem type.
5426 *
5427 * Returns: (transfer full): a #GFileMonitor for the given @file,
5428 * or %NULL on error.
5429 * Free the returned object with g_object_unref().
5430 */
5431 GFileMonitor *
5433 GFileMonitorFlags flags,
5436 {
5452 /* Fallback to polling */
5457 }
5459 /**
5460 * g_file_monitor:
5461 * @file: input #GFile
5462 * @flags: a set of #GFileMonitorFlags
5463 * @cancellable: (nullable): optional #GCancellable object,
5464 * %NULL to ignore
5465 * @error: a #GError, or %NULL
5466 *
5467 * Obtains a file or directory monitor for the given file,
5468 * depending on the type of the file.
5469 *
5470 * If @cancellable is not %NULL, then the operation can be cancelled by
5471 * triggering the cancellable object from another thread. If the operation
5472 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5473 *
5474 * Returns: (transfer full): a #GFileMonitor for the given @file,
5475 * or %NULL on error.
5476 * Free the returned object with g_object_unref().
5477 *
5478 * Since: 2.18
5479 */
5480 GFileMonitor *
5482 GFileMonitorFlags flags,
5485 {
5490 else
5492 }
5494 /********************************************
5495 * Default implementation of async ops *
5496 ********************************************/
5500 GFileQueryInfoFlags flags;
5503 static void
5505 {
5508 }
5510 static void
5512 gpointer object,
5513 gpointer task_data,
5515 {
5520 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5523 else
5525 }
5527 static void
5530 GFileQueryInfoFlags flags,
5533 GAsyncReadyCallback callback,
5534 gpointer user_data)
5535 {
5549 }
5555 {
5559 }
5561 static void
5563 gpointer object,
5564 gpointer task_data,
5566 {
5574 else
5576 }
5578 static void
5583 GAsyncReadyCallback callback,
5584 gpointer user_data)
5585 {
5594 }
5600 {
5604 }
5606 static void
5608 gpointer object,
5609 gpointer task_data,
5611 {
5616 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5619 else
5621 }
5623 static void
5626 GFileQueryInfoFlags flags,
5629 GAsyncReadyCallback callback,
5630 gpointer user_data)
5631 {
5645 }
5651 {
5655 }
5657 static void
5659 gpointer object,
5660 gpointer task_data,
5662 {
5669 else
5671 }
5673 static void
5677 GAsyncReadyCallback callback,
5678 gpointer user_data)
5679 {
5687 }
5693 {
5697 }
5699 static void
5701 gpointer source_object,
5702 gpointer task_data,
5704 {
5712 else
5714 }
5716 static void
5718 GFileCreateFlags flags,
5721 GAsyncReadyCallback callback,
5722 gpointer user_data)
5723 {
5737 }
5743 {
5747 }
5749 static void
5751 gpointer source_object,
5752 gpointer task_data,
5754 {
5762 else
5764 }
5766 static void
5768 GFileCreateFlags flags,
5771 GAsyncReadyCallback callback,
5772 gpointer user_data)
5773 {
5787 }
5793 {
5797 }
5802 gboolean make_backup;
5803 GFileCreateFlags flags;
5806 static void
5808 {
5813 }
5815 static void
5817 gpointer source_object,
5818 gpointer task_data,
5820 {
5829 cancellable,
5834 else
5836 }
5838 static void
5841 gboolean make_backup,
5842 GFileCreateFlags flags,
5845 GAsyncReadyCallback callback,
5846 gpointer user_data)
5847 {
5863 }
5869 {
5873 }
5875 static void
5877 gpointer object,
5878 gpointer task_data,
5880 {
5885 else
5887 }
5889 static void
5893 GAsyncReadyCallback callback,
5894 gpointer user_data)
5895 {
5903 }
5905 static gboolean
5909 {
5913 }
5915 static void
5917 gpointer object,
5918 gpointer task_data,
5920 {
5925 else
5927 }
5929 static void
5933 GAsyncReadyCallback callback,
5934 gpointer user_data)
5935 {
5943 }
5945 static gboolean
5949 {
5953 }
5955 static void
5957 gpointer object,
5958 gpointer task_data,
5960 {
5965 else
5967 }
5969 static void
5973 GAsyncReadyCallback callback,
5974 gpointer user_data)
5975 {
5983 }
5985 static gboolean
5989 {
5993 }
5995 static void
5997 gpointer object,
5998 gpointer task_data,
6000 {
6008 else
6010 }
6012 static void
6016 GAsyncReadyCallback callback,
6017 gpointer user_data)
6018 {
6027 }
6033 {
6037 }
6039 static void
6041 gpointer object,
6042 gpointer task_data,
6044 {
6053 else
6055 }
6057 static void
6059 GFileCreateFlags flags,
6062 GAsyncReadyCallback callback,
6063 gpointer user_data)
6064 {
6078 }
6084 {
6088 }
6092 gboolean make_backup;
6093 GFileCreateFlags flags;
6096 static void
6098 {
6101 }
6103 static void
6105 gpointer object,
6106 gpointer task_data,
6108 {
6117 cancellable,
6122 else
6124 }
6126 static void
6129 gboolean make_backup,
6130 GFileCreateFlags flags,
6133 GAsyncReadyCallback callback,
6134 gpointer user_data)
6135 {
6151 }
6157 {
6161 }
6163 static void
6165 gpointer object,
6166 gpointer task_data,
6168 {
6177 else
6179 }
6181 static void
6186 GAsyncReadyCallback callback,
6187 gpointer user_data)
6188 {
6198 }
6204 {
6208 }
6211 GFileQueryInfoFlags flags;
6213 gboolean res;
6217 static void
6219 {
6225 }
6227 static void
6229 gpointer object,
6230 gpointer task_data,
6232 {
6239 cancellable,
6241 }
6243 static void
6246 GFileQueryInfoFlags flags,
6249 GAsyncReadyCallback callback,
6250 gpointer user_data)
6251 {
6266 }
6268 static gboolean
6273 {
6287 }
6289 static void
6291 gpointer object,
6292 gpointer task_data,
6294 {
6302 else
6304 }
6306 static void
6310 GAsyncReadyCallback callback,
6311 gpointer user_data)
6312 {
6321 }
6327 {
6331 }
6337 GFileCopyFlags flags;
6338 GFileProgressCallback progress_cb;
6339 gpointer progress_cb_data;
6342 static void
6344 {
6348 }
6352 goffset current_num_bytes;
6353 goffset total_num_bytes;
6356 static gboolean
6358 {
6367 }
6369 static void
6371 goffset total_num_bytes,
6372 gpointer user_data)
6373 {
6385 copy_async_progress_in_main,
6386 progress,
6387 g_free);
6388 }
6390 static void
6392 gpointer source,
6393 gpointer task_data,
6395 {
6397 gboolean result;
6403 cancellable,
6405 task,
6409 else
6411 }
6413 static void
6416 GFileCopyFlags flags,
6419 GFileProgressCallback progress_callback,
6420 gpointer progress_callback_data,
6421 GAsyncReadyCallback callback,
6422 gpointer user_data)
6423 {
6440 }
6442 static gboolean
6446 {
6450 }
6453 /********************************************
6454 * Default VFS operations *
6455 ********************************************/
6457 /**
6458 * g_file_new_for_path:
6459 * @path: (type filename): a string containing a relative or absolute path.
6460 * The string must be encoded in the glib filename encoding.
6461 *
6462 * Constructs a #GFile for a given path. This operation never
6463 * fails, but the returned object might not support any I/O
6464 * operation if @path is malformed.
6465 *
6466 * Returns: (transfer full): a new #GFile for the given @path.
6467 * Free the returned object with g_object_unref().
6468 */
6469 GFile *
6471 {
6475 }
6477 /**
6478 * g_file_new_for_uri:
6479 * @uri: a UTF-8 string containing a URI
6480 *
6481 * Constructs a #GFile for a given URI. This operation never
6482 * fails, but the returned object might not support any I/O
6483 * operation if @uri is malformed or if the uri type is
6484 * not supported.
6485 *
6486 * Returns: (transfer full): a new #GFile for the given @uri.
6487 * Free the returned object with g_object_unref().
6488 */
6489 GFile *
6491 {
6495 }
6497 /**
6498 * g_file_new_tmp:
6499 * @tmpl: (type filename) (nullable): Template for the file
6500 * name, as in g_file_open_tmp(), or %NULL for a default template
6501 * @iostream: (out): on return, a #GFileIOStream for the created file
6502 * @error: a #GError, or %NULL
6503 *
6504 * Opens a file in the preferred directory for temporary files (as
6505 * returned by g_get_tmp_dir()) and returns a #GFile and
6506 * #GFileIOStream pointing to it.
6507 *
6508 * @tmpl should be a string in the GLib file name encoding
6509 * containing a sequence of six 'X' characters, and containing no
6510 * directory components. If it is %NULL, a default template is used.
6511 *
6512 * Unlike the other #GFile constructors, this will return %NULL if
6513 * a temporary file could not be created.
6514 *
6515 * Returns: (transfer full): a new #GFile.
6516 * Free the returned object with g_object_unref().
6517 *
6518 * Since: 2.32
6519 */
6520 GFile *
6524 {
6525 gint fd;
6545 }
6547 /**
6548 * g_file_parse_name:
6549 * @parse_name: a file name or path to be parsed
6550 *
6551 * Constructs a #GFile with the given @parse_name (i.e. something
6552 * given by g_file_get_parse_name()). This operation never fails,
6553 * but the returned object might not support any I/O operation if
6554 * the @parse_name cannot be parsed.
6555 *
6556 * Returns: (transfer full): a new #GFile.
6557 */
6558 GFile *
6560 {
6564 }
6566 /**
6567 * g_file_new_build_filename:
6568 * @first_element: (type filename): the first element in the path
6569 * @...: remaining elements in path, terminated by %NULL
6570 *
6571 * Constructs a #GFile from a series of elements using the correct
6572 * separator for filenames.
6573 *
6574 * Using this function is equivalent to calling g_build_filename(),
6575 * followed by g_file_new_for_path() on the result.
6576 *
6577 * Returns: (transfer full): a new #GFile
6578 *
6579 * Since: 2.56
6580 */
6581 GFile *
6583 ...)
6584 {
6599 }
6601 static gboolean
6603 {
6605 }
6607 /* Following RFC 2396, valid schemes are built like:
6608 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6609 */
6610 static gboolean
6612 {
6621 p++;
6625 }
6630 {
6641 {
6647 }
6648 else
6655 }
6657 /**
6658 * g_file_new_for_commandline_arg:
6659 * @arg: (type filename): a command line string
6660 *
6661 * Creates a #GFile with the given argument from the command line.
6662 * The value of @arg can be either a URI, an absolute path or a
6663 * relative path resolved relative to the current working directory.
6664 * This operation never fails, but the returned object might not
6665 * support any I/O operation if @arg points to a malformed path.
6666 *
6667 * Note that on Windows, this function expects its argument to be in
6668 * UTF-8 -- not the system code page. This means that you
6669 * should not use this function with string from argv as it is passed
6670 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6671 * the commandline. #GApplication also uses UTF-8 but
6672 * g_application_command_line_create_file_for_arg() may be more useful
6673 * for you there. It is also always possible to use this function with
6674 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6675 *
6676 * Returns: (transfer full): a new #GFile.
6677 * Free the returned object with g_object_unref().
6678 */
6679 GFile *
6681 {
6685 }
6687 /**
6688 * g_file_new_for_commandline_arg_and_cwd:
6689 * @arg: (type filename): a command line string
6690 * @cwd: (type filename): the current working directory of the commandline
6691 *
6692 * Creates a #GFile with the given argument from the command line.
6693 *
6694 * This function is similar to g_file_new_for_commandline_arg() except
6695 * that it allows for passing the current working directory as an
6696 * argument instead of using the current working directory of the
6697 * process.
6698 *
6699 * This is useful if the commandline argument was given in a context
6700 * other than the invocation of the current process.
6701 *
6702 * See also g_application_command_line_create_file_for_arg().
6703 *
6704 * Returns: (transfer full): a new #GFile
6705 *
6706 * Since: 2.36
6707 **/
6708 GFile *
6711 {
6716 }
6718 /**
6719 * g_file_mount_enclosing_volume:
6720 * @location: input #GFile
6721 * @flags: flags affecting the operation
6722 * @mount_operation: (nullable): a #GMountOperation
6723 * or %NULL to avoid user interaction
6724 * @cancellable: (nullable): optional #GCancellable object,
6725 * %NULL to ignore
6726 * @callback: (nullable): a #GAsyncReadyCallback to call
6727 * when the request is satisfied, or %NULL
6728 * @user_data: the data to pass to callback function
6729 *
6730 * Starts a @mount_operation, mounting the volume that contains
6731 * the file @location.
6732 *
6733 * When this operation has completed, @callback will be called with
6734 * @user_user data, and the operation can be finalized with
6735 * g_file_mount_enclosing_volume_finish().
6736 *
6737 * If @cancellable is not %NULL, then the operation can be cancelled by
6738 * triggering the cancellable object from another thread. If the operation
6739 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6740 */
6741 void
6743 GMountMountFlags flags,
6746 GAsyncReadyCallback callback,
6747 gpointer user_data)
6748 {
6756 {
6758 g_file_mount_enclosing_volume,
6762 }
6764 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6766 }
6768 /**
6769 * g_file_mount_enclosing_volume_finish:
6770 * @location: input #GFile
6771 * @result: a #GAsyncResult
6772 * @error: a #GError, or %NULL
6773 *
6774 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6775 *
6776 * Returns: %TRUE if successful. If an error has occurred,
6777 * this function will return %FALSE and set @error
6778 * appropriately if present.
6779 */
6780 gboolean
6784 {
6798 }
6800 /********************************************
6801 * Utility functions *
6802 ********************************************/
6804 /**
6805 * g_file_query_default_handler:
6806 * @file: a #GFile to open
6807 * @cancellable: optional #GCancellable object, %NULL to ignore
6808 * @error: a #GError, or %NULL
6809 *
6810 * Returns the #GAppInfo that is registered as the default
6811 * application to handle the file specified by @file.
6812 *
6813 * If @cancellable is not %NULL, then the operation can be cancelled by
6814 * triggering the cancellable object from another thread. If the operation
6815 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6816 *
6817 * Returns: (transfer full): a #GAppInfo if the handle was found,
6818 * %NULL if there were errors.
6819 * When you are done with it, release it with g_object_unref()
6820 */
6821 GAppInfo *
6825 {
6834 {
6840 }
6843 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6845 cancellable,
6846 error);
6854 {
6855 /* Don't use is_native(), as we want to support fuse paths if available */
6860 }
6868 G_IO_ERROR_NOT_SUPPORTED,
6871 }
6873 #define GET_CONTENT_BLOCK_SIZE 8192
6875 /**
6876 * g_file_load_contents:
6877 * @file: input #GFile
6878 * @cancellable: optional #GCancellable object, %NULL to ignore
6879 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6880 * @length: (out) (optional): a location to place the length of the contents of the file,
6881 * or %NULL if the length is not needed
6882 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
6883 * or %NULL if the entity tag is not needed
6884 * @error: a #GError, or %NULL
6885 *
6886 * Loads the content of the file into memory. The data is always
6887 * zero-terminated, but this is not included in the resultant @length.
6888 * The returned @content should be freed with g_free() when no longer
6889 * needed.
6890 *
6891 * If @cancellable is not %NULL, then the operation can be cancelled by
6892 * triggering the cancellable object from another thread. If the operation
6893 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6894 *
6895 * Returns: %TRUE if the @file's contents were successfully loaded.
6896 * %FALSE if there were errors.
6897 */
6898 gboolean
6905 {
6908 gsize pos;
6909 gssize res;
6925 GET_CONTENT_BLOCK_SIZE,
6927 {
6930 }
6933 {
6937 G_FILE_ATTRIBUTE_ETAG_VALUE,
6938 cancellable,
6939 NULL);
6941 {
6944 }
6945 }
6947 /* Ignore errors on close */
6952 {
6953 /* error is set already */
6956 }
6961 /* Zero terminate (we got an extra byte allocated for this */
6967 }
6971 GFileReadMoreCallback read_more_callback;
6973 gsize pos;
6978 static void
6980 {
6985 }
6987 static void
6990 gpointer user_data)
6991 {
6995 /* Ignore errors here, we're only reading anyway */
7001 }
7003 static void
7006 gpointer user_data)
7007 {
7015 {
7018 }
7023 }
7025 static void
7028 gpointer user_data)
7029 {
7033 gssize read_size;
7038 {
7042 /* Close the file ignoring any error */
7045 }
7047 {
7049 G_FILE_ATTRIBUTE_ETAG_VALUE,
7052 load_contents_fstat_callback,
7053 data);
7054 }
7056 {
7067 G_FILE_ATTRIBUTE_ETAG_VALUE,
7070 load_contents_fstat_callback,
7071 data);
7072 else
7075 GET_CONTENT_BLOCK_SIZE,
7078 load_contents_read_callback,
7079 data);
7080 }
7081 }
7083 static void
7086 gpointer user_data)
7087 {
7096 {
7101 GET_CONTENT_BLOCK_SIZE,
7104 load_contents_read_callback,
7105 data);
7106 }
7107 else
7108 {
7111 }
7112 }
7114 /**
7115 * g_file_load_partial_contents_async: (skip)
7116 * @file: input #GFile
7117 * @cancellable: optional #GCancellable object, %NULL to ignore
7118 * @read_more_callback: (scope call) (closure user_data): a
7119 * #GFileReadMoreCallback to receive partial data
7120 * and to specify whether further data should be read
7121 * @callback: (scope async) (closure user_data): a #GAsyncReadyCallback to call
7122 * when the request is satisfied
7123 * @user_data: the data to pass to the callback functions
7124 *
7125 * Reads the partial contents of a file. A #GFileReadMoreCallback should
7126 * be used to stop reading from the file when appropriate, else this
7127 * function will behave exactly as g_file_load_contents_async(). This
7128 * operation can be finished by g_file_load_partial_contents_finish().
7129 *
7130 * Users of this function should be aware that @user_data is passed to
7131 * both the @read_more_callback and the @callback.
7132 *
7133 * If @cancellable is not %NULL, then the operation can be cancelled by
7134 * triggering the cancellable object from another thread. If the operation
7135 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7136 */
7137 void
7140 GFileReadMoreCallback read_more_callback,
7141 GAsyncReadyCallback callback,
7142 gpointer user_data)
7143 {
7159 load_contents_open_callback,
7160 data);
7161 }
7163 /**
7164 * g_file_load_partial_contents_finish:
7165 * @file: input #GFile
7166 * @res: a #GAsyncResult
7167 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7168 * @length: (out) (optional): a location to place the length of the contents of the file,
7169 * or %NULL if the length is not needed
7170 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7171 * or %NULL if the entity tag is not needed
7172 * @error: a #GError, or %NULL
7173 *
7174 * Finishes an asynchronous partial load operation that was started
7175 * with g_file_load_partial_contents_async(). The data is always
7176 * zero-terminated, but this is not included in the resultant @length.
7177 * The returned @content should be freed with g_free() when no longer
7178 * needed.
7179 *
7180 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7181 * present, it will be set appropriately.
7182 */
7183 gboolean
7190 {
7201 {
7205 }
7213 {
7216 }
7218 /* Zero terminate */
7226 }
7228 /**
7229 * g_file_load_contents_async:
7230 * @file: input #GFile
7231 * @cancellable: optional #GCancellable object, %NULL to ignore
7232 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7233 * @user_data: the data to pass to callback function
7234 *
7235 * Starts an asynchronous load of the @file's contents.
7236 *
7237 * For more details, see g_file_load_contents() which is
7238 * the synchronous version of this call.
7239 *
7240 * When the load operation has completed, @callback will be called
7241 * with @user data. To finish the operation, call
7242 * g_file_load_contents_finish() with the #GAsyncResult returned by
7243 * the @callback.
7244 *
7245 * If @cancellable is not %NULL, then the operation can be cancelled by
7246 * triggering the cancellable object from another thread. If the operation
7247 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7248 */
7249 void
7252 GAsyncReadyCallback callback,
7253 gpointer user_data)
7254 {
7256 cancellable,
7257 NULL,
7259 }
7261 /**
7262 * g_file_load_contents_finish:
7263 * @file: input #GFile
7264 * @res: a #GAsyncResult
7265 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7266 * @length: (out) (optional): a location to place the length of the contents of the file,
7267 * or %NULL if the length is not needed
7268 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7269 * or %NULL if the entity tag is not needed
7270 * @error: a #GError, or %NULL
7271 *
7272 * Finishes an asynchronous load of the @file's contents.
7273 * The contents are placed in @contents, and @length is set to the
7274 * size of the @contents string. The @content should be freed with
7275 * g_free() when no longer needed. If @etag_out is present, it will be
7276 * set to the new entity tag for the @file.
7277 *
7278 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7279 * present, it will be set appropriately.
7280 */
7281 gboolean
7288 {
7290 res,
7291 contents,
7292 length,
7293 etag_out,
7294 error);
7295 }
7297 /**
7298 * g_file_replace_contents:
7299 * @file: input #GFile
7300 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7301 * @length: the length of @contents in bytes
7302 * @etag: (nullable): the old [entity-tag][gfile-etag] for the document,
7303 * or %NULL
7304 * @make_backup: %TRUE if a backup should be created
7305 * @flags: a set of #GFileCreateFlags
7306 * @new_etag: (out) (optional): a location to a new [entity tag][gfile-etag]
7307 * for the document. This should be freed with g_free() when no longer
7308 * needed, or %NULL
7309 * @cancellable: optional #GCancellable object, %NULL to ignore
7310 * @error: a #GError, or %NULL
7311 *
7312 * Replaces the contents of @file with @contents of @length bytes.
7313 *
7314 * If @etag is specified (not %NULL), any existing file must have that etag,
7315 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7316 *
7317 * If @make_backup is %TRUE, this function will attempt to make a backup
7318 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7319 * file contents in the safest way possible. For example, atomic renames are
7320 * used when replacing local files’ contents.
7321 *
7322 * If @cancellable is not %NULL, then the operation can be cancelled by
7323 * triggering the cancellable object from another thread. If the operation
7324 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7325 *
7326 * The returned @new_etag can be used to verify that the file hasn't
7327 * changed the next time it is saved over.
7328 *
7329 * Returns: %TRUE if successful. If an error has occurred, this function
7330 * will return %FALSE and set @error appropriately if present.
7331 */
7332 gboolean
7335 gsize length,
7337 gboolean make_backup,
7338 GFileCreateFlags flags,
7342 {
7345 gssize res;
7346 gboolean ret;
7361 cancellable,
7363 {
7366 }
7369 {
7370 /* Ignore errors on close */
7374 /* error is set already */
7376 }
7386 }
7391 gsize pos;
7393 gboolean failed;
7396 static void
7398 {
7402 }
7404 static void
7407 gpointer user_data)
7408 {
7412 /* Ignore errors here, we're only reading anyway */
7417 {
7420 }
7422 }
7424 static void
7427 gpointer user_data)
7428 {
7432 gssize write_size;
7437 {
7438 /* Error or EOF, close the file */
7440 {
7443 }
7447 }
7449 {
7451 gsize length;
7460 else
7466 replace_contents_write_callback,
7467 data);
7468 }
7469 }
7471 static void
7474 gpointer user_data)
7475 {
7484 {
7486 gsize length;
7494 replace_contents_write_callback,
7495 data);
7496 }
7497 else
7498 {
7501 }
7502 }
7504 /**
7505 * g_file_replace_contents_async:
7506 * @file: input #GFile
7507 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7508 * @length: the length of @contents in bytes
7509 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7510 * @make_backup: %TRUE if a backup should be created
7511 * @flags: a set of #GFileCreateFlags
7512 * @cancellable: optional #GCancellable object, %NULL to ignore
7513 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7514 * @user_data: the data to pass to callback function
7515 *
7516 * Starts an asynchronous replacement of @file with the given
7517 * @contents of @length bytes. @etag will replace the document's
7518 * current entity tag.
7519 *
7520 * When this operation has completed, @callback will be called with
7521 * @user_user data, and the operation can be finalized with
7522 * g_file_replace_contents_finish().
7523 *
7524 * If @cancellable is not %NULL, then the operation can be cancelled by
7525 * triggering the cancellable object from another thread. If the operation
7526 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7527 *
7528 * If @make_backup is %TRUE, this function will attempt to
7529 * make a backup of @file.
7530 *
7531 * Note that no copy of @content will be made, so it must stay valid
7532 * until @callback is called. See g_file_replace_contents_bytes_async()
7533 * for a #GBytes version that will automatically hold a reference to the
7534 * contents (without copying) for the duration of the call.
7535 */
7536 void
7539 gsize length,
7541 gboolean make_backup,
7542 GFileCreateFlags flags,
7544 GAsyncReadyCallback callback,
7545 gpointer user_data)
7546 {
7553 }
7555 /**
7556 * g_file_replace_contents_bytes_async:
7557 * @file: input #GFile
7558 * @contents: a #GBytes
7559 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7560 * @make_backup: %TRUE if a backup should be created
7561 * @flags: a set of #GFileCreateFlags
7562 * @cancellable: optional #GCancellable object, %NULL to ignore
7563 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7564 * @user_data: the data to pass to callback function
7565 *
7566 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7567 * This function will keep a ref on @contents until the operation is done.
7568 * Unlike g_file_replace_contents_async() this allows forgetting about the
7569 * content without waiting for the callback.
7570 *
7571 * When this operation has completed, @callback will be called with
7572 * @user_user data, and the operation can be finalized with
7573 * g_file_replace_contents_finish().
7574 *
7575 * Since: 2.40
7576 */
7577 void
7581 gboolean make_backup,
7582 GFileCreateFlags flags,
7584 GAsyncReadyCallback callback,
7585 gpointer user_data)
7586 {
7601 etag,
7602 make_backup,
7603 flags,
7606 replace_contents_open_callback,
7607 data);
7608 }
7610 /**
7611 * g_file_replace_contents_finish:
7612 * @file: input #GFile
7613 * @res: a #GAsyncResult
7614 * @new_etag: (out) (optional): a location of a new [entity tag][gfile-etag]
7615 * for the document. This should be freed with g_free() when it is no
7616 * longer needed, or %NULL
7617 * @error: a #GError, or %NULL
7618 *
7619 * Finishes an asynchronous replace of the given @file. See
7620 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7621 * tag for the document, if present.
7622 *
7623 * Returns: %TRUE on success, %FALSE on failure.
7624 */
7625 gboolean
7630 {
7645 {
7648 }
7651 }
7653 gboolean
7655 GFileMeasureFlags flags,
7657 GFileMeasureProgressCallback progress_callback,
7658 gpointer progress_data,
7663 {
7667 }
7670 {
7671 GFileMeasureFlags flags;
7672 GFileMeasureProgressCallback progress_callback;
7673 gpointer progress_data;
7677 {
7678 guint64 disk_usage;
7679 guint64 num_dirs;
7680 guint64 num_files;
7684 {
7685 GFileMeasureProgressCallback callback;
7686 gpointer user_data;
7687 gboolean reporting;
7688 guint64 current_size;
7689 guint64 num_dirs;
7690 guint64 num_files;
7693 static gboolean
7695 {
7703 }
7705 static void
7707 guint64 current_size,
7708 guint64 num_dirs,
7709 guint64 num_files,
7710 gpointer user_data)
7711 {
7712 MeasureProgress progress;
7727 measure_disk_usage_invoke_progress,
7729 g_free);
7730 }
7732 static void
7734 gpointer source_object,
7735 gpointer task_data,
7737 {
7747 else
7749 }
7751 static void
7753 GFileMeasureFlags flags,
7754 gint io_priority,
7756 GFileMeasureProgressCallback progress_callback,
7757 gpointer progress_data,
7758 GAsyncReadyCallback callback,
7759 gpointer user_data)
7760 {
7761 MeasureTaskData data;
7775 }
7777 static gboolean
7784 {
7806 }
7808 /**
7809 * g_file_measure_disk_usage:
7810 * @file: a #GFile
7811 * @flags: #GFileMeasureFlags
7812 * @cancellable: (nullable): optional #GCancellable
7813 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7814 * @progress_data: user_data for @progress_callback
7815 * @disk_usage: (out) (optional): the number of bytes of disk space used
7816 * @num_dirs: (out) (optional): the number of directories encountered
7817 * @num_files: (out) (optional): the number of non-directories encountered
7818 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7819 *
7820 * Recursively measures the disk usage of @file.
7821 *
7822 * This is essentially an analog of the 'du' command, but it also
7823 * reports the number of directories and non-directory files encountered
7824 * (including things like symbolic links).
7825 *
7826 * By default, errors are only reported against the toplevel file
7827 * itself. Errors found while recursing are silently ignored, unless
7828 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7829 *
7830 * The returned size, @disk_usage, is in bytes and should be formatted
7831 * with g_format_size() in order to get something reasonable for showing
7832 * in a user interface.
7833 *
7834 * @progress_callback and @progress_data can be given to request
7835 * periodic progress updates while scanning. See the documentation for
7836 * #GFileMeasureProgressCallback for information about when and how the
7837 * callback will be invoked.
7838 *
7839 * Returns: %TRUE if successful, with the out parameters set.
7840 * %FALSE otherwise, with @error set.
7841 *
7842 * Since: 2.38
7843 **/
7844 gboolean
7846 GFileMeasureFlags flags,
7848 GFileMeasureProgressCallback progress_callback,
7849 gpointer progress_data,
7854 {
7862 error);
7863 }
7865 /**
7866 * g_file_measure_disk_usage_async:
7867 * @file: a #GFile
7868 * @flags: #GFileMeasureFlags
7869 * @io_priority: the [I/O priority][io-priority] of the request
7870 * @cancellable: (nullable): optional #GCancellable
7871 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7872 * @progress_data: user_data for @progress_callback
7873 * @callback: (nullable): a #GAsyncReadyCallback to call when complete
7874 * @user_data: the data to pass to callback function
7875 *
7876 * Recursively measures the disk usage of @file.
7877 *
7878 * This is the asynchronous version of g_file_measure_disk_usage(). See
7879 * there for more information.
7880 *
7881 * Since: 2.38
7882 **/
7883 void
7885 GFileMeasureFlags flags,
7886 gint io_priority,
7888 GFileMeasureProgressCallback progress_callback,
7889 gpointer progress_data,
7890 GAsyncReadyCallback callback,
7891 gpointer user_data)
7892 {
7899 }
7901 /**
7902 * g_file_measure_disk_usage_finish:
7903 * @file: a #GFile
7904 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7905 * @disk_usage: (out) (optional): the number of bytes of disk space used
7906 * @num_dirs: (out) (optional): the number of directories encountered
7907 * @num_files: (out) (optional): the number of non-directories encountered
7908 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7909 *
7910 * Collects the results from an earlier call to
7911 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7912 * more information.
7913 *
7914 * Returns: %TRUE if successful, with the out parameters set.
7915 * %FALSE otherwise, with @error set.
7916 *
7917 * Since: 2.38
7918 **/
7919 gboolean
7926 {
7930 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7931 }
7933 /**
7934 * g_file_start_mountable:
7935 * @file: input #GFile
7936 * @flags: flags affecting the operation
7937 * @start_operation: (nullable): a #GMountOperation, or %NULL to avoid user interaction
7938 * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
7939 * @callback: (nullable): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7940 * @user_data: the data to pass to callback function
7941 *
7942 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7943 * Using @start_operation, you can request callbacks when, for instance,
7944 * passwords are needed during authentication.
7945 *
7946 * If @cancellable is not %NULL, then the operation can be cancelled by
7947 * triggering the cancellable object from another thread. If the operation
7948 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7949 *
7950 * When the operation is finished, @callback will be called.
7951 * You can then call g_file_mount_mountable_finish() to get
7952 * the result of the operation.
7953 *
7954 * Since: 2.22
7955 */
7956 void
7958 GDriveStartFlags flags,
7961 GAsyncReadyCallback callback,
7962 gpointer user_data)
7963 {
7971 {
7973 g_file_start_mountable,
7977 }
7980 flags,
7981 start_operation,
7982 cancellable,
7983 callback,
7984 user_data);
7985 }
7987 /**
7988 * g_file_start_mountable_finish:
7989 * @file: input #GFile
7990 * @result: a #GAsyncResult
7991 * @error: a #GError, or %NULL
7992 *
7993 * Finishes a start operation. See g_file_start_mountable() for details.
7994 *
7995 * Finish an asynchronous start operation that was started
7996 * with g_file_start_mountable().
7997 *
7998 * Returns: %TRUE if the operation finished successfully. %FALSE
7999 * otherwise.
8000 *
8001 * Since: 2.22
8002 */
8003 gboolean
8007 {
8020 }
8022 /**
8023 * g_file_stop_mountable:
8024 * @file: input #GFile
8025 * @flags: flags affecting the operation
8026 * @mount_operation: (nullable): a #GMountOperation,
8027 * or %NULL to avoid user interaction.
8028 * @cancellable: (nullable): optional #GCancellable object,
8029 * %NULL to ignore
8030 * @callback: (nullable): a #GAsyncReadyCallback to call
8031 * when the request is satisfied, or %NULL
8032 * @user_data: the data to pass to callback function
8033 *
8034 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
8035 *
8036 * If @cancellable is not %NULL, then the operation can be cancelled by
8037 * triggering the cancellable object from another thread. If the operation
8038 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8039 *
8040 * When the operation is finished, @callback will be called.
8041 * You can then call g_file_stop_mountable_finish() to get
8042 * the result of the operation.
8043 *
8044 * Since: 2.22
8045 */
8046 void
8048 GMountUnmountFlags flags,
8051 GAsyncReadyCallback callback,
8052 gpointer user_data)
8053 {
8061 {
8063 g_file_stop_mountable,
8067 }
8070 flags,
8071 mount_operation,
8072 cancellable,
8073 callback,
8074 user_data);
8075 }
8077 /**
8078 * g_file_stop_mountable_finish:
8079 * @file: input #GFile
8080 * @result: a #GAsyncResult
8081 * @error: a #GError, or %NULL
8082 *
8083 * Finishes an stop operation, see g_file_stop_mountable() for details.
8084 *
8085 * Finish an asynchronous stop operation that was started
8086 * with g_file_stop_mountable().
8087 *
8088 * Returns: %TRUE if the operation finished successfully.
8089 * %FALSE otherwise.
8090 *
8091 * Since: 2.22
8092 */
8093 gboolean
8097 {
8110 }
8112 /**
8113 * g_file_poll_mountable:
8114 * @file: input #GFile
8115 * @cancellable: optional #GCancellable object, %NULL to ignore
8116 * @callback: (nullable): a #GAsyncReadyCallback to call
8117 * when the request is satisfied, or %NULL
8118 * @user_data: the data to pass to callback function
8119 *
8120 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
8121 *
8122 * If @cancellable is not %NULL, then the operation can be cancelled by
8123 * triggering the cancellable object from another thread. If the operation
8124 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
8125 *
8126 * When the operation is finished, @callback will be called.
8127 * You can then call g_file_mount_mountable_finish() to get
8128 * the result of the operation.
8129 *
8130 * Since: 2.22
8131 */
8132 void
8135 GAsyncReadyCallback callback,
8136 gpointer user_data)
8137 {
8145 {
8147 g_file_poll_mountable,
8151 }
8154 cancellable,
8155 callback,
8156 user_data);
8157 }
8159 /**
8160 * g_file_poll_mountable_finish:
8161 * @file: input #GFile
8162 * @result: a #GAsyncResult
8163 * @error: a #GError, or %NULL
8164 *
8165 * Finishes a poll operation. See g_file_poll_mountable() for details.
8166 *
8167 * Finish an asynchronous poll operation that was polled
8168 * with g_file_poll_mountable().
8169 *
8170 * Returns: %TRUE if the operation finished successfully. %FALSE
8171 * otherwise.
8172 *
8173 * Since: 2.22
8174 */
8175 gboolean
8179 {
8192 }
8194 /**
8195 * g_file_supports_thread_contexts:
8196 * @file: a #GFile
8197 *
8198 * Checks if @file supports
8199 * [thread-default contexts][g-main-context-push-thread-default-context].
8200 * If this returns %FALSE, you cannot perform asynchronous operations on
8201 * @file in a thread that has a thread-default context.
8202 *
8203 * Returns: Whether or not @file supports thread-default contexts.
8204 *
8205 * Since: 2.22
8206 */
8207 gboolean
8209 {
8216 }
8218 /**
8219 * g_file_load_bytes:
8220 * @file: a #GFile
8221 * @cancellable: (nullable): a #GCancellable or %NULL
8222 * @etag_out: (out) (nullable) (optional): a location to place the current
8223 * entity tag for the file, or %NULL if the entity tag is not needed
8224 * @error: a location for a #GError or %NULL
8225 *
8226 * Loads the contents of @file and returns it as #GBytes.
8227 *
8228 * If @file is a resource:// based URI, the resulting bytes will reference the
8229 * embedded resource instead of a copy. Otherwise, this is equivalent to calling
8230 * g_file_load_contents() and g_bytes_new_take().
8231 *
8232 * For resources, @etag_out will be set to %NULL.
8233 *
8234 * The data contained in the resulting #GBytes is always zero-terminated, but
8235 * this is not included in the #GBytes length. The resulting #GBytes should be
8236 * freed with g_bytes_unref() when no longer in use.
8237 *
8238 * Returns: (transfer full): a #GBytes or %NULL and @error is set
8239 *
8240 * Since: 2.56
8241 */
8242 GBytes *
8247 {
8249 gsize len;
8259 {
8271 }
8273 /* contents is guaranteed to be \0 terminated */
8278 }
8280 static void
8283 gpointer user_data)
8284 {
8297 else
8303 }
8305 /**
8306 * g_file_load_bytes_async:
8307 * @file: a #GFile
8308 * @cancellable: (nullable): a #GCancellable or %NULL
8309 * @callback: (scope async): a #GAsyncReadyCallback to call when the
8310 * request is satisfied
8311 * @user_data: (closure): the data to pass to callback function
8312 *
8313 * Asynchronously loads the contents of @file as #GBytes.
8314 *
8315 * If @file is a resource:// based URI, the resulting bytes will reference the
8316 * embedded resource instead of a copy. Otherwise, this is equivalent to calling
8317 * g_file_load_contents_async() and g_bytes_new_take().
8318 *
8319 * @callback should call g_file_load_bytes_finish() to get the result of this
8320 * asynchronous operation.
8321 *
8322 * See g_file_load_bytes() for more information.
8323 *
8324 * Since: 2.56
8325 */
8326 void
8329 GAsyncReadyCallback callback,
8330 gpointer user_data)
8331 {
8343 {
8345 cancellable,
8346 g_file_load_bytes_cb,
8349 }
8355 else
8361 }
8363 /**
8364 * g_file_load_bytes_finish:
8365 * @file: a #GFile
8366 * @result: a #GAsyncResult provided to the callback
8367 * @etag_out: (out) (nullable) (optional): a location to place the current
8368 * entity tag for the file, or %NULL if the entity tag is not needed
8369 * @error: a location for a #GError, or %NULL
8370 *
8371 * Completes an asynchronous request to g_file_load_bytes_async().
8372 *
8373 * For resources, @etag_out will be set to %NULL.
8374 *
8375 * The data contained in the resulting #GBytes is always zero-terminated, but
8376 * this is not included in the #GBytes length. The resulting #GBytes should be
8377 * freed with g_bytes_unref() when no longer in use.
8378 *
8379 * See g_file_load_bytes() for more information.
8380 *
8381 * Returns: (transfer full): a #GBytes or %NULL and @error is set
8382 *
8383 * Since: 2.56
8384 */
8385 GBytes *
8390 {
8404 }