Move single-include guards inside include guards
[platform/upstream/glib.git] / gio / gfile.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  */
22
23 #ifndef __G_FILE_H__
24 #define __G_FILE_H__
25
26 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
27 #error "Only <gio/gio.h> can be included directly."
28 #endif
29
30 #include <gio/giotypes.h>
31
32 G_BEGIN_DECLS
33
34 #define G_TYPE_FILE            (g_file_get_type ())
35 #define G_FILE(obj)            (G_TYPE_CHECK_INSTANCE_CAST ((obj), G_TYPE_FILE, GFile))
36 #define G_IS_FILE(obj)         (G_TYPE_CHECK_INSTANCE_TYPE ((obj), G_TYPE_FILE))
37 #define G_FILE_GET_IFACE(obj)  (G_TYPE_INSTANCE_GET_INTERFACE ((obj), G_TYPE_FILE, GFileIface))
38
39 #if 0
40 /**
41  * GFile:
42  *
43  * A handle to an object implementing the #GFileIface interface.
44  * Generally stores a location within the file system. Handles do not
45  * necessarily represent files or directories that currently exist.
46  **/
47 typedef struct _GFile                   GFile; /* Dummy typedef */
48 #endif
49 typedef struct _GFileIface              GFileIface;
50
51
52 /**
53  * GFileIface:
54  * @g_iface: The parent interface.
55  * @dup: Duplicates a #GFile.
56  * @hash: Creates a hash of a #GFile.
57  * @equal: Checks equality of two given #GFile<!-- -->s.
58  * @is_native: Checks to see if a file is native to the system.
59  * @has_uri_scheme: Checks to see if a #GFile has a given URI scheme.
60  * @get_uri_scheme: Gets the URI scheme for a #GFile.
61  * @get_basename: Gets the basename for a given #GFile.
62  * @get_path: Gets the current path within a #GFile.
63  * @get_uri: Gets a URI for the path within a #GFile.
64  * @get_parse_name: Gets the parsed name for the #GFile.
65  * @get_parent: Gets the parent directory for the #GFile.
66  * @prefix_matches: Checks whether a #GFile contains a specified file.
67  * @get_relative_path: Gets the path for a #GFile relative to a given path.
68  * @resolve_relative_path: Resolves a relative path for a #GFile to an absolute path.
69  * @get_child_for_display_name: Gets the child #GFile for a given display name.
70  * @enumerate_children: Gets a #GFileEnumerator with the children of a #GFile.
71  * @enumerate_children_async: Asynchronously gets a #GFileEnumerator with the children of a #GFile.
72  * @enumerate_children_finish: Finishes asynchronously enumerating the children.
73  * @query_info: Gets the #GFileInfo for a #GFile.
74  * @query_info_async: Asynchronously gets the #GFileInfo for a #GFile.
75  * @query_info_finish: Finishes an asynchronous query info operation.
76  * @query_filesystem_info: Gets a #GFileInfo for the file system #GFile is on.
77  * @query_filesystem_info_async: Asynchronously gets a #GFileInfo for the file system #GFile is on.
78  * @query_filesystem_info_finish: Finishes asynchronously getting the file system info.
79  * @find_enclosing_mount: Gets a #GMount for the #GFile.
80  * @find_enclosing_mount_async: Asynchronously gets the #GMount for a #GFile.
81  * @find_enclosing_mount_finish: Finishes asynchronously getting the volume.
82  * @set_display_name: Sets the display name for a #GFile.
83  * @set_display_name_async: Asynchronously sets a #GFile's display name.
84  * @set_display_name_finish: Finishes asynchronously setting a #GFile's display name.
85  * @query_settable_attributes: Returns a list of #GFileAttribute<!-- -->s that can be set.
86  * @_query_settable_attributes_async: Asynchronously gets a list of #GFileAttribute<!-- -->s that can be set.
87  * @_query_settable_attributes_finish: Finishes asynchronously querying settable attributes.
88  * @query_writable_namespaces: Returns a list of #GFileAttribute namespaces that are writable.
89  * @_query_writable_namespaces_async: Asynchronously gets a list of #GFileAttribute namespaces that are writable.
90  * @_query_writable_namespaces_finish: Finishes asynchronously querying the writable namespaces.
91  * @set_attribute: Sets a #GFileAttribute.
92  * @set_attributes_from_info: Sets a #GFileAttribute with information from a #GFileInfo.
93  * @set_attributes_async: Asynchronously sets a file's attributes.
94  * @set_attributes_finish: Finishes setting a file's attributes asynchronously.
95  * @read_fn: Reads a file asynchronously.
96  * @read_async: Asynchronously reads a file.
97  * @read_finish: Finishes asynchronously reading a file.
98  * @append_to: Writes to the end of a file.
99  * @append_to_async: Asynchronously writes to the end of a file.
100  * @append_to_finish: Finishes an asynchronous file append operation.
101  * @create: Creates a new file.
102  * @create_async: Asynchronously creates a file.
103  * @create_finish: Finishes asynchronously creating a file.
104  * @replace: Replaces the contents of a file.
105  * @replace_async: Asynchronously replaces the contents of a file.
106  * @replace_finish: Finishes asynchronously replacing a file.
107  * @delete_file: Deletes a file.
108  * @delete_file_async: Asynchronously deletes a file.
109  * @delete_file_finish: Finishes an asynchronous delete.
110  * @trash: Sends a #GFile to the Trash location.
111  * @_trash_async: Asynchronously sends a #GFile to the Trash location.
112  * @_trash_finish: Finishes an asynchronous file trashing operation.
113  * @make_directory: Makes a directory.
114  * @_make_directory_async: Asynchronously makes a directory.
115  * @_make_directory_finish: Finishes making a directory asynchronously.
116  * @make_symbolic_link: Makes a symbolic link.
117  * @_make_symbolic_link_async: Asynchronously makes a symbolic link
118  * @_make_symbolic_link_finish: Finishes making a symbolic link asynchronously.
119  * @copy: Copies a file.
120  * @copy_async: Asynchronously copies a file.
121  * @copy_finish: Finishes an asynchronous copy operation.
122  * @move: Moves a file.
123  * @_move_async: Asynchronously moves a file.
124  * @_move_finish: Finishes an asynchronous move operation.
125  * @mount_mountable: Mounts a mountable object.
126  * @mount_mountable_finish: Finishes a mounting operation.
127  * @unmount_mountable: Unmounts a mountable object.
128  * @unmount_mountable_finish: Finishes an unmount operation.
129  * @eject_mountable: Ejects a mountable.
130  * @eject_mountable_finish: Finishes an eject operation.
131  * @mount_enclosing_volume: Mounts a specified location.
132  * @mount_enclosing_volume_finish: Finishes mounting a specified location.
133  * @monitor_dir: Creates a #GFileMonitor for the location.
134  * @monitor_file: Creates a #GFileMonitor for the location.
135  * @open_readwrite: Open file read/write. Since 2.22.
136  * @open_readwrite_async: Asynchronously opens file read/write. Since 2.22.
137  * @open_readwrite_finish: Finishes an asynchronous open read/write. Since 2.22.
138  * @create_readwrite: Creates file read/write. Since 2.22.
139  * @create_readwrite_async: Asynchronously creates file read/write. Since 2.22.
140  * @create_readwrite_finish: Finishes an asynchronous creates read/write. Since 2.22.
141  * @replace_readwrite: Replaces file read/write. Since 2.22.
142  * @replace_readwrite_async: Asynchronously replaces file read/write. Since 2.22.
143  * @replace_readwrite_finish: Finishes an asynchronous replace read/write. Since 2.22.
144  * @start_mountable: Starts a mountable object. Since 2.22.
145  * @start_mountable_finish: Finishes an start operation. Since 2.22.
146  * @stop_mountable: Stops a mountable. Since 2.22.
147  * @stop_mountable_finish: Finishes an stop operation. Since 2.22.
148  * @supports_thread_contexts: a boolean that indicates whether the #GFile implementation supports thread-default contexts. Since 2.22.
149  * @unmount_mountable_with_operation: Unmounts a mountable object using a #GMountOperation. Since 2.22.
150  * @unmount_mountable_with_operation_finish: Finishes an unmount operation using a #GMountOperation. Since 2.22.
151  * @eject_mountable_with_operation: Ejects a mountable object using a #GMountOperation. Since 2.22.
152  * @eject_mountable_with_operation_finish: Finishes an eject operation using a #GMountOperation. Since 2.22.
153  * @poll_mountable: Polls a mountable object for media changes. Since 2.22.
154  * @poll_mountable_finish: Finishes an poll operation for media changes. Since 2.22.
155  *
156  * An interface for writing VFS file handles.
157  **/
158 struct _GFileIface
159 {
160   GTypeInterface g_iface;
161
162   /* Virtual Table */
163
164   GFile *             (* dup)                         (GFile         *file);
165   guint               (* hash)                        (GFile         *file);
166   gboolean            (* equal)                       (GFile         *file1,
167                                                        GFile         *file2);
168   gboolean            (* is_native)                   (GFile         *file);
169   gboolean            (* has_uri_scheme)              (GFile         *file,
170                                                        const char    *uri_scheme);
171   char *              (* get_uri_scheme)              (GFile         *file);
172   char *              (* get_basename)                (GFile         *file);
173   char *              (* get_path)                    (GFile         *file);
174   char *              (* get_uri)                     (GFile         *file);
175   char *              (* get_parse_name)              (GFile         *file);
176   GFile *             (* get_parent)                  (GFile         *file);
177   gboolean            (* prefix_matches)              (GFile         *prefix,
178                                                        GFile         *file);
179   char *              (* get_relative_path)           (GFile         *parent,
180                                                        GFile         *descendant);
181   GFile *             (* resolve_relative_path)       (GFile        *file,
182                                                        const char   *relative_path);
183   GFile *             (* get_child_for_display_name)  (GFile        *file,
184                                                        const char   *display_name,
185                                                        GError      **error);
186
187   GFileEnumerator *   (* enumerate_children)          (GFile                *file,
188                                                        const char           *attributes,
189                                                        GFileQueryInfoFlags   flags,
190                                                        GCancellable         *cancellable,
191                                                        GError              **error);
192   void                (* enumerate_children_async)    (GFile                *file,
193                                                        const char           *attributes,
194                                                        GFileQueryInfoFlags   flags,
195                                                        int                   io_priority,
196                                                        GCancellable         *cancellable,
197                                                        GAsyncReadyCallback   callback,
198                                                        gpointer              user_data);
199   GFileEnumerator *   (* enumerate_children_finish)   (GFile                *file,
200                                                        GAsyncResult         *res,
201                                                        GError              **error);
202
203   GFileInfo *         (* query_info)                  (GFile                *file,
204                                                        const char           *attributes,
205                                                        GFileQueryInfoFlags   flags,
206                                                        GCancellable         *cancellable,
207                                                        GError              **error);
208   void                (* query_info_async)            (GFile                *file,
209                                                        const char           *attributes,
210                                                        GFileQueryInfoFlags   flags,
211                                                        int                   io_priority,
212                                                        GCancellable         *cancellable,
213                                                        GAsyncReadyCallback   callback,
214                                                        gpointer              user_data);
215   GFileInfo *         (* query_info_finish)           (GFile                *file,
216                                                        GAsyncResult         *res,
217                                                        GError              **error);
218
219   GFileInfo *         (* query_filesystem_info)       (GFile                *file,
220                                                        const char           *attributes,
221                                                        GCancellable         *cancellable,
222                                                        GError              **error);
223   void                (* query_filesystem_info_async) (GFile                *file,
224                                                        const char           *attributes,
225                                                        int                   io_priority,
226                                                        GCancellable         *cancellable,
227                                                        GAsyncReadyCallback   callback,
228                                                        gpointer              user_data);
229   GFileInfo *         (* query_filesystem_info_finish)(GFile                *file,
230                                                        GAsyncResult         *res,
231                                                        GError              **error);
232
233   GMount *            (* find_enclosing_mount)        (GFile                *file,
234                                                        GCancellable         *cancellable,
235                                                        GError              **error);
236   void                (* find_enclosing_mount_async)  (GFile                *file,
237                                                        int                   io_priority,
238                                                        GCancellable         *cancellable,
239                                                        GAsyncReadyCallback   callback,
240                                                        gpointer              user_data);
241   GMount *            (* find_enclosing_mount_finish) (GFile                *file,
242                                                        GAsyncResult         *res,
243                                                        GError              **error);
244
245   GFile *             (* set_display_name)            (GFile                *file,
246                                                        const char           *display_name,
247                                                        GCancellable         *cancellable,
248                                                        GError              **error);
249   void                (* set_display_name_async)      (GFile                *file,
250                                                        const char           *display_name,
251                                                        int                   io_priority,
252                                                        GCancellable         *cancellable,
253                                                        GAsyncReadyCallback   callback,
254                                                        gpointer              user_data);
255   GFile *             (* set_display_name_finish)     (GFile                *file,
256                                                        GAsyncResult         *res,
257                                                        GError              **error);
258
259   GFileAttributeInfoList * (* query_settable_attributes)    (GFile          *file,
260                                                              GCancellable   *cancellable,
261                                                              GError        **error);
262   void                (* _query_settable_attributes_async)  (void);
263   void                (* _query_settable_attributes_finish) (void);
264
265   GFileAttributeInfoList * (* query_writable_namespaces)    (GFile          *file,
266                                                              GCancellable   *cancellable,
267                                                              GError        **error);
268   void                (* _query_writable_namespaces_async)  (void);
269   void                (* _query_writable_namespaces_finish) (void);
270
271   gboolean            (* set_attribute)               (GFile                *file,
272                                                        const char           *attribute,
273                                                        GFileAttributeType    type,
274                                                        gpointer              value_p,
275                                                        GFileQueryInfoFlags   flags,
276                                                        GCancellable         *cancellable,
277                                                        GError              **error);
278   gboolean            (* set_attributes_from_info)    (GFile                *file,
279                                                        GFileInfo            *info,
280                                                        GFileQueryInfoFlags   flags,
281                                                        GCancellable         *cancellable,
282                                                        GError              **error);
283   void                (* set_attributes_async)        (GFile                *file,
284                                                        GFileInfo            *info,
285                                                        GFileQueryInfoFlags   flags,
286                                                        int                   io_priority,
287                                                        GCancellable         *cancellable,
288                                                        GAsyncReadyCallback   callback,
289                                                        gpointer              user_data);
290   gboolean            (* set_attributes_finish)       (GFile                *file,
291                                                        GAsyncResult         *result,
292                                                        GFileInfo           **info,
293                                                        GError              **error);
294
295   GFileInputStream *  (* read_fn)                     (GFile                *file,
296                                                        GCancellable         *cancellable,
297                                                        GError              **error);
298   void                (* read_async)                  (GFile                *file,
299                                                        int                   io_priority,
300                                                        GCancellable         *cancellable,
301                                                        GAsyncReadyCallback   callback,
302                                                        gpointer              user_data);
303   GFileInputStream *  (* read_finish)                 (GFile                *file,
304                                                        GAsyncResult         *res,
305                                                        GError              **error);
306
307   GFileOutputStream * (* append_to)                   (GFile                *file,
308                                                        GFileCreateFlags      flags,
309                                                        GCancellable         *cancellable,
310                                                        GError              **error);
311   void                (* append_to_async)             (GFile                *file,
312                                                        GFileCreateFlags      flags,
313                                                        int                   io_priority,
314                                                        GCancellable         *cancellable,
315                                                        GAsyncReadyCallback   callback,
316                                                        gpointer              user_data);
317   GFileOutputStream * (* append_to_finish)            (GFile                *file,
318                                                        GAsyncResult         *res,
319                                                        GError              **error);
320
321   GFileOutputStream * (* create)                      (GFile                *file,
322                                                        GFileCreateFlags      flags,
323                                                        GCancellable         *cancellable,
324                                                        GError              **error);
325   void                (* create_async)                (GFile                *file,
326                                                        GFileCreateFlags      flags,
327                                                        int                   io_priority,
328                                                        GCancellable         *cancellable,
329                                                        GAsyncReadyCallback   callback,
330                                                        gpointer              user_data);
331   GFileOutputStream * (* create_finish)               (GFile                *file,
332                                                        GAsyncResult         *res,
333                                                        GError              **error);
334
335   GFileOutputStream * (* replace)                     (GFile                *file,
336                                                        const char           *etag,
337                                                        gboolean              make_backup,
338                                                        GFileCreateFlags      flags,
339                                                        GCancellable         *cancellable,
340                                                        GError              **error);
341   void                (* replace_async)               (GFile                *file,
342                                                        const char           *etag,
343                                                        gboolean              make_backup,
344                                                        GFileCreateFlags      flags,
345                                                        int                   io_priority,
346                                                        GCancellable         *cancellable,
347                                                        GAsyncReadyCallback   callback,
348                                                        gpointer              user_data);
349   GFileOutputStream * (* replace_finish)              (GFile                *file,
350                                                        GAsyncResult         *res,
351                                                        GError              **error);
352
353   gboolean            (* delete_file)                 (GFile                *file,
354                                                        GCancellable         *cancellable,
355                                                        GError              **error);
356   void                (* delete_file_async)           (GFile                *file,
357                                                        int                   io_priority,
358                                                        GCancellable         *cancellable,
359                                                        GAsyncReadyCallback   callback,
360                                                        gpointer              user_data);
361   gboolean            (* delete_file_finish)          (GFile                *file,
362                                                        GAsyncResult         *result,
363                                                        GError              **error);
364
365   gboolean            (* trash)                       (GFile                *file,
366                                                        GCancellable         *cancellable,
367                                                        GError              **error);
368   void                (* _trash_async)                (void);
369   void                (* _trash_finish)               (void);
370
371   gboolean            (* make_directory)              (GFile                *file,
372                                                        GCancellable         *cancellable,
373                                                        GError              **error);
374   void                (* _make_directory_async)       (void);
375   void                (* _make_directory_finish)      (void);
376
377   gboolean            (* make_symbolic_link)          (GFile                *file,
378                                                        const char           *symlink_value,
379                                                        GCancellable         *cancellable,
380                                                        GError              **error);
381   void                (* _make_symbolic_link_async)   (void);
382   void                (* _make_symbolic_link_finish)  (void);
383
384   gboolean            (* copy)                        (GFile                *source,
385                                                        GFile                *destination,
386                                                        GFileCopyFlags        flags,
387                                                        GCancellable         *cancellable,
388                                                        GFileProgressCallback progress_callback,
389                                                        gpointer              progress_callback_data,
390                                                        GError              **error);
391   void                (* copy_async)                  (GFile                *source,
392                                                        GFile                *destination,
393                                                        GFileCopyFlags        flags,
394                                                        int                   io_priority,
395                                                        GCancellable         *cancellable,
396                                                        GFileProgressCallback progress_callback,
397                                                        gpointer              progress_callback_data,
398                                                        GAsyncReadyCallback   callback,
399                                                        gpointer              user_data);
400   gboolean            (* copy_finish)                 (GFile                *file,
401                                                        GAsyncResult         *res,
402                                                        GError              **error);
403
404   gboolean            (* move)                        (GFile                *source,
405                                                        GFile                *destination,
406                                                        GFileCopyFlags        flags,
407                                                        GCancellable         *cancellable,
408                                                        GFileProgressCallback progress_callback,
409                                                        gpointer              progress_callback_data,
410                                                        GError              **error);
411   void                (* _move_async)                 (void);
412   void                (* _move_finish)                (void);
413
414   void                (* mount_mountable)             (GFile                *file,
415                                                        GMountMountFlags      flags,
416                                                        GMountOperation      *mount_operation,
417                                                        GCancellable         *cancellable,
418                                                        GAsyncReadyCallback   callback,
419                                                        gpointer              user_data);
420   GFile *             (* mount_mountable_finish)      (GFile                *file,
421                                                        GAsyncResult         *result,
422                                                        GError              **error);
423
424   void                (* unmount_mountable)           (GFile                *file,
425                                                        GMountUnmountFlags    flags,
426                                                        GCancellable         *cancellable,
427                                                        GAsyncReadyCallback   callback,
428                                                        gpointer              user_data);
429   gboolean            (* unmount_mountable_finish)    (GFile                *file,
430                                                        GAsyncResult         *result,
431                                                        GError              **error);
432
433   void                (* eject_mountable)             (GFile                *file,
434                                                        GMountUnmountFlags    flags,
435                                                        GCancellable         *cancellable,
436                                                        GAsyncReadyCallback   callback,
437                                                        gpointer              user_data);
438   gboolean            (* eject_mountable_finish)      (GFile                *file,
439                                                        GAsyncResult         *result,
440                                                        GError              **error);
441
442   void                (* mount_enclosing_volume)      (GFile                *location,
443                                                        GMountMountFlags      flags,
444                                                        GMountOperation      *mount_operation,
445                                                        GCancellable         *cancellable,
446                                                        GAsyncReadyCallback   callback,
447                                                        gpointer              user_data);
448   gboolean         (* mount_enclosing_volume_finish)  (GFile                *location,
449                                                        GAsyncResult         *result,
450                                                        GError              **error);
451
452   GFileMonitor *      (* monitor_dir)                 (GFile                *file,
453                                                        GFileMonitorFlags     flags,
454                                                        GCancellable         *cancellable,
455                                                        GError              **error);
456   GFileMonitor *      (* monitor_file)                (GFile                *file,
457                                                        GFileMonitorFlags     flags,
458                                                        GCancellable         *cancellable,
459                                                        GError              **error);
460
461   GFileIOStream *     (* open_readwrite)              (GFile                *file,
462                                                        GCancellable         *cancellable,
463                                                        GError              **error);
464   void                (* open_readwrite_async)        (GFile                *file,
465                                                        int                   io_priority,
466                                                        GCancellable         *cancellable,
467                                                        GAsyncReadyCallback   callback,
468                                                        gpointer              user_data);
469   GFileIOStream *     (* open_readwrite_finish)       (GFile                *file,
470                                                        GAsyncResult         *res,
471                                                        GError              **error);
472   GFileIOStream *     (* create_readwrite)            (GFile                *file,
473                                                        GFileCreateFlags      flags,
474                                                        GCancellable         *cancellable,
475                                                        GError              **error);
476   void                (* create_readwrite_async)      (GFile                *file,
477                                                        GFileCreateFlags      flags,
478                                                        int                   io_priority,
479                                                        GCancellable         *cancellable,
480                                                        GAsyncReadyCallback   callback,
481                                                        gpointer              user_data);
482   GFileIOStream *     (* create_readwrite_finish)      (GFile                *file,
483                                                        GAsyncResult         *res,
484                                                        GError              **error);
485   GFileIOStream *     (* replace_readwrite)           (GFile                *file,
486                                                        const char           *etag,
487                                                        gboolean              make_backup,
488                                                        GFileCreateFlags      flags,
489                                                        GCancellable         *cancellable,
490                                                        GError              **error);
491   void                (* replace_readwrite_async)     (GFile                *file,
492                                                        const char           *etag,
493                                                        gboolean              make_backup,
494                                                        GFileCreateFlags      flags,
495                                                        int                   io_priority,
496                                                        GCancellable         *cancellable,
497                                                        GAsyncReadyCallback   callback,
498                                                        gpointer              user_data);
499   GFileIOStream *     (* replace_readwrite_finish)    (GFile                *file,
500                                                        GAsyncResult         *res,
501                                                        GError              **error);
502
503   void                (* start_mountable)             (GFile                *file,
504                                                        GDriveStartFlags      flags,
505                                                        GMountOperation      *start_operation,
506                                                        GCancellable         *cancellable,
507                                                        GAsyncReadyCallback   callback,
508                                                        gpointer              user_data);
509   gboolean            (* start_mountable_finish)      (GFile                *file,
510                                                        GAsyncResult         *result,
511                                                        GError              **error);
512
513   void                (* stop_mountable)              (GFile                *file,
514                                                        GMountUnmountFlags    flags,
515                                                        GMountOperation      *mount_operation,
516                                                        GCancellable         *cancellable,
517                                                        GAsyncReadyCallback   callback,
518                                                        gpointer              user_data);
519   gboolean            (* stop_mountable_finish)       (GFile                *file,
520                                                        GAsyncResult         *result,
521                                                        GError              **error);
522
523   gboolean            supports_thread_contexts;
524
525   void                (* unmount_mountable_with_operation) (GFile           *file,
526                                                        GMountUnmountFlags    flags,
527                                                        GMountOperation      *mount_operation,
528                                                        GCancellable         *cancellable,
529                                                        GAsyncReadyCallback   callback,
530                                                        gpointer              user_data);
531   gboolean            (* unmount_mountable_with_operation_finish) (GFile    *file,
532                                                        GAsyncResult         *result,
533                                                        GError              **error);
534
535   void                (* eject_mountable_with_operation) (GFile             *file,
536                                                        GMountUnmountFlags    flags,
537                                                        GMountOperation      *mount_operation,
538                                                        GCancellable         *cancellable,
539                                                        GAsyncReadyCallback   callback,
540                                                        gpointer              user_data);
541   gboolean            (* eject_mountable_with_operation_finish) (GFile      *file,
542                                                        GAsyncResult         *result,
543                                                        GError              **error);
544
545   void                (* poll_mountable)              (GFile                *file,
546                                                        GCancellable         *cancellable,
547                                                        GAsyncReadyCallback   callback,
548                                                        gpointer              user_data);
549   gboolean            (* poll_mountable_finish)       (GFile                *file,
550                                                        GAsyncResult         *result,
551                                                        GError              **error);
552 };
553
554 GType                   g_file_get_type                   (void) G_GNUC_CONST;
555
556 GFile *                 g_file_new_for_path               (const char                 *path);
557 GFile *                 g_file_new_for_uri                (const char                 *uri);
558 GFile *                 g_file_new_for_commandline_arg    (const char                 *arg);
559 GLIB_AVAILABLE_IN_2_36
560 GFile *                 g_file_new_for_commandline_arg_and_cwd (const gchar           *arg,
561                                                                 const gchar           *cwd);
562 GLIB_AVAILABLE_IN_2_32
563 GFile *                 g_file_new_tmp                    (const char                 *tmpl,
564                                                            GFileIOStream             **iostream,
565                                                            GError                    **error);
566 GFile *                 g_file_parse_name                 (const char                 *parse_name);
567 GFile *                 g_file_dup                        (GFile                      *file);
568 guint                   g_file_hash                       (gconstpointer               file);
569 gboolean                g_file_equal                      (GFile                      *file1,
570                                                            GFile                      *file2);
571 char *                  g_file_get_basename               (GFile                      *file);
572 char *                  g_file_get_path                   (GFile                      *file);
573 char *                  g_file_get_uri                    (GFile                      *file);
574 char *                  g_file_get_parse_name             (GFile                      *file);
575 GFile *                 g_file_get_parent                 (GFile                      *file);
576 gboolean                g_file_has_parent                 (GFile                      *file,
577                                                            GFile                      *parent);
578 GFile *                 g_file_get_child                  (GFile                      *file,
579                                                            const char                 *name);
580 GFile *                 g_file_get_child_for_display_name (GFile                      *file,
581                                                            const char                 *display_name,
582                                                            GError                    **error);
583 gboolean                g_file_has_prefix                 (GFile                      *file,
584                                                            GFile                      *prefix);
585 char *                  g_file_get_relative_path          (GFile                      *parent,
586                                                            GFile                      *descendant);
587 GFile *                 g_file_resolve_relative_path      (GFile                      *file,
588                                                            const char                 *relative_path);
589 gboolean                g_file_is_native                  (GFile                      *file);
590 gboolean                g_file_has_uri_scheme             (GFile                      *file,
591                                                            const char                 *uri_scheme);
592 char *                  g_file_get_uri_scheme             (GFile                      *file);
593 GFileInputStream *      g_file_read                       (GFile                      *file,
594                                                            GCancellable               *cancellable,
595                                                            GError                    **error);
596 void                    g_file_read_async                 (GFile                      *file,
597                                                            int                         io_priority,
598                                                            GCancellable               *cancellable,
599                                                            GAsyncReadyCallback         callback,
600                                                            gpointer                    user_data);
601 GFileInputStream *      g_file_read_finish                (GFile                      *file,
602                                                            GAsyncResult               *res,
603                                                            GError                    **error);
604 GFileOutputStream *     g_file_append_to                  (GFile                      *file,
605                                                            GFileCreateFlags             flags,
606                                                            GCancellable               *cancellable,
607                                                            GError                    **error);
608 GFileOutputStream *     g_file_create                     (GFile                      *file,
609                                                            GFileCreateFlags             flags,
610                                                            GCancellable               *cancellable,
611                                                            GError                    **error);
612 GFileOutputStream *     g_file_replace                    (GFile                      *file,
613                                                            const char                 *etag,
614                                                            gboolean                    make_backup,
615                                                            GFileCreateFlags            flags,
616                                                            GCancellable               *cancellable,
617                                                            GError                    **error);
618 void                    g_file_append_to_async            (GFile                      *file,
619                                                            GFileCreateFlags            flags,
620                                                            int                         io_priority,
621                                                            GCancellable               *cancellable,
622                                                            GAsyncReadyCallback         callback,
623                                                            gpointer                    user_data);
624 GFileOutputStream *     g_file_append_to_finish           (GFile                      *file,
625                                                            GAsyncResult               *res,
626                                                            GError                    **error);
627 void                    g_file_create_async               (GFile                      *file,
628                                                            GFileCreateFlags            flags,
629                                                            int                         io_priority,
630                                                            GCancellable               *cancellable,
631                                                            GAsyncReadyCallback         callback,
632                                                            gpointer                    user_data);
633 GFileOutputStream *     g_file_create_finish              (GFile                      *file,
634                                                            GAsyncResult               *res,
635                                                            GError                    **error);
636 void                    g_file_replace_async              (GFile                      *file,
637                                                            const char                 *etag,
638                                                            gboolean                    make_backup,
639                                                            GFileCreateFlags            flags,
640                                                            int                         io_priority,
641                                                            GCancellable               *cancellable,
642                                                            GAsyncReadyCallback         callback,
643                                                            gpointer                    user_data);
644 GFileOutputStream *     g_file_replace_finish             (GFile                      *file,
645                                                            GAsyncResult               *res,
646                                                            GError                    **error);
647 GFileIOStream *         g_file_open_readwrite             (GFile                      *file,
648                                                            GCancellable               *cancellable,
649                                                            GError                    **error);
650 void                    g_file_open_readwrite_async       (GFile                      *file,
651                                                            int                         io_priority,
652                                                            GCancellable               *cancellable,
653                                                            GAsyncReadyCallback         callback,
654                                                            gpointer                    user_data);
655 GFileIOStream *         g_file_open_readwrite_finish      (GFile                      *file,
656                                                            GAsyncResult               *res,
657                                                            GError                    **error);
658 GFileIOStream *         g_file_create_readwrite           (GFile                      *file,
659                                                            GFileCreateFlags            flags,
660                                                            GCancellable               *cancellable,
661                                                            GError                    **error);
662 void                    g_file_create_readwrite_async     (GFile                      *file,
663                                                            GFileCreateFlags            flags,
664                                                            int                         io_priority,
665                                                            GCancellable               *cancellable,
666                                                            GAsyncReadyCallback         callback,
667                                                            gpointer                    user_data);
668 GFileIOStream *         g_file_create_readwrite_finish    (GFile                      *file,
669                                                            GAsyncResult               *res,
670                                                            GError                    **error);
671 GFileIOStream *         g_file_replace_readwrite          (GFile                      *file,
672                                                            const char                 *etag,
673                                                            gboolean                    make_backup,
674                                                            GFileCreateFlags            flags,
675                                                            GCancellable               *cancellable,
676                                                            GError                    **error);
677 void                    g_file_replace_readwrite_async    (GFile                      *file,
678                                                            const char                 *etag,
679                                                            gboolean                    make_backup,
680                                                            GFileCreateFlags            flags,
681                                                            int                         io_priority,
682                                                            GCancellable               *cancellable,
683                                                            GAsyncReadyCallback         callback,
684                                                            gpointer                    user_data);
685 GFileIOStream *         g_file_replace_readwrite_finish   (GFile                      *file,
686                                                            GAsyncResult               *res,
687                                                            GError                    **error);
688 gboolean                g_file_query_exists               (GFile                      *file,
689                                                            GCancellable               *cancellable);
690 GFileType               g_file_query_file_type            (GFile                      *file,
691                                                            GFileQueryInfoFlags         flags,
692                                                            GCancellable               *cancellable);
693 GFileInfo *             g_file_query_info                 (GFile                      *file,
694                                                            const char                 *attributes,
695                                                            GFileQueryInfoFlags         flags,
696                                                            GCancellable               *cancellable,
697                                                            GError                    **error);
698 void                    g_file_query_info_async           (GFile                      *file,
699                                                            const char                 *attributes,
700                                                            GFileQueryInfoFlags         flags,
701                                                            int                         io_priority,
702                                                            GCancellable               *cancellable,
703                                                            GAsyncReadyCallback         callback,
704                                                            gpointer                    user_data);
705 GFileInfo *             g_file_query_info_finish          (GFile                      *file,
706                                                            GAsyncResult               *res,
707                                                            GError                    **error);
708 GFileInfo *             g_file_query_filesystem_info      (GFile                      *file,
709                                                            const char                 *attributes,
710                                                            GCancellable               *cancellable,
711                                                            GError                    **error);
712 void                    g_file_query_filesystem_info_async (GFile                      *file,
713                                                            const char                 *attributes,
714                                                            int                         io_priority,
715                                                            GCancellable               *cancellable,
716                                                            GAsyncReadyCallback         callback,
717                                                            gpointer                    user_data);
718 GFileInfo *             g_file_query_filesystem_info_finish (GFile                      *file,
719                                                            GAsyncResult               *res,
720                                                            GError                    **error);
721 GMount *                g_file_find_enclosing_mount       (GFile                      *file,
722                                                            GCancellable               *cancellable,
723                                                            GError                    **error);
724 void                    g_file_find_enclosing_mount_async (GFile                      *file,
725                                                            int                         io_priority,
726                                                            GCancellable               *cancellable,
727                                                            GAsyncReadyCallback         callback,
728                                                            gpointer                    user_data);
729 GMount *                g_file_find_enclosing_mount_finish (GFile                     *file,
730                                                             GAsyncResult              *res,
731                                                             GError                   **error);
732 GFileEnumerator *       g_file_enumerate_children         (GFile                      *file,
733                                                            const char                 *attributes,
734                                                            GFileQueryInfoFlags         flags,
735                                                            GCancellable               *cancellable,
736                                                            GError                    **error);
737 void                    g_file_enumerate_children_async   (GFile                      *file,
738                                                            const char                 *attributes,
739                                                            GFileQueryInfoFlags         flags,
740                                                            int                         io_priority,
741                                                            GCancellable               *cancellable,
742                                                            GAsyncReadyCallback         callback,
743                                                            gpointer                    user_data);
744 GFileEnumerator *       g_file_enumerate_children_finish  (GFile                      *file,
745                                                            GAsyncResult               *res,
746                                                            GError                    **error);
747 GFile *                 g_file_set_display_name           (GFile                      *file,
748                                                            const char                 *display_name,
749                                                            GCancellable               *cancellable,
750                                                            GError                    **error);
751 void                    g_file_set_display_name_async     (GFile                      *file,
752                                                            const char                 *display_name,
753                                                            int                         io_priority,
754                                                            GCancellable               *cancellable,
755                                                            GAsyncReadyCallback         callback,
756                                                            gpointer                    user_data);
757 GFile *                 g_file_set_display_name_finish    (GFile                      *file,
758                                                            GAsyncResult               *res,
759                                                            GError                    **error);
760 gboolean                g_file_delete                     (GFile                      *file,
761                                                            GCancellable               *cancellable,
762                                                            GError                    **error);
763
764 GLIB_AVAILABLE_IN_2_34
765 void                    g_file_delete_async               (GFile                      *file,
766                                                            int                         io_priority,
767                                                            GCancellable               *cancellable,
768                                                            GAsyncReadyCallback         callback,
769                                                            gpointer                    user_data);
770
771 GLIB_AVAILABLE_IN_2_34
772 gboolean                g_file_delete_finish              (GFile                      *file,
773                                                            GAsyncResult               *result,
774                                                            GError                    **error);
775
776 gboolean                g_file_trash                      (GFile                      *file,
777                                                            GCancellable               *cancellable,
778                                                            GError                    **error);
779 gboolean                g_file_copy                       (GFile                      *source,
780                                                            GFile                      *destination,
781                                                            GFileCopyFlags              flags,
782                                                            GCancellable               *cancellable,
783                                                            GFileProgressCallback       progress_callback,
784                                                            gpointer                    progress_callback_data,
785                                                            GError                    **error);
786 void                    g_file_copy_async                 (GFile                      *source,
787                                                            GFile                      *destination,
788                                                            GFileCopyFlags              flags,
789                                                            int                         io_priority,
790                                                            GCancellable               *cancellable,
791                                                            GFileProgressCallback       progress_callback,
792                                                            gpointer                    progress_callback_data,
793                                                            GAsyncReadyCallback         callback,
794                                                            gpointer                    user_data);
795 gboolean                g_file_copy_finish                (GFile                      *file,
796                                                            GAsyncResult               *res,
797                                                            GError                    **error);
798 gboolean                g_file_move                       (GFile                      *source,
799                                                            GFile                      *destination,
800                                                            GFileCopyFlags              flags,
801                                                            GCancellable               *cancellable,
802                                                            GFileProgressCallback       progress_callback,
803                                                            gpointer                    progress_callback_data,
804                                                            GError                    **error);
805 gboolean                g_file_make_directory             (GFile                      *file,
806                                                            GCancellable               *cancellable,
807                                                            GError                    **error);
808 gboolean                g_file_make_directory_with_parents (GFile                     *file,
809                                                            GCancellable               *cancellable,
810                                                            GError                    **error);
811 gboolean                g_file_make_symbolic_link         (GFile                      *file,
812                                                            const char                 *symlink_value,
813                                                            GCancellable               *cancellable,
814                                                            GError                    **error);
815 GFileAttributeInfoList *g_file_query_settable_attributes  (GFile                      *file,
816                                                            GCancellable               *cancellable,
817                                                            GError                    **error);
818 GFileAttributeInfoList *g_file_query_writable_namespaces  (GFile                      *file,
819                                                            GCancellable               *cancellable,
820                                                            GError                    **error);
821 gboolean                g_file_set_attribute              (GFile                      *file,
822                                                            const char                 *attribute,
823                                                            GFileAttributeType          type,
824                                                            gpointer                    value_p,
825                                                            GFileQueryInfoFlags         flags,
826                                                            GCancellable               *cancellable,
827                                                            GError                    **error);
828 gboolean                g_file_set_attributes_from_info   (GFile                      *file,
829                                                            GFileInfo                  *info,
830                                                            GFileQueryInfoFlags         flags,
831                                                            GCancellable               *cancellable,
832                                                            GError                    **error);
833 void                    g_file_set_attributes_async       (GFile                      *file,
834                                                            GFileInfo                  *info,
835                                                            GFileQueryInfoFlags         flags,
836                                                            int                         io_priority,
837                                                            GCancellable               *cancellable,
838                                                            GAsyncReadyCallback         callback,
839                                                            gpointer                    user_data);
840 gboolean                g_file_set_attributes_finish      (GFile                      *file,
841                                                            GAsyncResult               *result,
842                                                            GFileInfo                 **info,
843                                                            GError                    **error);
844 gboolean                g_file_set_attribute_string       (GFile                      *file,
845                                                            const char                 *attribute,
846                                                            const char                 *value,
847                                                            GFileQueryInfoFlags         flags,
848                                                            GCancellable               *cancellable,
849                                                            GError                    **error);
850 gboolean                g_file_set_attribute_byte_string  (GFile                      *file,
851                                                            const char                 *attribute,
852                                                            const char                 *value,
853                                                            GFileQueryInfoFlags         flags,
854                                                            GCancellable               *cancellable,
855                                                            GError                    **error);
856 gboolean                g_file_set_attribute_uint32       (GFile                      *file,
857                                                            const char                 *attribute,
858                                                            guint32                     value,
859                                                            GFileQueryInfoFlags         flags,
860                                                            GCancellable               *cancellable,
861                                                            GError                    **error);
862 gboolean                g_file_set_attribute_int32        (GFile                      *file,
863                                                            const char                 *attribute,
864                                                            gint32                      value,
865                                                            GFileQueryInfoFlags         flags,
866                                                            GCancellable               *cancellable,
867                                                            GError                    **error);
868 gboolean                g_file_set_attribute_uint64       (GFile                      *file,
869                                                            const char                 *attribute,
870                                                            guint64                     value,
871                                                            GFileQueryInfoFlags         flags,
872                                                            GCancellable               *cancellable,
873                                                            GError                    **error);
874 gboolean                g_file_set_attribute_int64        (GFile                      *file,
875                                                            const char                 *attribute,
876                                                            gint64                      value,
877                                                            GFileQueryInfoFlags         flags,
878                                                            GCancellable               *cancellable,
879                                                            GError                    **error);
880 void                    g_file_mount_enclosing_volume     (GFile                      *location,
881                                                            GMountMountFlags            flags,
882                                                            GMountOperation            *mount_operation,
883                                                            GCancellable               *cancellable,
884                                                            GAsyncReadyCallback         callback,
885                                                            gpointer                    user_data);
886 gboolean                g_file_mount_enclosing_volume_finish (GFile                      *location,
887                                                            GAsyncResult               *result,
888                                                            GError                    **error);
889 void                    g_file_mount_mountable            (GFile                      *file,
890                                                            GMountMountFlags            flags,
891                                                            GMountOperation            *mount_operation,
892                                                            GCancellable               *cancellable,
893                                                            GAsyncReadyCallback         callback,
894                                                            gpointer                    user_data);
895 GFile *                 g_file_mount_mountable_finish     (GFile                      *file,
896                                                            GAsyncResult               *result,
897                                                            GError                    **error);
898 GLIB_DEPRECATED_FOR(g_file_unmount_mountable_with_operation)
899 void                    g_file_unmount_mountable          (GFile                      *file,
900                                                            GMountUnmountFlags          flags,
901                                                            GCancellable               *cancellable,
902                                                            GAsyncReadyCallback         callback,
903                                                            gpointer                    user_data);
904
905 GLIB_DEPRECATED_FOR(g_file_unmount_mountable_with_operation_finish)
906 gboolean                g_file_unmount_mountable_finish   (GFile                      *file,
907                                                            GAsyncResult               *result,
908                                                            GError                    **error);
909 void                    g_file_unmount_mountable_with_operation (GFile                *file,
910                                                            GMountUnmountFlags          flags,
911                                                            GMountOperation            *mount_operation,
912                                                            GCancellable               *cancellable,
913                                                            GAsyncReadyCallback         callback,
914                                                            gpointer                    user_data);
915 gboolean                g_file_unmount_mountable_with_operation_finish (GFile         *file,
916                                                            GAsyncResult               *result,
917                                                            GError                    **error);
918 GLIB_DEPRECATED_FOR(g_file_eject_mountable_with_operation)
919 void                    g_file_eject_mountable            (GFile                      *file,
920                                                            GMountUnmountFlags          flags,
921                                                            GCancellable               *cancellable,
922                                                            GAsyncReadyCallback         callback,
923                                                            gpointer                    user_data);
924
925 GLIB_DEPRECATED_FOR(g_file_eject_mountable_with_operation_finish)
926 gboolean                g_file_eject_mountable_finish     (GFile                      *file,
927                                                            GAsyncResult               *result,
928                                                            GError                    **error);
929 void                    g_file_eject_mountable_with_operation (GFile                  *file,
930                                                            GMountUnmountFlags          flags,
931                                                            GMountOperation            *mount_operation,
932                                                            GCancellable               *cancellable,
933                                                            GAsyncReadyCallback         callback,
934                                                            gpointer                    user_data);
935 gboolean                g_file_eject_mountable_with_operation_finish (GFile           *file,
936                                                            GAsyncResult               *result,
937                                                            GError                    **error);
938
939 gboolean                g_file_copy_attributes            (GFile                      *source,
940                                                            GFile                      *destination,
941                                                            GFileCopyFlags              flags,
942                                                            GCancellable               *cancellable,
943                                                            GError                    **error);
944
945
946 GFileMonitor*           g_file_monitor_directory          (GFile                  *file,
947                                                            GFileMonitorFlags       flags,
948                                                            GCancellable           *cancellable,
949                                                            GError                **error);
950 GFileMonitor*           g_file_monitor_file               (GFile                  *file,
951                                                            GFileMonitorFlags       flags,
952                                                            GCancellable           *cancellable,
953                                                            GError                **error);
954 GFileMonitor*           g_file_monitor                    (GFile                  *file,
955                                                            GFileMonitorFlags       flags,
956                                                            GCancellable           *cancellable,
957                                                            GError                **error);
958
959 void                    g_file_start_mountable            (GFile                      *file,
960                                                            GDriveStartFlags            flags,
961                                                            GMountOperation            *start_operation,
962                                                            GCancellable               *cancellable,
963                                                            GAsyncReadyCallback         callback,
964                                                            gpointer                    user_data);
965 gboolean                g_file_start_mountable_finish     (GFile                      *file,
966                                                            GAsyncResult               *result,
967                                                            GError                    **error);
968 void                    g_file_stop_mountable             (GFile                      *file,
969                                                            GMountUnmountFlags          flags,
970                                                            GMountOperation            *mount_operation,
971                                                            GCancellable               *cancellable,
972                                                            GAsyncReadyCallback         callback,
973                                                            gpointer                    user_data);
974 gboolean                g_file_stop_mountable_finish      (GFile                      *file,
975                                                            GAsyncResult               *result,
976                                                            GError                    **error);
977
978 void                    g_file_poll_mountable             (GFile                      *file,
979                                                            GCancellable               *cancellable,
980                                                            GAsyncReadyCallback         callback,
981                                                            gpointer                    user_data);
982 gboolean                g_file_poll_mountable_finish      (GFile                      *file,
983                                                            GAsyncResult               *result,
984                                                            GError                    **error);
985
986 /* Utilities */
987
988 GAppInfo *g_file_query_default_handler       (GFile                  *file,
989                                               GCancellable           *cancellable,
990                                               GError                **error);
991 gboolean g_file_load_contents                (GFile                  *file,
992                                               GCancellable           *cancellable,
993                                               char                  **contents,
994                                               gsize                  *length,
995                                               char                  **etag_out,
996                                               GError                **error);
997 void     g_file_load_contents_async          (GFile                  *file,
998                                               GCancellable           *cancellable,
999                                               GAsyncReadyCallback     callback,
1000                                               gpointer                user_data);
1001 gboolean g_file_load_contents_finish         (GFile                  *file,
1002                                               GAsyncResult           *res,
1003                                               char                  **contents,
1004                                               gsize                  *length,
1005                                               char                  **etag_out,
1006                                               GError                **error);
1007 void     g_file_load_partial_contents_async  (GFile                  *file,
1008                                               GCancellable           *cancellable,
1009                                               GFileReadMoreCallback   read_more_callback,
1010                                               GAsyncReadyCallback     callback,
1011                                               gpointer                user_data);
1012 gboolean g_file_load_partial_contents_finish (GFile                  *file,
1013                                               GAsyncResult           *res,
1014                                               char                  **contents,
1015                                               gsize                  *length,
1016                                               char                  **etag_out,
1017                                               GError                **error);
1018 gboolean g_file_replace_contents             (GFile                  *file,
1019                                               const char             *contents,
1020                                               gsize                   length,
1021                                               const char             *etag,
1022                                               gboolean                make_backup,
1023                                               GFileCreateFlags        flags,
1024                                               char                  **new_etag,
1025                                               GCancellable           *cancellable,
1026                                               GError                **error);
1027 void     g_file_replace_contents_async       (GFile                  *file,
1028                                               const char             *contents,
1029                                               gsize                   length,
1030                                               const char             *etag,
1031                                               gboolean                make_backup,
1032                                               GFileCreateFlags        flags,
1033                                               GCancellable           *cancellable,
1034                                               GAsyncReadyCallback     callback,
1035                                               gpointer                user_data);
1036 gboolean g_file_replace_contents_finish      (GFile                  *file,
1037                                               GAsyncResult           *res,
1038                                               char                  **new_etag,
1039                                               GError                **error);
1040
1041 gboolean g_file_supports_thread_contexts     (GFile                  *file);
1042
1043 G_END_DECLS
1044
1045 #endif /* __G_FILE_H__ */