gio/gunixmounts.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * This library is free software; you can redistribute it and/or
   6  * modify it under the terms of the GNU Lesser General Public
   7  * License as published by the Free Software Foundation; either
   8  * version 2 of the License, or (at your option) any later version.
   9  *
  10  * This library is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13  * Lesser General Public License for more details.
  14  *
  15  * 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  */
  20
  21 #ifndef __G_UNIX_MOUNTS_H__
  22 #define __G_UNIX_MOUNTS_H__
  23
  24 #include <gio/gio.h>
  25
  26 G_BEGIN_DECLS
  27
  28 /**
  29  * GUnixMountEntry:
  30  *
  31  * Defines a Unix mount entry (e.g. <filename>/media/cdrom</filename>).
  32  * This corresponds roughly to a mtab entry.
  33  **/
  34 typedef struct _GUnixMountEntry GUnixMountEntry;
  35
  36 /**
  37  * GUnixMountPoint:
  38  *
  39  * Defines a Unix mount point (e.g. <filename>/dev</filename>).
  40  * This corresponds roughly to a fstab entry.
  41  **/
  42 typedef struct _GUnixMountPoint GUnixMountPoint;
  43
  44 /**
  45  * GUnixMountMonitor:
  46  *
  47  * Watches #GUnixMounts for changes.
  48  **/
  49 typedef struct _GUnixMountMonitor      GUnixMountMonitor;
  50 typedef struct _GUnixMountMonitorClass GUnixMountMonitorClass;
  51
  52 #define G_TYPE_UNIX_MOUNT_MONITOR        (g_unix_mount_monitor_get_type ())
  53 #define G_UNIX_MOUNT_MONITOR(o)          (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_UNIX_MOUNT_MONITOR, GUnixMountMonitor))
  54 #define G_UNIX_MOUNT_MONITOR_CLASS(k)    (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_UNIX_MOUNT_MONITOR, GUnixMountMonitorClass))
  55 #define G_IS_UNIX_MOUNT_MONITOR(o)       (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_UNIX_MOUNT_MONITOR))
  56 #define G_IS_UNIX_MOUNT_MONITOR_CLASS(k) (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_UNIX_MOUNT_MONITOR))
  57
  58 GLIB_AVAILABLE_IN_ALL
  59 void           g_unix_mount_free                    (GUnixMountEntry    *mount_entry);
  60 GLIB_AVAILABLE_IN_ALL
  61 void           g_unix_mount_point_free              (GUnixMountPoint    *mount_point);
  62 GLIB_AVAILABLE_IN_ALL
  63 gint           g_unix_mount_compare                 (GUnixMountEntry    *mount1,
  64                                                      GUnixMountEntry    *mount2);
  65 GLIB_AVAILABLE_IN_ALL
  66 const char *   g_unix_mount_get_mount_path          (GUnixMountEntry    *mount_entry);
  67 GLIB_AVAILABLE_IN_ALL
  68 const char *   g_unix_mount_get_device_path         (GUnixMountEntry    *mount_entry);
  69 GLIB_AVAILABLE_IN_ALL
  70 const char *   g_unix_mount_get_fs_type             (GUnixMountEntry    *mount_entry);
  71 GLIB_AVAILABLE_IN_ALL
  72 gboolean       g_unix_mount_is_readonly             (GUnixMountEntry    *mount_entry);
  73 GLIB_AVAILABLE_IN_ALL
  74 gboolean       g_unix_mount_is_system_internal      (GUnixMountEntry    *mount_entry);
  75 GLIB_AVAILABLE_IN_ALL
  76 gboolean       g_unix_mount_guess_can_eject         (GUnixMountEntry    *mount_entry);
  77 GLIB_AVAILABLE_IN_ALL
  78 gboolean       g_unix_mount_guess_should_display    (GUnixMountEntry    *mount_entry);
  79 GLIB_AVAILABLE_IN_ALL
  80 char *         g_unix_mount_guess_name              (GUnixMountEntry    *mount_entry);
  81 GLIB_AVAILABLE_IN_ALL
  82 GIcon *        g_unix_mount_guess_icon              (GUnixMountEntry    *mount_entry);
  83 GLIB_AVAILABLE_IN_ALL
  84 GIcon *        g_unix_mount_guess_symbolic_icon     (GUnixMountEntry    *mount_entry);
  85
  86
  87 GLIB_AVAILABLE_IN_ALL
  88 gint           g_unix_mount_point_compare           (GUnixMountPoint    *mount1,
  89                                                      GUnixMountPoint    *mount2);
  90 GLIB_AVAILABLE_IN_ALL
  91 const char *   g_unix_mount_point_get_mount_path    (GUnixMountPoint    *mount_point);
  92 GLIB_AVAILABLE_IN_ALL
  93 const char *   g_unix_mount_point_get_device_path   (GUnixMountPoint    *mount_point);
  94 GLIB_AVAILABLE_IN_ALL
  95 const char *   g_unix_mount_point_get_fs_type       (GUnixMountPoint    *mount_point);
  96 GLIB_AVAILABLE_IN_2_32
  97 const char *   g_unix_mount_point_get_options       (GUnixMountPoint    *mount_point);
  98 GLIB_AVAILABLE_IN_ALL
  99 gboolean       g_unix_mount_point_is_readonly       (GUnixMountPoint    *mount_point);
 100 GLIB_AVAILABLE_IN_ALL
 101 gboolean       g_unix_mount_point_is_user_mountable (GUnixMountPoint    *mount_point);
 102 GLIB_AVAILABLE_IN_ALL
 103 gboolean       g_unix_mount_point_is_loopback       (GUnixMountPoint    *mount_point);
 104 GLIB_AVAILABLE_IN_ALL
 105 gboolean       g_unix_mount_point_guess_can_eject   (GUnixMountPoint    *mount_point);
 106 GLIB_AVAILABLE_IN_ALL
 107 char *         g_unix_mount_point_guess_name        (GUnixMountPoint    *mount_point);
 108 GLIB_AVAILABLE_IN_ALL
 109 GIcon *        g_unix_mount_point_guess_icon        (GUnixMountPoint    *mount_point);
 110 GLIB_AVAILABLE_IN_ALL
 111 GIcon *        g_unix_mount_point_guess_symbolic_icon (GUnixMountPoint    *mount_point);
 112
 113
 114 GLIB_AVAILABLE_IN_ALL
 115 GList *        g_unix_mount_points_get              (guint64            *time_read);
 116 GLIB_AVAILABLE_IN_ALL
 117 GList *        g_unix_mounts_get                    (guint64            *time_read);
 118 GLIB_AVAILABLE_IN_ALL
 119 GUnixMountEntry *g_unix_mount_at                    (const char         *mount_path,
 120                                                      guint64            *time_read);
 121 GLIB_AVAILABLE_IN_ALL
 122 gboolean       g_unix_mounts_changed_since          (guint64             time);
 123 GLIB_AVAILABLE_IN_ALL
 124 gboolean       g_unix_mount_points_changed_since    (guint64             time);
 125
 126 GLIB_AVAILABLE_IN_ALL
 127 GType              g_unix_mount_monitor_get_type       (void) G_GNUC_CONST;
 128 GLIB_AVAILABLE_IN_ALL
 129 GUnixMountMonitor *g_unix_mount_monitor_new            (void);
 130 GLIB_AVAILABLE_IN_ALL
 131 void               g_unix_mount_monitor_set_rate_limit (GUnixMountMonitor *mount_monitor,
 132                                                         int                limit_msec);
 133
 134 GLIB_AVAILABLE_IN_ALL
 135 gboolean g_unix_is_mount_path_system_internal (const char *mount_path);
 136
 137 G_END_DECLS
 138
 139 #endif /* __G_UNIX_MOUNTS_H__ */