| blob | 73b64d85b7dcfe4d2877754eb1a62c2316831792 |
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 *
85 * One way to think of a #GFile is as an abstraction of a pathname. For
86 * normal files the system pathname is what is stored internally, but as
87 * #GFiles are extensible it could also be something else that corresponds
88 * to a pathname in a userspace implementation of a filesystem.
89 *
90 * #GFiles make up hierarchies of directories and files that correspond to
91 * the files on a filesystem. You can move through the file system with
92 * #GFile using g_file_get_parent() to get an identifier for the parent
93 * directory, g_file_get_child() to get a child within a directory,
94 * g_file_resolve_relative_path() to resolve a relative path between two
95 * #GFiles. There can be multiple hierarchies, so you may not end up at
96 * the same root if you repeatedly call g_file_get_parent() on two different
97 * files.
98 *
99 * All #GFiles have a basename (get with g_file_get_basename()). These names
100 * are byte strings that are used to identify the file on the filesystem
101 * (relative to its parent directory) and there is no guarantees that they
102 * have any particular charset encoding or even make any sense at all. If
103 * you want to use filenames in a user interface you should use the display
104 * name that you can get by requesting the
105 * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info().
106 * This is guaranteed to be in UTF-8 and can be used in a user interface.
107 * But always store the real basename or the #GFile to use to actually
108 * access the file, because there is no way to go from a display name to
109 * the actual name.
110 *
111 * Using #GFile as an identifier has the same weaknesses as using a path
112 * in that there may be multiple aliases for the same file. For instance,
113 * hard or soft links may cause two different #GFiles to refer to the same
114 * file. Other possible causes for aliases are: case insensitive filesystems,
115 * short and long names on FAT/NTFS, or bind mounts in Linux. If you want to
116 * check if two #GFiles point to the same file you can query for the
117 * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial
118 * canonicalization of pathnames passed in, so that trivial differences in
119 * the path string used at creation (duplicated slashes, slash at end of
120 * path, "." or ".." path segments, etc) does not create different #GFiles.
121 *
122 * Many #GFile operations have both synchronous and asynchronous versions
123 * to suit your application. Asynchronous versions of synchronous functions
124 * simply have _async() appended to their function names. The asynchronous
125 * I/O functions call a #GAsyncReadyCallback which is then used to finalize
126 * the operation, producing a GAsyncResult which is then passed to the
127 * function's matching _finish() operation.
128 *
129 * It is highly recommended to use asynchronous calls when running within a
130 * shared main loop, such as in the main thread of an application. This avoids
131 * I/O operations blocking other sources on the main loop from being dispatched.
132 * Synchronous I/O operations should be performed from worker threads. See the
133 * [introduction to asynchronous programming section][async-programming] for
134 * more.
135 *
136 * Some #GFile operations almost always take a noticeable amount of time, and
137 * so do not have synchronous analogs. Notable cases include:
138 * - g_file_mount_mountable() to mount a mountable file.
139 * - g_file_unmount_mountable_with_operation() to unmount a mountable file.
140 * - g_file_eject_mountable_with_operation() to eject a mountable file.
141 *
142 * ## Entity Tags # {#gfile-etag}
143 *
144 * One notable feature of #GFiles are entity tags, or "etags" for
145 * short. Entity tags are somewhat like a more abstract version of the
146 * traditional mtime, and can be used to quickly determine if the file
147 * has been modified from the version on the file system. See the
148 * HTTP 1.1
149 * [specification](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
150 * for HTTP Etag headers, which are a very similar concept.
151 */
155 GFileQueryInfoFlags flags,
158 GAsyncReadyCallback callback,
159 gpointer user_data);
167 GAsyncReadyCallback callback,
168 gpointer user_data);
174 GFileQueryInfoFlags flags,
177 GAsyncReadyCallback callback,
178 gpointer user_data);
185 GAsyncReadyCallback callback,
186 gpointer user_data);
191 GFileCreateFlags flags,
194 GAsyncReadyCallback callback,
195 gpointer user_data);
200 GFileCreateFlags flags,
203 GAsyncReadyCallback callback,
204 gpointer user_data);
210 gboolean make_backup,
211 GFileCreateFlags flags,
214 GAsyncReadyCallback callback,
215 gpointer user_data);
222 GAsyncReadyCallback callback,
223 gpointer user_data);
230 GAsyncReadyCallback callback,
231 gpointer user_data);
238 GAsyncReadyCallback callback,
239 gpointer user_data);
246 GAsyncReadyCallback callback,
247 gpointer user_data);
252 GFileCreateFlags flags,
255 GAsyncReadyCallback callback,
256 gpointer user_data);
262 gboolean make_backup,
263 GFileCreateFlags flags,
266 GAsyncReadyCallback callback,
267 gpointer user_data);
273 GFileQueryInfoFlags flags,
280 GAsyncReadyCallback callback,
281 gpointer user_data);
287 GFileQueryInfoFlags flags,
290 GAsyncReadyCallback callback,
291 gpointer user_data);
299 GAsyncReadyCallback callback,
300 gpointer user_data);
306 GFileCopyFlags flags,
309 GFileProgressCallback progress_callback,
310 gpointer progress_callback_data,
311 GAsyncReadyCallback callback,
312 gpointer user_data);
318 GFileMeasureFlags flags,
320 GFileMeasureProgressCallback progress_callback,
321 gpointer progress_data,
327 GFileMeasureFlags flags,
328 gint io_priority,
330 GFileMeasureProgressCallback progress_callback,
331 gpointer progress_data,
332 GAsyncReadyCallback callback,
333 gpointer user_data);
344 static void
346 {
385 }
388 /**
389 * g_file_is_native:
390 * @file: input #GFile
391 *
392 * Checks to see if a file is native to the platform.
393 *
394 * A native file s one expressed in the platform-native filename format,
395 * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
396 * as it might be on a locally mounted remote filesystem.
397 *
398 * On some systems non-native files may be available using the native
399 * filesystem via a userspace filesystem (FUSE), in these cases this call
400 * will return %FALSE, but g_file_get_path() will still return a native path.
401 *
402 * This call does no blocking I/O.
403 *
404 * Returns: %TRUE if @file is native
405 */
406 gboolean
408 {
416 }
419 /**
420 * g_file_has_uri_scheme:
421 * @file: input #GFile
422 * @uri_scheme: a string containing a URI scheme
423 *
424 * Checks to see if a #GFile has a given URI scheme.
425 *
426 * This call does no blocking I/O.
427 *
428 * Returns: %TRUE if #GFile's backend supports the
429 * given URI scheme, %FALSE if URI scheme is %NULL,
430 * not supported, or #GFile is invalid.
431 */
432 gboolean
435 {
444 }
447 /**
448 * g_file_get_uri_scheme:
449 * @file: input #GFile
450 *
451 * Gets the URI scheme for a #GFile.
452 * RFC 3986 decodes the scheme as:
453 * |[
454 * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
455 * ]|
456 * Common schemes include "file", "http", "ftp", etc.
457 *
458 * This call does no blocking I/O.
459 *
460 * Returns: a string containing the URI scheme for the given
461 * #GFile. The returned string should be freed with g_free()
462 * when no longer needed.
463 */
466 {
474 }
477 /**
478 * g_file_get_basename:
479 * @file: input #GFile
480 *
481 * Gets the base name (the last component of the path) for a given #GFile.
482 *
483 * If called for the top level of a system (such as the filesystem root
484 * or a uri like sftp://host/) it will return a single directory separator
485 * (and on Windows, possibly a drive letter).
486 *
487 * The base name is a byte string (not UTF-8). It has no defined encoding
488 * or rules other than it may not contain zero bytes. If you want to use
489 * filenames in a user interface you should use the display name that you
490 * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME
491 * attribute with g_file_query_info().
492 *
493 * This call does no blocking I/O.
494 *
495 * Returns: (type filename) (nullable): string containing the #GFile's
496 * base name, or %NULL if given #GFile is invalid. The returned string
497 * should be freed with g_free() when no longer needed.
498 */
501 {
509 }
511 /**
512 * g_file_get_path:
513 * @file: input #GFile
514 *
515 * Gets the local pathname for #GFile, if one exists. If non-%NULL, this is
516 * guaranteed to be an absolute, canonical path. It might contain symlinks.
517 *
518 * This call does no blocking I/O.
519 *
520 * Returns: (type filename) (nullable): string containing the #GFile's path,
521 * or %NULL if no such path exists. The returned string should be freed
522 * with g_free() when no longer needed.
523 */
526 {
534 }
536 /**
537 * g_file_get_uri:
538 * @file: input #GFile
539 *
540 * Gets the URI for the @file.
541 *
542 * This call does no blocking I/O.
543 *
544 * Returns: a string containing the #GFile's URI.
545 * The returned string should be freed with g_free()
546 * when no longer needed.
547 */
550 {
558 }
560 /**
561 * g_file_get_parse_name:
562 * @file: input #GFile
563 *
564 * Gets the parse name of the @file.
565 * A parse name is a UTF-8 string that describes the
566 * file such that one can get the #GFile back using
567 * g_file_parse_name().
568 *
569 * This is generally used to show the #GFile as a nice
570 * full-pathname kind of string in a user interface,
571 * like in a location entry.
572 *
573 * For local files with names that can safely be converted
574 * to UTF-8 the pathname is used, otherwise the IRI is used
575 * (a form of URI that allows UTF-8 characters unescaped).
576 *
577 * This call does no blocking I/O.
578 *
579 * Returns: a string containing the #GFile's parse name.
580 * The returned string should be freed with g_free()
581 * when no longer needed.
582 */
585 {
593 }
595 /**
596 * g_file_dup:
597 * @file: input #GFile
598 *
599 * Duplicates a #GFile handle. This operation does not duplicate
600 * the actual file or directory represented by the #GFile; see
601 * g_file_copy() if attempting to copy a file.
602 *
603 * This call does no blocking I/O.
604 *
605 * Returns: (transfer full): a new #GFile that is a duplicate
606 * of the given #GFile.
607 */
608 GFile *
610 {
618 }
620 /**
621 * g_file_hash:
622 * @file: (type GFile): #gconstpointer to a #GFile
623 *
624 * Creates a hash value for a #GFile.
625 *
626 * This call does no blocking I/O.
627 *
628 * Virtual: hash
629 * Returns: 0 if @file is not a valid #GFile, otherwise an
630 * integer that can be used as hash value for the #GFile.
631 * This function is intended for easily hashing a #GFile to
632 * add to a #GHashTable or similar data structure.
633 */
634 guint
636 {
644 }
646 /**
647 * g_file_equal:
648 * @file1: the first #GFile
649 * @file2: the second #GFile
650 *
651 * Checks if the two given #GFiles refer to the same file.
652 *
653 * Note that two #GFiles that differ can still refer to the same
654 * file on the filesystem due to various forms of filename
655 * aliasing.
656 *
657 * This call does no blocking I/O.
658 *
659 * Returns: %TRUE if @file1 and @file2 are equal.
660 */
661 gboolean
664 {
679 }
682 /**
683 * g_file_get_parent:
684 * @file: input #GFile
685 *
686 * Gets the parent directory for the @file.
687 * If the @file represents the root directory of the
688 * file system, then %NULL will be returned.
689 *
690 * This call does no blocking I/O.
691 *
692 * Returns: (nullable) (transfer full): a #GFile structure to the
693 * parent of the given #GFile or %NULL if there is no parent. Free
694 * the returned object with g_object_unref().
695 */
696 GFile *
698 {
706 }
708 /**
709 * g_file_has_parent:
710 * @file: input #GFile
711 * @parent: (nullable): the parent to check for, or %NULL
712 *
713 * Checks if @file has a parent, and optionally, if it is @parent.
714 *
715 * If @parent is %NULL then this function returns %TRUE if @file has any
716 * parent at all. If @parent is non-%NULL then %TRUE is only returned
717 * if @file is an immediate child of @parent.
718 *
719 * Returns: %TRUE if @file is an immediate child of @parent (or any parent in
720 * the case that @parent is %NULL).
721 *
722 * Since: 2.24
723 */
724 gboolean
727 {
729 gboolean result;
737 {
740 else
744 }
745 else
749 }
751 /**
752 * g_file_get_child:
753 * @file: input #GFile
754 * @name: (type filename): string containing the child's basename
755 *
756 * Gets a child of @file with basename equal to @name.
757 *
758 * Note that the file with that specific name might not exist, but
759 * you can still have a #GFile that points to it. You can use this
760 * for instance to create that file.
761 *
762 * This call does no blocking I/O.
763 *
764 * Returns: (transfer full): a #GFile to a child specified by @name.
765 * Free the returned object with g_object_unref().
766 */
767 GFile *
770 {
775 }
777 /**
778 * g_file_get_child_for_display_name:
779 * @file: input #GFile
780 * @display_name: string to a possible child
781 * @error: return location for an error
782 *
783 * Gets the child of @file for a given @display_name (i.e. a UTF-8
784 * version of the name). If this function fails, it returns %NULL
785 * and @error will be set. This is very useful when constructing a
786 * #GFile for a new file and the user entered the filename in the
787 * user interface, for instance when you select a directory and
788 * type a filename in the file selector.
789 *
790 * This call does no blocking I/O.
791 *
792 * Returns: (transfer full): a #GFile to the specified child, or
793 * %NULL if the display name couldn't be converted.
794 * Free the returned object with g_object_unref().
795 */
796 GFile *
800 {
809 }
811 /**
812 * g_file_has_prefix:
813 * @file: input #GFile
814 * @prefix: input #GFile
815 *
816 * Checks whether @file has the prefix specified by @prefix.
817 *
818 * In other words, if the names of initial elements of @file's
819 * pathname match @prefix. Only full pathname elements are matched,
820 * so a path like /foo is not considered a prefix of /foobar, only
821 * of /foo/bar.
822 *
823 * A #GFile is not a prefix of itself. If you want to check for
824 * equality, use g_file_equal().
825 *
826 * This call does no I/O, as it works purely on names. As such it can
827 * sometimes return %FALSE even if @file is inside a @prefix (from a
828 * filesystem point of view), because the prefix of @file is an alias
829 * of @prefix.
830 *
831 * Virtual: prefix_matches
832 * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix,
833 * %FALSE otherwise.
834 */
835 gboolean
838 {
849 /* The vtable function differs in arg order since
850 * we're using the old contains_file call
851 */
853 }
855 /**
856 * g_file_get_relative_path:
857 * @parent: input #GFile
858 * @descendant: input #GFile
859 *
860 * Gets the path for @descendant relative to @parent.
861 *
862 * This call does no blocking I/O.
863 *
864 * Returns: (type filename) (nullable): string with the relative path from
865 * @descendant to @parent, or %NULL if @descendant doesn't have @parent as
866 * prefix. The returned string should be freed with g_free() when
867 * no longer needed.
868 */
872 {
884 }
886 /**
887 * g_file_resolve_relative_path:
888 * @file: input #GFile
889 * @relative_path: (type filename): a given relative path string
890 *
891 * Resolves a relative path for @file to an absolute path.
892 *
893 * This call does no blocking I/O.
894 *
895 * Returns: (transfer full): #GFile to the resolved path.
896 * %NULL if @relative_path is %NULL or if @file is invalid.
897 * Free the returned object with g_object_unref().
898 */
899 GFile *
902 {
911 }
913 /**
914 * g_file_enumerate_children:
915 * @file: input #GFile
916 * @attributes: an attribute query string
917 * @flags: a set of #GFileQueryInfoFlags
918 * @cancellable: (nullable): optional #GCancellable object,
919 * %NULL to ignore
920 * @error: #GError for error reporting
921 *
922 * Gets the requested information about the files in a directory.
923 * The result is a #GFileEnumerator object that will give out
924 * #GFileInfo objects for all the files in the directory.
925 *
926 * The @attributes value is a string that specifies the file
927 * attributes that should be gathered. It is not an error if
928 * it's not possible to read a particular requested attribute
929 * from a file - it just won't be set. @attributes should
930 * be a comma-separated list of attributes or attribute wildcards.
931 * The wildcard "*" means all attributes, and a wildcard like
932 * "standard::*" means all attributes in the standard namespace.
933 * An example attribute query be "standard::*,owner::user".
934 * The standard attributes are available as defines, like
935 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
936 *
937 * If @cancellable is not %NULL, then the operation can be cancelled
938 * by triggering the cancellable object from another thread. If the
939 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
940 * returned.
941 *
942 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
943 * be returned. If the file is not a directory, the %G_IO_ERROR_NOT_DIRECTORY
944 * error will be returned. Other errors are possible too.
945 *
946 * Returns: (transfer full): A #GFileEnumerator if successful,
947 * %NULL on error. Free the returned object with g_object_unref().
948 */
949 GFileEnumerator *
952 GFileQueryInfoFlags flags,
955 {
966 {
968 G_IO_ERROR_NOT_SUPPORTED,
971 }
975 }
977 /**
978 * g_file_enumerate_children_async:
979 * @file: input #GFile
980 * @attributes: an attribute query string
981 * @flags: a set of #GFileQueryInfoFlags
982 * @io_priority: the [I/O priority][io-priority] of the request
983 * @cancellable: (nullable): optional #GCancellable object,
984 * %NULL to ignore
985 * @callback: (scope async): a #GAsyncReadyCallback to call when the
986 * request is satisfied
987 * @user_data: (closure): the data to pass to callback function
988 *
989 * Asynchronously gets the requested information about the files
990 * in a directory. The result is a #GFileEnumerator object that will
991 * give out #GFileInfo objects for all the files in the directory.
992 *
993 * For more details, see g_file_enumerate_children() which is
994 * the synchronous version of this call.
995 *
996 * When the operation is finished, @callback will be called. You can
997 * then call g_file_enumerate_children_finish() to get the result of
998 * the operation.
999 */
1000 void
1003 GFileQueryInfoFlags flags,
1006 GAsyncReadyCallback callback,
1007 gpointer user_data)
1008 {
1015 attributes,
1016 flags,
1017 io_priority,
1018 cancellable,
1019 callback,
1020 user_data);
1021 }
1023 /**
1024 * g_file_enumerate_children_finish:
1025 * @file: input #GFile
1026 * @res: a #GAsyncResult
1027 * @error: a #GError
1028 *
1029 * Finishes an async enumerate children operation.
1030 * See g_file_enumerate_children_async().
1031 *
1032 * Returns: (transfer full): a #GFileEnumerator or %NULL
1033 * if an error occurred.
1034 * Free the returned object with g_object_unref().
1035 */
1036 GFileEnumerator *
1040 {
1051 }
1053 /**
1054 * g_file_query_exists:
1055 * @file: input #GFile
1056 * @cancellable: (nullable): optional #GCancellable object,
1057 * %NULL to ignore
1058 *
1059 * Utility function to check if a particular file exists. This is
1060 * implemented using g_file_query_info() and as such does blocking I/O.
1061 *
1062 * Note that in many cases it is racy to first check for file existence
1063 * and then execute something based on the outcome of that, because the
1064 * file might have been created or removed in between the operations. The
1065 * general approach to handling that is to not check, but just do the
1066 * operation and handle the errors as they come.
1067 *
1068 * As an example of race-free checking, take the case of reading a file,
1069 * and if it doesn't exist, creating it. There are two racy versions: read
1070 * it, and on error create it; and: check if it exists, if not create it.
1071 * These can both result in two processes creating the file (with perhaps
1072 * a partially written file as the result). The correct approach is to
1073 * always try to create the file with g_file_create() which will either
1074 * atomically create the file or fail with a %G_IO_ERROR_EXISTS error.
1075 *
1076 * However, in many cases an existence check is useful in a user interface,
1077 * for instance to make a menu item sensitive/insensitive, so that you don't
1078 * have to fool users that something is possible and then just show an error
1079 * dialog. If you do this, you should make sure to also handle the errors
1080 * that can happen due to races when you execute the operation.
1081 *
1082 * Returns: %TRUE if the file exists (and can be detected without error),
1083 * %FALSE otherwise (or if cancelled).
1084 */
1085 gboolean
1088 {
1096 {
1099 }
1102 }
1104 /**
1105 * g_file_query_file_type:
1106 * @file: input #GFile
1107 * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info()
1108 * @cancellable: (nullable): optional #GCancellable object,
1109 * %NULL to ignore
1110 *
1111 * Utility function to inspect the #GFileType of a file. This is
1112 * implemented using g_file_query_info() and as such does blocking I/O.
1113 *
1114 * The primary use case of this method is to check if a file is
1115 * a regular file, directory, or symlink.
1116 *
1117 * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN
1118 * if the file does not exist
1119 *
1120 * Since: 2.18
1121 */
1122 GFileType
1124 GFileQueryInfoFlags flags,
1126 {
1128 GFileType file_type;
1134 {
1137 }
1138 else
1142 }
1144 /**
1145 * g_file_query_info:
1146 * @file: input #GFile
1147 * @attributes: an attribute query string
1148 * @flags: a set of #GFileQueryInfoFlags
1149 * @cancellable: (nullable): optional #GCancellable object,
1150 * %NULL to ignore
1151 * @error: a #GError
1152 *
1153 * Gets the requested information about specified @file.
1154 * The result is a #GFileInfo object that contains key-value
1155 * attributes (such as the type or size of the file).
1156 *
1157 * The @attributes value is a string that specifies the file
1158 * attributes that should be gathered. It is not an error if
1159 * it's not possible to read a particular requested attribute
1160 * from a file - it just won't be set. @attributes should be a
1161 * comma-separated list of attributes or attribute wildcards.
1162 * The wildcard "*" means all attributes, and a wildcard like
1163 * "standard::*" means all attributes in the standard namespace.
1164 * An example attribute query be "standard::*,owner::user".
1165 * The standard attributes are available as defines, like
1166 * #G_FILE_ATTRIBUTE_STANDARD_NAME.
1167 *
1168 * If @cancellable is not %NULL, then the operation can be cancelled
1169 * by triggering the cancellable object from another thread. If the
1170 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1171 * returned.
1172 *
1173 * For symlinks, normally the information about the target of the
1174 * symlink is returned, rather than information about the symlink
1175 * itself. However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS
1176 * in @flags the information about the symlink itself will be returned.
1177 * Also, for symlinks that point to non-existing files the information
1178 * about the symlink itself will be returned.
1179 *
1180 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1181 * returned. Other errors are possible too, and depend on what kind of
1182 * filesystem the file is on.
1183 *
1184 * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL
1185 * on error. Free the returned object with g_object_unref().
1186 */
1187 GFileInfo *
1190 GFileQueryInfoFlags flags,
1193 {
1204 {
1206 G_IO_ERROR_NOT_SUPPORTED,
1209 }
1212 }
1214 /**
1215 * g_file_query_info_async:
1216 * @file: input #GFile
1217 * @attributes: an attribute query string
1218 * @flags: a set of #GFileQueryInfoFlags
1219 * @io_priority: the [I/O priority][io-priority] of the request
1220 * @cancellable: (nullable): optional #GCancellable object,
1221 * %NULL to ignore
1222 * @callback: (scope async): a #GAsyncReadyCallback to call when the
1223 * request is satisfied
1224 * @user_data: (closure): the data to pass to callback function
1225 *
1226 * Asynchronously gets the requested information about specified @file.
1227 * The result is a #GFileInfo object that contains key-value attributes
1228 * (such as type or size for the file).
1229 *
1230 * For more details, see g_file_query_info() which is the synchronous
1231 * version of this call.
1232 *
1233 * When the operation is finished, @callback will be called. You can
1234 * then call g_file_query_info_finish() to get the result of the operation.
1235 */
1236 void
1239 GFileQueryInfoFlags flags,
1242 GAsyncReadyCallback callback,
1243 gpointer user_data)
1244 {
1251 attributes,
1252 flags,
1253 io_priority,
1254 cancellable,
1255 callback,
1256 user_data);
1257 }
1259 /**
1260 * g_file_query_info_finish:
1261 * @file: input #GFile
1262 * @res: a #GAsyncResult
1263 * @error: a #GError
1264 *
1265 * Finishes an asynchronous file info query.
1266 * See g_file_query_info_async().
1267 *
1268 * Returns: (transfer full): #GFileInfo for given @file
1269 * or %NULL on error. Free the returned object with
1270 * g_object_unref().
1271 */
1272 GFileInfo *
1276 {
1287 }
1289 /**
1290 * g_file_query_filesystem_info:
1291 * @file: input #GFile
1292 * @attributes: an attribute query string
1293 * @cancellable: (nullable): optional #GCancellable object,
1294 * %NULL to ignore
1295 * @error: a #GError
1296 *
1297 * Similar to g_file_query_info(), but obtains information
1298 * about the filesystem the @file is on, rather than the file itself.
1299 * For instance the amount of space available and the type of
1300 * the filesystem.
1301 *
1302 * The @attributes value is a string that specifies the attributes
1303 * that should be gathered. It is not an error if it's not possible
1304 * to read a particular requested attribute from a file - it just
1305 * won't be set. @attributes should be a comma-separated list of
1306 * attributes or attribute wildcards. The wildcard "*" means all
1307 * attributes, and a wildcard like "filesystem::*" means all attributes
1308 * in the filesystem namespace. The standard namespace for filesystem
1309 * attributes is "filesystem". Common attributes of interest are
1310 * #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem
1311 * in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available),
1312 * and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem).
1313 *
1314 * If @cancellable is not %NULL, then the operation can be cancelled
1315 * by triggering the cancellable object from another thread. If the
1316 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1317 * returned.
1318 *
1319 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1320 * be returned. Other errors are possible too, and depend on what
1321 * kind of filesystem the file is on.
1322 *
1323 * Returns: (transfer full): a #GFileInfo or %NULL if there was an error.
1324 * Free the returned object with g_object_unref().
1325 */
1326 GFileInfo *
1331 {
1342 {
1344 G_IO_ERROR_NOT_SUPPORTED,
1347 }
1350 }
1352 /**
1353 * g_file_query_filesystem_info_async:
1354 * @file: input #GFile
1355 * @attributes: an attribute query string
1356 * @io_priority: the [I/O priority][io-priority] of the request
1357 * @cancellable: (nullable): optional #GCancellable object,
1358 * %NULL to ignore
1359 * @callback: (scope async): a #GAsyncReadyCallback to call
1360 * when the request is satisfied
1361 * @user_data: (closure): the data to pass to callback function
1362 *
1363 * Asynchronously gets the requested information about the filesystem
1364 * that the specified @file is on. The result is a #GFileInfo object
1365 * that contains key-value attributes (such as type or size for the
1366 * file).
1367 *
1368 * For more details, see g_file_query_filesystem_info() which is the
1369 * synchronous version of this call.
1370 *
1371 * When the operation is finished, @callback will be called. You can
1372 * then call g_file_query_info_finish() to get the result of the
1373 * operation.
1374 */
1375 void
1380 GAsyncReadyCallback callback,
1381 gpointer user_data)
1382 {
1389 attributes,
1390 io_priority,
1391 cancellable,
1392 callback,
1393 user_data);
1394 }
1396 /**
1397 * g_file_query_filesystem_info_finish:
1398 * @file: input #GFile
1399 * @res: a #GAsyncResult
1400 * @error: a #GError
1401 *
1402 * Finishes an asynchronous filesystem info query.
1403 * See g_file_query_filesystem_info_async().
1404 *
1405 * Returns: (transfer full): #GFileInfo for given @file
1406 * or %NULL on error.
1407 * Free the returned object with g_object_unref().
1408 */
1409 GFileInfo *
1413 {
1424 }
1426 /**
1427 * g_file_find_enclosing_mount:
1428 * @file: input #GFile
1429 * @cancellable: (nullable): optional #GCancellable object,
1430 * %NULL to ignore
1431 * @error: a #GError
1432 *
1433 * Gets a #GMount for the #GFile.
1434 *
1435 * If the #GFileIface for @file does not have a mount (e.g.
1436 * possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND
1437 * and %NULL will be returned.
1438 *
1439 * If @cancellable is not %NULL, then the operation can be cancelled by
1440 * triggering the cancellable object from another thread. If the operation
1441 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1442 *
1443 * Returns: (transfer full): a #GMount where the @file is located
1444 * or %NULL on error.
1445 * Free the returned object with g_object_unref().
1446 */
1447 GMount *
1451 {
1461 {
1464 /* Translators: This is an error message when
1465 * trying to find the enclosing (user visible)
1466 * mount of a file, but none exists.
1467 */
1470 }
1473 }
1475 /**
1476 * g_file_find_enclosing_mount_async:
1477 * @file: a #GFile
1478 * @io_priority: the [I/O priority][io-priority] of the request
1479 * @cancellable: (nullable): optional #GCancellable object,
1480 * %NULL to ignore
1481 * @callback: (scope async): a #GAsyncReadyCallback to call
1482 * when the request is satisfied
1483 * @user_data: (closure): the data to pass to callback function
1484 *
1485 * Asynchronously gets the mount for the file.
1486 *
1487 * For more details, see g_file_find_enclosing_mount() which is
1488 * the synchronous version of this call.
1489 *
1490 * When the operation is finished, @callback will be called.
1491 * You can then call g_file_find_enclosing_mount_finish() to
1492 * get the result of the operation.
1493 */
1494 void
1498 GAsyncReadyCallback callback,
1499 gpointer user_data)
1500 {
1507 io_priority,
1508 cancellable,
1509 callback,
1510 user_data);
1511 }
1513 /**
1514 * g_file_find_enclosing_mount_finish:
1515 * @file: a #GFile
1516 * @res: a #GAsyncResult
1517 * @error: a #GError
1518 *
1519 * Finishes an asynchronous find mount request.
1520 * See g_file_find_enclosing_mount_async().
1521 *
1522 * Returns: (transfer full): #GMount for given @file or %NULL on error.
1523 * Free the returned object with g_object_unref().
1524 */
1525 GMount *
1529 {
1540 }
1543 /**
1544 * g_file_read:
1545 * @file: #GFile to read
1546 * @cancellable: (nullable): a #GCancellable
1547 * @error: a #GError, or %NULL
1548 *
1549 * Opens a file for reading. The result is a #GFileInputStream that
1550 * can be used to read the contents of the file.
1551 *
1552 * If @cancellable is not %NULL, then the operation can be cancelled by
1553 * triggering the cancellable object from another thread. If the operation
1554 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
1555 *
1556 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be
1557 * returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1558 * error will be returned. Other errors are possible too, and depend
1559 * on what kind of filesystem the file is on.
1560 *
1561 * Virtual: read_fn
1562 * Returns: (transfer full): #GFileInputStream or %NULL on error.
1563 * Free the returned object with g_object_unref().
1564 */
1565 GFileInputStream *
1569 {
1580 {
1582 G_IO_ERROR_NOT_SUPPORTED,
1585 }
1588 }
1590 /**
1591 * g_file_append_to:
1592 * @file: input #GFile
1593 * @flags: a set of #GFileCreateFlags
1594 * @cancellable: (nullable): optional #GCancellable object,
1595 * %NULL to ignore
1596 * @error: a #GError, or %NULL
1597 *
1598 * Gets an output stream for appending data to the file.
1599 * If the file doesn't already exist it is created.
1600 *
1601 * By default files created are generally readable by everyone,
1602 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1603 * will be made readable only to the current user, to the level that
1604 * is supported on the target filesystem.
1605 *
1606 * If @cancellable is not %NULL, then the operation can be cancelled
1607 * by triggering the cancellable object from another thread. If the
1608 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1609 * returned.
1610 *
1611 * Some file systems don't allow all file names, and may return an
1612 * %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the
1613 * %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are
1614 * possible too, and depend on what kind of filesystem the file is on.
1615 *
1616 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
1617 * Free the returned object with g_object_unref().
1618 */
1619 GFileOutputStream *
1621 GFileCreateFlags flags,
1624 {
1635 {
1637 G_IO_ERROR_NOT_SUPPORTED,
1640 }
1643 }
1645 /**
1646 * g_file_create:
1647 * @file: input #GFile
1648 * @flags: a set of #GFileCreateFlags
1649 * @cancellable: (nullable): optional #GCancellable object,
1650 * %NULL to ignore
1651 * @error: a #GError, or %NULL
1652 *
1653 * Creates a new file and returns an output stream for writing to it.
1654 * The file must not already exist.
1655 *
1656 * By default files created are generally readable by everyone,
1657 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1658 * will be made readable only to the current user, to the level
1659 * that is supported on the target filesystem.
1660 *
1661 * If @cancellable is not %NULL, then the operation can be cancelled
1662 * by triggering the cancellable object from another thread. If the
1663 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1664 * returned.
1665 *
1666 * If a file or directory with this name already exists the
1667 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1668 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1669 * error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will
1670 * be returned. Other errors are possible too, and depend on what kind
1671 * of filesystem the file is on.
1672 *
1673 * Returns: (transfer full): a #GFileOutputStream for the newly created
1674 * file, or %NULL on error.
1675 * Free the returned object with g_object_unref().
1676 */
1677 GFileOutputStream *
1679 GFileCreateFlags flags,
1682 {
1693 {
1695 G_IO_ERROR_NOT_SUPPORTED,
1698 }
1701 }
1703 /**
1704 * g_file_replace:
1705 * @file: input #GFile
1706 * @etag: (nullable): an optional [entity tag][gfile-etag]
1707 * for the current #GFile, or #NULL to ignore
1708 * @make_backup: %TRUE if a backup should be created
1709 * @flags: a set of #GFileCreateFlags
1710 * @cancellable: (nullable): optional #GCancellable object,
1711 * %NULL to ignore
1712 * @error: a #GError, or %NULL
1713 *
1714 * Returns an output stream for overwriting the file, possibly
1715 * creating a backup copy of the file first. If the file doesn't exist,
1716 * it will be created.
1717 *
1718 * This will try to replace the file in the safest way possible so
1719 * that any errors during the writing will not affect an already
1720 * existing copy of the file. For instance, for local files it
1721 * may write to a temporary file and then atomically rename over
1722 * the destination when the stream is closed.
1723 *
1724 * By default files created are generally readable by everyone,
1725 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1726 * will be made readable only to the current user, to the level that
1727 * is supported on the target filesystem.
1728 *
1729 * If @cancellable is not %NULL, then the operation can be cancelled
1730 * by triggering the cancellable object from another thread. If the
1731 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1732 * returned.
1733 *
1734 * If you pass in a non-%NULL @etag value and @file already exists, then
1735 * this value is compared to the current entity tag of the file, and if
1736 * they differ an %G_IO_ERROR_WRONG_ETAG error is returned. This
1737 * generally means that the file has been changed since you last read
1738 * it. You can get the new etag from g_file_output_stream_get_etag()
1739 * after you've finished writing and closed the #GFileOutputStream. When
1740 * you load a new file you can use g_file_input_stream_query_info() to
1741 * get the etag of the file.
1742 *
1743 * If @make_backup is %TRUE, this function will attempt to make a
1744 * backup of the current file before overwriting it. If this fails
1745 * a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you
1746 * want to replace anyway, try again with @make_backup set to %FALSE.
1747 *
1748 * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will
1749 * be returned, and if the file is some other form of non-regular file
1750 * then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some
1751 * file systems don't allow all file names, and may return an
1752 * %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long
1753 * %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are
1754 * possible too, and depend on what kind of filesystem the file is on.
1755 *
1756 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
1757 * Free the returned object with g_object_unref().
1758 */
1759 GFileOutputStream *
1762 gboolean make_backup,
1763 GFileCreateFlags flags,
1766 {
1777 {
1779 G_IO_ERROR_NOT_SUPPORTED,
1782 }
1784 /* Handle empty tag string as NULL in consistent way. */
1789 }
1791 /**
1792 * g_file_open_readwrite:
1793 * @file: #GFile to open
1794 * @cancellable: (nullable): a #GCancellable
1795 * @error: a #GError, or %NULL
1796 *
1797 * Opens an existing file for reading and writing. The result is
1798 * a #GFileIOStream that can be used to read and write the contents
1799 * of the file.
1800 *
1801 * If @cancellable is not %NULL, then the operation can be cancelled
1802 * by triggering the cancellable object from another thread. If the
1803 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1804 * returned.
1805 *
1806 * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will
1807 * be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY
1808 * error will be returned. Other errors are possible too, and depend on
1809 * what kind of filesystem the file is on. Note that in many non-local
1810 * file cases read and write streams are not supported, so make sure you
1811 * really need to do read and write streaming, rather than just opening
1812 * for reading or writing.
1813 *
1814 * Returns: (transfer full): #GFileIOStream or %NULL on error.
1815 * Free the returned object with g_object_unref().
1816 *
1817 * Since: 2.22
1818 */
1819 GFileIOStream *
1823 {
1834 {
1836 G_IO_ERROR_NOT_SUPPORTED,
1839 }
1842 }
1844 /**
1845 * g_file_create_readwrite:
1846 * @file: a #GFile
1847 * @flags: a set of #GFileCreateFlags
1848 * @cancellable: (nullable): optional #GCancellable object,
1849 * %NULL to ignore
1850 * @error: return location for a #GError, or %NULL
1851 *
1852 * Creates a new file and returns a stream for reading and
1853 * writing to it. The file must not already exist.
1854 *
1855 * By default files created are generally readable by everyone,
1856 * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file
1857 * will be made readable only to the current user, to the level
1858 * that is supported on the target filesystem.
1859 *
1860 * If @cancellable is not %NULL, then the operation can be cancelled
1861 * by triggering the cancellable object from another thread. If the
1862 * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be
1863 * returned.
1864 *
1865 * If a file or directory with this name already exists, the
1866 * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't
1867 * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME
1868 * error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG
1869 * will be returned. Other errors are possible too, and depend on what
1870 * kind of filesystem the file is on.
1871 *
1872 * Note that in many non-local file cases read and write streams are
1873 * not supported, so make sure you really need to do read and write
1874 * streaming, rather than just opening for reading or writing.
1875 *
1876 * Returns: (transfer full): a #GFileIOStream for the newly created
1877 * file, or %NULL on error.
1878 * Free the returned object with g_object_unref().
1879 *
1880 * Since: 2.22
1881 */
1882 GFileIOStream *
1884 GFileCreateFlags flags,
1887 {
1898 {
1900 G_IO_ERROR_NOT_SUPPORTED,
1903 }
1906 }
1908 /**
1909 * g_file_replace_readwrite:
1910 * @file: a #GFile
1911 * @etag: (nullable): an optional [entity tag][gfile-etag]
1912 * for the current #GFile, or #NULL to ignore
1913 * @make_backup: %TRUE if a backup should be created
1914 * @flags: a set of #GFileCreateFlags
1915 * @cancellable: (nullable): optional #GCancellable object,
1916 * %NULL to ignore
1917 * @error: return location for a #GError, or %NULL
1918 *
1919 * Returns an output stream for overwriting the file in readwrite mode,
1920 * possibly creating a backup copy of the file first. If the file doesn't
1921 * exist, it will be created.
1922 *
1923 * For details about the behaviour, see g_file_replace() which does the
1924 * same thing but returns an output stream only.
1925 *
1926 * Note that in many non-local file cases read and write streams are not
1927 * supported, so make sure you really need to do read and write streaming,
1928 * rather than just opening for reading or writing.
1929 *
1930 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
1931 * Free the returned object with g_object_unref().
1932 *
1933 * Since: 2.22
1934 */
1935 GFileIOStream *
1938 gboolean make_backup,
1939 GFileCreateFlags flags,
1942 {
1953 {
1955 G_IO_ERROR_NOT_SUPPORTED,
1958 }
1961 }
1963 /**
1964 * g_file_read_async:
1965 * @file: input #GFile
1966 * @io_priority: the [I/O priority][io-priority] of the request
1967 * @cancellable: (nullable): optional #GCancellable object,
1968 * %NULL to ignore
1969 * @callback: (scope async): a #GAsyncReadyCallback to call
1970 * when the request is satisfied
1971 * @user_data: (closure): the data to pass to callback function
1972 *
1973 * Asynchronously opens @file for reading.
1974 *
1975 * For more details, see g_file_read() which is
1976 * the synchronous version of this call.
1977 *
1978 * When the operation is finished, @callback will be called.
1979 * You can then call g_file_read_finish() to get the result
1980 * of the operation.
1981 */
1982 void
1986 GAsyncReadyCallback callback,
1987 gpointer user_data)
1988 {
1995 io_priority,
1996 cancellable,
1997 callback,
1998 user_data);
1999 }
2001 /**
2002 * g_file_read_finish:
2003 * @file: input #GFile
2004 * @res: a #GAsyncResult
2005 * @error: a #GError, or %NULL
2006 *
2007 * Finishes an asynchronous file read operation started with
2008 * g_file_read_async().
2009 *
2010 * Returns: (transfer full): a #GFileInputStream or %NULL on error.
2011 * Free the returned object with g_object_unref().
2012 */
2013 GFileInputStream *
2017 {
2028 }
2030 /**
2031 * g_file_append_to_async:
2032 * @file: input #GFile
2033 * @flags: a set of #GFileCreateFlags
2034 * @io_priority: the [I/O priority][io-priority] of the request
2035 * @cancellable: (nullable): optional #GCancellable object,
2036 * %NULL to ignore
2037 * @callback: (scope async): a #GAsyncReadyCallback to call
2038 * when the request is satisfied
2039 * @user_data: (closure): the data to pass to callback function
2040 *
2041 * Asynchronously opens @file for appending.
2042 *
2043 * For more details, see g_file_append_to() which is
2044 * the synchronous version of this call.
2045 *
2046 * When the operation is finished, @callback will be called.
2047 * You can then call g_file_append_to_finish() to get the result
2048 * of the operation.
2049 */
2050 void
2052 GFileCreateFlags flags,
2055 GAsyncReadyCallback callback,
2056 gpointer user_data)
2057 {
2064 flags,
2065 io_priority,
2066 cancellable,
2067 callback,
2068 user_data);
2069 }
2071 /**
2072 * g_file_append_to_finish:
2073 * @file: input #GFile
2074 * @res: #GAsyncResult
2075 * @error: a #GError, or %NULL
2076 *
2077 * Finishes an asynchronous file append operation started with
2078 * g_file_append_to_async().
2079 *
2080 * Returns: (transfer full): a valid #GFileOutputStream
2081 * or %NULL on error.
2082 * Free the returned object with g_object_unref().
2083 */
2084 GFileOutputStream *
2088 {
2099 }
2101 /**
2102 * g_file_create_async:
2103 * @file: input #GFile
2104 * @flags: a set of #GFileCreateFlags
2105 * @io_priority: the [I/O priority][io-priority] of the request
2106 * @cancellable: (nullable): optional #GCancellable object,
2107 * %NULL to ignore
2108 * @callback: (scope async): a #GAsyncReadyCallback to call
2109 * when the request is satisfied
2110 * @user_data: (closure): the data to pass to callback function
2111 *
2112 * Asynchronously creates a new file and returns an output stream
2113 * for writing to it. The file must not already exist.
2114 *
2115 * For more details, see g_file_create() which is
2116 * the synchronous version of this call.
2117 *
2118 * When the operation is finished, @callback will be called.
2119 * You can then call g_file_create_finish() to get the result
2120 * of the operation.
2121 */
2122 void
2124 GFileCreateFlags flags,
2127 GAsyncReadyCallback callback,
2128 gpointer user_data)
2129 {
2136 flags,
2137 io_priority,
2138 cancellable,
2139 callback,
2140 user_data);
2141 }
2143 /**
2144 * g_file_create_finish:
2145 * @file: input #GFile
2146 * @res: a #GAsyncResult
2147 * @error: a #GError, or %NULL
2148 *
2149 * Finishes an asynchronous file create operation started with
2150 * g_file_create_async().
2151 *
2152 * Returns: (transfer full): a #GFileOutputStream or %NULL on error.
2153 * Free the returned object with g_object_unref().
2154 */
2155 GFileOutputStream *
2159 {
2170 }
2172 /**
2173 * g_file_replace_async:
2174 * @file: input #GFile
2175 * @etag: (nullable): an [entity tag][gfile-etag] for the current #GFile,
2176 * or %NULL to ignore
2177 * @make_backup: %TRUE if a backup should be created
2178 * @flags: a set of #GFileCreateFlags
2179 * @io_priority: the [I/O priority][io-priority] of the request
2180 * @cancellable: (nullable): optional #GCancellable object,
2181 * %NULL to ignore
2182 * @callback: (scope async): a #GAsyncReadyCallback to call
2183 * when the request is satisfied
2184 * @user_data: (closure): the data to pass to callback function
2185 *
2186 * Asynchronously overwrites the file, replacing the contents,
2187 * possibly creating a backup copy of the file first.
2188 *
2189 * For more details, see g_file_replace() which is
2190 * the synchronous version of this call.
2191 *
2192 * When the operation is finished, @callback will be called.
2193 * You can then call g_file_replace_finish() to get the result
2194 * of the operation.
2195 */
2196 void
2199 gboolean make_backup,
2200 GFileCreateFlags flags,
2203 GAsyncReadyCallback callback,
2204 gpointer user_data)
2205 {
2212 etag,
2213 make_backup,
2214 flags,
2215 io_priority,
2216 cancellable,
2217 callback,
2218 user_data);
2219 }
2221 /**
2222 * g_file_replace_finish:
2223 * @file: input #GFile
2224 * @res: a #GAsyncResult
2225 * @error: a #GError, or %NULL
2226 *
2227 * Finishes an asynchronous file replace operation started with
2228 * g_file_replace_async().
2229 *
2230 * Returns: (transfer full): a #GFileOutputStream, or %NULL on error.
2231 * Free the returned object with g_object_unref().
2232 */
2233 GFileOutputStream *
2237 {
2248 }
2250 /**
2251 * g_file_open_readwrite_async
2252 * @file: input #GFile
2253 * @io_priority: the [I/O priority][io-priority] of the request
2254 * @cancellable: (nullable): optional #GCancellable object,
2255 * %NULL to ignore
2256 * @callback: (scope async): a #GAsyncReadyCallback to call
2257 * when the request is satisfied
2258 * @user_data: (closure): the data to pass to callback function
2259 *
2260 * Asynchronously opens @file for reading and writing.
2261 *
2262 * For more details, see g_file_open_readwrite() which is
2263 * the synchronous version of this call.
2264 *
2265 * When the operation is finished, @callback will be called.
2266 * You can then call g_file_open_readwrite_finish() to get
2267 * the result of the operation.
2268 *
2269 * Since: 2.22
2270 */
2271 void
2275 GAsyncReadyCallback callback,
2276 gpointer user_data)
2277 {
2284 io_priority,
2285 cancellable,
2286 callback,
2287 user_data);
2288 }
2290 /**
2291 * g_file_open_readwrite_finish:
2292 * @file: input #GFile
2293 * @res: a #GAsyncResult
2294 * @error: a #GError, or %NULL
2295 *
2296 * Finishes an asynchronous file read operation started with
2297 * g_file_open_readwrite_async().
2298 *
2299 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2300 * Free the returned object with g_object_unref().
2301 *
2302 * Since: 2.22
2303 */
2304 GFileIOStream *
2308 {
2319 }
2321 /**
2322 * g_file_create_readwrite_async:
2323 * @file: input #GFile
2324 * @flags: a set of #GFileCreateFlags
2325 * @io_priority: the [I/O priority][io-priority] of the request
2326 * @cancellable: (nullable): optional #GCancellable object,
2327 * %NULL to ignore
2328 * @callback: (scope async): a #GAsyncReadyCallback to call
2329 * when the request is satisfied
2330 * @user_data: (closure): the data to pass to callback function
2331 *
2332 * Asynchronously creates a new file and returns a stream
2333 * for reading and writing to it. The file must not already exist.
2334 *
2335 * For more details, see g_file_create_readwrite() which is
2336 * the synchronous version of this call.
2337 *
2338 * When the operation is finished, @callback will be called.
2339 * You can then call g_file_create_readwrite_finish() to get
2340 * the result of the operation.
2341 *
2342 * Since: 2.22
2343 */
2344 void
2346 GFileCreateFlags flags,
2349 GAsyncReadyCallback callback,
2350 gpointer user_data)
2351 {
2358 flags,
2359 io_priority,
2360 cancellable,
2361 callback,
2362 user_data);
2363 }
2365 /**
2366 * g_file_create_readwrite_finish:
2367 * @file: input #GFile
2368 * @res: a #GAsyncResult
2369 * @error: a #GError, or %NULL
2370 *
2371 * Finishes an asynchronous file create operation started with
2372 * g_file_create_readwrite_async().
2373 *
2374 * Returns: (transfer full): a #GFileIOStream or %NULL on error.
2375 * Free the returned object with g_object_unref().
2376 *
2377 * Since: 2.22
2378 */
2379 GFileIOStream *
2383 {
2394 }
2396 /**
2397 * g_file_replace_readwrite_async:
2398 * @file: input #GFile
2399 * @etag: (nullable): an [entity tag][gfile-etag] for the current #GFile,
2400 * or %NULL to ignore
2401 * @make_backup: %TRUE if a backup should be created
2402 * @flags: a set of #GFileCreateFlags
2403 * @io_priority: the [I/O priority][io-priority] of the request
2404 * @cancellable: (nullable): optional #GCancellable object,
2405 * %NULL to ignore
2406 * @callback: (scope async): a #GAsyncReadyCallback to call
2407 * when the request is satisfied
2408 * @user_data: (closure): the data to pass to callback function
2409 *
2410 * Asynchronously overwrites the file in read-write mode,
2411 * replacing the contents, possibly creating a backup copy
2412 * of the file first.
2413 *
2414 * For more details, see g_file_replace_readwrite() which is
2415 * the synchronous version of this call.
2416 *
2417 * When the operation is finished, @callback will be called.
2418 * You can then call g_file_replace_readwrite_finish() to get
2419 * the result of the operation.
2420 *
2421 * Since: 2.22
2422 */
2423 void
2426 gboolean make_backup,
2427 GFileCreateFlags flags,
2430 GAsyncReadyCallback callback,
2431 gpointer user_data)
2432 {
2439 etag,
2440 make_backup,
2441 flags,
2442 io_priority,
2443 cancellable,
2444 callback,
2445 user_data);
2446 }
2448 /**
2449 * g_file_replace_readwrite_finish:
2450 * @file: input #GFile
2451 * @res: a #GAsyncResult
2452 * @error: a #GError, or %NULL
2453 *
2454 * Finishes an asynchronous file replace operation started with
2455 * g_file_replace_readwrite_async().
2456 *
2457 * Returns: (transfer full): a #GFileIOStream, or %NULL on error.
2458 * Free the returned object with g_object_unref().
2459 *
2460 * Since: 2.22
2461 */
2462 GFileIOStream *
2466 {
2477 }
2479 static gboolean
2481 GFileCopyFlags flags,
2485 {
2487 gboolean tried_delete;
2489 GFileType file_type;
2493 retry:
2496 {
2497 /* Maybe it already existed, and we want to overwrite? */
2500 {
2503 /* Don't overwrite if the destination is a directory */
2505 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2508 {
2513 {
2517 }
2518 }
2525 }
2526 /* Nah, fail */
2529 }
2532 }
2537 GFileCopyFlags flags,
2540 {
2544 GFileType file_type;
2551 /* There was an error opening the source, try to set a good error for it: */
2553 {
2554 /* The source is a directory, don't fail with WOULD_RECURSE immediately,
2555 * as that is less useful to the app. Better check for errors on the
2556 * target instead.
2557 */
2562 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2566 {
2571 {
2573 {
2577 }
2578 /* continue to would_recurse error */
2579 }
2580 else
2581 {
2585 }
2586 }
2587 else
2588 {
2589 /* Error getting info from target, return that error
2590 * (except for NOT_FOUND, which is no error here)
2591 */
2594 {
2597 }
2599 }
2604 }
2608 }
2610 static gboolean
2612 gboolean copy_all_attributes,
2613 gboolean skip_perms)
2614 {
2621 }
2623 static gboolean
2625 GFileCopyFlags flags,
2629 {
2633 gboolean first;
2635 gboolean copy_all_attributes;
2636 gboolean skip_perms;
2641 /* Ignore errors here, if the target supports no attributes there is
2642 * nothing to copy. We still honor the cancellable though.
2643 */
2659 {
2661 {
2663 {
2666 else
2670 }
2671 }
2672 }
2675 {
2677 {
2679 {
2682 else
2687 }
2688 }
2689 }
2694 out:
2703 }
2705 /**
2706 * g_file_copy_attributes:
2707 * @source: a #GFile with attributes
2708 * @destination: a #GFile to copy attributes to
2709 * @flags: a set of #GFileCopyFlags
2710 * @cancellable: (nullable): optional #GCancellable object,
2711 * %NULL to ignore
2712 * @error: a #GError, %NULL to ignore
2713 *
2714 * Copies the file attributes from @source to @destination.
2715 *
2716 * Normally only a subset of the file attributes are copied,
2717 * those that are copies in a normal file copy operation
2718 * (which for instance does not include e.g. owner). However
2719 * if #G_FILE_COPY_ALL_METADATA is specified in @flags, then
2720 * all the metadata that is possible to copy is copied. This
2721 * is useful when implementing move by copy + delete source.
2722 *
2723 * Returns: %TRUE if the attributes were copied successfully,
2724 * %FALSE otherwise.
2725 */
2726 gboolean
2729 GFileCopyFlags flags,
2732 {
2734 gboolean res;
2736 gboolean source_nofollow_symlinks;
2744 /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist)
2745 * we just don't copy it.
2746 */
2749 cancellable,
2750 NULL);
2756 {
2758 info,
2759 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
2760 cancellable,
2761 error);
2763 }
2766 }
2768 /* 256k minus malloc overhead */
2769 #define STREAM_BUFFER_SIZE (1024*256 - 2 *sizeof(gpointer))
2771 static gboolean
2776 GFileProgressCallback progress_callback,
2777 gpointer progress_callback_data,
2779 {
2781 goffset current_size;
2783 gboolean res;
2784 goffset total_size;
2788 /* avoid performance impact of querying total size when it's not needed */
2790 {
2792 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2795 {
2799 }
2802 {
2804 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2805 G_FILE_QUERY_INFO_NONE,
2808 {
2812 }
2813 }
2814 }
2823 {
2826 {
2829 }
2838 {
2841 {
2844 }
2848 }
2855 }
2858 /* Make sure we send full copied size */
2863 }
2865 #ifdef HAVE_SPLICE
2867 static gboolean
2875 {
2878 retry:
2882 {
2890 else
2897 }
2901 }
2903 static gboolean
2907 GFileProgressCallback progress_callback,
2908 gpointer progress_callback_data,
2910 {
2912 gboolean res;
2913 goffset total_size;
2914 loff_t offset_in;
2915 loff_t offset_out;
2925 /* avoid performance impact of querying total size when it's not needed */
2927 {
2932 }
2940 {
2951 {
2954 }
2957 {
2965 }
2969 }
2971 /* Make sure we send full copied size */
2981 out:
2988 }
2989 #endif
2991 #ifdef __linux__
2992 static gboolean
2997 GFileProgressCallback progress_callback,
2998 gpointer progress_callback_data,
3000 {
3001 goffset source_size;
3011 /* Btrfs clone ioctl properties:
3012 * - Works at the inode level
3013 * - Doesn't work with directories
3014 * - Always follows symlinks (source and destination)
3015 *
3016 * By the time we get here, *in and *out are both regular files */
3020 {
3023 G_IO_ERROR_NOT_SUPPORTED,
3027 G_IO_ERROR_NOT_SUPPORTED,
3029 else
3030 /* Most probably something odd happened; retry with fallback */
3032 G_IO_ERROR_NOT_SUPPORTED,
3034 /* We retry with fallback for all error cases because Btrfs is currently
3035 * unstable, and so we can't trust it to do clone properly.
3036 * In addition, any hard errors here would cause the same failure in the
3037 * fallback manual copy as well. */
3039 }
3041 /* Make sure we send full copied size */
3046 }
3047 #endif
3049 static gboolean
3052 GFileCopyFlags flags,
3054 GFileProgressCallback progress_callback,
3055 gpointer progress_callback_data,
3057 {
3067 /* need to know the file type */
3070 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3071 cancellable,
3072 error);
3076 /* Maybe copy the symlink? */
3079 {
3082 {
3088 }
3089 /* ... else fall back on a regular file copy */
3090 }
3091 /* Handle "special" files (pipes, device nodes, ...)? */
3093 {
3094 /* FIXME: could try to recreate device nodes and others? */
3098 }
3100 /* Everything else should just fall back on a regular copy. */
3112 {
3115 /* Ok, ditch the previous lightweight info (on Unix we just
3116 * called lstat()); at this point we gather all the information
3117 * we need about the source from the opened file descriptor.
3118 */
3124 {
3125 /* Not all gvfs backends implement query_info_on_read(), we
3126 * can just fall back to the pathname again.
3127 * https://bugzilla.gnome.org/706254
3128 */
3130 {
3134 }
3135 else
3136 {
3140 }
3141 }
3147 }
3149 /* In the local file path, we pass down the source info which
3150 * includes things like unix::mode, to ensure that the target file
3151 * is not created with different permissions from the source file.
3152 *
3153 * If a future API like g_file_replace_with_info() is added, switch
3154 * this code to use that.
3155 */
3157 {
3159 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3162 G_FILE_CREATE_REPLACE_DESTINATION,
3163 info,
3165 else
3166 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3169 }
3171 {
3173 NULL,
3175 G_FILE_CREATE_REPLACE_DESTINATION,
3177 }
3178 else
3179 {
3181 }
3186 #ifdef __linux__
3188 {
3194 {
3196 {
3198 }
3199 else
3200 {
3203 }
3204 }
3205 else
3206 {
3209 }
3210 }
3211 #endif
3213 #ifdef HAVE_SPLICE
3215 {
3221 {
3223 {
3225 }
3226 else
3227 {
3230 }
3231 }
3232 else
3233 {
3236 }
3237 }
3239 #endif
3241 /* A plain read/write loop */
3244 error))
3248 out:
3250 {
3251 /* Don't care about errors in source here */
3254 }
3257 {
3258 /* But write errors on close are bad! */
3262 }
3264 /* Ignore errors here. Failure to copy metadata is not a hard error */
3265 /* TODO: set these attributes /before/ we do the rename() on Unix */
3267 {
3269 info,
3270 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3271 cancellable,
3272 NULL);
3273 }
3278 }
3280 /**
3281 * g_file_copy:
3282 * @source: input #GFile
3283 * @destination: destination #GFile
3284 * @flags: set of #GFileCopyFlags
3285 * @cancellable: (nullable): optional #GCancellable object,
3286 * %NULL to ignore
3287 * @progress_callback: (nullable) (scope call): function to callback with
3288 * progress information, or %NULL if progress information is not needed
3289 * @progress_callback_data: (closure): user data to pass to @progress_callback
3290 * @error: #GError to set on error, or %NULL
3291 *
3292 * Copies the file @source to the location specified by @destination.
3293 * Can not handle recursive copies of directories.
3294 *
3295 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3296 * existing @destination file is overwritten.
3297 *
3298 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3299 * will be copied as symlinks, otherwise the target of the
3300 * @source symlink will be copied.
3301 *
3302 * If @cancellable is not %NULL, then the operation can be cancelled by
3303 * triggering the cancellable object from another thread. If the operation
3304 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3305 *
3306 * If @progress_callback is not %NULL, then the operation can be monitored
3307 * by setting this to a #GFileProgressCallback function.
3308 * @progress_callback_data will be passed to this function. It is guaranteed
3309 * that this callback will be called after all data has been transferred with
3310 * the total number of bytes copied during the operation.
3311 *
3312 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3313 * is returned, independent on the status of the @destination.
3314 *
3315 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3316 * the error %G_IO_ERROR_EXISTS is returned.
3317 *
3318 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3319 * error is returned. If trying to overwrite a directory with a directory the
3320 * %G_IO_ERROR_WOULD_MERGE error is returned.
3321 *
3322 * If the source is a directory and the target does not exist, or
3323 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3324 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3325 *
3326 * If you are interested in copying the #GFile object itself (not the on-disk
3327 * file), see g_file_dup().
3328 *
3329 * Returns: %TRUE on success, %FALSE otherwise.
3330 */
3331 gboolean
3334 GFileCopyFlags flags,
3336 GFileProgressCallback progress_callback,
3337 gpointer progress_callback_data,
3339 {
3342 gboolean res;
3352 {
3363 {
3366 }
3367 else
3369 }
3371 /* If the types are different, and the destination method failed
3372 * also try the source method
3373 */
3375 {
3379 {
3390 {
3393 }
3394 else
3396 }
3397 }
3401 error);
3402 }
3404 /**
3405 * g_file_copy_async: (skip)
3406 * @source: input #GFile
3407 * @destination: destination #GFile
3408 * @flags: set of #GFileCopyFlags
3409 * @io_priority: the [I/O priority][io-priority] of the request
3410 * @cancellable: (nullable): optional #GCancellable object,
3411 * %NULL to ignore
3412 * @progress_callback: (nullable): function to callback with progress
3413 * information, or %NULL if progress information is not needed
3414 * @progress_callback_data: (closure): user data to pass to @progress_callback
3415 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3416 * @user_data: the data to pass to callback function
3417 *
3418 * Copies the file @source to the location specified by @destination
3419 * asynchronously. For details of the behaviour, see g_file_copy().
3420 *
3421 * If @progress_callback is not %NULL, then that function that will be called
3422 * just like in g_file_copy(). The callback will run in the default main context
3423 * of the thread calling g_file_copy_async() — the same context as @callback is
3424 * run in.
3425 *
3426 * When the operation is finished, @callback will be called. You can then call
3427 * g_file_copy_finish() to get the result of the operation.
3428 */
3429 void
3432 GFileCopyFlags flags,
3435 GFileProgressCallback progress_callback,
3436 gpointer progress_callback_data,
3437 GAsyncReadyCallback callback,
3438 gpointer user_data)
3439 {
3447 destination,
3448 flags,
3449 io_priority,
3450 cancellable,
3451 progress_callback,
3452 progress_callback_data,
3453 callback,
3454 user_data);
3455 }
3457 /**
3458 * g_file_copy_finish:
3459 * @file: input #GFile
3460 * @res: a #GAsyncResult
3461 * @error: a #GError, or %NULL
3462 *
3463 * Finishes copying the file started with g_file_copy_async().
3464 *
3465 * Returns: a %TRUE on success, %FALSE on error.
3466 */
3467 gboolean
3471 {
3482 }
3484 /**
3485 * g_file_move:
3486 * @source: #GFile pointing to the source location
3487 * @destination: #GFile pointing to the destination location
3488 * @flags: set of #GFileCopyFlags
3489 * @cancellable: (nullable): optional #GCancellable object,
3490 * %NULL to ignore
3491 * @progress_callback: (nullable) (scope call): #GFileProgressCallback
3492 * function for updates
3493 * @progress_callback_data: (closure): gpointer to user data for
3494 * the callback function
3495 * @error: #GError for returning error conditions, or %NULL
3496 *
3497 * Tries to move the file or directory @source to the location specified
3498 * by @destination. If native move operations are supported then this is
3499 * used, otherwise a copy + delete fallback is used. The native
3500 * implementation may support moving directories (for instance on moves
3501 * inside the same filesystem), but the fallback code does not.
3502 *
3503 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3504 * existing @destination file is overwritten.
3505 *
3506 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3507 * will be copied as symlinks, otherwise the target of the
3508 * @source symlink will be copied.
3509 *
3510 * If @cancellable is not %NULL, then the operation can be cancelled by
3511 * triggering the cancellable object from another thread. If the operation
3512 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3513 *
3514 * If @progress_callback is not %NULL, then the operation can be monitored
3515 * by setting this to a #GFileProgressCallback function.
3516 * @progress_callback_data will be passed to this function. It is
3517 * guaranteed that this callback will be called after all data has been
3518 * transferred with the total number of bytes copied during the operation.
3519 *
3520 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3521 * error is returned, independent on the status of the @destination.
3522 *
3523 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3524 * then the error %G_IO_ERROR_EXISTS is returned.
3525 *
3526 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3527 * error is returned. If trying to overwrite a directory with a directory the
3528 * %G_IO_ERROR_WOULD_MERGE error is returned.
3529 *
3530 * If the source is a directory and the target does not exist, or
3531 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3532 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3533 * move operation isn't available).
3534 *
3535 * Returns: %TRUE on successful move, %FALSE otherwise.
3536 */
3537 gboolean
3540 GFileCopyFlags flags,
3542 GFileProgressCallback progress_callback,
3543 gpointer progress_callback_data,
3545 {
3548 gboolean res;
3558 {
3569 {
3572 }
3573 else
3575 }
3577 /* If the types are different, and the destination method failed
3578 * also try the source method
3579 */
3581 {
3585 {
3596 {
3599 }
3600 else
3602 }
3603 }
3606 {
3608 G_IO_ERROR_NOT_SUPPORTED,
3611 }
3616 error))
3620 }
3622 /**
3623 * g_file_make_directory:
3624 * @file: input #GFile
3625 * @cancellable: (nullable): optional #GCancellable object,
3626 * %NULL to ignore
3627 * @error: a #GError, or %NULL
3628 *
3629 * Creates a directory. Note that this will only create a child directory
3630 * of the immediate parent directory of the path or URI given by the #GFile.
3631 * To recursively create directories, see g_file_make_directory_with_parents().
3632 * This function will fail if the parent directory does not exist, setting
3633 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3634 * creating directories, this function will fail, setting @error to
3635 * %G_IO_ERROR_NOT_SUPPORTED.
3636 *
3637 * For a local #GFile the newly created directory will have the default
3638 * (current) ownership and permissions of the current process.
3639 *
3640 * If @cancellable is not %NULL, then the operation can be cancelled by
3641 * triggering the cancellable object from another thread. If the operation
3642 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3643 *
3644 * Returns: %TRUE on successful creation, %FALSE otherwise.
3645 */
3646 gboolean
3650 {
3661 {
3663 G_IO_ERROR_NOT_SUPPORTED,
3666 }
3669 }
3671 /**
3672 * g_file_make_directory_async:
3673 * @file: input #GFile
3674 * @io_priority: the [I/O priority][io-priority] of the request
3675 * @cancellable: (nullable): optional #GCancellable object,
3676 * %NULL to ignore
3677 * @callback: a #GAsyncReadyCallback to call
3678 * when the request is satisfied
3679 * @user_data: the data to pass to callback function
3680 *
3681 * Asynchronously creates a directory.
3682 *
3683 * Virtual: make_directory_async
3684 * Since: 2.38
3685 */
3686 void
3690 GAsyncReadyCallback callback,
3691 gpointer user_data)
3692 {
3699 io_priority,
3700 cancellable,
3701 callback,
3702 user_data);
3703 }
3705 /**
3706 * g_file_make_directory_finish:
3707 * @file: input #GFile
3708 * @result: a #GAsyncResult
3709 * @error: a #GError, or %NULL
3710 *
3711 * Finishes an asynchronous directory creation, started with
3712 * g_file_make_directory_async().
3713 *
3714 * Virtual: make_directory_finish
3715 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3716 * Since: 2.38
3717 */
3718 gboolean
3722 {
3730 }
3732 /**
3733 * g_file_make_directory_with_parents:
3734 * @file: input #GFile
3735 * @cancellable: (nullable): optional #GCancellable object,
3736 * %NULL to ignore
3737 * @error: a #GError, or %NULL
3738 *
3739 * Creates a directory and any parent directories that may not
3740 * exist similar to 'mkdir -p'. If the file system does not support
3741 * creating directories, this function will fail, setting @error to
3742 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3743 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3744 * the similar g_mkdir_with_parents().
3745 *
3746 * For a local #GFile the newly created directories will have the default
3747 * (current) ownership and permissions of the current process.
3748 *
3749 * If @cancellable is not %NULL, then the operation can be cancelled by
3750 * triggering the cancellable object from another thread. If the operation
3751 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3752 *
3753 * Returns: %TRUE if all directories have been successfully created, %FALSE
3754 * otherwise.
3755 *
3756 * Since: 2.18
3757 */
3758 gboolean
3762 {
3772 /* Try for the simple case of not having to create any parent
3773 * directories. If any parent directory needs to be created, this
3774 * call will fail with NOT_FOUND. If that happens, then that value of
3775 * my_error persists into the while loop below.
3776 */
3779 {
3783 }
3787 /* Creates the parent directories as needed. In case any particular
3788 * creation operation fails for lack of other parent directories
3789 * (NOT_FOUND), the directory is added to a list of directories to
3790 * create later, and the value of my_error is retained until the next
3791 * iteration of the loop. After the loop my_error should either be
3792 * empty or contain a real failure condition.
3793 */
3795 {
3804 /* Another process may have created the directory in between the
3805 * G_IO_ERROR_NOT_FOUND and now
3806 */
3815 else
3817 }
3819 /* All directories should be able to be created now, so an error at
3820 * this point means the whole operation must fail -- except an EXISTS
3821 * error, which means that another process already created the
3822 * directory in between the previous failure and now.
3823 */
3825 {
3829 }
3834 /* Clean up */
3836 {
3839 }
3841 /* At this point an error in my_error means a that something
3842 * unexpected failed in either of the loops above, so the whole
3843 * operation must fail.
3844 */
3846 {
3849 }
3852 }
3854 /**
3855 * g_file_make_symbolic_link:
3856 * @file: a #GFile with the name of the symlink to create
3857 * @symlink_value: (type filename): a string with the path for the target
3858 * of the new symlink
3859 * @cancellable: (nullable): optional #GCancellable object,
3860 * %NULL to ignore
3861 * @error: a #GError
3862 *
3863 * Creates a symbolic link named @file which contains the string
3864 * @symlink_value.
3865 *
3866 * If @cancellable is not %NULL, then the operation can be cancelled by
3867 * triggering the cancellable object from another thread. If the operation
3868 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3869 *
3870 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3871 */
3872 gboolean
3877 {
3887 {
3889 G_IO_ERROR_INVALID_ARGUMENT,
3892 }
3897 {
3899 G_IO_ERROR_NOT_SUPPORTED,
3902 }
3905 }
3907 /**
3908 * g_file_delete:
3909 * @file: input #GFile
3910 * @cancellable: (nullable): optional #GCancellable object,
3911 * %NULL to ignore
3912 * @error: a #GError, or %NULL
3913 *
3914 * Deletes a file. If the @file is a directory, it will only be
3915 * deleted if it is empty. This has the same semantics as g_unlink().
3916 *
3917 * If @cancellable is not %NULL, then the operation can be cancelled by
3918 * triggering the cancellable object from another thread. If the operation
3919 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3920 *
3921 * Virtual: delete_file
3922 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3923 */
3924 gboolean
3928 {
3939 {
3941 G_IO_ERROR_NOT_SUPPORTED,
3944 }
3947 }
3949 /**
3950 * g_file_delete_async:
3951 * @file: input #GFile
3952 * @io_priority: the [I/O priority][io-priority] of the request
3953 * @cancellable: (nullable): optional #GCancellable object,
3954 * %NULL to ignore
3955 * @callback: a #GAsyncReadyCallback to call
3956 * when the request is satisfied
3957 * @user_data: the data to pass to callback function
3958 *
3959 * Asynchronously delete a file. If the @file is a directory, it will
3960 * only be deleted if it is empty. This has the same semantics as
3961 * g_unlink().
3962 *
3963 * Virtual: delete_file_async
3964 * Since: 2.34
3965 */
3966 void
3970 GAsyncReadyCallback callback,
3971 gpointer user_data)
3972 {
3979 io_priority,
3980 cancellable,
3981 callback,
3982 user_data);
3983 }
3985 /**
3986 * g_file_delete_finish:
3987 * @file: input #GFile
3988 * @result: a #GAsyncResult
3989 * @error: a #GError, or %NULL
3990 *
3991 * Finishes deleting a file started with g_file_delete_async().
3992 *
3993 * Virtual: delete_file_finish
3994 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3995 * Since: 2.34
3996 **/
3997 gboolean
4001 {
4012 }
4014 /**
4015 * g_file_trash:
4016 * @file: #GFile to send to trash
4017 * @cancellable: (nullable): optional #GCancellable object,
4018 * %NULL to ignore
4019 * @error: a #GError, or %NULL
4020 *
4021 * Sends @file to the "Trashcan", if possible. This is similar to
4022 * deleting it, but the user can recover it before emptying the trashcan.
4023 * Not all file systems support trashing, so this call can return the
4024 * %G_IO_ERROR_NOT_SUPPORTED error.
4025 *
4026 * If @cancellable is not %NULL, then the operation can be cancelled by
4027 * triggering the cancellable object from another thread. If the operation
4028 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4029 *
4030 * Virtual: trash
4031 * Returns: %TRUE on successful trash, %FALSE otherwise.
4032 */
4033 gboolean
4037 {
4048 {
4053 }
4056 }
4058 /**
4059 * g_file_trash_async:
4060 * @file: input #GFile
4061 * @io_priority: the [I/O priority][io-priority] of the request
4062 * @cancellable: (nullable): optional #GCancellable object,
4063 * %NULL to ignore
4064 * @callback: a #GAsyncReadyCallback to call
4065 * when the request is satisfied
4066 * @user_data: the data to pass to callback function
4067 *
4068 * Asynchronously sends @file to the Trash location, if possible.
4069 *
4070 * Virtual: trash_async
4071 * Since: 2.38
4072 */
4073 void
4077 GAsyncReadyCallback callback,
4078 gpointer user_data)
4079 {
4086 io_priority,
4087 cancellable,
4088 callback,
4089 user_data);
4090 }
4092 /**
4093 * g_file_trash_finish:
4094 * @file: input #GFile
4095 * @result: a #GAsyncResult
4096 * @error: a #GError, or %NULL
4097 *
4098 * Finishes an asynchronous file trashing operation, started with
4099 * g_file_trash_async().
4100 *
4101 * Virtual: trash_finish
4102 * Returns: %TRUE on successful trash, %FALSE otherwise.
4103 * Since: 2.38
4104 */
4105 gboolean
4109 {
4117 }
4119 /**
4120 * g_file_set_display_name:
4121 * @file: input #GFile
4122 * @display_name: a string
4123 * @cancellable: (nullable): optional #GCancellable object,
4124 * %NULL to ignore
4125 * @error: a #GError, or %NULL
4126 *
4127 * Renames @file to the specified display name.
4128 *
4129 * The display name is converted from UTF-8 to the correct encoding
4130 * for the target filesystem if possible and the @file is renamed to this.
4131 *
4132 * If you want to implement a rename operation in the user interface the
4133 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4134 * initial value in the rename widget, and then the result after editing
4135 * should be passed to g_file_set_display_name().
4136 *
4137 * On success the resulting converted filename is returned.
4138 *
4139 * If @cancellable is not %NULL, then the operation can be cancelled by
4140 * triggering the cancellable object from another thread. If the operation
4141 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4142 *
4143 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4144 * or %NULL if there was an error.
4145 * Free the returned object with g_object_unref().
4146 */
4147 GFile *
4152 {
4159 {
4161 G_IO_ERROR,
4162 G_IO_ERROR_INVALID_ARGUMENT,
4165 }
4173 }
4175 /**
4176 * g_file_set_display_name_async:
4177 * @file: input #GFile
4178 * @display_name: a string
4179 * @io_priority: the [I/O priority][io-priority] of the request
4180 * @cancellable: (nullable): optional #GCancellable object,
4181 * %NULL to ignore
4182 * @callback: (scope async): a #GAsyncReadyCallback to call
4183 * when the request is satisfied
4184 * @user_data: (closure): the data to pass to callback function
4185 *
4186 * Asynchronously sets the display name for a given #GFile.
4187 *
4188 * For more details, see g_file_set_display_name() which is
4189 * the synchronous version of this call.
4190 *
4191 * When the operation is finished, @callback will be called.
4192 * You can then call g_file_set_display_name_finish() to get
4193 * the result of the operation.
4194 */
4195 void
4198 gint io_priority,
4200 GAsyncReadyCallback callback,
4201 gpointer user_data)
4202 {
4210 display_name,
4211 io_priority,
4212 cancellable,
4213 callback,
4214 user_data);
4215 }
4217 /**
4218 * g_file_set_display_name_finish:
4219 * @file: input #GFile
4220 * @res: a #GAsyncResult
4221 * @error: a #GError, or %NULL
4222 *
4223 * Finishes setting a display name started with
4224 * g_file_set_display_name_async().
4225 *
4226 * Returns: (transfer full): a #GFile or %NULL on error.
4227 * Free the returned object with g_object_unref().
4228 */
4229 GFile *
4233 {
4244 }
4246 /**
4247 * g_file_query_settable_attributes:
4248 * @file: input #GFile
4249 * @cancellable: (nullable): optional #GCancellable object,
4250 * %NULL to ignore
4251 * @error: a #GError, or %NULL
4252 *
4253 * Obtain the list of settable attributes for the file.
4254 *
4255 * Returns the type and full attribute name of all the attributes
4256 * that can be set on this file. This doesn't mean setting it will
4257 * always succeed though, you might get an access failure, or some
4258 * specific file may not support a specific attribute.
4259 *
4260 * If @cancellable is not %NULL, then the operation can be cancelled by
4261 * triggering the cancellable object from another thread. If the operation
4262 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4263 *
4264 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4265 * When you are done with it, release it with
4266 * g_file_attribute_info_list_unref()
4267 */
4268 GFileAttributeInfoList *
4272 {
4291 {
4293 {
4296 }
4297 else
4299 }
4302 }
4304 /**
4305 * g_file_query_writable_namespaces:
4306 * @file: input #GFile
4307 * @cancellable: (nullable): optional #GCancellable object,
4308 * %NULL to ignore
4309 * @error: a #GError, or %NULL
4310 *
4311 * Obtain the list of attribute namespaces where new attributes
4312 * can be created by a user. An example of this is extended
4313 * attributes (in the "xattr" namespace).
4314 *
4315 * If @cancellable is not %NULL, then the operation can be cancelled by
4316 * triggering the cancellable object from another thread. If the operation
4317 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4318 *
4319 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4320 * When you are done with it, release it with
4321 * g_file_attribute_info_list_unref()
4322 */
4323 GFileAttributeInfoList *
4327 {
4346 {
4349 }
4352 {
4354 {
4356 }
4357 else
4359 }
4362 }
4364 /**
4365 * g_file_set_attribute:
4366 * @file: input #GFile
4367 * @attribute: a string containing the attribute's name
4368 * @type: The type of the attribute
4369 * @value_p: (nullable): a pointer to the value (or the pointer
4370 * itself if the type is a pointer type)
4371 * @flags: a set of #GFileQueryInfoFlags
4372 * @cancellable: (nullable): optional #GCancellable object,
4373 * %NULL to ignore
4374 * @error: a #GError, or %NULL
4375 *
4376 * Sets an attribute in the file with attribute name @attribute to @value.
4377 *
4378 * Some attributes can be unset by setting @attribute to
4379 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4380 *
4381 * If @cancellable is not %NULL, then the operation can be cancelled by
4382 * triggering the cancellable object from another thread. If the operation
4383 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4384 *
4385 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4386 */
4387 gboolean
4390 GFileAttributeType type,
4391 gpointer value_p,
4392 GFileQueryInfoFlags flags,
4395 {
4407 {
4409 G_IO_ERROR_NOT_SUPPORTED,
4412 }
4415 }
4417 /**
4418 * g_file_set_attributes_from_info:
4419 * @file: input #GFile
4420 * @info: a #GFileInfo
4421 * @flags: #GFileQueryInfoFlags
4422 * @cancellable: (nullable): optional #GCancellable object,
4423 * %NULL to ignore
4424 * @error: a #GError, or %NULL
4425 *
4426 * Tries to set all attributes in the #GFileInfo on the target
4427 * values, not stopping on the first error.
4428 *
4429 * If there is any error during this operation then @error will
4430 * be set to the first error. Error on particular fields are flagged
4431 * by setting the "status" field in the attribute value to
4432 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4433 * also detect further errors.
4434 *
4435 * If @cancellable is not %NULL, then the operation can be cancelled by
4436 * triggering the cancellable object from another thread. If the operation
4437 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4438 *
4439 * Returns: %FALSE if there was any error, %TRUE otherwise.
4440 */
4441 gboolean
4444 GFileQueryInfoFlags flags,
4447 {
4461 info,
4462 flags,
4463 cancellable,
4464 error);
4465 }
4467 static gboolean
4470 GFileQueryInfoFlags flags,
4473 {
4476 gboolean res;
4484 {
4493 {
4496 /* Don't set error multiple times */
4498 }
4499 else
4501 }
4506 }
4508 /**
4509 * g_file_set_attributes_async:
4510 * @file: input #GFile
4511 * @info: a #GFileInfo
4512 * @flags: a #GFileQueryInfoFlags
4513 * @io_priority: the [I/O priority][io-priority] of the request
4514 * @cancellable: (nullable): optional #GCancellable object,
4515 * %NULL to ignore
4516 * @callback: (scope async): a #GAsyncReadyCallback
4517 * @user_data: (closure): a #gpointer
4518 *
4519 * Asynchronously sets the attributes of @file with @info.
4520 *
4521 * For more details, see g_file_set_attributes_from_info(),
4522 * which is the synchronous version of this call.
4523 *
4524 * When the operation is finished, @callback will be called.
4525 * You can then call g_file_set_attributes_finish() to get
4526 * the result of the operation.
4527 */
4528 void
4531 GFileQueryInfoFlags flags,
4534 GAsyncReadyCallback callback,
4535 gpointer user_data)
4536 {
4544 info,
4545 flags,
4546 io_priority,
4547 cancellable,
4548 callback,
4549 user_data);
4550 }
4552 /**
4553 * g_file_set_attributes_finish:
4554 * @file: input #GFile
4555 * @result: a #GAsyncResult
4556 * @info: (out) (transfer full): a #GFileInfo
4557 * @error: a #GError, or %NULL
4558 *
4559 * Finishes setting an attribute started in g_file_set_attributes_async().
4560 *
4561 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4562 */
4563 gboolean
4568 {
4574 /* No standard handling of errors here, as we must set info even
4575 * on errors
4576 */
4579 }
4581 /**
4582 * g_file_set_attribute_string:
4583 * @file: input #GFile
4584 * @attribute: a string containing the attribute's name
4585 * @value: a string containing the attribute's value
4586 * @flags: #GFileQueryInfoFlags
4587 * @cancellable: (nullable): optional #GCancellable object,
4588 * %NULL to ignore
4589 * @error: a #GError, or %NULL
4590 *
4591 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4592 * If @attribute is of a different type, this operation will fail.
4593 *
4594 * If @cancellable is not %NULL, then the operation can be cancelled by
4595 * triggering the cancellable object from another thread. If the operation
4596 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4597 *
4598 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4599 */
4600 gboolean
4604 GFileQueryInfoFlags flags,
4607 {
4611 }
4613 /**
4614 * g_file_set_attribute_byte_string:
4615 * @file: input #GFile
4616 * @attribute: a string containing the attribute's name
4617 * @value: a string containing the attribute's new value
4618 * @flags: a #GFileQueryInfoFlags
4619 * @cancellable: (nullable): optional #GCancellable object,
4620 * %NULL to ignore
4621 * @error: a #GError, or %NULL
4622 *
4623 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4624 * If @attribute is of a different type, this operation will fail,
4625 * returning %FALSE.
4626 *
4627 * If @cancellable is not %NULL, then the operation can be cancelled by
4628 * triggering the cancellable object from another thread. If the operation
4629 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4630 *
4631 * Returns: %TRUE if the @attribute was successfully set to @value
4632 * in the @file, %FALSE otherwise.
4633 */
4634 gboolean
4638 GFileQueryInfoFlags flags,
4641 {
4645 }
4647 /**
4648 * g_file_set_attribute_uint32:
4649 * @file: input #GFile
4650 * @attribute: a string containing the attribute's name
4651 * @value: a #guint32 containing the attribute's new value
4652 * @flags: a #GFileQueryInfoFlags
4653 * @cancellable: (nullable): optional #GCancellable object,
4654 * %NULL to ignore
4655 * @error: a #GError, or %NULL
4656 *
4657 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4658 * If @attribute is of a different type, this operation will fail.
4659 *
4660 * If @cancellable is not %NULL, then the operation can be cancelled by
4661 * triggering the cancellable object from another thread. If the operation
4662 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4663 *
4664 * Returns: %TRUE if the @attribute was successfully set to @value
4665 * in the @file, %FALSE otherwise.
4666 */
4667 gboolean
4670 guint32 value,
4671 GFileQueryInfoFlags flags,
4674 {
4678 }
4680 /**
4681 * g_file_set_attribute_int32:
4682 * @file: input #GFile
4683 * @attribute: a string containing the attribute's name
4684 * @value: a #gint32 containing the attribute's new value
4685 * @flags: a #GFileQueryInfoFlags
4686 * @cancellable: (nullable): optional #GCancellable object,
4687 * %NULL to ignore
4688 * @error: a #GError, or %NULL
4689 *
4690 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4691 * If @attribute is of a different type, this operation will fail.
4692 *
4693 * If @cancellable is not %NULL, then the operation can be cancelled by
4694 * triggering the cancellable object from another thread. If the operation
4695 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4696 *
4697 * Returns: %TRUE if the @attribute was successfully set to @value
4698 * in the @file, %FALSE otherwise.
4699 */
4700 gboolean
4703 gint32 value,
4704 GFileQueryInfoFlags flags,
4707 {
4711 }
4713 /**
4714 * g_file_set_attribute_uint64:
4715 * @file: input #GFile
4716 * @attribute: a string containing the attribute's name
4717 * @value: a #guint64 containing the attribute's new value
4718 * @flags: a #GFileQueryInfoFlags
4719 * @cancellable: (nullable): optional #GCancellable object,
4720 * %NULL to ignore
4721 * @error: a #GError, or %NULL
4722 *
4723 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4724 * If @attribute is of a different type, this operation will fail.
4725 *
4726 * If @cancellable is not %NULL, then the operation can be cancelled by
4727 * triggering the cancellable object from another thread. If the operation
4728 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4729 *
4730 * Returns: %TRUE if the @attribute was successfully set to @value
4731 * in the @file, %FALSE otherwise.
4732 */
4733 gboolean
4736 guint64 value,
4737 GFileQueryInfoFlags flags,
4740 {
4744 }
4746 /**
4747 * g_file_set_attribute_int64:
4748 * @file: input #GFile
4749 * @attribute: a string containing the attribute's name
4750 * @value: a #guint64 containing the attribute's new value
4751 * @flags: a #GFileQueryInfoFlags
4752 * @cancellable: (nullable): optional #GCancellable object,
4753 * %NULL to ignore
4754 * @error: a #GError, or %NULL
4755 *
4756 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4757 * If @attribute is of a different type, this operation will fail.
4758 *
4759 * If @cancellable is not %NULL, then the operation can be cancelled by
4760 * triggering the cancellable object from another thread. If the operation
4761 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4762 *
4763 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4764 */
4765 gboolean
4768 gint64 value,
4769 GFileQueryInfoFlags flags,
4772 {
4776 }
4778 /**
4779 * g_file_mount_mountable:
4780 * @file: input #GFile
4781 * @flags: flags affecting the operation
4782 * @mount_operation: (nullable): a #GMountOperation,
4783 * or %NULL to avoid user interaction
4784 * @cancellable: (nullable): optional #GCancellable object,
4785 * %NULL to ignore
4786 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4787 * when the request is satisfied, or %NULL
4788 * @user_data: (closure): the data to pass to callback function
4789 *
4790 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4791 * Using @mount_operation, you can request callbacks when, for instance,
4792 * passwords are needed during authentication.
4793 *
4794 * If @cancellable is not %NULL, then the operation can be cancelled by
4795 * triggering the cancellable object from another thread. If the operation
4796 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4797 *
4798 * When the operation is finished, @callback will be called.
4799 * You can then call g_file_mount_mountable_finish() to get
4800 * the result of the operation.
4801 */
4802 void
4804 GMountMountFlags flags,
4807 GAsyncReadyCallback callback,
4808 gpointer user_data)
4809 {
4817 {
4819 g_file_mount_mountable,
4823 }
4826 flags,
4827 mount_operation,
4828 cancellable,
4829 callback,
4830 user_data);
4831 }
4833 /**
4834 * g_file_mount_mountable_finish:
4835 * @file: input #GFile
4836 * @result: a #GAsyncResult
4837 * @error: a #GError, or %NULL
4838 *
4839 * Finishes a mount operation. See g_file_mount_mountable() for details.
4840 *
4841 * Finish an asynchronous mount operation that was started
4842 * with g_file_mount_mountable().
4843 *
4844 * Returns: (transfer full): a #GFile or %NULL on error.
4845 * Free the returned object with g_object_unref().
4846 */
4847 GFile *
4851 {
4864 }
4866 /**
4867 * g_file_unmount_mountable:
4868 * @file: input #GFile
4869 * @flags: flags affecting the operation
4870 * @cancellable: (nullable): optional #GCancellable object,
4871 * %NULL to ignore
4872 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4873 * when the request is satisfied, or %NULL
4874 * @user_data: (closure): the data to pass to callback function
4875 *
4876 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4877 *
4878 * If @cancellable is not %NULL, then the operation can be cancelled by
4879 * triggering the cancellable object from another thread. If the operation
4880 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4881 *
4882 * When the operation is finished, @callback will be called.
4883 * You can then call g_file_unmount_mountable_finish() to get
4884 * the result of the operation.
4885 *
4886 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4887 */
4888 void
4890 GMountUnmountFlags flags,
4892 GAsyncReadyCallback callback,
4893 gpointer user_data)
4894 {
4902 {
4904 g_file_unmount_mountable_with_operation,
4908 }
4911 flags,
4912 cancellable,
4913 callback,
4914 user_data);
4915 }
4917 /**
4918 * g_file_unmount_mountable_finish:
4919 * @file: input #GFile
4920 * @result: a #GAsyncResult
4921 * @error: a #GError, or %NULL
4922 *
4923 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4924 *
4925 * Finish an asynchronous unmount operation that was started
4926 * with g_file_unmount_mountable().
4927 *
4928 * Returns: %TRUE if the operation finished successfully.
4929 * %FALSE otherwise.
4930 *
4931 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
4932 * instead.
4933 */
4934 gboolean
4938 {
4951 }
4953 /**
4954 * g_file_unmount_mountable_with_operation:
4955 * @file: input #GFile
4956 * @flags: flags affecting the operation
4957 * @mount_operation: (nullable): a #GMountOperation,
4958 * or %NULL to avoid user interaction
4959 * @cancellable: (nullable): optional #GCancellable object,
4960 * %NULL to ignore
4961 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4962 * when the request is satisfied, or %NULL
4963 * @user_data: (closure): the data to pass to callback function
4964 *
4965 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
4966 *
4967 * If @cancellable is not %NULL, then the operation can be cancelled by
4968 * triggering the cancellable object from another thread. If the operation
4969 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4970 *
4971 * When the operation is finished, @callback will be called.
4972 * You can then call g_file_unmount_mountable_finish() to get
4973 * the result of the operation.
4974 *
4975 * Since: 2.22
4976 */
4977 void
4979 GMountUnmountFlags flags,
4982 GAsyncReadyCallback callback,
4983 gpointer user_data)
4984 {
4992 {
4994 g_file_unmount_mountable_with_operation,
4998 }
5002 flags,
5003 mount_operation,
5004 cancellable,
5005 callback,
5006 user_data);
5007 else
5009 flags,
5010 cancellable,
5011 callback,
5012 user_data);
5013 }
5015 /**
5016 * g_file_unmount_mountable_with_operation_finish:
5017 * @file: input #GFile
5018 * @result: a #GAsyncResult
5019 * @error: a #GError, or %NULL
5020 *
5021 * Finishes an unmount operation,
5022 * see g_file_unmount_mountable_with_operation() for details.
5023 *
5024 * Finish an asynchronous unmount operation that was started
5025 * with g_file_unmount_mountable_with_operation().
5026 *
5027 * Returns: %TRUE if the operation finished successfully.
5028 * %FALSE otherwise.
5029 *
5030 * Since: 2.22
5031 */
5032 gboolean
5036 {
5050 else
5052 }
5054 /**
5055 * g_file_eject_mountable:
5056 * @file: input #GFile
5057 * @flags: flags affecting the operation
5058 * @cancellable: (nullable): optional #GCancellable object,
5059 * %NULL to ignore
5060 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5061 * when the request is satisfied, or %NULL
5062 * @user_data: (closure): the data to pass to callback function
5063 *
5064 * Starts an asynchronous eject on a mountable.
5065 * When this operation has completed, @callback will be called with
5066 * @user_user data, and the operation can be finalized with
5067 * g_file_eject_mountable_finish().
5068 *
5069 * If @cancellable is not %NULL, then the operation can be cancelled by
5070 * triggering the cancellable object from another thread. If the operation
5071 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5072 *
5073 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5074 */
5075 void
5077 GMountUnmountFlags flags,
5079 GAsyncReadyCallback callback,
5080 gpointer user_data)
5081 {
5089 {
5091 g_file_eject_mountable_with_operation,
5095 }
5098 flags,
5099 cancellable,
5100 callback,
5101 user_data);
5102 }
5104 /**
5105 * g_file_eject_mountable_finish:
5106 * @file: input #GFile
5107 * @result: a #GAsyncResult
5108 * @error: a #GError, or %NULL
5109 *
5110 * Finishes an asynchronous eject operation started by
5111 * g_file_eject_mountable().
5112 *
5113 * Returns: %TRUE if the @file was ejected successfully.
5114 * %FALSE otherwise.
5115 *
5116 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5117 * instead.
5118 */
5119 gboolean
5123 {
5136 }
5138 /**
5139 * g_file_eject_mountable_with_operation:
5140 * @file: input #GFile
5141 * @flags: flags affecting the operation
5142 * @mount_operation: (nullable): a #GMountOperation,
5143 * or %NULL to avoid user interaction
5144 * @cancellable: (nullable): optional #GCancellable object,
5145 * %NULL to ignore
5146 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5147 * when the request is satisfied, or %NULL
5148 * @user_data: (closure): the data to pass to callback function
5149 *
5150 * Starts an asynchronous eject on a mountable.
5151 * When this operation has completed, @callback will be called with
5152 * @user_user data, and the operation can be finalized with
5153 * g_file_eject_mountable_with_operation_finish().
5154 *
5155 * If @cancellable is not %NULL, then the operation can be cancelled by
5156 * triggering the cancellable object from another thread. If the operation
5157 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5158 *
5159 * Since: 2.22
5160 */
5161 void
5163 GMountUnmountFlags flags,
5166 GAsyncReadyCallback callback,
5167 gpointer user_data)
5168 {
5176 {
5178 g_file_eject_mountable_with_operation,
5182 }
5186 flags,
5187 mount_operation,
5188 cancellable,
5189 callback,
5190 user_data);
5191 else
5193 flags,
5194 cancellable,
5195 callback,
5196 user_data);
5197 }
5199 /**
5200 * g_file_eject_mountable_with_operation_finish:
5201 * @file: input #GFile
5202 * @result: a #GAsyncResult
5203 * @error: a #GError, or %NULL
5204 *
5205 * Finishes an asynchronous eject operation started by
5206 * g_file_eject_mountable_with_operation().
5207 *
5208 * Returns: %TRUE if the @file was ejected successfully.
5209 * %FALSE otherwise.
5210 *
5211 * Since: 2.22
5212 */
5213 gboolean
5217 {
5231 else
5233 }
5235 /**
5236 * g_file_monitor_directory:
5237 * @file: input #GFile
5238 * @flags: a set of #GFileMonitorFlags
5239 * @cancellable: (nullable): optional #GCancellable object,
5240 * %NULL to ignore
5241 * @error: a #GError, or %NULL
5242 *
5243 * Obtains a directory monitor for the given file.
5244 * This may fail if directory monitoring is not supported.
5245 *
5246 * If @cancellable is not %NULL, then the operation can be cancelled by
5247 * triggering the cancellable object from another thread. If the operation
5248 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5249 *
5250 * It does not make sense for @flags to contain
5251 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5252 * directories. It is not possible to monitor all the files in a
5253 * directory for changes made via hard links; if you want to do this then
5254 * you must register individual watches with g_file_monitor().
5255 *
5256 * Virtual: monitor_dir
5257 * Returns: (transfer full): a #GFileMonitor for the given @file,
5258 * or %NULL on error.
5259 * Free the returned object with g_object_unref().
5260 */
5261 GFileMonitor *
5263 GFileMonitorFlags flags,
5266 {
5278 {
5280 G_IO_ERROR_NOT_SUPPORTED,
5283 }
5286 }
5288 /**
5289 * g_file_monitor_file:
5290 * @file: input #GFile
5291 * @flags: a set of #GFileMonitorFlags
5292 * @cancellable: (nullable): optional #GCancellable object,
5293 * %NULL to ignore
5294 * @error: a #GError, or %NULL
5295 *
5296 * Obtains a file monitor for the given file. If no file notification
5297 * mechanism exists, then regular polling of the file is used.
5298 *
5299 * If @cancellable is not %NULL, then the operation can be cancelled by
5300 * triggering the cancellable object from another thread. If the operation
5301 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5302 *
5303 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5304 * will also attempt to report changes made to the file via another
5305 * filename (ie, a hard link). Without this flag, you can only rely on
5306 * changes made through the filename contained in @file to be
5307 * reported. Using this flag may result in an increase in resource
5308 * usage, and may not have any effect depending on the #GFileMonitor
5309 * backend and/or filesystem type.
5310 *
5311 * Returns: (transfer full): a #GFileMonitor for the given @file,
5312 * or %NULL on error.
5313 * Free the returned object with g_object_unref().
5314 */
5315 GFileMonitor *
5317 GFileMonitorFlags flags,
5320 {
5336 /* Fallback to polling */
5341 }
5343 /**
5344 * g_file_monitor:
5345 * @file: input #GFile
5346 * @flags: a set of #GFileMonitorFlags
5347 * @cancellable: (nullable): optional #GCancellable object,
5348 * %NULL to ignore
5349 * @error: a #GError, or %NULL
5350 *
5351 * Obtains a file or directory monitor for the given file,
5352 * depending on the type of the file.
5353 *
5354 * If @cancellable is not %NULL, then the operation can be cancelled by
5355 * triggering the cancellable object from another thread. If the operation
5356 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5357 *
5358 * Returns: (transfer full): a #GFileMonitor for the given @file,
5359 * or %NULL on error.
5360 * Free the returned object with g_object_unref().
5361 *
5362 * Since: 2.18
5363 */
5364 GFileMonitor *
5366 GFileMonitorFlags flags,
5369 {
5374 else
5376 }
5378 /********************************************
5379 * Default implementation of async ops *
5380 ********************************************/
5384 GFileQueryInfoFlags flags;
5387 static void
5389 {
5392 }
5394 static void
5396 gpointer object,
5397 gpointer task_data,
5399 {
5404 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5407 else
5409 }
5411 static void
5414 GFileQueryInfoFlags flags,
5417 GAsyncReadyCallback callback,
5418 gpointer user_data)
5419 {
5433 }
5439 {
5443 }
5445 static void
5447 gpointer object,
5448 gpointer task_data,
5450 {
5458 else
5460 }
5462 static void
5467 GAsyncReadyCallback callback,
5468 gpointer user_data)
5469 {
5478 }
5484 {
5488 }
5490 static void
5492 gpointer object,
5493 gpointer task_data,
5495 {
5500 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5503 else
5505 }
5507 static void
5510 GFileQueryInfoFlags flags,
5513 GAsyncReadyCallback callback,
5514 gpointer user_data)
5515 {
5529 }
5535 {
5539 }
5541 static void
5543 gpointer object,
5544 gpointer task_data,
5546 {
5553 else
5555 }
5557 static void
5561 GAsyncReadyCallback callback,
5562 gpointer user_data)
5563 {
5571 }
5577 {
5581 }
5583 static void
5585 gpointer source_object,
5586 gpointer task_data,
5588 {
5596 else
5598 }
5600 static void
5602 GFileCreateFlags flags,
5605 GAsyncReadyCallback callback,
5606 gpointer user_data)
5607 {
5621 }
5627 {
5631 }
5633 static void
5635 gpointer source_object,
5636 gpointer task_data,
5638 {
5646 else
5648 }
5650 static void
5652 GFileCreateFlags flags,
5655 GAsyncReadyCallback callback,
5656 gpointer user_data)
5657 {
5671 }
5677 {
5681 }
5686 gboolean make_backup;
5687 GFileCreateFlags flags;
5690 static void
5692 {
5697 }
5699 static void
5701 gpointer source_object,
5702 gpointer task_data,
5704 {
5713 cancellable,
5718 else
5720 }
5722 static void
5725 gboolean make_backup,
5726 GFileCreateFlags flags,
5729 GAsyncReadyCallback callback,
5730 gpointer user_data)
5731 {
5747 }
5753 {
5757 }
5759 static void
5761 gpointer object,
5762 gpointer task_data,
5764 {
5769 else
5771 }
5773 static void
5777 GAsyncReadyCallback callback,
5778 gpointer user_data)
5779 {
5787 }
5789 static gboolean
5793 {
5797 }
5799 static void
5801 gpointer object,
5802 gpointer task_data,
5804 {
5809 else
5811 }
5813 static void
5817 GAsyncReadyCallback callback,
5818 gpointer user_data)
5819 {
5827 }
5829 static gboolean
5833 {
5837 }
5839 static void
5841 gpointer object,
5842 gpointer task_data,
5844 {
5849 else
5851 }
5853 static void
5857 GAsyncReadyCallback callback,
5858 gpointer user_data)
5859 {
5867 }
5869 static gboolean
5873 {
5877 }
5879 static void
5881 gpointer object,
5882 gpointer task_data,
5884 {
5892 else
5894 }
5896 static void
5900 GAsyncReadyCallback callback,
5901 gpointer user_data)
5902 {
5911 }
5917 {
5921 }
5923 static void
5925 gpointer object,
5926 gpointer task_data,
5928 {
5937 else
5939 }
5941 static void
5943 GFileCreateFlags flags,
5946 GAsyncReadyCallback callback,
5947 gpointer user_data)
5948 {
5962 }
5968 {
5972 }
5976 gboolean make_backup;
5977 GFileCreateFlags flags;
5980 static void
5982 {
5985 }
5987 static void
5989 gpointer object,
5990 gpointer task_data,
5992 {
6001 cancellable,
6006 else
6008 }
6010 static void
6013 gboolean make_backup,
6014 GFileCreateFlags flags,
6017 GAsyncReadyCallback callback,
6018 gpointer user_data)
6019 {
6035 }
6041 {
6045 }
6047 static void
6049 gpointer object,
6050 gpointer task_data,
6052 {
6061 else
6063 }
6065 static void
6070 GAsyncReadyCallback callback,
6071 gpointer user_data)
6072 {
6082 }
6088 {
6092 }
6095 GFileQueryInfoFlags flags;
6097 gboolean res;
6101 static void
6103 {
6109 }
6111 static void
6113 gpointer object,
6114 gpointer task_data,
6116 {
6123 cancellable,
6125 }
6127 static void
6130 GFileQueryInfoFlags flags,
6133 GAsyncReadyCallback callback,
6134 gpointer user_data)
6135 {
6150 }
6152 static gboolean
6157 {
6171 }
6173 static void
6175 gpointer object,
6176 gpointer task_data,
6178 {
6186 else
6188 }
6190 static void
6194 GAsyncReadyCallback callback,
6195 gpointer user_data)
6196 {
6205 }
6211 {
6215 }
6221 GFileCopyFlags flags;
6222 GFileProgressCallback progress_cb;
6223 gpointer progress_cb_data;
6226 static void
6228 {
6232 }
6236 goffset current_num_bytes;
6237 goffset total_num_bytes;
6240 static gboolean
6242 {
6251 }
6253 static void
6255 goffset total_num_bytes,
6256 gpointer user_data)
6257 {
6269 copy_async_progress_in_main,
6270 progress,
6271 g_free);
6272 }
6274 static void
6276 gpointer source,
6277 gpointer task_data,
6279 {
6281 gboolean result;
6287 cancellable,
6289 task,
6293 else
6295 }
6297 static void
6300 GFileCopyFlags flags,
6303 GFileProgressCallback progress_callback,
6304 gpointer progress_callback_data,
6305 GAsyncReadyCallback callback,
6306 gpointer user_data)
6307 {
6324 }
6326 static gboolean
6330 {
6334 }
6337 /********************************************
6338 * Default VFS operations *
6339 ********************************************/
6341 /**
6342 * g_file_new_for_path:
6343 * @path: (type filename): a string containing a relative or absolute path.
6344 * The string must be encoded in the glib filename encoding.
6345 *
6346 * Constructs a #GFile for a given path. This operation never
6347 * fails, but the returned object might not support any I/O
6348 * operation if @path is malformed.
6349 *
6350 * Returns: (transfer full): a new #GFile for the given @path.
6351 * Free the returned object with g_object_unref().
6352 */
6353 GFile *
6355 {
6359 }
6361 /**
6362 * g_file_new_for_uri:
6363 * @uri: a UTF-8 string containing a URI
6364 *
6365 * Constructs a #GFile for a given URI. This operation never
6366 * fails, but the returned object might not support any I/O
6367 * operation if @uri is malformed or if the uri type is
6368 * not supported.
6369 *
6370 * Returns: (transfer full): a new #GFile for the given @uri.
6371 * Free the returned object with g_object_unref().
6372 */
6373 GFile *
6375 {
6379 }
6381 /**
6382 * g_file_new_tmp:
6383 * @tmpl: (type filename) (nullable): Template for the file
6384 * name, as in g_file_open_tmp(), or %NULL for a default template
6385 * @iostream: (out): on return, a #GFileIOStream for the created file
6386 * @error: a #GError, or %NULL
6387 *
6388 * Opens a file in the preferred directory for temporary files (as
6389 * returned by g_get_tmp_dir()) and returns a #GFile and
6390 * #GFileIOStream pointing to it.
6391 *
6392 * @tmpl should be a string in the GLib file name encoding
6393 * containing a sequence of six 'X' characters, and containing no
6394 * directory components. If it is %NULL, a default template is used.
6395 *
6396 * Unlike the other #GFile constructors, this will return %NULL if
6397 * a temporary file could not be created.
6398 *
6399 * Returns: (transfer full): a new #GFile.
6400 * Free the returned object with g_object_unref().
6401 *
6402 * Since: 2.32
6403 */
6404 GFile *
6408 {
6409 gint fd;
6429 }
6431 /**
6432 * g_file_parse_name:
6433 * @parse_name: a file name or path to be parsed
6434 *
6435 * Constructs a #GFile with the given @parse_name (i.e. something
6436 * given by g_file_get_parse_name()). This operation never fails,
6437 * but the returned object might not support any I/O operation if
6438 * the @parse_name cannot be parsed.
6439 *
6440 * Returns: (transfer full): a new #GFile.
6441 */
6442 GFile *
6444 {
6448 }
6450 static gboolean
6452 {
6454 }
6456 /* Following RFC 2396, valid schemes are built like:
6457 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6458 */
6459 static gboolean
6461 {
6470 p++;
6474 }
6479 {
6490 {
6496 }
6497 else
6504 }
6506 /**
6507 * g_file_new_for_commandline_arg:
6508 * @arg: a command line string
6509 *
6510 * Creates a #GFile with the given argument from the command line.
6511 * The value of @arg can be either a URI, an absolute path or a
6512 * relative path resolved relative to the current working directory.
6513 * This operation never fails, but the returned object might not
6514 * support any I/O operation if @arg points to a malformed path.
6515 *
6516 * Note that on Windows, this function expects its argument to be in
6517 * UTF-8 -- not the system code page. This means that you
6518 * should not use this function with string from argv as it is passed
6519 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6520 * the commandline. #GApplication also uses UTF-8 but
6521 * g_application_command_line_create_file_for_arg() may be more useful
6522 * for you there. It is also always possible to use this function with
6523 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6524 *
6525 * Returns: (transfer full): a new #GFile.
6526 * Free the returned object with g_object_unref().
6527 */
6528 GFile *
6530 {
6534 }
6536 /**
6537 * g_file_new_for_commandline_arg_and_cwd:
6538 * @arg: a command line string
6539 * @cwd: (type filename): the current working directory of the commandline
6540 *
6541 * Creates a #GFile with the given argument from the command line.
6542 *
6543 * This function is similar to g_file_new_for_commandline_arg() except
6544 * that it allows for passing the current working directory as an
6545 * argument instead of using the current working directory of the
6546 * process.
6547 *
6548 * This is useful if the commandline argument was given in a context
6549 * other than the invocation of the current process.
6550 *
6551 * See also g_application_command_line_create_file_for_arg().
6552 *
6553 * Returns: (transfer full): a new #GFile
6554 *
6555 * Since: 2.36
6556 **/
6557 GFile *
6560 {
6565 }
6567 /**
6568 * g_file_mount_enclosing_volume:
6569 * @location: input #GFile
6570 * @flags: flags affecting the operation
6571 * @mount_operation: (nullable): a #GMountOperation
6572 * or %NULL to avoid user interaction
6573 * @cancellable: (nullable): optional #GCancellable object,
6574 * %NULL to ignore
6575 * @callback: (nullable): a #GAsyncReadyCallback to call
6576 * when the request is satisfied, or %NULL
6577 * @user_data: the data to pass to callback function
6578 *
6579 * Starts a @mount_operation, mounting the volume that contains
6580 * the file @location.
6581 *
6582 * When this operation has completed, @callback will be called with
6583 * @user_user data, and the operation can be finalized with
6584 * g_file_mount_enclosing_volume_finish().
6585 *
6586 * If @cancellable is not %NULL, then the operation can be cancelled by
6587 * triggering the cancellable object from another thread. If the operation
6588 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6589 */
6590 void
6592 GMountMountFlags flags,
6595 GAsyncReadyCallback callback,
6596 gpointer user_data)
6597 {
6605 {
6607 g_file_mount_enclosing_volume,
6611 }
6613 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6615 }
6617 /**
6618 * g_file_mount_enclosing_volume_finish:
6619 * @location: input #GFile
6620 * @result: a #GAsyncResult
6621 * @error: a #GError, or %NULL
6622 *
6623 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6624 *
6625 * Returns: %TRUE if successful. If an error has occurred,
6626 * this function will return %FALSE and set @error
6627 * appropriately if present.
6628 */
6629 gboolean
6633 {
6647 }
6649 /********************************************
6650 * Utility functions *
6651 ********************************************/
6653 /**
6654 * g_file_query_default_handler:
6655 * @file: a #GFile to open
6656 * @cancellable: optional #GCancellable object, %NULL to ignore
6657 * @error: a #GError, or %NULL
6658 *
6659 * Returns the #GAppInfo that is registered as the default
6660 * application to handle the file specified by @file.
6661 *
6662 * If @cancellable is not %NULL, then the operation can be cancelled by
6663 * triggering the cancellable object from another thread. If the operation
6664 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6665 *
6666 * Returns: (transfer full): a #GAppInfo if the handle was found,
6667 * %NULL if there were errors.
6668 * When you are done with it, release it with g_object_unref()
6669 */
6670 GAppInfo *
6674 {
6683 {
6689 }
6692 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6694 cancellable,
6695 error);
6703 {
6704 /* Don't use is_native(), as we want to support fuse paths if available */
6709 }
6717 G_IO_ERROR_NOT_SUPPORTED,
6720 }
6722 #define GET_CONTENT_BLOCK_SIZE 8192
6724 /**
6725 * g_file_load_contents:
6726 * @file: input #GFile
6727 * @cancellable: optional #GCancellable object, %NULL to ignore
6728 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6729 * @length: (out) (optional): a location to place the length of the contents of the file,
6730 * or %NULL if the length is not needed
6731 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
6732 * or %NULL if the entity tag is not needed
6733 * @error: a #GError, or %NULL
6734 *
6735 * Loads the content of the file into memory. The data is always
6736 * zero-terminated, but this is not included in the resultant @length.
6737 * The returned @content should be freed with g_free() when no longer
6738 * needed.
6739 *
6740 * If @cancellable is not %NULL, then the operation can be cancelled by
6741 * triggering the cancellable object from another thread. If the operation
6742 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6743 *
6744 * Returns: %TRUE if the @file's contents were successfully loaded.
6745 * %FALSE if there were errors.
6746 */
6747 gboolean
6754 {
6757 gsize pos;
6758 gssize res;
6774 GET_CONTENT_BLOCK_SIZE,
6776 {
6779 }
6782 {
6786 G_FILE_ATTRIBUTE_ETAG_VALUE,
6787 cancellable,
6788 NULL);
6790 {
6793 }
6794 }
6796 /* Ignore errors on close */
6801 {
6802 /* error is set already */
6805 }
6810 /* Zero terminate (we got an extra byte allocated for this */
6816 }
6820 GFileReadMoreCallback read_more_callback;
6822 gsize pos;
6827 static void
6829 {
6834 }
6836 static void
6839 gpointer user_data)
6840 {
6844 /* Ignore errors here, we're only reading anyway */
6850 }
6852 static void
6855 gpointer user_data)
6856 {
6864 {
6867 }
6872 }
6874 static void
6877 gpointer user_data)
6878 {
6882 gssize read_size;
6887 {
6891 /* Close the file ignoring any error */
6894 }
6896 {
6898 G_FILE_ATTRIBUTE_ETAG_VALUE,
6901 load_contents_fstat_callback,
6902 data);
6903 }
6905 {
6916 G_FILE_ATTRIBUTE_ETAG_VALUE,
6919 load_contents_fstat_callback,
6920 data);
6921 else
6924 GET_CONTENT_BLOCK_SIZE,
6927 load_contents_read_callback,
6928 data);
6929 }
6930 }
6932 static void
6935 gpointer user_data)
6936 {
6945 {
6950 GET_CONTENT_BLOCK_SIZE,
6953 load_contents_read_callback,
6954 data);
6955 }
6956 else
6957 {
6960 }
6961 }
6963 /**
6964 * g_file_load_partial_contents_async: (skip)
6965 * @file: input #GFile
6966 * @cancellable: optional #GCancellable object, %NULL to ignore
6967 * @read_more_callback: a #GFileReadMoreCallback to receive partial data
6968 * and to specify whether further data should be read
6969 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6970 * @user_data: the data to pass to the callback functions
6971 *
6972 * Reads the partial contents of a file. A #GFileReadMoreCallback should
6973 * be used to stop reading from the file when appropriate, else this
6974 * function will behave exactly as g_file_load_contents_async(). This
6975 * operation can be finished by g_file_load_partial_contents_finish().
6976 *
6977 * Users of this function should be aware that @user_data is passed to
6978 * both the @read_more_callback and the @callback.
6979 *
6980 * If @cancellable is not %NULL, then the operation can be cancelled by
6981 * triggering the cancellable object from another thread. If the operation
6982 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6983 */
6984 void
6987 GFileReadMoreCallback read_more_callback,
6988 GAsyncReadyCallback callback,
6989 gpointer user_data)
6990 {
7006 load_contents_open_callback,
7007 data);
7008 }
7010 /**
7011 * g_file_load_partial_contents_finish:
7012 * @file: input #GFile
7013 * @res: a #GAsyncResult
7014 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7015 * @length: (out) (optional): a location to place the length of the contents of the file,
7016 * or %NULL if the length is not needed
7017 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7018 * or %NULL if the entity tag is not needed
7019 * @error: a #GError, or %NULL
7020 *
7021 * Finishes an asynchronous partial load operation that was started
7022 * with g_file_load_partial_contents_async(). The data is always
7023 * zero-terminated, but this is not included in the resultant @length.
7024 * The returned @content should be freed with g_free() when no longer
7025 * needed.
7026 *
7027 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7028 * present, it will be set appropriately.
7029 */
7030 gboolean
7037 {
7048 {
7052 }
7060 {
7063 }
7065 /* Zero terminate */
7073 }
7075 /**
7076 * g_file_load_contents_async:
7077 * @file: input #GFile
7078 * @cancellable: optional #GCancellable object, %NULL to ignore
7079 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7080 * @user_data: the data to pass to callback function
7081 *
7082 * Starts an asynchronous load of the @file's contents.
7083 *
7084 * For more details, see g_file_load_contents() which is
7085 * the synchronous version of this call.
7086 *
7087 * When the load operation has completed, @callback will be called
7088 * with @user data. To finish the operation, call
7089 * g_file_load_contents_finish() with the #GAsyncResult returned by
7090 * the @callback.
7091 *
7092 * If @cancellable is not %NULL, then the operation can be cancelled by
7093 * triggering the cancellable object from another thread. If the operation
7094 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7095 */
7096 void
7099 GAsyncReadyCallback callback,
7100 gpointer user_data)
7101 {
7103 cancellable,
7104 NULL,
7106 }
7108 /**
7109 * g_file_load_contents_finish:
7110 * @file: input #GFile
7111 * @res: a #GAsyncResult
7112 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7113 * @length: (out) (optional): a location to place the length of the contents of the file,
7114 * or %NULL if the length is not needed
7115 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7116 * or %NULL if the entity tag is not needed
7117 * @error: a #GError, or %NULL
7118 *
7119 * Finishes an asynchronous load of the @file's contents.
7120 * The contents are placed in @contents, and @length is set to the
7121 * size of the @contents string. The @content should be freed with
7122 * g_free() when no longer needed. If @etag_out is present, it will be
7123 * set to the new entity tag for the @file.
7124 *
7125 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7126 * present, it will be set appropriately.
7127 */
7128 gboolean
7135 {
7137 res,
7138 contents,
7139 length,
7140 etag_out,
7141 error);
7142 }
7144 /**
7145 * g_file_replace_contents:
7146 * @file: input #GFile
7147 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7148 * @length: the length of @contents in bytes
7149 * @etag: (nullable): the old [entity-tag][gfile-etag] for the document,
7150 * or %NULL
7151 * @make_backup: %TRUE if a backup should be created
7152 * @flags: a set of #GFileCreateFlags
7153 * @new_etag: (out) (optional): a location to a new [entity tag][gfile-etag]
7154 * for the document. This should be freed with g_free() when no longer
7155 * needed, or %NULL
7156 * @cancellable: optional #GCancellable object, %NULL to ignore
7157 * @error: a #GError, or %NULL
7158 *
7159 * Replaces the contents of @file with @contents of @length bytes.
7160 *
7161 * If @etag is specified (not %NULL), any existing file must have that etag,
7162 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7163 *
7164 * If @make_backup is %TRUE, this function will attempt to make a backup
7165 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7166 * file contents in the safest way possible. For example, atomic renames are
7167 * used when replacing local files’ contents.
7168 *
7169 * If @cancellable is not %NULL, then the operation can be cancelled by
7170 * triggering the cancellable object from another thread. If the operation
7171 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7172 *
7173 * The returned @new_etag can be used to verify that the file hasn't
7174 * changed the next time it is saved over.
7175 *
7176 * Returns: %TRUE if successful. If an error has occurred, this function
7177 * will return %FALSE and set @error appropriately if present.
7178 */
7179 gboolean
7182 gsize length,
7184 gboolean make_backup,
7185 GFileCreateFlags flags,
7189 {
7192 gssize res;
7193 gboolean ret;
7208 cancellable,
7210 {
7213 }
7216 {
7217 /* Ignore errors on close */
7221 /* error is set already */
7223 }
7233 }
7238 gsize pos;
7240 gboolean failed;
7243 static void
7245 {
7249 }
7251 static void
7254 gpointer user_data)
7255 {
7259 /* Ignore errors here, we're only reading anyway */
7264 {
7267 }
7269 }
7271 static void
7274 gpointer user_data)
7275 {
7279 gssize write_size;
7284 {
7285 /* Error or EOF, close the file */
7287 {
7290 }
7294 }
7296 {
7298 gsize length;
7307 else
7313 replace_contents_write_callback,
7314 data);
7315 }
7316 }
7318 static void
7321 gpointer user_data)
7322 {
7331 {
7333 gsize length;
7341 replace_contents_write_callback,
7342 data);
7343 }
7344 else
7345 {
7348 }
7349 }
7351 /**
7352 * g_file_replace_contents_async:
7353 * @file: input #GFile
7354 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7355 * @length: the length of @contents in bytes
7356 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7357 * @make_backup: %TRUE if a backup should be created
7358 * @flags: a set of #GFileCreateFlags
7359 * @cancellable: optional #GCancellable object, %NULL to ignore
7360 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7361 * @user_data: the data to pass to callback function
7362 *
7363 * Starts an asynchronous replacement of @file with the given
7364 * @contents of @length bytes. @etag will replace the document's
7365 * current entity tag.
7366 *
7367 * When this operation has completed, @callback will be called with
7368 * @user_user data, and the operation can be finalized with
7369 * g_file_replace_contents_finish().
7370 *
7371 * If @cancellable is not %NULL, then the operation can be cancelled by
7372 * triggering the cancellable object from another thread. If the operation
7373 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7374 *
7375 * If @make_backup is %TRUE, this function will attempt to
7376 * make a backup of @file.
7377 *
7378 * Note that no copy of @content will be made, so it must stay valid
7379 * until @callback is called. See g_file_replace_contents_bytes_async()
7380 * for a #GBytes version that will automatically hold a reference to the
7381 * contents (without copying) for the duration of the call.
7382 */
7383 void
7386 gsize length,
7388 gboolean make_backup,
7389 GFileCreateFlags flags,
7391 GAsyncReadyCallback callback,
7392 gpointer user_data)
7393 {
7400 }
7402 /**
7403 * g_file_replace_contents_bytes_async:
7404 * @file: input #GFile
7405 * @contents: a #GBytes
7406 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7407 * @make_backup: %TRUE if a backup should be created
7408 * @flags: a set of #GFileCreateFlags
7409 * @cancellable: optional #GCancellable object, %NULL to ignore
7410 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7411 * @user_data: the data to pass to callback function
7412 *
7413 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7414 * This function will keep a ref on @contents until the operation is done.
7415 * Unlike g_file_replace_contents_async() this allows forgetting about the
7416 * content without waiting for the callback.
7417 *
7418 * When this operation has completed, @callback will be called with
7419 * @user_user data, and the operation can be finalized with
7420 * g_file_replace_contents_finish().
7421 *
7422 * Since: 2.40
7423 */
7424 void
7428 gboolean make_backup,
7429 GFileCreateFlags flags,
7431 GAsyncReadyCallback callback,
7432 gpointer user_data)
7433 {
7448 etag,
7449 make_backup,
7450 flags,
7453 replace_contents_open_callback,
7454 data);
7455 }
7457 /**
7458 * g_file_replace_contents_finish:
7459 * @file: input #GFile
7460 * @res: a #GAsyncResult
7461 * @new_etag: (out) (optional): a location of a new [entity tag][gfile-etag]
7462 * for the document. This should be freed with g_free() when it is no
7463 * longer needed, or %NULL
7464 * @error: a #GError, or %NULL
7465 *
7466 * Finishes an asynchronous replace of the given @file. See
7467 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7468 * tag for the document, if present.
7469 *
7470 * Returns: %TRUE on success, %FALSE on failure.
7471 */
7472 gboolean
7477 {
7492 {
7495 }
7498 }
7500 gboolean
7502 GFileMeasureFlags flags,
7504 GFileMeasureProgressCallback progress_callback,
7505 gpointer progress_data,
7510 {
7514 }
7517 {
7518 GFileMeasureFlags flags;
7519 GFileMeasureProgressCallback progress_callback;
7520 gpointer progress_data;
7524 {
7525 guint64 disk_usage;
7526 guint64 num_dirs;
7527 guint64 num_files;
7531 {
7532 GFileMeasureProgressCallback callback;
7533 gpointer user_data;
7534 gboolean reporting;
7535 guint64 current_size;
7536 guint64 num_dirs;
7537 guint64 num_files;
7540 static gboolean
7542 {
7550 }
7552 static void
7554 guint64 current_size,
7555 guint64 num_dirs,
7556 guint64 num_files,
7557 gpointer user_data)
7558 {
7559 MeasureProgress progress;
7574 measure_disk_usage_invoke_progress,
7576 g_free);
7577 }
7579 static void
7581 gpointer source_object,
7582 gpointer task_data,
7584 {
7594 else
7596 }
7598 static void
7600 GFileMeasureFlags flags,
7601 gint io_priority,
7603 GFileMeasureProgressCallback progress_callback,
7604 gpointer progress_data,
7605 GAsyncReadyCallback callback,
7606 gpointer user_data)
7607 {
7608 MeasureTaskData data;
7622 }
7624 static gboolean
7631 {
7653 }
7655 /**
7656 * g_file_measure_disk_usage:
7657 * @file: a #GFile
7658 * @flags: #GFileMeasureFlags
7659 * @cancellable: (nullable): optional #GCancellable
7660 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7661 * @progress_data: user_data for @progress_callback
7662 * @disk_usage: (out) (optional): the number of bytes of disk space used
7663 * @num_dirs: (out) (optional): the number of directories encountered
7664 * @num_files: (out) (optional): the number of non-directories encountered
7665 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7666 *
7667 * Recursively measures the disk usage of @file.
7668 *
7669 * This is essentially an analog of the 'du' command, but it also
7670 * reports the number of directories and non-directory files encountered
7671 * (including things like symbolic links).
7672 *
7673 * By default, errors are only reported against the toplevel file
7674 * itself. Errors found while recursing are silently ignored, unless
7675 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7676 *
7677 * The returned size, @disk_usage, is in bytes and should be formatted
7678 * with g_format_size() in order to get something reasonable for showing
7679 * in a user interface.
7680 *
7681 * @progress_callback and @progress_data can be given to request
7682 * periodic progress updates while scanning. See the documentation for
7683 * #GFileMeasureProgressCallback for information about when and how the
7684 * callback will be invoked.
7685 *
7686 * Returns: %TRUE if successful, with the out parameters set.
7687 * %FALSE otherwise, with @error set.
7688 *
7689 * Since: 2.38
7690 **/
7691 gboolean
7693 GFileMeasureFlags flags,
7695 GFileMeasureProgressCallback progress_callback,
7696 gpointer progress_data,
7701 {
7709 error);
7710 }
7712 /**
7713 * g_file_measure_disk_usage_async:
7714 * @file: a #GFile
7715 * @flags: #GFileMeasureFlags
7716 * @io_priority: the [I/O priority][io-priority] of the request
7717 * @cancellable: (nullable): optional #GCancellable
7718 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7719 * @progress_data: user_data for @progress_callback
7720 * @callback: (nullable): a #GAsyncReadyCallback to call when complete
7721 * @user_data: the data to pass to callback function
7722 *
7723 * Recursively measures the disk usage of @file.
7724 *
7725 * This is the asynchronous version of g_file_measure_disk_usage(). See
7726 * there for more information.
7727 *
7728 * Since: 2.38
7729 **/
7730 void
7732 GFileMeasureFlags flags,
7733 gint io_priority,
7735 GFileMeasureProgressCallback progress_callback,
7736 gpointer progress_data,
7737 GAsyncReadyCallback callback,
7738 gpointer user_data)
7739 {
7746 }
7748 /**
7749 * g_file_measure_disk_usage_finish:
7750 * @file: a #GFile
7751 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7752 * @disk_usage: (out) (optional): the number of bytes of disk space used
7753 * @num_dirs: (out) (optional): the number of directories encountered
7754 * @num_files: (out) (optional): the number of non-directories encountered
7755 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7756 *
7757 * Collects the results from an earlier call to
7758 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7759 * more information.
7760 *
7761 * Returns: %TRUE if successful, with the out parameters set.
7762 * %FALSE otherwise, with @error set.
7763 *
7764 * Since: 2.38
7765 **/
7766 gboolean
7773 {
7777 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7778 }
7780 /**
7781 * g_file_start_mountable:
7782 * @file: input #GFile
7783 * @flags: flags affecting the operation
7784 * @start_operation: (nullable): a #GMountOperation, or %NULL to avoid user interaction
7785 * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
7786 * @callback: (nullable): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7787 * @user_data: the data to pass to callback function
7788 *
7789 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7790 * Using @start_operation, you can request callbacks when, for instance,
7791 * passwords are needed during authentication.
7792 *
7793 * If @cancellable is not %NULL, then the operation can be cancelled by
7794 * triggering the cancellable object from another thread. If the operation
7795 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7796 *
7797 * When the operation is finished, @callback will be called.
7798 * You can then call g_file_mount_mountable_finish() to get
7799 * the result of the operation.
7800 *
7801 * Since: 2.22
7802 */
7803 void
7805 GDriveStartFlags flags,
7808 GAsyncReadyCallback callback,
7809 gpointer user_data)
7810 {
7818 {
7820 g_file_start_mountable,
7824 }
7827 flags,
7828 start_operation,
7829 cancellable,
7830 callback,
7831 user_data);
7832 }
7834 /**
7835 * g_file_start_mountable_finish:
7836 * @file: input #GFile
7837 * @result: a #GAsyncResult
7838 * @error: a #GError, or %NULL
7839 *
7840 * Finishes a start operation. See g_file_start_mountable() for details.
7841 *
7842 * Finish an asynchronous start operation that was started
7843 * with g_file_start_mountable().
7844 *
7845 * Returns: %TRUE if the operation finished successfully. %FALSE
7846 * otherwise.
7847 *
7848 * Since: 2.22
7849 */
7850 gboolean
7854 {
7867 }
7869 /**
7870 * g_file_stop_mountable:
7871 * @file: input #GFile
7872 * @flags: flags affecting the operation
7873 * @mount_operation: (nullable): a #GMountOperation,
7874 * or %NULL to avoid user interaction.
7875 * @cancellable: (nullable): optional #GCancellable object,
7876 * %NULL to ignore
7877 * @callback: (nullable): a #GAsyncReadyCallback to call
7878 * when the request is satisfied, or %NULL
7879 * @user_data: the data to pass to callback function
7880 *
7881 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
7882 *
7883 * If @cancellable is not %NULL, then the operation can be cancelled by
7884 * triggering the cancellable object from another thread. If the operation
7885 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7886 *
7887 * When the operation is finished, @callback will be called.
7888 * You can then call g_file_stop_mountable_finish() to get
7889 * the result of the operation.
7890 *
7891 * Since: 2.22
7892 */
7893 void
7895 GMountUnmountFlags flags,
7898 GAsyncReadyCallback callback,
7899 gpointer user_data)
7900 {
7908 {
7910 g_file_stop_mountable,
7914 }
7917 flags,
7918 mount_operation,
7919 cancellable,
7920 callback,
7921 user_data);
7922 }
7924 /**
7925 * g_file_stop_mountable_finish:
7926 * @file: input #GFile
7927 * @result: a #GAsyncResult
7928 * @error: a #GError, or %NULL
7929 *
7930 * Finishes an stop operation, see g_file_stop_mountable() for details.
7931 *
7932 * Finish an asynchronous stop operation that was started
7933 * with g_file_stop_mountable().
7934 *
7935 * Returns: %TRUE if the operation finished successfully.
7936 * %FALSE otherwise.
7937 *
7938 * Since: 2.22
7939 */
7940 gboolean
7944 {
7957 }
7959 /**
7960 * g_file_poll_mountable:
7961 * @file: input #GFile
7962 * @cancellable: optional #GCancellable object, %NULL to ignore
7963 * @callback: (nullable): a #GAsyncReadyCallback to call
7964 * when the request is satisfied, or %NULL
7965 * @user_data: the data to pass to callback function
7966 *
7967 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
7968 *
7969 * If @cancellable is not %NULL, then the operation can be cancelled by
7970 * triggering the cancellable object from another thread. If the operation
7971 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7972 *
7973 * When the operation is finished, @callback will be called.
7974 * You can then call g_file_mount_mountable_finish() to get
7975 * the result of the operation.
7976 *
7977 * Since: 2.22
7978 */
7979 void
7982 GAsyncReadyCallback callback,
7983 gpointer user_data)
7984 {
7992 {
7994 g_file_poll_mountable,
7998 }
8001 cancellable,
8002 callback,
8003 user_data);
8004 }
8006 /**
8007 * g_file_poll_mountable_finish:
8008 * @file: input #GFile
8009 * @result: a #GAsyncResult
8010 * @error: a #GError, or %NULL
8011 *
8012 * Finishes a poll operation. See g_file_poll_mountable() for details.
8013 *
8014 * Finish an asynchronous poll operation that was polled
8015 * with g_file_poll_mountable().
8016 *
8017 * Returns: %TRUE if the operation finished successfully. %FALSE
8018 * otherwise.
8019 *
8020 * Since: 2.22
8021 */
8022 gboolean
8026 {
8039 }
8041 /**
8042 * g_file_supports_thread_contexts:
8043 * @file: a #GFile
8044 *
8045 * Checks if @file supports
8046 * [thread-default contexts][g-main-context-push-thread-default-context].
8047 * If this returns %FALSE, you cannot perform asynchronous operations on
8048 * @file in a thread that has a thread-default context.
8049 *
8050 * Returns: Whether or not @file supports thread-default contexts.
8051 *
8052 * Since: 2.22
8053 */
8054 gboolean
8056 {
8063 }