gvfs.h 4.57 KB
Newer Older
1
/* GIO - GLib Input, Output and Streaming Library
2
 *
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22
 * Copyright (C) 2006-2007 Red Hat, Inc.
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General
 * Public License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307, USA.
 *
 * Author: Alexander Larsson <alexl@redhat.com>
 */

23 24 25 26
#if !defined (__GIO_GIO_H_INSIDE__) && !defined (GIO_COMPILATION)
#error "Only <gio/gio.h> can be included directly."
#endif

27 28
#ifndef __G_VFS_H__
#define __G_VFS_H__
29

30
#include <gio/giotypes.h>
31 32 33 34 35 36 37 38 39 40

G_BEGIN_DECLS

#define G_TYPE_VFS         (g_vfs_get_type ())
#define G_VFS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_VFS, GVfs))
#define G_VFS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_VFS, GVfsClass))
#define G_VFS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_VFS, GVfsClass))
#define G_IS_VFS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_VFS))
#define G_IS_VFS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_VFS))

Matthias Clasen's avatar
Matthias Clasen committed
41 42 43
/**
 * G_VFS_EXTENSION_POINT_NAME:
 *
44
 * Extension point for #GVfs functionality.
45
 * See <link linkend="extending-gio">Extending GIO</link>.
Matthias Clasen's avatar
Matthias Clasen committed
46
 */
47 48
#define G_VFS_EXTENSION_POINT_NAME "gio-vfs"

49 50
/**
 * GVfs:
51
 *
52 53
 * Virtual File System object.
 **/
54 55
typedef struct _GVfsClass    GVfsClass;

56 57
struct _GVfs
{
58
  GObject parent_instance;
59 60 61 62 63 64 65 66
};

struct _GVfsClass
{
  GObjectClass parent_class;

  /* Virtual Table */

67 68 69 70 71 72 73 74
  gboolean              (* is_active)                 (GVfs       *vfs);
  GFile               * (* get_file_for_path)         (GVfs       *vfs,
                                                       const char *path);
  GFile               * (* get_file_for_uri)          (GVfs       *vfs,
                                                       const char *uri);
  const gchar * const * (* get_supported_uri_schemes) (GVfs       *vfs);
  GFile               * (* parse_name)                (GVfs       *vfs,
                                                       const char *parse_name);
75

76
  /*< private >*/
77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97
  void                  (* local_file_add_info)       (GVfs       *vfs,
						       const char *filename,
						       guint64     device,
						       GFileAttributeMatcher *attribute_matcher,
						       GFileInfo  *info,
						       GCancellable *cancellable,
						       gpointer   *extra_data,
						       GDestroyNotify *free_extra_data);
  void                  (* add_writable_namespaces)   (GVfs       *vfs,
						       GFileAttributeInfoList *list);
  gboolean              (* local_file_set_attributes) (GVfs       *vfs,
						       const char *filename,
						       GFileInfo  *info,
                                                       GFileQueryInfoFlags flags,
                                                       GCancellable *cancellable,
						       GError    **error);
  void                  (* local_file_removed)        (GVfs       *vfs,
						       const char *filename);
  void                  (* local_file_moved)          (GVfs       *vfs,
						       const char *source,
						       const char *dest);
98
  /* Padding for future expansion */
99 100 101 102 103 104 105 106 107
  void (*_g_reserved1) (void);
  void (*_g_reserved2) (void);
  void (*_g_reserved3) (void);
  void (*_g_reserved4) (void);
  void (*_g_reserved5) (void);
  void (*_g_reserved6) (void);
  void (*_g_reserved7) (void);
};

108
GType                 g_vfs_get_type                  (void) G_GNUC_CONST;
109 110 111

gboolean              g_vfs_is_active                 (GVfs       *vfs);
GFile *               g_vfs_get_file_for_path         (GVfs       *vfs,
112
                                                       const char *path);
113
GFile *               g_vfs_get_file_for_uri          (GVfs       *vfs,
114 115
                                                       const char *uri);
const gchar* const * g_vfs_get_supported_uri_schemes  (GVfs       *vfs);
116 117

GFile *               g_vfs_parse_name                (GVfs       *vfs,
118
                                                       const char *parse_name);
119 120 121 122 123 124 125

GVfs *                g_vfs_get_default               (void);
GVfs *                g_vfs_get_local                 (void);

G_END_DECLS

#endif /* __G_VFS_H__ */