gio/gvfs.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_VFS_H__
  24 #define __G_VFS_H__
  25
  26 #include <glib-object.h>
  27 #include <gio/gfile.h>
  28
  29 G_BEGIN_DECLS
  30
  31 #define G_TYPE_VFS         (g_vfs_get_type ())
  32 #define G_VFS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_VFS, GVfs))
  33 #define G_VFS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_VFS, GVfsClass))
  34 #define G_VFS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_VFS, GVfsClass))
  35 #define G_IS_VFS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_VFS))
  36 #define G_IS_VFS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_VFS))
  37
  38 /**
  39  * GVfs:
  40  *
  41  * Virtual File System object.
  42  **/
  43 typedef struct _GVfs         GVfs; /* Dummy typedef */
  44 typedef struct _GVfsClass    GVfsClass;
  45
  46 struct _GVfs {
  47   GObject parent_instance;
  48 };
  49
  50 struct _GVfsClass
  51 {
  52   GObjectClass parent_class;
  53
  54   const char *name;
  55   int priority;
  56
  57   /* Virtual Table */
  58
  59   gboolean             (*is_active)                 (GVfs *vfs);
  60   GFile               *(*get_file_for_path)         (GVfs *vfs,
  61                                                      const char *path);
  62   GFile               *(*get_file_for_uri)          (GVfs *vfs,
  63                                                      const char *uri);
  64   const gchar * const *(*get_supported_uri_schemes) (GVfs *vfs);
  65   GFile               *(*parse_name)                (GVfs *vfs,
  66                                                      const char *parse_name);
  67
  68
  69   /*< private >*/
  70   /* Padding for future expansion */
  71   void (*_g_reserved1) (void);
  72   void (*_g_reserved2) (void);
  73   void (*_g_reserved3) (void);
  74   void (*_g_reserved4) (void);
  75   void (*_g_reserved5) (void);
  76   void (*_g_reserved6) (void);
  77   void (*_g_reserved7) (void);
  78   void (*_g_reserved8) (void);
  79   void (*_g_reserved9) (void);
  80   void (*_g_reserved10) (void);
  81   void (*_g_reserved11) (void);
  82   void (*_g_reserved12) (void);
  83
  84 };
  85
  86 GType g_vfs_get_type (void) G_GNUC_CONST;
  87
  88 gboolean              g_vfs_is_active                 (GVfs       *vfs);
  89 GFile *               g_vfs_get_file_for_path         (GVfs       *vfs,
  90                                                        const char *path);
  91 GFile *               g_vfs_get_file_for_uri          (GVfs       *vfs,
  92                                                        const char *uri);
  93 const gchar * const * g_vfs_get_supported_uri_schemes (GVfs *vfs);
  94
  95 GFile *               g_vfs_parse_name                (GVfs       *vfs,
  96                                                        const char *parse_name);
  97
  98 GVfs *                g_vfs_get_default               (void);
  99 GVfs *                g_vfs_get_local                 (void);
 100
 101 G_END_DECLS
 102
 103 #endif /* __G_VFS_H__ */