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.h"
32 * @short_description: Virtual File System
33 * @include: gio/gvfs.h
35 * Entry point for using GIO functionality.
39 G_DEFINE_TYPE (GVfs, g_vfs, G_TYPE_OBJECT);
42 g_vfs_class_init (GVfsClass *klass)
47 g_vfs_init (GVfs *vfs)
55 * Checks if the VFS is active.
57 * Returns: %TRUE if construction of the @vfs was successful and it is now active.
60 g_vfs_is_active (GVfs *vfs)
64 g_return_val_if_fail (G_IS_VFS (vfs), FALSE);
66 class = G_VFS_GET_CLASS (vfs);
68 return (* class->is_active) (vfs);
73 * g_vfs_get_file_for_path:
75 * @path: a string containing a VFS path.
77 * Gets a #GFile for @path.
82 g_vfs_get_file_for_path (GVfs *vfs,
87 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
88 g_return_val_if_fail (path != NULL, NULL);
90 class = G_VFS_GET_CLASS (vfs);
92 return (* class->get_file_for_path) (vfs, path);
96 * g_vfs_get_file_for_uri:
98 * @uri: a string containing a URI path.
100 * Gets a #GFile for @uri.
102 * This operation never fails, but the returned object
103 * might not support any I/O operation if the uri
104 * is malformed or if the uri type is not supported.
110 g_vfs_get_file_for_uri (GVfs *vfs,
115 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
116 g_return_val_if_fail (uri != NULL, NULL);
118 class = G_VFS_GET_CLASS (vfs);
120 return (* class->get_file_for_uri) (vfs, uri);
124 * g_vfs_get_supported_uri_schemes:
127 * Gets a list of URI schemes supported by @vfs.
129 * Returns: a list of strings.
131 const gchar * const *
132 g_vfs_get_supported_uri_schemes (GVfs *vfs)
136 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
138 class = G_VFS_GET_CLASS (vfs);
140 return (* class->get_supported_uri_schemes) (vfs);
146 * @parse_name: a string to be parsed by the VFS module.
148 * This operation never fails, but the returned object might
149 * not support any I/O operations if the @parse_name cannot
150 * be parsed by the #GVfs module.
152 * Returns: a #GFile for the given @parse_name.
155 g_vfs_parse_name (GVfs *vfs,
156 const char *parse_name)
160 g_return_val_if_fail (G_IS_VFS (vfs), NULL);
161 g_return_val_if_fail (parse_name != NULL, NULL);
163 class = G_VFS_GET_CLASS (vfs);
165 return (* class->parse_name) (vfs, parse_name);
168 /* Note: This compares in reverse order.
169 Higher prio -> sort first
172 compare_vfs_type (gconstpointer a,
176 GVfsClass *class_a, *class_b;
178 const char *use_this_vfs;
180 class_a = g_type_class_ref (*(GType *)a);
181 class_b = g_type_class_ref (*(GType *)b);
182 use_this_vfs = user_data;
184 if (class_a == class_b)
186 else if (use_this_vfs != NULL &&
187 strcmp (class_a->name, use_this_vfs) == 0)
189 else if (use_this_vfs != NULL &&
190 strcmp (class_b->name, use_this_vfs) == 0)
193 res = class_b->priority - class_a->priority;
195 g_type_class_unref (class_a);
196 g_type_class_unref (class_b);
203 get_default_vfs (gpointer arg)
205 volatile GType local_type;
209 const char *use_this;
211 GType (*casted_get_type)(void);
213 use_this = g_getenv ("GIO_USE_VFS");
215 /* Ensure GLocalVfs type is available
216 the cast is required to avoid any G_GNUC_CONST optimizations */
217 casted_get_type = g_local_vfs_get_type;
218 local_type = casted_get_type ();
220 /* Ensure vfs in modules loaded */
221 g_io_modules_ensure_loaded (GIO_MODULE_DIR);
223 vfs_impls = g_type_children (G_TYPE_VFS, &n_vfs_impls);
225 g_qsort_with_data (vfs_impls, n_vfs_impls, sizeof (GType),
226 compare_vfs_type, (gpointer)use_this);
228 for (i = 0; i < n_vfs_impls; i++)
230 vfs = g_object_new (vfs_impls[i], NULL);
232 if (g_vfs_is_active (vfs))
235 g_object_unref (vfs);
247 * Gets the default #GVfs for the system.
252 g_vfs_get_default (void)
254 static GOnce once_init = G_ONCE_INIT;
256 return g_once (&once_init, get_default_vfs, NULL);
262 * Gets the local #GVfs for the system.
267 g_vfs_get_local (void)
269 static gsize vfs = 0;
271 if (g_once_init_enter (&vfs))
272 g_once_init_leave (&vfs, (gsize)g_local_vfs_new ());