1 /* -*- mode: C; c-file-style: "gnu"; indent-tabs-mode: nil; -*- */
3 /* GIO - GLib Input, Output and Streaming Library
5 * Copyright (C) 2006-2008 Red Hat, Inc.
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General
18 * Public License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
20 * Boston, MA 02111-1307, USA.
22 * Author: Alexander Larsson <alexl@redhat.com>
23 * David Zeuthen <davidz@redhat.com>
31 #include "gmountprivate.h"
32 #include "gasyncresult.h"
33 #include "gsimpleasyncresult.h"
40 * @short_description: Mount management
42 * @see_also: GVolume, GUnixMount
44 * The #GMount interface represents user-visible mounts. Note, when
45 * porting from GnomeVFS, #GMount is the moral equivalent of #GnomeVFSVolume.
47 * #GMount is a "mounted" filesystem that you can access. Mounted is in
48 * quotes because it's not the same as a unix mount, it might be a gvfs
49 * mount, but you can still access the files on it if you use GIO. Might or
50 * might not be related to a volume object.
52 * Unmounting a #GMount instance is an asynchronous operation. For
53 * more information about asynchronous operations, see #GAsyncReady
54 * and #GSimpleAsyncReady. To unmount a #GMount instance, first call
55 * g_mount_unmount_with_operation() with (at least) the #GMount instance and a
56 * #GAsyncReadyCallback. The callback will be fired when the
57 * operation has resolved (either with success or failure), and a
58 * #GAsyncReady structure will be passed to the callback. That
59 * callback should then call g_mount_unmount_with_operation_finish() with the #GMount
60 * and the #GAsyncReady data to see if the operation was completed
61 * successfully. If an @error is present when g_mount_unmount_with_operation_finish()
62 * is called, then it will be filled with any error information.
65 typedef GMountIface GMountInterface
;
66 G_DEFINE_INTERFACE (GMount
, g_mount
, G_TYPE_OBJECT
)
69 g_mount_default_init (GMountInterface
*iface
)
73 * @mount: the object on which the signal is emitted
75 * Emitted when the mount has been changed.
77 g_signal_new (I_("changed"),
80 G_STRUCT_OFFSET (GMountIface
, changed
),
82 g_cclosure_marshal_VOID__VOID
,
87 * @mount: the object on which the signal is emitted
89 * This signal is emitted when the #GMount have been
90 * unmounted. If the recipient is holding references to the
91 * object they should release them so the object can be
94 g_signal_new (I_("unmounted"),
97 G_STRUCT_OFFSET (GMountIface
, unmounted
),
99 g_cclosure_marshal_VOID__VOID
,
102 * GMount::pre-unmount:
103 * @mount: the object on which the signal is emitted
105 * This signal is emitted when the #GMount is about to be
110 g_signal_new (I_("pre-unmount"),
113 G_STRUCT_OFFSET (GMountIface
, pre_unmount
),
115 g_cclosure_marshal_VOID__VOID
,
123 * Gets the root directory on @mount.
125 * Returns: (transfer full): a #GFile.
126 * The returned object should be unreffed with
127 * g_object_unref() when no longer needed.
130 g_mount_get_root (GMount
*mount
)
134 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
136 iface
= G_MOUNT_GET_IFACE (mount
);
138 return (* iface
->get_root
) (mount
);
142 * g_mount_get_default_location:
145 * Gets the default location of @mount. The default location of the given
146 * @mount is a path that reflects the main entry point for the user (e.g.
147 * the home directory, or the root of the volume).
149 * Returns: (transfer full): a #GFile.
150 * The returned object should be unreffed with
151 * g_object_unref() when no longer needed.
154 g_mount_get_default_location (GMount
*mount
)
159 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
161 iface
= G_MOUNT_GET_IFACE (mount
);
163 /* Fallback to get_root when default_location () is not available */
164 if (iface
->get_default_location
)
165 file
= (* iface
->get_default_location
) (mount
);
167 file
= (* iface
->get_root
) (mount
);
176 * Gets the name of @mount.
178 * Returns: the name for the given @mount.
179 * The returned string should be freed with g_free()
180 * when no longer needed.
183 g_mount_get_name (GMount
*mount
)
187 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
189 iface
= G_MOUNT_GET_IFACE (mount
);
191 return (* iface
->get_name
) (mount
);
198 * Gets the icon for @mount.
200 * Returns: (transfer full): a #GIcon.
201 * The returned object should be unreffed with
202 * g_object_unref() when no longer needed.
205 g_mount_get_icon (GMount
*mount
)
209 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
211 iface
= G_MOUNT_GET_IFACE (mount
);
213 return (* iface
->get_icon
) (mount
);
220 * Gets the UUID for the @mount. The reference is typically based on
221 * the file system UUID for the mount in question and should be
222 * considered an opaque string. Returns %NULL if there is no UUID
225 * Returns: the UUID for @mount or %NULL if no UUID can be computed.
226 * The returned string should be freed with g_free()
227 * when no longer needed.
230 g_mount_get_uuid (GMount
*mount
)
234 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
236 iface
= G_MOUNT_GET_IFACE (mount
);
238 return (* iface
->get_uuid
) (mount
);
242 * g_mount_get_volume:
245 * Gets the volume for the @mount.
247 * Returns: (transfer full): a #GVolume or %NULL if @mount is not associated with a volume.
248 * The returned object should be unreffed with
249 * g_object_unref() when no longer needed.
252 g_mount_get_volume (GMount
*mount
)
256 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
258 iface
= G_MOUNT_GET_IFACE (mount
);
260 return (* iface
->get_volume
) (mount
);
267 * Gets the drive for the @mount.
269 * This is a convenience method for getting the #GVolume and then
270 * using that object to get the #GDrive.
272 * Returns: (transfer full): a #GDrive or %NULL if @mount is not associated with a volume or a drive.
273 * The returned object should be unreffed with
274 * g_object_unref() when no longer needed.
277 g_mount_get_drive (GMount
*mount
)
281 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
283 iface
= G_MOUNT_GET_IFACE (mount
);
285 return (* iface
->get_drive
) (mount
);
289 * g_mount_can_unmount:
292 * Checks if @mount can be mounted.
294 * Returns: %TRUE if the @mount can be unmounted.
297 g_mount_can_unmount (GMount
*mount
)
301 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
303 iface
= G_MOUNT_GET_IFACE (mount
);
305 return (* iface
->can_unmount
) (mount
);
312 * Checks if @mount can be eject.
314 * Returns: %TRUE if the @mount can be ejected.
317 g_mount_can_eject (GMount
*mount
)
321 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
323 iface
= G_MOUNT_GET_IFACE (mount
);
325 return (* iface
->can_eject
) (mount
);
331 * @flags: flags affecting the operation
332 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
333 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
334 * @user_data: user data passed to @callback.
336 * Unmounts a mount. This is an asynchronous operation, and is
337 * finished by calling g_mount_unmount_finish() with the @mount
338 * and #GAsyncResult data returned in the @callback.
340 * Deprecated: 2.22: Use g_mount_unmount_with_operation() instead.
343 g_mount_unmount (GMount
*mount
,
344 GMountUnmountFlags flags
,
345 GCancellable
*cancellable
,
346 GAsyncReadyCallback callback
,
351 g_return_if_fail (G_IS_MOUNT (mount
));
353 iface
= G_MOUNT_GET_IFACE (mount
);
355 if (iface
->unmount
== NULL
)
357 g_simple_async_report_error_in_idle (G_OBJECT (mount
),
359 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
360 /* Translators: This is an error
361 * message for mount objects that
362 * don't implement unmount. */
363 _("mount doesn't implement \"unmount\""));
368 (* iface
->unmount
) (mount
, flags
, cancellable
, callback
, user_data
);
372 * g_mount_unmount_finish:
374 * @result: a #GAsyncResult.
375 * @error: a #GError location to store the error occurring, or %NULL to
378 * Finishes unmounting a mount. If any errors occurred during the operation,
379 * @error will be set to contain the errors and %FALSE will be returned.
381 * Returns: %TRUE if the mount was successfully unmounted. %FALSE otherwise.
383 * Deprecated: 2.22: Use g_mount_unmount_with_operation_finish() instead.
386 g_mount_unmount_finish (GMount
*mount
,
387 GAsyncResult
*result
,
392 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
393 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
395 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
397 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
398 if (g_simple_async_result_propagate_error (simple
, error
))
402 iface
= G_MOUNT_GET_IFACE (mount
);
403 return (* iface
->unmount_finish
) (mount
, result
, error
);
410 * @flags: flags affecting the unmount if required for eject
411 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
412 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
413 * @user_data: user data passed to @callback.
415 * Ejects a mount. This is an asynchronous operation, and is
416 * finished by calling g_mount_eject_finish() with the @mount
417 * and #GAsyncResult data returned in the @callback.
419 * Deprecated: 2.22: Use g_mount_eject_with_operation() instead.
422 g_mount_eject (GMount
*mount
,
423 GMountUnmountFlags flags
,
424 GCancellable
*cancellable
,
425 GAsyncReadyCallback callback
,
430 g_return_if_fail (G_IS_MOUNT (mount
));
432 iface
= G_MOUNT_GET_IFACE (mount
);
434 if (iface
->eject
== NULL
)
436 g_simple_async_report_error_in_idle (G_OBJECT (mount
),
438 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
439 /* Translators: This is an error
440 * message for mount objects that
441 * don't implement eject. */
442 _("mount doesn't implement \"eject\""));
447 (* iface
->eject
) (mount
, flags
, cancellable
, callback
, user_data
);
451 * g_mount_eject_finish:
453 * @result: a #GAsyncResult.
454 * @error: a #GError location to store the error occurring, or %NULL to
457 * Finishes ejecting a mount. If any errors occurred during the operation,
458 * @error will be set to contain the errors and %FALSE will be returned.
460 * Returns: %TRUE if the mount was successfully ejected. %FALSE otherwise.
462 * Deprecated: 2.22: Use g_mount_eject_with_operation_finish() instead.
465 g_mount_eject_finish (GMount
*mount
,
466 GAsyncResult
*result
,
471 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
472 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
474 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
476 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
477 if (g_simple_async_result_propagate_error (simple
, error
))
481 iface
= G_MOUNT_GET_IFACE (mount
);
482 return (* iface
->eject_finish
) (mount
, result
, error
);
486 * g_mount_unmount_with_operation:
488 * @flags: flags affecting the operation
489 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
491 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
492 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
493 * @user_data: user data passed to @callback.
495 * Unmounts a mount. This is an asynchronous operation, and is
496 * finished by calling g_mount_unmount_with_operation_finish() with the @mount
497 * and #GAsyncResult data returned in the @callback.
502 g_mount_unmount_with_operation (GMount
*mount
,
503 GMountUnmountFlags flags
,
504 GMountOperation
*mount_operation
,
505 GCancellable
*cancellable
,
506 GAsyncReadyCallback callback
,
511 g_return_if_fail (G_IS_MOUNT (mount
));
513 iface
= G_MOUNT_GET_IFACE (mount
);
515 if (iface
->unmount
== NULL
&& iface
->unmount_with_operation
== NULL
)
517 g_simple_async_report_error_in_idle (G_OBJECT (mount
),
519 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
520 /* Translators: This is an error
521 * message for mount objects that
522 * don't implement any of unmount or unmount_with_operation. */
523 _("mount doesn't implement \"unmount\" or \"unmount_with_operation\""));
528 if (iface
->unmount_with_operation
!= NULL
)
529 (* iface
->unmount_with_operation
) (mount
, flags
, mount_operation
, cancellable
, callback
, user_data
);
531 (* iface
->unmount
) (mount
, flags
, cancellable
, callback
, user_data
);
535 * g_mount_unmount_with_operation_finish:
537 * @result: a #GAsyncResult.
538 * @error: a #GError location to store the error occurring, or %NULL to
541 * Finishes unmounting a mount. If any errors occurred during the operation,
542 * @error will be set to contain the errors and %FALSE will be returned.
544 * Returns: %TRUE if the mount was successfully unmounted. %FALSE otherwise.
549 g_mount_unmount_with_operation_finish (GMount
*mount
,
550 GAsyncResult
*result
,
555 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
556 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
558 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
560 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
561 if (g_simple_async_result_propagate_error (simple
, error
))
565 iface
= G_MOUNT_GET_IFACE (mount
);
566 if (iface
->unmount_with_operation_finish
!= NULL
)
567 return (* iface
->unmount_with_operation_finish
) (mount
, result
, error
);
569 return (* iface
->unmount_finish
) (mount
, result
, error
);
574 * g_mount_eject_with_operation:
576 * @flags: flags affecting the unmount if required for eject
577 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
579 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
580 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
581 * @user_data: user data passed to @callback.
583 * Ejects a mount. This is an asynchronous operation, and is
584 * finished by calling g_mount_eject_with_operation_finish() with the @mount
585 * and #GAsyncResult data returned in the @callback.
590 g_mount_eject_with_operation (GMount
*mount
,
591 GMountUnmountFlags flags
,
592 GMountOperation
*mount_operation
,
593 GCancellable
*cancellable
,
594 GAsyncReadyCallback callback
,
599 g_return_if_fail (G_IS_MOUNT (mount
));
601 iface
= G_MOUNT_GET_IFACE (mount
);
603 if (iface
->eject
== NULL
&& iface
->eject_with_operation
== NULL
)
605 g_simple_async_report_error_in_idle (G_OBJECT (mount
),
607 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
608 /* Translators: This is an error
609 * message for mount objects that
610 * don't implement any of eject or eject_with_operation. */
611 _("mount doesn't implement \"eject\" or \"eject_with_operation\""));
615 if (iface
->eject_with_operation
!= NULL
)
616 (* iface
->eject_with_operation
) (mount
, flags
, mount_operation
, cancellable
, callback
, user_data
);
618 (* iface
->eject
) (mount
, flags
, cancellable
, callback
, user_data
);
622 * g_mount_eject_with_operation_finish:
624 * @result: a #GAsyncResult.
625 * @error: a #GError location to store the error occurring, or %NULL to
628 * Finishes ejecting a mount. If any errors occurred during the operation,
629 * @error will be set to contain the errors and %FALSE will be returned.
631 * Returns: %TRUE if the mount was successfully ejected. %FALSE otherwise.
636 g_mount_eject_with_operation_finish (GMount
*mount
,
637 GAsyncResult
*result
,
642 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
643 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
645 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
647 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
648 if (g_simple_async_result_propagate_error (simple
, error
))
652 iface
= G_MOUNT_GET_IFACE (mount
);
653 if (iface
->eject_with_operation_finish
!= NULL
)
654 return (* iface
->eject_with_operation_finish
) (mount
, result
, error
);
656 return (* iface
->eject_finish
) (mount
, result
, error
);
662 * @flags: flags affecting the operation
663 * @mount_operation: (allow-none): a #GMountOperation or %NULL to avoid
665 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore.
666 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL.
667 * @user_data: user data passed to @callback.
669 * Remounts a mount. This is an asynchronous operation, and is
670 * finished by calling g_mount_remount_finish() with the @mount
671 * and #GAsyncResults data returned in the @callback.
673 * Remounting is useful when some setting affecting the operation
674 * of the volume has been changed, as these may need a remount to
675 * take affect. While this is semantically equivalent with unmounting
676 * and then remounting not all backends might need to actually be
680 g_mount_remount (GMount
*mount
,
681 GMountMountFlags flags
,
682 GMountOperation
*mount_operation
,
683 GCancellable
*cancellable
,
684 GAsyncReadyCallback callback
,
689 g_return_if_fail (G_IS_MOUNT (mount
));
691 iface
= G_MOUNT_GET_IFACE (mount
);
693 if (iface
->remount
== NULL
)
695 g_simple_async_report_error_in_idle (G_OBJECT (mount
),
697 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
698 /* Translators: This is an error
699 * message for mount objects that
700 * don't implement remount. */
701 _("mount doesn't implement \"remount\""));
706 (* iface
->remount
) (mount
, flags
, mount_operation
, cancellable
, callback
, user_data
);
710 * g_mount_remount_finish:
712 * @result: a #GAsyncResult.
713 * @error: a #GError location to store the error occurring, or %NULL to
716 * Finishes remounting a mount. If any errors occurred during the operation,
717 * @error will be set to contain the errors and %FALSE will be returned.
719 * Returns: %TRUE if the mount was successfully remounted. %FALSE otherwise.
722 g_mount_remount_finish (GMount
*mount
,
723 GAsyncResult
*result
,
728 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
729 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), FALSE
);
731 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
733 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
734 if (g_simple_async_result_propagate_error (simple
, error
))
738 iface
= G_MOUNT_GET_IFACE (mount
);
739 return (* iface
->remount_finish
) (mount
, result
, error
);
743 * g_mount_guess_content_type:
745 * @force_rescan: Whether to force a rescan of the content.
746 * Otherwise a cached result will be used if available
747 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
748 * @callback: a #GAsyncReadyCallback
749 * @user_data: user data passed to @callback
751 * Tries to guess the type of content stored on @mount. Returns one or
752 * more textual identifiers of well-known content types (typically
753 * prefixed with "x-content/"), e.g. x-content/image-dcf for camera
754 * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
755 * specification for more on x-content types.
757 * This is an asynchronous operation (see
758 * g_mount_guess_content_type_sync() for the synchronous version), and
759 * is finished by calling g_mount_guess_content_type_finish() with the
760 * @mount and #GAsyncResult data returned in the @callback.
765 g_mount_guess_content_type (GMount
*mount
,
766 gboolean force_rescan
,
767 GCancellable
*cancellable
,
768 GAsyncReadyCallback callback
,
773 g_return_if_fail (G_IS_MOUNT (mount
));
775 iface
= G_MOUNT_GET_IFACE (mount
);
777 if (iface
->guess_content_type
== NULL
)
779 g_simple_async_report_error_in_idle (G_OBJECT (mount
),
781 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
782 /* Translators: This is an error
783 * message for mount objects that
784 * don't implement content type guessing. */
785 _("mount doesn't implement content type guessing"));
790 (* iface
->guess_content_type
) (mount
, force_rescan
, cancellable
, callback
, user_data
);
794 * g_mount_guess_content_type_finish:
796 * @result: a #GAsyncResult
797 * @error: a #GError location to store the error occurring, or %NULL to
800 * Finishes guessing content types of @mount. If any errors occurred
801 * during the operation, @error will be set to contain the errors and
802 * %FALSE will be returned. In particular, you may get an
803 * %G_IO_ERROR_NOT_SUPPORTED if the mount does not support content
806 * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error.
807 * Caller should free this array with g_strfreev() when done with it.
812 g_mount_guess_content_type_finish (GMount
*mount
,
813 GAsyncResult
*result
,
818 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
819 g_return_val_if_fail (G_IS_ASYNC_RESULT (result
), NULL
);
821 if (G_IS_SIMPLE_ASYNC_RESULT (result
))
823 GSimpleAsyncResult
*simple
= G_SIMPLE_ASYNC_RESULT (result
);
824 if (g_simple_async_result_propagate_error (simple
, error
))
828 iface
= G_MOUNT_GET_IFACE (mount
);
829 return (* iface
->guess_content_type_finish
) (mount
, result
, error
);
833 * g_mount_guess_content_type_sync:
835 * @force_rescan: Whether to force a rescan of the content.
836 * Otherwise a cached result will be used if available
837 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
838 * @error: a #GError location to store the error occurring, or %NULL to
841 * Tries to guess the type of content stored on @mount. Returns one or
842 * more textual identifiers of well-known content types (typically
843 * prefixed with "x-content/"), e.g. x-content/image-dcf for camera
844 * memory cards. See the <ulink url="http://www.freedesktop.org/wiki/Specifications/shared-mime-info-spec">shared-mime-info</ulink>
845 * specification for more on x-content types.
847 * This is an synchronous operation and as such may block doing IO;
848 * see g_mount_guess_content_type() for the asynchronous version.
850 * Returns: (transfer full) (element-type utf8): a %NULL-terminated array of content types or %NULL on error.
851 * Caller should free this array with g_strfreev() when done with it.
856 g_mount_guess_content_type_sync (GMount
*mount
,
857 gboolean force_rescan
,
858 GCancellable
*cancellable
,
863 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
865 iface
= G_MOUNT_GET_IFACE (mount
);
867 if (iface
->guess_content_type_sync
== NULL
)
869 g_set_error_literal (error
,
870 G_IO_ERROR
, G_IO_ERROR_NOT_SUPPORTED
,
871 /* Translators: This is an error
872 * message for mount objects that
873 * don't implement content type guessing. */
874 _("mount doesn't implement synchronous content type guessing"));
879 return (* iface
->guess_content_type_sync
) (mount
, force_rescan
, cancellable
, error
);
882 G_LOCK_DEFINE_STATIC (priv_lock
);
884 /* only access this structure when holding priv_lock */
887 gint shadow_ref_count
;
891 free_private (GMountPrivate
*private)
895 G_UNLOCK (priv_lock
);
898 /* may only be called when holding priv_lock */
899 static GMountPrivate
*
900 get_private (GMount
*mount
)
902 GMountPrivate
*private;
904 private = g_object_get_data (G_OBJECT (mount
), "g-mount-private");
905 if (G_LIKELY (private != NULL
))
908 private = g_new0 (GMountPrivate
, 1);
909 g_object_set_data_full (G_OBJECT (mount
),
912 (GDestroyNotify
) free_private
);
919 * g_mount_is_shadowed:
922 * Determines if @mount is shadowed. Applications or libraries should
923 * avoid displaying @mount in the user interface if it is shadowed.
925 * A mount is said to be shadowed if there exists one or more user
926 * visible objects (currently #GMount objects) with a root that is
927 * inside the root of @mount.
929 * One application of shadow mounts is when exposing a single file
930 * system that is used to address several logical volumes. In this
931 * situation, a #GVolumeMonitor implementation would create two
932 * #GVolume objects (for example, one for the camera functionality of
933 * the device and one for a SD card reader on the device) with
934 * activation URIs <literal>gphoto2://[usb:001,002]/store1/</literal>
935 * and <literal>gphoto2://[usb:001,002]/store2/</literal>. When the
936 * underlying mount (with root
937 * <literal>gphoto2://[usb:001,002]/</literal>) is mounted, said
938 * #GVolumeMonitor implementation would create two #GMount objects
939 * (each with their root matching the corresponding volume activation
940 * root) that would shadow the original mount.
942 * The proxy monitor in GVfs 2.26 and later, automatically creates and
943 * manage shadow mounts (and shadows the underlying mount) if the
944 * activation root on a #GVolume is set.
946 * Returns: %TRUE if @mount is shadowed.
951 g_mount_is_shadowed (GMount
*mount
)
956 g_return_val_if_fail (G_IS_MOUNT (mount
), FALSE
);
959 priv
= get_private (mount
);
960 ret
= (priv
->shadow_ref_count
> 0);
961 G_UNLOCK (priv_lock
);
970 * Increments the shadow count on @mount. Usually used by
971 * #GVolumeMonitor implementations when creating a shadow mount for
972 * @mount, see g_mount_is_shadowed() for more information. The caller
973 * will need to emit the #GMount::changed signal on @mount manually.
978 g_mount_shadow (GMount
*mount
)
982 g_return_if_fail (G_IS_MOUNT (mount
));
985 priv
= get_private (mount
);
986 priv
->shadow_ref_count
+= 1;
987 G_UNLOCK (priv_lock
);
994 * Decrements the shadow count on @mount. Usually used by
995 * #GVolumeMonitor implementations when destroying a shadow mount for
996 * @mount, see g_mount_is_shadowed() for more information. The caller
997 * will need to emit the #GMount::changed signal on @mount manually.
1002 g_mount_unshadow (GMount
*mount
)
1004 GMountPrivate
*priv
;
1006 g_return_if_fail (G_IS_MOUNT (mount
));
1009 priv
= get_private (mount
);
1010 priv
->shadow_ref_count
-= 1;
1011 if (priv
->shadow_ref_count
< 0)
1012 g_warning ("Shadow ref count on GMount is negative");
1013 G_UNLOCK (priv_lock
);
1017 * g_mount_get_sort_key:
1018 * @mount: A #GMount.
1020 * Gets the sort key for @mount, if any.
1022 * Returns: Sorting key for @mount or %NULL if no such key is available.
1027 g_mount_get_sort_key (GMount
*mount
)
1029 const gchar
*ret
= NULL
;
1032 g_return_val_if_fail (G_IS_MOUNT (mount
), NULL
);
1034 iface
= G_MOUNT_GET_IFACE (mount
);
1035 if (iface
->get_sort_key
!= NULL
)
1036 ret
= iface
->get_sort_key (mount
);