Revert "GIOScheduler: Avoid constant iteration over pending job list"
[platform/upstream/glib.git] / gio / gvolume.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, write to the
17  * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
18  * Boston, MA 02111-1307, USA.
19  *
20  * Author: Alexander Larsson <alexl@redhat.com>
21  *         David Zeuthen <davidz@redhat.com>
22  */
23
24 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
25 #error "Only <gio/gio.h> can be included directly."
26 #endif
27
28 #ifndef __G_VOLUME_H__
29 #define __G_VOLUME_H__
30
31 #include <gio/giotypes.h>
32
33 G_BEGIN_DECLS
34
35 /**
36  * G_VOLUME_IDENTIFIER_KIND_HAL_UDI:
37  *
38  * The string used to obtain a Hal UDI with g_volume_get_identifier().
39  */
40 #define G_VOLUME_IDENTIFIER_KIND_HAL_UDI "hal-udi"
41
42 /**
43  * G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE:
44  *
45  * The string used to obtain a Unix device path with g_volume_get_identifier().
46  */
47 #define G_VOLUME_IDENTIFIER_KIND_UNIX_DEVICE "unix-device"
48
49 /**
50  * G_VOLUME_IDENTIFIER_KIND_LABEL:
51  *
52  * The string used to obtain a filesystem label with g_volume_get_identifier().
53  */
54 #define G_VOLUME_IDENTIFIER_KIND_LABEL "label"
55
56 /**
57  * G_VOLUME_IDENTIFIER_KIND_UUID:
58  *
59  * The string used to obtain a UUID with g_volume_get_identifier().
60  */
61 #define G_VOLUME_IDENTIFIER_KIND_UUID "uuid"
62
63 /**
64  * G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT:
65  *
66  * The string used to obtain a NFS mount with g_volume_get_identifier().
67  */
68 #define G_VOLUME_IDENTIFIER_KIND_NFS_MOUNT "nfs-mount"
69
70 /**
71  * G_VOLUME_IDENTIFIER_KIND_CLASS:
72  *
73  * The string used to obtain the volume <emphasis>class</emphasis>
74  * with g_volume_get_identifier().
75  *
76  * Known volume classes include <literal>device</literal> and
77  * <literal>network</literal>. Other classes may be added in the
78  * future.
79  *
80  * This is intended to be used by applications to classify #GVolume
81  * instances into different sections - for example a file manager or
82  * file chooser can use this information to show
83  * <literal>network</literal> volumes under a "Network" heading and
84  * <literal>device</literal> volumes under a "Devices" heading.
85  */
86 #define G_VOLUME_IDENTIFIER_KIND_CLASS "class"
87
88
89 #define G_TYPE_VOLUME            (g_volume_get_type ())
90 #define G_VOLUME(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_VOLUME, GVolume))
91 #define G_IS_VOLUME(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_VOLUME))
92 #define G_VOLUME_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_VOLUME, GVolumeIface))
93
94 /**
95  * GVolumeIface:
96  * @g_iface: The parent interface.
97  * @changed: Changed signal that is emitted when the volume's state has changed.
98  * @removed: The removed signal that 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.
99  * @get_name: Gets a string containing the name of the #GVolume.
100  * @get_icon: Gets a #GIcon for the #GVolume.
101  * @get_uuid: Gets the UUID for the #GVolume. The reference is typically based on the file system UUID for the mount in question and should be considered an opaque string. Returns %NULL if there is no UUID available.
102  * @get_drive: Gets a #GDrive the volume is located on. Returns %NULL if the #GVolume is not associated with a #GDrive.
103  * @get_mount: Gets a #GMount representing the mounted volume. Returns %NULL if the #GVolume is not mounted.
104  * @can_mount: Returns %TRUE if the #GVolume can be mounted.
105  * @can_eject: Checks if a #GVolume can be ejected.
106  * @mount_fn: Mounts a given #GVolume. 
107  *     #GVolume implementations must emit the #GMountOperation::aborted 
108  *     signal before completing a mount operation that is aborted while 
109  *     awaiting input from the user through a #GMountOperation instance.
110  * @mount_finish: Finishes a mount operation.
111  * @eject: Ejects a given #GVolume.
112  * @eject_finish: Finishes an eject operation.
113  * @get_identifier: Returns the <link linkend="volume-identifier">identifier</link> of the given kind, or %NULL if
114  *    the #GVolume doesn't have one.
115  * @enumerate_identifiers: Returns an array strings listing the kinds
116  *    of <link linkend="volume-identifier">identifiers</link> which the #GVolume has.
117  * @should_automount: Returns %TRUE if the #GVolume should be automatically mounted.
118  * @get_activation_root: Returns the activation root for the #GVolume if it is known in advance or %NULL if
119  *   it is not known.
120  * @eject_with_operation: Starts ejecting a #GVolume using a #GMountOperation. Since 2.22.
121  * @eject_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
122  * @get_sort_key: Gets a key used for sorting #GVolume instance or %NULL if no such key exists. Since 2.32.
123  *
124  * Interface for implementing operations for mountable volumes.
125  **/
126 typedef struct _GVolumeIface    GVolumeIface;
127
128 struct _GVolumeIface
129 {
130   GTypeInterface g_iface;
131
132   /* signals */
133
134   void        (* changed)               (GVolume             *volume);
135   void        (* removed)               (GVolume             *volume);
136
137   /* Virtual Table */
138
139   char      * (* get_name)              (GVolume             *volume);
140   GIcon     * (* get_icon)              (GVolume             *volume);
141   char      * (* get_uuid)              (GVolume             *volume);
142   GDrive    * (* get_drive)             (GVolume             *volume);
143   GMount    * (* get_mount)             (GVolume             *volume);
144   gboolean    (* can_mount)             (GVolume             *volume);
145   gboolean    (* can_eject)             (GVolume             *volume);
146   void        (* mount_fn)              (GVolume             *volume,
147                                          GMountMountFlags     flags,
148                                          GMountOperation     *mount_operation,
149                                          GCancellable        *cancellable,
150                                          GAsyncReadyCallback  callback,
151                                          gpointer             user_data);
152   gboolean    (* mount_finish)          (GVolume             *volume,
153                                          GAsyncResult        *result,
154                                          GError             **error);
155   void        (* eject)                 (GVolume             *volume,
156                                          GMountUnmountFlags   flags,
157                                          GCancellable        *cancellable,
158                                          GAsyncReadyCallback  callback,
159                                          gpointer             user_data);
160   gboolean    (* eject_finish)          (GVolume             *volume,
161                                          GAsyncResult        *result,
162                                          GError             **error);
163
164   char      * (* get_identifier)        (GVolume             *volume,
165                                          const char          *kind);
166   char     ** (* enumerate_identifiers) (GVolume             *volume);
167
168   gboolean    (* should_automount)      (GVolume             *volume);
169
170   GFile     * (* get_activation_root)   (GVolume             *volume);
171
172   void        (* eject_with_operation)      (GVolume             *volume,
173                                              GMountUnmountFlags   flags,
174                                              GMountOperation     *mount_operation,
175                                              GCancellable        *cancellable,
176                                              GAsyncReadyCallback  callback,
177                                              gpointer             user_data);
178   gboolean    (* eject_with_operation_finish) (GVolume           *volume,
179                                              GAsyncResult        *result,
180                                              GError             **error);
181
182   const gchar * (* get_sort_key)        (GVolume             *volume);
183 };
184
185 GType    g_volume_get_type              (void) G_GNUC_CONST;
186
187 char *   g_volume_get_name              (GVolume              *volume);
188 GIcon *  g_volume_get_icon              (GVolume              *volume);
189 char *   g_volume_get_uuid              (GVolume              *volume);
190 GDrive * g_volume_get_drive             (GVolume              *volume);
191 GMount * g_volume_get_mount             (GVolume              *volume);
192 gboolean g_volume_can_mount             (GVolume              *volume);
193 gboolean g_volume_can_eject             (GVolume              *volume);
194 gboolean g_volume_should_automount      (GVolume              *volume);
195 void     g_volume_mount                 (GVolume              *volume,
196                                          GMountMountFlags      flags,
197                                          GMountOperation      *mount_operation,
198                                          GCancellable         *cancellable,
199                                          GAsyncReadyCallback   callback,
200                                          gpointer              user_data);
201 gboolean g_volume_mount_finish          (GVolume              *volume,
202                                          GAsyncResult         *result,
203                                          GError              **error);
204 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation)
205 void     g_volume_eject                 (GVolume              *volume,
206                                          GMountUnmountFlags    flags,
207                                          GCancellable         *cancellable,
208                                          GAsyncReadyCallback   callback,
209                                          gpointer              user_data);
210
211 GLIB_DEPRECATED_FOR(g_volume_eject_with_operation_finish)
212 gboolean g_volume_eject_finish          (GVolume              *volume,
213                                          GAsyncResult         *result,
214                                          GError              **error);
215 char *   g_volume_get_identifier        (GVolume              *volume,
216                                          const char           *kind);
217 char **  g_volume_enumerate_identifiers (GVolume              *volume);
218
219 GFile *  g_volume_get_activation_root   (GVolume              *volume);
220
221 void        g_volume_eject_with_operation     (GVolume             *volume,
222                                                GMountUnmountFlags   flags,
223                                                GMountOperation     *mount_operation,
224                                                GCancellable        *cancellable,
225                                                GAsyncReadyCallback  callback,
226                                                gpointer             user_data);
227 gboolean    g_volume_eject_with_operation_finish (GVolume          *volume,
228                                                GAsyncResult        *result,
229                                                GError             **error);
230
231 GLIB_AVAILABLE_IN_2_32
232 const gchar *g_volume_get_sort_key            (GVolume              *volume);
233
234 G_END_DECLS
235
236 #endif /* __G_VOLUME_H__ */