| blob | 8a78e95c913d1cf0fcbd22ba50ef550c877084e7 |
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 {
2780 gssize n_read;
2781 gsize n_written;
2782 goffset current_size;
2784 gboolean res;
2785 goffset total_size;
2789 /* avoid performance impact of querying total size when it's not needed */
2791 {
2793 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2796 {
2800 }
2803 {
2805 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2806 G_FILE_QUERY_INFO_NONE,
2809 {
2813 }
2814 }
2815 }
2824 {
2827 {
2830 }
2843 }
2846 /* Make sure we send full copied size */
2851 }
2853 #ifdef HAVE_SPLICE
2855 static gboolean
2863 {
2866 retry:
2870 {
2878 else
2885 }
2889 }
2891 static gboolean
2895 GFileProgressCallback progress_callback,
2896 gpointer progress_callback_data,
2898 {
2900 gboolean res;
2901 goffset total_size;
2902 loff_t offset_in;
2903 loff_t offset_out;
2913 /* avoid performance impact of querying total size when it's not needed */
2915 {
2920 }
2928 {
2939 {
2942 }
2945 {
2953 }
2957 }
2959 /* Make sure we send full copied size */
2969 out:
2976 }
2977 #endif
2979 #ifdef __linux__
2980 static gboolean
2985 GFileProgressCallback progress_callback,
2986 gpointer progress_callback_data,
2988 {
2989 goffset source_size;
2999 /* Btrfs clone ioctl properties:
3000 * - Works at the inode level
3001 * - Doesn't work with directories
3002 * - Always follows symlinks (source and destination)
3003 *
3004 * By the time we get here, *in and *out are both regular files */
3009 {
3012 G_IO_ERROR_NOT_SUPPORTED,
3016 G_IO_ERROR_NOT_SUPPORTED,
3018 else
3019 /* Most probably something odd happened; retry with fallback */
3021 G_IO_ERROR_NOT_SUPPORTED,
3023 /* We retry with fallback for all error cases because Btrfs is currently
3024 * unstable, and so we can't trust it to do clone properly.
3025 * In addition, any hard errors here would cause the same failure in the
3026 * fallback manual copy as well. */
3028 }
3030 /* Make sure we send full copied size */
3035 }
3036 #endif
3038 static gboolean
3041 GFileCopyFlags flags,
3043 GFileProgressCallback progress_callback,
3044 gpointer progress_callback_data,
3046 {
3056 /* need to know the file type */
3059 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3060 cancellable,
3061 error);
3065 /* Maybe copy the symlink? */
3068 {
3071 {
3077 }
3078 /* ... else fall back on a regular file copy */
3079 }
3080 /* Handle "special" files (pipes, device nodes, ...)? */
3082 {
3083 /* FIXME: could try to recreate device nodes and others? */
3087 }
3089 /* Everything else should just fall back on a regular copy. */
3101 {
3104 /* Ok, ditch the previous lightweight info (on Unix we just
3105 * called lstat()); at this point we gather all the information
3106 * we need about the source from the opened file descriptor.
3107 */
3113 {
3114 /* Not all gvfs backends implement query_info_on_read(), we
3115 * can just fall back to the pathname again.
3116 * https://bugzilla.gnome.org/706254
3117 */
3119 {
3123 }
3124 else
3125 {
3129 }
3130 }
3136 }
3138 /* In the local file path, we pass down the source info which
3139 * includes things like unix::mode, to ensure that the target file
3140 * is not created with different permissions from the source file.
3141 *
3142 * If a future API like g_file_replace_with_info() is added, switch
3143 * this code to use that.
3144 */
3146 {
3148 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3151 G_FILE_CREATE_REPLACE_DESTINATION,
3152 info,
3154 else
3155 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3158 }
3160 {
3162 NULL,
3164 G_FILE_CREATE_REPLACE_DESTINATION,
3166 }
3167 else
3168 {
3170 }
3175 #ifdef __linux__
3177 {
3183 {
3185 {
3187 }
3188 else
3189 {
3192 }
3193 }
3194 else
3195 {
3198 }
3199 }
3200 #endif
3202 #ifdef HAVE_SPLICE
3204 {
3210 {
3212 {
3214 }
3215 else
3216 {
3219 }
3220 }
3221 else
3222 {
3225 }
3226 }
3228 #endif
3230 /* A plain read/write loop */
3233 error))
3237 out:
3239 {
3240 /* Don't care about errors in source here */
3243 }
3246 {
3247 /* But write errors on close are bad! */
3251 }
3253 /* Ignore errors here. Failure to copy metadata is not a hard error */
3254 /* TODO: set these attributes /before/ we do the rename() on Unix */
3256 {
3258 info,
3259 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3260 cancellable,
3261 NULL);
3262 }
3267 }
3269 /**
3270 * g_file_copy:
3271 * @source: input #GFile
3272 * @destination: destination #GFile
3273 * @flags: set of #GFileCopyFlags
3274 * @cancellable: (nullable): optional #GCancellable object,
3275 * %NULL to ignore
3276 * @progress_callback: (nullable) (scope call): function to callback with
3277 * progress information, or %NULL if progress information is not needed
3278 * @progress_callback_data: (closure): user data to pass to @progress_callback
3279 * @error: #GError to set on error, or %NULL
3280 *
3281 * Copies the file @source to the location specified by @destination.
3282 * Can not handle recursive copies of directories.
3283 *
3284 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3285 * existing @destination file is overwritten.
3286 *
3287 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3288 * will be copied as symlinks, otherwise the target of the
3289 * @source symlink will be copied.
3290 *
3291 * If the flag #G_FILE_COPY_ALL_METADATA is specified then all the metadata
3292 * that is possible to copy is copied, not just the default subset (which,
3293 * for instance, does not include the owner, see #GFileInfo).
3294 *
3295 * If @cancellable is not %NULL, then the operation can be cancelled by
3296 * triggering the cancellable object from another thread. If the operation
3297 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3298 *
3299 * If @progress_callback is not %NULL, then the operation can be monitored
3300 * by setting this to a #GFileProgressCallback function.
3301 * @progress_callback_data will be passed to this function. It is guaranteed
3302 * that this callback will be called after all data has been transferred with
3303 * the total number of bytes copied during the operation.
3304 *
3305 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3306 * is returned, independent on the status of the @destination.
3307 *
3308 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3309 * the error %G_IO_ERROR_EXISTS is returned.
3310 *
3311 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3312 * error is returned. If trying to overwrite a directory with a directory the
3313 * %G_IO_ERROR_WOULD_MERGE error is returned.
3314 *
3315 * If the source is a directory and the target does not exist, or
3316 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3317 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3318 *
3319 * If you are interested in copying the #GFile object itself (not the on-disk
3320 * file), see g_file_dup().
3321 *
3322 * Returns: %TRUE on success, %FALSE otherwise.
3323 */
3324 gboolean
3327 GFileCopyFlags flags,
3329 GFileProgressCallback progress_callback,
3330 gpointer progress_callback_data,
3332 {
3335 gboolean res;
3345 {
3356 {
3359 }
3360 else
3362 }
3364 /* If the types are different, and the destination method failed
3365 * also try the source method
3366 */
3368 {
3372 {
3383 {
3386 }
3387 else
3389 }
3390 }
3394 error);
3395 }
3397 /**
3398 * g_file_copy_async:
3399 * @source: input #GFile
3400 * @destination: destination #GFile
3401 * @flags: set of #GFileCopyFlags
3402 * @io_priority: the [I/O priority][io-priority] of the request
3403 * @cancellable: (nullable): optional #GCancellable object,
3404 * %NULL to ignore
3405 * @progress_callback: (nullable) (scope notified): function to callback with progress
3406 * information, or %NULL if progress information is not needed
3407 * @progress_callback_data: (closure progress_callback) (nullable): user data to pass to @progress_callback
3408 * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied
3409 * @user_data: (closure callback): the data to pass to callback function
3410 *
3411 * Copies the file @source to the location specified by @destination
3412 * asynchronously. For details of the behaviour, see g_file_copy().
3413 *
3414 * If @progress_callback is not %NULL, then that function that will be called
3415 * just like in g_file_copy(). The callback will run in the default main context
3416 * of the thread calling g_file_copy_async() — the same context as @callback is
3417 * run in.
3418 *
3419 * When the operation is finished, @callback will be called. You can then call
3420 * g_file_copy_finish() to get the result of the operation.
3421 */
3422 void
3425 GFileCopyFlags flags,
3428 GFileProgressCallback progress_callback,
3429 gpointer progress_callback_data,
3430 GAsyncReadyCallback callback,
3431 gpointer user_data)
3432 {
3440 destination,
3441 flags,
3442 io_priority,
3443 cancellable,
3444 progress_callback,
3445 progress_callback_data,
3446 callback,
3447 user_data);
3448 }
3450 /**
3451 * g_file_copy_finish:
3452 * @file: input #GFile
3453 * @res: a #GAsyncResult
3454 * @error: a #GError, or %NULL
3455 *
3456 * Finishes copying the file started with g_file_copy_async().
3457 *
3458 * Returns: a %TRUE on success, %FALSE on error.
3459 */
3460 gboolean
3464 {
3475 }
3477 /**
3478 * g_file_move:
3479 * @source: #GFile pointing to the source location
3480 * @destination: #GFile pointing to the destination location
3481 * @flags: set of #GFileCopyFlags
3482 * @cancellable: (nullable): optional #GCancellable object,
3483 * %NULL to ignore
3484 * @progress_callback: (nullable) (scope call): #GFileProgressCallback
3485 * function for updates
3486 * @progress_callback_data: (closure): gpointer to user data for
3487 * the callback function
3488 * @error: #GError for returning error conditions, or %NULL
3489 *
3490 * Tries to move the file or directory @source to the location specified
3491 * by @destination. If native move operations are supported then this is
3492 * used, otherwise a copy + delete fallback is used. The native
3493 * implementation may support moving directories (for instance on moves
3494 * inside the same filesystem), but the fallback code does not.
3495 *
3496 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3497 * existing @destination file is overwritten.
3498 *
3499 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3500 * will be copied as symlinks, otherwise the target of the
3501 * @source symlink will be copied.
3502 *
3503 * If @cancellable is not %NULL, then the operation can be cancelled by
3504 * triggering the cancellable object from another thread. If the operation
3505 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3506 *
3507 * If @progress_callback is not %NULL, then the operation can be monitored
3508 * by setting this to a #GFileProgressCallback function.
3509 * @progress_callback_data will be passed to this function. It is
3510 * guaranteed that this callback will be called after all data has been
3511 * transferred with the total number of bytes copied during the operation.
3512 *
3513 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3514 * error is returned, independent on the status of the @destination.
3515 *
3516 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3517 * then the error %G_IO_ERROR_EXISTS is returned.
3518 *
3519 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3520 * error is returned. If trying to overwrite a directory with a directory the
3521 * %G_IO_ERROR_WOULD_MERGE error is returned.
3522 *
3523 * If the source is a directory and the target does not exist, or
3524 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3525 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3526 * move operation isn't available).
3527 *
3528 * Returns: %TRUE on successful move, %FALSE otherwise.
3529 */
3530 gboolean
3533 GFileCopyFlags flags,
3535 GFileProgressCallback progress_callback,
3536 gpointer progress_callback_data,
3538 {
3541 gboolean res;
3551 {
3562 {
3565 }
3566 else
3568 }
3570 /* If the types are different, and the destination method failed
3571 * also try the source method
3572 */
3574 {
3578 {
3589 {
3592 }
3593 else
3595 }
3596 }
3599 {
3601 G_IO_ERROR_NOT_SUPPORTED,
3604 }
3609 error))
3613 }
3615 /**
3616 * g_file_make_directory:
3617 * @file: input #GFile
3618 * @cancellable: (nullable): optional #GCancellable object,
3619 * %NULL to ignore
3620 * @error: a #GError, or %NULL
3621 *
3622 * Creates a directory. Note that this will only create a child directory
3623 * of the immediate parent directory of the path or URI given by the #GFile.
3624 * To recursively create directories, see g_file_make_directory_with_parents().
3625 * This function will fail if the parent directory does not exist, setting
3626 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3627 * creating directories, this function will fail, setting @error to
3628 * %G_IO_ERROR_NOT_SUPPORTED.
3629 *
3630 * For a local #GFile the newly created directory will have the default
3631 * (current) ownership and permissions of the current process.
3632 *
3633 * If @cancellable is not %NULL, then the operation can be cancelled by
3634 * triggering the cancellable object from another thread. If the operation
3635 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3636 *
3637 * Returns: %TRUE on successful creation, %FALSE otherwise.
3638 */
3639 gboolean
3643 {
3654 {
3656 G_IO_ERROR_NOT_SUPPORTED,
3659 }
3662 }
3664 /**
3665 * g_file_make_directory_async:
3666 * @file: input #GFile
3667 * @io_priority: the [I/O priority][io-priority] of the request
3668 * @cancellable: (nullable): optional #GCancellable object,
3669 * %NULL to ignore
3670 * @callback: a #GAsyncReadyCallback to call
3671 * when the request is satisfied
3672 * @user_data: the data to pass to callback function
3673 *
3674 * Asynchronously creates a directory.
3675 *
3676 * Virtual: make_directory_async
3677 * Since: 2.38
3678 */
3679 void
3683 GAsyncReadyCallback callback,
3684 gpointer user_data)
3685 {
3692 io_priority,
3693 cancellable,
3694 callback,
3695 user_data);
3696 }
3698 /**
3699 * g_file_make_directory_finish:
3700 * @file: input #GFile
3701 * @result: a #GAsyncResult
3702 * @error: a #GError, or %NULL
3703 *
3704 * Finishes an asynchronous directory creation, started with
3705 * g_file_make_directory_async().
3706 *
3707 * Virtual: make_directory_finish
3708 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3709 * Since: 2.38
3710 */
3711 gboolean
3715 {
3723 }
3725 /**
3726 * g_file_make_directory_with_parents:
3727 * @file: input #GFile
3728 * @cancellable: (nullable): optional #GCancellable object,
3729 * %NULL to ignore
3730 * @error: a #GError, or %NULL
3731 *
3732 * Creates a directory and any parent directories that may not
3733 * exist similar to 'mkdir -p'. If the file system does not support
3734 * creating directories, this function will fail, setting @error to
3735 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3736 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3737 * the similar g_mkdir_with_parents().
3738 *
3739 * For a local #GFile the newly created directories will have the default
3740 * (current) ownership and permissions of the current process.
3741 *
3742 * If @cancellable is not %NULL, then the operation can be cancelled by
3743 * triggering the cancellable object from another thread. If the operation
3744 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3745 *
3746 * Returns: %TRUE if all directories have been successfully created, %FALSE
3747 * otherwise.
3748 *
3749 * Since: 2.18
3750 */
3751 gboolean
3755 {
3765 /* Try for the simple case of not having to create any parent
3766 * directories. If any parent directory needs to be created, this
3767 * call will fail with NOT_FOUND. If that happens, then that value of
3768 * my_error persists into the while loop below.
3769 */
3772 {
3776 }
3780 /* Creates the parent directories as needed. In case any particular
3781 * creation operation fails for lack of other parent directories
3782 * (NOT_FOUND), the directory is added to a list of directories to
3783 * create later, and the value of my_error is retained until the next
3784 * iteration of the loop. After the loop my_error should either be
3785 * empty or contain a real failure condition.
3786 */
3788 {
3797 /* Another process may have created the directory in between the
3798 * G_IO_ERROR_NOT_FOUND and now
3799 */
3808 else
3810 }
3812 /* All directories should be able to be created now, so an error at
3813 * this point means the whole operation must fail -- except an EXISTS
3814 * error, which means that another process already created the
3815 * directory in between the previous failure and now.
3816 */
3818 {
3822 }
3827 /* Clean up */
3829 {
3832 }
3834 /* At this point an error in my_error means a that something
3835 * unexpected failed in either of the loops above, so the whole
3836 * operation must fail.
3837 */
3839 {
3842 }
3845 }
3847 /**
3848 * g_file_make_symbolic_link:
3849 * @file: a #GFile with the name of the symlink to create
3850 * @symlink_value: (type filename): a string with the path for the target
3851 * of the new symlink
3852 * @cancellable: (nullable): optional #GCancellable object,
3853 * %NULL to ignore
3854 * @error: a #GError
3855 *
3856 * Creates a symbolic link named @file which contains the string
3857 * @symlink_value.
3858 *
3859 * If @cancellable is not %NULL, then the operation can be cancelled by
3860 * triggering the cancellable object from another thread. If the operation
3861 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3862 *
3863 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3864 */
3865 gboolean
3870 {
3880 {
3882 G_IO_ERROR_INVALID_ARGUMENT,
3885 }
3890 {
3892 G_IO_ERROR_NOT_SUPPORTED,
3895 }
3898 }
3900 /**
3901 * g_file_delete:
3902 * @file: input #GFile
3903 * @cancellable: (nullable): optional #GCancellable object,
3904 * %NULL to ignore
3905 * @error: a #GError, or %NULL
3906 *
3907 * Deletes a file. If the @file is a directory, it will only be
3908 * deleted if it is empty. This has the same semantics as g_unlink().
3909 *
3910 * If @cancellable is not %NULL, then the operation can be cancelled by
3911 * triggering the cancellable object from another thread. If the operation
3912 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3913 *
3914 * Virtual: delete_file
3915 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3916 */
3917 gboolean
3921 {
3932 {
3934 G_IO_ERROR_NOT_SUPPORTED,
3937 }
3940 }
3942 /**
3943 * g_file_delete_async:
3944 * @file: input #GFile
3945 * @io_priority: the [I/O priority][io-priority] of the request
3946 * @cancellable: (nullable): optional #GCancellable object,
3947 * %NULL to ignore
3948 * @callback: a #GAsyncReadyCallback to call
3949 * when the request is satisfied
3950 * @user_data: the data to pass to callback function
3951 *
3952 * Asynchronously delete a file. If the @file is a directory, it will
3953 * only be deleted if it is empty. This has the same semantics as
3954 * g_unlink().
3955 *
3956 * Virtual: delete_file_async
3957 * Since: 2.34
3958 */
3959 void
3963 GAsyncReadyCallback callback,
3964 gpointer user_data)
3965 {
3972 io_priority,
3973 cancellable,
3974 callback,
3975 user_data);
3976 }
3978 /**
3979 * g_file_delete_finish:
3980 * @file: input #GFile
3981 * @result: a #GAsyncResult
3982 * @error: a #GError, or %NULL
3983 *
3984 * Finishes deleting a file started with g_file_delete_async().
3985 *
3986 * Virtual: delete_file_finish
3987 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3988 * Since: 2.34
3989 **/
3990 gboolean
3994 {
4005 }
4007 /**
4008 * g_file_trash:
4009 * @file: #GFile to send to trash
4010 * @cancellable: (nullable): optional #GCancellable object,
4011 * %NULL to ignore
4012 * @error: a #GError, or %NULL
4013 *
4014 * Sends @file to the "Trashcan", if possible. This is similar to
4015 * deleting it, but the user can recover it before emptying the trashcan.
4016 * Not all file systems support trashing, so this call can return the
4017 * %G_IO_ERROR_NOT_SUPPORTED error.
4018 *
4019 * If @cancellable is not %NULL, then the operation can be cancelled by
4020 * triggering the cancellable object from another thread. If the operation
4021 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4022 *
4023 * Virtual: trash
4024 * Returns: %TRUE on successful trash, %FALSE otherwise.
4025 */
4026 gboolean
4030 {
4041 {
4046 }
4049 }
4051 /**
4052 * g_file_trash_async:
4053 * @file: input #GFile
4054 * @io_priority: the [I/O priority][io-priority] of the request
4055 * @cancellable: (nullable): optional #GCancellable object,
4056 * %NULL to ignore
4057 * @callback: a #GAsyncReadyCallback to call
4058 * when the request is satisfied
4059 * @user_data: the data to pass to callback function
4060 *
4061 * Asynchronously sends @file to the Trash location, if possible.
4062 *
4063 * Virtual: trash_async
4064 * Since: 2.38
4065 */
4066 void
4070 GAsyncReadyCallback callback,
4071 gpointer user_data)
4072 {
4079 io_priority,
4080 cancellable,
4081 callback,
4082 user_data);
4083 }
4085 /**
4086 * g_file_trash_finish:
4087 * @file: input #GFile
4088 * @result: a #GAsyncResult
4089 * @error: a #GError, or %NULL
4090 *
4091 * Finishes an asynchronous file trashing operation, started with
4092 * g_file_trash_async().
4093 *
4094 * Virtual: trash_finish
4095 * Returns: %TRUE on successful trash, %FALSE otherwise.
4096 * Since: 2.38
4097 */
4098 gboolean
4102 {
4110 }
4112 /**
4113 * g_file_set_display_name:
4114 * @file: input #GFile
4115 * @display_name: a string
4116 * @cancellable: (nullable): optional #GCancellable object,
4117 * %NULL to ignore
4118 * @error: a #GError, or %NULL
4119 *
4120 * Renames @file to the specified display name.
4121 *
4122 * The display name is converted from UTF-8 to the correct encoding
4123 * for the target filesystem if possible and the @file is renamed to this.
4124 *
4125 * If you want to implement a rename operation in the user interface the
4126 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4127 * initial value in the rename widget, and then the result after editing
4128 * should be passed to g_file_set_display_name().
4129 *
4130 * On success the resulting converted filename is returned.
4131 *
4132 * If @cancellable is not %NULL, then the operation can be cancelled by
4133 * triggering the cancellable object from another thread. If the operation
4134 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4135 *
4136 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4137 * or %NULL if there was an error.
4138 * Free the returned object with g_object_unref().
4139 */
4140 GFile *
4145 {
4152 {
4154 G_IO_ERROR,
4155 G_IO_ERROR_INVALID_ARGUMENT,
4158 }
4166 }
4168 /**
4169 * g_file_set_display_name_async:
4170 * @file: input #GFile
4171 * @display_name: a string
4172 * @io_priority: the [I/O priority][io-priority] of the request
4173 * @cancellable: (nullable): optional #GCancellable object,
4174 * %NULL to ignore
4175 * @callback: (scope async): a #GAsyncReadyCallback to call
4176 * when the request is satisfied
4177 * @user_data: (closure): the data to pass to callback function
4178 *
4179 * Asynchronously sets the display name for a given #GFile.
4180 *
4181 * For more details, see g_file_set_display_name() which is
4182 * the synchronous version of this call.
4183 *
4184 * When the operation is finished, @callback will be called.
4185 * You can then call g_file_set_display_name_finish() to get
4186 * the result of the operation.
4187 */
4188 void
4191 gint io_priority,
4193 GAsyncReadyCallback callback,
4194 gpointer user_data)
4195 {
4203 display_name,
4204 io_priority,
4205 cancellable,
4206 callback,
4207 user_data);
4208 }
4210 /**
4211 * g_file_set_display_name_finish:
4212 * @file: input #GFile
4213 * @res: a #GAsyncResult
4214 * @error: a #GError, or %NULL
4215 *
4216 * Finishes setting a display name started with
4217 * g_file_set_display_name_async().
4218 *
4219 * Returns: (transfer full): a #GFile or %NULL on error.
4220 * Free the returned object with g_object_unref().
4221 */
4222 GFile *
4226 {
4237 }
4239 /**
4240 * g_file_query_settable_attributes:
4241 * @file: input #GFile
4242 * @cancellable: (nullable): optional #GCancellable object,
4243 * %NULL to ignore
4244 * @error: a #GError, or %NULL
4245 *
4246 * Obtain the list of settable attributes for the file.
4247 *
4248 * Returns the type and full attribute name of all the attributes
4249 * that can be set on this file. This doesn't mean setting it will
4250 * always succeed though, you might get an access failure, or some
4251 * specific file may not support a specific attribute.
4252 *
4253 * If @cancellable is not %NULL, then the operation can be cancelled by
4254 * triggering the cancellable object from another thread. If the operation
4255 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4256 *
4257 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4258 * When you are done with it, release it with
4259 * g_file_attribute_info_list_unref()
4260 */
4261 GFileAttributeInfoList *
4265 {
4284 {
4286 {
4289 }
4290 else
4292 }
4295 }
4297 /**
4298 * g_file_query_writable_namespaces:
4299 * @file: input #GFile
4300 * @cancellable: (nullable): optional #GCancellable object,
4301 * %NULL to ignore
4302 * @error: a #GError, or %NULL
4303 *
4304 * Obtain the list of attribute namespaces where new attributes
4305 * can be created by a user. An example of this is extended
4306 * attributes (in the "xattr" namespace).
4307 *
4308 * If @cancellable is not %NULL, then the operation can be cancelled by
4309 * triggering the cancellable object from another thread. If the operation
4310 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4311 *
4312 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4313 * When you are done with it, release it with
4314 * g_file_attribute_info_list_unref()
4315 */
4316 GFileAttributeInfoList *
4320 {
4339 {
4342 }
4345 {
4347 {
4349 }
4350 else
4352 }
4355 }
4357 /**
4358 * g_file_set_attribute:
4359 * @file: input #GFile
4360 * @attribute: a string containing the attribute's name
4361 * @type: The type of the attribute
4362 * @value_p: (nullable): a pointer to the value (or the pointer
4363 * itself if the type is a pointer type)
4364 * @flags: a set of #GFileQueryInfoFlags
4365 * @cancellable: (nullable): optional #GCancellable object,
4366 * %NULL to ignore
4367 * @error: a #GError, or %NULL
4368 *
4369 * Sets an attribute in the file with attribute name @attribute to @value.
4370 *
4371 * Some attributes can be unset by setting @attribute to
4372 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4373 *
4374 * If @cancellable is not %NULL, then the operation can be cancelled by
4375 * triggering the cancellable object from another thread. If the operation
4376 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4377 *
4378 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4379 */
4380 gboolean
4383 GFileAttributeType type,
4384 gpointer value_p,
4385 GFileQueryInfoFlags flags,
4388 {
4400 {
4402 G_IO_ERROR_NOT_SUPPORTED,
4405 }
4408 }
4410 /**
4411 * g_file_set_attributes_from_info:
4412 * @file: input #GFile
4413 * @info: a #GFileInfo
4414 * @flags: #GFileQueryInfoFlags
4415 * @cancellable: (nullable): optional #GCancellable object,
4416 * %NULL to ignore
4417 * @error: a #GError, or %NULL
4418 *
4419 * Tries to set all attributes in the #GFileInfo on the target
4420 * values, not stopping on the first error.
4421 *
4422 * If there is any error during this operation then @error will
4423 * be set to the first error. Error on particular fields are flagged
4424 * by setting the "status" field in the attribute value to
4425 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4426 * also detect further errors.
4427 *
4428 * If @cancellable is not %NULL, then the operation can be cancelled by
4429 * triggering the cancellable object from another thread. If the operation
4430 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4431 *
4432 * Returns: %FALSE if there was any error, %TRUE otherwise.
4433 */
4434 gboolean
4437 GFileQueryInfoFlags flags,
4440 {
4454 info,
4455 flags,
4456 cancellable,
4457 error);
4458 }
4460 static gboolean
4463 GFileQueryInfoFlags flags,
4466 {
4469 gboolean res;
4477 {
4486 {
4489 /* Don't set error multiple times */
4491 }
4492 else
4494 }
4499 }
4501 /**
4502 * g_file_set_attributes_async:
4503 * @file: input #GFile
4504 * @info: a #GFileInfo
4505 * @flags: a #GFileQueryInfoFlags
4506 * @io_priority: the [I/O priority][io-priority] of the request
4507 * @cancellable: (nullable): optional #GCancellable object,
4508 * %NULL to ignore
4509 * @callback: (scope async): a #GAsyncReadyCallback
4510 * @user_data: (closure): a #gpointer
4511 *
4512 * Asynchronously sets the attributes of @file with @info.
4513 *
4514 * For more details, see g_file_set_attributes_from_info(),
4515 * which is the synchronous version of this call.
4516 *
4517 * When the operation is finished, @callback will be called.
4518 * You can then call g_file_set_attributes_finish() to get
4519 * the result of the operation.
4520 */
4521 void
4524 GFileQueryInfoFlags flags,
4527 GAsyncReadyCallback callback,
4528 gpointer user_data)
4529 {
4537 info,
4538 flags,
4539 io_priority,
4540 cancellable,
4541 callback,
4542 user_data);
4543 }
4545 /**
4546 * g_file_set_attributes_finish:
4547 * @file: input #GFile
4548 * @result: a #GAsyncResult
4549 * @info: (out) (transfer full): a #GFileInfo
4550 * @error: a #GError, or %NULL
4551 *
4552 * Finishes setting an attribute started in g_file_set_attributes_async().
4553 *
4554 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4555 */
4556 gboolean
4561 {
4567 /* No standard handling of errors here, as we must set info even
4568 * on errors
4569 */
4572 }
4574 /**
4575 * g_file_set_attribute_string:
4576 * @file: input #GFile
4577 * @attribute: a string containing the attribute's name
4578 * @value: a string containing the attribute's value
4579 * @flags: #GFileQueryInfoFlags
4580 * @cancellable: (nullable): optional #GCancellable object,
4581 * %NULL to ignore
4582 * @error: a #GError, or %NULL
4583 *
4584 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4585 * If @attribute is of a different type, this operation will fail.
4586 *
4587 * If @cancellable is not %NULL, then the operation can be cancelled by
4588 * triggering the cancellable object from another thread. If the operation
4589 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4590 *
4591 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4592 */
4593 gboolean
4597 GFileQueryInfoFlags flags,
4600 {
4604 }
4606 /**
4607 * g_file_set_attribute_byte_string:
4608 * @file: input #GFile
4609 * @attribute: a string containing the attribute's name
4610 * @value: a string containing the attribute's new value
4611 * @flags: a #GFileQueryInfoFlags
4612 * @cancellable: (nullable): optional #GCancellable object,
4613 * %NULL to ignore
4614 * @error: a #GError, or %NULL
4615 *
4616 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4617 * If @attribute is of a different type, this operation will fail,
4618 * returning %FALSE.
4619 *
4620 * If @cancellable is not %NULL, then the operation can be cancelled by
4621 * triggering the cancellable object from another thread. If the operation
4622 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4623 *
4624 * Returns: %TRUE if the @attribute was successfully set to @value
4625 * in the @file, %FALSE otherwise.
4626 */
4627 gboolean
4631 GFileQueryInfoFlags flags,
4634 {
4638 }
4640 /**
4641 * g_file_set_attribute_uint32:
4642 * @file: input #GFile
4643 * @attribute: a string containing the attribute's name
4644 * @value: a #guint32 containing the attribute's new value
4645 * @flags: a #GFileQueryInfoFlags
4646 * @cancellable: (nullable): optional #GCancellable object,
4647 * %NULL to ignore
4648 * @error: a #GError, or %NULL
4649 *
4650 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4651 * If @attribute is of a different type, this operation will fail.
4652 *
4653 * If @cancellable is not %NULL, then the operation can be cancelled by
4654 * triggering the cancellable object from another thread. If the operation
4655 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4656 *
4657 * Returns: %TRUE if the @attribute was successfully set to @value
4658 * in the @file, %FALSE otherwise.
4659 */
4660 gboolean
4663 guint32 value,
4664 GFileQueryInfoFlags flags,
4667 {
4671 }
4673 /**
4674 * g_file_set_attribute_int32:
4675 * @file: input #GFile
4676 * @attribute: a string containing the attribute's name
4677 * @value: a #gint32 containing the attribute's new value
4678 * @flags: a #GFileQueryInfoFlags
4679 * @cancellable: (nullable): optional #GCancellable object,
4680 * %NULL to ignore
4681 * @error: a #GError, or %NULL
4682 *
4683 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4684 * If @attribute is of a different type, this operation will fail.
4685 *
4686 * If @cancellable is not %NULL, then the operation can be cancelled by
4687 * triggering the cancellable object from another thread. If the operation
4688 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4689 *
4690 * Returns: %TRUE if the @attribute was successfully set to @value
4691 * in the @file, %FALSE otherwise.
4692 */
4693 gboolean
4696 gint32 value,
4697 GFileQueryInfoFlags flags,
4700 {
4704 }
4706 /**
4707 * g_file_set_attribute_uint64:
4708 * @file: input #GFile
4709 * @attribute: a string containing the attribute's name
4710 * @value: a #guint64 containing the attribute's new value
4711 * @flags: a #GFileQueryInfoFlags
4712 * @cancellable: (nullable): optional #GCancellable object,
4713 * %NULL to ignore
4714 * @error: a #GError, or %NULL
4715 *
4716 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4717 * If @attribute is of a different type, this operation will fail.
4718 *
4719 * If @cancellable is not %NULL, then the operation can be cancelled by
4720 * triggering the cancellable object from another thread. If the operation
4721 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4722 *
4723 * Returns: %TRUE if the @attribute was successfully set to @value
4724 * in the @file, %FALSE otherwise.
4725 */
4726 gboolean
4729 guint64 value,
4730 GFileQueryInfoFlags flags,
4733 {
4737 }
4739 /**
4740 * g_file_set_attribute_int64:
4741 * @file: input #GFile
4742 * @attribute: a string containing the attribute's name
4743 * @value: a #guint64 containing the attribute's new value
4744 * @flags: a #GFileQueryInfoFlags
4745 * @cancellable: (nullable): optional #GCancellable object,
4746 * %NULL to ignore
4747 * @error: a #GError, or %NULL
4748 *
4749 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4750 * If @attribute is of a different type, this operation will fail.
4751 *
4752 * If @cancellable is not %NULL, then the operation can be cancelled by
4753 * triggering the cancellable object from another thread. If the operation
4754 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4755 *
4756 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4757 */
4758 gboolean
4761 gint64 value,
4762 GFileQueryInfoFlags flags,
4765 {
4769 }
4771 /**
4772 * g_file_mount_mountable:
4773 * @file: input #GFile
4774 * @flags: flags affecting the operation
4775 * @mount_operation: (nullable): a #GMountOperation,
4776 * or %NULL to avoid user interaction
4777 * @cancellable: (nullable): optional #GCancellable object,
4778 * %NULL to ignore
4779 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4780 * when the request is satisfied, or %NULL
4781 * @user_data: (closure): the data to pass to callback function
4782 *
4783 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4784 * Using @mount_operation, you can request callbacks when, for instance,
4785 * passwords are needed during authentication.
4786 *
4787 * If @cancellable is not %NULL, then the operation can be cancelled by
4788 * triggering the cancellable object from another thread. If the operation
4789 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4790 *
4791 * When the operation is finished, @callback will be called.
4792 * You can then call g_file_mount_mountable_finish() to get
4793 * the result of the operation.
4794 */
4795 void
4797 GMountMountFlags flags,
4800 GAsyncReadyCallback callback,
4801 gpointer user_data)
4802 {
4810 {
4812 g_file_mount_mountable,
4816 }
4819 flags,
4820 mount_operation,
4821 cancellable,
4822 callback,
4823 user_data);
4824 }
4826 /**
4827 * g_file_mount_mountable_finish:
4828 * @file: input #GFile
4829 * @result: a #GAsyncResult
4830 * @error: a #GError, or %NULL
4831 *
4832 * Finishes a mount operation. See g_file_mount_mountable() for details.
4833 *
4834 * Finish an asynchronous mount operation that was started
4835 * with g_file_mount_mountable().
4836 *
4837 * Returns: (transfer full): a #GFile or %NULL on error.
4838 * Free the returned object with g_object_unref().
4839 */
4840 GFile *
4844 {
4857 }
4859 /**
4860 * g_file_unmount_mountable:
4861 * @file: input #GFile
4862 * @flags: flags affecting the operation
4863 * @cancellable: (nullable): optional #GCancellable object,
4864 * %NULL to ignore
4865 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4866 * when the request is satisfied, or %NULL
4867 * @user_data: (closure): the data to pass to callback function
4868 *
4869 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4870 *
4871 * If @cancellable is not %NULL, then the operation can be cancelled by
4872 * triggering the cancellable object from another thread. If the operation
4873 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4874 *
4875 * When the operation is finished, @callback will be called.
4876 * You can then call g_file_unmount_mountable_finish() to get
4877 * the result of the operation.
4878 *
4879 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4880 */
4881 void
4883 GMountUnmountFlags flags,
4885 GAsyncReadyCallback callback,
4886 gpointer user_data)
4887 {
4895 {
4897 g_file_unmount_mountable_with_operation,
4901 }
4904 flags,
4905 cancellable,
4906 callback,
4907 user_data);
4908 }
4910 /**
4911 * g_file_unmount_mountable_finish:
4912 * @file: input #GFile
4913 * @result: a #GAsyncResult
4914 * @error: a #GError, or %NULL
4915 *
4916 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4917 *
4918 * Finish an asynchronous unmount operation that was started
4919 * with g_file_unmount_mountable().
4920 *
4921 * Returns: %TRUE if the operation finished successfully.
4922 * %FALSE otherwise.
4923 *
4924 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
4925 * instead.
4926 */
4927 gboolean
4931 {
4944 }
4946 /**
4947 * g_file_unmount_mountable_with_operation:
4948 * @file: input #GFile
4949 * @flags: flags affecting the operation
4950 * @mount_operation: (nullable): a #GMountOperation,
4951 * or %NULL to avoid user interaction
4952 * @cancellable: (nullable): optional #GCancellable object,
4953 * %NULL to ignore
4954 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
4955 * when the request is satisfied, or %NULL
4956 * @user_data: (closure): the data to pass to callback function
4957 *
4958 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
4959 *
4960 * If @cancellable is not %NULL, then the operation can be cancelled by
4961 * triggering the cancellable object from another thread. If the operation
4962 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4963 *
4964 * When the operation is finished, @callback will be called.
4965 * You can then call g_file_unmount_mountable_finish() to get
4966 * the result of the operation.
4967 *
4968 * Since: 2.22
4969 */
4970 void
4972 GMountUnmountFlags flags,
4975 GAsyncReadyCallback callback,
4976 gpointer user_data)
4977 {
4985 {
4987 g_file_unmount_mountable_with_operation,
4991 }
4995 flags,
4996 mount_operation,
4997 cancellable,
4998 callback,
4999 user_data);
5000 else
5002 flags,
5003 cancellable,
5004 callback,
5005 user_data);
5006 }
5008 /**
5009 * g_file_unmount_mountable_with_operation_finish:
5010 * @file: input #GFile
5011 * @result: a #GAsyncResult
5012 * @error: a #GError, or %NULL
5013 *
5014 * Finishes an unmount operation,
5015 * see g_file_unmount_mountable_with_operation() for details.
5016 *
5017 * Finish an asynchronous unmount operation that was started
5018 * with g_file_unmount_mountable_with_operation().
5019 *
5020 * Returns: %TRUE if the operation finished successfully.
5021 * %FALSE otherwise.
5022 *
5023 * Since: 2.22
5024 */
5025 gboolean
5029 {
5043 else
5045 }
5047 /**
5048 * g_file_eject_mountable:
5049 * @file: input #GFile
5050 * @flags: flags affecting the operation
5051 * @cancellable: (nullable): optional #GCancellable object,
5052 * %NULL to ignore
5053 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5054 * when the request is satisfied, or %NULL
5055 * @user_data: (closure): the data to pass to callback function
5056 *
5057 * Starts an asynchronous eject on a mountable.
5058 * When this operation has completed, @callback will be called with
5059 * @user_user data, and the operation can be finalized with
5060 * g_file_eject_mountable_finish().
5061 *
5062 * If @cancellable is not %NULL, then the operation can be cancelled by
5063 * triggering the cancellable object from another thread. If the operation
5064 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5065 *
5066 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5067 */
5068 void
5070 GMountUnmountFlags flags,
5072 GAsyncReadyCallback callback,
5073 gpointer user_data)
5074 {
5082 {
5084 g_file_eject_mountable_with_operation,
5088 }
5091 flags,
5092 cancellable,
5093 callback,
5094 user_data);
5095 }
5097 /**
5098 * g_file_eject_mountable_finish:
5099 * @file: input #GFile
5100 * @result: a #GAsyncResult
5101 * @error: a #GError, or %NULL
5102 *
5103 * Finishes an asynchronous eject operation started by
5104 * g_file_eject_mountable().
5105 *
5106 * Returns: %TRUE if the @file was ejected successfully.
5107 * %FALSE otherwise.
5108 *
5109 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5110 * instead.
5111 */
5112 gboolean
5116 {
5129 }
5131 /**
5132 * g_file_eject_mountable_with_operation:
5133 * @file: input #GFile
5134 * @flags: flags affecting the operation
5135 * @mount_operation: (nullable): a #GMountOperation,
5136 * or %NULL to avoid user interaction
5137 * @cancellable: (nullable): optional #GCancellable object,
5138 * %NULL to ignore
5139 * @callback: (scope async) (nullable): a #GAsyncReadyCallback to call
5140 * when the request is satisfied, or %NULL
5141 * @user_data: (closure): the data to pass to callback function
5142 *
5143 * Starts an asynchronous eject on a mountable.
5144 * When this operation has completed, @callback will be called with
5145 * @user_user data, and the operation can be finalized with
5146 * g_file_eject_mountable_with_operation_finish().
5147 *
5148 * If @cancellable is not %NULL, then the operation can be cancelled by
5149 * triggering the cancellable object from another thread. If the operation
5150 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5151 *
5152 * Since: 2.22
5153 */
5154 void
5156 GMountUnmountFlags flags,
5159 GAsyncReadyCallback callback,
5160 gpointer user_data)
5161 {
5169 {
5171 g_file_eject_mountable_with_operation,
5175 }
5179 flags,
5180 mount_operation,
5181 cancellable,
5182 callback,
5183 user_data);
5184 else
5186 flags,
5187 cancellable,
5188 callback,
5189 user_data);
5190 }
5192 /**
5193 * g_file_eject_mountable_with_operation_finish:
5194 * @file: input #GFile
5195 * @result: a #GAsyncResult
5196 * @error: a #GError, or %NULL
5197 *
5198 * Finishes an asynchronous eject operation started by
5199 * g_file_eject_mountable_with_operation().
5200 *
5201 * Returns: %TRUE if the @file was ejected successfully.
5202 * %FALSE otherwise.
5203 *
5204 * Since: 2.22
5205 */
5206 gboolean
5210 {
5224 else
5226 }
5228 /**
5229 * g_file_monitor_directory:
5230 * @file: input #GFile
5231 * @flags: a set of #GFileMonitorFlags
5232 * @cancellable: (nullable): optional #GCancellable object,
5233 * %NULL to ignore
5234 * @error: a #GError, or %NULL
5235 *
5236 * Obtains a directory monitor for the given file.
5237 * This may fail if directory monitoring is not supported.
5238 *
5239 * If @cancellable is not %NULL, then the operation can be cancelled by
5240 * triggering the cancellable object from another thread. If the operation
5241 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5242 *
5243 * It does not make sense for @flags to contain
5244 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5245 * directories. It is not possible to monitor all the files in a
5246 * directory for changes made via hard links; if you want to do this then
5247 * you must register individual watches with g_file_monitor().
5248 *
5249 * Virtual: monitor_dir
5250 * Returns: (transfer full): a #GFileMonitor for the given @file,
5251 * or %NULL on error.
5252 * Free the returned object with g_object_unref().
5253 */
5254 GFileMonitor *
5256 GFileMonitorFlags flags,
5259 {
5271 {
5273 G_IO_ERROR_NOT_SUPPORTED,
5276 }
5279 }
5281 /**
5282 * g_file_monitor_file:
5283 * @file: input #GFile
5284 * @flags: a set of #GFileMonitorFlags
5285 * @cancellable: (nullable): optional #GCancellable object,
5286 * %NULL to ignore
5287 * @error: a #GError, or %NULL
5288 *
5289 * Obtains a file monitor for the given file. If no file notification
5290 * mechanism exists, then regular polling of the file is used.
5291 *
5292 * If @cancellable is not %NULL, then the operation can be cancelled by
5293 * triggering the cancellable object from another thread. If the operation
5294 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5295 *
5296 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5297 * will also attempt to report changes made to the file via another
5298 * filename (ie, a hard link). Without this flag, you can only rely on
5299 * changes made through the filename contained in @file to be
5300 * reported. Using this flag may result in an increase in resource
5301 * usage, and may not have any effect depending on the #GFileMonitor
5302 * backend and/or filesystem type.
5303 *
5304 * Returns: (transfer full): a #GFileMonitor for the given @file,
5305 * or %NULL on error.
5306 * Free the returned object with g_object_unref().
5307 */
5308 GFileMonitor *
5310 GFileMonitorFlags flags,
5313 {
5329 /* Fallback to polling */
5334 }
5336 /**
5337 * g_file_monitor:
5338 * @file: input #GFile
5339 * @flags: a set of #GFileMonitorFlags
5340 * @cancellable: (nullable): optional #GCancellable object,
5341 * %NULL to ignore
5342 * @error: a #GError, or %NULL
5343 *
5344 * Obtains a file or directory monitor for the given file,
5345 * depending on the type of the file.
5346 *
5347 * If @cancellable is not %NULL, then the operation can be cancelled by
5348 * triggering the cancellable object from another thread. If the operation
5349 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5350 *
5351 * Returns: (transfer full): a #GFileMonitor for the given @file,
5352 * or %NULL on error.
5353 * Free the returned object with g_object_unref().
5354 *
5355 * Since: 2.18
5356 */
5357 GFileMonitor *
5359 GFileMonitorFlags flags,
5362 {
5367 else
5369 }
5371 /********************************************
5372 * Default implementation of async ops *
5373 ********************************************/
5377 GFileQueryInfoFlags flags;
5380 static void
5382 {
5385 }
5387 static void
5389 gpointer object,
5390 gpointer task_data,
5392 {
5397 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5400 else
5402 }
5404 static void
5407 GFileQueryInfoFlags flags,
5410 GAsyncReadyCallback callback,
5411 gpointer user_data)
5412 {
5426 }
5432 {
5436 }
5438 static void
5440 gpointer object,
5441 gpointer task_data,
5443 {
5451 else
5453 }
5455 static void
5460 GAsyncReadyCallback callback,
5461 gpointer user_data)
5462 {
5471 }
5477 {
5481 }
5483 static void
5485 gpointer object,
5486 gpointer task_data,
5488 {
5493 enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5496 else
5498 }
5500 static void
5503 GFileQueryInfoFlags flags,
5506 GAsyncReadyCallback callback,
5507 gpointer user_data)
5508 {
5522 }
5528 {
5532 }
5534 static void
5536 gpointer object,
5537 gpointer task_data,
5539 {
5546 else
5548 }
5550 static void
5554 GAsyncReadyCallback callback,
5555 gpointer user_data)
5556 {
5564 }
5570 {
5574 }
5576 static void
5578 gpointer source_object,
5579 gpointer task_data,
5581 {
5589 else
5591 }
5593 static void
5595 GFileCreateFlags flags,
5598 GAsyncReadyCallback callback,
5599 gpointer user_data)
5600 {
5614 }
5620 {
5624 }
5626 static void
5628 gpointer source_object,
5629 gpointer task_data,
5631 {
5639 else
5641 }
5643 static void
5645 GFileCreateFlags flags,
5648 GAsyncReadyCallback callback,
5649 gpointer user_data)
5650 {
5664 }
5670 {
5674 }
5679 gboolean make_backup;
5680 GFileCreateFlags flags;
5683 static void
5685 {
5690 }
5692 static void
5694 gpointer source_object,
5695 gpointer task_data,
5697 {
5706 cancellable,
5711 else
5713 }
5715 static void
5718 gboolean make_backup,
5719 GFileCreateFlags flags,
5722 GAsyncReadyCallback callback,
5723 gpointer user_data)
5724 {
5740 }
5746 {
5750 }
5752 static void
5754 gpointer object,
5755 gpointer task_data,
5757 {
5762 else
5764 }
5766 static void
5770 GAsyncReadyCallback callback,
5771 gpointer user_data)
5772 {
5780 }
5782 static gboolean
5786 {
5790 }
5792 static void
5794 gpointer object,
5795 gpointer task_data,
5797 {
5802 else
5804 }
5806 static void
5810 GAsyncReadyCallback callback,
5811 gpointer user_data)
5812 {
5820 }
5822 static gboolean
5826 {
5830 }
5832 static void
5834 gpointer object,
5835 gpointer task_data,
5837 {
5842 else
5844 }
5846 static void
5850 GAsyncReadyCallback callback,
5851 gpointer user_data)
5852 {
5860 }
5862 static gboolean
5866 {
5870 }
5872 static void
5874 gpointer object,
5875 gpointer task_data,
5877 {
5885 else
5887 }
5889 static void
5893 GAsyncReadyCallback callback,
5894 gpointer user_data)
5895 {
5904 }
5910 {
5914 }
5916 static void
5918 gpointer object,
5919 gpointer task_data,
5921 {
5930 else
5932 }
5934 static void
5936 GFileCreateFlags flags,
5939 GAsyncReadyCallback callback,
5940 gpointer user_data)
5941 {
5955 }
5961 {
5965 }
5969 gboolean make_backup;
5970 GFileCreateFlags flags;
5973 static void
5975 {
5978 }
5980 static void
5982 gpointer object,
5983 gpointer task_data,
5985 {
5994 cancellable,
5999 else
6001 }
6003 static void
6006 gboolean make_backup,
6007 GFileCreateFlags flags,
6010 GAsyncReadyCallback callback,
6011 gpointer user_data)
6012 {
6028 }
6034 {
6038 }
6040 static void
6042 gpointer object,
6043 gpointer task_data,
6045 {
6054 else
6056 }
6058 static void
6063 GAsyncReadyCallback callback,
6064 gpointer user_data)
6065 {
6075 }
6081 {
6085 }
6088 GFileQueryInfoFlags flags;
6090 gboolean res;
6094 static void
6096 {
6102 }
6104 static void
6106 gpointer object,
6107 gpointer task_data,
6109 {
6116 cancellable,
6118 }
6120 static void
6123 GFileQueryInfoFlags flags,
6126 GAsyncReadyCallback callback,
6127 gpointer user_data)
6128 {
6143 }
6145 static gboolean
6150 {
6164 }
6166 static void
6168 gpointer object,
6169 gpointer task_data,
6171 {
6179 else
6181 }
6183 static void
6187 GAsyncReadyCallback callback,
6188 gpointer user_data)
6189 {
6198 }
6204 {
6208 }
6214 GFileCopyFlags flags;
6215 GFileProgressCallback progress_cb;
6216 gpointer progress_cb_data;
6219 static void
6221 {
6225 }
6229 goffset current_num_bytes;
6230 goffset total_num_bytes;
6233 static gboolean
6235 {
6244 }
6246 static void
6248 goffset total_num_bytes,
6249 gpointer user_data)
6250 {
6262 copy_async_progress_in_main,
6263 progress,
6264 g_free);
6265 }
6267 static void
6269 gpointer source,
6270 gpointer task_data,
6272 {
6274 gboolean result;
6280 cancellable,
6282 task,
6286 else
6288 }
6290 static void
6293 GFileCopyFlags flags,
6296 GFileProgressCallback progress_callback,
6297 gpointer progress_callback_data,
6298 GAsyncReadyCallback callback,
6299 gpointer user_data)
6300 {
6317 }
6319 static gboolean
6323 {
6327 }
6330 /********************************************
6331 * Default VFS operations *
6332 ********************************************/
6334 /**
6335 * g_file_new_for_path:
6336 * @path: (type filename): a string containing a relative or absolute path.
6337 * The string must be encoded in the glib filename encoding.
6338 *
6339 * Constructs a #GFile for a given path. This operation never
6340 * fails, but the returned object might not support any I/O
6341 * operation if @path is malformed.
6342 *
6343 * Returns: (transfer full): a new #GFile for the given @path.
6344 * Free the returned object with g_object_unref().
6345 */
6346 GFile *
6348 {
6352 }
6354 /**
6355 * g_file_new_for_uri:
6356 * @uri: a UTF-8 string containing a URI
6357 *
6358 * Constructs a #GFile for a given URI. This operation never
6359 * fails, but the returned object might not support any I/O
6360 * operation if @uri is malformed or if the uri type is
6361 * not supported.
6362 *
6363 * Returns: (transfer full): a new #GFile for the given @uri.
6364 * Free the returned object with g_object_unref().
6365 */
6366 GFile *
6368 {
6372 }
6374 /**
6375 * g_file_new_tmp:
6376 * @tmpl: (type filename) (nullable): Template for the file
6377 * name, as in g_file_open_tmp(), or %NULL for a default template
6378 * @iostream: (out): on return, a #GFileIOStream for the created file
6379 * @error: a #GError, or %NULL
6380 *
6381 * Opens a file in the preferred directory for temporary files (as
6382 * returned by g_get_tmp_dir()) and returns a #GFile and
6383 * #GFileIOStream pointing to it.
6384 *
6385 * @tmpl should be a string in the GLib file name encoding
6386 * containing a sequence of six 'X' characters, and containing no
6387 * directory components. If it is %NULL, a default template is used.
6388 *
6389 * Unlike the other #GFile constructors, this will return %NULL if
6390 * a temporary file could not be created.
6391 *
6392 * Returns: (transfer full): a new #GFile.
6393 * Free the returned object with g_object_unref().
6394 *
6395 * Since: 2.32
6396 */
6397 GFile *
6401 {
6402 gint fd;
6422 }
6424 /**
6425 * g_file_parse_name:
6426 * @parse_name: a file name or path to be parsed
6427 *
6428 * Constructs a #GFile with the given @parse_name (i.e. something
6429 * given by g_file_get_parse_name()). This operation never fails,
6430 * but the returned object might not support any I/O operation if
6431 * the @parse_name cannot be parsed.
6432 *
6433 * Returns: (transfer full): a new #GFile.
6434 */
6435 GFile *
6437 {
6441 }
6443 static gboolean
6445 {
6447 }
6449 /* Following RFC 2396, valid schemes are built like:
6450 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6451 */
6452 static gboolean
6454 {
6463 p++;
6467 }
6472 {
6483 {
6489 }
6490 else
6497 }
6499 /**
6500 * g_file_new_for_commandline_arg:
6501 * @arg: a command line string
6502 *
6503 * Creates a #GFile with the given argument from the command line.
6504 * The value of @arg can be either a URI, an absolute path or a
6505 * relative path resolved relative to the current working directory.
6506 * This operation never fails, but the returned object might not
6507 * support any I/O operation if @arg points to a malformed path.
6508 *
6509 * Note that on Windows, this function expects its argument to be in
6510 * UTF-8 -- not the system code page. This means that you
6511 * should not use this function with string from argv as it is passed
6512 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6513 * the commandline. #GApplication also uses UTF-8 but
6514 * g_application_command_line_create_file_for_arg() may be more useful
6515 * for you there. It is also always possible to use this function with
6516 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6517 *
6518 * Returns: (transfer full): a new #GFile.
6519 * Free the returned object with g_object_unref().
6520 */
6521 GFile *
6523 {
6527 }
6529 /**
6530 * g_file_new_for_commandline_arg_and_cwd:
6531 * @arg: a command line string
6532 * @cwd: (type filename): the current working directory of the commandline
6533 *
6534 * Creates a #GFile with the given argument from the command line.
6535 *
6536 * This function is similar to g_file_new_for_commandline_arg() except
6537 * that it allows for passing the current working directory as an
6538 * argument instead of using the current working directory of the
6539 * process.
6540 *
6541 * This is useful if the commandline argument was given in a context
6542 * other than the invocation of the current process.
6543 *
6544 * See also g_application_command_line_create_file_for_arg().
6545 *
6546 * Returns: (transfer full): a new #GFile
6547 *
6548 * Since: 2.36
6549 **/
6550 GFile *
6553 {
6558 }
6560 /**
6561 * g_file_mount_enclosing_volume:
6562 * @location: input #GFile
6563 * @flags: flags affecting the operation
6564 * @mount_operation: (nullable): a #GMountOperation
6565 * or %NULL to avoid user interaction
6566 * @cancellable: (nullable): optional #GCancellable object,
6567 * %NULL to ignore
6568 * @callback: (nullable): a #GAsyncReadyCallback to call
6569 * when the request is satisfied, or %NULL
6570 * @user_data: the data to pass to callback function
6571 *
6572 * Starts a @mount_operation, mounting the volume that contains
6573 * the file @location.
6574 *
6575 * When this operation has completed, @callback will be called with
6576 * @user_user data, and the operation can be finalized with
6577 * g_file_mount_enclosing_volume_finish().
6578 *
6579 * If @cancellable is not %NULL, then the operation can be cancelled by
6580 * triggering the cancellable object from another thread. If the operation
6581 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6582 */
6583 void
6585 GMountMountFlags flags,
6588 GAsyncReadyCallback callback,
6589 gpointer user_data)
6590 {
6598 {
6600 g_file_mount_enclosing_volume,
6604 }
6606 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6608 }
6610 /**
6611 * g_file_mount_enclosing_volume_finish:
6612 * @location: input #GFile
6613 * @result: a #GAsyncResult
6614 * @error: a #GError, or %NULL
6615 *
6616 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6617 *
6618 * Returns: %TRUE if successful. If an error has occurred,
6619 * this function will return %FALSE and set @error
6620 * appropriately if present.
6621 */
6622 gboolean
6626 {
6640 }
6642 /********************************************
6643 * Utility functions *
6644 ********************************************/
6646 /**
6647 * g_file_query_default_handler:
6648 * @file: a #GFile to open
6649 * @cancellable: optional #GCancellable object, %NULL to ignore
6650 * @error: a #GError, or %NULL
6651 *
6652 * Returns the #GAppInfo that is registered as the default
6653 * application to handle the file specified by @file.
6654 *
6655 * If @cancellable is not %NULL, then the operation can be cancelled by
6656 * triggering the cancellable object from another thread. If the operation
6657 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6658 *
6659 * Returns: (transfer full): a #GAppInfo if the handle was found,
6660 * %NULL if there were errors.
6661 * When you are done with it, release it with g_object_unref()
6662 */
6663 GAppInfo *
6667 {
6676 {
6682 }
6685 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6687 cancellable,
6688 error);
6696 {
6697 /* Don't use is_native(), as we want to support fuse paths if available */
6702 }
6710 G_IO_ERROR_NOT_SUPPORTED,
6713 }
6715 #define GET_CONTENT_BLOCK_SIZE 8192
6717 /**
6718 * g_file_load_contents:
6719 * @file: input #GFile
6720 * @cancellable: optional #GCancellable object, %NULL to ignore
6721 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6722 * @length: (out) (optional): a location to place the length of the contents of the file,
6723 * or %NULL if the length is not needed
6724 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
6725 * or %NULL if the entity tag is not needed
6726 * @error: a #GError, or %NULL
6727 *
6728 * Loads the content of the file into memory. The data is always
6729 * zero-terminated, but this is not included in the resultant @length.
6730 * The returned @content should be freed with g_free() when no longer
6731 * needed.
6732 *
6733 * If @cancellable is not %NULL, then the operation can be cancelled by
6734 * triggering the cancellable object from another thread. If the operation
6735 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6736 *
6737 * Returns: %TRUE if the @file's contents were successfully loaded.
6738 * %FALSE if there were errors.
6739 */
6740 gboolean
6747 {
6750 gsize pos;
6751 gssize res;
6767 GET_CONTENT_BLOCK_SIZE,
6769 {
6772 }
6775 {
6779 G_FILE_ATTRIBUTE_ETAG_VALUE,
6780 cancellable,
6781 NULL);
6783 {
6786 }
6787 }
6789 /* Ignore errors on close */
6794 {
6795 /* error is set already */
6798 }
6803 /* Zero terminate (we got an extra byte allocated for this */
6809 }
6813 GFileReadMoreCallback read_more_callback;
6815 gsize pos;
6820 static void
6822 {
6827 }
6829 static void
6832 gpointer user_data)
6833 {
6837 /* Ignore errors here, we're only reading anyway */
6843 }
6845 static void
6848 gpointer user_data)
6849 {
6857 {
6860 }
6865 }
6867 static void
6870 gpointer user_data)
6871 {
6875 gssize read_size;
6880 {
6884 /* Close the file ignoring any error */
6887 }
6889 {
6891 G_FILE_ATTRIBUTE_ETAG_VALUE,
6894 load_contents_fstat_callback,
6895 data);
6896 }
6898 {
6909 G_FILE_ATTRIBUTE_ETAG_VALUE,
6912 load_contents_fstat_callback,
6913 data);
6914 else
6917 GET_CONTENT_BLOCK_SIZE,
6920 load_contents_read_callback,
6921 data);
6922 }
6923 }
6925 static void
6928 gpointer user_data)
6929 {
6938 {
6943 GET_CONTENT_BLOCK_SIZE,
6946 load_contents_read_callback,
6947 data);
6948 }
6949 else
6950 {
6953 }
6954 }
6956 /**
6957 * g_file_load_partial_contents_async: (skip)
6958 * @file: input #GFile
6959 * @cancellable: optional #GCancellable object, %NULL to ignore
6960 * @read_more_callback: a #GFileReadMoreCallback to receive partial data
6961 * and to specify whether further data should be read
6962 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6963 * @user_data: the data to pass to the callback functions
6964 *
6965 * Reads the partial contents of a file. A #GFileReadMoreCallback should
6966 * be used to stop reading from the file when appropriate, else this
6967 * function will behave exactly as g_file_load_contents_async(). This
6968 * operation can be finished by g_file_load_partial_contents_finish().
6969 *
6970 * Users of this function should be aware that @user_data is passed to
6971 * both the @read_more_callback and the @callback.
6972 *
6973 * If @cancellable is not %NULL, then the operation can be cancelled by
6974 * triggering the cancellable object from another thread. If the operation
6975 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6976 */
6977 void
6980 GFileReadMoreCallback read_more_callback,
6981 GAsyncReadyCallback callback,
6982 gpointer user_data)
6983 {
6999 load_contents_open_callback,
7000 data);
7001 }
7003 /**
7004 * g_file_load_partial_contents_finish:
7005 * @file: input #GFile
7006 * @res: a #GAsyncResult
7007 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7008 * @length: (out) (optional): a location to place the length of the contents of the file,
7009 * or %NULL if the length is not needed
7010 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7011 * or %NULL if the entity tag is not needed
7012 * @error: a #GError, or %NULL
7013 *
7014 * Finishes an asynchronous partial load operation that was started
7015 * with g_file_load_partial_contents_async(). The data is always
7016 * zero-terminated, but this is not included in the resultant @length.
7017 * The returned @content should be freed with g_free() when no longer
7018 * needed.
7019 *
7020 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7021 * present, it will be set appropriately.
7022 */
7023 gboolean
7030 {
7041 {
7045 }
7053 {
7056 }
7058 /* Zero terminate */
7066 }
7068 /**
7069 * g_file_load_contents_async:
7070 * @file: input #GFile
7071 * @cancellable: optional #GCancellable object, %NULL to ignore
7072 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7073 * @user_data: the data to pass to callback function
7074 *
7075 * Starts an asynchronous load of the @file's contents.
7076 *
7077 * For more details, see g_file_load_contents() which is
7078 * the synchronous version of this call.
7079 *
7080 * When the load operation has completed, @callback will be called
7081 * with @user data. To finish the operation, call
7082 * g_file_load_contents_finish() with the #GAsyncResult returned by
7083 * the @callback.
7084 *
7085 * If @cancellable is not %NULL, then the operation can be cancelled by
7086 * triggering the cancellable object from another thread. If the operation
7087 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7088 */
7089 void
7092 GAsyncReadyCallback callback,
7093 gpointer user_data)
7094 {
7096 cancellable,
7097 NULL,
7099 }
7101 /**
7102 * g_file_load_contents_finish:
7103 * @file: input #GFile
7104 * @res: a #GAsyncResult
7105 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7106 * @length: (out) (optional): a location to place the length of the contents of the file,
7107 * or %NULL if the length is not needed
7108 * @etag_out: (out) (optional): a location to place the current entity tag for the file,
7109 * or %NULL if the entity tag is not needed
7110 * @error: a #GError, or %NULL
7111 *
7112 * Finishes an asynchronous load of the @file's contents.
7113 * The contents are placed in @contents, and @length is set to the
7114 * size of the @contents string. The @content should be freed with
7115 * g_free() when no longer needed. If @etag_out is present, it will be
7116 * set to the new entity tag for the @file.
7117 *
7118 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7119 * present, it will be set appropriately.
7120 */
7121 gboolean
7128 {
7130 res,
7131 contents,
7132 length,
7133 etag_out,
7134 error);
7135 }
7137 /**
7138 * g_file_replace_contents:
7139 * @file: input #GFile
7140 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7141 * @length: the length of @contents in bytes
7142 * @etag: (nullable): the old [entity-tag][gfile-etag] for the document,
7143 * or %NULL
7144 * @make_backup: %TRUE if a backup should be created
7145 * @flags: a set of #GFileCreateFlags
7146 * @new_etag: (out) (optional): a location to a new [entity tag][gfile-etag]
7147 * for the document. This should be freed with g_free() when no longer
7148 * needed, or %NULL
7149 * @cancellable: optional #GCancellable object, %NULL to ignore
7150 * @error: a #GError, or %NULL
7151 *
7152 * Replaces the contents of @file with @contents of @length bytes.
7153 *
7154 * If @etag is specified (not %NULL), any existing file must have that etag,
7155 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7156 *
7157 * If @make_backup is %TRUE, this function will attempt to make a backup
7158 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7159 * file contents in the safest way possible. For example, atomic renames are
7160 * used when replacing local files’ contents.
7161 *
7162 * If @cancellable is not %NULL, then the operation can be cancelled by
7163 * triggering the cancellable object from another thread. If the operation
7164 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7165 *
7166 * The returned @new_etag can be used to verify that the file hasn't
7167 * changed the next time it is saved over.
7168 *
7169 * Returns: %TRUE if successful. If an error has occurred, this function
7170 * will return %FALSE and set @error appropriately if present.
7171 */
7172 gboolean
7175 gsize length,
7177 gboolean make_backup,
7178 GFileCreateFlags flags,
7182 {
7185 gssize res;
7186 gboolean ret;
7201 cancellable,
7203 {
7206 }
7209 {
7210 /* Ignore errors on close */
7214 /* error is set already */
7216 }
7226 }
7231 gsize pos;
7233 gboolean failed;
7236 static void
7238 {
7242 }
7244 static void
7247 gpointer user_data)
7248 {
7252 /* Ignore errors here, we're only reading anyway */
7257 {
7260 }
7262 }
7264 static void
7267 gpointer user_data)
7268 {
7272 gssize write_size;
7277 {
7278 /* Error or EOF, close the file */
7280 {
7283 }
7287 }
7289 {
7291 gsize length;
7300 else
7306 replace_contents_write_callback,
7307 data);
7308 }
7309 }
7311 static void
7314 gpointer user_data)
7315 {
7324 {
7326 gsize length;
7334 replace_contents_write_callback,
7335 data);
7336 }
7337 else
7338 {
7341 }
7342 }
7344 /**
7345 * g_file_replace_contents_async:
7346 * @file: input #GFile
7347 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7348 * @length: the length of @contents in bytes
7349 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7350 * @make_backup: %TRUE if a backup should be created
7351 * @flags: a set of #GFileCreateFlags
7352 * @cancellable: optional #GCancellable object, %NULL to ignore
7353 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7354 * @user_data: the data to pass to callback function
7355 *
7356 * Starts an asynchronous replacement of @file with the given
7357 * @contents of @length bytes. @etag will replace the document's
7358 * current entity tag.
7359 *
7360 * When this operation has completed, @callback will be called with
7361 * @user_user data, and the operation can be finalized with
7362 * g_file_replace_contents_finish().
7363 *
7364 * If @cancellable is not %NULL, then the operation can be cancelled by
7365 * triggering the cancellable object from another thread. If the operation
7366 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7367 *
7368 * If @make_backup is %TRUE, this function will attempt to
7369 * make a backup of @file.
7370 *
7371 * Note that no copy of @content will be made, so it must stay valid
7372 * until @callback is called. See g_file_replace_contents_bytes_async()
7373 * for a #GBytes version that will automatically hold a reference to the
7374 * contents (without copying) for the duration of the call.
7375 */
7376 void
7379 gsize length,
7381 gboolean make_backup,
7382 GFileCreateFlags flags,
7384 GAsyncReadyCallback callback,
7385 gpointer user_data)
7386 {
7393 }
7395 /**
7396 * g_file_replace_contents_bytes_async:
7397 * @file: input #GFile
7398 * @contents: a #GBytes
7399 * @etag: (nullable): a new [entity tag][gfile-etag] for the @file, or %NULL
7400 * @make_backup: %TRUE if a backup should be created
7401 * @flags: a set of #GFileCreateFlags
7402 * @cancellable: optional #GCancellable object, %NULL to ignore
7403 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7404 * @user_data: the data to pass to callback function
7405 *
7406 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7407 * This function will keep a ref on @contents until the operation is done.
7408 * Unlike g_file_replace_contents_async() this allows forgetting about the
7409 * content without waiting for the callback.
7410 *
7411 * When this operation has completed, @callback will be called with
7412 * @user_user data, and the operation can be finalized with
7413 * g_file_replace_contents_finish().
7414 *
7415 * Since: 2.40
7416 */
7417 void
7421 gboolean make_backup,
7422 GFileCreateFlags flags,
7424 GAsyncReadyCallback callback,
7425 gpointer user_data)
7426 {
7441 etag,
7442 make_backup,
7443 flags,
7446 replace_contents_open_callback,
7447 data);
7448 }
7450 /**
7451 * g_file_replace_contents_finish:
7452 * @file: input #GFile
7453 * @res: a #GAsyncResult
7454 * @new_etag: (out) (optional): a location of a new [entity tag][gfile-etag]
7455 * for the document. This should be freed with g_free() when it is no
7456 * longer needed, or %NULL
7457 * @error: a #GError, or %NULL
7458 *
7459 * Finishes an asynchronous replace of the given @file. See
7460 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7461 * tag for the document, if present.
7462 *
7463 * Returns: %TRUE on success, %FALSE on failure.
7464 */
7465 gboolean
7470 {
7485 {
7488 }
7491 }
7493 gboolean
7495 GFileMeasureFlags flags,
7497 GFileMeasureProgressCallback progress_callback,
7498 gpointer progress_data,
7503 {
7507 }
7510 {
7511 GFileMeasureFlags flags;
7512 GFileMeasureProgressCallback progress_callback;
7513 gpointer progress_data;
7517 {
7518 guint64 disk_usage;
7519 guint64 num_dirs;
7520 guint64 num_files;
7524 {
7525 GFileMeasureProgressCallback callback;
7526 gpointer user_data;
7527 gboolean reporting;
7528 guint64 current_size;
7529 guint64 num_dirs;
7530 guint64 num_files;
7533 static gboolean
7535 {
7543 }
7545 static void
7547 guint64 current_size,
7548 guint64 num_dirs,
7549 guint64 num_files,
7550 gpointer user_data)
7551 {
7552 MeasureProgress progress;
7567 measure_disk_usage_invoke_progress,
7569 g_free);
7570 }
7572 static void
7574 gpointer source_object,
7575 gpointer task_data,
7577 {
7587 else
7589 }
7591 static void
7593 GFileMeasureFlags flags,
7594 gint io_priority,
7596 GFileMeasureProgressCallback progress_callback,
7597 gpointer progress_data,
7598 GAsyncReadyCallback callback,
7599 gpointer user_data)
7600 {
7601 MeasureTaskData data;
7615 }
7617 static gboolean
7624 {
7646 }
7648 /**
7649 * g_file_measure_disk_usage:
7650 * @file: a #GFile
7651 * @flags: #GFileMeasureFlags
7652 * @cancellable: (nullable): optional #GCancellable
7653 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7654 * @progress_data: user_data for @progress_callback
7655 * @disk_usage: (out) (optional): the number of bytes of disk space used
7656 * @num_dirs: (out) (optional): the number of directories encountered
7657 * @num_files: (out) (optional): the number of non-directories encountered
7658 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7659 *
7660 * Recursively measures the disk usage of @file.
7661 *
7662 * This is essentially an analog of the 'du' command, but it also
7663 * reports the number of directories and non-directory files encountered
7664 * (including things like symbolic links).
7665 *
7666 * By default, errors are only reported against the toplevel file
7667 * itself. Errors found while recursing are silently ignored, unless
7668 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7669 *
7670 * The returned size, @disk_usage, is in bytes and should be formatted
7671 * with g_format_size() in order to get something reasonable for showing
7672 * in a user interface.
7673 *
7674 * @progress_callback and @progress_data can be given to request
7675 * periodic progress updates while scanning. See the documentation for
7676 * #GFileMeasureProgressCallback for information about when and how the
7677 * callback will be invoked.
7678 *
7679 * Returns: %TRUE if successful, with the out parameters set.
7680 * %FALSE otherwise, with @error set.
7681 *
7682 * Since: 2.38
7683 **/
7684 gboolean
7686 GFileMeasureFlags flags,
7688 GFileMeasureProgressCallback progress_callback,
7689 gpointer progress_data,
7694 {
7702 error);
7703 }
7705 /**
7706 * g_file_measure_disk_usage_async:
7707 * @file: a #GFile
7708 * @flags: #GFileMeasureFlags
7709 * @io_priority: the [I/O priority][io-priority] of the request
7710 * @cancellable: (nullable): optional #GCancellable
7711 * @progress_callback: (nullable): a #GFileMeasureProgressCallback
7712 * @progress_data: user_data for @progress_callback
7713 * @callback: (nullable): a #GAsyncReadyCallback to call when complete
7714 * @user_data: the data to pass to callback function
7715 *
7716 * Recursively measures the disk usage of @file.
7717 *
7718 * This is the asynchronous version of g_file_measure_disk_usage(). See
7719 * there for more information.
7720 *
7721 * Since: 2.38
7722 **/
7723 void
7725 GFileMeasureFlags flags,
7726 gint io_priority,
7728 GFileMeasureProgressCallback progress_callback,
7729 gpointer progress_data,
7730 GAsyncReadyCallback callback,
7731 gpointer user_data)
7732 {
7739 }
7741 /**
7742 * g_file_measure_disk_usage_finish:
7743 * @file: a #GFile
7744 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7745 * @disk_usage: (out) (optional): the number of bytes of disk space used
7746 * @num_dirs: (out) (optional): the number of directories encountered
7747 * @num_files: (out) (optional): the number of non-directories encountered
7748 * @error: (nullable): %NULL, or a pointer to a %NULL #GError pointer
7749 *
7750 * Collects the results from an earlier call to
7751 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7752 * more information.
7753 *
7754 * Returns: %TRUE if successful, with the out parameters set.
7755 * %FALSE otherwise, with @error set.
7756 *
7757 * Since: 2.38
7758 **/
7759 gboolean
7766 {
7770 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7771 }
7773 /**
7774 * g_file_start_mountable:
7775 * @file: input #GFile
7776 * @flags: flags affecting the operation
7777 * @start_operation: (nullable): a #GMountOperation, or %NULL to avoid user interaction
7778 * @cancellable: (nullable): optional #GCancellable object, %NULL to ignore
7779 * @callback: (nullable): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7780 * @user_data: the data to pass to callback function
7781 *
7782 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7783 * Using @start_operation, you can request callbacks when, for instance,
7784 * passwords are needed during authentication.
7785 *
7786 * If @cancellable is not %NULL, then the operation can be cancelled by
7787 * triggering the cancellable object from another thread. If the operation
7788 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7789 *
7790 * When the operation is finished, @callback will be called.
7791 * You can then call g_file_mount_mountable_finish() to get
7792 * the result of the operation.
7793 *
7794 * Since: 2.22
7795 */
7796 void
7798 GDriveStartFlags flags,
7801 GAsyncReadyCallback callback,
7802 gpointer user_data)
7803 {
7811 {
7813 g_file_start_mountable,
7817 }
7820 flags,
7821 start_operation,
7822 cancellable,
7823 callback,
7824 user_data);
7825 }
7827 /**
7828 * g_file_start_mountable_finish:
7829 * @file: input #GFile
7830 * @result: a #GAsyncResult
7831 * @error: a #GError, or %NULL
7832 *
7833 * Finishes a start operation. See g_file_start_mountable() for details.
7834 *
7835 * Finish an asynchronous start operation that was started
7836 * with g_file_start_mountable().
7837 *
7838 * Returns: %TRUE if the operation finished successfully. %FALSE
7839 * otherwise.
7840 *
7841 * Since: 2.22
7842 */
7843 gboolean
7847 {
7860 }
7862 /**
7863 * g_file_stop_mountable:
7864 * @file: input #GFile
7865 * @flags: flags affecting the operation
7866 * @mount_operation: (nullable): a #GMountOperation,
7867 * or %NULL to avoid user interaction.
7868 * @cancellable: (nullable): optional #GCancellable object,
7869 * %NULL to ignore
7870 * @callback: (nullable): a #GAsyncReadyCallback to call
7871 * when the request is satisfied, or %NULL
7872 * @user_data: the data to pass to callback function
7873 *
7874 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
7875 *
7876 * If @cancellable is not %NULL, then the operation can be cancelled by
7877 * triggering the cancellable object from another thread. If the operation
7878 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7879 *
7880 * When the operation is finished, @callback will be called.
7881 * You can then call g_file_stop_mountable_finish() to get
7882 * the result of the operation.
7883 *
7884 * Since: 2.22
7885 */
7886 void
7888 GMountUnmountFlags flags,
7891 GAsyncReadyCallback callback,
7892 gpointer user_data)
7893 {
7901 {
7903 g_file_stop_mountable,
7907 }
7910 flags,
7911 mount_operation,
7912 cancellable,
7913 callback,
7914 user_data);
7915 }
7917 /**
7918 * g_file_stop_mountable_finish:
7919 * @file: input #GFile
7920 * @result: a #GAsyncResult
7921 * @error: a #GError, or %NULL
7922 *
7923 * Finishes an stop operation, see g_file_stop_mountable() for details.
7924 *
7925 * Finish an asynchronous stop operation that was started
7926 * with g_file_stop_mountable().
7927 *
7928 * Returns: %TRUE if the operation finished successfully.
7929 * %FALSE otherwise.
7930 *
7931 * Since: 2.22
7932 */
7933 gboolean
7937 {
7950 }
7952 /**
7953 * g_file_poll_mountable:
7954 * @file: input #GFile
7955 * @cancellable: optional #GCancellable object, %NULL to ignore
7956 * @callback: (nullable): a #GAsyncReadyCallback to call
7957 * when the request is satisfied, or %NULL
7958 * @user_data: the data to pass to callback function
7959 *
7960 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
7961 *
7962 * If @cancellable is not %NULL, then the operation can be cancelled by
7963 * triggering the cancellable object from another thread. If the operation
7964 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7965 *
7966 * When the operation is finished, @callback will be called.
7967 * You can then call g_file_mount_mountable_finish() to get
7968 * the result of the operation.
7969 *
7970 * Since: 2.22
7971 */
7972 void
7975 GAsyncReadyCallback callback,
7976 gpointer user_data)
7977 {
7985 {
7987 g_file_poll_mountable,
7991 }
7994 cancellable,
7995 callback,
7996 user_data);
7997 }
7999 /**
8000 * g_file_poll_mountable_finish:
8001 * @file: input #GFile
8002 * @result: a #GAsyncResult
8003 * @error: a #GError, or %NULL
8004 *
8005 * Finishes a poll operation. See g_file_poll_mountable() for details.
8006 *
8007 * Finish an asynchronous poll operation that was polled
8008 * with g_file_poll_mountable().
8009 *
8010 * Returns: %TRUE if the operation finished successfully. %FALSE
8011 * otherwise.
8012 *
8013 * Since: 2.22
8014 */
8015 gboolean
8019 {
8032 }
8034 /**
8035 * g_file_supports_thread_contexts:
8036 * @file: a #GFile
8037 *
8038 * Checks if @file supports
8039 * [thread-default contexts][g-main-context-push-thread-default-context].
8040 * If this returns %FALSE, you cannot perform asynchronous operations on
8041 * @file in a thread that has a thread-default context.
8042 *
8043 * Returns: Whether or not @file supports thread-default contexts.
8044 *
8045 * Since: 2.22
8046 */
8047 gboolean
8049 {
8056 }