diff --git a/gio/gfile.c b/gio/gfile.c index 5c43e570c..d7af16cfb 100644 --- a/gio/gfile.c +++ b/gio/gfile.c @@ -57,153 +57,160 @@ * @short_description: File and Directory Handling * @include: gio/gio.h * @see_also: #GFileInfo, #GFileEnumerator - * - * #GFile is a high level abstraction for manipulating files on a - * virtual file system. #GFiles are lightweight, immutable - * objects that do no I/O upon creation. It is necessary to understand that - * #GFile objects do not represent files, merely an identifier for a file. All - * file content I/O is implemented as streaming operations (see #GInputStream and - * #GOutputStream). * - * To construct a #GFile, you can use: - * g_file_new_for_path() if you have a path. - * g_file_new_for_uri() if you have a URI. - * g_file_new_for_commandline_arg() for a command line argument. - * g_file_new_tmp() to create a temporary file from a template. - * g_file_parse_name() from a utf8 string gotten from g_file_get_parse_name(). - * - * One way to think of a #GFile is as an abstraction of a pathname. For normal - * files the system pathname is what is stored internally, but as #GFiles - * are extensible it could also be something else that corresponds to a pathname - * in a userspace implementation of a filesystem. + * #GFile is a high level abstraction for manipulating files on a + * virtual file system. #GFiles are lightweight, immutable objects + * that do no I/O upon creation. It is necessary to understand that + * #GFile objects do not represent files, merely an identifier for a + * file. All file content I/O is implemented as streaming operations + * (see #GInputStream and #GOutputStream). * - * #GFiles make up hierarchies of directories and files that correspond to the - * files on a filesystem. You can move through the file system with #GFile using - * g_file_get_parent() to get an identifier for the parent directory, g_file_get_child() - * to get a child within a directory, g_file_resolve_relative_path() to resolve a relative - * path between two #GFiles. There can be multiple hierarchies, so you may not - * end up at the same root if you repeatedly call g_file_get_parent() on two different + * To construct a #GFile, you can use: + * + * g_file_new_for_path() if you have a path. + * g_file_new_for_uri() if you have a URI. + * g_file_new_for_commandline_arg() for a command line argument. + * g_file_new_tmp() to create a temporary file from a template. + * g_file_parse_name() from a UTF-8 string gotten from g_file_get_parse_name(). + * + * + * One way to think of a #GFile is as an abstraction of a pathname. For + * normal files the system pathname is what is stored internally, but as + * #GFiles are extensible it could also be something else that corresponds + * to a pathname in a userspace implementation of a filesystem. + * + * #GFiles make up hierarchies of directories and files that correspond to + * the files on a filesystem. You can move through the file system with + * #GFile using g_file_get_parent() to get an identifier for the parent + * directory, g_file_get_child() to get a child within a directory, + * g_file_resolve_relative_path() to resolve a relative path between two + * #GFiles. There can be multiple hierarchies, so you may not end up at + * the same root if you repeatedly call g_file_get_parent() on two different * files. * - * All #GFiles have a basename (get with g_file_get_basename()). These names - * are byte strings that are used to identify the file on the filesystem (relative to - * its parent directory) and there is no guarantees that they have any particular charset - * encoding or even make any sense at all. If you want to use filenames in a user - * interface you should use the display name that you can get by requesting the + * All #GFiles have a basename (get with g_file_get_basename()). These names + * are byte strings that are used to identify the file on the filesystem + * (relative to its parent directory) and there is no guarantees that they + * have any particular charset encoding or even make any sense at all. If + * you want to use filenames in a user interface you should use the display + * name that you can get by requesting the * %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME attribute with g_file_query_info(). - * This is guaranteed to be in utf8 and can be used in a user interface. But always - * store the real basename or the #GFile to use to actually access the file, because - * there is no way to go from a display name to the actual name. + * This is guaranteed to be in UTF-8 and can be used in a user interface. + * But always store the real basename or the #GFile to use to actually + * access the file, because there is no way to go from a display name to + * the actual name. * - * Using #GFile as an identifier has the same weaknesses as using a path in that - * there may be multiple aliases for the same file. For instance, hard or - * soft links may cause two different #GFiles to refer to the same file. - * Other possible causes for aliases are: case insensitive filesystems, short - * and long names on Fat/NTFS, or bind mounts in Linux. If you want to check if - * two #GFiles point to the same file you can query for the + * Using #GFile as an identifier has the same weaknesses as using a path + * in that there may be multiple aliases for the same file. For instance, + * hard or soft links may cause two different #GFiles to refer to the same + * file. Other possible causes for aliases are: case insensitive filesystems, + * short and long names on FAT/NTFS, or bind mounts in Linux. If you want to + * check if two #GFiles point to the same file you can query for the * %G_FILE_ATTRIBUTE_ID_FILE attribute. Note that #GFile does some trivial - * canonicalization of pathnames passed in, so that trivial differences in the - * path string used at creation (duplicated slashes, slash at end of path, "." - * or ".." path segments, etc) does not create different #GFiles. - * - * Many #GFile operations have both synchronous and asynchronous versions - * to suit your application. Asynchronous versions of synchronous functions - * simply have _async() appended to their function names. The asynchronous - * I/O functions call a #GAsyncReadyCallback which is then used to finalize - * the operation, producing a GAsyncResult which is then passed to the - * function's matching _finish() operation. + * canonicalization of pathnames passed in, so that trivial differences in + * the path string used at creation (duplicated slashes, slash at end of + * path, "." or ".." path segments, etc) does not create different #GFiles. + * + * Many #GFile operations have both synchronous and asynchronous versions + * to suit your application. Asynchronous versions of synchronous functions + * simply have _async() appended to their function names. The asynchronous + * I/O functions call a #GAsyncReadyCallback which is then used to finalize + * the operation, producing a GAsyncResult which is then passed to the + * function's matching _finish() operation. * * Some #GFile operations do not have synchronous analogs, as they may * take a very long time to finish, and blocking may leave an application * unusable. Notable cases include: - * g_file_mount_mountable() to mount a mountable file. - * g_file_unmount_mountable_with_operation() to unmount a mountable file. - * g_file_eject_mountable_with_operation() to eject a mountable file. - * + * + * g_file_mount_mountable() to mount a mountable file. + * g_file_unmount_mountable_with_operation() to unmount a mountable file. + * g_file_eject_mountable_with_operation() to eject a mountable file. + * + * * entity tag - * One notable feature of #GFiles are entity tags, or "etags" for - * short. Entity tags are somewhat like a more abstract version of the + * One notable feature of #GFiles are entity tags, or "etags" for + * short. Entity tags are somewhat like a more abstract version of the * traditional mtime, and can be used to quickly determine if the file has - * been modified from the version on the file system. See the HTTP 1.1 + * been modified from the version on the file system. See the HTTP 1.1 * specification * for HTTP Etag headers, which are a very similar concept. * **/ static void g_file_real_query_info_async (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + const char *attributes, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileInfo * g_file_real_query_info_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_query_filesystem_info_async (GFile *file, - const char *attributes, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + const char *attributes, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileInfo * g_file_real_query_filesystem_info_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_enumerate_children_async (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + const char *attributes, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileEnumerator * g_file_real_enumerate_children_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_read_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileInputStream * g_file_real_read_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_append_to_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileOutputStream *g_file_real_append_to_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_create_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileOutputStream *g_file_real_create_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_replace_async (GFile *file, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFileOutputStream *g_file_real_replace_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_delete_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static gboolean g_file_real_delete_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_open_readwrite_async (GFile *file, int io_priority, GCancellable *cancellable, @@ -233,50 +240,50 @@ static GFileIOStream * g_file_real_replace_readwrite_finish (GFile GAsyncResult *res, GError **error); static gboolean g_file_real_set_attributes_from_info (GFile *file, - GFileInfo *info, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error); + GFileInfo *info, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error); static void g_file_real_set_display_name_async (GFile *file, - const char *display_name, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + const char *display_name, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GFile * g_file_real_set_display_name_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_set_attributes_async (GFile *file, - GFileInfo *info, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + GFileInfo *info, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static gboolean g_file_real_set_attributes_finish (GFile *file, - GAsyncResult *res, - GFileInfo **info, - GError **error); + GAsyncResult *res, + GFileInfo **info, + GError **error); static void g_file_real_find_enclosing_mount_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data); + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data); static GMount * g_file_real_find_enclosing_mount_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); static void g_file_real_copy_async (GFile *source, - GFile *destination, - GFileCopyFlags flags, - int io_priority, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GAsyncReadyCallback callback, - gpointer user_data); + GFile *destination, + GFileCopyFlags flags, + int io_priority, + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GAsyncReadyCallback callback, + gpointer user_data); static gboolean g_file_real_copy_finish (GFile *file, - GAsyncResult *res, - GError **error); + GAsyncResult *res, + GError **error); typedef GFileIface GFileInterface; G_DEFINE_INTERFACE (GFile, g_file, G_TYPE_OBJECT) @@ -320,7 +327,7 @@ g_file_default_init (GFileIface *iface) /** * g_file_is_native: - * @file: input #GFile. + * @file: input #GFile * * Checks to see if a file is native to the platform. * @@ -328,15 +335,14 @@ g_file_default_init (GFileIface *iface) * e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local, * as it might be on a locally mounted remote filesystem. * - * On some systems non-native files may be available using - * the native filesystem via a userspace filesystem (FUSE), in - * these cases this call will return %FALSE, but g_file_get_path() - * will still return a native path. + * On some systems non-native files may be available using the native + * filesystem via a userspace filesystem (FUSE), in these cases this call + * will return %FALSE, but g_file_get_path() will still return a native path. * - * This call does no blocking i/o. - * - * Returns: %TRUE if file is native. - **/ + * This call does no blocking I/O. + * + * Returns: %TRUE if @file is native + */ gboolean g_file_is_native (GFile *file) { @@ -351,24 +357,24 @@ g_file_is_native (GFile *file) /** - * g_file_has_uri_scheme: - * @file: input #GFile. - * @uri_scheme: a string containing a URI scheme. + * g_file_has_uri_scheme: + * @file: input #GFile + * @uri_scheme: a string containing a URI scheme * * Checks to see if a #GFile has a given URI scheme. * - * This call does no blocking i/o. - * + * This call does no blocking I/O. + * * Returns: %TRUE if #GFile's backend supports the * given URI scheme, %FALSE if URI scheme is %NULL, * not supported, or #GFile is invalid. - **/ + */ gboolean g_file_has_uri_scheme (GFile *file, - const char *uri_scheme) + const char *uri_scheme) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (uri_scheme != NULL, FALSE); @@ -380,21 +386,21 @@ g_file_has_uri_scheme (GFile *file, /** * g_file_get_uri_scheme: - * @file: input #GFile. + * @file: input #GFile * * Gets the URI scheme for a #GFile. * RFC 3986 decodes the scheme as: * - * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] + * URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ] * - * Common schemes include "file", "http", "ftp", etc. + * Common schemes include "file", "http", "ftp", etc. * - * This call does no blocking i/o. - * - * Returns: a string containing the URI scheme for the given - * #GFile. The returned string should be freed with g_free() + * This call does no blocking I/O. + * + * Returns: a string containing the URI scheme for the given + * #GFile. The returned string should be freed with g_free() * when no longer needed. - **/ + */ char * g_file_get_uri_scheme (GFile *file) { @@ -410,7 +416,7 @@ g_file_get_uri_scheme (GFile *file) /** * g_file_get_basename: - * @file: input #GFile. + * @file: input #GFile * * Gets the base name (the last component of the path) for a given #GFile. * @@ -418,23 +424,23 @@ g_file_get_uri_scheme (GFile *file) * or a uri like sftp://host/) it will return a single directory separator * (and on Windows, possibly a drive letter). * - * The base name is a byte string (*not* UTF-8). It has no defined encoding + * The base name is a byte string (not UTF-8). It has no defined encoding * or rules other than it may not contain zero bytes. If you want to use * filenames in a user interface you should use the display name that you * can get by requesting the %G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME * attribute with g_file_query_info(). - * - * This call does no blocking i/o. - * - * Returns: string containing the #GFile's base name, or %NULL - * if given #GFile is invalid. The returned string should be + * + * This call does no blocking I/O. + * + * Returns: string containing the #GFile's base name, or %NULL + * if given #GFile is invalid. The returned string should be * freed with g_free() when no longer needed. - **/ + */ char * g_file_get_basename (GFile *file) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); iface = G_FILE_GET_IFACE (file); @@ -444,16 +450,16 @@ g_file_get_basename (GFile *file) /** * g_file_get_path: - * @file: input #GFile. + * @file: input #GFile * - * Gets the local pathname for #GFile, if one exists. + * Gets the local pathname for #GFile, if one exists. * - * This call does no blocking i/o. - * - * Returns: string containing the #GFile's path, or %NULL if - * no such path exists. The returned string should be + * This call does no blocking I/O. + * + * Returns: string containing the #GFile's path, or %NULL if + * no such path exists. The returned string should be * freed with g_free() when no longer needed. - **/ + */ char * g_file_get_path (GFile *file) { @@ -468,20 +474,21 @@ g_file_get_path (GFile *file) /** * g_file_get_uri: - * @file: input #GFile. + * @file: input #GFile * * Gets the URI for the @file. * - * This call does no blocking i/o. - * + * This call does no blocking I/O. + * * Returns: a string containing the #GFile's URI. - * The returned string should be freed with g_free() when no longer needed. - **/ + * The returned string should be freed with g_free() + * when no longer needed. + */ char * g_file_get_uri (GFile *file) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); iface = G_FILE_GET_IFACE (file); @@ -491,7 +498,7 @@ g_file_get_uri (GFile *file) /** * g_file_get_parse_name: - * @file: input #GFile. + * @file: input #GFile * * Gets the parse name of the @file. * A parse name is a UTF-8 string that describes the @@ -503,19 +510,20 @@ g_file_get_uri (GFile *file) * like in a location entry. * * For local files with names that can safely be converted - * to UTF8 the pathname is used, otherwise the IRI is used - * (a form of URI that allows UTF8 characters unescaped). + * to UTF-8 the pathname is used, otherwise the IRI is used + * (a form of URI that allows UTF-8 characters unescaped). * - * This call does no blocking i/o. - * - * Returns: a string containing the #GFile's parse name. The returned - * string should be freed with g_free() when no longer needed. - **/ + * This call does no blocking I/O. + * + * Returns: a string containing the #GFile's parse name. + * The returned string should be freed with g_free() + * when no longer needed. + */ char * g_file_get_parse_name (GFile *file) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); iface = G_FILE_GET_IFACE (file); @@ -525,21 +533,22 @@ g_file_get_parse_name (GFile *file) /** * g_file_dup: - * @file: input #GFile. + * @file: input #GFile * - * Duplicates a #GFile handle. This operation does not duplicate - * the actual file or directory represented by the #GFile; see - * g_file_copy() if attempting to copy a file. + * Duplicates a #GFile handle. This operation does not duplicate + * the actual file or directory represented by the #GFile; see + * g_file_copy() if attempting to copy a file. * - * This call does no blocking i/o. - * - * Returns: (transfer full): a new #GFile that is a duplicate of the given #GFile. - **/ + * This call does no blocking I/O. + * + * Returns: (transfer full): a new #GFile that is a duplicate + * of the given #GFile. + */ GFile * g_file_dup (GFile *file) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); iface = G_FILE_GET_IFACE (file); @@ -549,23 +558,23 @@ g_file_dup (GFile *file) /** * g_file_hash: - * @file: (type GFile): #gconstpointer to a #GFile. + * @file: (type GFile): #gconstpointer to a #GFile * * Creates a hash value for a #GFile. * - * This call does no blocking i/o. + * This call does no blocking I/O. * * Virtual: hash - * Returns: 0 if @file is not a valid #GFile, otherwise an - * integer that can be used as hash value for the #GFile. - * This function is intended for easily hashing a #GFile to + * Returns: 0 if @file is not a valid #GFile, otherwise an + * integer that can be used as hash value for the #GFile. + * This function is intended for easily hashing a #GFile to * add to a #GHashTable or similar data structure. - **/ + */ guint g_file_hash (gconstpointer file) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), 0); iface = G_FILE_GET_IFACE (file); @@ -575,56 +584,57 @@ g_file_hash (gconstpointer file) /** * g_file_equal: - * @file1: the first #GFile. - * @file2: the second #GFile. + * @file1: the first #GFile + * @file2: the second #GFile * - * Checks equality of two given #GFiles. Note that two - * #GFiles that differ can still refer to the same + * Checks equality of two given #GFiles. + * + * Note that two #GFiles that differ can still refer to the same * file on the filesystem due to various forms of filename * aliasing. * - * This call does no blocking i/o. - * + * This call does no blocking I/O. + * * Returns: %TRUE if @file1 and @file2 are equal. * %FALSE if either is not a #GFile. - **/ + */ gboolean g_file_equal (GFile *file1, - GFile *file2) + GFile *file2) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file1), FALSE); g_return_val_if_fail (G_IS_FILE (file2), FALSE); - + if (G_TYPE_FROM_INSTANCE (file1) != G_TYPE_FROM_INSTANCE (file2)) return FALSE; iface = G_FILE_GET_IFACE (file1); - + return (* iface->equal) (file1, file2); } /** * g_file_get_parent: - * @file: input #GFile. + * @file: input #GFile * - * Gets the parent directory for the @file. - * If the @file represents the root directory of the + * Gets the parent directory for the @file. + * If the @file represents the root directory of the * file system, then %NULL will be returned. * - * This call does no blocking i/o. - * - * Returns: (transfer full): a #GFile structure to the parent of the given - * #GFile or %NULL if there is no parent. - * Free the returned object with g_object_unref(). - **/ + * This call does no blocking I/O. + * + * Returns: (transfer full): a #GFile structure to the + * parent of the given #GFile or %NULL if there is + * no parent. Free the returned object with g_object_unref(). + */ GFile * g_file_get_parent (GFile *file) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); iface = G_FILE_GET_IFACE (file); @@ -647,7 +657,7 @@ g_file_get_parent (GFile *file) * case that @parent is %NULL). * * Since: 2.24 - **/ + */ gboolean g_file_has_parent (GFile *file, GFile *parent) @@ -677,8 +687,8 @@ g_file_has_parent (GFile *file, /** * g_file_get_child: - * @file: input #GFile. - * @name: string containing the child's basename. + * @file: input #GFile + * @name: string containing the child's basename * * Gets a child of @file with basename equal to @name. * @@ -686,14 +696,14 @@ g_file_has_parent (GFile *file, * you can still have a #GFile that points to it. You can use this * for instance to create that file. * - * This call does no blocking i/o. - * + * This call does no blocking I/O. + * * Returns: (transfer full): a #GFile to a child specified by @name. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_get_child (GFile *file, - const char *name) + const char *name) { g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (name != NULL, NULL); @@ -703,29 +713,30 @@ g_file_get_child (GFile *file, /** * g_file_get_child_for_display_name: - * @file: input #GFile. - * @display_name: string to a possible child. - * @error: #GError. + * @file: input #GFile + * @display_name: string to a possible child + * @error: return location for an error * - * Gets the child of @file for a given @display_name (i.e. a UTF8 - * version of the name). If this function fails, it returns %NULL and @error will be - * set. This is very useful when constructing a GFile for a new file - * and the user entered the filename in the user interface, for instance - * when you select a directory and type a filename in the file selector. - * - * This call does no blocking i/o. - * - * Returns: (transfer full): a #GFile to the specified child, or - * %NULL if the display name couldn't be converted. + * Gets the child of @file for a given @display_name (i.e. a UTF-8 + * version of the name). If this function fails, it returns %NULL + * and @error will be set. This is very useful when constructing a + * #GFile for a new file and the user entered the filename in the + * user interface, for instance when you select a directory and + * type a filename in the file selector. + * + * This call does no blocking I/O. + * + * Returns: (transfer full): a #GFile to the specified child, or + * %NULL if the display name couldn't be converted. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_get_child_for_display_name (GFile *file, - const char *display_name, - GError **error) + const char *display_name, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (display_name != NULL, NULL); @@ -736,67 +747,71 @@ g_file_get_child_for_display_name (GFile *file, /** * g_file_has_prefix: - * @file: input #GFile. - * @prefix: input #GFile. - * - * Checks whether @file has the prefix specified by @prefix. In other word, - * if the names of initial elements of @files pathname match @prefix. - * Only full pathname elements are matched, so a path like /foo is not - * considered a prefix of /foobar, only of /foo/bar. - * - * This call does no i/o, as it works purely on names. As such it can - * sometimes return %FALSE even if @file is inside a @prefix (from a - * filesystem point of view), because the prefix of @file is an alias + * @file: input #GFile + * @prefix: input #GFile + * + * Checks whether @file has the prefix specified by @prefix. + * + * In other words, if the names of initial elements of @file's + * pathname match @prefix. Only full pathname elements are matched, + * so a path like /foo is not considered a prefix of /foobar, only + * of /foo/bar. + * + * This call does no I/O, as it works purely on names. As such it can + * sometimes return %FALSE even if @file is inside a @prefix (from a + * filesystem point of view), because the prefix of @file is an alias * of @prefix. * * Virtual: prefix_matches - * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix. + * Returns: %TRUE if the @files's parent, grandparent, etc is @prefix, * %FALSE otherwise. - **/ + */ gboolean g_file_has_prefix (GFile *file, - GFile *prefix) + GFile *prefix) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (G_IS_FILE (prefix), FALSE); if (G_TYPE_FROM_INSTANCE (file) != G_TYPE_FROM_INSTANCE (prefix)) return FALSE; - + iface = G_FILE_GET_IFACE (file); - /* The vtable function differs in arg order since we're - using the old contains_file call */ + /* The vtable function differs in arg order since + * we're using the old contains_file call + */ return (* iface->prefix_matches) (prefix, file); } /** * g_file_get_relative_path: - * @parent: input #GFile. - * @descendant: input #GFile. + * @parent: input #GFile + * @descendant: input #GFile * - * Gets the path for @descendant relative to @parent. + * Gets the path for @descendant relative to @parent. * - * This call does no blocking i/o. - * - * Returns: string with the relative path from @descendant - * to @parent, or %NULL if @descendant doesn't have @parent as prefix. - * The returned string should be freed with g_free() when no longer needed. - **/ + * This call does no blocking I/O. + * + * Returns: string with the relative path from @descendant + * to @parent, or %NULL if @descendant doesn't have @parent + * as prefix. The returned string should be freed with g_free() + * when no longer needed. + */ char * g_file_get_relative_path (GFile *parent, - GFile *descendant) + GFile *descendant) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (parent), NULL); g_return_val_if_fail (G_IS_FILE (descendant), NULL); if (G_TYPE_FROM_INSTANCE (parent) != G_TYPE_FROM_INSTANCE (descendant)) return NULL; - + iface = G_FILE_GET_IFACE (parent); return (* iface->get_relative_path) (parent, descendant); @@ -804,20 +819,20 @@ g_file_get_relative_path (GFile *parent, /** * g_file_resolve_relative_path: - * @file: input #GFile. - * @relative_path: a given relative path string. + * @file: input #GFile + * @relative_path: a given relative path string * * Resolves a relative path for @file to an absolute path. * - * This call does no blocking i/o. - * - * Returns: (transfer full): #GFile to the resolved path. %NULL if @relative_path - * is %NULL or if @file is invalid. + * This call does no blocking I/O. + * + * Returns: (transfer full): #GFile to the resolved path. + * %NULL if @relative_path is %NULL or if @file is invalid. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_resolve_relative_path (GFile *file, - const char *relative_path) + const char *relative_path) { GFileIface *iface; @@ -831,50 +846,54 @@ g_file_resolve_relative_path (GFile *file, /** * g_file_enumerate_children: - * @file: input #GFile. - * @attributes: an attribute query string. - * @flags: a set of #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: #GError for error reporting. + * @file: input #GFile + * @attributes: an attribute query string + * @flags: a set of #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: #GError for error reporting * - * Gets the requested information about the files in a directory. The result - * is a #GFileEnumerator object that will give out #GFileInfo objects for - * all the files in the directory. + * Gets the requested information about the files in a directory. + * The result is a #GFileEnumerator object that will give out + * #GFileInfo objects for all the files in the directory. * - * The @attributes value is a string that specifies the file attributes that - * should be gathered. It is not an error if it's not possible to read a particular - * requested attribute from a file - it just won't be set. @attributes should - * be a comma-separated list of attributes or attribute wildcards. The wildcard "*" - * means all attributes, and a wildcard like "standard::*" means all attributes in the standard - * namespace. An example attribute query be "standard::*,owner::user". - * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME. + * The @attributes value is a string that specifies the file + * attributes that should be gathered. It is not an error if + * it's not possible to read a particular requested attribute + * from a file - it just won't be set. @attributes should + * be a comma-separated list of attributes or attribute wildcards. + * The wildcard "*" means all attributes, and a wildcard like + * "standard::*" means all attributes in the standard namespace. + * An example attribute query be "standard::*,owner::user". + * The standard attributes are available as defines, like + * #G_FILE_ATTRIBUTE_STANDARD_NAME. * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. - * If the file is not a directory, the G_FILE_ERROR_NOTDIR error will be returned. - * Other errors are possible too. + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. * - * Returns: (transfer full): A #GFileEnumerator if successful, %NULL on error. - * Free the returned object with g_object_unref(). - **/ + * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will + * be returned. If the file is not a directory, the %G_FILE_ERROR_NOTDIR + * error will be returned. Other errors are possible too. + * + * Returns: (transfer full): A #GFileEnumerator if successful, + * %NULL on error. Free the returned object with g_object_unref(). + */ GFileEnumerator * g_file_enumerate_children (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) - + const char *attributes, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->enumerate_children == NULL) @@ -886,39 +905,41 @@ g_file_enumerate_children (GFile *file, } return (* iface->enumerate_children) (file, attributes, flags, - cancellable, error); + cancellable, error); } /** * g_file_enumerate_children_async: - * @file: input #GFile. - * @attributes: an attribute query string. - * @flags: a set of #GFileQueryInfoFlags. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async) : a #GAsyncReadyCallback to call when the + * @file: input #GFile + * @attributes: an attribute query string + * @flags: a set of #GFileQueryInfoFlags + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call when the * request is satisfied * @user_data: (closure): the data to pass to callback function * - * Asynchronously gets the requested information about the files in a directory. The result - * is a #GFileEnumerator object that will give out #GFileInfo objects for - * all the files in the directory. + * Asynchronously gets the requested information about the files + * in a directory. The result is a #GFileEnumerator object that will + * give out #GFileInfo objects for all the files in the directory. * * For more details, see g_file_enumerate_children() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_enumerate_children_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. You can + * then call g_file_enumerate_children_finish() to get the result of + * the operation. + */ void g_file_enumerate_children_async (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *attributes, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -926,47 +947,49 @@ g_file_enumerate_children_async (GFile *file, iface = G_FILE_GET_IFACE (file); (* iface->enumerate_children_async) (file, - attributes, - flags, - io_priority, - cancellable, - callback, - user_data); + attributes, + flags, + io_priority, + cancellable, + callback, + user_data); } /** * g_file_enumerate_children_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. - * @error: a #GError. - * + * @file: input #GFile + * @res: a #GAsyncResult + * @error: a #GError + * * Finishes an async enumerate children operation. * See g_file_enumerate_children_async(). * - * Returns: (transfer full): a #GFileEnumerator or %NULL if an error occurred. + * Returns: (transfer full): a #GFileEnumerator or %NULL + * if an error occurred. * Free the returned object with g_object_unref(). - **/ + */ GFileEnumerator * g_file_enumerate_children_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->enumerate_children_finish) (file, res, error); } /** * g_file_query_exists: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * * Utility function to check if a particular file exists. This is * implemented using g_file_query_info() and as such does blocking I/O. @@ -977,69 +1000,71 @@ g_file_enumerate_children_finish (GFile *file, * general approach to handling that is to not check, but just do the * operation and handle the errors as they come. * - * As an example of race-free checking, take the case of reading a file, and - * if it doesn't exist, creating it. There are two racy versions: read it, and - * on error create it; and: check if it exists, if not create it. These - * can both result in two processes creating the file (with perhaps a partially - * written file as the result). The correct approach is to always try to create - * the file with g_file_create() which will either atomically create the file - * or fail with a G_IO_ERROR_EXISTS error. + * As an example of race-free checking, take the case of reading a file, + * and if it doesn't exist, creating it. There are two racy versions: read + * it, and on error create it; and: check if it exists, if not create it. + * These can both result in two processes creating the file (with perhaps + * a partially written file as the result). The correct approach is to + * always try to create the file with g_file_create() which will either + * atomically create the file or fail with a %G_IO_ERROR_EXISTS error. * - * However, in many cases an existence check is useful in a user - * interface, for instance to make a menu item sensitive/insensitive, so that - * you don't have to fool users that something is possible and then just show - * and error dialog. If you do this, you should make sure to also handle the - * errors that can happen due to races when you execute the operation. - * - * Returns: %TRUE if the file exists (and can be detected without error), %FALSE otherwise (or if cancelled). + * However, in many cases an existence check is useful in a user interface, + * for instance to make a menu item sensitive/insensitive, so that you don't + * have to fool users that something is possible and then just show an error + * dialog. If you do this, you should make sure to also handle the errors + * that can happen due to races when you execute the operation. + * + * Returns: %TRUE if the file exists (and can be detected without error), + * %FALSE otherwise (or if cancelled). */ gboolean -g_file_query_exists (GFile *file, - GCancellable *cancellable) +g_file_query_exists (GFile *file, + GCancellable *cancellable) { GFileInfo *info; - + g_return_val_if_fail (G_IS_FILE(file), FALSE); - + info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, - G_FILE_QUERY_INFO_NONE, cancellable, NULL); + G_FILE_QUERY_INFO_NONE, cancellable, NULL); if (info != NULL) { g_object_unref (info); return TRUE; } - + return FALSE; } /** * g_file_query_file_type: - * @file: input #GFile. - * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info(). - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @flags: a set of #GFileQueryInfoFlags passed to g_file_query_info() + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * * Utility function to inspect the #GFileType of a file. This is * implemented using g_file_query_info() and as such does blocking I/O. * - * The primary use case of this method is to check if a file is a regular file, - * directory, or symlink. - * - * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN if the file - * does not exist + * The primary use case of this method is to check if a file is + * a regular file, directory, or symlink. + * + * Returns: The #GFileType of the file and #G_FILE_TYPE_UNKNOWN + * if the file does not exist * * Since: 2.18 */ GFileType -g_file_query_file_type (GFile *file, - GFileQueryInfoFlags flags, - GCancellable *cancellable) +g_file_query_file_type (GFile *file, + GFileQueryInfoFlags flags, + GCancellable *cancellable) { GFileInfo *info; GFileType file_type; - + g_return_val_if_fail (G_IS_FILE(file), G_FILE_TYPE_UNKNOWN); info = g_file_query_info (file, G_FILE_ATTRIBUTE_STANDARD_TYPE, flags, - cancellable, NULL); + cancellable, NULL); if (info != NULL) { file_type = g_file_info_get_file_type (info); @@ -1047,61 +1072,67 @@ g_file_query_file_type (GFile *file, } else file_type = G_FILE_TYPE_UNKNOWN; - + return file_type; } /** * g_file_query_info: - * @file: input #GFile. - * @attributes: an attribute query string. - * @flags: a set of #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError. + * @file: input #GFile + * @attributes: an attribute query string + * @flags: a set of #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError * - * Gets the requested information about specified @file. The result - * is a #GFileInfo object that contains key-value attributes (such as - * the type or size of the file). + * Gets the requested information about specified @file. + * The result is a #GFileInfo object that contains key-value + * attributes (such as the type or size of the file). * - * The @attributes value is a string that specifies the file attributes that - * should be gathered. It is not an error if it's not possible to read a particular - * requested attribute from a file - it just won't be set. @attributes should - * be a comma-separated list of attributes or attribute wildcards. The wildcard "*" - * means all attributes, and a wildcard like "standard::*" means all attributes in the standard - * namespace. An example attribute query be "standard::*,owner::user". - * The standard attributes are available as defines, like #G_FILE_ATTRIBUTE_STANDARD_NAME. - * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * The @attributes value is a string that specifies the file + * attributes that should be gathered. It is not an error if + * it's not possible to read a particular requested attribute + * from a file - it just won't be set. @attributes should be a + * comma-separated list of attributes or attribute wildcards. + * The wildcard "*" means all attributes, and a wildcard like + * "standard::*" means all attributes in the standard namespace. + * An example attribute query be "standard::*,owner::user". + * The standard attributes are available as defines, like + * #G_FILE_ATTRIBUTE_STANDARD_NAME. + * + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. * * For symlinks, normally the information about the target of the - * symlink is returned, rather than information about the symlink itself. - * However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS in @flags the - * information about the symlink itself will be returned. Also, for symlinks - * that point to non-existing files the information about the symlink itself - * will be returned. + * symlink is returned, rather than information about the symlink + * itself. However if you pass #G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS + * in @flags the information about the symlink itself will be returned. + * Also, for symlinks that point to non-existing files the information + * about the symlink itself will be returned. * - * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. - * Other errors are possible too, and depend on what kind of filesystem the file is on. + * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be + * returned. Other errors are possible too, and depend on what kind of + * filesystem the file is on. * - * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL on error. - * Free the returned object with g_object_unref(). - **/ + * Returns: (transfer full): a #GFileInfo for the given @file, or %NULL + * on error. Free the returned object with g_object_unref(). + */ GFileInfo * g_file_query_info (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const char *attributes, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->query_info == NULL) @@ -1111,70 +1142,73 @@ g_file_query_info (GFile *file, _("Operation not supported")); return NULL; } - + return (* iface->query_info) (file, attributes, flags, cancellable, error); } /** * g_file_query_info_async: - * @file: input #GFile. - * @attributes: an attribute query string. - * @flags: a set of #GFileQueryInfoFlags. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @file: input #GFile + * @attributes: an attribute query string + * @flags: a set of #GFileQueryInfoFlags + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call when the + * request is satisfied * @user_data: (closure): the data to pass to callback function - * - * Asynchronously gets the requested information about specified @file. The result - * is a #GFileInfo object that contains key-value attributes (such as type or size - * for the file). - * - * For more details, see g_file_query_info() which is - * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_query_info_finish() to get the result of the operation. - **/ + * Asynchronously gets the requested information about specified @file. + * The result is a #GFileInfo object that contains key-value attributes + * (such as type or size for the file). + * + * For more details, see g_file_query_info() which is the synchronous + * version of this call. + * + * When the operation is finished, @callback will be called. You can + * then call g_file_query_info_finish() to get the result of the operation. + */ void g_file_query_info_async (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *attributes, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); (* iface->query_info_async) (file, - attributes, - flags, - io_priority, - cancellable, - callback, - user_data); + attributes, + flags, + io_priority, + cancellable, + callback, + user_data); } /** * g_file_query_info_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. - * @error: a #GError. - * - * Finishes an asynchronous file info query. + * @file: input #GFile + * @res: a #GAsyncResult + * @error: a #GError + * + * Finishes an asynchronous file info query. * See g_file_query_info_async(). - * - * Returns: (transfer full): #GFileInfo for given @file or %NULL on error. - * Free the returned object with g_object_unref(). - **/ + * + * Returns: (transfer full): #GFileInfo for given @file + * or %NULL on error. Free the returned object with + * g_object_unref(). + */ GFileInfo * g_file_query_info_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; @@ -1183,56 +1217,61 @@ g_file_query_info_finish (GFile *file, if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->query_info_finish) (file, res, error); } /** * g_file_query_filesystem_info: - * @file: input #GFile. - * @attributes: an attribute query string. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError. - * + * @file: input #GFile + * @attributes: an attribute query string + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError + * * Similar to g_file_query_info(), but obtains information * about the filesystem the @file is on, rather than the file itself. * For instance the amount of space available and the type of * the filesystem. * - * The @attributes value is a string that specifies the file attributes that - * should be gathered. It is not an error if it's not possible to read a particular - * requested attribute from a file - it just won't be set. @attributes should - * be a comma-separated list of attributes or attribute wildcards. The wildcard "*" - * means all attributes, and a wildcard like "filesystem::*" means all attributes in the - * filesystem namespace. The standard namespace for filesystem attributes is "filesystem". - * Common attributes of interest are #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE - * (the total size of the filesystem in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of - * bytes available), and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). - * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * The @attributes value is a string that specifies the attributes + * that should be gathered. It is not an error if it's not possible + * to read a particular requested attribute from a file - it just + * won't be set. @attributes should be a comma-separated list of + * attributes or attribute wildcards. The wildcard "*" means all + * attributes, and a wildcard like "filesystem::*" means all attributes + * in the filesystem namespace. The standard namespace for filesystem + * attributes is "filesystem". Common attributes of interest are + * #G_FILE_ATTRIBUTE_FILESYSTEM_SIZE (the total size of the filesystem + * in bytes), #G_FILE_ATTRIBUTE_FILESYSTEM_FREE (number of bytes available), + * and #G_FILE_ATTRIBUTE_FILESYSTEM_TYPE (type of the filesystem). * - * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. - * Other errors are possible too, and depend on what kind of filesystem the file is on. + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. + * + * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will + * be returned. Other errors are possible too, and depend on what + * kind of filesystem the file is on. * * Returns: (transfer full): a #GFileInfo or %NULL if there was an error. * Free the returned object with g_object_unref(). - **/ + */ GFileInfo * g_file_query_filesystem_info (GFile *file, - const char *attributes, - GCancellable *cancellable, - GError **error) + const char *attributes, + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->query_filesystem_info == NULL) @@ -1242,32 +1281,34 @@ g_file_query_filesystem_info (GFile *file, _("Operation not supported")); return NULL; } - + return (* iface->query_filesystem_info) (file, attributes, cancellable, error); } /** * g_file_query_filesystem_info_async: - * @file: input #GFile. - * @attributes: an attribute query string. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @file: input #GFile + * @attributes: an attribute query string + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function - * + * * Asynchronously gets the requested information about the filesystem * that the specified @file is on. The result is a #GFileInfo object * that contains key-value attributes (such as type or size for the * file). - * + * * For more details, see g_file_query_filesystem_info() which is the * synchronous version of this call. * * When the operation is finished, @callback will be called. You can * then call g_file_query_info_finish() to get the result of the * operation. - **/ + */ void g_file_query_filesystem_info_async (GFile *file, const char *attributes, @@ -1277,7 +1318,7 @@ g_file_query_filesystem_info_async (GFile *file, gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); @@ -1291,16 +1332,17 @@ g_file_query_filesystem_info_async (GFile *file, /** * g_file_query_filesystem_info_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. - * @error: a #GError. - * - * Finishes an asynchronous filesystem info query. See - * g_file_query_filesystem_info_async(). - * - * Returns: (transfer full): #GFileInfo for given @file or %NULL on error. + * @file: input #GFile + * @res: a #GAsyncResult + * @error: a #GError + * + * Finishes an asynchronous filesystem info query. + * See g_file_query_filesystem_info_async(). + * + * Returns: (transfer full): #GFileInfo for given @file + * or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileInfo * g_file_query_filesystem_info_finish (GFile *file, GAsyncResult *res, @@ -1313,34 +1355,36 @@ g_file_query_filesystem_info_finish (GFile *file, if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->query_filesystem_info_finish) (file, res, error); } /** * g_file_find_enclosing_mount: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError. + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError * - * Gets a #GMount for the #GFile. + * Gets a #GMount for the #GFile. + * + * If the #GFileIface for @file does not have a mount (e.g. + * possibly a remote share), @error will be set to %G_IO_ERROR_NOT_FOUND + * and %NULL will be returned. * - * If the #GFileIface for @file does not have a mount (e.g. possibly a - * remote share), @error will be set to %G_IO_ERROR_NOT_FOUND and %NULL - * will be returned. - * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: (transfer full): a #GMount where the @file is located or %NULL on error. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: (transfer full): a #GMount where the @file is located + * or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GMount * g_file_find_enclosing_mount (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -1354,9 +1398,11 @@ g_file_find_enclosing_mount (GFile *file, { g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND, - /* Translators: This is an error message when trying to find the - * enclosing (user visible) mount of a file, but none exists. */ - _("Containing mount does not exist")); + /* Translators: This is an error message when + * trying to find the enclosing (user visible) + * mount of a file, but none exists. + */ + _("Containing mount does not exist")); return NULL; } @@ -1366,10 +1412,12 @@ g_file_find_enclosing_mount (GFile *file, /** * g_file_find_enclosing_mount_async: * @file: a #GFile - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function * * Asynchronously gets the mount for the file. @@ -1377,15 +1425,16 @@ g_file_find_enclosing_mount (GFile *file, * For more details, see g_file_find_enclosing_mount() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_find_enclosing_mount_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_find_enclosing_mount_finish() to + * get the result of the operation. */ void g_file_find_enclosing_mount_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -1393,10 +1442,10 @@ g_file_find_enclosing_mount_async (GFile *file, iface = G_FILE_GET_IFACE (file); (* iface->find_enclosing_mount_async) (file, - io_priority, - cancellable, - callback, - user_data); + io_priority, + cancellable, + callback, + user_data); } /** @@ -1404,26 +1453,26 @@ g_file_find_enclosing_mount_async (GFile *file, * @file: a #GFile * @res: a #GAsyncResult * @error: a #GError - * - * Finishes an asynchronous find mount request. + * + * Finishes an asynchronous find mount request. * See g_file_find_enclosing_mount_async(). - * + * * Returns: (transfer full): #GMount for given @file or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GMount * g_file_find_enclosing_mount_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->find_enclosing_mount_finish) (file, res, error); } @@ -1431,7 +1480,7 @@ g_file_find_enclosing_mount_finish (GFile *file, /** * g_file_read: - * @file: #GFile to read. + * @file: #GFile to read * @cancellable: (allow-none): a #GCancellable * @error: a #GError, or %NULL * @@ -1440,23 +1489,24 @@ g_file_find_enclosing_mount_finish (GFile *file, * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. - * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned. - * Other errors are possible too, and depend on what kind of filesystem the file is on. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will be + * returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY + * error will be returned. Other errors are possible too, and depend + * on what kind of filesystem the file is on. * * Virtual: read_fn * Returns: (transfer full): #GFileInputStream or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileInputStream * g_file_read (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) @@ -1471,43 +1521,44 @@ g_file_read (GFile *file, _("Operation not supported")); return NULL; } - + return (* iface->read_fn) (file, cancellable, error); } /** * g_file_append_to: - * @file: input #GFile. - * @flags: a set of #GFileCreateFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @flags: a set of #GFileCreateFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL * - * Gets an output stream for appending data to the file. If - * the file doesn't already exist it is created. + * Gets an output stream for appending data to the file. + * If the file doesn't already exist it is created. * * By default files created are generally readable by everyone, * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. + * + * Some file systems don't allow all file names, and may return an + * %G_IO_ERROR_INVALID_FILENAME error. If the file is a directory the + * %G_IO_ERROR_IS_DIRECTORY error will be returned. Other errors are + * possible too, and depend on what kind of filesystem the file is on. * - * Some file systems don't allow all file names, and may - * return an %G_IO_ERROR_INVALID_FILENAME error. - * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will be - * returned. Other errors are possible too, and depend on what kind of - * filesystem the file is on. - * * Returns: (transfer full): a #GFileOutputStream, or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileOutputStream * g_file_append_to (GFile *file, - GFileCreateFlags flags, - GCancellable *cancellable, - GError **error) + GFileCreateFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -1515,7 +1566,7 @@ g_file_append_to (GFile *file, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->append_to == NULL) @@ -1525,15 +1576,16 @@ g_file_append_to (GFile *file, _("Operation not supported")); return NULL; } - + return (* iface->append_to) (file, flags, cancellable, error); } /** * g_file_create: - * @file: input #GFile. - * @flags: a set of #GFileCreateFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @flags: a set of #GFileCreateFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL * * Creates a new file and returns an output stream for writing to it. @@ -1541,38 +1593,38 @@ g_file_append_to (GFile *file, * * By default files created are generally readable by everyone, * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file - * will be made readable only to the current user, to the level that - * is supported on the target filesystem. + * will be made readable only to the current user, to the level + * that is supported on the target filesystem. * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. * - * If a file or directory with this name already exists the G_IO_ERROR_EXISTS - * error will be returned. - * Some file systems don't allow all file names, and may - * return an G_IO_ERROR_INVALID_FILENAME error, and if the name - * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned. - * Other errors are possible too, and depend on what kind of - * filesystem the file is on. - * - * Returns: (transfer full): a #GFileOutputStream for the newly created file, or - * %NULL on error. + * If a file or directory with this name already exists the + * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't + * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME + * error, and if the name is to long %G_IO_ERROR_FILENAME_TOO_LONG will + * be returned. Other errors are possible too, and depend on what kind + * of filesystem the file is on. + * + * Returns: (transfer full): a #GFileOutputStream for the newly created + * file, or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileOutputStream * g_file_create (GFile *file, - GFileCreateFlags flags, - GCancellable *cancellable, - GError **error) + GFileCreateFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->create == NULL) @@ -1582,18 +1634,19 @@ g_file_create (GFile *file, _("Operation not supported")); return NULL; } - + return (* iface->create) (file, flags, cancellable, error); } /** * g_file_replace: - * @file: input #GFile. - * @etag: (allow-none): an optional entity tag for the - * current #GFile, or #NULL to ignore. - * @make_backup: %TRUE if a backup should be created. - * @flags: a set of #GFileCreateFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @etag: (allow-none): an optional entity tag + * for the current #GFile, or #NULL to ignore + * @make_backup: %TRUE if a backup should be created + * @flags: a set of #GFileCreateFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL * * Returns an output stream for overwriting the file, possibly @@ -1605,49 +1658,49 @@ g_file_create (GFile *file, * existing copy of the file. For instance, for local files it * may write to a temporary file and then atomically rename over * the destination when the stream is closed. - * + * * By default files created are generally readable by everyone, * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file * will be made readable only to the current user, to the level that * is supported on the target filesystem. * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * If you pass in a non-#NULL @etag value, then this value is + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. + * + * If you pass in a non-%NULL @etag value, then this value is * compared to the current entity tag of the file, and if they differ - * an G_IO_ERROR_WRONG_ETAG error is returned. This generally means + * an %G_IO_ERROR_WRONG_ETAG error is returned. This generally means * that the file has been changed since you last read it. You can get * the new etag from g_file_output_stream_get_etag() after you've * finished writing and closed the #GFileOutputStream. When you load * a new file you can use g_file_input_stream_query_info() to get * the etag of the file. - * - * If @make_backup is %TRUE, this function will attempt to make a backup - * of the current file before overwriting it. If this fails a G_IO_ERROR_CANT_CREATE_BACKUP - * error will be returned. If you want to replace anyway, try again with - * @make_backup set to %FALSE. * - * If the file is a directory the G_IO_ERROR_IS_DIRECTORY error will be returned, - * and if the file is some other form of non-regular file then a - * G_IO_ERROR_NOT_REGULAR_FILE error will be returned. - * Some file systems don't allow all file names, and may - * return an G_IO_ERROR_INVALID_FILENAME error, and if the name - * is to long G_IO_ERROR_FILENAME_TOO_LONG will be returned. - * Other errors are possible too, and depend on what kind of - * filesystem the file is on. + * If @make_backup is %TRUE, this function will attempt to make a + * backup of the current file before overwriting it. If this fails + * a %G_IO_ERROR_CANT_CREATE_BACKUP error will be returned. If you + * want to replace anyway, try again with @make_backup set to %FALSE. * - * Returns: (transfer full): a #GFileOutputStream or %NULL on error. + * If the file is a directory the %G_IO_ERROR_IS_DIRECTORY error will + * be returned, and if the file is some other form of non-regular file + * then a %G_IO_ERROR_NOT_REGULAR_FILE error will be returned. Some + * file systems don't allow all file names, and may return an + * %G_IO_ERROR_INVALID_FILENAME error, and if the name is to long + * %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors are + * possible too, and depend on what kind of filesystem the file is on. + * + * Returns: (transfer full): a #GFileOutputStream or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileOutputStream * g_file_replace (GFile *file, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - GCancellable *cancellable, - GError **error) + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -1655,7 +1708,7 @@ g_file_replace (GFile *file, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->replace == NULL) @@ -1665,12 +1718,11 @@ g_file_replace (GFile *file, _("Operation not supported")); return NULL; } - - + /* Handle empty tag string as NULL in consistent way. */ if (etag && *etag == 0) etag = NULL; - + return (* iface->replace) (file, etag, make_backup, flags, cancellable, error); } @@ -1681,28 +1733,31 @@ g_file_replace (GFile *file, * @error: a #GError, or %NULL * * Opens an existing file for reading and writing. The result is - * a #GFileIOStream that can be used to read and write the contents of the file. + * a #GFileIOStream that can be used to read and write the contents + * of the file. * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. * - * If the file does not exist, the G_IO_ERROR_NOT_FOUND error will be returned. - * If the file is a directory, the G_IO_ERROR_IS_DIRECTORY error will be returned. - * Other errors are possible too, and depend on what kind of filesystem the file is on. - * Note that in many non-local file cases read and write streams are not supported, - * so make sure you really need to do read and write streaming, rather than - * just opening for reading or writing. + * If the file does not exist, the %G_IO_ERROR_NOT_FOUND error will + * be returned. If the file is a directory, the %G_IO_ERROR_IS_DIRECTORY + * error will be returned. Other errors are possible too, and depend on + * what kind of filesystem the file is on. Note that in many non-local + * file cases read and write streams are not supported, so make sure you + * really need to do read and write streaming, rather than just opening + * for reading or writing. * * Returns: (transfer full): #GFileIOStream or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 - **/ + */ GFileIOStream * -g_file_open_readwrite (GFile *file, - GCancellable *cancellable, - GError **error) +g_file_open_readwrite (GFile *file, + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -1728,32 +1783,36 @@ g_file_open_readwrite (GFile *file, * g_file_create_readwrite: * @file: a #GFile * @flags: a set of #GFileCreateFlags - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: return location for a #GError, or %NULL * - * Creates a new file and returns a stream for reading and writing to it. - * The file must not already exist. + * Creates a new file and returns a stream for reading and + * writing to it. The file must not already exist. * * By default files created are generally readable by everyone, * but if you pass #G_FILE_CREATE_PRIVATE in @flags the file - * will be made readable only to the current user, to the level that - * is supported on the target filesystem. + * will be made readable only to the current user, to the level + * that is supported on the target filesystem. * - * If @cancellable is not %NULL, then the operation can be cancelled by - * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * If @cancellable is not %NULL, then the operation can be cancelled + * by triggering the cancellable object from another thread. If the + * operation was cancelled, the error %G_IO_ERROR_CANCELLED will be + * returned. * - * If a file or directory with this name already exists the %G_IO_ERROR_EXISTS - * error will be returned. Some file systems don't allow all file names, - * and may return an %G_IO_ERROR_INVALID_FILENAME error, and if the name - * is too long, %G_IO_ERROR_FILENAME_TOO_LONG will be returned. Other errors - * are possible too, and depend on what kind of filesystem the file is on. + * If a file or directory with this name already exists, the + * %G_IO_ERROR_EXISTS error will be returned. Some file systems don't + * allow all file names, and may return an %G_IO_ERROR_INVALID_FILENAME + * error, and if the name is too long, %G_IO_ERROR_FILENAME_TOO_LONG + * will be returned. Other errors are possible too, and depend on what + * kind of filesystem the file is on. * - * Note that in many non-local file cases read and write streams are not - * supported, so make sure you really need to do read and write streaming, - * rather than just opening for reading or writing. + * Note that in many non-local file cases read and write streams are + * not supported, so make sure you really need to do read and write + * streaming, rather than just opening for reading or writing. * - * Returns: (transfer full): a #GFileIOStream for the newly created file, or %NULL on error. + * Returns: (transfer full): a #GFileIOStream for the newly created + * file, or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.22 @@ -1787,19 +1846,20 @@ g_file_create_readwrite (GFile *file, /** * g_file_replace_readwrite: * @file: a #GFile - * @etag: (allow-none): an optional entity tag for the - * current #GFile, or #NULL to ignore + * @etag: (allow-none): an optional entity tag + * for the current #GFile, or #NULL to ignore * @make_backup: %TRUE if a backup should be created * @flags: a set of #GFileCreateFlags - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: return location for a #GError, or %NULL * * Returns an output stream for overwriting the file in readwrite mode, * possibly creating a backup copy of the file first. If the file doesn't * exist, it will be created. * - * For details about the behaviour, see g_file_replace() which does the same - * thing but returns an output stream only. + * For details about the behaviour, see g_file_replace() which does the + * same thing but returns an output stream only. * * Note that in many non-local file cases read and write streams are not * supported, so make sure you really need to do read and write streaming, @@ -1842,9 +1902,11 @@ g_file_replace_readwrite (GFile *file, * g_file_read_async: * @file: input #GFile * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function * * Asynchronously opens @file for reading. @@ -1852,278 +1914,290 @@ g_file_replace_readwrite (GFile *file, * For more details, see g_file_read() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_read_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. + * You can then call g_file_read_finish() to get the result + * of the operation. + */ void g_file_read_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); (* iface->read_async) (file, - io_priority, - cancellable, - callback, - user_data); + io_priority, + cancellable, + callback, + user_data); } /** * g_file_read_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL * - * Finishes an asynchronous file read operation started with - * g_file_read_async(). - * + * Finishes an asynchronous file read operation started with + * g_file_read_async(). + * * Returns: (transfer full): a #GFileInputStream or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileInputStream * g_file_read_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->read_finish) (file, res, error); } /** * g_file_append_to_async: - * @file: input #GFile. - * @flags: a set of #GFileCreateFlags. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @file: input #GFile + * @flags: a set of #GFileCreateFlags + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function - * + * * Asynchronously opens @file for appending. * * For more details, see g_file_append_to() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_append_to_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. + * You can then call g_file_append_to_finish() to get the result + * of the operation. + */ void g_file_append_to_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); (* iface->append_to_async) (file, - flags, - io_priority, - cancellable, - callback, - user_data); + flags, + io_priority, + cancellable, + callback, + user_data); } /** * g_file_append_to_finish: - * @file: input #GFile. + * @file: input #GFile * @res: #GAsyncResult * @error: a #GError, or %NULL - * - * Finishes an asynchronous file append operation started with - * g_file_append_to_async(). - * - * Returns: (transfer full): a valid #GFileOutputStream or %NULL on error. + * + * Finishes an asynchronous file append operation started with + * g_file_append_to_async(). + * + * Returns: (transfer full): a valid #GFileOutputStream + * or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileOutputStream * g_file_append_to_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->append_to_finish) (file, res, error); } /** * g_file_create_async: - * @file: input #GFile. - * @flags: a set of #GFileCreateFlags. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @file: input #GFile + * @flags: a set of #GFileCreateFlags + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function - * - * Asynchronously creates a new file and returns an output stream for writing to it. - * The file must not already exist. + * + * Asynchronously creates a new file and returns an output stream + * for writing to it. The file must not already exist. * * For more details, see g_file_create() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_create_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. + * You can then call g_file_create_finish() to get the result + * of the operation. + */ void g_file_create_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); (* iface->create_async) (file, - flags, - io_priority, - cancellable, - callback, - user_data); + flags, + io_priority, + cancellable, + callback, + user_data); } /** * g_file_create_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL - * - * Finishes an asynchronous file create operation started with - * g_file_create_async(). - * + * + * Finishes an asynchronous file create operation started with + * g_file_create_async(). + * * Returns: (transfer full): a #GFileOutputStream or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileOutputStream * g_file_create_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->create_finish) (file, res, error); } /** * g_file_replace_async: - * @file: input #GFile. - * @etag: (allow-none): an entity tag for the - * current #GFile, or NULL to ignore. - * @make_backup: %TRUE if a backup should be created. - * @flags: a set of #GFileCreateFlags. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @file: input #GFile + * @etag: (allow-none): an entity tag + * for the current #GFile, or NULL to ignore + * @make_backup: %TRUE if a backup should be created + * @flags: a set of #GFileCreateFlags + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function * - * Asynchronously overwrites the file, replacing the contents, possibly - * creating a backup copy of the file first. + * Asynchronously overwrites the file, replacing the contents, + * possibly creating a backup copy of the file first. * * For more details, see g_file_replace() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_replace_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. + * You can then call g_file_replace_finish() to get the result + * of the operation. + */ void g_file_replace_async (GFile *file, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); (* iface->replace_async) (file, - etag, - make_backup, - flags, - io_priority, - cancellable, - callback, - user_data); + etag, + make_backup, + flags, + io_priority, + cancellable, + callback, + user_data); } /** * g_file_replace_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL - * - * Finishes an asynchronous file replace operation started with - * g_file_replace_async(). - * + * + * Finishes an asynchronous file replace operation started with + * g_file_replace_async(). + * * Returns: (transfer full): a #GFileOutputStream, or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFileOutputStream * g_file_replace_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->replace_finish) (file, res, error); } - /** - * g_file_open_readwrite_async: - * @file: input #GFile. + * g_file_open_readwrite_async + * @file: input #GFile * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function * * Asynchronously opens @file for reading and writing. @@ -2131,17 +2205,18 @@ g_file_replace_finish (GFile *file, * For more details, see g_file_open_readwrite() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_open_readwrite_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_open_readwrite_finish() to get + * the result of the operation. * * Since: 2.22 - **/ + */ void -g_file_open_readwrite_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) +g_file_open_readwrite_async (GFile *file, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -2157,8 +2232,8 @@ g_file_open_readwrite_async (GFile *file, /** * g_file_open_readwrite_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes an asynchronous file read operation started with @@ -2168,11 +2243,11 @@ g_file_open_readwrite_async (GFile *file, * Free the returned object with g_object_unref(). * * Since: 2.22 - **/ + */ GFileIOStream * -g_file_open_readwrite_finish (GFile *file, - GAsyncResult *res, - GError **error) +g_file_open_readwrite_finish (GFile *file, + GAsyncResult *res, + GError **error) { GFileIface *iface; @@ -2181,30 +2256,32 @@ g_file_open_readwrite_finish (GFile *file, if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->open_readwrite_finish) (file, res, error); } - /** * g_file_create_readwrite_async: * @file: input #GFile * @flags: a set of #GFileCreateFlags * @io_priority: the I/O priority * of the request - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function * - * Asynchronously creates a new file and returns a stream for reading and - * writing to it. The file must not already exist. + * Asynchronously creates a new file and returns a stream + * for reading and writing to it. The file must not already exist. * * For more details, see g_file_create_readwrite() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then - * call g_file_create_readwrite_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_create_readwrite_finish() to get + * the result of the operation. * * Since: 2.22 */ @@ -2242,7 +2319,7 @@ g_file_create_readwrite_async (GFile *file, * Free the returned object with g_object_unref(). * * Since: 2.22 - **/ + */ GFileIOStream * g_file_create_readwrite_finish (GFile *file, GAsyncResult *res, @@ -2255,32 +2332,36 @@ g_file_create_readwrite_finish (GFile *file, if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->create_readwrite_finish) (file, res, error); } /** * g_file_replace_readwrite_async: - * @file: input #GFile. - * @etag: (allow-none): an entity tag for the - * current #GFile, or NULL to ignore. - * @make_backup: %TRUE if a backup should be created. - * @flags: a set of #GFileCreateFlags. + * @file: input #GFile + * @etag: (allow-none): an entity tag + * for the current #GFile, or NULL to ignore + * @make_backup: %TRUE if a backup should be created + * @flags: a set of #GFileCreateFlags * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function * - * Asynchronously overwrites the file in read-write mode, replacing the - * contents, possibly creating a backup copy of the file first. + * Asynchronously overwrites the file in read-write mode, + * replacing the contents, possibly creating a backup copy + * of the file first. * * For more details, see g_file_replace_readwrite() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then - * call g_file_replace_readwrite_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_replace_readwrite_finish() to get + * the result of the operation. * * Since: 2.22 */ @@ -2311,8 +2392,8 @@ g_file_replace_readwrite_async (GFile *file, /** * g_file_replace_readwrite_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes an asynchronous file replace operation started with @@ -2335,17 +2416,17 @@ g_file_replace_readwrite_finish (GFile *file, if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->replace_readwrite_finish) (file, res, error); } static gboolean copy_symlink (GFile *destination, - GFileCopyFlags flags, - GCancellable *cancellable, - const char *target, - GError **error) + GFileCopyFlags flags, + GCancellable *cancellable, + const char *target, + GError **error) { GError *my_error; gboolean tried_delete; @@ -2359,35 +2440,34 @@ copy_symlink (GFile *destination, if (!g_file_make_symbolic_link (destination, target, cancellable, &my_error)) { /* Maybe it already existed, and we want to overwrite? */ - if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) && - my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS) - { - g_error_free (my_error); + if (!tried_delete && (flags & G_FILE_COPY_OVERWRITE) && + my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_EXISTS) + { + g_error_free (my_error); + /* Don't overwrite if the destination is a directory */ + info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE, + G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, + cancellable, &my_error); + if (info != NULL) + { + file_type = g_file_info_get_file_type (info); + g_object_unref (info); - /* Don't overwrite if the destination is a directory */ - info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE, - G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, - cancellable, &my_error); - if (info != NULL) - { - file_type = g_file_info_get_file_type (info); - g_object_unref (info); - - if (file_type == G_FILE_TYPE_DIRECTORY) - { - g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY, + if (file_type == G_FILE_TYPE_DIRECTORY) + { + g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_IS_DIRECTORY, _("Can't copy over directory")); - return FALSE; - } - } - - if (!g_file_delete (destination, cancellable, error)) - return FALSE; - - tried_delete = TRUE; - goto retry; - } + return FALSE; + } + } + + if (!g_file_delete (destination, cancellable, error)) + return FALSE; + + tried_delete = TRUE; + goto retry; + } /* Nah, fail */ g_propagate_error (error, my_error); return FALSE; @@ -2398,71 +2478,70 @@ copy_symlink (GFile *destination, static GInputStream * open_source_for_copy (GFile *source, - GFile *destination, - GFileCopyFlags flags, - GCancellable *cancellable, - GError **error) + GFile *destination, + GFileCopyFlags flags, + GCancellable *cancellable, + GError **error) { GError *my_error; GInputStream *in; GFileInfo *info; GFileType file_type; - + my_error = NULL; in = (GInputStream *)g_file_read (source, cancellable, &my_error); if (in != NULL) return in; /* There was an error opening the source, try to set a good error for it: */ - if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_IS_DIRECTORY) { - /* The source is a directory, don't fail with WOULD_RECURSE immediately, - * as that is less useful to the app. Better check for errors on the - * target instead. + /* The source is a directory, don't fail with WOULD_RECURSE immediately, + * as that is less useful to the app. Better check for errors on the + * target instead. */ g_error_free (my_error); my_error = NULL; - + info = g_file_query_info (destination, G_FILE_ATTRIBUTE_STANDARD_TYPE, - G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, - cancellable, &my_error); + G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, + cancellable, &my_error); if (info != NULL && g_file_info_has_attribute (info, G_FILE_ATTRIBUTE_STANDARD_TYPE)) - { - file_type = g_file_info_get_file_type (info); - g_object_unref (info); - - if (flags & G_FILE_COPY_OVERWRITE) - { - if (file_type == G_FILE_TYPE_DIRECTORY) - { - g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE, + { + file_type = g_file_info_get_file_type (info); + g_object_unref (info); + + if (flags & G_FILE_COPY_OVERWRITE) + { + if (file_type == G_FILE_TYPE_DIRECTORY) + { + g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_MERGE, _("Can't copy directory over directory")); - return NULL; - } - /* continue to would_recurse error */ - } - else - { - g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS, + return NULL; + } + /* continue to would_recurse error */ + } + else + { + g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_EXISTS, _("Target file exists")); - return NULL; - } - } + return NULL; + } + } else - { - /* Error getting info from target, return that error - * (except for NOT_FOUND, which is no error here) + { + /* Error getting info from target, return that error + * (except for NOT_FOUND, which is no error here) */ - if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND)) - { - g_propagate_error (error, my_error); - return NULL; - } - g_clear_error (&my_error); - } - + if (my_error != NULL && !g_error_matches (my_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND)) + { + g_propagate_error (error, my_error); + return NULL; + } + g_clear_error (&my_error); + } + g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_WOULD_RECURSE, _("Can't recursively copy directory")); return NULL; @@ -2473,7 +2552,7 @@ open_source_for_copy (GFile *source, } static gboolean -should_copy (GFileAttributeInfo *info, +should_copy (GFileAttributeInfo *info, gboolean as_move, gboolean skip_perms) { @@ -2487,48 +2566,48 @@ should_copy (GFileAttributeInfo *info, static char * build_attribute_list_for_copy (GFileAttributeInfoList *attributes, - GFileAttributeInfoList *namespaces, - gboolean as_move, - gboolean skip_perms) + GFileAttributeInfoList *namespaces, + gboolean as_move, + gboolean skip_perms) { GString *s; gboolean first; int i; - + first = TRUE; s = g_string_new (""); if (attributes) { for (i = 0; i < attributes->n_infos; i++) - { - if (should_copy (&attributes->infos[i], as_move, skip_perms)) - { - if (first) - first = FALSE; - else - g_string_append_c (s, ','); - - g_string_append (s, attributes->infos[i].name); - } - } + { + if (should_copy (&attributes->infos[i], as_move, skip_perms)) + { + if (first) + first = FALSE; + else + g_string_append_c (s, ','); + + g_string_append (s, attributes->infos[i].name); + } + } } if (namespaces) { for (i = 0; i < namespaces->n_infos; i++) - { - if (should_copy (&namespaces->infos[i], as_move, FALSE)) - { - if (first) - first = FALSE; - else - g_string_append_c (s, ','); - - g_string_append (s, namespaces->infos[i].name); - g_string_append (s, "::*"); - } - } + { + if (should_copy (&namespaces->infos[i], as_move, FALSE)) + { + if (first) + first = FALSE; + else + g_string_append_c (s, ','); + + g_string_append (s, namespaces->infos[i].name); + g_string_append (s, "::*"); + } + } } return g_string_free (s, FALSE); @@ -2536,13 +2615,14 @@ build_attribute_list_for_copy (GFileAttributeInfoList *attributes, /** * g_file_copy_attributes: - * @source: a #GFile with attributes. - * @destination: a #GFile to copy attributes to. - * @flags: a set of #GFileCopyFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, %NULL to ignore. + * @source: a #GFile with attributes + * @destination: a #GFile to copy attributes to + * @flags: a set of #GFileCopyFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, %NULL to ignore * - * Copies the file attributes from @source to @destination. + * Copies the file attributes from @source to @destination. * * Normally only a subset of the file attributes are copied, * those that are copies in a normal file copy operation @@ -2551,14 +2631,15 @@ build_attribute_list_for_copy (GFileAttributeInfoList *attributes, * all the metadata that is possible to copy is copied. This * is useful when implementing move by copy + delete source. * - * Returns: %TRUE if the attributes were copied successfully, %FALSE otherwise. - **/ + * Returns: %TRUE if the attributes were copied successfully, + * %FALSE otherwise. + */ gboolean g_file_copy_attributes (GFile *source, - GFile *destination, - GFileCopyFlags flags, - GCancellable *cancellable, - GError **error) + GFile *destination, + GFileCopyFlags flags, + GCancellable *cancellable, + GError **error) { GFileAttributeInfoList *attributes, *namespaces; char *attrs_to_read; @@ -2572,7 +2653,9 @@ g_file_copy_attributes (GFile *source, source_nofollow_symlinks = flags & G_FILE_COPY_NOFOLLOW_SYMLINKS; skip_perms = (flags & G_FILE_COPY_TARGET_DEFAULT_PERMS) != 0; - /* Ignore errors here, if the target supports no attributes there is nothing to copy */ + /* Ignore errors here, if the target supports no attributes there is + * nothing to copy + */ attributes = g_file_query_settable_attributes (destination, cancellable, NULL); namespaces = g_file_query_writable_namespaces (destination, cancellable, NULL); @@ -2582,40 +2665,40 @@ g_file_copy_attributes (GFile *source, attrs_to_read = build_attribute_list_for_copy (attributes, namespaces, as_move, skip_perms); /* Ignore errors here, if we can't read some info (e.g. if it doesn't exist) - * we just don't copy it. + * we just don't copy it. */ info = g_file_query_info (source, attrs_to_read, - source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0, - cancellable, - NULL); + source_nofollow_symlinks ? G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS:0, + cancellable, + NULL); g_free (attrs_to_read); - + res = TRUE; if (info) { res = g_file_set_attributes_from_info (destination, - info, - G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, - cancellable, - error); + info, + G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, + cancellable, + error); g_object_unref (info); } - + g_file_attribute_info_list_unref (attributes); g_file_attribute_info_list_unref (namespaces); - + return res; } static gboolean copy_stream_with_progress (GInputStream *in, - GOutputStream *out, + GOutputStream *out, GFile *source, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GError **error) + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GError **error) { gssize n_read, n_written; goffset current_size; @@ -2640,7 +2723,7 @@ copy_stream_with_progress (GInputStream *in, if (total_size == -1) { - info = g_file_query_info (source, + info = g_file_query_info (source, G_FILE_ATTRIBUTE_STANDARD_SIZE, G_FILE_QUERY_INFO_NONE, cancellable, NULL); @@ -2655,42 +2738,42 @@ copy_stream_with_progress (GInputStream *in, if (total_size == -1) total_size = 0; - + current_size = 0; res = TRUE; while (TRUE) { n_read = g_input_stream_read (in, buffer, sizeof (buffer), cancellable, error); if (n_read == -1) - { - res = FALSE; - break; - } - + { + res = FALSE; + break; + } + if (n_read == 0) - break; + break; current_size += n_read; p = buffer; while (n_read > 0) - { - n_written = g_output_stream_write (out, p, n_read, cancellable, error); - if (n_written == -1) - { - res = FALSE; - break; - } + { + n_written = g_output_stream_write (out, p, n_read, cancellable, error); + if (n_written == -1) + { + res = FALSE; + break; + } - p += n_written; - n_read -= n_written; - } + p += n_written; + n_read -= n_written; + } if (!res) break; if (progress_callback) - progress_callback (current_size, total_size, progress_callback_data); + progress_callback (current_size, total_size, progress_callback_data); } /* Make sure we send full copied size */ @@ -2704,9 +2787,9 @@ copy_stream_with_progress (GInputStream *in, static gboolean do_splice (int fd_in, - loff_t *off_in, + loff_t *off_in, int fd_out, - loff_t *off_out, + loff_t *off_out, size_t len, long *bytes_transferd, GError **error) @@ -2824,12 +2907,12 @@ splice_stream_with_progress (GInputStream *in, static gboolean file_copy_fallback (GFile *source, - GFile *destination, - GFileCopyFlags flags, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GError **error) + GFile *destination, + GFileCopyFlags flags, + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GError **error) { GInputStream *in; GOutputStream *out; @@ -2842,13 +2925,13 @@ file_copy_fallback (GFile *source, /* need to know the file type */ info = g_file_query_info (source, - G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET, - G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, - cancellable, - error); + G_FILE_ATTRIBUTE_STANDARD_TYPE "," G_FILE_ATTRIBUTE_STANDARD_SYMLINK_TARGET, + G_FILE_QUERY_INFO_NOFOLLOW_SYMLINKS, + cancellable, + error); if (info == NULL) - return FALSE; + return FALSE; /* Maybe copy the symlink? */ if ((flags & G_FILE_COPY_NOFOLLOW_SYMLINKS) && @@ -2856,24 +2939,23 @@ file_copy_fallback (GFile *source, { target = g_file_info_get_symlink_target (info); if (target) - { - if (!copy_symlink (destination, flags, cancellable, target, error)) - { - g_object_unref (info); - return FALSE; - } - - g_object_unref (info); - goto copied_file; - } + { + if (!copy_symlink (destination, flags, cancellable, target, error)) + { + g_object_unref (info); + return FALSE; + } + + g_object_unref (info); + goto copied_file; + } /* ... else fall back on a regular file copy */ - g_object_unref (info); + g_object_unref (info); } /* Handle "special" files (pipes, device nodes, ...)? */ else if (g_file_info_get_file_type (info) == G_FILE_TYPE_SPECIAL) { /* FIXME: could try to recreate device nodes and others? */ - g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, _("Can't copy special file")); g_object_unref (info); @@ -2886,14 +2968,14 @@ file_copy_fallback (GFile *source, in = open_source_for_copy (source, destination, flags, cancellable, error); if (in == NULL) return FALSE; - + if (flags & G_FILE_COPY_OVERWRITE) { out = (GOutputStream *)g_file_replace (destination, - NULL, - flags & G_FILE_COPY_BACKUP, + NULL, + flags & G_FILE_COPY_BACKUP, G_FILE_CREATE_REPLACE_DESTINATION, - cancellable, error); + cancellable, error); } else { @@ -2928,8 +3010,8 @@ file_copy_fallback (GFile *source, if (fallback) #endif result = copy_stream_with_progress (in, out, source, cancellable, - progress_callback, progress_callback_data, - error); + progress_callback, progress_callback_data, + error); /* Don't care about errors in source here */ g_input_stream_close (in, cancellable, NULL); @@ -2947,17 +3029,18 @@ file_copy_fallback (GFile *source, copied_file: /* Ignore errors here. Failure to copy metadata is not a hard error */ g_file_copy_attributes (source, destination, - flags, cancellable, NULL); - + flags, cancellable, NULL); + return TRUE; } /** * g_file_copy: - * @source: input #GFile. + * @source: input #GFile * @destination: destination #GFile * @flags: set of #GFileCopyFlags - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @progress_callback: (allow-none) (scope call): function to callback with * progress information, or %NULL if progress information is not needed * @progress_callback_data: (closure): user data to pass to @progress_callback @@ -2977,39 +3060,39 @@ file_copy_fallback (GFile *source, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * If @progress_callback is not %NULL, then the operation can be monitored by - * setting this to a #GFileProgressCallback function. @progress_callback_data - * will be passed to this function. It is guaranteed that this callback will - * be called after all data has been transferred with the total number of bytes - * copied during the operation. + * If @progress_callback is not %NULL, then the operation can be monitored + * by setting this to a #GFileProgressCallback function. + * @progress_callback_data will be passed to this function. It is guaranteed + * that this callback will be called after all data has been transferred with + * the total number of bytes copied during the operation. * - * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND - * error is returned, independent on the status of the @destination. + * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND error + * is returned, independent on the status of the @destination. * - * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the - * error G_IO_ERROR_EXISTS is returned. + * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then + * the error %G_IO_ERROR_EXISTS is returned. * - * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY + * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY * error is returned. If trying to overwrite a directory with a directory the - * G_IO_ERROR_WOULD_MERGE error is returned. + * %G_IO_ERROR_WOULD_MERGE error is returned. * * If the source is a directory and the target does not exist, or * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then the - * G_IO_ERROR_WOULD_RECURSE error is returned. + * %G_IO_ERROR_WOULD_RECURSE error is returned. * * If you are interested in copying the #GFile object itself (not the on-disk * file), see g_file_dup(). * * Returns: %TRUE on success, %FALSE otherwise. - **/ + */ gboolean g_file_copy (GFile *source, - GFile *destination, - GFileCopyFlags flags, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GError **error) + GFile *destination, + GFileCopyFlags flags, + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GError **error) { GFileIface *iface; GError *my_error; @@ -3020,68 +3103,70 @@ g_file_copy (GFile *source, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + iface = G_FILE_GET_IFACE (destination); if (iface->copy) { my_error = NULL; res = (* iface->copy) (source, destination, - flags, cancellable, - progress_callback, progress_callback_data, - &my_error); - + flags, cancellable, + progress_callback, progress_callback_data, + &my_error); + if (res) - return TRUE; - + return TRUE; + if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED) - { - g_propagate_error (error, my_error); - return FALSE; - } + { + g_propagate_error (error, my_error); + return FALSE; + } else - g_clear_error (&my_error); + g_clear_error (&my_error); } /* If the types are different, and the destination method failed - also try the source method */ + * also try the source method + */ if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination)) { iface = G_FILE_GET_IFACE (source); - + if (iface->copy) - { - my_error = NULL; - res = (* iface->copy) (source, destination, - flags, cancellable, - progress_callback, progress_callback_data, - &my_error); - - if (res) - return TRUE; - - if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED) - { - g_propagate_error (error, my_error); - return FALSE; - } - else - g_clear_error (&my_error); - } + { + my_error = NULL; + res = (* iface->copy) (source, destination, + flags, cancellable, + progress_callback, progress_callback_data, + &my_error); + + if (res) + return TRUE; + + if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED) + { + g_propagate_error (error, my_error); + return FALSE; + } + else + g_clear_error (&my_error); + } } - + return file_copy_fallback (source, destination, flags, cancellable, - progress_callback, progress_callback_data, - error); + progress_callback, progress_callback_data, + error); } /** * g_file_copy_async: (skip) - * @source: input #GFile. + * @source: input #GFile * @destination: destination #GFile * @flags: set of #GFileCopyFlags * @io_priority: the I/O priority * of the request - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @progress_callback: (allow-none): function to callback with progress * information, or %NULL if progress information is not needed * @progress_callback_data: (closure): user data to pass to @progress_callback @@ -3097,17 +3182,17 @@ g_file_copy (GFile *source, * * When the operation is finished, @callback will be called. You can then call * g_file_copy_finish() to get the result of the operation. - **/ + */ void g_file_copy_async (GFile *source, - GFile *destination, - GFileCopyFlags flags, - int io_priority, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GAsyncReadyCallback callback, - gpointer user_data) + GFile *destination, + GFileCopyFlags flags, + int io_priority, + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -3116,60 +3201,62 @@ g_file_copy_async (GFile *source, iface = G_FILE_GET_IFACE (source); (* iface->copy_async) (source, - destination, - flags, - io_priority, - cancellable, - progress_callback, - progress_callback_data, - callback, - user_data); + destination, + flags, + io_priority, + cancellable, + progress_callback, + progress_callback_data, + callback, + user_data); } /** * g_file_copy_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL - * - * Finishes copying the file started with - * g_file_copy_async(). - * + * + * Finishes copying the file started with g_file_copy_async(). + * * Returns: a %TRUE on success, %FALSE on error. - **/ + */ gboolean -g_file_copy_finish (GFile *file, - GAsyncResult *res, - GError **error) +g_file_copy_finish (GFile *file, + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), FALSE); if (g_async_result_legacy_propagate_error (res, error)) return FALSE; - + iface = G_FILE_GET_IFACE (file); return (* iface->copy_finish) (file, res, error); } /** * g_file_move: - * @source: #GFile pointing to the source location. - * @destination: #GFile pointing to the destination location. - * @flags: set of #GFileCopyFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @progress_callback: (allow-none) (scope call): #GFileProgressCallback function for updates. - * @progress_callback_data: (closure): gpointer to user data for the callback function. + * @source: #GFile pointing to the source location + * @destination: #GFile pointing to the destination location + * @flags: set of #GFileCopyFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @progress_callback: (allow-none) (scope call): #GFileProgressCallback + * function for updates + * @progress_callback_data: (closure): gpointer to user data for + * the callback function * @error: #GError for returning error conditions, or %NULL * + * Tries to move the file or directory @source to the location specified + * by @destination. If native move operations are supported then this is + * used, otherwise a copy + delete fallback is used. The native + * implementation may support moving directories (for instance on moves + * inside the same filesystem), but the fallback code does not. * - * Tries to move the file or directory @source to the location specified by @destination. - * If native move operations are supported then this is used, otherwise a copy + delete - * fallback is used. The native implementation may support moving directories (for instance - * on moves inside the same filesystem), but the fallback code does not. - * * If the flag #G_FILE_COPY_OVERWRITE is specified an already * existing @destination file is overwritten. * @@ -3179,38 +3266,39 @@ g_file_copy_finish (GFile *file, * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * If @progress_callback is not %NULL, then the operation can be monitored by - * setting this to a #GFileProgressCallback function. @progress_callback_data - * will be passed to this function. It is guaranteed that this callback will - * be called after all data has been transferred with the total number of bytes - * copied during the operation. - * - * If the @source file does not exist then the G_IO_ERROR_NOT_FOUND + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * If @progress_callback is not %NULL, then the operation can be monitored + * by setting this to a #GFileProgressCallback function. + * @progress_callback_data will be passed to this function. It is + * guaranteed that this callback will be called after all data has been + * transferred with the total number of bytes copied during the operation. + * + * If the @source file does not exist, then the %G_IO_ERROR_NOT_FOUND * error is returned, independent on the status of the @destination. * - * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, then the - * error G_IO_ERROR_EXISTS is returned. + * If #G_FILE_COPY_OVERWRITE is not specified and the target exists, + * then the error %G_IO_ERROR_EXISTS is returned. * - * If trying to overwrite a file over a directory the G_IO_ERROR_IS_DIRECTORY + * If trying to overwrite a file over a directory, the %G_IO_ERROR_IS_DIRECTORY * error is returned. If trying to overwrite a directory with a directory the - * G_IO_ERROR_WOULD_MERGE error is returned. + * %G_IO_ERROR_WOULD_MERGE error is returned. * - * If the source is a directory and the target does not exist, or #G_FILE_COPY_OVERWRITE is - * specified and the target is a file, then the G_IO_ERROR_WOULD_RECURSE error - * may be returned (if the native move operation isn't available). + * If the source is a directory and the target does not exist, or + * #G_FILE_COPY_OVERWRITE is specified and the target is a file, then + * the %G_IO_ERROR_WOULD_RECURSE error may be returned (if the native + * move operation isn't available). * * Returns: %TRUE on successful move, %FALSE otherwise. - **/ + */ gboolean g_file_move (GFile *source, - GFile *destination, - GFileCopyFlags flags, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GError **error) + GFile *destination, + GFileCopyFlags flags, + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GError **error) { GFileIface *iface; GError *my_error; @@ -3221,63 +3309,64 @@ g_file_move (GFile *source, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + iface = G_FILE_GET_IFACE (destination); if (iface->move) { my_error = NULL; res = (* iface->move) (source, destination, - flags, cancellable, - progress_callback, progress_callback_data, - &my_error); - + flags, cancellable, + progress_callback, progress_callback_data, + &my_error); + if (res) - return TRUE; - + return TRUE; + if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED) - { - g_propagate_error (error, my_error); - return FALSE; - } + { + g_propagate_error (error, my_error); + return FALSE; + } } /* If the types are different, and the destination method failed - also try the source method */ + * also try the source method + */ if (G_OBJECT_TYPE (source) != G_OBJECT_TYPE (destination)) { iface = G_FILE_GET_IFACE (source); - + if (iface->move) - { - my_error = NULL; - res = (* iface->move) (source, destination, - flags, cancellable, - progress_callback, progress_callback_data, - &my_error); - - if (res) - return TRUE; - - if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED) - { - g_propagate_error (error, my_error); - return FALSE; - } - } + { + my_error = NULL; + res = (* iface->move) (source, destination, + flags, cancellable, + progress_callback, progress_callback_data, + &my_error); + + if (res) + return TRUE; + + if (my_error->domain != G_IO_ERROR || my_error->code != G_IO_ERROR_NOT_SUPPORTED) + { + g_propagate_error (error, my_error); + return FALSE; + } + } } - + if (flags & G_FILE_COPY_NO_FALLBACK_FOR_MOVE) - { + { g_set_error_literal (error, G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, _("Operation not supported")); return FALSE; } - + flags |= G_FILE_COPY_ALL_METADATA; if (!g_file_copy (source, destination, flags, cancellable, - progress_callback, progress_callback_data, - error)) + progress_callback, progress_callback_data, + error)) return FALSE; return g_file_delete (source, cancellable, error); @@ -3285,31 +3374,32 @@ g_file_move (GFile *source, /** * g_file_make_directory: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, or %NULL + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, or %NULL * - * Creates a directory. Note that this will only create a child directory of - * the immediate parent directory of the path or URI given by the #GFile. To - * recursively create directories, see g_file_make_directory_with_parents(). - * This function will fail if the parent directory does not exist, setting - * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support creating - * directories, this function will fail, setting @error to + * Creates a directory. Note that this will only create a child directory + * of the immediate parent directory of the path or URI given by the #GFile. + * To recursively create directories, see g_file_make_directory_with_parents(). + * This function will fail if the parent directory does not exist, setting + * @error to %G_IO_ERROR_NOT_FOUND. If the file system doesn't support + * creating directories, this function will fail, setting @error to * %G_IO_ERROR_NOT_SUPPORTED. * * For a local #GFile the newly created directory will have the default * (current) ownership and permissions of the current process. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE on successful creation, %FALSE otherwise. - **/ + */ gboolean g_file_make_directory (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -3317,7 +3407,7 @@ g_file_make_directory (GFile *file, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + iface = G_FILE_GET_IFACE (file); if (iface->make_directory == NULL) @@ -3327,38 +3417,40 @@ g_file_make_directory (GFile *file, _("Operation not supported")); return FALSE; } - + return (* iface->make_directory) (file, cancellable, error); } /** * g_file_make_directory_with_parents: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, or %NULL + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, or %NULL + * + * Creates a directory and any parent directories that may not + * exist similar to 'mkdir -p'. If the file system does not support + * creating directories, this function will fail, setting @error to + * %G_IO_ERROR_NOT_SUPPORTED. If the directory itself already exists, + * this function will fail setting @error to %G_IO_ERROR_EXISTS, unlike + * the similar g_mkdir_with_parents(). * - * Creates a directory and any parent directories that may not exist similar to - * 'mkdir -p'. If the file system does not support creating directories, this - * function will fail, setting @error to %G_IO_ERROR_NOT_SUPPORTED. If the - * directory itself already exists, this function will fail setting @error - * to %G_IO_ERROR_EXISTS, unlike the similar g_mkdir_with_parents(). - * * For a local #GFile the newly created directories will have the default * (current) ownership and permissions of the current process. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE if all directories have been successfully created, %FALSE * otherwise. * * Since: 2.18 - **/ + */ gboolean g_file_make_directory_with_parents (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFile *work_file = NULL; GList *list = NULL, *l; @@ -3368,7 +3460,7 @@ g_file_make_directory_with_parents (GFile *file, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + g_file_make_directory (file, cancellable, &my_error); if (my_error == NULL || my_error->code != G_IO_ERROR_NOT_FOUND) { @@ -3376,9 +3468,9 @@ g_file_make_directory_with_parents (GFile *file, g_propagate_error (error, my_error); return my_error == NULL; } - + work_file = g_object_ref (file); - + while (my_error != NULL && my_error->code == G_IO_ERROR_NOT_FOUND) { GFile *parent_file; @@ -3406,9 +3498,9 @@ g_file_make_directory_with_parents (GFile *file, if (work_file) g_object_unref (work_file); - + /* Clean up */ - while (list != NULL) + while (list != NULL) { g_object_unref ((GFile *) list->data); list = g_list_remove (list, list->data); @@ -3419,7 +3511,7 @@ g_file_make_directory_with_parents (GFile *file, g_propagate_error (error, my_error); return FALSE; } - + return g_file_make_directory (file, cancellable, error); } @@ -3427,8 +3519,9 @@ g_file_make_directory_with_parents (GFile *file, * g_file_make_symbolic_link: * @file: a #GFile with the name of the symlink to create * @symlink_value: a string with the path for the target of the new symlink - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError. + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError * * Creates a symbolic link named @file which contains the string * @symlink_value. @@ -3441,9 +3534,9 @@ g_file_make_directory_with_parents (GFile *file, */ gboolean g_file_make_symbolic_link (GFile *file, - const char *symlink_value, - GCancellable *cancellable, - GError **error) + const char *symlink_value, + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -3460,7 +3553,7 @@ g_file_make_symbolic_link (GFile *file, _("Invalid symlink value given")); return FALSE; } - + iface = G_FILE_GET_IFACE (file); if (iface->make_symbolic_link == NULL) @@ -3470,38 +3563,39 @@ g_file_make_symbolic_link (GFile *file, _("Operation not supported")); return FALSE; } - + return (* iface->make_symbolic_link) (file, symlink_value, cancellable, error); } /** * g_file_delete: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, or %NULL - * - * Deletes a file. If the @file is a directory, it will only be deleted if it - * is empty. This has the same semantics as g_unlink(). - * + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, or %NULL + * + * Deletes a file. If the @file is a directory, it will only be + * deleted if it is empty. This has the same semantics as g_unlink(). + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * Virtual: delete_file * Returns: %TRUE if the file was deleted. %FALSE otherwise. - **/ + */ gboolean g_file_delete (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + iface = G_FILE_GET_IFACE (file); if (iface->delete_file == NULL) @@ -3511,17 +3605,19 @@ g_file_delete (GFile *file, _("Operation not supported")); return FALSE; } - + return (* iface->delete_file) (file, cancellable, error); } /** * g_file_delete_async: - * @file: input #GFile. + * @file: input #GFile * @io_priority: the I/O priority * of the request - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback to call when the request is satisfied + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: the data to pass to callback function * * Asynchronously delete a file. If the @file is a directory, it will @@ -3530,7 +3626,7 @@ g_file_delete (GFile *file, * * Virtual: delete_file_async * Since: 2.34 - **/ + */ void g_file_delete_async (GFile *file, int io_priority, @@ -3552,20 +3648,19 @@ g_file_delete_async (GFile *file, /** * g_file_delete_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL * - * Finishes deleting a file started with - * g_file_delete_async(). + * Finishes deleting a file started with g_file_delete_async(). * * Virtual: delete_file_finish * Since: 2.34 **/ gboolean -g_file_delete_finish (GFile *file, - GAsyncResult *result, - GError **error) +g_file_delete_finish (GFile *file, + GAsyncResult *result, + GError **error) { GFileIface *iface; @@ -3581,8 +3676,9 @@ g_file_delete_finish (GFile *file, /** * g_file_trash: - * @file: #GFile to send to trash. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: #GFile to send to trash + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL * * Sends @file to the "Trashcan", if possible. This is similar to @@ -3590,25 +3686,24 @@ g_file_delete_finish (GFile *file, * Not all file systems support trashing, so this call can return the * %G_IO_ERROR_NOT_SUPPORTED error. * - * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE on successful trash, %FALSE otherwise. - **/ + */ gboolean g_file_trash (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + iface = G_FILE_GET_IFACE (file); if (iface->trash == NULL) @@ -3618,59 +3713,61 @@ g_file_trash (GFile *file, _("Trash not supported")); return FALSE; } - + return (* iface->trash) (file, cancellable, error); } /** * g_file_set_display_name: - * @file: input #GFile. - * @display_name: a string. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @display_name: a string + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * + * * Renames @file to the specified display name. * - * The display name is converted from UTF8 to the correct encoding for the target - * filesystem if possible and the @file is renamed to this. - * - * If you want to implement a rename operation in the user interface the edit name - * (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the initial value in the rename - * widget, and then the result after editing should be passed to g_file_set_display_name(). + * The display name is converted from UTF-8 to the correct encoding + * for the target filesystem if possible and the @file is renamed to this. + * + * If you want to implement a rename operation in the user interface the + * edit name (#G_FILE_ATTRIBUTE_STANDARD_EDIT_NAME) should be used as the + * initial value in the rename widget, and then the result after editing + * should be passed to g_file_set_display_name(). * * On success the resulting converted filename is returned. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: (transfer full): a #GFile specifying what @file was renamed to, or %NULL - * if there was an error. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: (transfer full): a #GFile specifying what @file was renamed to, + * or %NULL if there was an error. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_set_display_name (GFile *file, - const char *display_name, - GCancellable *cancellable, - GError **error) + const gchar *display_name, + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (display_name != NULL, NULL); if (strchr (display_name, G_DIR_SEPARATOR) != NULL) { g_set_error (error, - G_IO_ERROR, - G_IO_ERROR_INVALID_ARGUMENT, - _("File names cannot contain '%c'"), G_DIR_SEPARATOR); + G_IO_ERROR, + G_IO_ERROR_INVALID_ARGUMENT, + _("File names cannot contain '%c'"), G_DIR_SEPARATOR); return NULL; } - + if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->set_display_name) (file, display_name, cancellable, error); @@ -3678,97 +3775,102 @@ g_file_set_display_name (GFile *file, /** * g_file_set_display_name_async: - * @file: input #GFile. - * @display_name: a string. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback to call when the request is satisfied + * @file: input #GFile + * @display_name: a string + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback to call + * when the request is satisfied * @user_data: (closure): the data to pass to callback function - * + * * Asynchronously sets the display name for a given #GFile. - * + * * For more details, see g_file_set_display_name() which is * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_set_display_name_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. + * You can then call g_file_set_display_name_finish() to get + * the result of the operation. + */ void g_file_set_display_name_async (GFile *file, - const char *display_name, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const gchar *display_name, + gint io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); g_return_if_fail (display_name != NULL); iface = G_FILE_GET_IFACE (file); (* iface->set_display_name_async) (file, - display_name, - io_priority, - cancellable, - callback, - user_data); + display_name, + io_priority, + cancellable, + callback, + user_data); } /** * g_file_set_display_name_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. + * @file: input #GFile + * @res: a #GAsyncResult * @error: a #GError, or %NULL - * - * Finishes setting a display name started with + * + * Finishes setting a display name started with * g_file_set_display_name_async(). - * + * * Returns: (transfer full): a #GFile or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_set_display_name_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), NULL); g_return_val_if_fail (G_IS_ASYNC_RESULT (res), NULL); if (g_async_result_legacy_propagate_error (res, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->set_display_name_finish) (file, res, error); } /** * g_file_query_settable_attributes: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * + * * Obtain the list of settable attributes for the file. * - * Returns the type and full attribute name of all the attributes - * that can be set on this file. This doesn't mean setting it will always - * succeed though, you might get an access failure, or some specific - * file may not support a specific attribute. + * Returns the type and full attribute name of all the attributes + * that can be set on this file. This doesn't mean setting it will + * always succeed though, you might get an access failure, or some + * specific file may not support a specific attribute. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: a #GFileAttributeInfoList describing the settable attributes. - * When you are done with it, release it with g_file_attribute_info_list_unref() - **/ + * When you are done with it, release it with + * g_file_attribute_info_list_unref() + */ GFileAttributeInfoList * g_file_query_settable_attributes (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; GError *my_error; @@ -3778,7 +3880,7 @@ g_file_query_settable_attributes (GFile *file, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->query_settable_attributes == NULL) @@ -3786,52 +3888,54 @@ g_file_query_settable_attributes (GFile *file, my_error = NULL; list = (* iface->query_settable_attributes) (file, cancellable, &my_error); - + if (list == NULL) { if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED) - { - list = g_file_attribute_info_list_new (); - g_error_free (my_error); - } + { + list = g_file_attribute_info_list_new (); + g_error_free (my_error); + } else - g_propagate_error (error, my_error); + g_propagate_error (error, my_error); } - + return list; } /** * g_file_query_writable_namespaces: - * @file: input #GFile. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Obtain the list of attribute namespaces where new attributes + * + * Obtain the list of attribute namespaces where new attributes * can be created by a user. An example of this is extended * attributes (in the "xattr" namespace). * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: a #GFileAttributeInfoList describing the writable namespaces. - * When you are done with it, release it with g_file_attribute_info_list_unref() - **/ + * When you are done with it, release it with + * g_file_attribute_info_list_unref() + */ GFileAttributeInfoList * g_file_query_writable_namespaces (GFile *file, - GCancellable *cancellable, - GError **error) + GCancellable *cancellable, + GError **error) { GFileIface *iface; GError *my_error; GFileAttributeInfoList *list; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); if (iface->query_writable_namespaces == NULL) @@ -3839,59 +3943,61 @@ g_file_query_writable_namespaces (GFile *file, my_error = NULL; list = (* iface->query_writable_namespaces) (file, cancellable, &my_error); - + if (list == NULL) { if (my_error->domain == G_IO_ERROR && my_error->code == G_IO_ERROR_NOT_SUPPORTED) - { - list = g_file_attribute_info_list_new (); - g_error_free (my_error); - } + { + list = g_file_attribute_info_list_new (); + g_error_free (my_error); + } else - g_propagate_error (error, my_error); + g_propagate_error (error, my_error); } - + return list; } /** * g_file_set_attribute: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. + * @file: input #GFile + * @attribute: a string containing the attribute's name * @type: The type of the attribute - * @value_p: (allow-none): a pointer to the value (or the pointer itself if the type is a pointer type) - * @flags: a set of #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @value_p: (allow-none): a pointer to the value (or the pointer + * itself if the type is a pointer type) + * @flags: a set of #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * + * * Sets an attribute in the file with attribute name @attribute to @value. * * Some attributes can be unset by setting @attribute to * %G_FILE_ATTRIBUTE_TYPE_INVALID and @value_p to %NULL. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE if the attribute was set, %FALSE otherwise. - **/ + */ gboolean -g_file_set_attribute (GFile *file, - const char *attribute, - GFileAttributeType type, - gpointer value_p, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) +g_file_set_attribute (GFile *file, + const gchar *attribute, + GFileAttributeType type, + gpointer value_p, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (attribute != NULL && *attribute != '\0', FALSE); if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + iface = G_FILE_GET_IFACE (file); if (iface->set_attribute == NULL) @@ -3907,33 +4013,34 @@ g_file_set_attribute (GFile *file, /** * g_file_set_attributes_from_info: - * @file: input #GFile. - * @info: a #GFileInfo. + * @file: input #GFile + * @info: a #GFileInfo * @flags: #GFileQueryInfoFlags - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, or %NULL - * - * Tries to set all attributes in the #GFileInfo on the target values, - * not stopping on the first error. - * - * If there is any error during this operation then @error will be set to - * the first error. Error on particular fields are flagged by setting - * the "status" field in the attribute value to - * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can also detect - * further errors. + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, or %NULL + * + * Tries to set all attributes in the #GFileInfo on the target + * values, not stopping on the first error. + * + * If there is any error during this operation then @error will + * be set to the first error. Error on particular fields are flagged + * by setting the "status" field in the attribute value to + * %G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING, which means you can + * also detect further errors. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE if there was any error, %FALSE otherwise. - **/ + */ gboolean g_file_set_attributes_from_info (GFile *file, - GFileInfo *info, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + GFileInfo *info, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -3942,33 +4049,32 @@ g_file_set_attributes_from_info (GFile *file, if (g_cancellable_set_error_if_cancelled (cancellable, error)) return FALSE; - + g_file_info_clear_status (info); - + iface = G_FILE_GET_IFACE (file); - return (* iface->set_attributes_from_info) (file, - info, - flags, - cancellable, + return (* iface->set_attributes_from_info) (file, + info, + flags, + cancellable, error); } - static gboolean g_file_real_set_attributes_from_info (GFile *file, - GFileInfo *info, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + GFileInfo *info, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { char **attributes; int i; gboolean res; GFileAttributeValue *value; - + res = TRUE; - + attributes = g_file_info_list_attributes (info, NULL); for (i = 0; attributes[i] != NULL; i++) @@ -3976,93 +4082,95 @@ g_file_real_set_attributes_from_info (GFile *file, value = _g_file_info_get_attribute_value (info, attributes[i]); if (value->status != G_FILE_ATTRIBUTE_STATUS_UNSET) - continue; + continue; if (!g_file_set_attribute (file, attributes[i], - value->type, _g_file_attribute_value_peek_as_pointer (value), - flags, cancellable, error)) - { - value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING; - res = FALSE; - /* Don't set error multiple times */ - error = NULL; - } + value->type, _g_file_attribute_value_peek_as_pointer (value), + flags, cancellable, error)) + { + value->status = G_FILE_ATTRIBUTE_STATUS_ERROR_SETTING; + res = FALSE; + /* Don't set error multiple times */ + error = NULL; + } else - value->status = G_FILE_ATTRIBUTE_STATUS_SET; + value->status = G_FILE_ATTRIBUTE_STATUS_SET; } - + g_strfreev (attributes); - + return res; } /** * g_file_set_attributes_async: - * @file: input #GFile. - * @info: a #GFileInfo. - * @flags: a #GFileQueryInfoFlags. - * @io_priority: the I/O priority - * of the request. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async): a #GAsyncReadyCallback. - * @user_data: (closure): a #gpointer. + * @file: input #GFile + * @info: a #GFileInfo + * @flags: a #GFileQueryInfoFlags + * @io_priority: the I/O priority + * of the request + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async): a #GAsyncReadyCallback + * @user_data: (closure): a #gpointer * * Asynchronously sets the attributes of @file with @info. - * - * For more details, see g_file_set_attributes_from_info() which is - * the synchronous version of this call. * - * When the operation is finished, @callback will be called. You can then call - * g_file_set_attributes_finish() to get the result of the operation. - **/ + * For more details, see g_file_set_attributes_from_info(), + * which is the synchronous version of this call. + * + * When the operation is finished, @callback will be called. + * You can then call g_file_set_attributes_finish() to get + * the result of the operation. + */ void g_file_set_attributes_async (GFile *file, - GFileInfo *info, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileInfo *info, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); g_return_if_fail (G_IS_FILE_INFO (info)); iface = G_FILE_GET_IFACE (file); - (* iface->set_attributes_async) (file, - info, - flags, - io_priority, - cancellable, - callback, + (* iface->set_attributes_async) (file, + info, + flags, + io_priority, + cancellable, + callback, user_data); } /** * g_file_set_attributes_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. - * @info: (out) (transfer full): a #GFileInfo. + * @file: input #GFile + * @result: a #GAsyncResult + * @info: (out) (transfer full): a #GFileInfo * @error: a #GError, or %NULL - * + * * Finishes setting an attribute started in g_file_set_attributes_async(). - * + * * Returns: %TRUE if the attributes were set correctly, %FALSE otherwise. - **/ + */ gboolean g_file_set_attributes_finish (GFile *file, - GAsyncResult *result, - GFileInfo **info, - GError **error) + GAsyncResult *result, + GFileInfo **info, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); /* No standard handling of errors here, as we must set info even - * on errors + * on errors */ iface = G_FILE_GET_IFACE (file); return (* iface->set_attributes_finish) (file, result, info, error); @@ -4070,222 +4178,232 @@ g_file_set_attributes_finish (GFile *file, /** * g_file_set_attribute_string: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. - * @value: a string containing the attribute's value. - * @flags: #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @attribute: a string containing the attribute's name + * @value: a string containing the attribute's value + * @flags: #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. + * + * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_STRING to @value. * If @attribute is of a different type, this operation will fail. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise. - **/ + */ gboolean g_file_set_attribute_string (GFile *file, - const char *attribute, - const char *value, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const char *attribute, + const char *value, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { return g_file_set_attribute (file, attribute, - G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value, - flags, cancellable, error); + G_FILE_ATTRIBUTE_TYPE_STRING, (gpointer)value, + flags, cancellable, error); } /** * g_file_set_attribute_byte_string: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. - * @value: a string containing the attribute's new value. - * @flags: a #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @attribute: a string containing the attribute's name + * @value: a string containing the attribute's new value + * @flags: a #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. - * If @attribute is of a different type, this operation will fail, - * returning %FALSE. - * + * + * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_BYTE_STRING to @value. + * If @attribute is of a different type, this operation will fail, + * returning %FALSE. + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: %TRUE if the @attribute was successfully set to @value - * in the @file, %FALSE otherwise. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: %TRUE if the @attribute was successfully set to @value + * in the @file, %FALSE otherwise. + */ gboolean g_file_set_attribute_byte_string (GFile *file, - const char *attribute, - const char *value, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const gchar *attribute, + const gchar *value, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { return g_file_set_attribute (file, attribute, - G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value, - flags, cancellable, error); + G_FILE_ATTRIBUTE_TYPE_BYTE_STRING, (gpointer)value, + flags, cancellable, error); } /** * g_file_set_attribute_uint32: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. - * @value: a #guint32 containing the attribute's new value. - * @flags: a #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @attribute: a string containing the attribute's name + * @value: a #guint32 containing the attribute's new value + * @flags: a #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. + * + * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT32 to @value. * If @attribute is of a different type, this operation will fail. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: %TRUE if the @attribute was successfully set to @value - * in the @file, %FALSE otherwise. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: %TRUE if the @attribute was successfully set to @value + * in the @file, %FALSE otherwise. + */ gboolean g_file_set_attribute_uint32 (GFile *file, - const char *attribute, - guint32 value, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const gchar *attribute, + guint32 value, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { return g_file_set_attribute (file, attribute, - G_FILE_ATTRIBUTE_TYPE_UINT32, &value, - flags, cancellable, error); + G_FILE_ATTRIBUTE_TYPE_UINT32, &value, + flags, cancellable, error); } /** * g_file_set_attribute_int32: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. - * @value: a #gint32 containing the attribute's new value. - * @flags: a #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @attribute: a string containing the attribute's name + * @value: a #gint32 containing the attribute's new value + * @flags: a #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. + * + * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT32 to @value. * If @attribute is of a different type, this operation will fail. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: %TRUE if the @attribute was successfully set to @value - * in the @file, %FALSE otherwise. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: %TRUE if the @attribute was successfully set to @value + * in the @file, %FALSE otherwise. + */ gboolean g_file_set_attribute_int32 (GFile *file, - const char *attribute, - gint32 value, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const gchar *attribute, + gint32 value, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { return g_file_set_attribute (file, attribute, - G_FILE_ATTRIBUTE_TYPE_INT32, &value, - flags, cancellable, error); + G_FILE_ATTRIBUTE_TYPE_INT32, &value, + flags, cancellable, error); } /** * g_file_set_attribute_uint64: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. - * @value: a #guint64 containing the attribute's new value. - * @flags: a #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @attribute: a string containing the attribute's name + * @value: a #guint64 containing the attribute's new value + * @flags: a #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. + * + * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_UINT64 to @value. * If @attribute is of a different type, this operation will fail. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: %TRUE if the @attribute was successfully set to @value - * in the @file, %FALSE otherwise. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: %TRUE if the @attribute was successfully set to @value + * in the @file, %FALSE otherwise. + */ gboolean g_file_set_attribute_uint64 (GFile *file, - const char *attribute, - guint64 value, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const gchar *attribute, + guint64 value, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { return g_file_set_attribute (file, attribute, - G_FILE_ATTRIBUTE_TYPE_UINT64, &value, - flags, cancellable, error); + G_FILE_ATTRIBUTE_TYPE_UINT64, &value, + flags, cancellable, error); } /** * g_file_set_attribute_int64: - * @file: input #GFile. - * @attribute: a string containing the attribute's name. - * @value: a #guint64 containing the attribute's new value. - * @flags: a #GFileQueryInfoFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @attribute: a string containing the attribute's name + * @value: a #guint64 containing the attribute's new value + * @flags: a #GFileQueryInfoFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. + * + * Sets @attribute of type %G_FILE_ATTRIBUTE_TYPE_INT64 to @value. * If @attribute is of a different type, this operation will fail. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE if the @attribute was successfully set, %FALSE otherwise. - **/ + */ gboolean g_file_set_attribute_int64 (GFile *file, - const char *attribute, - gint64 value, - GFileQueryInfoFlags flags, - GCancellable *cancellable, - GError **error) + const gchar *attribute, + gint64 value, + GFileQueryInfoFlags flags, + GCancellable *cancellable, + GError **error) { return g_file_set_attribute (file, attribute, - G_FILE_ATTRIBUTE_TYPE_INT64, &value, - flags, cancellable, error); + G_FILE_ATTRIBUTE_TYPE_INT64, &value, + flags, cancellable, error); } /** * g_file_mount_mountable: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @mount_operation: (allow-none): a #GMountOperation, + * or %NULL to avoid user interaction + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: (closure): the data to pass to callback function - * + * * Mounts a file of type G_FILE_TYPE_MOUNTABLE. - * Using @mount_operation, you can request callbacks when, for instance, + * Using @mount_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * When the operation is finished, @callback will be called. You can then call - * g_file_mount_mountable_finish() to get the result of the operation. - **/ + * When the operation is finished, @callback will be called. + * You can then call g_file_mount_mountable_finish() to get + * the result of the operation. + */ void g_file_mount_mountable (GFile *file, - GMountMountFlags flags, - GMountOperation *mount_operation, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GMountMountFlags flags, + GMountOperation *mount_operation, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -4293,43 +4411,43 @@ g_file_mount_mountable (GFile *file, iface = G_FILE_GET_IFACE (file); - if (iface->mount_mountable == NULL) + if (iface->mount_mountable == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } - + (* iface->mount_mountable) (file, - flags, - mount_operation, - cancellable, - callback, - user_data); + flags, + mount_operation, + cancellable, + callback, + user_data); } /** * g_file_mount_mountable_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes a mount operation. See g_file_mount_mountable() for details. - * - * Finish an asynchronous mount operation that was started + * + * Finish an asynchronous mount operation that was started * with g_file_mount_mountable(). * * Returns: (transfer full): a #GFile or %NULL on error. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_mount_mountable_finish (GFile *file, - GAsyncResult *result, - GError **error) + GAsyncResult *result, + GError **error) { GFileIface *iface; @@ -4338,17 +4456,19 @@ g_file_mount_mountable_finish (GFile *file, if (g_async_result_legacy_propagate_error (result, error)) return NULL; - + iface = G_FILE_GET_IFACE (file); return (* iface->mount_mountable_finish) (file, result, error); } /** * g_file_unmount_mountable: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: (closure): the data to pass to callback function * * Unmounts a file of type G_FILE_TYPE_MOUNTABLE. @@ -4357,95 +4477,101 @@ g_file_mount_mountable_finish (GFile *file, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * When the operation is finished, @callback will be called. You can then call - * g_file_unmount_mountable_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_unmount_mountable_finish() to get + * the result of the operation. * * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation() instead. - **/ + */ void g_file_unmount_mountable (GFile *file, - GMountUnmountFlags flags, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GMountUnmountFlags flags, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; - + g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); - + if (iface->unmount_mountable == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } - + (* iface->unmount_mountable) (file, - flags, - cancellable, - callback, - user_data); + flags, + cancellable, + callback, + user_data); } /** * g_file_unmount_mountable_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes an unmount operation, see g_file_unmount_mountable() for details. - * - * Finish an asynchronous unmount operation that was started + * + * Finish an asynchronous unmount operation that was started * with g_file_unmount_mountable(). * - * Returns: %TRUE if the operation finished successfully. %FALSE - * otherwise. + * Returns: %TRUE if the operation finished successfully. + * %FALSE otherwise. * - * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() instead. - **/ + * Deprecated: 2.22: Use g_file_unmount_mountable_with_operation_finish() + * instead. + */ gboolean g_file_unmount_mountable_finish (GFile *file, - GAsyncResult *result, - GError **error) + GAsyncResult *result, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); if (g_async_result_legacy_propagate_error (result, error)) return FALSE; - + iface = G_FILE_GET_IFACE (file); return (* iface->unmount_mountable_finish) (file, result, error); } /** * g_file_unmount_mountable_with_operation: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @mount_operation: (allow-none): a #GMountOperation, + * or %NULL to avoid user interaction + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: (closure): the data to pass to callback function * - * Unmounts a file of type G_FILE_TYPE_MOUNTABLE. + * Unmounts a file of type #G_FILE_TYPE_MOUNTABLE. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * When the operation is finished, @callback will be called. You can then call - * g_file_unmount_mountable_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_unmount_mountable_finish() to get + * the result of the operation. * * Since: 2.22 - **/ + */ void g_file_unmount_mountable_with_operation (GFile *file, GMountUnmountFlags flags, @@ -4463,11 +4589,11 @@ g_file_unmount_mountable_with_operation (GFile *file, if (iface->unmount_mountable == NULL && iface->unmount_mountable_with_operation == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } @@ -4488,20 +4614,21 @@ g_file_unmount_mountable_with_operation (GFile *file, /** * g_file_unmount_mountable_with_operation_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * - * Finishes an unmount operation, see g_file_unmount_mountable_with_operation() for details. + * Finishes an unmount operation, + * see g_file_unmount_mountable_with_operation() for details. * * Finish an asynchronous unmount operation that was started * with g_file_unmount_mountable_with_operation(). * - * Returns: %TRUE if the operation finished successfully. %FALSE - * otherwise. + * Returns: %TRUE if the operation finished successfully. + * %FALSE otherwise. * * Since: 2.22 - **/ + */ gboolean g_file_unmount_mountable_with_operation_finish (GFile *file, GAsyncResult *result, @@ -4524,75 +4651,78 @@ g_file_unmount_mountable_with_operation_finish (GFile *file, /** * g_file_eject_mountable: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: (closure): the data to pass to callback function - * - * Starts an asynchronous eject on a mountable. + * + * Starts an asynchronous eject on a mountable. * When this operation has completed, @callback will be called with - * @user_user data, and the operation can be finalized with + * @user_user data, and the operation can be finalized with * g_file_eject_mountable_finish(). - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * Deprecated: 2.22: Use g_file_eject_mountable_with_operation() instead. - **/ + */ void g_file_eject_mountable (GFile *file, - GMountUnmountFlags flags, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GMountUnmountFlags flags, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; g_return_if_fail (G_IS_FILE (file)); iface = G_FILE_GET_IFACE (file); - - if (iface->eject_mountable == NULL) + + if (iface->eject_mountable == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } - + (* iface->eject_mountable) (file, - flags, - cancellable, - callback, - user_data); + flags, + cancellable, + callback, + user_data); } /** * g_file_eject_mountable_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL - * - * Finishes an asynchronous eject operation started by - * g_file_eject_mountable(). - * - * Returns: %TRUE if the @file was ejected successfully. %FALSE - * otherwise. * - * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() instead. - **/ + * Finishes an asynchronous eject operation started by + * g_file_eject_mountable(). + * + * Returns: %TRUE if the @file was ejected successfully. + * %FALSE otherwise. + * + * Deprecated: 2.22: Use g_file_eject_mountable_with_operation_finish() + * instead. + */ gboolean g_file_eject_mountable_finish (GFile *file, - GAsyncResult *result, - GError **error) + GAsyncResult *result, + GError **error) { GFileIface *iface; - + g_return_val_if_fail (G_IS_FILE (file), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); @@ -4605,11 +4735,14 @@ g_file_eject_mountable_finish (GFile *file, /** * g_file_eject_mountable_with_operation: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @mount_operation: (allow-none): a #GMountOperation, + * or %NULL to avoid user interaction + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (scope async) (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: (closure): the data to pass to callback function * * Starts an asynchronous eject on a mountable. @@ -4622,7 +4755,7 @@ g_file_eject_mountable_finish (GFile *file, * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * Since: 2.22 - **/ + */ void g_file_eject_mountable_with_operation (GFile *file, GMountUnmountFlags flags, @@ -4640,11 +4773,11 @@ g_file_eject_mountable_with_operation (GFile *file, if (iface->eject_mountable == NULL && iface->eject_mountable_with_operation == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } @@ -4665,18 +4798,18 @@ g_file_eject_mountable_with_operation (GFile *file, /** * g_file_eject_mountable_with_operation_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes an asynchronous eject operation started by * g_file_eject_mountable_with_operation(). * - * Returns: %TRUE if the @file was ejected successfully. %FALSE - * otherwise. + * Returns: %TRUE if the @file was ejected successfully. + * %FALSE otherwise. * * Since: 2.22 - **/ + */ gboolean g_file_eject_mountable_with_operation_finish (GFile *file, GAsyncResult *result, @@ -4699,27 +4832,29 @@ g_file_eject_mountable_with_operation_finish (GFile *file, /** * g_file_monitor_directory: - * @file: input #GFile. - * @flags: a set of #GFileMonitorFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, or %NULL. - * + * @file: input #GFile + * @flags: a set of #GFileMonitorFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, or %NULL + * * Obtains a directory monitor for the given file. * This may fail if directory monitoring is not supported. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * * Virtual: monitor_dir - * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error. + * Returns: (transfer full): a #GFileMonitor for the given @file, + * or %NULL on error. * Free the returned object with g_object_unref(). - **/ -GFileMonitor* -g_file_monitor_directory (GFile *file, - GFileMonitorFlags flags, - GCancellable *cancellable, - GError **error) + */ +GFileMonitor * +g_file_monitor_directory (GFile *file, + GFileMonitorFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; @@ -4743,30 +4878,32 @@ g_file_monitor_directory (GFile *file, /** * g_file_monitor_file: - * @file: input #GFile. - * @flags: a set of #GFileMonitorFlags. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @error: a #GError, or %NULL. - * + * @file: input #GFile + * @flags: a set of #GFileMonitorFlags + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @error: a #GError, or %NULL + * * Obtains a file monitor for the given file. If no file notification * mechanism exists, then regular polling of the file is used. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: (transfer full): a #GFileMonitor for the given @file, + * or %NULL on error. * Free the returned object with g_object_unref(). - **/ -GFileMonitor* -g_file_monitor_file (GFile *file, - GFileMonitorFlags flags, - GCancellable *cancellable, - GError **error) + */ +GFileMonitor * +g_file_monitor_file (GFile *file, + GFileMonitorFlags flags, + GCancellable *cancellable, + GError **error) { GFileIface *iface; GFileMonitor *monitor; - + g_return_val_if_fail (G_IS_FILE (file), NULL); if (g_cancellable_set_error_if_cancelled (cancellable, error)) @@ -4775,11 +4912,11 @@ g_file_monitor_file (GFile *file, iface = G_FILE_GET_IFACE (file); monitor = NULL; - + if (iface->monitor_file) monitor = (* iface->monitor_file) (file, flags, cancellable, NULL); -/* Fallback to polling */ + /* Fallback to polling */ if (monitor == NULL) monitor = _g_poll_file_monitor_new (file); @@ -4790,26 +4927,28 @@ g_file_monitor_file (GFile *file, * g_file_monitor: * @file: input #GFile * @flags: a set of #GFileMonitorFlags - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore * @error: a #GError, or %NULL - * - * Obtains a file or directory monitor for the given file, depending - * on the type of the file. + * + * Obtains a file or directory monitor for the given file, + * depending on the type of the file. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * Returns: (transfer full): a #GFileMonitor for the given @file, or %NULL on error. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * Returns: (transfer full): a #GFileMonitor for the given @file, + * or %NULL on error. * Free the returned object with g_object_unref(). * * Since: 2.18 */ -GFileMonitor* -g_file_monitor (GFile *file, - GFileMonitorFlags flags, - GCancellable *cancellable, - GError **error) +GFileMonitor * +g_file_monitor (GFile *file, + GFileMonitorFlags flags, + GCancellable *cancellable, + GError **error) { if (g_file_query_file_type (file, 0, cancellable) == G_FILE_TYPE_DIRECTORY) return g_file_monitor_directory (file, flags, cancellable, error); @@ -4838,15 +4977,14 @@ query_info_data_free (QueryInfoAsyncData *data) static void query_info_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GError *error = NULL; QueryInfoAsyncData *data; GFileInfo *info; - + data = g_simple_async_result_get_op_res_gpointer (res); - info = g_file_query_info (G_FILE (object), data->attributes, data->flags, cancellable, &error); if (info == NULL) @@ -4857,12 +4995,12 @@ query_info_async_thread (GSimpleAsyncResult *res, static void g_file_real_query_info_async (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *attributes, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; QueryInfoAsyncData *data; @@ -4870,18 +5008,18 @@ g_file_real_query_info_async (GFile *file, data = g_new0 (QueryInfoAsyncData, 1); data->attributes = g_strdup (attributes); data->flags = flags; - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_info_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_info_data_free); - + g_simple_async_result_run_in_thread (res, query_info_async_thread, io_priority, cancellable); g_object_unref (res); } static GFileInfo * g_file_real_query_info_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); QueryInfoAsyncData *data; @@ -4894,7 +5032,7 @@ g_file_real_query_info_finish (GFile *file, data = g_simple_async_result_get_op_res_gpointer (simple); if (data->info) return g_object_ref (data->info); - + return NULL; } @@ -4920,9 +5058,9 @@ query_filesystem_info_async_thread (GSimpleAsyncResult *res, GError *error = NULL; QueryFilesystemInfoAsyncData *data; GFileInfo *info; - + data = g_simple_async_result_get_op_res_gpointer (res); - + info = g_file_query_filesystem_info (G_FILE (object), data->attributes, cancellable, &error); if (info == NULL) @@ -4944,10 +5082,10 @@ g_file_real_query_filesystem_info_async (GFile *file, data = g_new0 (QueryFilesystemInfoAsyncData, 1); data->attributes = g_strdup (attributes); - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_query_filesystem_info_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)query_filesystem_info_data_free); - + g_simple_async_result_run_in_thread (res, query_filesystem_info_async_thread, io_priority, cancellable); g_object_unref (res); } @@ -4968,7 +5106,7 @@ g_file_real_query_filesystem_info_finish (GFile *file, data = g_simple_async_result_get_op_res_gpointer (simple); if (data->info) return g_object_ref (data->info); - + return NULL; } @@ -4989,15 +5127,15 @@ enumerate_children_data_free (EnumerateChildrenAsyncData *data) static void enumerate_children_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GError *error = NULL; EnumerateChildrenAsyncData *data; GFileEnumerator *enumerator; - + data = g_simple_async_result_get_op_res_gpointer (res); - + enumerator = g_file_enumerate_children (G_FILE (object), data->attributes, data->flags, cancellable, &error); if (enumerator == NULL) @@ -5008,12 +5146,12 @@ enumerate_children_async_thread (GSimpleAsyncResult *res, static void g_file_real_enumerate_children_async (GFile *file, - const char *attributes, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *attributes, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; EnumerateChildrenAsyncData *data; @@ -5021,18 +5159,18 @@ g_file_real_enumerate_children_async (GFile *file, data = g_new0 (EnumerateChildrenAsyncData, 1); data->attributes = g_strdup (attributes); data->flags = flags; - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_enumerate_children_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)enumerate_children_data_free); - + g_simple_async_result_run_in_thread (res, enumerate_children_async_thread, io_priority, cancellable); g_object_unref (res); } static GFileEnumerator * g_file_real_enumerate_children_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); EnumerateChildrenAsyncData *data; @@ -5045,14 +5183,14 @@ g_file_real_enumerate_children_finish (GFile *file, data = g_simple_async_result_get_op_res_gpointer (simple); if (data->enumerator) return g_object_ref (data->enumerator); - + return NULL; } static void open_read_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileInputStream *stream; @@ -5070,7 +5208,7 @@ open_read_async_thread (GSimpleAsyncResult *res, return; } - + stream = iface->read_fn (G_FILE (object), cancellable, &error); if (stream == NULL) @@ -5081,23 +5219,23 @@ open_read_async_thread (GSimpleAsyncResult *res, static void g_file_real_read_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_read_async); - + g_simple_async_result_run_in_thread (res, open_read_async_thread, io_priority, cancellable); g_object_unref (res); } static GFileInputStream * g_file_real_read_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); gpointer op; @@ -5110,14 +5248,14 @@ g_file_real_read_finish (GFile *file, op = g_simple_async_result_get_op_res_gpointer (simple); if (op) return g_object_ref (op); - + return NULL; } static void append_to_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileCreateFlags *data; @@ -5138,11 +5276,11 @@ append_to_async_thread (GSimpleAsyncResult *res, static void g_file_real_append_to_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileCreateFlags *data; GSimpleAsyncResult *res; @@ -5159,8 +5297,8 @@ g_file_real_append_to_async (GFile *file, static GFileOutputStream * g_file_real_append_to_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); gpointer op; @@ -5173,14 +5311,14 @@ g_file_real_append_to_finish (GFile *file, op = g_simple_async_result_get_op_res_gpointer (simple); if (op) return g_object_ref (op); - + return NULL; } static void create_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileCreateFlags *data; @@ -5201,11 +5339,11 @@ create_async_thread (GSimpleAsyncResult *res, static void g_file_real_create_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileCreateFlags *data; GSimpleAsyncResult *res; @@ -5222,8 +5360,8 @@ g_file_real_create_async (GFile *file, static GFileOutputStream * g_file_real_create_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); gpointer op; @@ -5236,7 +5374,7 @@ g_file_real_create_finish (GFile *file, op = g_simple_async_result_get_op_res_gpointer (simple); if (op) return g_object_ref (op); - + return NULL; } @@ -5258,8 +5396,8 @@ replace_async_data_free (ReplaceAsyncData *data) static void replace_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileOutputStream *stream; @@ -5267,15 +5405,15 @@ replace_async_thread (GSimpleAsyncResult *res, ReplaceAsyncData *data; iface = G_FILE_GET_IFACE (object); - + data = g_simple_async_result_get_op_res_gpointer (res); stream = iface->replace (G_FILE (object), - data->etag, - data->make_backup, - data->flags, - cancellable, - &error); + data->etag, + data->make_backup, + data->flags, + cancellable, + &error); if (stream == NULL) g_simple_async_result_take_error (res, error); @@ -5285,13 +5423,13 @@ replace_async_thread (GSimpleAsyncResult *res, static void g_file_real_replace_async (GFile *file, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; ReplaceAsyncData *data; @@ -5310,8 +5448,8 @@ g_file_real_replace_async (GFile *file, static GFileOutputStream * g_file_real_replace_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); ReplaceAsyncData *data; @@ -5324,7 +5462,7 @@ g_file_real_replace_finish (GFile *file, data = g_simple_async_result_get_op_res_gpointer (simple); if (data->stream) return g_object_ref (data->stream); - + return NULL; } @@ -5375,8 +5513,8 @@ g_file_real_delete_finish (GFile *file, static void open_readwrite_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileIOStream *stream; @@ -5405,10 +5543,10 @@ open_readwrite_async_thread (GSimpleAsyncResult *res, static void g_file_real_open_readwrite_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; @@ -5420,8 +5558,8 @@ g_file_real_open_readwrite_async (GFile *file, static GFileIOStream * g_file_real_open_readwrite_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); gpointer op; @@ -5440,8 +5578,8 @@ g_file_real_open_readwrite_finish (GFile *file, static void create_readwrite_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileCreateFlags *data; @@ -5473,11 +5611,11 @@ create_readwrite_async_thread (GSimpleAsyncResult *res, static void g_file_real_create_readwrite_async (GFile *file, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileCreateFlags *data; GSimpleAsyncResult *res; @@ -5530,8 +5668,8 @@ replace_rw_async_data_free (ReplaceRWAsyncData *data) static void replace_readwrite_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GFileIface *iface; GFileIOStream *stream; @@ -5543,11 +5681,11 @@ replace_readwrite_async_thread (GSimpleAsyncResult *res, data = g_simple_async_result_get_op_res_gpointer (res); stream = iface->replace_readwrite (G_FILE (object), - data->etag, - data->make_backup, - data->flags, - cancellable, - &error); + data->etag, + data->make_backup, + data->flags, + cancellable, + &error); if (stream == NULL) g_simple_async_result_take_error (res, error); @@ -5557,13 +5695,13 @@ replace_readwrite_async_thread (GSimpleAsyncResult *res, static void g_file_real_replace_readwrite_async (GFile *file, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; ReplaceRWAsyncData *data; @@ -5616,15 +5754,15 @@ set_display_name_data_free (SetDisplayNameAsyncData *data) static void set_display_name_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GError *error = NULL; SetDisplayNameAsyncData *data; GFile *file; - + data = g_simple_async_result_get_op_res_gpointer (res); - + file = g_file_set_display_name (G_FILE (object), data->name, cancellable, &error); if (file == NULL) @@ -5634,30 +5772,30 @@ set_display_name_async_thread (GSimpleAsyncResult *res, } static void -g_file_real_set_display_name_async (GFile *file, - const char *display_name, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) +g_file_real_set_display_name_async (GFile *file, + const char *display_name, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; SetDisplayNameAsyncData *data; data = g_new0 (SetDisplayNameAsyncData, 1); data->name = g_strdup (display_name); - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_display_name_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_display_name_data_free); - + g_simple_async_result_run_in_thread (res, set_display_name_async_thread, io_priority, cancellable); g_object_unref (res); } static GFile * g_file_real_set_display_name_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); SetDisplayNameAsyncData *data; @@ -5670,7 +5808,7 @@ g_file_real_set_display_name_finish (GFile *file, data = g_simple_async_result_get_op_res_gpointer (simple); if (data->file) return g_object_ref (data->file); - + return NULL; } @@ -5693,29 +5831,29 @@ set_info_data_free (SetInfoAsyncData *data) static void set_info_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { SetInfoAsyncData *data; - + data = g_simple_async_result_get_op_res_gpointer (res); - + data->error = NULL; data->res = g_file_set_attributes_from_info (G_FILE (object), - data->info, - data->flags, - cancellable, - &data->error); + data->info, + data->flags, + cancellable, + &data->error); } static void g_file_real_set_attributes_async (GFile *file, - GFileInfo *info, - GFileQueryInfoFlags flags, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GFileInfo *info, + GFileQueryInfoFlags flags, + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; SetInfoAsyncData *data; @@ -5723,44 +5861,44 @@ g_file_real_set_attributes_async (GFile *file, data = g_new0 (SetInfoAsyncData, 1); data->info = g_file_info_dup (info); data->flags = flags; - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_set_attributes_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)set_info_data_free); - + g_simple_async_result_run_in_thread (res, set_info_async_thread, io_priority, cancellable); g_object_unref (res); } static gboolean g_file_real_set_attributes_finish (GFile *file, - GAsyncResult *res, - GFileInfo **info, - GError **error) + GAsyncResult *res, + GFileInfo **info, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); SetInfoAsyncData *data; - + g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_real_set_attributes_async); data = g_simple_async_result_get_op_res_gpointer (simple); - if (info) + if (info) *info = g_object_ref (data->info); - if (error != NULL && data->error) + if (error != NULL && data->error) *error = g_error_copy (data->error); - + return data->res; } static void find_enclosing_mount_async_thread (GSimpleAsyncResult *res, - GObject *object, - GCancellable *cancellable) + GObject *object, + GCancellable *cancellable) { GError *error = NULL; GMount *mount; - + mount = g_file_find_enclosing_mount (G_FILE (object), cancellable, &error); if (mount == NULL) @@ -5771,23 +5909,23 @@ find_enclosing_mount_async_thread (GSimpleAsyncResult *res, static void g_file_real_find_enclosing_mount_async (GFile *file, - int io_priority, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + int io_priority, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; - + res = g_simple_async_result_new (G_OBJECT (file), callback, user_data, g_file_real_find_enclosing_mount_async); - + g_simple_async_result_run_in_thread (res, find_enclosing_mount_async_thread, io_priority, cancellable); g_object_unref (res); } static GMount * g_file_real_find_enclosing_mount_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); GMount *mount; @@ -5832,16 +5970,16 @@ copy_async_progress_in_main (gpointer user_data) CopyAsyncData *data = progress->data; data->progress_cb (progress->current_num_bytes, - progress->total_num_bytes, - data->progress_cb_data); + progress->total_num_bytes, + data->progress_cb_data); return FALSE; } static void copy_async_progress_callback (goffset current_num_bytes, - goffset total_num_bytes, - gpointer user_data) + goffset total_num_bytes, + gpointer user_data) { CopyAsyncData *data = user_data; ProgressData *progress; @@ -5850,17 +5988,17 @@ copy_async_progress_callback (goffset current_num_bytes, progress->data = data; progress->current_num_bytes = current_num_bytes; progress->total_num_bytes = total_num_bytes; - + g_io_scheduler_job_send_to_mainloop_async (data->job, - copy_async_progress_in_main, - progress, - g_free); + copy_async_progress_in_main, + progress, + g_free); } static gboolean copy_async_thread (GIOSchedulerJob *job, - GCancellable *cancellable, - gpointer user_data) + GCancellable *cancellable, + gpointer user_data) { GSimpleAsyncResult *res; CopyAsyncData *data; @@ -5873,12 +6011,12 @@ copy_async_thread (GIOSchedulerJob *job, error = NULL; data->job = job; result = g_file_copy (data->source, - data->destination, - data->flags, - cancellable, - (data->progress_cb != NULL) ? copy_async_progress_callback : NULL, - data, - &error); + data->destination, + data->flags, + cancellable, + (data->progress_cb != NULL) ? copy_async_progress_callback : NULL, + data, + &error); if (!result) g_simple_async_result_take_error (res, error); @@ -5890,14 +6028,14 @@ copy_async_thread (GIOSchedulerJob *job, static void g_file_real_copy_async (GFile *source, - GFile *destination, - GFileCopyFlags flags, - int io_priority, - GCancellable *cancellable, - GFileProgressCallback progress_callback, - gpointer progress_callback_data, - GAsyncReadyCallback callback, - gpointer user_data) + GFile *destination, + GFileCopyFlags flags, + int io_priority, + GCancellable *cancellable, + GFileProgressCallback progress_callback, + gpointer progress_callback_data, + GAsyncReadyCallback callback, + gpointer user_data) { GSimpleAsyncResult *res; CopyAsyncData *data; @@ -5917,8 +6055,8 @@ g_file_real_copy_async (GFile *source, static gboolean g_file_real_copy_finish (GFile *file, - GAsyncResult *res, - GError **error) + GAsyncResult *res, + GError **error) { GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (res); @@ -5935,16 +6073,16 @@ g_file_real_copy_finish (GFile *file, /** * g_file_new_for_path: - * @path: a string containing a relative or absolute path. The string - * must be encoded in the glib filename encoding. - * + * @path: a string containing a relative or absolute path. + * The string must be encoded in the glib filename encoding. + * * Constructs a #GFile for a given path. This operation never * fails, but the returned object might not support any I/O * operation if @path is malformed. - * + * * Returns: (transfer full): a new #GFile for the given @path. * Free the returned object with g_object_unref(). - **/ + */ GFile * g_file_new_for_path (const char *path) { @@ -5952,19 +6090,19 @@ g_file_new_for_path (const char *path) return g_vfs_get_file_for_path (g_vfs_get_default (), path); } - + /** * g_file_new_for_uri: - * @uri: a UTF8 string containing a URI. - * - * Constructs a #GFile for a given URI. This operation never - * fails, but the returned object might not support any I/O - * operation if @uri is malformed or if the uri type is + * @uri: a UTF-8 string containing a URI + * + * Constructs a #GFile for a given URI. This operation never + * fails, but the returned object might not support any I/O + * operation if @uri is malformed or if the uri type is * not supported. - * + * * Returns: (transfer full): a new #GFile for the given @uri. - * Free the returned object with g_object_unref(). - **/ + * Free the returned object with g_object_unref(). + */ GFile * g_file_new_for_uri (const char *uri) { @@ -5976,8 +6114,8 @@ g_file_new_for_uri (const char *uri) /** * g_file_new_tmp: * @tmpl: (type filename) (allow-none): Template for the file - * name, as in g_file_open_tmp(), or %NULL for a default template. - * @iostream: (out): on return, a #GFileIOStream for the created file. + * name, as in g_file_open_tmp(), or %NULL for a default template + * @iostream: (out): on return, a #GFileIOStream for the created file * @error: a #GError, or %NULL * * Opens a file in the preferred directory for temporary files (as @@ -5992,7 +6130,7 @@ g_file_new_for_uri (const char *uri) * a temporary file could not be created. * * Returns: (transfer full): a new #GFile. - * Free the returned object with g_object_unref(). + * Free the returned object with g_object_unref(). * * Since: 2.32 */ @@ -6025,14 +6163,15 @@ g_file_new_tmp (const char *tmpl, /** * g_file_parse_name: - * @parse_name: a file name or path to be parsed. - * - * Constructs a #GFile with the given @parse_name (i.e. something given by g_file_get_parse_name()). - * This operation never fails, but the returned object might not support any I/O - * operation if the @parse_name cannot be parsed. - * + * @parse_name: a file name or path to be parsed + * + * Constructs a #GFile with the given @parse_name (i.e. something + * given by g_file_get_parse_name()). This operation never fails, + * but the returned object might not support any I/O operation if + * the @parse_name cannot be parsed. + * * Returns: (transfer full): a new #GFile. - **/ + */ GFile * g_file_parse_name (const char *parse_name) { @@ -6054,9 +6193,9 @@ static gboolean has_valid_scheme (const char *uri) { const char *p; - + p = uri; - + if (!g_ascii_isalpha (*p)) return FALSE; @@ -6069,68 +6208,72 @@ has_valid_scheme (const char *uri) /** * g_file_new_for_commandline_arg: - * @arg: a command line string. - * - * Creates a #GFile with the given argument from the command line. The value of - * @arg can be either a URI, an absolute path or a relative path resolved - * relative to the current working directory. - * This operation never fails, but the returned object might not support any - * I/O operation if @arg points to a malformed path. + * @arg: a command line string + * + * Creates a #GFile with the given argument from the command line. + * The value of @arg can be either a URI, an absolute path or a + * relative path resolved relative to the current working directory. + * This operation never fails, but the returned object might not + * support any I/O operation if @arg points to a malformed path. * * Returns: (transfer full): a new #GFile. - * Free the returned object with g_object_unref(). - **/ + * Free the returned object with g_object_unref(). + */ GFile * g_file_new_for_commandline_arg (const char *arg) { GFile *file; char *filename; char *current_dir; - + g_return_val_if_fail (arg != NULL, NULL); - + if (g_path_is_absolute (arg)) return g_file_new_for_path (arg); if (has_valid_scheme (arg)) return g_file_new_for_uri (arg); - + current_dir = g_get_current_dir (); filename = g_build_filename (current_dir, arg, NULL); g_free (current_dir); - + file = g_file_new_for_path (filename); g_free (filename); - + return file; } /** * g_file_mount_enclosing_volume: - * @location: input #GFile. + * @location: input #GFile * @flags: flags affecting the operation - * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @mount_operation: (allow-none): a #GMountOperation + * or %NULL to avoid user interaction + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: the data to pass to callback function - * - * Starts a @mount_operation, mounting the volume that contains the file @location. - * + * + * Starts a @mount_operation, mounting the volume that contains + * the file @location. + * * When this operation has completed, @callback will be called with - * @user_user data, and the operation can be finalized with + * @user_user data, and the operation can be finalized with * g_file_mount_enclosing_volume_finish(). - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + */ void g_file_mount_enclosing_volume (GFile *location, - GMountMountFlags flags, - GMountOperation *mount_operation, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GMountMountFlags flags, + GMountOperation *mount_operation, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -6141,33 +6284,33 @@ g_file_mount_enclosing_volume (GFile *location, if (iface->mount_enclosing_volume == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (location), - callback, user_data, - G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, - _("volume doesn't implement mount")); - + callback, user_data, + G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, + _("volume doesn't implement mount")); + return; } - + (* iface->mount_enclosing_volume) (location, flags, mount_operation, cancellable, callback, user_data); } /** * g_file_mount_enclosing_volume_finish: - * @location: input #GFile. - * @result: a #GAsyncResult. + * @location: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL - * + * * Finishes a mount operation started by g_file_mount_enclosing_volume(). - * - * Returns: %TRUE if successful. If an error - * has occurred, this function will return %FALSE and set @error - * appropriately if present. - **/ + * + * Returns: %TRUE if successful. If an error has occurred, + * this function will return %FALSE and set @error + * appropriately if present. + */ gboolean g_file_mount_enclosing_volume_finish (GFile *location, - GAsyncResult *result, - GError **error) + GAsyncResult *result, + GError **error) { GFileIface *iface; @@ -6188,8 +6331,8 @@ g_file_mount_enclosing_volume_finish (GFile *location, /** * g_file_query_default_handler: - * @file: a #GFile to open. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @file: a #GFile to open + * @cancellable: optional #GCancellable object, %NULL to ignore * @error: a #GError, or %NULL * * Returns the #GAppInfo that is registered as the default @@ -6197,22 +6340,23 @@ g_file_mount_enclosing_volume_finish (GFile *location, * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * Returns: (transfer full): a #GAppInfo if the handle was found, %NULL if there were errors. - * When you are done with it, release it with g_object_unref() - **/ + * Returns: (transfer full): a #GAppInfo if the handle was found, + * %NULL if there were errors. + * When you are done with it, release it with g_object_unref() + */ GAppInfo * -g_file_query_default_handler (GFile *file, - GCancellable *cancellable, - GError **error) +g_file_query_default_handler (GFile *file, + GCancellable *cancellable, + GError **error) { char *uri_scheme; const char *content_type; GAppInfo *appinfo; GFileInfo *info; char *path; - + uri_scheme = g_file_get_uri_scheme (file); if (uri_scheme && uri_scheme[0] != '\0') { @@ -6224,10 +6368,10 @@ g_file_query_default_handler (GFile *file, } info = g_file_query_info (file, - G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE, - 0, - cancellable, - error); + G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE, + 0, + cancellable, + error); if (info == NULL) return NULL; @@ -6239,10 +6383,10 @@ g_file_query_default_handler (GFile *file, /* Don't use is_native(), as we want to support fuse paths if available */ path = g_file_get_path (file); appinfo = g_app_info_get_default_for_type (content_type, - path == NULL); + path == NULL); g_free (path); } - + g_object_unref (info); if (appinfo != NULL) @@ -6252,42 +6396,40 @@ g_file_query_default_handler (GFile *file, G_IO_ERROR_NOT_SUPPORTED, _("No application is registered as handling this file")); return NULL; - } - #define GET_CONTENT_BLOCK_SIZE 8192 /** * g_file_load_contents: - * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file. + * @file: input #GFile + * @cancellable: optional #GCancellable object, %NULL to ignore + * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file * @length: (out) (allow-none): a location to place the length of the contents of the file, * or %NULL if the length is not needed * @etag_out: (out) (allow-none): a location to place the current entity tag for the file, * or %NULL if the entity tag is not needed * @error: a #GError, or %NULL * - * Loads the content of the file into memory. The data is always + * Loads the content of the file into memory. The data is always * zero-terminated, but this is not included in the resultant @length. * The returned @content should be freed with g_free() when no longer * needed. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * * Returns: %TRUE if the @file's contents were successfully loaded. - * %FALSE if there were errors. - **/ + * %FALSE if there were errors. + */ gboolean g_file_load_contents (GFile *file, - GCancellable *cancellable, - char **contents, - gsize *length, - char **etag_out, - GError **error) + GCancellable *cancellable, + char **contents, + gsize *length, + char **etag_out, + GError **error) { GFileInputStream *in; GByteArray *content; @@ -6304,12 +6446,12 @@ g_file_load_contents (GFile *file, content = g_byte_array_new (); pos = 0; - + g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1); while ((res = g_input_stream_read (G_INPUT_STREAM (in), - content->data + pos, - GET_CONTENT_BLOCK_SIZE, - cancellable, error)) > 0) + content->data + pos, + GET_CONTENT_BLOCK_SIZE, + cancellable, error)) > 0) { pos += res; g_byte_array_set_size (content, pos + GET_CONTENT_BLOCK_SIZE + 1); @@ -6318,17 +6460,17 @@ g_file_load_contents (GFile *file, if (etag_out) { *etag_out = NULL; - + info = g_file_input_stream_query_info (in, - G_FILE_ATTRIBUTE_ETAG_VALUE, - cancellable, - NULL); + G_FILE_ATTRIBUTE_ETAG_VALUE, + cancellable, + NULL); if (info) - { - *etag_out = g_strdup (g_file_info_get_etag (info)); - g_object_unref (info); - } - } + { + *etag_out = g_strdup (g_file_info_get_etag (info)); + g_object_unref (info); + } + } /* Ignore errors on close */ g_input_stream_close (G_INPUT_STREAM (in), cancellable, NULL); @@ -6346,9 +6488,9 @@ g_file_load_contents (GFile *file, /* Zero terminate (we got an extra byte allocated for this */ content->data[pos] = 0; - + *contents = (char *)g_byte_array_free (content, FALSE); - + return TRUE; } @@ -6381,8 +6523,8 @@ load_contents_data_free (LoadContentsData *data) static void load_contents_close_callback (GObject *obj, - GAsyncResult *close_res, - gpointer user_data) + GAsyncResult *close_res, + gpointer user_data) { GInputStream *stream = G_INPUT_STREAM (obj); LoadContentsData *data = user_data; @@ -6393,9 +6535,9 @@ load_contents_close_callback (GObject *obj, g_object_unref (stream); res = g_simple_async_result_new (G_OBJECT (data->file), - data->callback, - data->user_data, - g_file_load_contents_async); + data->callback, + data->user_data, + g_file_load_contents_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)load_contents_data_free); g_simple_async_result_complete (res); g_object_unref (res); @@ -6403,15 +6545,15 @@ load_contents_close_callback (GObject *obj, static void load_contents_fstat_callback (GObject *obj, - GAsyncResult *stat_res, - gpointer user_data) + GAsyncResult *stat_res, + gpointer user_data) { GInputStream *stream = G_INPUT_STREAM (obj); LoadContentsData *data = user_data; GFileInfo *info; info = g_file_input_stream_query_info_finish (G_FILE_INPUT_STREAM (stream), - stat_res, NULL); + stat_res, NULL); if (info) { data->etag = g_strdup (g_file_info_get_etag (info)); @@ -6419,14 +6561,14 @@ load_contents_fstat_callback (GObject *obj, } g_input_stream_close_async (stream, 0, - data->cancellable, - load_contents_close_callback, data); + data->cancellable, + load_contents_close_callback, data); } static void load_contents_read_callback (GObject *obj, - GAsyncResult *read_res, - gpointer user_data) + GAsyncResult *read_res, + gpointer user_data) { GInputStream *stream = G_INPUT_STREAM (obj); LoadContentsData *data = user_data; @@ -6435,54 +6577,54 @@ load_contents_read_callback (GObject *obj, read_size = g_input_stream_read_finish (stream, read_res, &error); - if (read_size < 0) + if (read_size < 0) { /* Error or EOF, close the file */ data->error = error; g_input_stream_close_async (stream, 0, - data->cancellable, - load_contents_close_callback, data); + data->cancellable, + load_contents_close_callback, data); } else if (read_size == 0) { g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream), - G_FILE_ATTRIBUTE_ETAG_VALUE, - 0, - data->cancellable, - load_contents_fstat_callback, - data); + G_FILE_ATTRIBUTE_ETAG_VALUE, + 0, + data->cancellable, + load_contents_fstat_callback, + data); } else if (read_size > 0) { data->pos += read_size; - + g_byte_array_set_size (data->content, - data->pos + GET_CONTENT_BLOCK_SIZE); + data->pos + GET_CONTENT_BLOCK_SIZE); if (data->read_more_callback && - !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data)) - g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream), - G_FILE_ATTRIBUTE_ETAG_VALUE, - 0, - data->cancellable, - load_contents_fstat_callback, - data); - else - g_input_stream_read_async (stream, - data->content->data + data->pos, - GET_CONTENT_BLOCK_SIZE, - 0, - data->cancellable, - load_contents_read_callback, - data); + !data->read_more_callback ((char *)data->content->data, data->pos, data->user_data)) + g_file_input_stream_query_info_async (G_FILE_INPUT_STREAM (stream), + G_FILE_ATTRIBUTE_ETAG_VALUE, + 0, + data->cancellable, + load_contents_fstat_callback, + data); + else + g_input_stream_read_async (stream, + data->content->data + data->pos, + GET_CONTENT_BLOCK_SIZE, + 0, + data->cancellable, + load_contents_read_callback, + data); } } static void load_contents_open_callback (GObject *obj, - GAsyncResult *open_res, - gpointer user_data) + GAsyncResult *open_res, + gpointer user_data) { GFile *file = G_FILE (obj); GFileInputStream *stream; @@ -6495,22 +6637,21 @@ load_contents_open_callback (GObject *obj, if (stream) { g_byte_array_set_size (data->content, - data->pos + GET_CONTENT_BLOCK_SIZE); + data->pos + GET_CONTENT_BLOCK_SIZE); g_input_stream_read_async (G_INPUT_STREAM (stream), - data->content->data + data->pos, - GET_CONTENT_BLOCK_SIZE, - 0, - data->cancellable, - load_contents_read_callback, - data); - + data->content->data + data->pos, + GET_CONTENT_BLOCK_SIZE, + 0, + data->cancellable, + load_contents_read_callback, + data); } else { res = g_simple_async_result_new_take_error (G_OBJECT (data->file), - data->callback, - data->user_data, - error); + data->callback, + data->user_data, + error); g_simple_async_result_complete (res); load_contents_data_free (data); g_object_unref (res); @@ -6519,30 +6660,31 @@ load_contents_open_callback (GObject *obj, /** * g_file_load_partial_contents_async: (skip) - * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @read_more_callback: a #GFileReadMoreCallback to receive partial data and to specify whether further data should be read. + * @file: input #GFile + * @cancellable: optional #GCancellable object, %NULL to ignore + * @read_more_callback: a #GFileReadMoreCallback to receive partial data + * and to specify whether further data should be read * @callback: a #GAsyncReadyCallback to call when the request is satisfied - * @user_data: the data to pass to the callback functions. + * @user_data: the data to pass to the callback functions * - * Reads the partial contents of a file. A #GFileReadMoreCallback should be - * used to stop reading from the file when appropriate, else this function - * will behave exactly as g_file_load_contents_async(). This operation - * can be finished by g_file_load_partial_contents_finish(). + * Reads the partial contents of a file. A #GFileReadMoreCallback should + * be used to stop reading from the file when appropriate, else this + * function will behave exactly as g_file_load_contents_async(). This + * operation can be finished by g_file_load_partial_contents_finish(). * - * Users of this function should be aware that @user_data is passed to + * Users of this function should be aware that @user_data is passed to * both the @read_more_callback and the @callback. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + */ void g_file_load_partial_contents_async (GFile *file, - GCancellable *cancellable, - GFileReadMoreCallback read_more_callback, - GAsyncReadyCallback callback, - gpointer user_data) + GCancellable *cancellable, + GFileReadMoreCallback read_more_callback, + GAsyncReadyCallback callback, + gpointer user_data) { LoadContentsData *data; @@ -6559,39 +6701,39 @@ g_file_load_partial_contents_async (GFile *file, data->file = g_object_ref (file); g_file_read_async (file, - 0, - cancellable, - load_contents_open_callback, - data); + 0, + cancellable, + load_contents_open_callback, + data); } /** * g_file_load_partial_contents_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. - * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file. + * @file: input #GFile + * @res: a #GAsyncResult + * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file * @length: (out) (allow-none): a location to place the length of the contents of the file, * or %NULL if the length is not needed * @etag_out: (out) (allow-none): a location to place the current entity tag for the file, * or %NULL if the entity tag is not needed * @error: a #GError, or %NULL - * + * * Finishes an asynchronous partial load operation that was started - * with g_file_load_partial_contents_async(). The data is always + * with g_file_load_partial_contents_async(). The data is always * zero-terminated, but this is not included in the resultant @length. * The returned @content should be freed with g_free() when no longer * needed. * - * Returns: %TRUE if the load was successful. If %FALSE and @error is - * present, it will be set appropriately. - **/ + * Returns: %TRUE if the load was successful. If %FALSE and @error is + * present, it will be set appropriately. + */ gboolean g_file_load_partial_contents_finish (GFile *file, - GAsyncResult *res, - char **contents, - gsize *length, - char **etag_out, - GError **error) + GAsyncResult *res, + char **contents, + gsize *length, + char **etag_out, + GError **error) { GSimpleAsyncResult *simple; LoadContentsData *data; @@ -6604,9 +6746,9 @@ g_file_load_partial_contents_finish (GFile *file, if (g_simple_async_result_propagate_error (simple, error)) return FALSE; - + g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_load_contents_async); - + data = g_simple_async_result_get_op_res_gpointer (simple); if (data->error) @@ -6615,7 +6757,7 @@ g_file_load_partial_contents_finish (GFile *file, data->error = NULL; *contents = NULL; if (length) - *length = 0; + *length = 0; return FALSE; } @@ -6631,7 +6773,7 @@ g_file_load_partial_contents_finish (GFile *file, /* Zero terminate */ g_byte_array_set_size (data->content, data->pos + 1); data->content->data[data->pos] = 0; - + *contents = (char *)g_byte_array_free (data->content, FALSE); data->content = NULL; @@ -6640,116 +6782,116 @@ g_file_load_partial_contents_finish (GFile *file, /** * g_file_load_contents_async: - * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @file: input #GFile + * @cancellable: optional #GCancellable object, %NULL to ignore * @callback: a #GAsyncReadyCallback to call when the request is satisfied * @user_data: the data to pass to callback function - * + * * Starts an asynchronous load of the @file's contents. * * For more details, see g_file_load_contents() which is * the synchronous version of this call. * - * When the load operation has completed, @callback will be called - * with @user data. To finish the operation, call - * g_file_load_contents_finish() with the #GAsyncResult returned by + * When the load operation has completed, @callback will be called + * with @user data. To finish the operation, call + * g_file_load_contents_finish() with the #GAsyncResult returned by * the @callback. - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - **/ + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + */ void g_file_load_contents_async (GFile *file, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { g_file_load_partial_contents_async (file, - cancellable, - NULL, - callback, user_data); + cancellable, + NULL, + callback, user_data); } /** * g_file_load_contents_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. - * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file. + * @file: input #GFile + * @res: a #GAsyncResult + * @contents: (out) (transfer full) (element-type guint8) (array length=length): a location to place the contents of the file * @length: (out) (allow-none): a location to place the length of the contents of the file, * or %NULL if the length is not needed * @etag_out: (out) (allow-none): a location to place the current entity tag for the file, * or %NULL if the entity tag is not needed * @error: a #GError, or %NULL - * - * Finishes an asynchronous load of the @file's contents. - * The contents are placed in @contents, and @length is set to the + * + * Finishes an asynchronous load of the @file's contents. + * The contents are placed in @contents, and @length is set to the * size of the @contents string. The @content should be freed with - * g_free() when no longer needed. If @etag_out is present, it will be + * g_free() when no longer needed. If @etag_out is present, it will be * set to the new entity tag for the @file. - * - * Returns: %TRUE if the load was successful. If %FALSE and @error is - * present, it will be set appropriately. - **/ + * + * Returns: %TRUE if the load was successful. If %FALSE and @error is + * present, it will be set appropriately. + */ gboolean g_file_load_contents_finish (GFile *file, - GAsyncResult *res, - char **contents, - gsize *length, - char **etag_out, - GError **error) + GAsyncResult *res, + char **contents, + gsize *length, + char **etag_out, + GError **error) { return g_file_load_partial_contents_finish (file, - res, - contents, - length, - etag_out, - error); + res, + contents, + length, + etag_out, + error); } - + /** * g_file_replace_contents: - * @file: input #GFile. - * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file. - * @length: the length of @contents in bytes. - * @etag: (allow-none): the old entity tag + * @file: input #GFile + * @contents: (element-type guint8) (array length=length): a string containing the new contents for @file + * @length: the length of @contents in bytes + * @etag: (allow-none): the old entity tag * for the document, or %NULL - * @make_backup: %TRUE if a backup should be created. - * @flags: a set of #GFileCreateFlags. + * @make_backup: %TRUE if a backup should be created + * @flags: a set of #GFileCreateFlags * @new_etag: (allow-none) (out): a location to a new entity tag - * for the document. This should be freed with g_free() when no longer + * for the document. This should be freed with g_free() when no longer * needed, or %NULL - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @cancellable: optional #GCancellable object, %NULL to ignore * @error: a #GError, or %NULL * * Replaces the contents of @file with @contents of @length bytes. - - * If @etag is specified (not %NULL) any existing file must have that etag, or - * the error %G_IO_ERROR_WRONG_ETAG will be returned. * - * If @make_backup is %TRUE, this function will attempt to make a backup of @file. - * + * If @etag is specified (not %NULL), any existing file must have that etag, + * or the error %G_IO_ERROR_WRONG_ETAG will be returned. + * + * If @make_backup is %TRUE, this function will attempt to make a backup + * of @file. + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * The returned @new_etag can be used to verify that the file hasn't changed the - * next time it is saved over. - * - * Returns: %TRUE if successful. If an error - * has occurred, this function will return %FALSE and set @error - * appropriately if present. - **/ + * The returned @new_etag can be used to verify that the file hasn't + * changed the next time it is saved over. + * + * Returns: %TRUE if successful. If an error has occurred, this function + * will return %FALSE and set @error appropriately if present. + */ gboolean g_file_replace_contents (GFile *file, - const char *contents, - gsize length, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - char **new_etag, - GCancellable *cancellable, - GError **error) + const char *contents, + gsize length, + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + char **new_etag, + GCancellable *cancellable, + GError **error) { GFileOutputStream *out; gsize pos, remainder; @@ -6766,16 +6908,16 @@ g_file_replace_contents (GFile *file, pos = 0; remainder = length; while (remainder > 0 && - (res = g_output_stream_write (G_OUTPUT_STREAM (out), - contents + pos, - MIN (remainder, GET_CONTENT_BLOCK_SIZE), - cancellable, - error)) > 0) + (res = g_output_stream_write (G_OUTPUT_STREAM (out), + contents + pos, + MIN (remainder, GET_CONTENT_BLOCK_SIZE), + cancellable, + error)) > 0) { pos += res; remainder -= res; } - + if (remainder > 0 && res < 0) { /* Ignore errors on close */ @@ -6785,7 +6927,7 @@ g_file_replace_contents (GFile *file, /* error is set already */ return FALSE; } - + ret = g_output_stream_close (G_OUTPUT_STREAM (out), cancellable, error); if (new_etag) @@ -6822,8 +6964,8 @@ replace_contents_data_free (ReplaceContentsData *data) static void replace_contents_close_callback (GObject *obj, - GAsyncResult *close_res, - gpointer user_data) + GAsyncResult *close_res, + gpointer user_data) { GOutputStream *stream = G_OUTPUT_STREAM (obj); ReplaceContentsData *data = user_data; @@ -6834,11 +6976,11 @@ replace_contents_close_callback (GObject *obj, g_object_unref (stream); data->etag = g_file_output_stream_get_etag (G_FILE_OUTPUT_STREAM (stream)); - + res = g_simple_async_result_new (G_OBJECT (data->file), - data->callback, - data->user_data, - g_file_replace_contents_async); + data->callback, + data->user_data, + g_file_replace_contents_async); g_simple_async_result_set_op_res_gpointer (res, data, (GDestroyNotify)replace_contents_data_free); g_simple_async_result_complete (res); g_object_unref (res); @@ -6846,48 +6988,48 @@ replace_contents_close_callback (GObject *obj, static void replace_contents_write_callback (GObject *obj, - GAsyncResult *read_res, - gpointer user_data) + GAsyncResult *read_res, + gpointer user_data) { GOutputStream *stream = G_OUTPUT_STREAM (obj); ReplaceContentsData *data = user_data; GError *error = NULL; gssize write_size; - + write_size = g_output_stream_write_finish (stream, read_res, &error); - if (write_size <= 0) + if (write_size <= 0) { /* Error or EOF, close the file */ if (write_size < 0) - data->error = error; + data->error = error; g_output_stream_close_async (stream, 0, - data->cancellable, - replace_contents_close_callback, data); + data->cancellable, + replace_contents_close_callback, data); } else if (write_size > 0) { data->pos += write_size; if (data->pos >= data->length) - g_output_stream_close_async (stream, 0, - data->cancellable, - replace_contents_close_callback, data); + g_output_stream_close_async (stream, 0, + data->cancellable, + replace_contents_close_callback, data); else - g_output_stream_write_async (stream, - data->content + data->pos, - data->length - data->pos, - 0, - data->cancellable, - replace_contents_write_callback, - data); + g_output_stream_write_async (stream, + data->content + data->pos, + data->length - data->pos, + 0, + data->cancellable, + replace_contents_write_callback, + data); } } static void replace_contents_open_callback (GObject *obj, - GAsyncResult *open_res, - gpointer user_data) + GAsyncResult *open_res, + gpointer user_data) { GFile *file = G_FILE (obj); GFileOutputStream *stream; @@ -6900,20 +7042,19 @@ replace_contents_open_callback (GObject *obj, if (stream) { g_output_stream_write_async (G_OUTPUT_STREAM (stream), - data->content + data->pos, - data->length - data->pos, - 0, - data->cancellable, - replace_contents_write_callback, - data); - + data->content + data->pos, + data->length - data->pos, + 0, + data->cancellable, + replace_contents_write_callback, + data); } else { res = g_simple_async_result_new_take_error (G_OBJECT (data->file), - data->callback, - data->user_data, - error); + data->callback, + data->user_data, + error); g_simple_async_result_complete (res); replace_contents_data_free (data); g_object_unref (res); @@ -6922,41 +7063,41 @@ replace_contents_open_callback (GObject *obj, /** * g_file_replace_contents_async: - * @file: input #GFile. - * @contents: (element-type guint8) (array length=length): string of contents to replace the file with. - * @length: the length of @contents in bytes. + * @file: input #GFile + * @contents: (element-type guint8) (array length=length): string of contents to replace the file with + * @length: the length of @contents in bytes * @etag: (allow-none): a new entity tag for the @file, or %NULL - * @make_backup: %TRUE if a backup should be created. - * @flags: a set of #GFileCreateFlags. - * @cancellable: optional #GCancellable object, %NULL to ignore. + * @make_backup: %TRUE if a backup should be created + * @flags: a set of #GFileCreateFlags + * @cancellable: optional #GCancellable object, %NULL to ignore * @callback: a #GAsyncReadyCallback to call when the request is satisfied * @user_data: the data to pass to callback function - * - * Starts an asynchronous replacement of @file with the given - * @contents of @length bytes. @etag will replace the document's + * + * Starts an asynchronous replacement of @file with the given + * @contents of @length bytes. @etag will replace the document's * current entity tag. - * + * * When this operation has completed, @callback will be called with - * @user_user data, and the operation can be finalized with + * @user_user data, and the operation can be finalized with * g_file_replace_contents_finish(). - * + * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation - * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. - * - * If @make_backup is %TRUE, this function will attempt to + * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. + * + * If @make_backup is %TRUE, this function will attempt to * make a backup of @file. - **/ + */ void g_file_replace_contents_async (GFile *file, - const char *contents, - gsize length, - const char *etag, - gboolean make_backup, - GFileCreateFlags flags, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) + const char *contents, + gsize length, + const char *etag, + gboolean make_backup, + GFileCreateFlags flags, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { ReplaceContentsData *data; @@ -6975,35 +7116,35 @@ g_file_replace_contents_async (GFile *file, data->file = g_object_ref (file); g_file_replace_async (file, - etag, - make_backup, - flags, - 0, - cancellable, - replace_contents_open_callback, - data); + etag, + make_backup, + flags, + 0, + cancellable, + replace_contents_open_callback, + data); } - + /** * g_file_replace_contents_finish: - * @file: input #GFile. - * @res: a #GAsyncResult. - * @new_etag: (out) (allow-none): a location of a new entity tag - * for the document. This should be freed with g_free() when it is no + * @file: input #GFile + * @res: a #GAsyncResult + * @new_etag: (out) (allow-none): a location of a new entity tag + * for the document. This should be freed with g_free() when it is no * longer needed, or %NULL - * @error: a #GError, or %NULL - * + * @error: a #GError, or %NULL + * * Finishes an asynchronous replace of the given @file. See - * g_file_replace_contents_async(). Sets @new_etag to the new entity + * g_file_replace_contents_async(). Sets @new_etag to the new entity * tag for the document, if present. - * + * * Returns: %TRUE on success, %FALSE on failure. - **/ + */ gboolean g_file_replace_contents_finish (GFile *file, - GAsyncResult *res, - char **new_etag, - GError **error) + GAsyncResult *res, + char **new_etag, + GError **error) { GSimpleAsyncResult *simple; ReplaceContentsData *data; @@ -7015,9 +7156,9 @@ g_file_replace_contents_finish (GFile *file, if (g_simple_async_result_propagate_error (simple, error)) return FALSE; - + g_warn_if_fail (g_simple_async_result_get_source_tag (simple) == g_file_replace_contents_async); - + data = g_simple_async_result_get_op_res_gpointer (simple); if (data->error) @@ -7027,26 +7168,25 @@ g_file_replace_contents_finish (GFile *file, return FALSE; } - if (new_etag) { *new_etag = data->etag; data->etag = NULL; /* Take ownership */ } - + return TRUE; } /** * g_file_start_mountable: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @start_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL * @user_data: the data to pass to callback function * - * Starts a file of type G_FILE_TYPE_MOUNTABLE. + * Starts a file of type #G_FILE_TYPE_MOUNTABLE. * Using @start_operation, you can request callbacks when, for instance, * passwords are needed during authentication. * @@ -7054,18 +7194,19 @@ g_file_replace_contents_finish (GFile *file, * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * When the operation is finished, @callback will be called. You can then call - * g_file_mount_mountable_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_mount_mountable_finish() to get + * the result of the operation. * * Since: 2.22 */ void -g_file_start_mountable (GFile *file, - GDriveStartFlags flags, - GMountOperation *start_operation, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) +g_file_start_mountable (GFile *file, + GDriveStartFlags flags, + GMountOperation *start_operation, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -7076,26 +7217,26 @@ g_file_start_mountable (GFile *file, if (iface->start_mountable == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } (* iface->start_mountable) (file, - flags, - start_operation, - cancellable, - callback, - user_data); + flags, + start_operation, + cancellable, + callback, + user_data); } /** * g_file_start_mountable_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes a start operation. See g_file_start_mountable() for details. @@ -7109,9 +7250,9 @@ g_file_start_mountable (GFile *file, * Since: 2.22 */ gboolean -g_file_start_mountable_finish (GFile *file, - GAsyncResult *result, - GError **error) +g_file_start_mountable_finish (GFile *file, + GAsyncResult *result, + GError **error) { GFileIface *iface; @@ -7127,31 +7268,35 @@ g_file_start_mountable_finish (GFile *file, /** * g_file_stop_mountable: - * @file: input #GFile. + * @file: input #GFile * @flags: flags affecting the operation - * @mount_operation: (allow-none): a #GMountOperation, or %NULL to avoid user interaction. - * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore. - * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @mount_operation: (allow-none): a #GMountOperation, + * or %NULL to avoid user interaction. + * @cancellable: (allow-none): optional #GCancellable object, + * %NULL to ignore + * @callback: (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: the data to pass to callback function * - * Stops a file of type G_FILE_TYPE_MOUNTABLE. + * Stops a file of type #G_FILE_TYPE_MOUNTABLE. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * When the operation is finished, @callback will be called. You can then call - * g_file_stop_mountable_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_stop_mountable_finish() to get + * the result of the operation. * * Since: 2.22 */ void -g_file_stop_mountable (GFile *file, - GMountUnmountFlags flags, - GMountOperation *mount_operation, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) +g_file_stop_mountable (GFile *file, + GMountUnmountFlags flags, + GMountOperation *mount_operation, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -7162,11 +7307,11 @@ g_file_stop_mountable (GFile *file, if (iface->stop_mountable == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } @@ -7180,8 +7325,8 @@ g_file_stop_mountable (GFile *file, /** * g_file_stop_mountable_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes an stop operation, see g_file_stop_mountable() for details. @@ -7189,15 +7334,15 @@ g_file_stop_mountable (GFile *file, * Finish an asynchronous stop operation that was started * with g_file_stop_mountable(). * - * Returns: %TRUE if the operation finished successfully. %FALSE - * otherwise. + * Returns: %TRUE if the operation finished successfully. + * %FALSE otherwise. * * Since: 2.22 */ gboolean -g_file_stop_mountable_finish (GFile *file, - GAsyncResult *result, - GError **error) +g_file_stop_mountable_finish (GFile *file, + GAsyncResult *result, + GError **error) { GFileIface *iface; @@ -7213,27 +7358,29 @@ g_file_stop_mountable_finish (GFile *file, /** * g_file_poll_mountable: - * @file: input #GFile. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: (allow-none): a #GAsyncReadyCallback to call when the request is satisfied, or %NULL. + * @file: input #GFile + * @cancellable: optional #GCancellable object, %NULL to ignore + * @callback: (allow-none): a #GAsyncReadyCallback to call + * when the request is satisfied, or %NULL * @user_data: the data to pass to callback function * - * Polls a file of type G_FILE_TYPE_MOUNTABLE. + * Polls a file of type #G_FILE_TYPE_MOUNTABLE. * * If @cancellable is not %NULL, then the operation can be cancelled by * triggering the cancellable object from another thread. If the operation * was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * - * When the operation is finished, @callback will be called. You can then call - * g_file_mount_mountable_finish() to get the result of the operation. + * When the operation is finished, @callback will be called. + * You can then call g_file_mount_mountable_finish() to get + * the result of the operation. * * Since: 2.22 */ void -g_file_poll_mountable (GFile *file, - GCancellable *cancellable, - GAsyncReadyCallback callback, - gpointer user_data) +g_file_poll_mountable (GFile *file, + GCancellable *cancellable, + GAsyncReadyCallback callback, + gpointer user_data) { GFileIface *iface; @@ -7244,11 +7391,11 @@ g_file_poll_mountable (GFile *file, if (iface->poll_mountable == NULL) { g_simple_async_report_error_in_idle (G_OBJECT (file), - callback, - user_data, - G_IO_ERROR, - G_IO_ERROR_NOT_SUPPORTED, - _("Operation not supported")); + callback, + user_data, + G_IO_ERROR, + G_IO_ERROR_NOT_SUPPORTED, + _("Operation not supported")); return; } @@ -7260,8 +7407,8 @@ g_file_poll_mountable (GFile *file, /** * g_file_poll_mountable_finish: - * @file: input #GFile. - * @result: a #GAsyncResult. + * @file: input #GFile + * @result: a #GAsyncResult * @error: a #GError, or %NULL * * Finishes a poll operation. See g_file_poll_mountable() for details. @@ -7275,9 +7422,9 @@ g_file_poll_mountable (GFile *file, * Since: 2.22 */ gboolean -g_file_poll_mountable_finish (GFile *file, - GAsyncResult *result, - GError **error) +g_file_poll_mountable_finish (GFile *file, + GAsyncResult *result, + GError **error) { GFileIface *iface; @@ -7293,7 +7440,7 @@ g_file_poll_mountable_finish (GFile *file, /** * g_file_supports_thread_contexts: - * @file: a #GFile. + * @file: a #GFile * * Checks if @file supports thread-default