gio/gvfs.h

   1 /* GIO - GLib Input, Output and Streaming Library
   2  *
   3  * Copyright (C) 2006-2007 Red Hat, Inc.
   4  *
   5  * SPDX-License-Identifier: LGPL-2.1-or-later
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Lesser General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2.1 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Lesser General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Lesser General
  18  * Public License along with this library; if not, see <http://www.gnu.org/licenses/>.
  19  *
  20  * Author: Alexander Larsson <alexl@redhat.com>
  21  */
  22
  23 #ifndef __G_VFS_H__
  24 #define __G_VFS_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_VFS         (g_vfs_get_type ())
  35 #define G_VFS(o)           (G_TYPE_CHECK_INSTANCE_CAST ((o), G_TYPE_VFS, GVfs))
  36 #define G_VFS_CLASS(k)     (G_TYPE_CHECK_CLASS_CAST((k), G_TYPE_VFS, GVfsClass))
  37 #define G_VFS_GET_CLASS(o) (G_TYPE_INSTANCE_GET_CLASS ((o), G_TYPE_VFS, GVfsClass))
  38 #define G_IS_VFS(o)        (G_TYPE_CHECK_INSTANCE_TYPE ((o), G_TYPE_VFS))
  39 #define G_IS_VFS_CLASS(k)  (G_TYPE_CHECK_CLASS_TYPE ((k), G_TYPE_VFS))
  40
  41 /**
  42  * GVfsFileLookupFunc:
  43  * @vfs: a #GVfs
  44  * @identifier: the identifier to look up a #GFile for. This can either
  45  *     be an URI or a parse name as returned by g_file_get_parse_name()
  46  * @user_data: user data passed to the function
  47  *
  48  * This function type is used by g_vfs_register_uri_scheme() to make it
  49  * possible for a client to associate an URI scheme to a different #GFile
  50  * implementation.
  51  *
  52  * The client should return a reference to the new file that has been
  53  * created for @uri, or %NULL to continue with the default implementation.
  54  *
  55  * Returns: (transfer full): a #GFile for @identifier.
  56  *
  57  * Since: 2.50
  58  */
  59 typedef GFile * (* GVfsFileLookupFunc) (GVfs       *vfs,
  60                                         const char *identifier,
  61                                         gpointer    user_data);
  62
  63 /**
  64  * G_VFS_EXTENSION_POINT_NAME:
  65  *
  66  * Extension point for #GVfs functionality.
  67  * See [Extending GIO][extending-gio].
  68  */
  69 #define G_VFS_EXTENSION_POINT_NAME "gio-vfs"
  70
  71 /**
  72  * GVfs:
  73  *
  74  * Virtual File System object.
  75  **/
  76 typedef struct _GVfsClass    GVfsClass;
  77
  78 struct _GVfs
  79 {
  80   GObject parent_instance;
  81 };
  82
  83 struct _GVfsClass
  84 {
  85   GObjectClass parent_class;
  86
  87   /* Virtual Table */
  88
  89   gboolean              (* is_active)                 (GVfs       *vfs);
  90   GFile               * (* get_file_for_path)         (GVfs       *vfs,
  91                                                        const char *path);
  92   GFile               * (* get_file_for_uri)          (GVfs       *vfs,
  93                                                        const char *uri);
  94   const gchar * const * (* get_supported_uri_schemes) (GVfs       *vfs);
  95   GFile               * (* parse_name)                (GVfs       *vfs,
  96                                                        const char *parse_name);
  97
  98   /*< private >*/
  99   void                  (* local_file_add_info)       (GVfs       *vfs,
 100                                                        const char *filename,
 101                                                        guint64     device,
 102                                                        GFileAttributeMatcher *attribute_matcher,
 103                                                        GFileInfo  *info,
 104                                                        GCancellable *cancellable,
 105                                                        gpointer   *extra_data,
 106                                                        GDestroyNotify *free_extra_data);
 107   void                  (* add_writable_namespaces)   (GVfs       *vfs,
 108                                                        GFileAttributeInfoList *list);
 109   gboolean              (* local_file_set_attributes) (GVfs       *vfs,
 110                                                        const char *filename,
 111                                                        GFileInfo  *info,
 112                                                        GFileQueryInfoFlags flags,
 113                                                        GCancellable *cancellable,
 114                                                        GError    **error);
 115   void                  (* local_file_removed)        (GVfs       *vfs,
 116                                                        const char *filename);
 117   void                  (* local_file_moved)          (GVfs       *vfs,
 118                                                        const char *source,
 119                                                        const char *dest);
 120   GIcon *               (* deserialize_icon)          (GVfs       *vfs,
 121                                                        GVariant   *value);
 122   /* Padding for future expansion */
 123   void (*_g_reserved1) (void);
 124   void (*_g_reserved2) (void);
 125   void (*_g_reserved3) (void);
 126   void (*_g_reserved4) (void);
 127   void (*_g_reserved5) (void);
 128   void (*_g_reserved6) (void);
 129 };
 130
 131 GIO_AVAILABLE_IN_ALL
 132 GType                 g_vfs_get_type                  (void) G_GNUC_CONST;
 133
 134 GIO_AVAILABLE_IN_ALL
 135 gboolean              g_vfs_is_active                 (GVfs       *vfs);
 136 GIO_AVAILABLE_IN_ALL
 137 GFile *               g_vfs_get_file_for_path         (GVfs       *vfs,
 138                                                        const char *path);
 139 GIO_AVAILABLE_IN_ALL
 140 GFile *               g_vfs_get_file_for_uri          (GVfs       *vfs,
 141                                                        const char *uri);
 142 GIO_AVAILABLE_IN_ALL
 143 const gchar* const * g_vfs_get_supported_uri_schemes  (GVfs       *vfs);
 144
 145 GIO_AVAILABLE_IN_ALL
 146 GFile *               g_vfs_parse_name                (GVfs       *vfs,
 147                                                        const char *parse_name);
 148
 149 GIO_AVAILABLE_IN_ALL
 150 GVfs *                g_vfs_get_default               (void);
 151 GIO_AVAILABLE_IN_ALL
 152 GVfs *                g_vfs_get_local                 (void);
 153
 154 GIO_AVAILABLE_IN_2_50
 155 gboolean              g_vfs_register_uri_scheme       (GVfs               *vfs,
 156                                                        const char         *scheme,
 157                                                        GVfsFileLookupFunc  uri_func,
 158                                                        gpointer            uri_data,
 159                                                        GDestroyNotify      uri_destroy,
 160                                                        GVfsFileLookupFunc  parse_name_func,
 161                                                        gpointer            parse_name_data,
 162                                                        GDestroyNotify      parse_name_destroy);
 163 GIO_AVAILABLE_IN_2_50
 164 gboolean              g_vfs_unregister_uri_scheme     (GVfs               *vfs,
 165                                                        const char         *scheme);
 166
 167
 168 G_END_DECLS
 169
 170 #endif /* __G_VFS_H__ */