gdrive.c 8.84 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27
/* 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>
 */

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

28 29
#include "gioalias.h"

30 31
/**
 * SECTION:gdrive
32
 * @short_description: Virtual File System drive management
33 34 35 36 37 38 39
 * @include: gio/gdrive.h
 * 
 * #GDrive manages drive operations from GVFS, including volume mounting
 * and ejecting, and getting the drive's name and icon. 
 * 
 **/

40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75
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
76
                    gpointer class_data)
77 78 79 80 81 82 83 84 85 86
{
}

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

  if (! initialized)
    {
87 88 89 90 91 92 93
      /**
      * GDrive::changed:
      * @volume: a #GVolume.
      * 
      * Emitted when the drive's state has changed.
      * 
      **/
94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109
      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);

      initialized = TRUE;
    }
}

/**
 * g_drive_get_name:
 * @drive: a #GDrive.
 * 
Matthias Clasen's avatar
Matthias Clasen committed
110
 * Gets the name of @drive.
111
 *
Matthias Clasen's avatar
Matthias Clasen committed
112 113
 * Returns: a string containing @drive's name. The returned 
 *     string should be freed when no longer needed.
114 115 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 148 149 150
 **/
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.
 * 
151 152
 * Checks if a drive has any volumes.
 * 
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
 * Returns: %TRUE if @drive contains volumes, %FALSE otherwise.
 **/
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.
 * 
171 172 173
 * Gets a list of volumes for a drive.
 * 
 * Returns: #GList containing any #GVolume<!---->s on the given @drive.
174
 * <!-- NOTE: Fact-check this. -->
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
 **/
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);
}

/**
 * g_drive_is_automounted:
 * @drive: a #GDrive.
 * 
192 193
 * Checks if a drive was automatically mounted, e.g. by HAL.
 * 
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211
 * Returns: %TRUE if the drive was automounted. %FALSE otherwise.
 **/
gboolean
g_drive_is_automounted (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

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

/**
 * g_drive_can_mount:
 * @drive: a #GDrive.
 * 
212 213
 * Checks if a drive can be mounted.
 * 
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
 * Returns: %TRUE if the @drive can be mounted. %FALSE otherwise.
 **/
gboolean
g_drive_can_mount (GDrive *drive)
{
  GDriveIface *iface;

  g_return_val_if_fail (G_IS_DRIVE (drive), FALSE);

  iface = G_DRIVE_GET_IFACE (drive);

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

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

/**
 * g_drive_can_eject:
 * @drive: pointer to a #GDrive.
 * 
235 236
 * Checks if a drive can be ejected.
 * 
237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
 * 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);
}

/**
 * g_drive_mount:
 * @drive: a #GDrive.
 * @mount_operation: a #GMountOperation.
258
 * @cancellable: optional #GCancellable object, %NULL to ignore.
259 260 261
 * @callback: a #GAsyncReadyCallback.
 * @user_data: a #gpointer.
 * 
262
 * Mounts a drive.
263 264
 **/
void
Matthias Clasen's avatar
Matthias Clasen committed
265 266 267 268 269
g_drive_mount (GDrive              *drive,
	       GMountOperation     *mount_operation,
	       GCancellable        *cancellable,
	       GAsyncReadyCallback  callback,
	       gpointer             user_data)
270 271 272 273 274 275 276 277
{
  GDriveIface *iface;

  g_return_if_fail (G_IS_DRIVE (drive));
  g_return_if_fail (G_IS_MOUNT_OPERATION (mount_operation));

  iface = G_DRIVE_GET_IFACE (drive);

278
  if (iface->mount_fn == NULL)
279 280 281 282 283 284 285 286
    {
      g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
					   G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
					   _("drive doesn't implement mount"));
      
      return;
    }
  
287
  (* iface->mount_fn) (drive, mount_operation, cancellable, callback, user_data);
288 289 290 291
}

/**
 * g_drive_mount_finish:
292
 * @drive: a #GDrive.
293 294 295
 * @result: a #GAsyncResult.
 * @error: a #GError.
 * 
296 297 298 299
 * Finishes mounting a drive. 
 *
 * If the @drive's interface does not implement the mount operation, @error will 
 * be set to %G_IO_ERROR_NOT_SUPPORTED and %FALSE will be returned.
300
 * 
301 302
 * Returns: %TRUE if the mount was finished successfully, 
 *     %FALSE if operation failed.
303 304
 **/
gboolean
Matthias Clasen's avatar
Matthias Clasen committed
305 306 307
g_drive_mount_finish (GDrive        *drive,
		      GAsyncResult  *result,
		      GError       **error)
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
{
  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);
  return (* iface->mount_finish) (drive, result, error);
}

/**
 * g_drive_eject:
 * @drive: a #GDrive.
328
 * @cancellable: optional #GCancellable object, %NULL to ignore.
329 330 331
 * @callback: a #GAsyncReadyCallback.
 * @user_data: a #gpointer.
 * 
332 333
 * Ejects a drive.
 * 
334 335
 **/
void
Matthias Clasen's avatar
Matthias Clasen committed
336 337
g_drive_eject (GDrive              *drive,
	       GCancellable        *cancellable,
338
	       GAsyncReadyCallback  callback,
Matthias Clasen's avatar
Matthias Clasen committed
339
	       gpointer             user_data)
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364
{
  GDriveIface *iface;

  g_return_if_fail (G_IS_DRIVE (drive));

  iface = G_DRIVE_GET_IFACE (drive);

  if (iface->eject == NULL)
    {
      g_simple_async_report_error_in_idle (G_OBJECT (drive), callback, user_data,
					   G_IO_ERROR, G_IO_ERROR_NOT_SUPPORTED,
					   _("drive doesn't implement eject"));
      
      return;
    }
  
  (* iface->eject) (drive, cancellable, callback, user_data);
}

/**
 * g_drive_eject_finish
 * @drive: a #GDrive.
 * @result: a #GAsyncResult.
 * @error: a #GError.
 * 
365
 * Finishes ejecting a drive.
366 367 368
 *
 * If @drive's interface does not implement the eject operation, @error will 
 * be set to %G_IO_ERROR_NOT_SUPPORTED and %FALSE will be returned.
369
 * 
370 371 372 373
 * Returns: %TRUE if the drive has been ejected successfully,
 * %FALSE otherwise.
 **/
gboolean
Matthias Clasen's avatar
Matthias Clasen committed
374 375 376
g_drive_eject_finish (GDrive        *drive,
		      GAsyncResult  *result,
		      GError       **error)
377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393
{
  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);
  
  return (* iface->mount_finish) (drive, result, error);
}
394 395 396

#define __G_DRIVE_C__
#include "gioaliasdef.c"