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 #if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
  24 #error "Only <gio/gio.h> can be included directly."
  25 #endif
  26
  27 #ifndef __G_FILE_H__
  28 #define __G_FILE_H__
  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  *
 149  * An interface for writing VFS file handles.
 150  **/
 151 struct _GFileIface
 152 {
 153   GTypeInterface g_iface;
 154
 155   /* Virtual Table */
 156
 157   GFile *             (* dup)                         (GFile         *file);
 158   guint               (* hash)                        (GFile         *file);
 159   gboolean            (* equal)                       (GFile         *file1,
 160                                                        GFile         *file2);
 161   gboolean            (* is_native)                   (GFile         *file);
 162   gboolean            (* has_uri_scheme)              (GFile         *file,
 163                                                        const char    *uri_scheme);
 164   char *              (* get_uri_scheme)              (GFile         *file);
 165   char *              (* get_basename)                (GFile         *file);
 166   char *              (* get_path)                    (GFile         *file);
 167   char *              (* get_uri)                     (GFile         *file);
 168   char *              (* get_parse_name)              (GFile         *file);
 169   GFile *             (* get_parent)                  (GFile         *file);
 170   gboolean            (* prefix_matches)              (GFile         *prefix,
 171                                                        GFile         *file);
 172   char *              (* get_relative_path)           (GFile         *parent,
 173                                                        GFile         *descendant);
 174   GFile *             (* resolve_relative_path)       (GFile        *file,
 175                                                        const char   *relative_path);
 176   GFile *             (* get_child_for_display_name)  (GFile        *file,
 177                                                        const char   *display_name,
 178                                                        GError      **error);
 179
 180   GFileEnumerator *   (* enumerate_children)          (GFile                *file,
 181                                                        const char           *attributes,
 182                                                        GFileQueryInfoFlags   flags,
 183                                                        GCancellable         *cancellable,
 184                                                        GError              **error);
 185   void                (* enumerate_children_async)    (GFile                *file,
 186                                                        const char           *attributes,
 187                                                        GFileQueryInfoFlags   flags,
 188                                                        int                   io_priority,
 189                                                        GCancellable         *cancellable,
 190                                                        GAsyncReadyCallback   callback,
 191                                                        gpointer              user_data);
 192   GFileEnumerator *   (* enumerate_children_finish)   (GFile                *file,
 193                                                        GAsyncResult         *res,
 194                                                        GError              **error);
 195
 196   GFileInfo *         (* query_info)                  (GFile                *file,
 197                                                        const char           *attributes,
 198                                                        GFileQueryInfoFlags   flags,
 199                                                        GCancellable         *cancellable,
 200                                                        GError              **error);
 201   void                (* query_info_async)            (GFile                *file,
 202                                                        const char           *attributes,
 203                                                        GFileQueryInfoFlags   flags,
 204                                                        int                   io_priority,
 205                                                        GCancellable         *cancellable,
 206                                                        GAsyncReadyCallback   callback,
 207                                                        gpointer              user_data);
 208   GFileInfo *         (* query_info_finish)           (GFile                *file,
 209                                                        GAsyncResult         *res,
 210                                                        GError              **error);
 211
 212   GFileInfo *         (* query_filesystem_info)       (GFile                *file,
 213                                                        const char           *attributes,
 214                                                        GCancellable         *cancellable,
 215                                                        GError              **error);
 216   void                (* query_filesystem_info_async) (GFile                *file,
 217                                                        const char           *attributes,
 218                                                        int                   io_priority,
 219                                                        GCancellable         *cancellable,
 220                                                        GAsyncReadyCallback   callback,
 221                                                        gpointer              user_data);
 222   GFileInfo *         (* query_filesystem_info_finish)(GFile                *file,
 223                                                        GAsyncResult         *res,
 224                                                        GError              **error);
 225
 226   GMount *            (* find_enclosing_mount)        (GFile                *file,
 227                                                        GCancellable         *cancellable,
 228                                                        GError              **error);
 229   void                (* find_enclosing_mount_async)  (GFile                *file,
 230                                                        int                   io_priority,
 231                                                        GCancellable         *cancellable,
 232                                                        GAsyncReadyCallback   callback,
 233                                                        gpointer              user_data);
 234   GMount *            (* find_enclosing_mount_finish) (GFile                *file,
 235                                                        GAsyncResult         *res,
 236                                                        GError              **error);
 237
 238   GFile *             (* set_display_name)            (GFile                *file,
 239                                                        const char           *display_name,
 240                                                        GCancellable         *cancellable,
 241                                                        GError              **error);
 242   void                (* set_display_name_async)      (GFile                *file,
 243                                                        const char           *display_name,
 244                                                        int                   io_priority,
 245                                                        GCancellable         *cancellable,
 246                                                        GAsyncReadyCallback   callback,
 247                                                        gpointer              user_data);
 248   GFile *             (* set_display_name_finish)     (GFile                *file,
 249                                                        GAsyncResult         *res,
 250                                                        GError              **error);
 251
 252   GFileAttributeInfoList * (* query_settable_attributes)    (GFile          *file,
 253                                                              GCancellable   *cancellable,
 254                                                              GError        **error);
 255   void                (* _query_settable_attributes_async)  (void);
 256   void                (* _query_settable_attributes_finish) (void);
 257
 258   GFileAttributeInfoList * (* query_writable_namespaces)    (GFile          *file,
 259                                                              GCancellable   *cancellable,
 260                                                              GError        **error);
 261   void                (* _query_writable_namespaces_async)  (void);
 262   void                (* _query_writable_namespaces_finish) (void);
 263
 264   gboolean            (* set_attribute)               (GFile                *file,
 265                                                        const char           *attribute,
 266                                                        GFileAttributeType    type,
 267                                                        gpointer              value_p,
 268                                                        GFileQueryInfoFlags   flags,
 269                                                        GCancellable         *cancellable,
 270                                                        GError              **error);
 271   gboolean            (* set_attributes_from_info)    (GFile                *file,
 272                                                        GFileInfo            *info,
 273                                                        GFileQueryInfoFlags   flags,
 274                                                        GCancellable         *cancellable,
 275                                                        GError              **error);
 276   void                (* set_attributes_async)        (GFile                *file,
 277                                                        GFileInfo            *info,
 278                                                        GFileQueryInfoFlags   flags,
 279                                                        int                   io_priority,
 280                                                        GCancellable         *cancellable,
 281                                                        GAsyncReadyCallback   callback,
 282                                                        gpointer              user_data);
 283   gboolean            (* set_attributes_finish)       (GFile                *file,
 284                                                        GAsyncResult         *result,
 285                                                        GFileInfo           **info,
 286                                                        GError              **error);
 287
 288   GFileInputStream *  (* read_fn)                     (GFile                *file,
 289                                                        GCancellable         *cancellable,
 290                                                        GError              **error);
 291   void                (* read_async)                  (GFile                *file,
 292                                                        int                   io_priority,
 293                                                        GCancellable         *cancellable,
 294                                                        GAsyncReadyCallback   callback,
 295                                                        gpointer              user_data);
 296   GFileInputStream *  (* read_finish)                 (GFile                *file,
 297                                                        GAsyncResult         *res,
 298                                                        GError              **error);
 299
 300   GFileOutputStream * (* append_to)                   (GFile                *file,
 301                                                        GFileCreateFlags      flags,
 302                                                        GCancellable         *cancellable,
 303                                                        GError              **error);
 304   void                (* append_to_async)             (GFile                *file,
 305                                                        GFileCreateFlags      flags,
 306                                                        int                   io_priority,
 307                                                        GCancellable         *cancellable,
 308                                                        GAsyncReadyCallback   callback,
 309                                                        gpointer              user_data);
 310   GFileOutputStream * (* append_to_finish)            (GFile                *file,
 311                                                        GAsyncResult         *res,
 312                                                        GError              **error);
 313
 314   GFileOutputStream * (* create)                      (GFile                *file,
 315                                                        GFileCreateFlags      flags,
 316                                                        GCancellable         *cancellable,
 317                                                        GError              **error);
 318   void                (* create_async)                (GFile                *file,
 319                                                        GFileCreateFlags      flags,
 320                                                        int                   io_priority,
 321                                                        GCancellable         *cancellable,
 322                                                        GAsyncReadyCallback   callback,
 323                                                        gpointer              user_data);
 324   GFileOutputStream * (* create_finish)               (GFile                *file,
 325                                                        GAsyncResult         *res,
 326                                                        GError              **error);
 327
 328   GFileOutputStream * (* replace)                     (GFile                *file,
 329                                                        const char           *etag,
 330                                                        gboolean              make_backup,
 331                                                        GFileCreateFlags      flags,
 332                                                        GCancellable         *cancellable,
 333                                                        GError              **error);
 334   void                (* replace_async)               (GFile                *file,
 335                                                        const char           *etag,
 336                                                        gboolean              make_backup,
 337                                                        GFileCreateFlags      flags,
 338                                                        int                   io_priority,
 339                                                        GCancellable         *cancellable,
 340                                                        GAsyncReadyCallback   callback,
 341                                                        gpointer              user_data);
 342   GFileOutputStream * (* replace_finish)              (GFile                *file,
 343                                                        GAsyncResult         *res,
 344                                                        GError              **error);
 345
 346   gboolean            (* delete_file)                 (GFile                *file,
 347                                                        GCancellable         *cancellable,
 348                                                        GError              **error);
 349   void                (* _delete_file_async)          (void);
 350   void                (* _delete_file_finish)         (void);
 351
 352   gboolean            (* trash)                       (GFile                *file,
 353                                                        GCancellable         *cancellable,
 354                                                        GError              **error);
 355   void                (* _trash_async)                (void);
 356   void                (* _trash_finish)               (void);
 357
 358   gboolean            (* make_directory)              (GFile                *file,
 359                                                        GCancellable         *cancellable,
 360                                                        GError              **error);
 361   void                (* _make_directory_async)       (void);
 362   void                (* _make_directory_finish)      (void);
 363
 364   gboolean            (* make_symbolic_link)          (GFile                *file,
 365                                                        const char           *symlink_value,
 366                                                        GCancellable         *cancellable,
 367                                                        GError              **error);
 368   void                (* _make_symbolic_link_async)   (void);
 369   void                (* _make_symbolic_link_finish)  (void);
 370
 371   gboolean            (* copy)                        (GFile                *source,
 372                                                        GFile                *destination,
 373                                                        GFileCopyFlags        flags,
 374                                                        GCancellable         *cancellable,
 375                                                        GFileProgressCallback progress_callback,
 376                                                        gpointer              progress_callback_data,
 377                                                        GError              **error);
 378   void                (* copy_async)                  (GFile                *source,
 379                                                        GFile                *destination,
 380                                                        GFileCopyFlags        flags,
 381                                                        int                   io_priority,
 382                                                        GCancellable         *cancellable,
 383                                                        GFileProgressCallback progress_callback,
 384                                                        gpointer              progress_callback_data,
 385                                                        GAsyncReadyCallback   callback,
 386                                                        gpointer              user_data);
 387   gboolean            (* copy_finish)                 (GFile                *file,
 388                                                        GAsyncResult         *res,
 389                                                        GError              **error);
 390
 391   gboolean            (* move)                        (GFile                *source,
 392                                                        GFile                *destination,
 393                                                        GFileCopyFlags        flags,
 394                                                        GCancellable         *cancellable,
 395                                                        GFileProgressCallback progress_callback,
 396                                                        gpointer              progress_callback_data,
 397                                                        GError              **error);
 398   void                (* _move_async)                 (void);
 399   void                (* _move_finish)                (void);
 400
 401   void                (* mount_mountable)             (GFile                *file,
 402                                                        GMountMountFlags      flags,
 403                                                        GMountOperation      *mount_operation,
 404                                                        GCancellable         *cancellable,
 405                                                        GAsyncReadyCallback   callback,
 406                                                        gpointer              user_data);
 407   GFile *             (* mount_mountable_finish)      (GFile                *file,
 408                                                        GAsyncResult         *result,
 409                                                        GError              **error);
 410
 411   void                (* unmount_mountable)           (GFile                *file,
 412                                                        GMountUnmountFlags    flags,
 413                                                        GCancellable         *cancellable,
 414                                                        GAsyncReadyCallback   callback,
 415                                                        gpointer              user_data);
 416   gboolean            (* unmount_mountable_finish)    (GFile                *file,
 417                                                        GAsyncResult         *result,
 418                                                        GError              **error);
 419
 420   void                (* eject_mountable)             (GFile                *file,
 421                                                        GMountUnmountFlags    flags,
 422                                                        GCancellable         *cancellable,
 423                                                        GAsyncReadyCallback   callback,
 424                                                        gpointer              user_data);
 425   gboolean            (* eject_mountable_finish)      (GFile                *file,
 426                                                        GAsyncResult         *result,
 427                                                        GError              **error);
 428
 429   void                (* mount_enclosing_volume)      (GFile                *location,
 430                                                        GMountMountFlags      flags,
 431                                                        GMountOperation      *mount_operation,
 432                                                        GCancellable         *cancellable,
 433                                                        GAsyncReadyCallback   callback,
 434                                                        gpointer              user_data);
 435   gboolean         (* mount_enclosing_volume_finish)  (GFile                *location,
 436                                                        GAsyncResult         *result,
 437                                                        GError              **error);
 438
 439   GFileMonitor *      (* monitor_dir)                 (GFile                *file,
 440                                                        GFileMonitorFlags     flags,
 441                                                        GCancellable         *cancellable,
 442                                                        GError              **error);
 443   GFileMonitor *      (* monitor_file)                (GFile                *file,
 444                                                        GFileMonitorFlags     flags,
 445                                                        GCancellable         *cancellable,
 446                                                        GError              **error);
 447
 448   GFileIOStream *     (* open_readwrite)              (GFile                *file,
 449                                                        GCancellable         *cancellable,
 450                                                        GError              **error);
 451   void                (* open_readwrite_async)        (GFile                *file,
 452                                                        int                   io_priority,
 453                                                        GCancellable         *cancellable,
 454                                                        GAsyncReadyCallback   callback,
 455                                                        gpointer              user_data);
 456   GFileIOStream *     (* open_readwrite_finish)       (GFile                *file,
 457                                                        GAsyncResult         *res,
 458                                                        GError              **error);
 459   GFileIOStream *     (* create_readwrite)            (GFile                *file,
 460                                                        GFileCreateFlags      flags,
 461                                                        GCancellable         *cancellable,
 462                                                        GError              **error);
 463   void                (* create_readwrite_async)      (GFile                *file,
 464                                                        GFileCreateFlags      flags,
 465                                                        int                   io_priority,
 466                                                        GCancellable         *cancellable,
 467                                                        GAsyncReadyCallback   callback,
 468                                                        gpointer              user_data);
 469   GFileIOStream *     (* create_readwrite_finish)      (GFile                *file,
 470                                                        GAsyncResult         *res,
 471                                                        GError              **error);
 472   GFileIOStream *     (* replace_readwrite)           (GFile                *file,
 473                                                        const char           *etag,
 474                                                        gboolean              make_backup,
 475                                                        GFileCreateFlags      flags,
 476                                                        GCancellable         *cancellable,
 477                                                        GError              **error);
 478   void                (* replace_readwrite_async)     (GFile                *file,
 479                                                        const char           *etag,
 480                                                        gboolean              make_backup,
 481                                                        GFileCreateFlags      flags,
 482                                                        int                   io_priority,
 483                                                        GCancellable         *cancellable,
 484                                                        GAsyncReadyCallback   callback,
 485                                                        gpointer              user_data);
 486   GFileIOStream *     (* replace_readwrite_finish)    (GFile                *file,
 487                                                        GAsyncResult         *res,
 488                                                        GError              **error);
 489
 490   void                (* start_mountable)             (GFile                *file,
 491                                                        GDriveStartFlags      flags,
 492                                                        GMountOperation      *start_operation,
 493                                                        GCancellable         *cancellable,
 494                                                        GAsyncReadyCallback   callback,
 495                                                        gpointer              user_data);
 496   gboolean            (* start_mountable_finish)      (GFile                *file,
 497                                                        GAsyncResult         *result,
 498                                                        GError              **error);
 499
 500   void                (* stop_mountable)              (GFile                *file,
 501                                                        GMountUnmountFlags    flags,
 502                                                        GCancellable         *cancellable,
 503                                                        GAsyncReadyCallback   callback,
 504                                                        gpointer              user_data);
 505   gboolean            (* stop_mountable_finish)       (GFile                *file,
 506                                                        GAsyncResult         *result,
 507                                                        GError              **error);
 508   gboolean            supports_thread_contexts;
 509 };
 510
 511 GType                   g_file_get_type                   (void) G_GNUC_CONST;
 512
 513 GFile *                 g_file_new_for_path               (const char                 *path);
 514 GFile *                 g_file_new_for_uri                (const char                 *uri);
 515 GFile *                 g_file_new_for_commandline_arg    (const char                 *arg);
 516 GFile *                 g_file_parse_name                 (const char                 *parse_name);
 517 GFile *                 g_file_dup                        (GFile                      *file);
 518 guint                   g_file_hash                       (gconstpointer               file);
 519 gboolean                g_file_equal                      (GFile                      *file1,
 520                                                            GFile                      *file2);
 521 char *                  g_file_get_basename               (GFile                      *file);
 522 char *                  g_file_get_path                   (GFile                      *file);
 523 char *                  g_file_get_uri                    (GFile                      *file);
 524 char *                  g_file_get_parse_name             (GFile                      *file);
 525 GFile *                 g_file_get_parent                 (GFile                      *file);
 526 GFile *                 g_file_get_child                  (GFile                      *file,
 527                                                            const char                 *name);
 528 GFile *                 g_file_get_child_for_display_name (GFile                      *file,
 529                                                            const char                 *display_name,
 530                                                            GError                    **error);
 531 gboolean                g_file_has_prefix                 (GFile                      *file,
 532                                                            GFile                      *prefix);
 533 char *                  g_file_get_relative_path          (GFile                      *parent,
 534                                                            GFile                      *descendant);
 535 GFile *                 g_file_resolve_relative_path      (GFile                      *file,
 536                                                            const char                 *relative_path);
 537 gboolean                g_file_is_native                  (GFile                      *file);
 538 gboolean                g_file_has_uri_scheme             (GFile                      *file,
 539                                                            const char                 *uri_scheme);
 540 char *                  g_file_get_uri_scheme             (GFile                      *file);
 541 GFileInputStream *      g_file_read                       (GFile                      *file,
 542                                                            GCancellable               *cancellable,
 543                                                            GError                    **error);
 544 void                    g_file_read_async                 (GFile                      *file,
 545                                                            int                         io_priority,
 546                                                            GCancellable               *cancellable,
 547                                                            GAsyncReadyCallback         callback,
 548                                                            gpointer                    user_data);
 549 GFileInputStream *      g_file_read_finish                (GFile                      *file,
 550                                                            GAsyncResult               *res,
 551                                                            GError                    **error);
 552 GFileOutputStream *     g_file_append_to                  (GFile                      *file,
 553                                                            GFileCreateFlags             flags,
 554                                                            GCancellable               *cancellable,
 555                                                            GError                    **error);
 556 GFileOutputStream *     g_file_create                     (GFile                      *file,
 557                                                            GFileCreateFlags             flags,
 558                                                            GCancellable               *cancellable,
 559                                                            GError                    **error);
 560 GFileOutputStream *     g_file_replace                    (GFile                      *file,
 561                                                            const char                 *etag,
 562                                                            gboolean                    make_backup,
 563                                                            GFileCreateFlags            flags,
 564                                                            GCancellable               *cancellable,
 565                                                            GError                    **error);
 566 void                    g_file_append_to_async            (GFile                      *file,
 567                                                            GFileCreateFlags            flags,
 568                                                            int                         io_priority,
 569                                                            GCancellable               *cancellable,
 570                                                            GAsyncReadyCallback         callback,
 571                                                            gpointer                    user_data);
 572 GFileOutputStream *     g_file_append_to_finish           (GFile                      *file,
 573                                                            GAsyncResult               *res,
 574                                                            GError                    **error);
 575 void                    g_file_create_async               (GFile                      *file,
 576                                                            GFileCreateFlags            flags,
 577                                                            int                         io_priority,
 578                                                            GCancellable               *cancellable,
 579                                                            GAsyncReadyCallback         callback,
 580                                                            gpointer                    user_data);
 581 GFileOutputStream *     g_file_create_finish              (GFile                      *file,
 582                                                            GAsyncResult               *res,
 583                                                            GError                    **error);
 584 void                    g_file_replace_async              (GFile                      *file,
 585                                                            const char                 *etag,
 586                                                            gboolean                    make_backup,
 587                                                            GFileCreateFlags            flags,
 588                                                            int                         io_priority,
 589                                                            GCancellable               *cancellable,
 590                                                            GAsyncReadyCallback         callback,
 591                                                            gpointer                    user_data);
 592 GFileOutputStream *     g_file_replace_finish             (GFile                      *file,
 593                                                            GAsyncResult               *res,
 594                                                            GError                    **error);
 595 GFileIOStream *         g_file_open_readwrite             (GFile                      *file,
 596                                                            GCancellable               *cancellable,
 597                                                            GError                    **error);
 598 void                    g_file_open_readwrite_async       (GFile                      *file,
 599                                                            int                         io_priority,
 600                                                            GCancellable               *cancellable,
 601                                                            GAsyncReadyCallback         callback,
 602                                                            gpointer                    user_data);
 603 GFileIOStream *         g_file_open_readwrite_finish      (GFile                      *file,
 604                                                            GAsyncResult               *res,
 605                                                            GError                    **error);
 606 GFileIOStream *         g_file_create_readwrite           (GFile                      *file,
 607                                                            GFileCreateFlags            flags,
 608                                                            GCancellable               *cancellable,
 609                                                            GError                    **error);
 610 void                    g_file_create_readwrite_async     (GFile                      *file,
 611                                                            GFileCreateFlags            flags,
 612                                                            int                         io_priority,
 613                                                            GCancellable               *cancellable,
 614                                                            GAsyncReadyCallback         callback,
 615                                                            gpointer                    user_data);
 616 GFileIOStream *         g_file_create_readwrite_finish    (GFile                      *file,
 617                                                            GAsyncResult               *res,
 618                                                            GError                    **error);
 619 GFileIOStream *         g_file_replace_readwrite          (GFile                      *file,
 620                                                            const char                 *etag,
 621                                                            gboolean                    make_backup,
 622                                                            GFileCreateFlags            flags,
 623                                                            GCancellable               *cancellable,
 624                                                            GError                    **error);
 625 void                    g_file_replace_readwrite_async    (GFile                      *file,
 626                                                            const char                 *etag,
 627                                                            gboolean                    make_backup,
 628                                                            GFileCreateFlags            flags,
 629                                                            int                         io_priority,
 630                                                            GCancellable               *cancellable,
 631                                                            GAsyncReadyCallback         callback,
 632                                                            gpointer                    user_data);
 633 GFileIOStream *         g_file_replace_readwrite_finish   (GFile                      *file,
 634                                                            GAsyncResult               *res,
 635                                                            GError                    **error);
 636 gboolean                g_file_query_exists               (GFile                      *file,
 637                                                            GCancellable               *cancellable);
 638 GFileType               g_file_query_file_type            (GFile                      *file,
 639                                                            GFileQueryInfoFlags         flags,
 640                                                            GCancellable               *cancellable);
 641 GFileInfo *             g_file_query_info                 (GFile                      *file,
 642                                                            const char                 *attributes,
 643                                                            GFileQueryInfoFlags         flags,
 644                                                            GCancellable               *cancellable,
 645                                                            GError                    **error);
 646 void                    g_file_query_info_async           (GFile                      *file,
 647                                                            const char                 *attributes,
 648                                                            GFileQueryInfoFlags         flags,
 649                                                            int                         io_priority,
 650                                                            GCancellable               *cancellable,
 651                                                            GAsyncReadyCallback         callback,
 652                                                            gpointer                    user_data);
 653 GFileInfo *             g_file_query_info_finish          (GFile                      *file,
 654                                                            GAsyncResult               *res,
 655                                                            GError                    **error);
 656 GFileInfo *             g_file_query_filesystem_info      (GFile                      *file,
 657                                                            const char                 *attributes,
 658                                                            GCancellable               *cancellable,
 659                                                            GError                    **error);
 660 void                    g_file_query_filesystem_info_async (GFile                      *file,
 661                                                            const char                 *attributes,
 662                                                            int                         io_priority,
 663                                                            GCancellable               *cancellable,
 664                                                            GAsyncReadyCallback         callback,
 665                                                            gpointer                    user_data);
 666 GFileInfo *             g_file_query_filesystem_info_finish (GFile                      *file,
 667                                                            GAsyncResult               *res,
 668                                                            GError                    **error);
 669 GMount *                g_file_find_enclosing_mount       (GFile                      *file,
 670                                                            GCancellable               *cancellable,
 671                                                            GError                    **error);
 672 void                    g_file_find_enclosing_mount_async (GFile                      *file,
 673                                                            int                         io_priority,
 674                                                            GCancellable               *cancellable,
 675                                                            GAsyncReadyCallback         callback,
 676                                                            gpointer                    user_data);
 677 GMount *                g_file_find_enclosing_mount_finish (GFile                     *file,
 678                                                             GAsyncResult              *res,
 679                                                             GError                   **error);
 680 GFileEnumerator *       g_file_enumerate_children         (GFile                      *file,
 681                                                            const char                 *attributes,
 682                                                            GFileQueryInfoFlags         flags,
 683                                                            GCancellable               *cancellable,
 684                                                            GError                    **error);
 685 void                    g_file_enumerate_children_async   (GFile                      *file,
 686                                                            const char                 *attributes,
 687                                                            GFileQueryInfoFlags         flags,
 688                                                            int                         io_priority,
 689                                                            GCancellable               *cancellable,
 690                                                            GAsyncReadyCallback         callback,
 691                                                            gpointer                    user_data);
 692 GFileEnumerator *       g_file_enumerate_children_finish  (GFile                      *file,
 693                                                            GAsyncResult               *res,
 694                                                            GError                    **error);
 695 GFile *                 g_file_set_display_name           (GFile                      *file,
 696                                                            const char                 *display_name,
 697                                                            GCancellable               *cancellable,
 698                                                            GError                    **error);
 699 void                    g_file_set_display_name_async     (GFile                      *file,
 700                                                            const char                 *display_name,
 701                                                            int                         io_priority,
 702                                                            GCancellable               *cancellable,
 703                                                            GAsyncReadyCallback         callback,
 704                                                            gpointer                    user_data);
 705 GFile *                 g_file_set_display_name_finish    (GFile                      *file,
 706                                                            GAsyncResult               *res,
 707                                                            GError                    **error);
 708 gboolean                g_file_delete                     (GFile                      *file,
 709                                                            GCancellable               *cancellable,
 710                                                            GError                    **error);
 711 gboolean                g_file_trash                      (GFile                      *file,
 712                                                            GCancellable               *cancellable,
 713                                                            GError                    **error);
 714 gboolean                g_file_copy                       (GFile                      *source,
 715                                                            GFile                      *destination,
 716                                                            GFileCopyFlags              flags,
 717                                                            GCancellable               *cancellable,
 718                                                            GFileProgressCallback       progress_callback,
 719                                                            gpointer                    progress_callback_data,
 720                                                            GError                    **error);
 721 void                    g_file_copy_async                 (GFile                      *source,
 722                                                            GFile                      *destination,
 723                                                            GFileCopyFlags              flags,
 724                                                            int                         io_priority,
 725                                                            GCancellable               *cancellable,
 726                                                            GFileProgressCallback       progress_callback,
 727                                                            gpointer                    progress_callback_data,
 728                                                            GAsyncReadyCallback         callback,
 729                                                            gpointer                    user_data);
 730 gboolean                g_file_copy_finish                (GFile                      *file,
 731                                                            GAsyncResult               *res,
 732                                                            GError                    **error);
 733 gboolean                g_file_move                       (GFile                      *source,
 734                                                            GFile                      *destination,
 735                                                            GFileCopyFlags              flags,
 736                                                            GCancellable               *cancellable,
 737                                                            GFileProgressCallback       progress_callback,
 738                                                            gpointer                    progress_callback_data,
 739                                                            GError                    **error);
 740 gboolean                g_file_make_directory             (GFile                      *file,
 741                                                            GCancellable               *cancellable,
 742                                                            GError                    **error);
 743 gboolean                g_file_make_directory_with_parents (GFile                     *file,
 744                                                            GCancellable               *cancellable,
 745                                                            GError                    **error);
 746 gboolean                g_file_make_symbolic_link         (GFile                      *file,
 747                                                            const char                 *symlink_value,
 748                                                            GCancellable               *cancellable,
 749                                                            GError                    **error);
 750 GFileAttributeInfoList *g_file_query_settable_attributes  (GFile                      *file,
 751                                                            GCancellable               *cancellable,
 752                                                            GError                    **error);
 753 GFileAttributeInfoList *g_file_query_writable_namespaces  (GFile                      *file,
 754                                                            GCancellable               *cancellable,
 755                                                            GError                    **error);
 756 gboolean                g_file_set_attribute              (GFile                      *file,
 757                                                            const char                 *attribute,
 758                                                            GFileAttributeType          type,
 759                                                            gpointer                    value_p,
 760                                                            GFileQueryInfoFlags         flags,
 761                                                            GCancellable               *cancellable,
 762                                                            GError                    **error);
 763 gboolean                g_file_set_attributes_from_info   (GFile                      *file,
 764                                                            GFileInfo                  *info,
 765                                                            GFileQueryInfoFlags         flags,
 766                                                            GCancellable               *cancellable,
 767                                                            GError                    **error);
 768 void                    g_file_set_attributes_async       (GFile                      *file,
 769                                                            GFileInfo                  *info,
 770                                                            GFileQueryInfoFlags         flags,
 771                                                            int                         io_priority,
 772                                                            GCancellable               *cancellable,
 773                                                            GAsyncReadyCallback         callback,
 774                                                            gpointer                    user_data);
 775 gboolean                g_file_set_attributes_finish      (GFile                      *file,
 776                                                            GAsyncResult               *result,
 777                                                            GFileInfo                 **info,
 778                                                            GError                    **error);
 779 gboolean                g_file_set_attribute_string       (GFile                      *file,
 780                                                            const char                 *attribute,
 781                                                            const char                 *value,
 782                                                            GFileQueryInfoFlags         flags,
 783                                                            GCancellable               *cancellable,
 784                                                            GError                    **error);
 785 gboolean                g_file_set_attribute_byte_string  (GFile                      *file,
 786                                                            const char                 *attribute,
 787                                                            const char                 *value,
 788                                                            GFileQueryInfoFlags         flags,
 789                                                            GCancellable               *cancellable,
 790                                                            GError                    **error);
 791 gboolean                g_file_set_attribute_uint32       (GFile                      *file,
 792                                                            const char                 *attribute,
 793                                                            guint32                     value,
 794                                                            GFileQueryInfoFlags         flags,
 795                                                            GCancellable               *cancellable,
 796                                                            GError                    **error);
 797 gboolean                g_file_set_attribute_int32        (GFile                      *file,
 798                                                            const char                 *attribute,
 799                                                            gint32                      value,
 800                                                            GFileQueryInfoFlags         flags,
 801                                                            GCancellable               *cancellable,
 802                                                            GError                    **error);
 803 gboolean                g_file_set_attribute_uint64       (GFile                      *file,
 804                                                            const char                 *attribute,
 805                                                            guint64                     value,
 806                                                            GFileQueryInfoFlags         flags,
 807                                                            GCancellable               *cancellable,
 808                                                            GError                    **error);
 809 gboolean                g_file_set_attribute_int64        (GFile                      *file,
 810                                                            const char                 *attribute,
 811                                                            gint64                      value,
 812                                                            GFileQueryInfoFlags         flags,
 813                                                            GCancellable               *cancellable,
 814                                                            GError                    **error);
 815 void                    g_file_mount_enclosing_volume     (GFile                      *location,
 816                                                            GMountMountFlags            flags,
 817                                                            GMountOperation            *mount_operation,
 818                                                            GCancellable               *cancellable,
 819                                                            GAsyncReadyCallback         callback,
 820                                                            gpointer                    user_data);
 821 gboolean                g_file_mount_enclosing_volume_finish (GFile                      *location,
 822                                                            GAsyncResult               *result,
 823                                                            GError                    **error);
 824 void                    g_file_mount_mountable            (GFile                      *file,
 825                                                            GMountMountFlags            flags,
 826                                                            GMountOperation            *mount_operation,
 827                                                            GCancellable               *cancellable,
 828                                                            GAsyncReadyCallback         callback,
 829                                                            gpointer                    user_data);
 830 GFile *                 g_file_mount_mountable_finish     (GFile                      *file,
 831                                                            GAsyncResult               *result,
 832                                                            GError                    **error);
 833 void                    g_file_unmount_mountable          (GFile                      *file,
 834                                                            GMountUnmountFlags          flags,
 835                                                            GCancellable               *cancellable,
 836                                                            GAsyncReadyCallback         callback,
 837                                                            gpointer                    user_data);
 838 gboolean                g_file_unmount_mountable_finish   (GFile                      *file,
 839                                                            GAsyncResult               *result,
 840                                                            GError                    **error);
 841 void                    g_file_eject_mountable            (GFile                      *file,
 842                                                            GMountUnmountFlags          flags,
 843                                                            GCancellable               *cancellable,
 844                                                            GAsyncReadyCallback         callback,
 845                                                            gpointer                    user_data);
 846 gboolean                g_file_eject_mountable_finish     (GFile                      *file,
 847                                                            GAsyncResult               *result,
 848                                                            GError                    **error);
 849
 850 gboolean                g_file_copy_attributes            (GFile                      *source,
 851                                                            GFile                      *destination,
 852                                                            GFileCopyFlags              flags,
 853                                                            GCancellable               *cancellable,
 854                                                            GError                    **error);
 855
 856
 857 GFileMonitor*           g_file_monitor_directory          (GFile                  *file,
 858                                                            GFileMonitorFlags       flags,
 859                                                            GCancellable           *cancellable,
 860                                                            GError                **error);
 861 GFileMonitor*           g_file_monitor_file               (GFile                  *file,
 862                                                            GFileMonitorFlags       flags,
 863                                                            GCancellable           *cancellable,
 864                                                            GError                **error);
 865 GFileMonitor*           g_file_monitor                    (GFile                  *file,
 866                                                            GFileMonitorFlags       flags,
 867                                                            GCancellable           *cancellable,
 868                                                            GError                **error);
 869
 870 void                    g_file_start_mountable            (GFile                      *file,
 871                                                            GDriveStartFlags            flags,
 872                                                            GMountOperation            *start_operation,
 873                                                            GCancellable               *cancellable,
 874                                                            GAsyncReadyCallback         callback,
 875                                                            gpointer                    user_data);
 876 gboolean                g_file_start_mountable_finish     (GFile                      *file,
 877                                                            GAsyncResult               *result,
 878                                                            GError                    **error);
 879 void                    g_file_stop_mountable             (GFile                      *file,
 880                                                            GMountUnmountFlags          flags,
 881                                                            GCancellable               *cancellable,
 882                                                            GAsyncReadyCallback         callback,
 883                                                            gpointer                    user_data);
 884 gboolean                g_file_stop_mountable_finish      (GFile                      *file,
 885                                                            GAsyncResult               *result,
 886                                                            GError                    **error);
 887
 888
 889 /* Utilities */
 890
 891 GAppInfo *g_file_query_default_handler       (GFile                  *file,
 892                                               GCancellable           *cancellable,
 893                                               GError                **error);
 894 gboolean g_file_load_contents                (GFile                  *file,
 895                                               GCancellable           *cancellable,
 896                                               char                  **contents,
 897                                               gsize                  *length,
 898                                               char                  **etag_out,
 899                                               GError                **error);
 900 void     g_file_load_contents_async          (GFile                  *file,
 901                                               GCancellable           *cancellable,
 902                                               GAsyncReadyCallback     callback,
 903                                               gpointer                user_data);
 904 gboolean g_file_load_contents_finish         (GFile                  *file,
 905                                               GAsyncResult           *res,
 906                                               char                  **contents,
 907                                               gsize                  *length,
 908                                               char                  **etag_out,
 909                                               GError                **error);
 910 void     g_file_load_partial_contents_async  (GFile                  *file,
 911                                               GCancellable           *cancellable,
 912                                               GFileReadMoreCallback   read_more_callback,
 913                                               GAsyncReadyCallback     callback,
 914                                               gpointer                user_data);
 915 gboolean g_file_load_partial_contents_finish (GFile                  *file,
 916                                               GAsyncResult           *res,
 917                                               char                  **contents,
 918                                               gsize                  *length,
 919                                               char                  **etag_out,
 920                                               GError                **error);
 921 gboolean g_file_replace_contents             (GFile                  *file,
 922                                               const char             *contents,
 923                                               gsize                   length,
 924                                               const char             *etag,
 925                                               gboolean                make_backup,
 926                                               GFileCreateFlags        flags,
 927                                               char                  **new_etag,
 928                                               GCancellable           *cancellable,
 929                                               GError                **error);
 930 void     g_file_replace_contents_async       (GFile                  *file,
 931                                               const char             *contents,
 932                                               gsize                   length,
 933                                               const char             *etag,
 934                                               gboolean                make_backup,
 935                                               GFileCreateFlags        flags,
 936                                               GCancellable           *cancellable,
 937                                               GAsyncReadyCallback     callback,
 938                                               gpointer                user_data);
 939 gboolean g_file_replace_contents_finish      (GFile                  *file,
 940                                               GAsyncResult           *res,
 941                                               char                  **new_etag,
 942                                               GError                **error);
 943
 944 gboolean g_file_supports_thread_contexts     (GFile                  *file);
 945
 946 G_END_DECLS
 947
 948 #endif /* __G_FILE_H__ */