gio/gvfs.c

   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 #include "config.h"
  24 #include <string.h>
  25 #include "gvfs.h"
  26 #include "glocalvfs.h"
  27 #include "gresourcefile.h"
  28 #include "giomodule-priv.h"
  29 #include "glibintl.h"
  30
  31
  32 /**
  33  * SECTION:gvfs
  34  * @short_description: Virtual File System
  35  * @include: gio/gio.h
  36  *
  37  * Entry point for using GIO functionality.
  38  *
  39  **/
  40
  41 G_DEFINE_TYPE (GVfs, g_vfs, G_TYPE_OBJECT);
  42
  43 static void
  44 g_vfs_class_init (GVfsClass *klass)
  45 {
  46 }
  47
  48 static void
  49 g_vfs_init (GVfs *vfs)
  50 {
  51 }
  52
  53 /**
  54  * g_vfs_is_active:
  55  * @vfs: a #GVfs.
  56  *
  57  * Checks if the VFS is active.
  58  *
  59  * Returns: %TRUE if construction of the @vfs was successful and it is now active.
  60  **/
  61 gboolean
  62 g_vfs_is_active (GVfs *vfs)
  63 {
  64   GVfsClass *class;
  65
  66   g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
  67
  68   class = G_VFS_GET_CLASS (vfs);
  69
  70   return (* class->is_active) (vfs);
  71 }
  72
  73
  74 /**
  75  * g_vfs_get_file_for_path:
  76  * @vfs: a #GVfs.
  77  * @path: a string containing a VFS path.
  78  *
  79  * Gets a #GFile for @path.
  80  *
  81  * Returns: (transfer full): a #GFile.
  82  *     Free the returned object with g_object_unref().
  83  **/
  84 GFile *
  85 g_vfs_get_file_for_path (GVfs       *vfs,
  86                          const char *path)
  87 {
  88   GVfsClass *class;
  89
  90   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
  91   g_return_val_if_fail (path != NULL, NULL);
  92
  93   class = G_VFS_GET_CLASS (vfs);
  94
  95   return (* class->get_file_for_path) (vfs, path);
  96 }
  97
  98 /**
  99  * g_vfs_get_file_for_uri:
 100  * @vfs: a#GVfs.
 101  * @uri: a string containing a URI
 102  *
 103  * Gets a #GFile for @uri.
 104  *
 105  * This operation never fails, but the returned object
 106  * might not support any I/O operation if the URI
 107  * is malformed or if the URI scheme is not supported.
 108  *
 109  * Returns: (transfer full): a #GFile.
 110  *     Free the returned object with g_object_unref().
 111  **/
 112 GFile *
 113 g_vfs_get_file_for_uri (GVfs       *vfs,
 114                         const char *uri)
 115 {
 116   GVfsClass *class;
 117
 118   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 119   g_return_val_if_fail (uri != NULL, NULL);
 120
 121   class = G_VFS_GET_CLASS (vfs);
 122
 123   /* This is an unfortunate placement, but we really
 124      need to check this before chaining to the vfs,
 125      because we want to support resource uris for
 126      all vfs:es, even those that predate resources. */
 127   if (g_str_has_prefix (uri, "resource:"))
 128     return _g_resource_file_new (uri);
 129
 130   return (* class->get_file_for_uri) (vfs, uri);
 131 }
 132
 133 /**
 134  * g_vfs_get_supported_uri_schemes:
 135  * @vfs: a #GVfs.
 136  *
 137  * Gets a list of URI schemes supported by @vfs.
 138  *
 139  * Returns: (transfer none): a %NULL-terminated array of strings.
 140  *     The returned array belongs to GIO and must
 141  *     not be freed or modified.
 142  **/
 143 const gchar * const *
 144 g_vfs_get_supported_uri_schemes (GVfs *vfs)
 145 {
 146   GVfsClass *class;
 147
 148   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 149
 150   class = G_VFS_GET_CLASS (vfs);
 151
 152   return (* class->get_supported_uri_schemes) (vfs);
 153 }
 154
 155 /**
 156  * g_vfs_parse_name:
 157  * @vfs: a #GVfs.
 158  * @parse_name: a string to be parsed by the VFS module.
 159  *
 160  * This operation never fails, but the returned object might
 161  * not support any I/O operations if the @parse_name cannot
 162  * be parsed by the #GVfs module.
 163  *
 164  * Returns: (transfer full): a #GFile for the given @parse_name.
 165  *     Free the returned object with g_object_unref().
 166  **/
 167 GFile *
 168 g_vfs_parse_name (GVfs       *vfs,
 169                   const char *parse_name)
 170 {
 171   GVfsClass *class;
 172
 173   g_return_val_if_fail (G_IS_VFS (vfs), NULL);
 174   g_return_val_if_fail (parse_name != NULL, NULL);
 175
 176   class = G_VFS_GET_CLASS (vfs);
 177
 178   if (g_str_has_prefix (parse_name, "resource:"))
 179     return _g_resource_file_new (parse_name);
 180
 181   return (* class->parse_name) (vfs, parse_name);
 182 }
 183
 184 /**
 185  * g_vfs_get_default:
 186  *
 187  * Gets the default #GVfs for the system.
 188  *
 189  * Returns: (transfer none): a #GVfs.
 190  **/
 191 GVfs *
 192 g_vfs_get_default (void)
 193 {
 194   return _g_io_module_get_default (G_VFS_EXTENSION_POINT_NAME,
 195                                    "GIO_USE_VFS",
 196                                    (GIOModuleVerifyFunc)g_vfs_is_active);
 197 }
 198
 199 /**
 200  * g_vfs_get_local:
 201  *
 202  * Gets the local #GVfs for the system.
 203  *
 204  * Returns: (transfer none): a #GVfs.
 205  **/
 206 GVfs *
 207 g_vfs_get_local (void)
 208 {
 209   static gsize vfs = 0;
 210
 211   if (g_once_init_enter (&vfs))
 212     g_once_init_leave (&vfs, (gsize)_g_local_vfs_new ());
 213
 214   return G_VFS (vfs);
 215 }