1 /* GIO - GLib Input, Output and Streaming Library
3 * Copyright (C) 2006-2007 Red Hat, Inc.
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.
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.
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.
20 * Author: Alexander Larsson <alexl@redhat.com>
26 #include "glocalvfs.h"
27 #include "giomodule-priv.h"
34 * @short_description: Virtual File System
37 * Entry point for using GIO functionality.
41 G_DEFINE_TYPE (GVfs, g_vfs, G_TYPE_OBJECT);
44 g_vfs_class_init (GVfsClass *klass)
49 g_vfs_init (GVfs *vfs)
57 * Checks if the VFS is active.
59 * Returns: %TRUE if construction of the @vfs was successful and it is now active.
62 g_vfs_is_active (GVfs *vfs)
66 g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
68 class = G_VFS_GET_CLASS (vfs);
70 return (* class->is_active) (vfs);
75 * g_vfs_get_file_for_path:
77 * @path: a string containing a VFS path.
79 * Gets a #GFile for @path.
82 * Free the returned object with g_object_unref().
85 g_vfs_get_file_for_path (GVfs *vfs,
90 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
91 g_return_val_if_fail (path != NULL, NULL);
93 class = G_VFS_GET_CLASS (vfs);
95 return (* class->get_file_for_path) (vfs, path);
99 * g_vfs_get_file_for_uri:
101 * @uri: a string containing a URI
103 * Gets a #GFile for @uri.
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.
110 * Free the returned object with g_object_unref().
113 g_vfs_get_file_for_uri (GVfs *vfs,
118 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
119 g_return_val_if_fail (uri != NULL, NULL);
121 class = G_VFS_GET_CLASS (vfs);
123 return (* class->get_file_for_uri) (vfs, uri);
127 * g_vfs_get_supported_uri_schemes:
130 * Gets a list of URI schemes supported by @vfs.
132 * Returns: a %NULL-terminated array of strings.
133 * The returned array belongs to GIO and must
134 * not be freed or modified.
136 const gchar * const *
137 g_vfs_get_supported_uri_schemes (GVfs *vfs)
141 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
143 class = G_VFS_GET_CLASS (vfs);
145 return (* class->get_supported_uri_schemes) (vfs);
151 * @parse_name: a string to be parsed by the VFS module.
153 * This operation never fails, but the returned object might
154 * not support any I/O operations if the @parse_name cannot
155 * be parsed by the #GVfs module.
157 * Returns: a #GFile for the given @parse_name.
158 * Free the returned object with g_object_unref().
161 g_vfs_parse_name (GVfs *vfs,
162 const char *parse_name)
166 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
167 g_return_val_if_fail (parse_name != NULL, NULL);
169 class = G_VFS_GET_CLASS (vfs);
171 return (* class->parse_name) (vfs, parse_name);
175 get_default_vfs (gpointer arg)
177 const char *use_this;
180 GIOExtensionPoint *ep;
181 GIOExtension *extension;
184 use_this = g_getenv ("GIO_USE_VFS");
186 /* Ensure vfs in modules loaded */
187 _g_io_modules_ensure_loaded ();
189 ep = g_io_extension_point_lookup (G_VFS_EXTENSION_POINT_NAME);
193 extension = g_io_extension_point_get_extension_by_name (ep, use_this);
196 vfs = g_object_new (g_io_extension_get_type (extension), NULL);
198 if (g_vfs_is_active (vfs))
201 g_object_unref (vfs);
205 for (l = g_io_extension_point_get_extensions (ep); l != NULL; l = l->next)
209 vfs = g_object_new (g_io_extension_get_type (extension), NULL);
211 if (g_vfs_is_active (vfs))
214 g_object_unref (vfs);
224 * Gets the default #GVfs for the system.
229 g_vfs_get_default (void)
231 static GOnce once_init = G_ONCE_INIT;
233 return g_once (&once_init, get_default_vfs, NULL);
239 * Gets the local #GVfs for the system.
244 g_vfs_get_local (void)
246 static gsize vfs = 0;
248 if (g_once_init_enter (&vfs))
249 g_once_init_leave (&vfs, (gsize)_g_local_vfs_new ());
255 #include "gioaliasdef.c"