gvolume.c 19.6 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/* GIO - GLib Input, Output and Streaming Library
 * 
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
16
 * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
17 18
 *
 * Author: Alexander Larsson <alexl@redhat.com>
19
 *         David Zeuthen <davidz@redhat.com>
20 21
 */

22
#include "config.h"
23
#include "gmount.h"
24
#include "gvolume.h"
25
#include "gthemedicon.h"
26
#include "gasyncresult.h"
27
#include "gtask.h"
28
#include "gioerror.h"
29 30
#include "glibintl.h"

31

32
/**
33 34
 * SECTION:gvolume
 * @short_description: Volume management
Matthias Clasen's avatar
Matthias Clasen committed
35
 * @include: gio/gio.h
36
 * 
37 38 39
 * The #GVolume interface represents user-visible objects that can be
 * mounted. Note, when porting from GnomeVFS, #GVolume is the moral
 * equivalent of #GnomeVFSDrive.
40
 *
41
 * Mounting a #GVolume instance is an asynchronous operation. For more
42
 * information about asynchronous operations, see #GAsyncResult and
43 44 45
 * #GTask. To mount a #GVolume, first call g_volume_mount() with (at
 * least) the #GVolume instance, optionally a #GMountOperation object
 * and a #GAsyncReadyCallback.
46 47 48 49 50 51 52 53 54 55 56 57 58
 *
 * Typically, one will only want to pass %NULL for the
 * #GMountOperation if automounting all volumes when a desktop session
 * starts since it's not desirable to put up a lot of dialogs asking
 * for credentials.
 *
 * The callback will be fired when the operation has resolved (either
 * with success or failure), and a #GAsyncReady structure will be
 * passed to the callback.  That callback should then call
 * g_volume_mount_finish() with the #GVolume instance and the
 * #GAsyncReady data to see if the operation was completed
 * successfully.  If an @error is present when g_volume_mount_finish()
 * is called, then it will be filled with any error information.
59
 *
60 61
 * ## Volume Identifiers # {#volume-identifier}
 *
62
 * It is sometimes necessary to directly access the underlying
63 64 65 66
 * 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,
67 68 69 70
 * 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.
71
 *
72 73 74 75 76
 *
 * 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
77
 * libhal_manager_find_device_string_match().
78
 */
79

80 81
typedef GVolumeIface GVolumeInterface;
G_DEFINE_INTERFACE(GVolume, g_volume, G_TYPE_OBJECT)
82 83

static void
84
g_volume_default_init (GVolumeInterface *iface)
85
{
86 87 88 89
  /**
   * GVolume::changed:
   * 
   * Emitted when the volume has been changed.
90
   */
91 92 93 94 95 96 97
  g_signal_new (I_("changed"),
		G_TYPE_VOLUME,
		G_SIGNAL_RUN_LAST,
		G_STRUCT_OFFSET (GVolumeIface, changed),
		NULL, NULL,
		g_cclosure_marshal_VOID__VOID,
		G_TYPE_NONE, 0);
98

99 100 101 102 103 104
  /**
   * GVolume::removed:
   * 
   * 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.
105
   */
106 107 108 109 110 111 112
  g_signal_new (I_("removed"),
		G_TYPE_VOLUME,
		G_SIGNAL_RUN_LAST,
		G_STRUCT_OFFSET (GVolumeIface, removed),
		NULL, NULL,
		g_cclosure_marshal_VOID__VOID,
		G_TYPE_NONE, 0);
113 114 115 116
}

/**
 * g_volume_get_name:
117
 * @volume: a #GVolume
118
 * 
119
 * Gets the name of @volume.
120
 * 
Matthias Clasen's avatar
Matthias Clasen committed
121
 * Returns: the name for the given @volume. The returned string should 
122 123
 *     be freed with g_free() when no longer needed.
 */
124 125 126 127 128 129 130 131 132 133 134 135 136 137
char *
g_volume_get_name (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);

  iface = G_VOLUME_GET_IFACE (volume);

  return (* iface->get_name) (volume);
}

/**
 * g_volume_get_icon:
138
 * @volume: a #GVolume
139
 * 
140
 * Gets the icon for @volume.
141
 * 
142
 * Returns: (transfer full): a #GIcon.
143 144
 *     The returned object should be unreffed with g_object_unref()
 *     when no longer needed.
145
 */
146 147 148 149 150 151 152 153 154 155 156
GIcon *
g_volume_get_icon (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);

  iface = G_VOLUME_GET_IFACE (volume);

  return (* iface->get_icon) (volume);
}
157

158 159
/**
 * g_volume_get_symbolic_icon:
160
 * @volume: a #GVolume
161 162 163 164 165 166 167 168
 * 
 * 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
169
 */
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
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;

}

189 190
/**
 * g_volume_get_uuid:
191
 * @volume: a #GVolume
192 193 194 195 196 197 198
 * 
 * Gets the UUID for the @volume. The reference is typically based on
 * the file system UUID for the volume in question and should be
 * considered an opaque string. Returns %NULL if there is no UUID
 * available.
 * 
 * Returns: the UUID for @volume or %NULL if no UUID can be computed.
199 200
 *     The returned string should be freed with g_free() 
 *     when no longer needed.
201
 */
202 203 204 205 206 207 208 209 210 211 212
char *
g_volume_get_uuid (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);

  iface = G_VOLUME_GET_IFACE (volume);

  return (* iface->get_uuid) (volume);
}
213 214 215
  
/**
 * g_volume_get_drive:
216
 * @volume: a #GVolume
217
 * 
218
 * Gets the drive for the @volume.
219
 * 
220 221 222 223
 * 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.
 */
224 225 226 227 228 229 230 231 232 233 234 235 236
GDrive *
g_volume_get_drive (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);

  iface = G_VOLUME_GET_IFACE (volume);

  return (* iface->get_drive) (volume);
}

/**
237
 * g_volume_get_mount:
238
 * @volume: a #GVolume
239
 * 
240
 * Gets the mount for the @volume.
241
 * 
242
 * Returns: (transfer full): a #GMount or %NULL if @volume isn't mounted.
243 244
 *     The returned object should be unreffed with g_object_unref()
 *     when no longer needed.
245
 */
246 247
GMount *
g_volume_get_mount (GVolume *volume)
248 249 250
{
  GVolumeIface *iface;

251
  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
252 253 254

  iface = G_VOLUME_GET_IFACE (volume);

255
  return (* iface->get_mount) (volume);
256 257
}

258

259
/**
260
 * g_volume_can_mount:
261
 * @volume: a #GVolume
262
 * 
263
 * Checks if a volume can be mounted.
264
 * 
265 266
 * Returns: %TRUE if the @volume can be mounted. %FALSE otherwise
 */
267
gboolean
268
g_volume_can_mount (GVolume *volume)
269 270 271 272 273 274 275
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);

  iface = G_VOLUME_GET_IFACE (volume);

276 277
  if (iface->can_mount == NULL)
    return FALSE;
278

279
  return (* iface->can_mount) (volume);
280 281
}

282 283
/**
 * g_volume_can_eject:
284
 * @volume: a #GVolume
285 286 287
 * 
 * Checks if a volume can be ejected.
 * 
288 289
 * Returns: %TRUE if the @volume can be ejected. %FALSE otherwise
 */
290 291 292 293 294 295 296 297 298 299 300 301 302 303 304
gboolean
g_volume_can_eject (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);

  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->can_eject == NULL)
    return FALSE;

  return (* iface->can_eject) (volume);
}

305 306 307 308 309 310
/**
 * g_volume_should_automount:
 * @volume: a #GVolume
 *
 * Returns whether the volume should be automatically mounted.
 * 
311
 * Returns: %TRUE if the volume should be automatically mounted
312
 */
313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
gboolean
g_volume_should_automount (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);

  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->should_automount == NULL)
    return FALSE;

  return (* iface->should_automount) (volume);
}


329
/**
330
 * g_volume_mount:
331
 * @volume: a #GVolume
332
 * @flags: flags affecting the operation
333 334 335
 * @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
336
 * @user_data: user data that gets passed to @callback
337
 * 
338 339 340
 * 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.
341 342
 *
 * Virtual: mount_fn
343
 */
344
void
345
g_volume_mount (GVolume             *volume,
346
		GMountMountFlags     flags,
347 348 349 350
                GMountOperation     *mount_operation,
                GCancellable        *cancellable,
                GAsyncReadyCallback  callback,
                gpointer             user_data)
351 352 353 354 355 356 357
{
  GVolumeIface *iface;

  g_return_if_fail (G_IS_VOLUME (volume));

  iface = G_VOLUME_GET_IFACE (volume);

358
  if (iface->mount_fn == NULL)
359
    {
360 361 362 363
      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"));
364 365 366
      return;
    }
  
367
  (* iface->mount_fn) (volume, flags, mount_operation, cancellable, callback, user_data);
368 369 370
}

/**
371
 * g_volume_mount_finish:
372 373 374
 * @volume: a #GVolume
 * @result: a #GAsyncResult
 * @error: a #GError location to store an error, or %NULL to ignore
375
 * 
Matthias Clasen's avatar
Matthias Clasen committed
376
 * Finishes mounting a volume. If any errors occurred during the operation,
377
 * @error will be set to contain the errors and %FALSE will be returned.
378 379 380 381 382
 *
 * If the mount operation succeeded, g_volume_get_mount() on @volume
 * is guaranteed to return the mount right after calling this
 * function; there's no need to listen for the 'mount-added' signal on
 * #GVolumeMonitor.
383
 * 
384 385
 * Returns: %TRUE, %FALSE if operation failed
 */
386
gboolean
387 388 389
g_volume_mount_finish (GVolume       *volume,
                       GAsyncResult  *result,
                       GError       **error)
390 391 392 393 394 395
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
  g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);

396 397
  if (g_async_result_legacy_propagate_error (result, error))
    return FALSE;
398 399
  else if (g_async_result_is_tagged (result, g_volume_mount))
    return g_task_propagate_boolean (G_TASK (result), error);
400 401
  
  iface = G_VOLUME_GET_IFACE (volume);
402
  return (* iface->mount_finish) (volume, result, error);
403
}
404

405 406
/**
 * g_volume_eject:
407
 * @volume: a #GVolume
408
 * @flags: flags affecting the unmount if required for eject
409 410
 * @cancellable: (allow-none): optional #GCancellable object, %NULL to ignore
 * @callback: (allow-none): a #GAsyncReadyCallback, or %NULL
411
 * @user_data: user data that gets passed to @callback
412
 * 
413 414 415
 * Ejects a volume. This is an asynchronous operation, and is
 * finished by calling g_volume_eject_finish() with the @volume
 * and #GAsyncResult returned in the @callback.
416 417
 *
 * Deprecated: 2.22: Use g_volume_eject_with_operation() instead.
418
 */
419
void
420
g_volume_eject (GVolume             *volume,
421
		GMountUnmountFlags   flags,
422 423 424 425 426 427 428 429 430 431 432 433
                GCancellable        *cancellable,
                GAsyncReadyCallback  callback,
                gpointer             user_data)
{
  GVolumeIface *iface;

  g_return_if_fail (G_IS_VOLUME (volume));

  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->eject == NULL)
    {
434 435 436 437
      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"));
438 439 440
      return;
    }
  
441
  (* iface->eject) (volume, flags, cancellable, callback, user_data);
442 443 444 445
}

/**
 * g_volume_eject_finish:
446 447
 * @volume: pointer to a #GVolume
 * @result: a #GAsyncResult
448
 * @error: a #GError location to store an error, or %NULL to ignore
449
 * 
Matthias Clasen's avatar
Matthias Clasen committed
450
 * Finishes ejecting a volume. If any errors occurred during the operation,
451
 * @error will be set to contain the errors and %FALSE will be returned.
452
 * 
453
 * Returns: %TRUE, %FALSE if operation failed
454 455
 *
 * Deprecated: 2.22: Use g_volume_eject_with_operation_finish() instead.
456 457
 **/
gboolean
458 459 460
g_volume_eject_finish (GVolume       *volume,
                       GAsyncResult  *result,
                       GError       **error)
461 462 463 464 465 466
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
  g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);

467 468
  if (g_async_result_legacy_propagate_error (result, error))
    return FALSE;
469 470
  if (g_async_result_is_tagged (result, g_volume_eject_with_operation))
    return g_task_propagate_boolean (G_TASK (result), error);
471 472 473
  
  iface = G_VOLUME_GET_IFACE (volume);
  return (* iface->eject_finish) (volume, result, error);
474 475 476 477
}

/**
 * g_volume_eject_with_operation:
478
 * @volume: a #GVolume
479
 * @flags: flags affecting the unmount if required for eject
480
 * @mount_operation: (allow-none): a #GMountOperation or %NULL to
481 482 483 484
 *     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
485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
 *
 * Ejects a volume. This is an asynchronous operation, and is
 * finished by calling g_volume_eject_with_operation_finish() with the @volume
 * and #GAsyncResult data returned in the @callback.
 *
 * Since: 2.22
 **/
void
g_volume_eject_with_operation (GVolume              *volume,
                               GMountUnmountFlags   flags,
                               GMountOperation     *mount_operation,
                               GCancellable        *cancellable,
                               GAsyncReadyCallback  callback,
                               gpointer             user_data)
{
  GVolumeIface *iface;

  g_return_if_fail (G_IS_VOLUME (volume));

  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->eject == NULL && iface->eject_with_operation == NULL)
    {
508 509 510 511 512 513 514
      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"));
515 516 517 518 519 520 521 522 523 524 525
      return;
    }

  if (iface->eject_with_operation != NULL)
    (* iface->eject_with_operation) (volume, flags, mount_operation, cancellable, callback, user_data);
  else
    (* iface->eject) (volume, flags, cancellable, callback, user_data);
}

/**
 * g_volume_eject_with_operation_finish:
526 527 528
 * @volume: a #GVolume
 * @result: a #GAsyncResult
 * @error: a #GError location to store the error occurring, or %NULL
529 530 531 532
 *
 * Finishes ejecting a volume. If any errors occurred during the operation,
 * @error will be set to contain the errors and %FALSE will be returned.
 *
533
 * Returns: %TRUE if the volume was successfully ejected. %FALSE otherwise
534 535 536 537 538 539 540 541 542 543 544 545 546
 *
 * Since: 2.22
 **/
gboolean
g_volume_eject_with_operation_finish (GVolume        *volume,
                                      GAsyncResult  *result,
                                      GError       **error)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), FALSE);
  g_return_val_if_fail (G_IS_ASYNC_RESULT (result), FALSE);

547 548
  if (g_async_result_legacy_propagate_error (result, error))
    return FALSE;
549 550
  else if (g_async_result_is_tagged (result, g_volume_eject_with_operation))
    return g_task_propagate_boolean (G_TASK (result), error);
551 552 553 554 555 556

  iface = G_VOLUME_GET_IFACE (volume);
  if (iface->eject_with_operation_finish != NULL)
    return (* iface->eject_with_operation_finish) (volume, result, error);
  else
    return (* iface->eject_finish) (volume, result, error);
557 558
}

Matthias Clasen's avatar
Matthias Clasen committed
559 560 561 562 563
/**
 * g_volume_get_identifier:
 * @volume: a #GVolume
 * @kind: the kind of identifier to return
 *
564
 * Gets the identifier of the given kind for @volume. 
565 566
 * See the [introduction][volume-identifier] for more
 * information about volume identifiers.
Matthias Clasen's avatar
Matthias Clasen committed
567 568
 *
 * Returns: a newly allocated string containing the
569 570
 *     requested identfier, or %NULL if the #GVolume
 *     doesn't have this kind of identifier
Matthias Clasen's avatar
Matthias Clasen committed
571
 */
572
char *
Matthias Clasen's avatar
Matthias Clasen committed
573 574
g_volume_get_identifier (GVolume    *volume,
			 const char *kind)
575 576 577 578 579 580 581 582 583 584 585 586 587 588
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
  g_return_val_if_fail (kind != NULL, NULL);

  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->get_identifier == NULL)
    return NULL;
  
  return (* iface->get_identifier) (volume, kind);
}

Matthias Clasen's avatar
Matthias Clasen committed
589 590 591
/**
 * g_volume_enumerate_identifiers:
 * @volume: a #GVolume
592
 * 
593 594
 * Gets the kinds of [identifiers][volume-identifier] that @volume has.
 * Use g_volume_get_identifier() to obtain the identifiers themselves.
Matthias Clasen's avatar
Matthias Clasen committed
595
 *
596 597
 * Returns: (array zero-terminated=1) (transfer full): a %NULL-terminated array
 *   of strings containing kinds of identifiers. Use g_strfreev() to free.
Matthias Clasen's avatar
Matthias Clasen committed
598
 */
599 600 601 602 603 604 605 606 607 608 609 610 611 612
char **
g_volume_enumerate_identifiers (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->enumerate_identifiers == NULL)
    return NULL;
  
  return (* iface->enumerate_identifiers) (volume);
}

613 614 615 616 617 618 619 620 621 622 623
/**
 * g_volume_get_activation_root:
 * @volume: a #GVolume
 *
 * Gets the activation root for a #GVolume if it is known ahead of
 * mount time. Returns %NULL otherwise. If not %NULL and if @volume
 * is mounted, then the result of g_mount_get_root() on the
 * #GMount object obtained from g_volume_get_mount() will always
 * either be equal or a prefix of what this function returns. In
 * other words, in code
 *
624
 * |[<!-- language="C" -->
625 626 627 628
 *   GMount *mount;
 *   GFile *mount_root
 *   GFile *volume_activation_root;
 *
Matthias Clasen's avatar
Matthias Clasen committed
629
 *   mount = g_volume_get_mount (volume); // mounted, so never NULL
630
 *   mount_root = g_mount_get_root (mount);
Matthias Clasen's avatar
Matthias Clasen committed
631
 *   volume_activation_root = g_volume_get_activation_root (volume); // assume not NULL
632
 * ]|
633
 * then the expression
634
 * |[<!-- language="C" -->
635 636
 *   (g_file_has_prefix (volume_activation_root, mount_root) ||
      g_file_equal (volume_activation_root, mount_root))
637
 * ]|
638 639
 * will always be %TRUE.
 *
640 641 642
 * Activation roots are typically used in #GVolumeMonitor
 * implementations to find the underlying mount to shadow, see
 * g_mount_is_shadowed() for more details.
643
 *
644 645
 * Returns: (nullable) (transfer full): the activation root of @volume
 *     or %NULL. Use g_object_unref() to free.
646 647
 *
 * Since: 2.18
648
 */
649 650 651 652 653 654 655 656 657 658 659 660 661
GFile *
g_volume_get_activation_root (GVolume *volume)
{
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);
  iface = G_VOLUME_GET_IFACE (volume);

  if (iface->get_activation_root == NULL)
    return NULL;

  return (* iface->get_activation_root) (volume);
}
662 663 664

/**
 * g_volume_get_sort_key:
665
 * @volume: a #GVolume
666 667 668
 *
 * Gets the sort key for @volume, if any.
 *
669
 * Returns: Sorting key for @volume or %NULL if no such key is available
670 671 672 673
 *
 * Since: 2.32
 */
const gchar *
674
g_volume_get_sort_key (GVolume *volume)
675 676 677 678 679 680 681 682 683 684 685 686
{
  const gchar *ret = NULL;
  GVolumeIface *iface;

  g_return_val_if_fail (G_IS_VOLUME (volume), NULL);

  iface = G_VOLUME_GET_IFACE (volume);
  if (iface->get_sort_key != NULL)
    ret = iface->get_sort_key (volume);

  return ret;
}