X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=gio%2Fgvolume.c;h=a14cbc61379ddd93a1b792401521a8b66217168a;hb=4482977238ae80f64c2fe318d1500f4662c73980;hp=3768b690589a10bbe19c7737e77998c16b5dca9d;hpb=7c36619d269284597d5df4f366b6389df9bcf617;p=platform%2Fupstream%2Fglib.git diff --git a/gio/gvolume.c b/gio/gvolume.c index 3768b69..a14cbc6 100644 --- a/gio/gvolume.c +++ b/gio/gvolume.c @@ -13,9 +13,7 @@ * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General - * Public License along with this library; if not, write to the - * Free Software Foundation, Inc., 59 Temple Place, Suite 330, - * Boston, MA 02111-1307, USA. + * Public License along with this library; if not, see . * * Author: Alexander Larsson * David Zeuthen @@ -24,12 +22,12 @@ #include "config.h" #include "gmount.h" #include "gvolume.h" +#include "gthemedicon.h" #include "gasyncresult.h" -#include "gsimpleasyncresult.h" +#include "gtask.h" #include "gioerror.h" #include "glibintl.h" -#include "gioalias.h" /** * SECTION:gvolume @@ -41,10 +39,10 @@ * equivalent of #GnomeVFSDrive. * * Mounting a #GVolume instance is an asynchronous operation. For more - * information about asynchronous operations, see #GAsyncReady and - * #GSimpleAsyncReady. To mount a #GVolume, first call - * g_volume_mount() with (at least) the #GVolume instance, optionally - * a #GMountOperation object and a #GAsyncReadyCallback. + * information about asynchronous operations, see #GAsyncResult and + * #GTask. To mount a #GVolume, first call g_volume_mount() with (at + * least) the #GVolume instance, optionally a #GMountOperation object + * and a #GAsyncReadyCallback. * * Typically, one will only want to pass %NULL for the * #GMountOperation if automounting all volumes when a desktop session @@ -59,24 +57,24 @@ * successfully. If an @error is present when g_volume_mount_finish() * is called, then it will be filled with any error information. * - * + * ## Volume Identifiers # {#volume-identifier} + * * It is sometimes necessary to directly access the underlying * operating system object behind a volume (e.g. for passing a volume * to an application via the commandline). For this purpose, GIO * allows to obtain an 'identifier' for the volume. There can be * different kinds of identifiers, such as Hal UDIs, filesystem labels, - * traditional Unix devices (e.g. /dev/sda2), - * uuids. GIO uses predefind strings as names for the different kinds - * of identifiers: #G_VOLUME_IDENTIFIER_KIND_HAL_UDI, - * #G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use g_volume_get_identifier() - * to obtain an identifier for a volume. - * + * traditional Unix devices (e.g. `/dev/sda2`), UUIDs. GIO uses predefined + * strings as names for the different kinds of identifiers: + * #G_VOLUME_IDENTIFIER_KIND_HAL_UDI, #G_VOLUME_IDENTIFIER_KIND_LABEL, etc. + * Use g_volume_get_identifier() to obtain an identifier for a volume. + * * * Note that #G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available * when the gvfs hal volume monitor is in use. Other volume monitors * will generally be able to provide the #G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE * identifier, which can be used to obtain a hal device by means of - * libhal_manger_find_device_string_match(). + * libhal_manager_find_device_string_match(). */ typedef GVolumeIface GVolumeInterface; @@ -89,7 +87,7 @@ g_volume_default_init (GVolumeInterface *iface) * GVolume::changed: * * Emitted when the volume has been changed. - **/ + */ g_signal_new (I_("changed"), G_TYPE_VOLUME, G_SIGNAL_RUN_LAST, @@ -104,7 +102,7 @@ g_volume_default_init (GVolumeInterface *iface) * This signal is emitted when the #GVolume have been removed. If * the recipient is holding references to the object they should * release them so the object can be finalized. - **/ + */ g_signal_new (I_("removed"), G_TYPE_VOLUME, G_SIGNAL_RUN_LAST, @@ -116,13 +114,13 @@ g_volume_default_init (GVolumeInterface *iface) /** * g_volume_get_name: - * @volume: a #GVolume. + * @volume: a #GVolume * * Gets the name of @volume. * * Returns: the name for the given @volume. The returned string should - * be freed with g_free() when no longer needed. - **/ + * be freed with g_free() when no longer needed. + */ char * g_volume_get_name (GVolume *volume) { @@ -137,14 +135,14 @@ g_volume_get_name (GVolume *volume) /** * g_volume_get_icon: - * @volume: a #GVolume. + * @volume: a #GVolume * * Gets the icon for @volume. * * Returns: (transfer full): a #GIcon. * The returned object should be unreffed with g_object_unref() * when no longer needed. - **/ + */ GIcon * g_volume_get_icon (GVolume *volume) { @@ -158,8 +156,39 @@ g_volume_get_icon (GVolume *volume) } /** + * g_volume_get_symbolic_icon: + * @volume: a #GVolume + * + * Gets the symbolic icon for @volume. + * + * Returns: (transfer full): a #GIcon. + * The returned object should be unreffed with g_object_unref() + * when no longer needed. + * + * Since: 2.34 + */ +GIcon * +g_volume_get_symbolic_icon (GVolume *volume) +{ + GVolumeIface *iface; + GIcon *ret; + + g_return_val_if_fail (G_IS_VOLUME (volume), NULL); + + iface = G_VOLUME_GET_IFACE (volume); + + if (iface->get_symbolic_icon != NULL) + ret = iface->get_symbolic_icon (volume); + else + ret = g_themed_icon_new_with_default_fallbacks ("folder-remote-symbolic"); + + return ret; + +} + +/** * g_volume_get_uuid: - * @volume: a #GVolume. + * @volume: a #GVolume * * Gets the UUID for the @volume. The reference is typically based on * the file system UUID for the volume in question and should be @@ -169,7 +198,7 @@ g_volume_get_icon (GVolume *volume) * Returns: the UUID for @volume or %NULL if no UUID can be computed. * The returned string should be freed with g_free() * when no longer needed. - **/ + */ char * g_volume_get_uuid (GVolume *volume) { @@ -184,14 +213,14 @@ g_volume_get_uuid (GVolume *volume) /** * g_volume_get_drive: - * @volume: a #GVolume. + * @volume: a #GVolume * * Gets the drive for the @volume. * - * Returns: (transfer full): a #GDrive or %NULL if @volume is not associated with a drive. - * The returned object should be unreffed with g_object_unref() - * when no longer needed. - **/ + * Returns: (transfer full): a #GDrive or %NULL if @volume is not + * associated with a drive. The returned object should be unreffed + * with g_object_unref() when no longer needed. + */ GDrive * g_volume_get_drive (GVolume *volume) { @@ -206,14 +235,14 @@ g_volume_get_drive (GVolume *volume) /** * g_volume_get_mount: - * @volume: a #GVolume. + * @volume: a #GVolume * * Gets the mount for the @volume. * * Returns: (transfer full): a #GMount or %NULL if @volume isn't mounted. * The returned object should be unreffed with g_object_unref() * when no longer needed. - **/ + */ GMount * g_volume_get_mount (GVolume *volume) { @@ -229,12 +258,12 @@ g_volume_get_mount (GVolume *volume) /** * g_volume_can_mount: - * @volume: a #GVolume. + * @volume: a #GVolume * * Checks if a volume can be mounted. * - * Returns: %TRUE if the @volume can be mounted. %FALSE otherwise. - **/ + * Returns: %TRUE if the @volume can be mounted. %FALSE otherwise + */ gboolean g_volume_can_mount (GVolume *volume) { @@ -252,12 +281,12 @@ g_volume_can_mount (GVolume *volume) /** * g_volume_can_eject: - * @volume: a #GVolume. + * @volume: a #GVolume * * Checks if a volume can be ejected. * - * Returns: %TRUE if the @volume can be ejected. %FALSE otherwise. - **/ + * Returns: %TRUE if the @volume can be ejected. %FALSE otherwise + */ gboolean g_volume_can_eject (GVolume *volume) { @@ -279,7 +308,7 @@ g_volume_can_eject (GVolume *volume) * * Returns whether the volume should be automatically mounted. * - * Returns: %TRUE if the volume should be automatically mounted. + * Returns: %TRUE if the volume should be automatically mounted */ gboolean g_volume_should_automount (GVolume *volume) @@ -299,17 +328,19 @@ g_volume_should_automount (GVolume *volume) /** * g_volume_mount: - * @volume: a #GVolume. + * @volume: a #GVolume * @flags: flags affecting the operation - * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid user interaction. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback, 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, or %NULL * @user_data: user data that gets passed to @callback * * Mounts a volume. This is an asynchronous operation, and is * finished by calling g_volume_mount_finish() with the @volume * and #GAsyncResult returned in the @callback. - **/ + * + * Virtual: mount_fn + */ void g_volume_mount (GVolume *volume, GMountMountFlags flags, @@ -326,10 +357,10 @@ g_volume_mount (GVolume *volume, if (iface->mount_fn == NULL) { - g_simple_async_report_error_in_idle (G_OBJECT (volume), callback, user_data, - G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, - _("volume doesn't implement mount")); - + g_task_report_new_error (volume, callback, user_data, + g_volume_mount, + G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, + _("volume doesn't implement mount")); return; } @@ -342,7 +373,7 @@ g_volume_mount (GVolume *volume, * @result: a #GAsyncResult * @error: a #GError location to store an error, or %NULL to ignore * - * Finishes mounting a volume. If any errors occured during the operation, + * Finishes mounting a volume. If any errors occurred during the operation, * @error will be set to contain the errors and %FALSE will be returned. * * If the mount operation succeeded, g_volume_get_mount() on @volume @@ -350,8 +381,8 @@ g_volume_mount (GVolume *volume, * function; there's no need to listen for the 'mount-added' signal on * #GVolumeMonitor. * - * Returns: %TRUE, %FALSE if operation failed. - **/ + * Returns: %TRUE, %FALSE if operation failed + */ gboolean g_volume_mount_finish (GVolume *volume, GAsyncResult *result, @@ -362,12 +393,10 @@ g_volume_mount_finish (GVolume *volume, g_return_val_if_fail (G_IS_VOLUME (volume), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); - if (G_IS_SIMPLE_ASYNC_RESULT (result)) - { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - if (g_simple_async_result_propagate_error (simple, error)) - return FALSE; - } + if (g_async_result_legacy_propagate_error (result, error)) + return FALSE; + else if (g_async_result_is_tagged (result, g_volume_mount)) + return g_task_propagate_boolean (G_TASK (result), error); iface = G_VOLUME_GET_IFACE (volume); return (* iface->mount_finish) (volume, result, error); @@ -375,10 +404,10 @@ g_volume_mount_finish (GVolume *volume, /** * g_volume_eject: - * @volume: a #GVolume. + * @volume: a #GVolume * @flags: flags affecting the unmount if required for eject - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback, or %NULL. + * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore + * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL * @user_data: user data that gets passed to @callback * * Ejects a volume. This is an asynchronous operation, and is @@ -386,7 +415,7 @@ g_volume_mount_finish (GVolume *volume, * and #GAsyncResult returned in the @callback. * * Deprecated: 2.22: Use g_volume_eject_with_operation() instead. - **/ + */ void g_volume_eject (GVolume *volume, GMountUnmountFlags flags, @@ -402,10 +431,10 @@ g_volume_eject (GVolume *volume, if (iface->eject == NULL) { - g_simple_async_report_error_in_idle (G_OBJECT (volume), callback, user_data, - G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, - _("volume doesn't implement eject")); - + g_task_report_new_error (volume, callback, user_data, + g_volume_eject_with_operation, + G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, + _("volume doesn't implement eject")); return; } @@ -414,14 +443,14 @@ g_volume_eject (GVolume *volume, /** * g_volume_eject_finish: - * @volume: pointer to a #GVolume. - * @result: a #GAsyncResult. + * @volume: pointer to a #GVolume + * @result: a #GAsyncResult * @error: a #GError location to store an error, or %NULL to ignore * - * Finishes ejecting a volume. If any errors occured during the operation, + * Finishes ejecting a volume. If any errors occurred during the operation, * @error will be set to contain the errors and %FALSE will be returned. * - * Returns: %TRUE, %FALSE if operation failed. + * Returns: %TRUE, %FALSE if operation failed * * Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead. **/ @@ -435,12 +464,10 @@ g_volume_eject_finish (GVolume *volume, g_return_val_if_fail (G_IS_VOLUME (volume), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); - if (G_IS_SIMPLE_ASYNC_RESULT (result)) - { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - if (g_simple_async_result_propagate_error (simple, error)) - return FALSE; - } + if (g_async_result_legacy_propagate_error (result, error)) + return FALSE; + if (g_async_result_is_tagged (result, g_volume_eject_with_operation)) + return g_task_propagate_boolean (G_TASK (result), error); iface = G_VOLUME_GET_IFACE (volume); return (* iface->eject_finish) (volume, result, error); @@ -448,12 +475,13 @@ g_volume_eject_finish (GVolume *volume, /** * g_volume_eject_with_operation: - * @volume: a #GVolume. + * @volume: a #GVolume * @flags: flags affecting the unmount if required for eject - * @mount_operation: a #GMountOperation or %NULL to avoid user interaction. - * @cancellable: optional #GCancellable object, %NULL to ignore. - * @callback: a #GAsyncReadyCallback, or %NULL. - * @user_data: user data passed to @callback. + * @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, or %NULL + * @user_data: user data passed to @callback * * Ejects a volume. This is an asynchronous operation, and is * finished by calling g_volume_eject_with_operation_finish() with the @volume @@ -477,13 +505,13 @@ g_volume_eject_with_operation (GVolume *volume, if (iface->eject == NULL && iface->eject_with_operation == NULL) { - g_simple_async_report_error_in_idle (G_OBJECT (volume), - callback, user_data, - G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, - /* Translators: This is an error - * message for volume objects that - * don't implement any of eject or eject_with_operation. */ - _("volume doesn't implement eject or eject_with_operation")); + g_task_report_new_error (volume, callback, user_data, + g_volume_eject_with_operation, + G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED, + /* Translators: This is an error + * message for volume objects that + * don't implement any of eject or eject_with_operation. */ + _("volume doesn't implement eject or eject_with_operation")); return; } @@ -495,15 +523,14 @@ g_volume_eject_with_operation (GVolume *volume, /** * g_volume_eject_with_operation_finish: - * @volume: a #GVolume. - * @result: a #GAsyncResult. - * @error: a #GError location to store the error occuring, or %NULL to - * ignore. + * @volume: a #GVolume + * @result: a #GAsyncResult + * @error: a #GError location to store the error occurring, or %NULL * * Finishes ejecting a volume. If any errors occurred during the operation, * @error will be set to contain the errors and %FALSE will be returned. * - * Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise. + * Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise * * Since: 2.22 **/ @@ -517,12 +544,10 @@ g_volume_eject_with_operation_finish (GVolume *volume, g_return_val_if_fail (G_IS_VOLUME (volume), FALSE); g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE); - if (G_IS_SIMPLE_ASYNC_RESULT (result)) - { - GSimpleAsyncResult *simple = G_SIMPLE_ASYNC_RESULT (result); - if (g_simple_async_result_propagate_error (simple, error)) - return FALSE; - } + if (g_async_result_legacy_propagate_error (result, error)) + return FALSE; + else if (g_async_result_is_tagged (result, g_volume_eject_with_operation)) + return g_task_propagate_boolean (G_TASK (result), error); iface = G_VOLUME_GET_IFACE (volume); if (iface->eject_with_operation_finish != NULL) @@ -537,12 +562,12 @@ g_volume_eject_with_operation_finish (GVolume *volume, * @kind: the kind of identifier to return * * Gets the identifier of the given kind for @volume. - * See the introduction - * for more information about volume identifiers. + * See the [introduction][volume-identifier] for more + * information about volume identifiers. * * Returns: a newly allocated string containing the - * requested identfier, or %NULL if the #GVolume - * doesn't have this kind of identifier + * requested identfier, or %NULL if the #GVolume + * doesn't have this kind of identifier */ char * g_volume_get_identifier (GVolume *volume, @@ -565,12 +590,11 @@ g_volume_get_identifier (GVolume *volume, * g_volume_enumerate_identifiers: * @volume: a #GVolume * - * Gets the kinds of identifiers - * that @volume has. Use g_volume_get_identifer() to obtain - * the identifiers themselves. + * Gets the kinds of [identifiers][volume-identifier] that @volume has. + * Use g_volume_get_identifier() to obtain the identifiers themselves. * - * Returns: a %NULL-terminated array of strings containing - * kinds of identifiers. Use g_strfreev() to free. + * Returns: (array zero-terminated=1) (transfer full): a %NULL-terminated array + * of strings containing kinds of identifiers. Use g_strfreev() to free. */ char ** g_volume_enumerate_identifiers (GVolume *volume) @@ -597,34 +621,31 @@ g_volume_enumerate_identifiers (GVolume *volume) * either be equal or a prefix of what this function returns. In * other words, in code * - * + * |[ * GMount *mount; * GFile *mount_root * GFile *volume_activation_root; * - * mount = g_volume_get_mount (volume); /* mounted, so never NULL */ + * mount = g_volume_get_mount (volume); // mounted, so never NULL * mount_root = g_mount_get_root (mount); - * volume_activation_root = g_volume_get_activation_root(volume); /* assume not NULL */ - * - * + * volume_activation_root = g_volume_get_activation_root (volume); // assume not NULL + * ]| * then the expression - * - * + * |[ * (g_file_has_prefix (volume_activation_root, mount_root) || g_file_equal (volume_activation_root, mount_root)) - * - * + * ]| * will always be %TRUE. * * Activation roots are typically used in #GVolumeMonitor * implementations to find the underlying mount to shadow, see * g_mount_is_shadowed() for more details. * - * Returns: the activation root of @volume or %NULL. Use - * g_object_unref() to free. + * Returns: (nullable) (transfer full): the activation root of @volume + * or %NULL. Use g_object_unref() to free. * * Since: 2.18 - **/ + */ GFile * g_volume_get_activation_root (GVolume *volume) { @@ -639,7 +660,27 @@ g_volume_get_activation_root (GVolume *volume) return (* iface->get_activation_root) (volume); } +/** + * g_volume_get_sort_key: + * @volume: a #GVolume + * + * Gets the sort key for @volume, if any. + * + * Returns: Sorting key for @volume or %NULL if no such key is available + * + * Since: 2.32 + */ +const gchar * +g_volume_get_sort_key (GVolume *volume) +{ + const gchar *ret = NULL; + GVolumeIface *iface; + g_return_val_if_fail (G_IS_VOLUME (volume), NULL); -#define __G_VOLUME_C__ -#include "gioaliasdef.c" + iface = G_VOLUME_GET_IFACE (volume); + if (iface->get_sort_key != NULL) + ret = iface->get_sort_key (volume); + + return ret; +}