gdrive.c 11.5 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
/* 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
 * 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.
 *
 * Author: Alexander Larsson <alexl@redhat.com>
21
 *         David Zeuthen <davidz@redhat.com>
22 23 24 25 26 27 28
 */

#include <config.h>
#include "gdrive.h"
#include "gsimpleasyncresult.h"
#include "glibintl.h"

29 30
#include "gioalias.h"

31 32
/**
 * SECTION:gdrive
33
 * @short_description: Virtual File System drive management
34
 * @include: gio.h
35
 * 
36 37 38 39
 * #GDrive - this represent a piece of hardware connected to the machine.
 * Its generally only created for removable hardware or hardware with
 * removable media. 
 *
40 41 42 43 44 45 46 47 48 49 50 51 52
 * #GDrive is a container class for #GVolume objects that stem from
 * the same piece of media. As such, #GDrive abstracts a drive with
 * (or without) removable media and provides operations for querying
 * whether media is available, determing whether media change is
 * automatically detected and ejecting the media.
 *
 * If the #GDrive reports that media isn't automatically detected, one
 * can poll for media; typically one should not do this periodically
 * as a poll for media operation is potententially expensive and may
 * spin up the drive creating noise.
 *
 * For porting from GnomeVFS note that there is no equivalent of
 * #GDrive in that API.
53 54
 **/

55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90
static void g_drive_base_init (gpointer g_class);
static void g_drive_class_init (gpointer g_class,
				 gpointer class_data);

GType
g_drive_get_type (void)
{
  static GType drive_type = 0;

  if (! drive_type)
    {
      static const GTypeInfo drive_info =
      {
        sizeof (GDriveIface), /* class_size */
	g_drive_base_init,   /* base_init */
	NULL,		/* base_finalize */
	g_drive_class_init,
	NULL,		/* class_finalize */
	NULL,		/* class_data */
	0,
	0,              /* n_preallocs */
	NULL
      };

      drive_type =
	g_type_register_static (G_TYPE_INTERFACE, I_("GDrive"),
				&drive_info, 0);

      g_type_interface_add_prerequisite (drive_type, G_TYPE_OBJECT);
    }

  return drive_type;
}

static void
g_drive_class_init (gpointer g_class,
Matthias Clasen's avatar
Matthias Clasen committed
91
                    gpointer class_data)
92 93 94 95 96 97 98 99 100 101
{
}

static void
g_drive_base_init (gpointer g_class)
{
  static gboolean initialized = FALSE;

  if (! initialized)
    {
102 103
      /**
      * GDrive::changed:
104
      * @drive: a #GDrive.
105 106 107
      * 
      * Emitted when the drive's state has changed.
      **/
108 109 110 111 112 113 114 115
      g_signal_new (I_("changed"),
                    G_TYPE_DRIVE,
                    G_SIGNAL_RUN_LAST,
                    G_STRUCT_OFFSET (GDriveIface, changed),
                    NULL, NULL,
                    g_cclosure_marshal_VOID__VOID,
                    G_TYPE_NONE, 0);

116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
      /**
      * GDrive::disconnected:
      * @drive: a #GDrive.
      * 
      * This signal is emitted when the #GDrive have been
      * disconnected. If the recipient is holding references to the
      * object they should release them so the object can be
      * finalized.
      **/
      g_signal_new (I_("disconnected"),
                    G_TYPE_DRIVE,
                    G_SIGNAL_RUN_LAST,
                    G_STRUCT_OFFSET (GDriveIface, disconnected),
                    NULL, NULL,
                    g_cclosure_marshal_VOID__VOID,
                    G_TYPE_NONE, 0);

      /**
      * GDrive::eject-button:
      * @drive: a #GDrive.
      * 
      * Emitted when the physical eject button (if any) of a drive have been pressed.
      * 
      **/
      g_signal_new (I_("eject-button"),
                    G_TYPE_DRIVE,
                    G_SIGNAL_RUN_LAST,
                    G_STRUCT_OFFSET (GDriveIface, eject_button),
                    NULL, NULL,
                    g_cclosure_marshal_VOID__VOID,
                    G_TYPE_NONE, 0);

148 149 150 151 152 153 154 155
      initialized = TRUE;
    }
}

/**
 * g_drive_get_name:
 * @drive: a #GDrive.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
156
 * Gets the name of @drive.
157
 *
Matthias Clasen's avatar
Matthias Clasen committed
158 159
 * Returns: a string containing @drive's name. The returned 
 *     string should be freed when no longer needed.
160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196
 **/
char *
g_drive_get_name (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), NULL);

  iface = G_DRIVE_GET_IFACE (drive);

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

/**
 * g_drive_get_icon:
 * @drive: a #GDrive.
 * 
 * Gets the icon for @drive.
 * 
 * Returns: #GIcon for the @drive.
 **/
GIcon *
g_drive_get_icon (GDrive *drive)
{
  GDriveIface *iface;
  
  g_return_val_if_fail (G_IS_DRIVE (drive), NULL);

  iface = G_DRIVE_GET_IFACE (drive);

  return (* iface->get_icon) (drive);
}

/**
 * g_drive_has_volumes:
 * @drive: a #GDrive.
 * 
197
 * Check if @drive has any mountable volumes.
198
 * 
199
 * Returns: %TRUE if the @drive contains volumes, %FALSE otherwise.
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
 **/
gboolean
g_drive_has_volumes (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

  return (* iface->has_volumes) (drive);
}

/**
 * g_drive_get_volumes:
 * @drive: a #GDrive.
 * 
217
 * Get a list of mountable volumes for @drive.
218 219
 * 
 * Returns: #GList containing any #GVolume<!---->s on the given @drive.
220 221 222 223 224 225 226 227 228 229 230 231 232 233
 **/
GList *
g_drive_get_volumes (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), NULL);

  iface = G_DRIVE_GET_IFACE (drive);

  return (* iface->get_volumes) (drive);
}

/**
234
 * g_drive_is_media_check_automatic:
235 236
 * @drive: a #GDrive.
 * 
237
 * Checks if @drive is capabable of automatically detecting media changes.
238
 * 
239
 * Returns: %TRUE if the @drive is capabable of automatically detecting media changes, %FALSE otherwise.
240 241
 **/
gboolean
242
g_drive_is_media_check_automatic (GDrive *drive)
243 244 245 246 247 248 249
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

250
  return (* iface->is_media_check_automatic) (drive);
251 252 253
}

/**
254
 * g_drive_is_media_removable:
255 256
 * @drive: a #GDrive.
 * 
257
 * Checks if the @drive supports removable media.
258
 * 
259
 * Returns: %TRUE if @drive supports removable media, %FALSE otherwise.
260 261
 **/
gboolean
262
g_drive_is_media_removable (GDrive *drive)
263 264 265 266 267 268 269
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

270 271
  return (* iface->is_media_removable) (drive);
}
272

273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292
/**
 * g_drive_has_media:
 * @drive: a #GDrive.
 * 
 * Checks if the @drive has media. Note that the OS may not be polling
 * the drive for media changes; see g_drive_is_media_check_automatic()
 * for more details.
 * 
 * Returns: %TRUE if @drive has media, %FALSE otherwise.
 **/
gboolean
g_drive_has_media (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

  return (* iface->has_media) (drive);
293 294 295 296 297 298
}

/**
 * g_drive_can_eject:
 * @drive: pointer to a #GDrive.
 * 
299 300
 * Checks if a drive can be ejected.
 * 
301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318
 * Returns: %TRUE if the @drive can be ejected. %FALSE otherwise.
 **/
gboolean
g_drive_can_eject (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

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

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

/**
319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342
 * g_drive_can_poll_for_media:
 * @drive: a #GDrive.
 * 
 * Checks if a drive can be polled for media changes.
 * 
 * Returns: %TRUE if the @drive can be polled for media changes. %FALSE otherwise.
 **/
gboolean
g_drive_can_poll_for_media (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

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

  return (* iface->can_poll_for_media) (drive);
}

/**
 * g_drive_eject:
343
 * @drive: a #GDrive.
344
 * @flags: flags affecting the unmount if required for eject
345
 * @cancellable: optional #GCancellable object, %NULL to ignore.
346
 * @callback: a #GAsyncReadyCallback, or %NULL.
347 348
 * @user_data: a #gpointer.
 * 
349 350
 * Ejects a drive.
 * 
351 352
 **/
void
353
g_drive_eject (GDrive              *drive,
354
	       GMountUnmountFlags   flags,
Matthias Clasen's avatar
Matthias Clasen committed
355 356 357
	       GCancellable        *cancellable,
	       GAsyncReadyCallback  callback,
	       gpointer             user_data)
358 359 360 361 362 363 364
{
  GDriveIface *iface;

  g_return_if_fail (G_IS_DRIVE (drive));

  iface = G_DRIVE_GET_IFACE (drive);

365
  if (iface->eject == NULL)
366 367 368
    {
      g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
					   G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
369
					   _("drive doesn't implement eject"));
370 371 372 373
      
      return;
    }
  
374
  (* iface->eject) (drive, flags, cancellable, callback, user_data);
375 376 377
}

/**
378
 * g_drive_eject_finish
379
 * @drive: a #GDrive.
380 381 382
 * @result: a #GAsyncResult.
 * @error: a #GError.
 * 
383
 * Finishes ejecting a drive.
384
 * 
385 386
 * Returns: %TRUE if the drive has been ejected successfully,
 * %FALSE otherwise.
387 388
 **/
gboolean
389
g_drive_eject_finish (GDrive        *drive,
Matthias Clasen's avatar
Matthias Clasen committed
390 391
		      GAsyncResult  *result,
		      GError       **error)
392 393 394 395 396 397 398 399 400 401 402 403 404 405
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), 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;
    }
  
  iface = G_DRIVE_GET_IFACE (drive);
406 407
  
  return (* iface->eject_finish) (drive, result, error);
408 409 410
}

/**
411
 * g_drive_poll_for_media:
412
 * @drive: a #GDrive.
413
 * @cancellable: optional #GCancellable object, %NULL to ignore.
414
 * @callback: a #GAsyncReadyCallback, or %NULL.
415 416
 * @user_data: a #gpointer.
 * 
417
 * Polls @drive to see if media has been inserted or removed.
418
 * 
419 420
 **/
void
421 422 423 424
g_drive_poll_for_media (GDrive              *drive,
                        GCancellable        *cancellable,
                        GAsyncReadyCallback  callback,
                        gpointer             user_data)
425 426 427 428 429 430 431
{
  GDriveIface *iface;

  g_return_if_fail (G_IS_DRIVE (drive));

  iface = G_DRIVE_GET_IFACE (drive);

432
  if (iface->poll_for_media == NULL)
433 434 435
    {
      g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
					   G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
436
					   _("drive doesn't implement polling for media"));
437 438 439 440
      
      return;
    }
  
441
  (* iface->poll_for_media) (drive, cancellable, callback, user_data);
442 443 444
}

/**
445
 * g_drive_poll_for_media_finish
446 447 448 449
 * @drive: a #GDrive.
 * @result: a #GAsyncResult.
 * @error: a #GError.
 * 
450
 * Finishes poll_for_mediaing a drive.
451
 * 
452
 * Returns: %TRUE if the drive has been poll_for_mediaed successfully,
453 454 455
 * %FALSE otherwise.
 **/
gboolean
456 457 458
g_drive_poll_for_media_finish (GDrive        *drive,
                               GAsyncResult  *result,
                               GError       **error)
459 460 461 462 463 464 465 466 467 468 469 470 471 472 473
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), 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;
    }
  
  iface = G_DRIVE_GET_IFACE (drive);
  
474
  return (* iface->poll_for_media_finish) (drive, result, error);
475
}
476 477 478

#define __G_DRIVE_C__
#include "gioaliasdef.c"