| blob | 6226e360c74fdf4a4a755de959edb4e81a185ee8 |
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 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: (allow-none): 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: 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: 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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: (allow-none): 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 static gboolean
2773 GFileProgressCallback progress_callback,
2774 gpointer progress_callback_data,
2776 {
2778 goffset current_size;
2780 gboolean res;
2781 goffset total_size;
2785 /* avoid performance impact of querying total size when it's not needed */
2787 {
2789 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2792 {
2796 }
2799 {
2801 G_FILE_ATTRIBUTE_STANDARD_SIZE,
2802 G_FILE_QUERY_INFO_NONE,
2805 {
2809 }
2810 }
2811 }
2819 {
2822 {
2825 }
2834 {
2837 {
2840 }
2844 }
2851 }
2853 /* Make sure we send full copied size */
2858 }
2860 #ifdef HAVE_SPLICE
2862 static gboolean
2870 {
2873 retry:
2877 {
2885 else
2892 }
2896 }
2898 static gboolean
2902 GFileProgressCallback progress_callback,
2903 gpointer progress_callback_data,
2905 {
2907 gboolean res;
2908 goffset total_size;
2909 loff_t offset_in;
2910 loff_t offset_out;
2920 /* avoid performance impact of querying total size when it's not needed */
2922 {
2927 }
2935 {
2946 {
2949 }
2952 {
2960 }
2964 }
2966 /* Make sure we send full copied size */
2976 out:
2983 }
2984 #endif
2986 #ifdef __linux__
2987 static gboolean
2992 GFileProgressCallback progress_callback,
2993 gpointer progress_callback_data,
2995 {
2996 goffset source_size;
3006 /* Btrfs clone ioctl properties:
3007 * - Works at the inode level
3008 * - Doesn't work with directories
3009 * - Always follows symlinks (source and destination)
3010 *
3011 * By the time we get here, *in and *out are both regular files */
3015 {
3018 G_IO_ERROR_NOT_SUPPORTED,
3022 G_IO_ERROR_NOT_SUPPORTED,
3024 else
3025 /* Most probably something odd happened; retry with fallback */
3027 G_IO_ERROR_NOT_SUPPORTED,
3029 /* We retry with fallback for all error cases because Btrfs is currently
3030 * unstable, and so we can't trust it to do clone properly.
3031 * In addition, any hard errors here would cause the same failure in the
3032 * fallback manual copy as well. */
3034 }
3036 /* Make sure we send full copied size */
3041 }
3042 #endif
3044 static gboolean
3047 GFileCopyFlags flags,
3049 GFileProgressCallback progress_callback,
3050 gpointer progress_callback_data,
3052 {
3062 /* need to know the file type */
3065 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3066 cancellable,
3067 error);
3071 /* Maybe copy the symlink? */
3074 {
3077 {
3083 }
3084 /* ... else fall back on a regular file copy */
3085 }
3086 /* Handle "special" files (pipes, device nodes, ...)? */
3088 {
3089 /* FIXME: could try to recreate device nodes and others? */
3093 }
3095 /* Everything else should just fall back on a regular copy. */
3107 {
3110 /* Ok, ditch the previous lightweight info (on Unix we just
3111 * called lstat()); at this point we gather all the information
3112 * we need about the source from the opened file descriptor.
3113 */
3119 {
3120 /* Not all gvfs backends implement query_info_on_read(), we
3121 * can just fall back to the pathname again.
3122 * https://bugzilla.gnome.org/706254
3123 */
3125 {
3129 }
3130 else
3131 {
3135 }
3136 }
3142 }
3144 /* In the local file path, we pass down the source info which
3145 * includes things like unix::mode, to ensure that the target file
3146 * is not created with different permissions from the source file.
3147 *
3148 * If a future API like g_file_replace_with_info() is added, switch
3149 * this code to use that.
3150 */
3152 {
3154 out = (GOutputStream*)_g_local_file_output_stream_replace (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3157 G_FILE_CREATE_REPLACE_DESTINATION,
3158 info,
3160 else
3161 out = (GOutputStream*)_g_local_file_output_stream_create (_g_local_file_get_filename (G_LOCAL_FILE (destination)),
3164 }
3166 {
3168 NULL,
3170 G_FILE_CREATE_REPLACE_DESTINATION,
3172 }
3173 else
3174 {
3176 }
3181 #ifdef __linux__
3183 {
3189 {
3191 {
3193 }
3194 else
3195 {
3198 }
3199 }
3200 else
3201 {
3204 }
3205 }
3206 #endif
3208 #ifdef HAVE_SPLICE
3210 {
3216 {
3218 {
3220 }
3221 else
3222 {
3225 }
3226 }
3227 else
3228 {
3231 }
3232 }
3234 #endif
3236 /* A plain read/write loop */
3239 error))
3243 out:
3245 {
3246 /* Don't care about errors in source here */
3249 }
3252 {
3253 /* But write errors on close are bad! */
3257 }
3259 /* Ignore errors here. Failure to copy metadata is not a hard error */
3260 /* TODO: set these attributes /before/ we do the rename() on Unix */
3262 {
3264 info,
3265 G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS,
3266 cancellable,
3267 NULL);
3268 }
3273 }
3275 /**
3276 * g_file_copy:
3277 * @source: input #GFile
3278 * @destination: destination #GFile
3279 * @flags: set of #GFileCopyFlags
3280 * @cancellable: (allow-none): optional #GCancellable object,
3281 * %NULL to ignore
3282 * @progress_callback: (allow-none) (scope call): function to callback with
3283 * progress information, or %NULL if progress information is not needed
3284 * @progress_callback_data: (closure): user data to pass to @progress_callback
3285 * @error: #GError to set on error, or %NULL
3286 *
3287 * Copies the file @source to the location specified by @destination.
3288 * Can not handle recursive copies of directories.
3289 *
3290 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3291 * existing @destination file is overwritten.
3292 *
3293 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3294 * will be copied as symlinks, otherwise the target of the
3295 * @source symlink will be copied.
3296 *
3297 * If @cancellable is not %NULL, then the operation can be cancelled by
3298 * triggering the cancellable object from another thread. If the operation
3299 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3300 *
3301 * If @progress_callback is not %NULL, then the operation can be monitored
3302 * by setting this to a #GFileProgressCallback function.
3303 * @progress_callback_data will be passed to this function. It is guaranteed
3304 * that this callback will be called after all data has been transferred with
3305 * the total number of bytes copied during the operation.
3306 *
3307 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error
3308 * is returned, independent on the status of the @destination.
3309 *
3310 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then
3311 * the error %G_IO_ERROR_EXISTS is returned.
3312 *
3313 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3314 * error is returned. If trying to overwrite a directory with a directory the
3315 * %G_IO_ERROR_WOULD_MERGE error is returned.
3316 *
3317 * If the source is a directory and the target does not exist, or
3318 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the
3319 * %G_IO_ERROR_WOULD_RECURSE error is returned.
3320 *
3321 * If you are interested in copying the #GFile object itself (not the on-disk
3322 * file), see g_file_dup().
3323 *
3324 * Returns: %TRUE on success, %FALSE otherwise.
3325 */
3326 gboolean
3329 GFileCopyFlags flags,
3331 GFileProgressCallback progress_callback,
3332 gpointer progress_callback_data,
3334 {
3337 gboolean res;
3347 {
3358 {
3361 }
3362 else
3364 }
3366 /* If the types are different, and the destination method failed
3367 * also try the source method
3368 */
3370 {
3374 {
3385 {
3388 }
3389 else
3391 }
3392 }
3396 error);
3397 }
3399 /**
3400 * g_file_copy_async: (skip)
3401 * @source: input #GFile
3402 * @destination: destination #GFile
3403 * @flags: set of #GFileCopyFlags
3404 * @io_priority: the [I/O priority][io-priority] of the request
3405 * @cancellable: (allow-none): optional #GCancellable object,
3406 * %NULL to ignore
3407 * @progress_callback: (allow-none): function to callback with progress
3408 * information, or %NULL if progress information is not needed
3409 * @progress_callback_data: (closure): user data to pass to @progress_callback
3410 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
3411 * @user_data: the data to pass to callback function
3412 *
3413 * Copies the file @source to the location specified by @destination
3414 * asynchronously. For details of the behaviour, see g_file_copy().
3415 *
3416 * If @progress_callback is not %NULL, then that function that will be called
3417 * just like in g_file_copy(). The callback will run in the default main context
3418 * of the thread calling g_file_copy_async() — the same context as @callback is
3419 * run in.
3420 *
3421 * When the operation is finished, @callback will be called. You can then call
3422 * g_file_copy_finish() to get the result of the operation.
3423 */
3424 void
3427 GFileCopyFlags flags,
3430 GFileProgressCallback progress_callback,
3431 gpointer progress_callback_data,
3432 GAsyncReadyCallback callback,
3433 gpointer user_data)
3434 {
3442 destination,
3443 flags,
3444 io_priority,
3445 cancellable,
3446 progress_callback,
3447 progress_callback_data,
3448 callback,
3449 user_data);
3450 }
3452 /**
3453 * g_file_copy_finish:
3454 * @file: input #GFile
3455 * @res: a #GAsyncResult
3456 * @error: a #GError, or %NULL
3457 *
3458 * Finishes copying the file started with g_file_copy_async().
3459 *
3460 * Returns: a %TRUE on success, %FALSE on error.
3461 */
3462 gboolean
3466 {
3477 }
3479 /**
3480 * g_file_move:
3481 * @source: #GFile pointing to the source location
3482 * @destination: #GFile pointing to the destination location
3483 * @flags: set of #GFileCopyFlags
3484 * @cancellable: (allow-none): optional #GCancellable object,
3485 * %NULL to ignore
3486 * @progress_callback: (allow-none) (scope call): #GFileProgressCallback
3487 * function for updates
3488 * @progress_callback_data: (closure): gpointer to user data for
3489 * the callback function
3490 * @error: #GError for returning error conditions, or %NULL
3491 *
3492 * Tries to move the file or directory @source to the location specified
3493 * by @destination. If native move operations are supported then this is
3494 * used, otherwise a copy + delete fallback is used. The native
3495 * implementation may support moving directories (for instance on moves
3496 * inside the same filesystem), but the fallback code does not.
3497 *
3498 * If the flag #G_FILE_COPY_OVERWRITE is specified an already
3499 * existing @destination file is overwritten.
3500 *
3501 * If the flag #G_FILE_COPY_NOFOLLOW_SYMLINKS is specified then symlinks
3502 * will be copied as symlinks, otherwise the target of the
3503 * @source symlink will be copied.
3504 *
3505 * If @cancellable is not %NULL, then the operation can be cancelled by
3506 * triggering the cancellable object from another thread. If the operation
3507 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3508 *
3509 * If @progress_callback is not %NULL, then the operation can be monitored
3510 * by setting this to a #GFileProgressCallback function.
3511 * @progress_callback_data will be passed to this function. It is
3512 * guaranteed that this callback will be called after all data has been
3513 * transferred with the total number of bytes copied during the operation.
3514 *
3515 * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND
3516 * error is returned, independent on the status of the @destination.
3517 *
3518 * If #G_FILE_COPY_OVERWRITE is not specified and the target exists,
3519 * then the error %G_IO_ERROR_EXISTS is returned.
3520 *
3521 * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY
3522 * error is returned. If trying to overwrite a directory with a directory the
3523 * %G_IO_ERROR_WOULD_MERGE error is returned.
3524 *
3525 * If the source is a directory and the target does not exist, or
3526 * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then
3527 * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native
3528 * move operation isn't available).
3529 *
3530 * Returns: %TRUE on successful move, %FALSE otherwise.
3531 */
3532 gboolean
3535 GFileCopyFlags flags,
3537 GFileProgressCallback progress_callback,
3538 gpointer progress_callback_data,
3540 {
3543 gboolean res;
3553 {
3564 {
3567 }
3568 else
3570 }
3572 /* If the types are different, and the destination method failed
3573 * also try the source method
3574 */
3576 {
3580 {
3591 {
3594 }
3595 else
3597 }
3598 }
3601 {
3603 G_IO_ERROR_NOT_SUPPORTED,
3606 }
3611 error))
3615 }
3617 /**
3618 * g_file_make_directory:
3619 * @file: input #GFile
3620 * @cancellable: (allow-none): optional #GCancellable object,
3621 * %NULL to ignore
3622 * @error: a #GError, or %NULL
3623 *
3624 * Creates a directory. Note that this will only create a child directory
3625 * of the immediate parent directory of the path or URI given by the #GFile.
3626 * To recursively create directories, see g_file_make_directory_with_parents().
3627 * This function will fail if the parent directory does not exist, setting
3628 * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support
3629 * creating directories, this function will fail, setting @error to
3630 * %G_IO_ERROR_NOT_SUPPORTED.
3631 *
3632 * For a local #GFile the newly created directory will have the default
3633 * (current) ownership and permissions of the current process.
3634 *
3635 * If @cancellable is not %NULL, then the operation can be cancelled by
3636 * triggering the cancellable object from another thread. If the operation
3637 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3638 *
3639 * Returns: %TRUE on successful creation, %FALSE otherwise.
3640 */
3641 gboolean
3645 {
3656 {
3658 G_IO_ERROR_NOT_SUPPORTED,
3661 }
3664 }
3666 /**
3667 * g_file_make_directory_async:
3668 * @file: input #GFile
3669 * @io_priority: the [I/O priority][io-priority] of the request
3670 * @cancellable: (allow-none): optional #GCancellable object,
3671 * %NULL to ignore
3672 * @callback: a #GAsyncReadyCallback to call
3673 * when the request is satisfied
3674 * @user_data: the data to pass to callback function
3675 *
3676 * Asynchronously creates a directory.
3677 *
3678 * Virtual: make_directory_async
3679 * Since: 2.38
3680 */
3681 void
3685 GAsyncReadyCallback callback,
3686 gpointer user_data)
3687 {
3694 io_priority,
3695 cancellable,
3696 callback,
3697 user_data);
3698 }
3700 /**
3701 * g_file_make_directory_finish:
3702 * @file: input #GFile
3703 * @result: a #GAsyncResult
3704 * @error: a #GError, or %NULL
3705 *
3706 * Finishes an asynchronous directory creation, started with
3707 * g_file_make_directory_async().
3708 *
3709 * Virtual: make_directory_finish
3710 * Returns: %TRUE on successful directory creation, %FALSE otherwise.
3711 * Since: 2.38
3712 */
3713 gboolean
3717 {
3725 }
3727 /**
3728 * g_file_make_directory_with_parents:
3729 * @file: input #GFile
3730 * @cancellable: (allow-none): optional #GCancellable object,
3731 * %NULL to ignore
3732 * @error: a #GError, or %NULL
3733 *
3734 * Creates a directory and any parent directories that may not
3735 * exist similar to 'mkdir -p'. If the file system does not support
3736 * creating directories, this function will fail, setting @error to
3737 * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists,
3738 * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike
3739 * the similar g_mkdir_with_parents().
3740 *
3741 * For a local #GFile the newly created directories will have the default
3742 * (current) ownership and permissions of the current process.
3743 *
3744 * If @cancellable is not %NULL, then the operation can be cancelled by
3745 * triggering the cancellable object from another thread. If the operation
3746 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3747 *
3748 * Returns: %TRUE if all directories have been successfully created, %FALSE
3749 * otherwise.
3750 *
3751 * Since: 2.18
3752 */
3753 gboolean
3757 {
3767 /* Try for the simple case of not having to create any parent
3768 * directories. If any parent directory needs to be created, this
3769 * call will fail with NOT_FOUND. If that happens, then that value of
3770 * my_error persists into the while loop below.
3771 */
3774 {
3778 }
3782 /* Creates the parent directories as needed. In case any particular
3783 * creation operation fails for lack of other parent directories
3784 * (NOT_FOUND), the directory is added to a list of directories to
3785 * create later, and the value of my_error is retained until the next
3786 * iteration of the loop. After the loop my_error should either be
3787 * empty or contain a real failure condition.
3788 */
3790 {
3799 /* Another process may have created the directory in between the
3800 * G_IO_ERROR_NOT_FOUND and now
3801 */
3810 else
3812 }
3814 /* All directories should be able to be created now, so an error at
3815 * this point means the whole operation must fail -- except an EXISTS
3816 * error, which means that another process already created the
3817 * directory in between the previous failure and now.
3818 */
3820 {
3824 }
3829 /* Clean up */
3831 {
3834 }
3836 /* At this point an error in my_error means a that something
3837 * unexpected failed in either of the loops above, so the whole
3838 * operation must fail.
3839 */
3841 {
3844 }
3847 }
3849 /**
3850 * g_file_make_symbolic_link:
3851 * @file: a #GFile with the name of the symlink to create
3852 * @symlink_value: (type filename): a string with the path for the target
3853 * of the new symlink
3854 * @cancellable: (allow-none): optional #GCancellable object,
3855 * %NULL to ignore
3856 * @error: a #GError
3857 *
3858 * Creates a symbolic link named @file which contains the string
3859 * @symlink_value.
3860 *
3861 * If @cancellable is not %NULL, then the operation can be cancelled by
3862 * triggering the cancellable object from another thread. If the operation
3863 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3864 *
3865 * Returns: %TRUE on the creation of a new symlink, %FALSE otherwise.
3866 */
3867 gboolean
3872 {
3882 {
3884 G_IO_ERROR_INVALID_ARGUMENT,
3887 }
3892 {
3894 G_IO_ERROR_NOT_SUPPORTED,
3897 }
3900 }
3902 /**
3903 * g_file_delete:
3904 * @file: input #GFile
3905 * @cancellable: (allow-none): optional #GCancellable object,
3906 * %NULL to ignore
3907 * @error: a #GError, or %NULL
3908 *
3909 * Deletes a file. If the @file is a directory, it will only be
3910 * deleted if it is empty. This has the same semantics as g_unlink().
3911 *
3912 * If @cancellable is not %NULL, then the operation can be cancelled by
3913 * triggering the cancellable object from another thread. If the operation
3914 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
3915 *
3916 * Virtual: delete_file
3917 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3918 */
3919 gboolean
3923 {
3934 {
3936 G_IO_ERROR_NOT_SUPPORTED,
3939 }
3942 }
3944 /**
3945 * g_file_delete_async:
3946 * @file: input #GFile
3947 * @io_priority: the [I/O priority][io-priority] of the request
3948 * @cancellable: (allow-none): optional #GCancellable object,
3949 * %NULL to ignore
3950 * @callback: a #GAsyncReadyCallback to call
3951 * when the request is satisfied
3952 * @user_data: the data to pass to callback function
3953 *
3954 * Asynchronously delete a file. If the @file is a directory, it will
3955 * only be deleted if it is empty. This has the same semantics as
3956 * g_unlink().
3957 *
3958 * Virtual: delete_file_async
3959 * Since: 2.34
3960 */
3961 void
3965 GAsyncReadyCallback callback,
3966 gpointer user_data)
3967 {
3974 io_priority,
3975 cancellable,
3976 callback,
3977 user_data);
3978 }
3980 /**
3981 * g_file_delete_finish:
3982 * @file: input #GFile
3983 * @result: a #GAsyncResult
3984 * @error: a #GError, or %NULL
3985 *
3986 * Finishes deleting a file started with g_file_delete_async().
3987 *
3988 * Virtual: delete_file_finish
3989 * Returns: %TRUE if the file was deleted. %FALSE otherwise.
3990 * Since: 2.34
3991 **/
3992 gboolean
3996 {
4007 }
4009 /**
4010 * g_file_trash:
4011 * @file: #GFile to send to trash
4012 * @cancellable: (allow-none): optional #GCancellable object,
4013 * %NULL to ignore
4014 * @error: a #GError, or %NULL
4015 *
4016 * Sends @file to the "Trashcan", if possible. This is similar to
4017 * deleting it, but the user can recover it before emptying the trashcan.
4018 * Not all file systems support trashing, so this call can return the
4019 * %G_IO_ERROR_NOT_SUPPORTED error.
4020 *
4021 * If @cancellable is not %NULL, then the operation can be cancelled by
4022 * triggering the cancellable object from another thread. If the operation
4023 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4024 *
4025 * Virtual: trash
4026 * Returns: %TRUE on successful trash, %FALSE otherwise.
4027 */
4028 gboolean
4032 {
4043 {
4048 }
4051 }
4053 /**
4054 * g_file_trash_async:
4055 * @file: input #GFile
4056 * @io_priority: the [I/O priority][io-priority] of the request
4057 * @cancellable: (allow-none): optional #GCancellable object,
4058 * %NULL to ignore
4059 * @callback: a #GAsyncReadyCallback to call
4060 * when the request is satisfied
4061 * @user_data: the data to pass to callback function
4062 *
4063 * Asynchronously sends @file to the Trash location, if possible.
4064 *
4065 * Virtual: trash_async
4066 * Since: 2.38
4067 */
4068 void
4072 GAsyncReadyCallback callback,
4073 gpointer user_data)
4074 {
4081 io_priority,
4082 cancellable,
4083 callback,
4084 user_data);
4085 }
4087 /**
4088 * g_file_trash_finish:
4089 * @file: input #GFile
4090 * @result: a #GAsyncResult
4091 * @error: a #GError, or %NULL
4092 *
4093 * Finishes an asynchronous file trashing operation, started with
4094 * g_file_trash_async().
4095 *
4096 * Virtual: trash_finish
4097 * Returns: %TRUE on successful trash, %FALSE otherwise.
4098 * Since: 2.38
4099 */
4100 gboolean
4104 {
4112 }
4114 /**
4115 * g_file_set_display_name:
4116 * @file: input #GFile
4117 * @display_name: a string
4118 * @cancellable: (allow-none): optional #GCancellable object,
4119 * %NULL to ignore
4120 * @error: a #GError, or %NULL
4121 *
4122 * Renames @file to the specified display name.
4123 *
4124 * The display name is converted from UTF-8 to the correct encoding
4125 * for the target filesystem if possible and the @file is renamed to this.
4126 *
4127 * If you want to implement a rename operation in the user interface the
4128 * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the
4129 * initial value in the rename widget, and then the result after editing
4130 * should be passed to g_file_set_display_name().
4131 *
4132 * On success the resulting converted filename is returned.
4133 *
4134 * If @cancellable is not %NULL, then the operation can be cancelled by
4135 * triggering the cancellable object from another thread. If the operation
4136 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4137 *
4138 * Returns: (transfer full): a #GFile specifying what @file was renamed to,
4139 * or %NULL if there was an error.
4140 * Free the returned object with g_object_unref().
4141 */
4142 GFile *
4147 {
4154 {
4156 G_IO_ERROR,
4157 G_IO_ERROR_INVALID_ARGUMENT,
4160 }
4168 }
4170 /**
4171 * g_file_set_display_name_async:
4172 * @file: input #GFile
4173 * @display_name: a string
4174 * @io_priority: the [I/O priority][io-priority] of the request
4175 * @cancellable: (allow-none): optional #GCancellable object,
4176 * %NULL to ignore
4177 * @callback: (scope async): a #GAsyncReadyCallback to call
4178 * when the request is satisfied
4179 * @user_data: (closure): the data to pass to callback function
4180 *
4181 * Asynchronously sets the display name for a given #GFile.
4182 *
4183 * For more details, see g_file_set_display_name() which is
4184 * the synchronous version of this call.
4185 *
4186 * When the operation is finished, @callback will be called.
4187 * You can then call g_file_set_display_name_finish() to get
4188 * the result of the operation.
4189 */
4190 void
4193 gint io_priority,
4195 GAsyncReadyCallback callback,
4196 gpointer user_data)
4197 {
4205 display_name,
4206 io_priority,
4207 cancellable,
4208 callback,
4209 user_data);
4210 }
4212 /**
4213 * g_file_set_display_name_finish:
4214 * @file: input #GFile
4215 * @res: a #GAsyncResult
4216 * @error: a #GError, or %NULL
4217 *
4218 * Finishes setting a display name started with
4219 * g_file_set_display_name_async().
4220 *
4221 * Returns: (transfer full): a #GFile or %NULL on error.
4222 * Free the returned object with g_object_unref().
4223 */
4224 GFile *
4228 {
4239 }
4241 /**
4242 * g_file_query_settable_attributes:
4243 * @file: input #GFile
4244 * @cancellable: (allow-none): optional #GCancellable object,
4245 * %NULL to ignore
4246 * @error: a #GError, or %NULL
4247 *
4248 * Obtain the list of settable attributes for the file.
4249 *
4250 * Returns the type and full attribute name of all the attributes
4251 * that can be set on this file. This doesn't mean setting it will
4252 * always succeed though, you might get an access failure, or some
4253 * specific file may not support a specific attribute.
4254 *
4255 * If @cancellable is not %NULL, then the operation can be cancelled by
4256 * triggering the cancellable object from another thread. If the operation
4257 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4258 *
4259 * Returns: a #GFileAttributeInfoList describing the settable attributes.
4260 * When you are done with it, release it with
4261 * g_file_attribute_info_list_unref()
4262 */
4263 GFileAttributeInfoList *
4267 {
4286 {
4288 {
4291 }
4292 else
4294 }
4297 }
4299 /**
4300 * g_file_query_writable_namespaces:
4301 * @file: input #GFile
4302 * @cancellable: (allow-none): optional #GCancellable object,
4303 * %NULL to ignore
4304 * @error: a #GError, or %NULL
4305 *
4306 * Obtain the list of attribute namespaces where new attributes
4307 * can be created by a user. An example of this is extended
4308 * attributes (in the "xattr" namespace).
4309 *
4310 * If @cancellable is not %NULL, then the operation can be cancelled by
4311 * triggering the cancellable object from another thread. If the operation
4312 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4313 *
4314 * Returns: a #GFileAttributeInfoList describing the writable namespaces.
4315 * When you are done with it, release it with
4316 * g_file_attribute_info_list_unref()
4317 */
4318 GFileAttributeInfoList *
4322 {
4341 {
4344 }
4347 {
4349 {
4351 }
4352 else
4354 }
4357 }
4359 /**
4360 * g_file_set_attribute:
4361 * @file: input #GFile
4362 * @attribute: a string containing the attribute's name
4363 * @type: The type of the attribute
4364 * @value_p: (allow-none): a pointer to the value (or the pointer
4365 * itself if the type is a pointer type)
4366 * @flags: a set of #GFileQueryInfoFlags
4367 * @cancellable: (allow-none): optional #GCancellable object,
4368 * %NULL to ignore
4369 * @error: a #GError, or %NULL
4370 *
4371 * Sets an attribute in the file with attribute name @attribute to @value.
4372 *
4373 * Some attributes can be unset by setting @attribute to
4374 * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL.
4375 *
4376 * If @cancellable is not %NULL, then the operation can be cancelled by
4377 * triggering the cancellable object from another thread. If the operation
4378 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4379 *
4380 * Returns: %TRUE if the attribute was set, %FALSE otherwise.
4381 */
4382 gboolean
4385 GFileAttributeType type,
4386 gpointer value_p,
4387 GFileQueryInfoFlags flags,
4390 {
4402 {
4404 G_IO_ERROR_NOT_SUPPORTED,
4407 }
4410 }
4412 /**
4413 * g_file_set_attributes_from_info:
4414 * @file: input #GFile
4415 * @info: a #GFileInfo
4416 * @flags: #GFileQueryInfoFlags
4417 * @cancellable: (allow-none): optional #GCancellable object,
4418 * %NULL to ignore
4419 * @error: a #GError, or %NULL
4420 *
4421 * Tries to set all attributes in the #GFileInfo on the target
4422 * values, not stopping on the first error.
4423 *
4424 * If there is any error during this operation then @error will
4425 * be set to the first error. Error on particular fields are flagged
4426 * by setting the "status" field in the attribute value to
4427 * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can
4428 * also detect further errors.
4429 *
4430 * If @cancellable is not %NULL, then the operation can be cancelled by
4431 * triggering the cancellable object from another thread. If the operation
4432 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4433 *
4434 * Returns: %FALSE if there was any error, %TRUE otherwise.
4435 */
4436 gboolean
4439 GFileQueryInfoFlags flags,
4442 {
4456 info,
4457 flags,
4458 cancellable,
4459 error);
4460 }
4462 static gboolean
4465 GFileQueryInfoFlags flags,
4468 {
4471 gboolean res;
4479 {
4488 {
4491 /* Don't set error multiple times */
4493 }
4494 else
4496 }
4501 }
4503 /**
4504 * g_file_set_attributes_async:
4505 * @file: input #GFile
4506 * @info: a #GFileInfo
4507 * @flags: a #GFileQueryInfoFlags
4508 * @io_priority: the [I/O priority][io-priority] of the request
4509 * @cancellable: (allow-none): optional #GCancellable object,
4510 * %NULL to ignore
4511 * @callback: (scope async): a #GAsyncReadyCallback
4512 * @user_data: (closure): a #gpointer
4513 *
4514 * Asynchronously sets the attributes of @file with @info.
4515 *
4516 * For more details, see g_file_set_attributes_from_info(),
4517 * which is the synchronous version of this call.
4518 *
4519 * When the operation is finished, @callback will be called.
4520 * You can then call g_file_set_attributes_finish() to get
4521 * the result of the operation.
4522 */
4523 void
4526 GFileQueryInfoFlags flags,
4529 GAsyncReadyCallback callback,
4530 gpointer user_data)
4531 {
4539 info,
4540 flags,
4541 io_priority,
4542 cancellable,
4543 callback,
4544 user_data);
4545 }
4547 /**
4548 * g_file_set_attributes_finish:
4549 * @file: input #GFile
4550 * @result: a #GAsyncResult
4551 * @info: (out) (transfer full): a #GFileInfo
4552 * @error: a #GError, or %NULL
4553 *
4554 * Finishes setting an attribute started in g_file_set_attributes_async().
4555 *
4556 * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise.
4557 */
4558 gboolean
4563 {
4569 /* No standard handling of errors here, as we must set info even
4570 * on errors
4571 */
4574 }
4576 /**
4577 * g_file_set_attribute_string:
4578 * @file: input #GFile
4579 * @attribute: a string containing the attribute's name
4580 * @value: a string containing the attribute's value
4581 * @flags: #GFileQueryInfoFlags
4582 * @cancellable: (allow-none): optional #GCancellable object,
4583 * %NULL to ignore
4584 * @error: a #GError, or %NULL
4585 *
4586 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value.
4587 * If @attribute is of a different type, this operation will fail.
4588 *
4589 * If @cancellable is not %NULL, then the operation can be cancelled by
4590 * triggering the cancellable object from another thread. If the operation
4591 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4592 *
4593 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4594 */
4595 gboolean
4599 GFileQueryInfoFlags flags,
4602 {
4606 }
4608 /**
4609 * g_file_set_attribute_byte_string:
4610 * @file: input #GFile
4611 * @attribute: a string containing the attribute's name
4612 * @value: a string containing the attribute's new value
4613 * @flags: a #GFileQueryInfoFlags
4614 * @cancellable: (allow-none): optional #GCancellable object,
4615 * %NULL to ignore
4616 * @error: a #GError, or %NULL
4617 *
4618 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value.
4619 * If @attribute is of a different type, this operation will fail,
4620 * returning %FALSE.
4621 *
4622 * If @cancellable is not %NULL, then the operation can be cancelled by
4623 * triggering the cancellable object from another thread. If the operation
4624 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4625 *
4626 * Returns: %TRUE if the @attribute was successfully set to @value
4627 * in the @file, %FALSE otherwise.
4628 */
4629 gboolean
4633 GFileQueryInfoFlags flags,
4636 {
4640 }
4642 /**
4643 * g_file_set_attribute_uint32:
4644 * @file: input #GFile
4645 * @attribute: a string containing the attribute's name
4646 * @value: a #guint32 containing the attribute's new value
4647 * @flags: a #GFileQueryInfoFlags
4648 * @cancellable: (allow-none): optional #GCancellable object,
4649 * %NULL to ignore
4650 * @error: a #GError, or %NULL
4651 *
4652 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value.
4653 * If @attribute is of a different type, this operation will fail.
4654 *
4655 * If @cancellable is not %NULL, then the operation can be cancelled by
4656 * triggering the cancellable object from another thread. If the operation
4657 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4658 *
4659 * Returns: %TRUE if the @attribute was successfully set to @value
4660 * in the @file, %FALSE otherwise.
4661 */
4662 gboolean
4665 guint32 value,
4666 GFileQueryInfoFlags flags,
4669 {
4673 }
4675 /**
4676 * g_file_set_attribute_int32:
4677 * @file: input #GFile
4678 * @attribute: a string containing the attribute's name
4679 * @value: a #gint32 containing the attribute's new value
4680 * @flags: a #GFileQueryInfoFlags
4681 * @cancellable: (allow-none): optional #GCancellable object,
4682 * %NULL to ignore
4683 * @error: a #GError, or %NULL
4684 *
4685 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value.
4686 * If @attribute is of a different type, this operation will fail.
4687 *
4688 * If @cancellable is not %NULL, then the operation can be cancelled by
4689 * triggering the cancellable object from another thread. If the operation
4690 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4691 *
4692 * Returns: %TRUE if the @attribute was successfully set to @value
4693 * in the @file, %FALSE otherwise.
4694 */
4695 gboolean
4698 gint32 value,
4699 GFileQueryInfoFlags flags,
4702 {
4706 }
4708 /**
4709 * g_file_set_attribute_uint64:
4710 * @file: input #GFile
4711 * @attribute: a string containing the attribute's name
4712 * @value: a #guint64 containing the attribute's new value
4713 * @flags: a #GFileQueryInfoFlags
4714 * @cancellable: (allow-none): optional #GCancellable object,
4715 * %NULL to ignore
4716 * @error: a #GError, or %NULL
4717 *
4718 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value.
4719 * If @attribute is of a different type, this operation will fail.
4720 *
4721 * If @cancellable is not %NULL, then the operation can be cancelled by
4722 * triggering the cancellable object from another thread. If the operation
4723 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4724 *
4725 * Returns: %TRUE if the @attribute was successfully set to @value
4726 * in the @file, %FALSE otherwise.
4727 */
4728 gboolean
4731 guint64 value,
4732 GFileQueryInfoFlags flags,
4735 {
4739 }
4741 /**
4742 * g_file_set_attribute_int64:
4743 * @file: input #GFile
4744 * @attribute: a string containing the attribute's name
4745 * @value: a #guint64 containing the attribute's new value
4746 * @flags: a #GFileQueryInfoFlags
4747 * @cancellable: (allow-none): optional #GCancellable object,
4748 * %NULL to ignore
4749 * @error: a #GError, or %NULL
4750 *
4751 * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value.
4752 * If @attribute is of a different type, this operation will fail.
4753 *
4754 * If @cancellable is not %NULL, then the operation can be cancelled by
4755 * triggering the cancellable object from another thread. If the operation
4756 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4757 *
4758 * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise.
4759 */
4760 gboolean
4763 gint64 value,
4764 GFileQueryInfoFlags flags,
4767 {
4771 }
4773 /**
4774 * g_file_mount_mountable:
4775 * @file: input #GFile
4776 * @flags: flags affecting the operation
4777 * @mount_operation: (allow-none): a #GMountOperation,
4778 * or %NULL to avoid user interaction
4779 * @cancellable: (allow-none): optional #GCancellable object,
4780 * %NULL to ignore
4781 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4782 * when the request is satisfied, or %NULL
4783 * @user_data: (closure): the data to pass to callback function
4784 *
4785 * Mounts a file of type G_FILE_TYPE_MOUNTABLE.
4786 * Using @mount_operation, you can request callbacks when, for instance,
4787 * passwords are needed during authentication.
4788 *
4789 * If @cancellable is not %NULL, then the operation can be cancelled by
4790 * triggering the cancellable object from another thread. If the operation
4791 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4792 *
4793 * When the operation is finished, @callback will be called.
4794 * You can then call g_file_mount_mountable_finish() to get
4795 * the result of the operation.
4796 */
4797 void
4799 GMountMountFlags flags,
4802 GAsyncReadyCallback callback,
4803 gpointer user_data)
4804 {
4812 {
4814 g_file_mount_mountable,
4818 }
4821 flags,
4822 mount_operation,
4823 cancellable,
4824 callback,
4825 user_data);
4826 }
4828 /**
4829 * g_file_mount_mountable_finish:
4830 * @file: input #GFile
4831 * @result: a #GAsyncResult
4832 * @error: a #GError, or %NULL
4833 *
4834 * Finishes a mount operation. See g_file_mount_mountable() for details.
4835 *
4836 * Finish an asynchronous mount operation that was started
4837 * with g_file_mount_mountable().
4838 *
4839 * Returns: (transfer full): a #GFile or %NULL on error.
4840 * Free the returned object with g_object_unref().
4841 */
4842 GFile *
4846 {
4859 }
4861 /**
4862 * g_file_unmount_mountable:
4863 * @file: input #GFile
4864 * @flags: flags affecting the operation
4865 * @cancellable: (allow-none): optional #GCancellable object,
4866 * %NULL to ignore
4867 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4868 * when the request is satisfied, or %NULL
4869 * @user_data: (closure): the data to pass to callback function
4870 *
4871 * Unmounts a file of type G_FILE_TYPE_MOUNTABLE.
4872 *
4873 * If @cancellable is not %NULL, then the operation can be cancelled by
4874 * triggering the cancellable object from another thread. If the operation
4875 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4876 *
4877 * When the operation is finished, @callback will be called.
4878 * You can then call g_file_unmount_mountable_finish() to get
4879 * the result of the operation.
4880 *
4881 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead.
4882 */
4883 void
4885 GMountUnmountFlags flags,
4887 GAsyncReadyCallback callback,
4888 gpointer user_data)
4889 {
4897 {
4899 g_file_unmount_mountable_with_operation,
4903 }
4906 flags,
4907 cancellable,
4908 callback,
4909 user_data);
4910 }
4912 /**
4913 * g_file_unmount_mountable_finish:
4914 * @file: input #GFile
4915 * @result: a #GAsyncResult
4916 * @error: a #GError, or %NULL
4917 *
4918 * Finishes an unmount operation, see g_file_unmount_mountable() for details.
4919 *
4920 * Finish an asynchronous unmount operation that was started
4921 * with g_file_unmount_mountable().
4922 *
4923 * Returns: %TRUE if the operation finished successfully.
4924 * %FALSE otherwise.
4925 *
4926 * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish()
4927 * instead.
4928 */
4929 gboolean
4933 {
4946 }
4948 /**
4949 * g_file_unmount_mountable_with_operation:
4950 * @file: input #GFile
4951 * @flags: flags affecting the operation
4952 * @mount_operation: (allow-none): a #GMountOperation,
4953 * or %NULL to avoid user interaction
4954 * @cancellable: (allow-none): optional #GCancellable object,
4955 * %NULL to ignore
4956 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
4957 * when the request is satisfied, or %NULL
4958 * @user_data: (closure): the data to pass to callback function
4959 *
4960 * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE.
4961 *
4962 * If @cancellable is not %NULL, then the operation can be cancelled by
4963 * triggering the cancellable object from another thread. If the operation
4964 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
4965 *
4966 * When the operation is finished, @callback will be called.
4967 * You can then call g_file_unmount_mountable_finish() to get
4968 * the result of the operation.
4969 *
4970 * Since: 2.22
4971 */
4972 void
4974 GMountUnmountFlags flags,
4977 GAsyncReadyCallback callback,
4978 gpointer user_data)
4979 {
4987 {
4989 g_file_unmount_mountable_with_operation,
4993 }
4997 flags,
4998 mount_operation,
4999 cancellable,
5000 callback,
5001 user_data);
5002 else
5004 flags,
5005 cancellable,
5006 callback,
5007 user_data);
5008 }
5010 /**
5011 * g_file_unmount_mountable_with_operation_finish:
5012 * @file: input #GFile
5013 * @result: a #GAsyncResult
5014 * @error: a #GError, or %NULL
5015 *
5016 * Finishes an unmount operation,
5017 * see g_file_unmount_mountable_with_operation() for details.
5018 *
5019 * Finish an asynchronous unmount operation that was started
5020 * with g_file_unmount_mountable_with_operation().
5021 *
5022 * Returns: %TRUE if the operation finished successfully.
5023 * %FALSE otherwise.
5024 *
5025 * Since: 2.22
5026 */
5027 gboolean
5031 {
5045 else
5047 }
5049 /**
5050 * g_file_eject_mountable:
5051 * @file: input #GFile
5052 * @flags: flags affecting the operation
5053 * @cancellable: (allow-none): optional #GCancellable object,
5054 * %NULL to ignore
5055 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
5056 * when the request is satisfied, or %NULL
5057 * @user_data: (closure): the data to pass to callback function
5058 *
5059 * Starts an asynchronous eject on a mountable.
5060 * When this operation has completed, @callback will be called with
5061 * @user_user data, and the operation can be finalized with
5062 * g_file_eject_mountable_finish().
5063 *
5064 * If @cancellable is not %NULL, then the operation can be cancelled by
5065 * triggering the cancellable object from another thread. If the operation
5066 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5067 *
5068 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead.
5069 */
5070 void
5072 GMountUnmountFlags flags,
5074 GAsyncReadyCallback callback,
5075 gpointer user_data)
5076 {
5084 {
5086 g_file_eject_mountable_with_operation,
5090 }
5093 flags,
5094 cancellable,
5095 callback,
5096 user_data);
5097 }
5099 /**
5100 * g_file_eject_mountable_finish:
5101 * @file: input #GFile
5102 * @result: a #GAsyncResult
5103 * @error: a #GError, or %NULL
5104 *
5105 * Finishes an asynchronous eject operation started by
5106 * g_file_eject_mountable().
5107 *
5108 * Returns: %TRUE if the @file was ejected successfully.
5109 * %FALSE otherwise.
5110 *
5111 * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish()
5112 * instead.
5113 */
5114 gboolean
5118 {
5131 }
5133 /**
5134 * g_file_eject_mountable_with_operation:
5135 * @file: input #GFile
5136 * @flags: flags affecting the operation
5137 * @mount_operation: (allow-none): a #GMountOperation,
5138 * or %NULL to avoid user interaction
5139 * @cancellable: (allow-none): optional #GCancellable object,
5140 * %NULL to ignore
5141 * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call
5142 * when the request is satisfied, or %NULL
5143 * @user_data: (closure): the data to pass to callback function
5144 *
5145 * Starts an asynchronous eject on a mountable.
5146 * When this operation has completed, @callback will be called with
5147 * @user_user data, and the operation can be finalized with
5148 * g_file_eject_mountable_with_operation_finish().
5149 *
5150 * If @cancellable is not %NULL, then the operation can be cancelled by
5151 * triggering the cancellable object from another thread. If the operation
5152 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5153 *
5154 * Since: 2.22
5155 */
5156 void
5158 GMountUnmountFlags flags,
5161 GAsyncReadyCallback callback,
5162 gpointer user_data)
5163 {
5171 {
5173 g_file_eject_mountable_with_operation,
5177 }
5181 flags,
5182 mount_operation,
5183 cancellable,
5184 callback,
5185 user_data);
5186 else
5188 flags,
5189 cancellable,
5190 callback,
5191 user_data);
5192 }
5194 /**
5195 * g_file_eject_mountable_with_operation_finish:
5196 * @file: input #GFile
5197 * @result: a #GAsyncResult
5198 * @error: a #GError, or %NULL
5199 *
5200 * Finishes an asynchronous eject operation started by
5201 * g_file_eject_mountable_with_operation().
5202 *
5203 * Returns: %TRUE if the @file was ejected successfully.
5204 * %FALSE otherwise.
5205 *
5206 * Since: 2.22
5207 */
5208 gboolean
5212 {
5226 else
5228 }
5230 /**
5231 * g_file_monitor_directory:
5232 * @file: input #GFile
5233 * @flags: a set of #GFileMonitorFlags
5234 * @cancellable: (allow-none): optional #GCancellable object,
5235 * %NULL to ignore
5236 * @error: a #GError, or %NULL
5237 *
5238 * Obtains a directory monitor for the given file.
5239 * This may fail if directory monitoring is not supported.
5240 *
5241 * If @cancellable is not %NULL, then the operation can be cancelled by
5242 * triggering the cancellable object from another thread. If the operation
5243 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5244 *
5245 * It does not make sense for @flags to contain
5246 * %G_FILE_MONITOR_WATCH_HARD_LINKS, since hard links can not be made to
5247 * directories. It is not possible to monitor all the files in a
5248 * directory for changes made via hard links; if you want to do this then
5249 * you must register individual watches with g_file_monitor().
5250 *
5251 * Virtual: monitor_dir
5252 * Returns: (transfer full): a #GFileMonitor for the given @file,
5253 * or %NULL on error.
5254 * Free the returned object with g_object_unref().
5255 */
5256 GFileMonitor *
5258 GFileMonitorFlags flags,
5261 {
5273 {
5275 G_IO_ERROR_NOT_SUPPORTED,
5278 }
5281 }
5283 /**
5284 * g_file_monitor_file:
5285 * @file: input #GFile
5286 * @flags: a set of #GFileMonitorFlags
5287 * @cancellable: (allow-none): optional #GCancellable object,
5288 * %NULL to ignore
5289 * @error: a #GError, or %NULL
5290 *
5291 * Obtains a file monitor for the given file. If no file notification
5292 * mechanism exists, then regular polling of the file is used.
5293 *
5294 * If @cancellable is not %NULL, then the operation can be cancelled by
5295 * triggering the cancellable object from another thread. If the operation
5296 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5297 *
5298 * If @flags contains %G_FILE_MONITOR_WATCH_HARD_LINKS then the monitor
5299 * will also attempt to report changes made to the file via another
5300 * filename (ie, a hard link). Without this flag, you can only rely on
5301 * changes made through the filename contained in @file to be
5302 * reported. Using this flag may result in an increase in resource
5303 * usage, and may not have any effect depending on the #GFileMonitor
5304 * backend and/or filesystem type.
5305 *
5306 * Returns: (transfer full): a #GFileMonitor for the given @file,
5307 * or %NULL on error.
5308 * Free the returned object with g_object_unref().
5309 */
5310 GFileMonitor *
5312 GFileMonitorFlags flags,
5315 {
5331 /* Fallback to polling */
5336 }
5338 /**
5339 * g_file_monitor:
5340 * @file: input #GFile
5341 * @flags: a set of #GFileMonitorFlags
5342 * @cancellable: (allow-none): optional #GCancellable object,
5343 * %NULL to ignore
5344 * @error: a #GError, or %NULL
5345 *
5346 * Obtains a file or directory monitor for the given file,
5347 * depending on the type of the file.
5348 *
5349 * If @cancellable is not %NULL, then the operation can be cancelled by
5350 * triggering the cancellable object from another thread. If the operation
5351 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
5352 *
5353 * Returns: (transfer full): a #GFileMonitor for the given @file,
5354 * or %NULL on error.
5355 * Free the returned object with g_object_unref().
5356 *
5357 * Since: 2.18
5358 */
5359 GFileMonitor *
5361 GFileMonitorFlags flags,
5364 {
5369 else
5371 }
5373 /********************************************
5374 * Default implementation of async ops *
5375 ********************************************/
5379 GFileQueryInfoFlags flags;
5382 static void
5384 {
5387 }
5389 static void
5391 gpointer object,
5392 gpointer task_data,
5394 {
5399 info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error);
5402 else
5404 }
5406 static void
5409 GFileQueryInfoFlags flags,
5412 GAsyncReadyCallback callback,
5413 gpointer user_data)
5414 {
5427 }
5433 {
5437 }
5439 static void
5441 gpointer object,
5442 gpointer task_data,
5444 {
5452 else
5454 }
5456 static void
5461 GAsyncReadyCallback callback,
5462 gpointer user_data)
5463 {
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 {
5521 }
5527 {
5531 }
5533 static void
5535 gpointer object,
5536 gpointer task_data,
5538 {
5545 else
5547 }
5549 static void
5553 GAsyncReadyCallback callback,
5554 gpointer user_data)
5555 {
5562 }
5568 {
5572 }
5574 static void
5576 gpointer source_object,
5577 gpointer task_data,
5579 {
5587 else
5589 }
5591 static void
5593 GFileCreateFlags flags,
5596 GAsyncReadyCallback callback,
5597 gpointer user_data)
5598 {
5611 }
5617 {
5621 }
5623 static void
5625 gpointer source_object,
5626 gpointer task_data,
5628 {
5636 else
5638 }
5640 static void
5642 GFileCreateFlags flags,
5645 GAsyncReadyCallback callback,
5646 gpointer user_data)
5647 {
5660 }
5666 {
5670 }
5675 gboolean make_backup;
5676 GFileCreateFlags flags;
5679 static void
5681 {
5686 }
5688 static void
5690 gpointer source_object,
5691 gpointer task_data,
5693 {
5702 cancellable,
5707 else
5709 }
5711 static void
5714 gboolean make_backup,
5715 GFileCreateFlags flags,
5718 GAsyncReadyCallback callback,
5719 gpointer user_data)
5720 {
5735 }
5741 {
5745 }
5747 static void
5749 gpointer object,
5750 gpointer task_data,
5752 {
5757 else
5759 }
5761 static void
5765 GAsyncReadyCallback callback,
5766 gpointer user_data)
5767 {
5774 }
5776 static gboolean
5780 {
5784 }
5786 static void
5788 gpointer object,
5789 gpointer task_data,
5791 {
5796 else
5798 }
5800 static void
5804 GAsyncReadyCallback callback,
5805 gpointer user_data)
5806 {
5813 }
5815 static gboolean
5819 {
5823 }
5825 static void
5827 gpointer object,
5828 gpointer task_data,
5830 {
5835 else
5837 }
5839 static void
5843 GAsyncReadyCallback callback,
5844 gpointer user_data)
5845 {
5852 }
5854 static gboolean
5858 {
5862 }
5864 static void
5866 gpointer object,
5867 gpointer task_data,
5869 {
5877 else
5879 }
5881 static void
5885 GAsyncReadyCallback callback,
5886 gpointer user_data)
5887 {
5895 }
5901 {
5905 }
5907 static void
5909 gpointer object,
5910 gpointer task_data,
5912 {
5921 else
5923 }
5925 static void
5927 GFileCreateFlags flags,
5930 GAsyncReadyCallback callback,
5931 gpointer user_data)
5932 {
5945 }
5951 {
5955 }
5959 gboolean make_backup;
5960 GFileCreateFlags flags;
5963 static void
5965 {
5968 }
5970 static void
5972 gpointer object,
5973 gpointer task_data,
5975 {
5984 cancellable,
5989 else
5991 }
5993 static void
5996 gboolean make_backup,
5997 GFileCreateFlags flags,
6000 GAsyncReadyCallback callback,
6001 gpointer user_data)
6002 {
6017 }
6023 {
6027 }
6029 static void
6031 gpointer object,
6032 gpointer task_data,
6034 {
6043 else
6045 }
6047 static void
6052 GAsyncReadyCallback callback,
6053 gpointer user_data)
6054 {
6063 }
6069 {
6073 }
6076 GFileQueryInfoFlags flags;
6078 gboolean res;
6082 static void
6084 {
6090 }
6092 static void
6094 gpointer object,
6095 gpointer task_data,
6097 {
6104 cancellable,
6106 }
6108 static void
6111 GFileQueryInfoFlags flags,
6114 GAsyncReadyCallback callback,
6115 gpointer user_data)
6116 {
6130 }
6132 static gboolean
6137 {
6151 }
6153 static void
6155 gpointer object,
6156 gpointer task_data,
6158 {
6166 else
6168 }
6170 static void
6174 GAsyncReadyCallback callback,
6175 gpointer user_data)
6176 {
6184 }
6190 {
6194 }
6200 GFileCopyFlags flags;
6201 GFileProgressCallback progress_cb;
6202 gpointer progress_cb_data;
6205 static void
6207 {
6211 }
6215 goffset current_num_bytes;
6216 goffset total_num_bytes;
6219 static gboolean
6221 {
6230 }
6232 static void
6234 goffset total_num_bytes,
6235 gpointer user_data)
6236 {
6248 copy_async_progress_in_main,
6249 progress,
6250 g_free);
6251 }
6253 static void
6255 gpointer source,
6256 gpointer task_data,
6258 {
6260 gboolean result;
6266 cancellable,
6268 task,
6272 else
6274 }
6276 static void
6279 GFileCopyFlags flags,
6282 GFileProgressCallback progress_callback,
6283 gpointer progress_callback_data,
6284 GAsyncReadyCallback callback,
6285 gpointer user_data)
6286 {
6302 }
6304 static gboolean
6308 {
6312 }
6315 /********************************************
6316 * Default VFS operations *
6317 ********************************************/
6319 /**
6320 * g_file_new_for_path:
6321 * @path: (type filename): a string containing a relative or absolute path.
6322 * The string must be encoded in the glib filename encoding.
6323 *
6324 * Constructs a #GFile for a given path. This operation never
6325 * fails, but the returned object might not support any I/O
6326 * operation if @path is malformed.
6327 *
6328 * Returns: (transfer full): a new #GFile for the given @path.
6329 * Free the returned object with g_object_unref().
6330 */
6331 GFile *
6333 {
6337 }
6339 /**
6340 * g_file_new_for_uri:
6341 * @uri: a UTF-8 string containing a URI
6342 *
6343 * Constructs a #GFile for a given URI. This operation never
6344 * fails, but the returned object might not support any I/O
6345 * operation if @uri is malformed or if the uri type is
6346 * not supported.
6347 *
6348 * Returns: (transfer full): a new #GFile for the given @uri.
6349 * Free the returned object with g_object_unref().
6350 */
6351 GFile *
6353 {
6357 }
6359 /**
6360 * g_file_new_tmp:
6361 * @tmpl: (type filename) (allow-none): Template for the file
6362 * name, as in g_file_open_tmp(), or %NULL for a default template
6363 * @iostream: (out): on return, a #GFileIOStream for the created file
6364 * @error: a #GError, or %NULL
6365 *
6366 * Opens a file in the preferred directory for temporary files (as
6367 * returned by g_get_tmp_dir()) and returns a #GFile and
6368 * #GFileIOStream pointing to it.
6369 *
6370 * @tmpl should be a string in the GLib file name encoding
6371 * containing a sequence of six 'X' characters, and containing no
6372 * directory components. If it is %NULL, a default template is used.
6373 *
6374 * Unlike the other #GFile constructors, this will return %NULL if
6375 * a temporary file could not be created.
6376 *
6377 * Returns: (transfer full): a new #GFile.
6378 * Free the returned object with g_object_unref().
6379 *
6380 * Since: 2.32
6381 */
6382 GFile *
6386 {
6387 gint fd;
6407 }
6409 /**
6410 * g_file_parse_name:
6411 * @parse_name: a file name or path to be parsed
6412 *
6413 * Constructs a #GFile with the given @parse_name (i.e. something
6414 * given by g_file_get_parse_name()). This operation never fails,
6415 * but the returned object might not support any I/O operation if
6416 * the @parse_name cannot be parsed.
6417 *
6418 * Returns: (transfer full): a new #GFile.
6419 */
6420 GFile *
6422 {
6426 }
6428 static gboolean
6430 {
6432 }
6434 /* Following RFC 2396, valid schemes are built like:
6435 * scheme = alpha *( alpha | digit | "+" | "-" | "." )
6436 */
6437 static gboolean
6439 {
6448 p++;
6452 }
6457 {
6468 {
6474 }
6475 else
6482 }
6484 /**
6485 * g_file_new_for_commandline_arg:
6486 * @arg: a command line string
6487 *
6488 * Creates a #GFile with the given argument from the command line.
6489 * The value of @arg can be either a URI, an absolute path or a
6490 * relative path resolved relative to the current working directory.
6491 * This operation never fails, but the returned object might not
6492 * support any I/O operation if @arg points to a malformed path.
6493 *
6494 * Note that on Windows, this function expects its argument to be in
6495 * UTF-8 -- not the system code page. This means that you
6496 * should not use this function with string from argv as it is passed
6497 * to main(). g_win32_get_command_line() will return a UTF-8 version of
6498 * the commandline. #GApplication also uses UTF-8 but
6499 * g_application_command_line_create_file_for_arg() may be more useful
6500 * for you there. It is also always possible to use this function with
6501 * #GOptionContext arguments of type %G_OPTION_ARG_FILENAME.
6502 *
6503 * Returns: (transfer full): a new #GFile.
6504 * Free the returned object with g_object_unref().
6505 */
6506 GFile *
6508 {
6512 }
6514 /**
6515 * g_file_new_for_commandline_arg_and_cwd:
6516 * @arg: a command line string
6517 * @cwd: (type filename): the current working directory of the commandline
6518 *
6519 * Creates a #GFile with the given argument from the command line.
6520 *
6521 * This function is similar to g_file_new_for_commandline_arg() except
6522 * that it allows for passing the current working directory as an
6523 * argument instead of using the current working directory of the
6524 * process.
6525 *
6526 * This is useful if the commandline argument was given in a context
6527 * other than the invocation of the current process.
6528 *
6529 * See also g_application_command_line_create_file_for_arg().
6530 *
6531 * Returns: (transfer full): a new #GFile
6532 *
6533 * Since: 2.36
6534 **/
6535 GFile *
6538 {
6543 }
6545 /**
6546 * g_file_mount_enclosing_volume:
6547 * @location: input #GFile
6548 * @flags: flags affecting the operation
6549 * @mount_operation: (allow-none): a #GMountOperation
6550 * or %NULL to avoid user interaction
6551 * @cancellable: (allow-none): optional #GCancellable object,
6552 * %NULL to ignore
6553 * @callback: (allow-none): a #GAsyncReadyCallback to call
6554 * when the request is satisfied, or %NULL
6555 * @user_data: the data to pass to callback function
6556 *
6557 * Starts a @mount_operation, mounting the volume that contains
6558 * the file @location.
6559 *
6560 * When this operation has completed, @callback will be called with
6561 * @user_user data, and the operation can be finalized with
6562 * g_file_mount_enclosing_volume_finish().
6563 *
6564 * If @cancellable is not %NULL, then the operation can be cancelled by
6565 * triggering the cancellable object from another thread. If the operation
6566 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6567 */
6568 void
6570 GMountMountFlags flags,
6573 GAsyncReadyCallback callback,
6574 gpointer user_data)
6575 {
6583 {
6585 g_file_mount_enclosing_volume,
6589 }
6591 (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data);
6593 }
6595 /**
6596 * g_file_mount_enclosing_volume_finish:
6597 * @location: input #GFile
6598 * @result: a #GAsyncResult
6599 * @error: a #GError, or %NULL
6600 *
6601 * Finishes a mount operation started by g_file_mount_enclosing_volume().
6602 *
6603 * Returns: %TRUE if successful. If an error has occurred,
6604 * this function will return %FALSE and set @error
6605 * appropriately if present.
6606 */
6607 gboolean
6611 {
6625 }
6627 /********************************************
6628 * Utility functions *
6629 ********************************************/
6631 /**
6632 * g_file_query_default_handler:
6633 * @file: a #GFile to open
6634 * @cancellable: optional #GCancellable object, %NULL to ignore
6635 * @error: a #GError, or %NULL
6636 *
6637 * Returns the #GAppInfo that is registered as the default
6638 * application to handle the file specified by @file.
6639 *
6640 * If @cancellable is not %NULL, then the operation can be cancelled by
6641 * triggering the cancellable object from another thread. If the operation
6642 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6643 *
6644 * Returns: (transfer full): a #GAppInfo if the handle was found,
6645 * %NULL if there were errors.
6646 * When you are done with it, release it with g_object_unref()
6647 */
6648 GAppInfo *
6652 {
6661 {
6667 }
6670 G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE,
6672 cancellable,
6673 error);
6681 {
6682 /* Don't use is_native(), as we want to support fuse paths if available */
6687 }
6695 G_IO_ERROR_NOT_SUPPORTED,
6698 }
6700 #define GET_CONTENT_BLOCK_SIZE 8192
6702 /**
6703 * g_file_load_contents:
6704 * @file: input #GFile
6705 * @cancellable: optional #GCancellable object, %NULL to ignore
6706 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6707 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6708 * or %NULL if the length is not needed
6709 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6710 * or %NULL if the entity tag is not needed
6711 * @error: a #GError, or %NULL
6712 *
6713 * Loads the content of the file into memory. The data is always
6714 * zero-terminated, but this is not included in the resultant @length.
6715 * The returned @content should be freed with g_free() when no longer
6716 * needed.
6717 *
6718 * If @cancellable is not %NULL, then the operation can be cancelled by
6719 * triggering the cancellable object from another thread. If the operation
6720 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6721 *
6722 * Returns: %TRUE if the @file's contents were successfully loaded.
6723 * %FALSE if there were errors.
6724 */
6725 gboolean
6732 {
6735 gsize pos;
6736 gssize res;
6752 GET_CONTENT_BLOCK_SIZE,
6754 {
6757 }
6760 {
6764 G_FILE_ATTRIBUTE_ETAG_VALUE,
6765 cancellable,
6766 NULL);
6768 {
6771 }
6772 }
6774 /* Ignore errors on close */
6779 {
6780 /* error is set already */
6783 }
6788 /* Zero terminate (we got an extra byte allocated for this */
6794 }
6798 GFileReadMoreCallback read_more_callback;
6800 gsize pos;
6805 static void
6807 {
6812 }
6814 static void
6817 gpointer user_data)
6818 {
6822 /* Ignore errors here, we're only reading anyway */
6828 }
6830 static void
6833 gpointer user_data)
6834 {
6842 {
6845 }
6850 }
6852 static void
6855 gpointer user_data)
6856 {
6860 gssize read_size;
6865 {
6869 /* Close the file ignoring any error */
6872 }
6874 {
6876 G_FILE_ATTRIBUTE_ETAG_VALUE,
6879 load_contents_fstat_callback,
6880 data);
6881 }
6883 {
6894 G_FILE_ATTRIBUTE_ETAG_VALUE,
6897 load_contents_fstat_callback,
6898 data);
6899 else
6902 GET_CONTENT_BLOCK_SIZE,
6905 load_contents_read_callback,
6906 data);
6907 }
6908 }
6910 static void
6913 gpointer user_data)
6914 {
6923 {
6928 GET_CONTENT_BLOCK_SIZE,
6931 load_contents_read_callback,
6932 data);
6933 }
6934 else
6935 {
6938 }
6939 }
6941 /**
6942 * g_file_load_partial_contents_async: (skip)
6943 * @file: input #GFile
6944 * @cancellable: optional #GCancellable object, %NULL to ignore
6945 * @read_more_callback: a #GFileReadMoreCallback to receive partial data
6946 * and to specify whether further data should be read
6947 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
6948 * @user_data: the data to pass to the callback functions
6949 *
6950 * Reads the partial contents of a file. A #GFileReadMoreCallback should
6951 * be used to stop reading from the file when appropriate, else this
6952 * function will behave exactly as g_file_load_contents_async(). This
6953 * operation can be finished by g_file_load_partial_contents_finish().
6954 *
6955 * Users of this function should be aware that @user_data is passed to
6956 * both the @read_more_callback and the @callback.
6957 *
6958 * If @cancellable is not %NULL, then the operation can be cancelled by
6959 * triggering the cancellable object from another thread. If the operation
6960 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
6961 */
6962 void
6965 GFileReadMoreCallback read_more_callback,
6966 GAsyncReadyCallback callback,
6967 gpointer user_data)
6968 {
6983 load_contents_open_callback,
6984 data);
6985 }
6987 /**
6988 * g_file_load_partial_contents_finish:
6989 * @file: input #GFile
6990 * @res: a #GAsyncResult
6991 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
6992 * @length: (out) (allow-none): a location to place the length of the contents of the file,
6993 * or %NULL if the length is not needed
6994 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
6995 * or %NULL if the entity tag is not needed
6996 * @error: a #GError, or %NULL
6997 *
6998 * Finishes an asynchronous partial load operation that was started
6999 * with g_file_load_partial_contents_async(). The data is always
7000 * zero-terminated, but this is not included in the resultant @length.
7001 * The returned @content should be freed with g_free() when no longer
7002 * needed.
7003 *
7004 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7005 * present, it will be set appropriately.
7006 */
7007 gboolean
7014 {
7025 {
7029 }
7037 {
7040 }
7042 /* Zero terminate */
7050 }
7052 /**
7053 * g_file_load_contents_async:
7054 * @file: input #GFile
7055 * @cancellable: optional #GCancellable object, %NULL to ignore
7056 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7057 * @user_data: the data to pass to callback function
7058 *
7059 * Starts an asynchronous load of the @file's contents.
7060 *
7061 * For more details, see g_file_load_contents() which is
7062 * the synchronous version of this call.
7063 *
7064 * When the load operation has completed, @callback will be called
7065 * with @user data. To finish the operation, call
7066 * g_file_load_contents_finish() with the #GAsyncResult returned by
7067 * the @callback.
7068 *
7069 * If @cancellable is not %NULL, then the operation can be cancelled by
7070 * triggering the cancellable object from another thread. If the operation
7071 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7072 */
7073 void
7076 GAsyncReadyCallback callback,
7077 gpointer user_data)
7078 {
7080 cancellable,
7081 NULL,
7083 }
7085 /**
7086 * g_file_load_contents_finish:
7087 * @file: input #GFile
7088 * @res: a #GAsyncResult
7089 * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file
7090 * @length: (out) (allow-none): a location to place the length of the contents of the file,
7091 * or %NULL if the length is not needed
7092 * @etag_out: (out) (allow-none): a location to place the current entity tag for the file,
7093 * or %NULL if the entity tag is not needed
7094 * @error: a #GError, or %NULL
7095 *
7096 * Finishes an asynchronous load of the @file's contents.
7097 * The contents are placed in @contents, and @length is set to the
7098 * size of the @contents string. The @content should be freed with
7099 * g_free() when no longer needed. If @etag_out is present, it will be
7100 * set to the new entity tag for the @file.
7101 *
7102 * Returns: %TRUE if the load was successful. If %FALSE and @error is
7103 * present, it will be set appropriately.
7104 */
7105 gboolean
7112 {
7114 res,
7115 contents,
7116 length,
7117 etag_out,
7118 error);
7119 }
7121 /**
7122 * g_file_replace_contents:
7123 * @file: input #GFile
7124 * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file
7125 * @length: the length of @contents in bytes
7126 * @etag: (allow-none): the old [entity-tag][gfile-etag] for the document,
7127 * or %NULL
7128 * @make_backup: %TRUE if a backup should be created
7129 * @flags: a set of #GFileCreateFlags
7130 * @new_etag: (allow-none) (out): a location to a new [entity tag][gfile-etag]
7131 * for the document. This should be freed with g_free() when no longer
7132 * needed, or %NULL
7133 * @cancellable: optional #GCancellable object, %NULL to ignore
7134 * @error: a #GError, or %NULL
7135 *
7136 * Replaces the contents of @file with @contents of @length bytes.
7137 *
7138 * If @etag is specified (not %NULL), any existing file must have that etag,
7139 * or the error %G_IO_ERROR_WRONG_ETAG will be returned.
7140 *
7141 * If @make_backup is %TRUE, this function will attempt to make a backup
7142 * of @file. Internally, it uses g_file_replace(), so will try to replace the
7143 * file contents in the safest way possible. For example, atomic renames are
7144 * used when replacing local files’ contents.
7145 *
7146 * If @cancellable is not %NULL, then the operation can be cancelled by
7147 * triggering the cancellable object from another thread. If the operation
7148 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7149 *
7150 * The returned @new_etag can be used to verify that the file hasn't
7151 * changed the next time it is saved over.
7152 *
7153 * Returns: %TRUE if successful. If an error has occurred, this function
7154 * will return %FALSE and set @error appropriately if present.
7155 */
7156 gboolean
7159 gsize length,
7161 gboolean make_backup,
7162 GFileCreateFlags flags,
7166 {
7169 gssize res;
7170 gboolean ret;
7185 cancellable,
7187 {
7190 }
7193 {
7194 /* Ignore errors on close */
7198 /* error is set already */
7200 }
7210 }
7215 gsize pos;
7217 gboolean failed;
7220 static void
7222 {
7226 }
7228 static void
7231 gpointer user_data)
7232 {
7236 /* Ignore errors here, we're only reading anyway */
7241 {
7244 }
7246 }
7248 static void
7251 gpointer user_data)
7252 {
7256 gssize write_size;
7261 {
7262 /* Error or EOF, close the file */
7264 {
7267 }
7271 }
7273 {
7275 gsize length;
7284 else
7290 replace_contents_write_callback,
7291 data);
7292 }
7293 }
7295 static void
7298 gpointer user_data)
7299 {
7308 {
7310 gsize length;
7318 replace_contents_write_callback,
7319 data);
7320 }
7321 else
7322 {
7325 }
7326 }
7328 /**
7329 * g_file_replace_contents_async:
7330 * @file: input #GFile
7331 * @contents: (element-type guint8) (array length=length): string of contents to replace the file with
7332 * @length: the length of @contents in bytes
7333 * @etag: (allow-none): a new [entity tag][gfile-etag] for the @file, or %NULL
7334 * @make_backup: %TRUE if a backup should be created
7335 * @flags: a set of #GFileCreateFlags
7336 * @cancellable: optional #GCancellable object, %NULL to ignore
7337 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7338 * @user_data: the data to pass to callback function
7339 *
7340 * Starts an asynchronous replacement of @file with the given
7341 * @contents of @length bytes. @etag will replace the document's
7342 * current entity tag.
7343 *
7344 * When this operation has completed, @callback will be called with
7345 * @user_user data, and the operation can be finalized with
7346 * g_file_replace_contents_finish().
7347 *
7348 * If @cancellable is not %NULL, then the operation can be cancelled by
7349 * triggering the cancellable object from another thread. If the operation
7350 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7351 *
7352 * If @make_backup is %TRUE, this function will attempt to
7353 * make a backup of @file.
7354 *
7355 * Note that no copy of @content will be made, so it must stay valid
7356 * until @callback is called. See g_file_replace_contents_bytes_async()
7357 * for a #GBytes version that will automatically hold a reference to the
7358 * contents (without copying) for the duration of the call.
7359 */
7360 void
7363 gsize length,
7365 gboolean make_backup,
7366 GFileCreateFlags flags,
7368 GAsyncReadyCallback callback,
7369 gpointer user_data)
7370 {
7377 }
7379 /**
7380 * g_file_replace_contents_bytes_async:
7381 * @file: input #GFile
7382 * @contents: a #GBytes
7383 * @etag: (allow-none): a new [entity tag][gfile-etag] for the @file, or %NULL
7384 * @make_backup: %TRUE if a backup should be created
7385 * @flags: a set of #GFileCreateFlags
7386 * @cancellable: optional #GCancellable object, %NULL to ignore
7387 * @callback: a #GAsyncReadyCallback to call when the request is satisfied
7388 * @user_data: the data to pass to callback function
7389 *
7390 * Same as g_file_replace_contents_async() but takes a #GBytes input instead.
7391 * This function will keep a ref on @contents until the operation is done.
7392 * Unlike g_file_replace_contents_async() this allows forgetting about the
7393 * content without waiting for the callback.
7394 *
7395 * When this operation has completed, @callback will be called with
7396 * @user_user data, and the operation can be finalized with
7397 * g_file_replace_contents_finish().
7398 *
7399 * Since: 2.40
7400 */
7401 void
7405 gboolean make_backup,
7406 GFileCreateFlags flags,
7408 GAsyncReadyCallback callback,
7409 gpointer user_data)
7410 {
7424 etag,
7425 make_backup,
7426 flags,
7429 replace_contents_open_callback,
7430 data);
7431 }
7433 /**
7434 * g_file_replace_contents_finish:
7435 * @file: input #GFile
7436 * @res: a #GAsyncResult
7437 * @new_etag: (out) (allow-none): a location of a new [entity tag][gfile-etag]
7438 * for the document. This should be freed with g_free() when it is no
7439 * longer needed, or %NULL
7440 * @error: a #GError, or %NULL
7441 *
7442 * Finishes an asynchronous replace of the given @file. See
7443 * g_file_replace_contents_async(). Sets @new_etag to the new entity
7444 * tag for the document, if present.
7445 *
7446 * Returns: %TRUE on success, %FALSE on failure.
7447 */
7448 gboolean
7453 {
7468 {
7471 }
7474 }
7476 gboolean
7478 GFileMeasureFlags flags,
7480 GFileMeasureProgressCallback progress_callback,
7481 gpointer progress_data,
7486 {
7490 }
7493 {
7494 GFileMeasureFlags flags;
7495 GFileMeasureProgressCallback progress_callback;
7496 gpointer progress_data;
7500 {
7501 guint64 disk_usage;
7502 guint64 num_dirs;
7503 guint64 num_files;
7507 {
7508 GFileMeasureProgressCallback callback;
7509 gpointer user_data;
7510 gboolean reporting;
7511 guint64 current_size;
7512 guint64 num_dirs;
7513 guint64 num_files;
7516 static gboolean
7518 {
7526 }
7528 static void
7530 guint64 current_size,
7531 guint64 num_dirs,
7532 guint64 num_files,
7533 gpointer user_data)
7534 {
7535 MeasureProgress progress;
7550 measure_disk_usage_invoke_progress,
7552 g_free);
7553 }
7555 static void
7557 gpointer source_object,
7558 gpointer task_data,
7560 {
7570 else
7572 }
7574 static void
7576 GFileMeasureFlags flags,
7577 gint io_priority,
7579 GFileMeasureProgressCallback progress_callback,
7580 gpointer progress_data,
7581 GAsyncReadyCallback callback,
7582 gpointer user_data)
7583 {
7584 MeasureTaskData data;
7597 }
7599 static gboolean
7606 {
7628 }
7630 /**
7631 * g_file_measure_disk_usage:
7632 * @file: a #GFile
7633 * @flags: #GFileMeasureFlags
7634 * @cancellable: (allow-none): optional #GCancellable
7635 * @progress_callback: (allow-none): a #GFileMeasureProgressCallback
7636 * @progress_data: user_data for @progress_callback
7637 * @disk_usage: (allow-none) (out): the number of bytes of disk space used
7638 * @num_dirs: (allow-none) (out): the number of directories encountered
7639 * @num_files: (allow-none) (out): the number of non-directories encountered
7640 * @error: (allow-none): %NULL, or a pointer to a %NULL #GError pointer
7641 *
7642 * Recursively measures the disk usage of @file.
7643 *
7644 * This is essentially an analog of the 'du' command, but it also
7645 * reports the number of directories and non-directory files encountered
7646 * (including things like symbolic links).
7647 *
7648 * By default, errors are only reported against the toplevel file
7649 * itself. Errors found while recursing are silently ignored, unless
7650 * %G_FILE_DISK_USAGE_REPORT_ALL_ERRORS is given in @flags.
7651 *
7652 * The returned size, @disk_usage, is in bytes and should be formatted
7653 * with g_format_size() in order to get something reasonable for showing
7654 * in a user interface.
7655 *
7656 * @progress_callback and @progress_data can be given to request
7657 * periodic progress updates while scanning. See the documentation for
7658 * #GFileMeasureProgressCallback for information about when and how the
7659 * callback will be invoked.
7660 *
7661 * Returns: %TRUE if successful, with the out parameters set.
7662 * %FALSE otherwise, with @error set.
7663 *
7664 * Since: 2.38
7665 **/
7666 gboolean
7668 GFileMeasureFlags flags,
7670 GFileMeasureProgressCallback progress_callback,
7671 gpointer progress_data,
7676 {
7684 error);
7685 }
7687 /**
7688 * g_file_measure_disk_usage_async:
7689 * @file: a #GFile
7690 * @flags: #GFileMeasureFlags
7691 * @io_priority: the [I/O priority][io-priority] of the request
7692 * @cancellable: (allow-none): optional #GCancellable
7693 * @progress_callback: (allow-none): a #GFileMeasureProgressCallback
7694 * @progress_data: user_data for @progress_callback
7695 * @callback: (allow-none): a #GAsyncReadyCallback to call when complete
7696 * @user_data: the data to pass to callback function
7697 *
7698 * Recursively measures the disk usage of @file.
7699 *
7700 * This is the asynchronous version of g_file_measure_disk_usage(). See
7701 * there for more information.
7702 *
7703 * Since: 2.38
7704 **/
7705 void
7707 GFileMeasureFlags flags,
7708 gint io_priority,
7710 GFileMeasureProgressCallback progress_callback,
7711 gpointer progress_data,
7712 GAsyncReadyCallback callback,
7713 gpointer user_data)
7714 {
7721 }
7723 /**
7724 * g_file_measure_disk_usage_finish:
7725 * @file: a #GFile
7726 * @result: the #GAsyncResult passed to your #GAsyncReadyCallback
7727 * @disk_usage: (allow-none) (out): the number of bytes of disk space used
7728 * @num_dirs: (allow-none) (out): the number of directories encountered
7729 * @num_files: (allow-none) (out): the number of non-directories encountered
7730 * @error: (allow-none): %NULL, or a pointer to a %NULL #GError pointer
7731 *
7732 * Collects the results from an earlier call to
7733 * g_file_measure_disk_usage_async(). See g_file_measure_disk_usage() for
7734 * more information.
7735 *
7736 * Returns: %TRUE if successful, with the out parameters set.
7737 * %FALSE otherwise, with @error set.
7738 *
7739 * Since: 2.38
7740 **/
7741 gboolean
7748 {
7752 return G_FILE_GET_IFACE (file)->measure_disk_usage_finish (file, result, disk_usage, num_dirs, num_files, error);
7753 }
7755 /**
7756 * g_file_start_mountable:
7757 * @file: input #GFile
7758 * @flags: flags affecting the operation
7759 * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction
7760 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
7761 * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL
7762 * @user_data: the data to pass to callback function
7763 *
7764 * Starts a file of type #G_FILE_TYPE_MOUNTABLE.
7765 * Using @start_operation, you can request callbacks when, for instance,
7766 * passwords are needed during authentication.
7767 *
7768 * If @cancellable is not %NULL, then the operation can be cancelled by
7769 * triggering the cancellable object from another thread. If the operation
7770 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7771 *
7772 * When the operation is finished, @callback will be called.
7773 * You can then call g_file_mount_mountable_finish() to get
7774 * the result of the operation.
7775 *
7776 * Since: 2.22
7777 */
7778 void
7780 GDriveStartFlags flags,
7783 GAsyncReadyCallback callback,
7784 gpointer user_data)
7785 {
7793 {
7795 g_file_start_mountable,
7799 }
7802 flags,
7803 start_operation,
7804 cancellable,
7805 callback,
7806 user_data);
7807 }
7809 /**
7810 * g_file_start_mountable_finish:
7811 * @file: input #GFile
7812 * @result: a #GAsyncResult
7813 * @error: a #GError, or %NULL
7814 *
7815 * Finishes a start operation. See g_file_start_mountable() for details.
7816 *
7817 * Finish an asynchronous start operation that was started
7818 * with g_file_start_mountable().
7819 *
7820 * Returns: %TRUE if the operation finished successfully. %FALSE
7821 * otherwise.
7822 *
7823 * Since: 2.22
7824 */
7825 gboolean
7829 {
7842 }
7844 /**
7845 * g_file_stop_mountable:
7846 * @file: input #GFile
7847 * @flags: flags affecting the operation
7848 * @mount_operation: (allow-none): a #GMountOperation,
7849 * or %NULL to avoid user interaction.
7850 * @cancellable: (allow-none): optional #GCancellable object,
7851 * %NULL to ignore
7852 * @callback: (allow-none): a #GAsyncReadyCallback to call
7853 * when the request is satisfied, or %NULL
7854 * @user_data: the data to pass to callback function
7855 *
7856 * Stops a file of type #G_FILE_TYPE_MOUNTABLE.
7857 *
7858 * If @cancellable is not %NULL, then the operation can be cancelled by
7859 * triggering the cancellable object from another thread. If the operation
7860 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7861 *
7862 * When the operation is finished, @callback will be called.
7863 * You can then call g_file_stop_mountable_finish() to get
7864 * the result of the operation.
7865 *
7866 * Since: 2.22
7867 */
7868 void
7870 GMountUnmountFlags flags,
7873 GAsyncReadyCallback callback,
7874 gpointer user_data)
7875 {
7883 {
7885 g_file_stop_mountable,
7889 }
7892 flags,
7893 mount_operation,
7894 cancellable,
7895 callback,
7896 user_data);
7897 }
7899 /**
7900 * g_file_stop_mountable_finish:
7901 * @file: input #GFile
7902 * @result: a #GAsyncResult
7903 * @error: a #GError, or %NULL
7904 *
7905 * Finishes an stop operation, see g_file_stop_mountable() for details.
7906 *
7907 * Finish an asynchronous stop operation that was started
7908 * with g_file_stop_mountable().
7909 *
7910 * Returns: %TRUE if the operation finished successfully.
7911 * %FALSE otherwise.
7912 *
7913 * Since: 2.22
7914 */
7915 gboolean
7919 {
7932 }
7934 /**
7935 * g_file_poll_mountable:
7936 * @file: input #GFile
7937 * @cancellable: optional #GCancellable object, %NULL to ignore
7938 * @callback: (allow-none): a #GAsyncReadyCallback to call
7939 * when the request is satisfied, or %NULL
7940 * @user_data: the data to pass to callback function
7941 *
7942 * Polls a file of type #G_FILE_TYPE_MOUNTABLE.
7943 *
7944 * If @cancellable is not %NULL, then the operation can be cancelled by
7945 * triggering the cancellable object from another thread. If the operation
7946 * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
7947 *
7948 * When the operation is finished, @callback will be called.
7949 * You can then call g_file_mount_mountable_finish() to get
7950 * the result of the operation.
7951 *
7952 * Since: 2.22
7953 */
7954 void
7957 GAsyncReadyCallback callback,
7958 gpointer user_data)
7959 {
7967 {
7969 g_file_poll_mountable,
7973 }
7976 cancellable,
7977 callback,
7978 user_data);
7979 }
7981 /**
7982 * g_file_poll_mountable_finish:
7983 * @file: input #GFile
7984 * @result: a #GAsyncResult
7985 * @error: a #GError, or %NULL
7986 *
7987 * Finishes a poll operation. See g_file_poll_mountable() for details.
7988 *
7989 * Finish an asynchronous poll operation that was polled
7990 * with g_file_poll_mountable().
7991 *
7992 * Returns: %TRUE if the operation finished successfully. %FALSE
7993 * otherwise.
7994 *
7995 * Since: 2.22
7996 */
7997 gboolean
8001 {
8014 }
8016 /**
8017 * g_file_supports_thread_contexts:
8018 * @file: a #GFile
8019 *
8020 * Checks if @file supports
8021 * [thread-default contexts][g-main-context-push-thread-default-context].
8022 * If this returns %FALSE, you cannot perform asynchronous operations on
8023 * @file in a thread that has a thread-default context.
8024 *
8025 * Returns: Whether or not @file supports thread-default contexts.
8026 *
8027 * Since: 2.22
8028 */
8029 gboolean
8031 {
8038 }