It is 'registered', not 'registred'
[glib.git] / gio / giomodule.c
blob37a9e70a99e0aa96136c558b05e9e878d771dc08
1 /* GIO - GLib Input, Output and Streaming Library
2 *
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>
23 #include "config.h"
25 #include <string.h>
27 #include "giomodule.h"
28 #include "giomodule-priv.h"
29 #include "glocalfilemonitor.h"
30 #include "glocaldirectorymonitor.h"
31 #include "gnativevolumemonitor.h"
32 #include "gproxyresolver.h"
33 #include "gproxy.h"
34 #include "gsettingsbackendinternal.h"
35 #include "gsocks4proxy.h"
36 #include "gsocks4aproxy.h"
37 #include "gsocks5proxy.h"
38 #include "gtlsbackend.h"
39 #include "gvfs.h"
40 #ifdef G_OS_WIN32
41 #include "gregistrysettingsbackend.h"
42 #endif
43 #include <glib/gstdio.h>
45 #ifdef G_OS_UNIX
46 #include "gdesktopappinfo.h"
47 #endif
49 /**
50 * SECTION:giomodule
51 * @short_description: Loadable GIO Modules
52 * @include: gio/gio.h
54 * Provides an interface and default functions for loading and unloading
55 * modules. This is used internally to make GIO extensible, but can also
56 * be used by others to implement module loading.
58 **/
60 /**
61 * SECTION:extensionpoints
62 * @short_description: Extension Points
63 * @include: gio.h
64 * @see_also: <link linkend="extending-gio">Extending GIO</link>
66 * #GIOExtensionPoint provides a mechanism for modules to extend the
67 * functionality of the library or application that loaded it in an
68 * organized fashion.
70 * An extension point is identified by a name, and it may optionally
71 * require that any implementation must by of a certain type (or derived
72 * thereof). Use g_io_extension_point_register() to register an
73 * extension point, and g_io_extension_point_set_required_type() to
74 * set a required type.
76 * A module can implement an extension point by specifying the #GType
77 * that implements the functionality. Additionally, each implementation
78 * of an extension point has a name, and a priority. Use
79 * g_io_extension_point_implement() to implement an extension point.
81 * |[
82 * GIOExtensionPoint *ep;
84 * /&ast; Register an extension point &ast;/
85 * ep = g_io_extension_point_register ("my-extension-point");
86 * g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE);
87 * ]|
89 * |[
90 * /&ast; Implement an extension point &ast;/
91 * G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE);
92 * g_io_extension_point_implement ("my-extension-point",
93 * my_example_impl_get_type (),
94 * "my-example",
95 * 10);
96 * ]|
98 * It is up to the code that registered the extension point how
99 * it uses the implementations that have been associated with it.
100 * Depending on the use case, it may use all implementations, or
101 * only the one with the highest priority, or pick a specific
102 * one by name.
104 * To avoid opening all modules just to find out what extension
105 * points they implement, GIO makes use of a caching mechanism,
106 * see <link linkend="gio-querymodules">gio-querymodules</link>.
107 * You are expected to run this command after installing a
108 * GIO module.
110 * The <envar>GIO_EXTRA_MODULES</envar> environment variable can be
111 * used to specify additional directories to automatically load modules
112 * from. This environment variable has the same syntax as the
113 * <envar>PATH</envar>. If two modules have the same base name in different
114 * directories, then the latter one will be ignored. If additional
115 * directories are specified GIO will load modules from the built-in
116 * directory last.
120 * GIOModuleScope:
122 * Represents a scope for loading IO modules. A scope can be used for blocking
123 * duplicate modules, or blocking a module you don't want to load.
125 * The scope can be used with g_io_modules_load_all_in_directory_with_scope()
126 * or g_io_modules_scan_all_in_directory_with_scope().
128 * Since: 2.30
130 struct _GIOModuleScope {
131 GIOModuleScopeFlags flags;
132 GHashTable *basenames;
136 * g_io_module_scope_new:
137 * @flags: flags for the new scope
139 * Create a new scope for loading of IO modules. A scope can be used for
140 * blocking duplicate modules, or blocking a module you don't want to load.
142 * Specify the %G_IO_MODULE_SCOPE_BLOCK_DUPLICATES flag to block modules
143 * which have the same base name as a module that has already been seen
144 * in this scope.
146 * Returns: (transfer full): the new module scope
148 * Since: 2.30
150 GIOModuleScope *
151 g_io_module_scope_new (GIOModuleScopeFlags flags)
153 GIOModuleScope *scope = g_new0 (GIOModuleScope, 1);
154 scope->flags = flags;
155 scope->basenames = g_hash_table_new_full (g_str_hash, g_str_equal, g_free, NULL);
156 return scope;
160 * g_io_module_scope_free:
161 * @scope: a module loading scope
163 * Free a module scope.
165 * Since: 2.30
167 void
168 g_io_module_scope_free (GIOModuleScope *scope)
170 if (!scope)
171 return;
172 g_hash_table_destroy (scope->basenames);
173 g_free (scope);
177 * g_io_module_scope_block:
178 * @scope: a module loading scope
179 * @basename: the basename to block
181 * Block modules with the given @basename from being loaded when
182 * this scope is used with g_io_modules_scan_all_in_directory_with_scope()
183 * or g_io_modules_load_all_in_directory_with_scope().
185 * Since: 2.30
187 void
188 g_io_module_scope_block (GIOModuleScope *scope,
189 const gchar *basename)
191 gchar *key;
193 g_return_if_fail (scope != NULL);
194 g_return_if_fail (basename != NULL);
196 key = g_strdup (basename);
197 g_hash_table_insert (scope->basenames, key, key);
200 static gboolean
201 _g_io_module_scope_contains (GIOModuleScope *scope,
202 const gchar *basename)
204 return g_hash_table_lookup (scope->basenames, basename) ? TRUE : FALSE;
207 struct _GIOModule {
208 GTypeModule parent_instance;
210 gchar *filename;
211 GModule *library;
212 gboolean initialized; /* The module was loaded at least once */
214 void (* load) (GIOModule *module);
215 void (* unload) (GIOModule *module);
218 struct _GIOModuleClass
220 GTypeModuleClass parent_class;
224 static void g_io_module_finalize (GObject *object);
225 static gboolean g_io_module_load_module (GTypeModule *gmodule);
226 static void g_io_module_unload_module (GTypeModule *gmodule);
228 struct _GIOExtension {
229 char *name;
230 GType type;
231 gint priority;
234 struct _GIOExtensionPoint {
235 GType required_type;
236 char *name;
237 GList *extensions;
238 GList *lazy_load_modules;
241 static GHashTable *extension_points = NULL;
242 G_LOCK_DEFINE_STATIC(extension_points);
244 G_DEFINE_TYPE (GIOModule, g_io_module, G_TYPE_TYPE_MODULE);
246 static void
247 g_io_module_class_init (GIOModuleClass *class)
249 GObjectClass *object_class = G_OBJECT_CLASS (class);
250 GTypeModuleClass *type_module_class = G_TYPE_MODULE_CLASS (class);
252 object_class->finalize = g_io_module_finalize;
254 type_module_class->load = g_io_module_load_module;
255 type_module_class->unload = g_io_module_unload_module;
258 static void
259 g_io_module_init (GIOModule *module)
263 static void
264 g_io_module_finalize (GObject *object)
266 GIOModule *module = G_IO_MODULE (object);
268 g_free (module->filename);
270 G_OBJECT_CLASS (g_io_module_parent_class)->finalize (object);
273 static gboolean
274 g_io_module_load_module (GTypeModule *gmodule)
276 GIOModule *module = G_IO_MODULE (gmodule);
278 if (!module->filename)
280 g_warning ("GIOModule path not set");
281 return FALSE;
284 module->library = g_module_open (module->filename, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
286 if (!module->library)
288 g_printerr ("%s\n", g_module_error ());
289 return FALSE;
292 /* Make sure that the loaded library contains the required methods */
293 if (! g_module_symbol (module->library,
294 "g_io_module_load",
295 (gpointer) &module->load) ||
296 ! g_module_symbol (module->library,
297 "g_io_module_unload",
298 (gpointer) &module->unload))
300 g_printerr ("%s\n", g_module_error ());
301 g_module_close (module->library);
303 return FALSE;
306 /* Initialize the loaded module */
307 module->load (module);
308 module->initialized = TRUE;
310 return TRUE;
313 static void
314 g_io_module_unload_module (GTypeModule *gmodule)
316 GIOModule *module = G_IO_MODULE (gmodule);
318 module->unload (module);
320 g_module_close (module->library);
321 module->library = NULL;
323 module->load = NULL;
324 module->unload = NULL;
328 * g_io_module_new:
329 * @filename: filename of the shared library module.
331 * Creates a new GIOModule that will load the specific
332 * shared library when in use.
334 * Returns: a #GIOModule from given @filename,
335 * or %NULL on error.
337 GIOModule *
338 g_io_module_new (const gchar *filename)
340 GIOModule *module;
342 g_return_val_if_fail (filename != NULL, NULL);
344 module = g_object_new (G_IO_TYPE_MODULE, NULL);
345 module->filename = g_strdup (filename);
347 return module;
350 static gboolean
351 is_valid_module_name (const gchar *basename,
352 GIOModuleScope *scope)
354 gboolean result;
356 #if !defined(G_OS_WIN32) && !defined(G_WITH_CYGWIN)
357 if (!g_str_has_prefix (basename, "lib") ||
358 !g_str_has_suffix (basename, ".so"))
359 return FALSE;
360 #else
361 if (!g_str_has_suffix (basename, ".dll"))
362 return FALSE;
363 #endif
365 result = TRUE;
366 if (scope)
368 result = _g_io_module_scope_contains (scope, basename) ? FALSE : TRUE;
369 if (result && (scope->flags & G_IO_MODULE_SCOPE_BLOCK_DUPLICATES))
370 g_io_module_scope_block (scope, basename);
373 return result;
378 * g_io_modules_scan_all_in_directory_with_scope:
379 * @dirname: pathname for a directory containing modules to scan.
380 * @scope: a scope to use when scanning the modules
382 * Scans all the modules in the specified directory, ensuring that
383 * any extension point implemented by a module is registered.
385 * This may not actually load and initialize all the types in each
386 * module, some modules may be lazily loaded and initialized when
387 * an extension point it implementes is used with e.g.
388 * g_io_extension_point_get_extensions() or
389 * g_io_extension_point_get_extension_by_name().
391 * If you need to guarantee that all types are loaded in all the modules,
392 * use g_io_modules_load_all_in_directory().
394 * Since: 2.30
396 void
397 g_io_modules_scan_all_in_directory_with_scope (const char *dirname,
398 GIOModuleScope *scope)
400 const gchar *name;
401 char *filename;
402 GDir *dir;
403 GStatBuf statbuf;
404 char *data;
405 time_t cache_mtime;
406 GHashTable *cache;
408 if (!g_module_supported ())
409 return;
411 dir = g_dir_open (dirname, 0, NULL);
412 if (!dir)
413 return;
415 filename = g_build_filename (dirname, "giomodule.cache", NULL);
417 cache = g_hash_table_new_full (g_str_hash, g_str_equal,
418 g_free, (GDestroyNotify)g_strfreev);
420 cache_mtime = 0;
421 if (g_stat (filename, &statbuf) == 0 &&
422 g_file_get_contents (filename, &data, NULL, NULL))
424 char **lines;
425 int i;
427 /* Cache mtime is the time the cache file was created, any file
428 * that has a ctime before this was created then and not modified
429 * since then (userspace can't change ctime). Its possible to change
430 * the ctime forward without changing the file content, by e.g.
431 * chmoding the file, but this is uncommon and will only cause us
432 * to not use the cache so will not cause bugs.
434 cache_mtime = statbuf.st_mtime;
436 lines = g_strsplit (data, "\n", -1);
437 g_free (data);
439 for (i = 0; lines[i] != NULL; i++)
441 char *line = lines[i];
442 char *file;
443 char *colon;
444 char **extension_points;
446 if (line[0] == '#')
447 continue;
449 colon = strchr (line, ':');
450 if (colon == NULL || line == colon)
451 continue; /* Invalid line, ignore */
453 *colon = 0; /* terminate filename */
454 file = g_strdup (line);
455 colon++; /* after colon */
457 while (g_ascii_isspace (*colon))
458 colon++;
460 extension_points = g_strsplit (colon, ",", -1);
461 g_hash_table_insert (cache, file, extension_points);
463 g_strfreev (lines);
466 while ((name = g_dir_read_name (dir)))
468 if (is_valid_module_name (name, scope))
470 GIOExtensionPoint *extension_point;
471 GIOModule *module;
472 gchar *path;
473 char **extension_points;
474 int i;
476 path = g_build_filename (dirname, name, NULL);
477 module = g_io_module_new (path);
479 extension_points = g_hash_table_lookup (cache, name);
480 if (extension_points != NULL &&
481 g_stat (path, &statbuf) == 0 &&
482 statbuf.st_ctime <= cache_mtime)
484 /* Lazy load/init the library when first required */
485 for (i = 0; extension_points[i] != NULL; i++)
487 extension_point =
488 g_io_extension_point_register (extension_points[i]);
489 extension_point->lazy_load_modules =
490 g_list_prepend (extension_point->lazy_load_modules,
491 module);
494 else
496 /* Try to load and init types */
497 if (g_type_module_use (G_TYPE_MODULE (module)))
498 g_type_module_unuse (G_TYPE_MODULE (module)); /* Unload */
499 else
500 { /* Failure to load */
501 g_printerr ("Failed to load module: %s\n", path);
502 g_object_unref (module);
503 g_free (path);
504 continue;
508 g_free (path);
512 g_dir_close (dir);
514 g_hash_table_destroy (cache);
516 g_free (filename);
520 * g_io_modules_scan_all_in_directory:
521 * @dirname: pathname for a directory containing modules to scan.
523 * Scans all the modules in the specified directory, ensuring that
524 * any extension point implemented by a module is registered.
526 * This may not actually load and initialize all the types in each
527 * module, some modules may be lazily loaded and initialized when
528 * an extension point it implementes is used with e.g.
529 * g_io_extension_point_get_extensions() or
530 * g_io_extension_point_get_extension_by_name().
532 * If you need to guarantee that all types are loaded in all the modules,
533 * use g_io_modules_load_all_in_directory().
535 * Since: 2.24
537 void
538 g_io_modules_scan_all_in_directory (const char *dirname)
540 g_io_modules_scan_all_in_directory_with_scope (dirname, NULL);
544 * g_io_modules_load_all_in_directory_with_scope:
545 * @dirname: pathname for a directory containing modules to load.
546 * @scope: a scope to use when scanning the modules.
548 * Loads all the modules in the specified directory.
550 * If don't require all modules to be initialized (and thus registering
551 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
552 * which allows delayed/lazy loading of modules.
554 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
555 * from the directory,
556 * All the modules are loaded into memory, if you want to
557 * unload them (enabling on-demand loading) you must call
558 * g_type_module_unuse() on all the modules. Free the list
559 * with g_list_free().
561 * Since: 2.30
563 GList *
564 g_io_modules_load_all_in_directory_with_scope (const char *dirname,
565 GIOModuleScope *scope)
567 const gchar *name;
568 GDir *dir;
569 GList *modules;
571 if (!g_module_supported ())
572 return NULL;
574 dir = g_dir_open (dirname, 0, NULL);
575 if (!dir)
576 return NULL;
578 modules = NULL;
579 while ((name = g_dir_read_name (dir)))
581 if (is_valid_module_name (name, scope))
583 GIOModule *module;
584 gchar *path;
586 path = g_build_filename (dirname, name, NULL);
587 module = g_io_module_new (path);
589 if (!g_type_module_use (G_TYPE_MODULE (module)))
591 g_printerr ("Failed to load module: %s\n", path);
592 g_object_unref (module);
593 g_free (path);
594 continue;
597 g_free (path);
599 modules = g_list_prepend (modules, module);
603 g_dir_close (dir);
605 return modules;
609 * g_io_modules_load_all_in_directory:
610 * @dirname: pathname for a directory containing modules to load.
612 * Loads all the modules in the specified directory.
614 * If don't require all modules to be initialized (and thus registering
615 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
616 * which allows delayed/lazy loading of modules.
618 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
619 * from the directory,
620 * All the modules are loaded into memory, if you want to
621 * unload them (enabling on-demand loading) you must call
622 * g_type_module_unuse() on all the modules. Free the list
623 * with g_list_free().
625 GList *
626 g_io_modules_load_all_in_directory (const char *dirname)
628 return g_io_modules_load_all_in_directory_with_scope (dirname, NULL);
631 GRecMutex default_modules_lock;
632 GHashTable *default_modules;
634 static gpointer
635 try_implementation (GIOExtension *extension,
636 GIOModuleVerifyFunc verify_func)
638 GType type = g_io_extension_get_type (extension);
639 gpointer impl;
641 if (g_type_is_a (type, G_TYPE_INITABLE))
642 return g_initable_new (type, NULL, NULL, NULL);
643 else
645 impl = g_object_new (type, NULL);
646 if (!verify_func || verify_func (impl))
647 return impl;
649 g_object_unref (impl);
650 return NULL;
655 * _g_io_module_get_default:
656 * @extension_point: the name of an extension point
657 * @envvar: (allow-none): the name of an environment variable to
658 * override the default implementation.
659 * @verify_func: (allow-none): a function to call to verify that
660 * a given implementation is usable in the current environment.
662 * Retrieves the default object implementing @extension_point.
664 * If @envvar is not %NULL, and the environment variable with that
665 * name is set, then the implementation it specifies will be tried
666 * first. After that, or if @envvar is not set, all other
667 * implementations will be tried in order of decreasing priority.
669 * If an extension point implementation implements #GInitable, then
670 * that implementation will only be used if it initializes
671 * successfully. Otherwise, if @verify_func is not %NULL, then it will
672 * be called on each candidate implementation after construction, to
673 * check if it is actually usable or not.
675 * The result is cached after it is generated the first time, and
676 * the function is thread-safe.
678 * Return value: (transfer none): an object implementing
679 * @extension_point, or %NULL if there are no usable
680 * implementations.
682 gpointer
683 _g_io_module_get_default (const gchar *extension_point,
684 const gchar *envvar,
685 GIOModuleVerifyFunc verify_func)
687 const char *use_this;
688 GList *l;
689 GIOExtensionPoint *ep;
690 GIOExtension *extension, *preferred;
691 gpointer impl;
693 g_rec_mutex_lock (&default_modules_lock);
694 if (default_modules)
696 gpointer key;
698 if (g_hash_table_lookup_extended (default_modules, extension_point,
699 &key, &impl))
701 g_rec_mutex_unlock (&default_modules_lock);
702 return impl;
705 else
707 default_modules = g_hash_table_new (g_str_hash, g_str_equal);
710 _g_io_modules_ensure_loaded ();
711 ep = g_io_extension_point_lookup (extension_point);
713 if (!ep)
715 g_warn_if_reached ();
716 g_rec_mutex_unlock (&default_modules_lock);
717 return NULL;
720 use_this = envvar ? g_getenv (envvar) : NULL;
721 if (use_this)
723 preferred = g_io_extension_point_get_extension_by_name (ep, use_this);
724 if (preferred)
726 impl = try_implementation (preferred, verify_func);
727 if (impl)
728 goto done;
730 else
731 g_warning ("Can't find module '%s' specified in %s", use_this, envvar);
733 else
734 preferred = NULL;
736 for (l = g_io_extension_point_get_extensions (ep); l != NULL; l = l->next)
738 extension = l->data;
739 if (extension == preferred)
740 continue;
742 impl = try_implementation (extension, verify_func);
743 if (impl)
744 goto done;
747 impl = NULL;
749 done:
750 g_hash_table_insert (default_modules,
751 g_strdup (extension_point),
752 impl ? g_object_ref (impl) : NULL);
753 g_rec_mutex_unlock (&default_modules_lock);
755 return impl;
758 G_LOCK_DEFINE_STATIC (registered_extensions);
759 G_LOCK_DEFINE_STATIC (loaded_dirs);
761 extern GType _g_fen_directory_monitor_get_type (void);
762 extern GType _g_fen_file_monitor_get_type (void);
763 extern GType _g_inotify_directory_monitor_get_type (void);
764 extern GType _g_inotify_file_monitor_get_type (void);
765 extern GType _g_unix_volume_monitor_get_type (void);
766 extern GType _g_local_vfs_get_type (void);
768 extern GType _g_win32_volume_monitor_get_type (void);
769 extern GType g_win32_directory_monitor_get_type (void);
770 extern GType _g_winhttp_vfs_get_type (void);
772 extern GType _g_dummy_proxy_resolver_get_type (void);
773 extern GType _g_dummy_tls_backend_get_type (void);
774 extern GType g_network_monitor_base_get_type (void);
775 #ifdef HAVE_NETLINK
776 extern GType _g_network_monitor_netlink_get_type (void);
777 #endif
779 #ifdef G_PLATFORM_WIN32
781 #include <windows.h>
783 static HMODULE gio_dll = NULL;
785 #ifdef DLL_EXPORT
787 BOOL WINAPI
788 DllMain (HINSTANCE hinstDLL,
789 DWORD fdwReason,
790 LPVOID lpvReserved)
792 if (fdwReason == DLL_PROCESS_ATTACH)
793 gio_dll = hinstDLL;
795 return TRUE;
798 void *
799 _g_io_win32_get_module (void)
801 return gio_dll;
804 #endif
806 #undef GIO_MODULE_DIR
808 /* GIO_MODULE_DIR is used only in code called just once,
809 * so no problem leaking this
811 #define GIO_MODULE_DIR \
812 g_build_filename (g_win32_get_package_installation_directory_of_module (gio_dll), \
813 "lib/gio/modules", \
814 NULL)
816 #endif
818 void
819 _g_io_modules_ensure_extension_points_registered (void)
821 static gboolean registered_extensions = FALSE;
822 GIOExtensionPoint *ep;
824 G_LOCK (registered_extensions);
826 if (!registered_extensions)
828 registered_extensions = TRUE;
830 #ifdef G_OS_UNIX
831 #if !GLIB_CHECK_VERSION (3, 0, 0)
832 ep = g_io_extension_point_register (G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME);
833 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
834 g_io_extension_point_set_required_type (ep, G_TYPE_DESKTOP_APP_INFO_LOOKUP);
835 G_GNUC_END_IGNORE_DEPRECATIONS
836 #endif
837 #endif
839 ep = g_io_extension_point_register (G_LOCAL_DIRECTORY_MONITOR_EXTENSION_POINT_NAME);
840 g_io_extension_point_set_required_type (ep, G_TYPE_LOCAL_DIRECTORY_MONITOR);
842 ep = g_io_extension_point_register (G_LOCAL_FILE_MONITOR_EXTENSION_POINT_NAME);
843 g_io_extension_point_set_required_type (ep, G_TYPE_LOCAL_FILE_MONITOR);
845 ep = g_io_extension_point_register (G_VOLUME_MONITOR_EXTENSION_POINT_NAME);
846 g_io_extension_point_set_required_type (ep, G_TYPE_VOLUME_MONITOR);
848 ep = g_io_extension_point_register (G_NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME);
849 g_io_extension_point_set_required_type (ep, G_TYPE_NATIVE_VOLUME_MONITOR);
851 ep = g_io_extension_point_register (G_VFS_EXTENSION_POINT_NAME);
852 g_io_extension_point_set_required_type (ep, G_TYPE_VFS);
854 ep = g_io_extension_point_register ("gsettings-backend");
855 g_io_extension_point_set_required_type (ep, G_TYPE_OBJECT);
857 ep = g_io_extension_point_register (G_PROXY_RESOLVER_EXTENSION_POINT_NAME);
858 g_io_extension_point_set_required_type (ep, G_TYPE_PROXY_RESOLVER);
860 ep = g_io_extension_point_register (G_PROXY_EXTENSION_POINT_NAME);
861 g_io_extension_point_set_required_type (ep, G_TYPE_PROXY);
863 ep = g_io_extension_point_register (G_TLS_BACKEND_EXTENSION_POINT_NAME);
864 g_io_extension_point_set_required_type (ep, G_TYPE_TLS_BACKEND);
866 ep = g_io_extension_point_register (G_NETWORK_MONITOR_EXTENSION_POINT_NAME);
867 g_io_extension_point_set_required_type (ep, G_TYPE_NETWORK_MONITOR);
870 G_UNLOCK (registered_extensions);
873 void
874 _g_io_modules_ensure_loaded (void)
876 static gboolean loaded_dirs = FALSE;
877 const char *module_path;
878 GIOModuleScope *scope;
880 _g_io_modules_ensure_extension_points_registered ();
882 G_LOCK (loaded_dirs);
884 if (!loaded_dirs)
886 loaded_dirs = TRUE;
887 scope = g_io_module_scope_new (G_IO_MODULE_SCOPE_BLOCK_DUPLICATES);
889 /* First load any overrides, extras */
890 module_path = g_getenv ("GIO_EXTRA_MODULES");
891 if (module_path)
893 gchar **paths;
894 int i;
896 paths = g_strsplit (module_path, G_SEARCHPATH_SEPARATOR_S, 0);
898 for (i = 0; paths[i] != NULL; i++)
900 g_io_modules_scan_all_in_directory_with_scope (paths[i], scope);
903 g_strfreev (paths);
906 /* Then load the compiled in path */
907 g_io_modules_scan_all_in_directory_with_scope (GIO_MODULE_DIR, scope);
909 g_io_module_scope_free (scope);
911 /* Initialize types from built-in "modules" */
912 g_type_ensure (g_null_settings_backend_get_type ());
913 g_type_ensure (g_memory_settings_backend_get_type ());
914 #if defined(HAVE_SYS_INOTIFY_H) || defined(HAVE_LINUX_INOTIFY_H)
915 g_type_ensure (_g_inotify_directory_monitor_get_type ());
916 g_type_ensure (_g_inotify_file_monitor_get_type ());
917 #endif
918 #if defined(HAVE_FEN)
919 g_type_ensure (_g_fen_directory_monitor_get_type ());
920 g_type_ensure (_g_fen_file_monitor_get_type ());
921 #endif
922 #ifdef G_OS_WIN32
923 g_type_ensure (_g_win32_volume_monitor_get_type ());
924 g_type_ensure (g_win32_directory_monitor_get_type ());
925 g_type_ensure (g_registry_backend_get_type ());
926 #endif
927 #ifdef HAVE_CARBON
928 g_nextstep_settings_backend_get_type ();
929 #endif
930 #ifdef G_OS_UNIX
931 g_type_ensure (_g_unix_volume_monitor_get_type ());
932 #endif
933 #ifdef G_OS_WIN32
934 g_type_ensure (_g_winhttp_vfs_get_type ());
935 #endif
936 g_type_ensure (_g_local_vfs_get_type ());
937 g_type_ensure (_g_dummy_proxy_resolver_get_type ());
938 g_type_ensure (_g_socks4a_proxy_get_type ());
939 g_type_ensure (_g_socks4_proxy_get_type ());
940 g_type_ensure (_g_socks5_proxy_get_type ());
941 g_type_ensure (_g_dummy_tls_backend_get_type ());
942 g_type_ensure (g_network_monitor_base_get_type ());
943 #ifdef HAVE_NETLINK
944 g_type_ensure (_g_network_monitor_netlink_get_type ());
945 #endif
948 G_UNLOCK (loaded_dirs);
951 static void
952 g_io_extension_point_free (GIOExtensionPoint *ep)
954 g_free (ep->name);
955 g_free (ep);
959 * g_io_extension_point_register:
960 * @name: The name of the extension point
962 * Registers an extension point.
964 * Returns: (transfer none): the new #GIOExtensionPoint. This object is
965 * owned by GIO and should not be freed.
967 GIOExtensionPoint *
968 g_io_extension_point_register (const char *name)
970 GIOExtensionPoint *ep;
972 G_LOCK (extension_points);
973 if (extension_points == NULL)
974 extension_points = g_hash_table_new_full (g_str_hash,
975 g_str_equal,
976 NULL,
977 (GDestroyNotify)g_io_extension_point_free);
979 ep = g_hash_table_lookup (extension_points, name);
980 if (ep != NULL)
982 G_UNLOCK (extension_points);
983 return ep;
986 ep = g_new0 (GIOExtensionPoint, 1);
987 ep->name = g_strdup (name);
989 g_hash_table_insert (extension_points, ep->name, ep);
991 G_UNLOCK (extension_points);
993 return ep;
997 * g_io_extension_point_lookup:
998 * @name: the name of the extension point
1000 * Looks up an existing extension point.
1002 * Returns: (transfer none): the #GIOExtensionPoint, or %NULL if there
1003 * is no registered extension point with the given name.
1005 GIOExtensionPoint *
1006 g_io_extension_point_lookup (const char *name)
1008 GIOExtensionPoint *ep;
1010 G_LOCK (extension_points);
1011 ep = NULL;
1012 if (extension_points != NULL)
1013 ep = g_hash_table_lookup (extension_points, name);
1015 G_UNLOCK (extension_points);
1017 return ep;
1022 * g_io_extension_point_set_required_type:
1023 * @extension_point: a #GIOExtensionPoint
1024 * @type: the #GType to require
1026 * Sets the required type for @extension_point to @type.
1027 * All implementations must henceforth have this type.
1029 void
1030 g_io_extension_point_set_required_type (GIOExtensionPoint *extension_point,
1031 GType type)
1033 extension_point->required_type = type;
1037 * g_io_extension_point_get_required_type:
1038 * @extension_point: a #GIOExtensionPoint
1040 * Gets the required type for @extension_point.
1042 * Returns: the #GType that all implementations must have,
1043 * or #G_TYPE_INVALID if the extension point has no required type
1045 GType
1046 g_io_extension_point_get_required_type (GIOExtensionPoint *extension_point)
1048 return extension_point->required_type;
1051 static void
1052 lazy_load_modules (GIOExtensionPoint *extension_point)
1054 GIOModule *module;
1055 GList *l;
1057 for (l = extension_point->lazy_load_modules; l != NULL; l = l->next)
1059 module = l->data;
1061 if (!module->initialized)
1063 if (g_type_module_use (G_TYPE_MODULE (module)))
1064 g_type_module_unuse (G_TYPE_MODULE (module)); /* Unload */
1065 else
1066 g_printerr ("Failed to load module: %s\n",
1067 module->filename);
1073 * g_io_extension_point_get_extensions:
1074 * @extension_point: a #GIOExtensionPoint
1076 * Gets a list of all extensions that implement this extension point.
1077 * The list is sorted by priority, beginning with the highest priority.
1079 * Returns: (element-type GIOExtension) (transfer none): a #GList of
1080 * #GIOExtension<!-- -->s. The list is owned by GIO and should not be
1081 * modified.
1083 GList *
1084 g_io_extension_point_get_extensions (GIOExtensionPoint *extension_point)
1086 lazy_load_modules (extension_point);
1087 return extension_point->extensions;
1091 * g_io_extension_point_get_extension_by_name:
1092 * @extension_point: a #GIOExtensionPoint
1093 * @name: the name of the extension to get
1095 * Finds a #GIOExtension for an extension point by name.
1097 * Returns: (transfer none): the #GIOExtension for @extension_point that has the
1098 * given name, or %NULL if there is no extension with that name
1100 GIOExtension *
1101 g_io_extension_point_get_extension_by_name (GIOExtensionPoint *extension_point,
1102 const char *name)
1104 GList *l;
1106 lazy_load_modules (extension_point);
1107 for (l = extension_point->extensions; l != NULL; l = l->next)
1109 GIOExtension *e = l->data;
1111 if (e->name != NULL &&
1112 strcmp (e->name, name) == 0)
1113 return e;
1116 return NULL;
1119 static gint
1120 extension_prio_compare (gconstpointer a,
1121 gconstpointer b)
1123 const GIOExtension *extension_a = a, *extension_b = b;
1125 if (extension_a->priority > extension_b->priority)
1126 return -1;
1128 if (extension_b->priority > extension_a->priority)
1129 return 1;
1131 return 0;
1135 * g_io_extension_point_implement:
1136 * @extension_point_name: the name of the extension point
1137 * @type: the #GType to register as extension
1138 * @extension_name: the name for the extension
1139 * @priority: the priority for the extension
1141 * Registers @type as extension for the extension point with name
1142 * @extension_point_name.
1144 * If @type has already been registered as an extension for this
1145 * extension point, the existing #GIOExtension object is returned.
1147 * Returns: (transfer none): a #GIOExtension object for #GType
1149 GIOExtension *
1150 g_io_extension_point_implement (const char *extension_point_name,
1151 GType type,
1152 const char *extension_name,
1153 gint priority)
1155 GIOExtensionPoint *extension_point;
1156 GIOExtension *extension;
1157 GList *l;
1159 g_return_val_if_fail (extension_point_name != NULL, NULL);
1161 extension_point = g_io_extension_point_lookup (extension_point_name);
1162 if (extension_point == NULL)
1164 g_warning ("Tried to implement non-registered extension point %s", extension_point_name);
1165 return NULL;
1168 if (extension_point->required_type != 0 &&
1169 !g_type_is_a (type, extension_point->required_type))
1171 g_warning ("Tried to register an extension of the type %s to extension point %s. "
1172 "Expected type is %s.",
1173 g_type_name (type),
1174 extension_point_name,
1175 g_type_name (extension_point->required_type));
1176 return NULL;
1179 /* It's safe to register the same type multiple times */
1180 for (l = extension_point->extensions; l != NULL; l = l->next)
1182 extension = l->data;
1183 if (extension->type == type)
1184 return extension;
1187 extension = g_slice_new0 (GIOExtension);
1188 extension->type = type;
1189 extension->name = g_strdup (extension_name);
1190 extension->priority = priority;
1192 extension_point->extensions = g_list_insert_sorted (extension_point->extensions,
1193 extension, extension_prio_compare);
1195 return extension;
1199 * g_io_extension_ref_class:
1200 * @extension: a #GIOExtension
1202 * Gets a reference to the class for the type that is
1203 * associated with @extension.
1205 * Returns: (transfer full): the #GTypeClass for the type of @extension
1207 GTypeClass *
1208 g_io_extension_ref_class (GIOExtension *extension)
1210 return g_type_class_ref (extension->type);
1214 * g_io_extension_get_type:
1215 * @extension: a #GIOExtension
1217 * Gets the type associated with @extension.
1219 * Returns: the type of @extension
1221 GType
1222 g_io_extension_get_type (GIOExtension *extension)
1224 return extension->type;
1228 * g_io_extension_get_name:
1229 * @extension: a #GIOExtension
1231 * Gets the name under which @extension was registered.
1233 * Note that the same type may be registered as extension
1234 * for multiple extension points, under different names.
1236 * Returns: the name of @extension.
1238 const char *
1239 g_io_extension_get_name (GIOExtension *extension)
1241 return extension->name;
1245 * g_io_extension_get_priority:
1246 * @extension: a #GIOExtension
1248 * Gets the priority with which @extension was registered.
1250 * Returns: the priority of @extension
1252 gint
1253 g_io_extension_get_priority (GIOExtension *extension)
1255 return extension->priority;