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>
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"
34 #include "gsettingsbackendinternal.h"
35 #include "gsocks4proxy.h"
36 #include "gsocks4aproxy.h"
37 #include "gsocks5proxy.h"
38 #include "gtlsbackend.h"
40 #include "gnotificationbackend.h"
42 #include "gregistrysettingsbackend.h"
44 #include <glib/gstdio.h>
47 #include "gdesktopappinfo.h"
52 * @short_description: Loadable GIO Modules
55 * Provides an interface and default functions for loading and unloading
56 * modules. This is used internally to make GIO extensible, but can also
57 * be used by others to implement module loading.
62 * SECTION:extensionpoints
63 * @short_description: Extension Points
65 * @see_also: <link linkend="extending-gio">Extending GIO</link>
67 * #GIOExtensionPoint provides a mechanism for modules to extend the
68 * functionality of the library or application that loaded it in an
71 * An extension point is identified by a name, and it may optionally
72 * require that any implementation must by of a certain type (or derived
73 * thereof). Use g_io_extension_point_register() to register an
74 * extension point, and g_io_extension_point_set_required_type() to
75 * set a required type.
77 * A module can implement an extension point by specifying the #GType
78 * that implements the functionality. Additionally, each implementation
79 * of an extension point has a name, and a priority. Use
80 * g_io_extension_point_implement() to implement an extension point.
83 * GIOExtensionPoint *ep;
85 * /* Register an extension point */
86 * ep = g_io_extension_point_register ("my-extension-point");
87 * g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE);
91 * /* Implement an extension point */
92 * G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE);
93 * g_io_extension_point_implement ("my-extension-point",
94 * my_example_impl_get_type (),
99 * It is up to the code that registered the extension point how
100 * it uses the implementations that have been associated with it.
101 * Depending on the use case, it may use all implementations, or
102 * only the one with the highest priority, or pick a specific
105 * To avoid opening all modules just to find out what extension
106 * points they implement, GIO makes use of a caching mechanism,
107 * see <link linkend="gio-querymodules">gio-querymodules</link>.
108 * You are expected to run this command after installing a
111 * The <envar>GIO_EXTRA_MODULES</envar> environment variable can be
112 * used to specify additional directories to automatically load modules
113 * from. This environment variable has the same syntax as the
114 * <envar>PATH</envar>. If two modules have the same base name in different
115 * directories, then the latter one will be ignored. If additional
116 * directories are specified GIO will load modules from the built-in
123 * Represents a scope for loading IO modules. A scope can be used for blocking
124 * duplicate modules, or blocking a module you don't want to load.
126 * The scope can be used with g_io_modules_load_all_in_directory_with_scope()
127 * or g_io_modules_scan_all_in_directory_with_scope().
131 struct _GIOModuleScope
{
132 GIOModuleScopeFlags flags
;
133 GHashTable
*basenames
;
137 * g_io_module_scope_new:
138 * @flags: flags for the new scope
140 * Create a new scope for loading of IO modules. A scope can be used for
141 * blocking duplicate modules, or blocking a module you don't want to load.
143 * Specify the %G_IO_MODULE_SCOPE_BLOCK_DUPLICATES flag to block modules
144 * which have the same base name as a module that has already been seen
147 * Returns: (transfer full): the new module scope
152 g_io_module_scope_new (GIOModuleScopeFlags flags
)
154 GIOModuleScope
*scope
= g_new0 (GIOModuleScope
, 1);
155 scope
->flags
= flags
;
156 scope
->basenames
= g_hash_table_new_full (g_str_hash
, g_str_equal
, g_free
, NULL
);
161 * g_io_module_scope_free:
162 * @scope: a module loading scope
164 * Free a module scope.
169 g_io_module_scope_free (GIOModuleScope
*scope
)
173 g_hash_table_destroy (scope
->basenames
);
178 * g_io_module_scope_block:
179 * @scope: a module loading scope
180 * @basename: the basename to block
182 * Block modules with the given @basename from being loaded when
183 * this scope is used with g_io_modules_scan_all_in_directory_with_scope()
184 * or g_io_modules_load_all_in_directory_with_scope().
189 g_io_module_scope_block (GIOModuleScope
*scope
,
190 const gchar
*basename
)
194 g_return_if_fail (scope
!= NULL
);
195 g_return_if_fail (basename
!= NULL
);
197 key
= g_strdup (basename
);
198 g_hash_table_insert (scope
->basenames
, key
, key
);
202 _g_io_module_scope_contains (GIOModuleScope
*scope
,
203 const gchar
*basename
)
205 return g_hash_table_lookup (scope
->basenames
, basename
) ? TRUE
: FALSE
;
209 GTypeModule parent_instance
;
213 gboolean initialized
; /* The module was loaded at least once */
215 void (* load
) (GIOModule
*module
);
216 void (* unload
) (GIOModule
*module
);
219 struct _GIOModuleClass
221 GTypeModuleClass parent_class
;
225 static void g_io_module_finalize (GObject
*object
);
226 static gboolean
g_io_module_load_module (GTypeModule
*gmodule
);
227 static void g_io_module_unload_module (GTypeModule
*gmodule
);
229 struct _GIOExtension
{
235 struct _GIOExtensionPoint
{
239 GList
*lazy_load_modules
;
242 static GHashTable
*extension_points
= NULL
;
243 G_LOCK_DEFINE_STATIC(extension_points
);
245 G_DEFINE_TYPE (GIOModule
, g_io_module
, G_TYPE_TYPE_MODULE
);
248 g_io_module_class_init (GIOModuleClass
*class)
250 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
251 GTypeModuleClass
*type_module_class
= G_TYPE_MODULE_CLASS (class);
253 object_class
->finalize
= g_io_module_finalize
;
255 type_module_class
->load
= g_io_module_load_module
;
256 type_module_class
->unload
= g_io_module_unload_module
;
260 g_io_module_init (GIOModule
*module
)
265 g_io_module_finalize (GObject
*object
)
267 GIOModule
*module
= G_IO_MODULE (object
);
269 g_free (module
->filename
);
271 G_OBJECT_CLASS (g_io_module_parent_class
)->finalize (object
);
275 g_io_module_load_module (GTypeModule
*gmodule
)
277 GIOModule
*module
= G_IO_MODULE (gmodule
);
279 if (!module
->filename
)
281 g_warning ("GIOModule path not set");
285 module
->library
= g_module_open (module
->filename
, G_MODULE_BIND_LAZY
| G_MODULE_BIND_LOCAL
);
287 if (!module
->library
)
289 g_printerr ("%s\n", g_module_error ());
293 /* Make sure that the loaded library contains the required methods */
294 if (! g_module_symbol (module
->library
,
296 (gpointer
) &module
->load
) ||
297 ! g_module_symbol (module
->library
,
298 "g_io_module_unload",
299 (gpointer
) &module
->unload
))
301 g_printerr ("%s\n", g_module_error ());
302 g_module_close (module
->library
);
307 /* Initialize the loaded module */
308 module
->load (module
);
309 module
->initialized
= TRUE
;
315 g_io_module_unload_module (GTypeModule
*gmodule
)
317 GIOModule
*module
= G_IO_MODULE (gmodule
);
319 module
->unload (module
);
321 g_module_close (module
->library
);
322 module
->library
= NULL
;
325 module
->unload
= NULL
;
330 * @filename: filename of the shared library module.
332 * Creates a new GIOModule that will load the specific
333 * shared library when in use.
335 * Returns: a #GIOModule from given @filename,
339 g_io_module_new (const gchar
*filename
)
343 g_return_val_if_fail (filename
!= NULL
, NULL
);
345 module
= g_object_new (G_IO_TYPE_MODULE
, NULL
);
346 module
->filename
= g_strdup (filename
);
352 is_valid_module_name (const gchar
*basename
,
353 GIOModuleScope
*scope
)
357 #if !defined(G_OS_WIN32) && !defined(G_WITH_CYGWIN)
358 if (!g_str_has_prefix (basename
, "lib") ||
359 !g_str_has_suffix (basename
, ".so"))
362 if (!g_str_has_suffix (basename
, ".dll"))
369 result
= _g_io_module_scope_contains (scope
, basename
) ? FALSE
: TRUE
;
370 if (result
&& (scope
->flags
& G_IO_MODULE_SCOPE_BLOCK_DUPLICATES
))
371 g_io_module_scope_block (scope
, basename
);
379 * g_io_modules_scan_all_in_directory_with_scope:
380 * @dirname: pathname for a directory containing modules to scan.
381 * @scope: a scope to use when scanning the modules
383 * Scans all the modules in the specified directory, ensuring that
384 * any extension point implemented by a module is registered.
386 * This may not actually load and initialize all the types in each
387 * module, some modules may be lazily loaded and initialized when
388 * an extension point it implementes is used with e.g.
389 * g_io_extension_point_get_extensions() or
390 * g_io_extension_point_get_extension_by_name().
392 * If you need to guarantee that all types are loaded in all the modules,
393 * use g_io_modules_load_all_in_directory().
398 g_io_modules_scan_all_in_directory_with_scope (const char *dirname
,
399 GIOModuleScope
*scope
)
409 if (!g_module_supported ())
412 dir
= g_dir_open (dirname
, 0, NULL
);
416 filename
= g_build_filename (dirname
, "giomodule.cache", NULL
);
418 cache
= g_hash_table_new_full (g_str_hash
, g_str_equal
,
419 g_free
, (GDestroyNotify
)g_strfreev
);
422 if (g_stat (filename
, &statbuf
) == 0 &&
423 g_file_get_contents (filename
, &data
, NULL
, NULL
))
428 /* Cache mtime is the time the cache file was created, any file
429 * that has a ctime before this was created then and not modified
430 * since then (userspace can't change ctime). Its possible to change
431 * the ctime forward without changing the file content, by e.g.
432 * chmoding the file, but this is uncommon and will only cause us
433 * to not use the cache so will not cause bugs.
435 cache_mtime
= statbuf
.st_mtime
;
437 lines
= g_strsplit (data
, "\n", -1);
440 for (i
= 0; lines
[i
] != NULL
; i
++)
442 char *line
= lines
[i
];
445 char **extension_points
;
450 colon
= strchr (line
, ':');
451 if (colon
== NULL
|| line
== colon
)
452 continue; /* Invalid line, ignore */
454 *colon
= 0; /* terminate filename */
455 file
= g_strdup (line
);
456 colon
++; /* after colon */
458 while (g_ascii_isspace (*colon
))
461 extension_points
= g_strsplit (colon
, ",", -1);
462 g_hash_table_insert (cache
, file
, extension_points
);
467 while ((name
= g_dir_read_name (dir
)))
469 if (is_valid_module_name (name
, scope
))
471 GIOExtensionPoint
*extension_point
;
474 char **extension_points
;
477 path
= g_build_filename (dirname
, name
, NULL
);
478 module
= g_io_module_new (path
);
480 extension_points
= g_hash_table_lookup (cache
, name
);
481 if (extension_points
!= NULL
&&
482 g_stat (path
, &statbuf
) == 0 &&
483 statbuf
.st_ctime
<= cache_mtime
)
485 /* Lazy load/init the library when first required */
486 for (i
= 0; extension_points
[i
] != NULL
; i
++)
489 g_io_extension_point_register (extension_points
[i
]);
490 extension_point
->lazy_load_modules
=
491 g_list_prepend (extension_point
->lazy_load_modules
,
497 /* Try to load and init types */
498 if (g_type_module_use (G_TYPE_MODULE (module
)))
499 g_type_module_unuse (G_TYPE_MODULE (module
)); /* Unload */
501 { /* Failure to load */
502 g_printerr ("Failed to load module: %s\n", path
);
503 g_object_unref (module
);
515 g_hash_table_destroy (cache
);
521 * g_io_modules_scan_all_in_directory:
522 * @dirname: pathname for a directory containing modules to scan.
524 * Scans all the modules in the specified directory, ensuring that
525 * any extension point implemented by a module is registered.
527 * This may not actually load and initialize all the types in each
528 * module, some modules may be lazily loaded and initialized when
529 * an extension point it implementes is used with e.g.
530 * g_io_extension_point_get_extensions() or
531 * g_io_extension_point_get_extension_by_name().
533 * If you need to guarantee that all types are loaded in all the modules,
534 * use g_io_modules_load_all_in_directory().
539 g_io_modules_scan_all_in_directory (const char *dirname
)
541 g_io_modules_scan_all_in_directory_with_scope (dirname
, NULL
);
545 * g_io_modules_load_all_in_directory_with_scope:
546 * @dirname: pathname for a directory containing modules to load.
547 * @scope: a scope to use when scanning the modules.
549 * Loads all the modules in the specified directory.
551 * If don't require all modules to be initialized (and thus registering
552 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
553 * which allows delayed/lazy loading of modules.
555 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
556 * from the directory,
557 * All the modules are loaded into memory, if you want to
558 * unload them (enabling on-demand loading) you must call
559 * g_type_module_unuse() on all the modules. Free the list
560 * with g_list_free().
565 g_io_modules_load_all_in_directory_with_scope (const char *dirname
,
566 GIOModuleScope
*scope
)
572 if (!g_module_supported ())
575 dir
= g_dir_open (dirname
, 0, NULL
);
580 while ((name
= g_dir_read_name (dir
)))
582 if (is_valid_module_name (name
, scope
))
587 path
= g_build_filename (dirname
, name
, NULL
);
588 module
= g_io_module_new (path
);
590 if (!g_type_module_use (G_TYPE_MODULE (module
)))
592 g_printerr ("Failed to load module: %s\n", path
);
593 g_object_unref (module
);
600 modules
= g_list_prepend (modules
, module
);
610 * g_io_modules_load_all_in_directory:
611 * @dirname: pathname for a directory containing modules to load.
613 * Loads all the modules in the specified directory.
615 * If don't require all modules to be initialized (and thus registering
616 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
617 * which allows delayed/lazy loading of modules.
619 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
620 * from the directory,
621 * All the modules are loaded into memory, if you want to
622 * unload them (enabling on-demand loading) you must call
623 * g_type_module_unuse() on all the modules. Free the list
624 * with g_list_free().
627 g_io_modules_load_all_in_directory (const char *dirname
)
629 return g_io_modules_load_all_in_directory_with_scope (dirname
, NULL
);
633 try_class (GIOExtension
*extension
,
634 guint is_supported_offset
)
636 GType type
= g_io_extension_get_type (extension
);
637 typedef gboolean (*verify_func
) (void);
640 class = g_type_class_ref (type
);
641 if (!is_supported_offset
|| (* G_STRUCT_MEMBER(verify_func
, class, is_supported_offset
)) ())
644 g_type_class_unref (class);
649 * _g_io_module_get_default_type:
650 * @extension_point: the name of an extension point
651 * @envvar: (allow-none): the name of an environment variable to
652 * override the default implementation.
653 * @is_supported_offset: a vtable offset, or zero
655 * Retrieves the default class implementing @extension_point.
657 * If @envvar is not %NULL, and the environment variable with that
658 * name is set, then the implementation it specifies will be tried
659 * first. After that, or if @envvar is not set, all other
660 * implementations will be tried in order of decreasing priority.
662 * If @is_supported_offset is non-zero, then it is the offset into the
663 * class vtable at which there is a function that takes no arguments and
664 * returns a boolean. This function will be called on each candidate
665 * implementation to check if it is actually usable or not.
667 * The result is cached after it is generated the first time, and
668 * the function is thread-safe.
670 * Return value: (transfer none): an object implementing
671 * @extension_point, or %NULL if there are no usable
675 _g_io_module_get_default_type (const gchar
*extension_point
,
677 guint is_supported_offset
)
679 static GRecMutex default_modules_lock
;
680 static GHashTable
*default_modules
;
681 const char *use_this
;
683 GIOExtensionPoint
*ep
;
684 GIOExtension
*extension
, *preferred
;
687 g_rec_mutex_lock (&default_modules_lock
);
692 if (g_hash_table_lookup_extended (default_modules
, extension_point
, &key
, &impl
))
694 g_rec_mutex_unlock (&default_modules_lock
);
695 return impl
? G_OBJECT_CLASS_TYPE (impl
) : G_TYPE_INVALID
;
700 default_modules
= g_hash_table_new (g_str_hash
, g_str_equal
);
703 _g_io_modules_ensure_loaded ();
704 ep
= g_io_extension_point_lookup (extension_point
);
708 g_warn_if_reached ();
709 g_rec_mutex_unlock (&default_modules_lock
);
710 return G_TYPE_INVALID
;
713 use_this
= envvar
? g_getenv (envvar
) : NULL
;
716 preferred
= g_io_extension_point_get_extension_by_name (ep
, use_this
);
719 impl
= try_class (preferred
, is_supported_offset
);
724 g_warning ("Can't find module '%s' specified in %s", use_this
, envvar
);
729 for (l
= g_io_extension_point_get_extensions (ep
); l
!= NULL
; l
= l
->next
)
732 if (extension
== preferred
)
735 impl
= try_class (extension
, is_supported_offset
);
743 g_hash_table_insert (default_modules
, g_strdup (extension_point
), impl
);
744 g_rec_mutex_unlock (&default_modules_lock
);
746 return impl
? G_OBJECT_CLASS_TYPE (impl
) : G_TYPE_INVALID
;
750 try_implementation (GIOExtension
*extension
,
751 GIOModuleVerifyFunc verify_func
)
753 GType type
= g_io_extension_get_type (extension
);
756 if (g_type_is_a (type
, G_TYPE_INITABLE
))
757 return g_initable_new (type
, NULL
, NULL
, NULL
);
760 impl
= g_object_new (type
, NULL
);
761 if (!verify_func
|| verify_func (impl
))
764 g_object_unref (impl
);
770 * _g_io_module_get_default:
771 * @extension_point: the name of an extension point
772 * @envvar: (allow-none): the name of an environment variable to
773 * override the default implementation.
774 * @verify_func: (allow-none): a function to call to verify that
775 * a given implementation is usable in the current environment.
777 * Retrieves the default object implementing @extension_point.
779 * If @envvar is not %NULL, and the environment variable with that
780 * name is set, then the implementation it specifies will be tried
781 * first. After that, or if @envvar is not set, all other
782 * implementations will be tried in order of decreasing priority.
784 * If an extension point implementation implements #GInitable, then
785 * that implementation will only be used if it initializes
786 * successfully. Otherwise, if @verify_func is not %NULL, then it will
787 * be called on each candidate implementation after construction, to
788 * check if it is actually usable or not.
790 * The result is cached after it is generated the first time, and
791 * the function is thread-safe.
793 * Return value: (transfer none): an object implementing
794 * @extension_point, or %NULL if there are no usable
798 _g_io_module_get_default (const gchar
*extension_point
,
800 GIOModuleVerifyFunc verify_func
)
802 static GRecMutex default_modules_lock
;
803 static GHashTable
*default_modules
;
804 const char *use_this
;
806 GIOExtensionPoint
*ep
;
807 GIOExtension
*extension
, *preferred
;
810 g_rec_mutex_lock (&default_modules_lock
);
815 if (g_hash_table_lookup_extended (default_modules
, extension_point
,
818 g_rec_mutex_unlock (&default_modules_lock
);
824 default_modules
= g_hash_table_new (g_str_hash
, g_str_equal
);
827 _g_io_modules_ensure_loaded ();
828 ep
= g_io_extension_point_lookup (extension_point
);
832 g_warn_if_reached ();
833 g_rec_mutex_unlock (&default_modules_lock
);
837 use_this
= envvar
? g_getenv (envvar
) : NULL
;
840 preferred
= g_io_extension_point_get_extension_by_name (ep
, use_this
);
843 impl
= try_implementation (preferred
, verify_func
);
848 g_warning ("Can't find module '%s' specified in %s", use_this
, envvar
);
853 for (l
= g_io_extension_point_get_extensions (ep
); l
!= NULL
; l
= l
->next
)
856 if (extension
== preferred
)
859 impl
= try_implementation (extension
, verify_func
);
867 g_hash_table_insert (default_modules
,
868 g_strdup (extension_point
),
869 impl
? g_object_ref (impl
) : NULL
);
870 g_rec_mutex_unlock (&default_modules_lock
);
875 G_LOCK_DEFINE_STATIC (registered_extensions
);
876 G_LOCK_DEFINE_STATIC (loaded_dirs
);
878 extern GType
_g_fen_directory_monitor_get_type (void);
879 extern GType
_g_fen_file_monitor_get_type (void);
880 extern GType
_g_inotify_directory_monitor_get_type (void);
881 extern GType
_g_inotify_file_monitor_get_type (void);
882 extern GType
_g_kqueue_directory_monitor_get_type (void);
883 extern GType
_g_kqueue_file_monitor_get_type (void);
884 extern GType
_g_unix_volume_monitor_get_type (void);
885 extern GType
_g_local_vfs_get_type (void);
887 extern GType
_g_win32_volume_monitor_get_type (void);
888 extern GType
g_win32_directory_monitor_get_type (void);
889 extern GType
_g_winhttp_vfs_get_type (void);
891 extern GType
_g_dummy_proxy_resolver_get_type (void);
892 extern GType
_g_dummy_tls_backend_get_type (void);
893 extern GType
g_network_monitor_base_get_type (void);
895 extern GType
_g_network_monitor_netlink_get_type (void);
899 extern GType
g_fdo_notification_backend_get_type (void);
900 extern GType
g_gtk_notification_backend_get_type (void);
903 #ifdef G_PLATFORM_WIN32
907 static HMODULE gio_dll
= NULL
;
911 BOOL WINAPI
DllMain (HINSTANCE hinstDLL
,
916 DllMain (HINSTANCE hinstDLL
,
920 if (fdwReason
== DLL_PROCESS_ATTACH
)
929 _g_io_win32_get_module (void)
932 GetModuleHandleExA (GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
,
933 (const char *) _g_io_win32_get_module
,
938 #undef GIO_MODULE_DIR
940 /* GIO_MODULE_DIR is used only in code called just once,
941 * so no problem leaking this
943 #define GIO_MODULE_DIR \
944 g_build_filename (g_win32_get_package_installation_directory_of_module (gio_dll), \
951 _g_io_modules_ensure_extension_points_registered (void)
953 static gboolean registered_extensions
= FALSE
;
954 GIOExtensionPoint
*ep
;
956 G_LOCK (registered_extensions
);
958 if (!registered_extensions
)
960 registered_extensions
= TRUE
;
963 #if !GLIB_CHECK_VERSION (3, 0, 0)
964 ep
= g_io_extension_point_register (G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME
);
965 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
966 g_io_extension_point_set_required_type (ep
, G_TYPE_DESKTOP_APP_INFO_LOOKUP
);
967 G_GNUC_END_IGNORE_DEPRECATIONS
971 ep
= g_io_extension_point_register (G_LOCAL_DIRECTORY_MONITOR_EXTENSION_POINT_NAME
);
972 g_io_extension_point_set_required_type (ep
, G_TYPE_LOCAL_DIRECTORY_MONITOR
);
974 ep
= g_io_extension_point_register (G_LOCAL_FILE_MONITOR_EXTENSION_POINT_NAME
);
975 g_io_extension_point_set_required_type (ep
, G_TYPE_LOCAL_FILE_MONITOR
);
977 ep
= g_io_extension_point_register (G_NFS_DIRECTORY_MONITOR_EXTENSION_POINT_NAME
);
978 g_io_extension_point_set_required_type (ep
, G_TYPE_LOCAL_DIRECTORY_MONITOR
);
980 ep
= g_io_extension_point_register (G_NFS_FILE_MONITOR_EXTENSION_POINT_NAME
);
981 g_io_extension_point_set_required_type (ep
, G_TYPE_LOCAL_FILE_MONITOR
);
983 ep
= g_io_extension_point_register (G_VOLUME_MONITOR_EXTENSION_POINT_NAME
);
984 g_io_extension_point_set_required_type (ep
, G_TYPE_VOLUME_MONITOR
);
986 ep
= g_io_extension_point_register (G_NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME
);
987 g_io_extension_point_set_required_type (ep
, G_TYPE_NATIVE_VOLUME_MONITOR
);
989 ep
= g_io_extension_point_register (G_VFS_EXTENSION_POINT_NAME
);
990 g_io_extension_point_set_required_type (ep
, G_TYPE_VFS
);
992 ep
= g_io_extension_point_register ("gsettings-backend");
993 g_io_extension_point_set_required_type (ep
, G_TYPE_OBJECT
);
995 ep
= g_io_extension_point_register (G_PROXY_RESOLVER_EXTENSION_POINT_NAME
);
996 g_io_extension_point_set_required_type (ep
, G_TYPE_PROXY_RESOLVER
);
998 ep
= g_io_extension_point_register (G_PROXY_EXTENSION_POINT_NAME
);
999 g_io_extension_point_set_required_type (ep
, G_TYPE_PROXY
);
1001 ep
= g_io_extension_point_register (G_TLS_BACKEND_EXTENSION_POINT_NAME
);
1002 g_io_extension_point_set_required_type (ep
, G_TYPE_TLS_BACKEND
);
1004 ep
= g_io_extension_point_register (G_NETWORK_MONITOR_EXTENSION_POINT_NAME
);
1005 g_io_extension_point_set_required_type (ep
, G_TYPE_NETWORK_MONITOR
);
1007 ep
= g_io_extension_point_register (G_NOTIFICATION_BACKEND_EXTENSION_POINT_NAME
);
1008 g_io_extension_point_set_required_type (ep
, G_TYPE_NOTIFICATION_BACKEND
);
1011 G_UNLOCK (registered_extensions
);
1015 _g_io_modules_ensure_loaded (void)
1017 static gboolean loaded_dirs
= FALSE
;
1018 const char *module_path
;
1019 GIOModuleScope
*scope
;
1021 _g_io_modules_ensure_extension_points_registered ();
1023 G_LOCK (loaded_dirs
);
1028 scope
= g_io_module_scope_new (G_IO_MODULE_SCOPE_BLOCK_DUPLICATES
);
1030 /* First load any overrides, extras */
1031 module_path
= g_getenv ("GIO_EXTRA_MODULES");
1037 paths
= g_strsplit (module_path
, G_SEARCHPATH_SEPARATOR_S
, 0);
1039 for (i
= 0; paths
[i
] != NULL
; i
++)
1041 g_io_modules_scan_all_in_directory_with_scope (paths
[i
], scope
);
1047 /* Then load the compiled in path */
1048 g_io_modules_scan_all_in_directory_with_scope (GIO_MODULE_DIR
, scope
);
1050 g_io_module_scope_free (scope
);
1052 /* Initialize types from built-in "modules" */
1053 g_type_ensure (g_null_settings_backend_get_type ());
1054 g_type_ensure (g_memory_settings_backend_get_type ());
1055 #if defined(HAVE_SYS_INOTIFY_H) || defined(HAVE_LINUX_INOTIFY_H)
1056 g_type_ensure (_g_inotify_directory_monitor_get_type ());
1057 g_type_ensure (_g_inotify_file_monitor_get_type ());
1059 #if defined(HAVE_KQUEUE)
1060 g_type_ensure (_g_kqueue_directory_monitor_get_type ());
1061 g_type_ensure (_g_kqueue_file_monitor_get_type ());
1063 #if defined(HAVE_FEN)
1064 g_type_ensure (_g_fen_directory_monitor_get_type ());
1065 g_type_ensure (_g_fen_file_monitor_get_type ());
1068 g_type_ensure (_g_win32_volume_monitor_get_type ());
1069 g_type_ensure (g_win32_directory_monitor_get_type ());
1070 g_type_ensure (g_registry_backend_get_type ());
1073 g_nextstep_settings_backend_get_type ();
1076 g_type_ensure (_g_unix_volume_monitor_get_type ());
1077 g_type_ensure (g_fdo_notification_backend_get_type ());
1078 g_type_ensure (g_gtk_notification_backend_get_type ());
1081 g_type_ensure (_g_winhttp_vfs_get_type ());
1083 g_type_ensure (_g_local_vfs_get_type ());
1084 g_type_ensure (_g_dummy_proxy_resolver_get_type ());
1085 g_type_ensure (_g_socks4a_proxy_get_type ());
1086 g_type_ensure (_g_socks4_proxy_get_type ());
1087 g_type_ensure (_g_socks5_proxy_get_type ());
1088 g_type_ensure (_g_dummy_tls_backend_get_type ());
1089 g_type_ensure (g_network_monitor_base_get_type ());
1091 g_type_ensure (_g_network_monitor_netlink_get_type ());
1095 G_UNLOCK (loaded_dirs
);
1099 g_io_extension_point_free (GIOExtensionPoint
*ep
)
1106 * g_io_extension_point_register:
1107 * @name: The name of the extension point
1109 * Registers an extension point.
1111 * Returns: (transfer none): the new #GIOExtensionPoint. This object is
1112 * owned by GIO and should not be freed.
1115 g_io_extension_point_register (const char *name
)
1117 GIOExtensionPoint
*ep
;
1119 G_LOCK (extension_points
);
1120 if (extension_points
== NULL
)
1121 extension_points
= g_hash_table_new_full (g_str_hash
,
1124 (GDestroyNotify
)g_io_extension_point_free
);
1126 ep
= g_hash_table_lookup (extension_points
, name
);
1129 G_UNLOCK (extension_points
);
1133 ep
= g_new0 (GIOExtensionPoint
, 1);
1134 ep
->name
= g_strdup (name
);
1136 g_hash_table_insert (extension_points
, ep
->name
, ep
);
1138 G_UNLOCK (extension_points
);
1144 * g_io_extension_point_lookup:
1145 * @name: the name of the extension point
1147 * Looks up an existing extension point.
1149 * Returns: (transfer none): the #GIOExtensionPoint, or %NULL if there
1150 * is no registered extension point with the given name.
1153 g_io_extension_point_lookup (const char *name
)
1155 GIOExtensionPoint
*ep
;
1157 G_LOCK (extension_points
);
1159 if (extension_points
!= NULL
)
1160 ep
= g_hash_table_lookup (extension_points
, name
);
1162 G_UNLOCK (extension_points
);
1169 * g_io_extension_point_set_required_type:
1170 * @extension_point: a #GIOExtensionPoint
1171 * @type: the #GType to require
1173 * Sets the required type for @extension_point to @type.
1174 * All implementations must henceforth have this type.
1177 g_io_extension_point_set_required_type (GIOExtensionPoint
*extension_point
,
1180 extension_point
->required_type
= type
;
1184 * g_io_extension_point_get_required_type:
1185 * @extension_point: a #GIOExtensionPoint
1187 * Gets the required type for @extension_point.
1189 * Returns: the #GType that all implementations must have,
1190 * or #G_TYPE_INVALID if the extension point has no required type
1193 g_io_extension_point_get_required_type (GIOExtensionPoint
*extension_point
)
1195 return extension_point
->required_type
;
1199 lazy_load_modules (GIOExtensionPoint
*extension_point
)
1204 for (l
= extension_point
->lazy_load_modules
; l
!= NULL
; l
= l
->next
)
1208 if (!module
->initialized
)
1210 if (g_type_module_use (G_TYPE_MODULE (module
)))
1211 g_type_module_unuse (G_TYPE_MODULE (module
)); /* Unload */
1213 g_printerr ("Failed to load module: %s\n",
1220 * g_io_extension_point_get_extensions:
1221 * @extension_point: a #GIOExtensionPoint
1223 * Gets a list of all extensions that implement this extension point.
1224 * The list is sorted by priority, beginning with the highest priority.
1226 * Returns: (element-type GIOExtension) (transfer none): a #GList of
1227 * #GIOExtension<!-- -->s. The list is owned by GIO and should not be
1231 g_io_extension_point_get_extensions (GIOExtensionPoint
*extension_point
)
1233 lazy_load_modules (extension_point
);
1234 return extension_point
->extensions
;
1238 * g_io_extension_point_get_extension_by_name:
1239 * @extension_point: a #GIOExtensionPoint
1240 * @name: the name of the extension to get
1242 * Finds a #GIOExtension for an extension point by name.
1244 * Returns: (transfer none): the #GIOExtension for @extension_point that has the
1245 * given name, or %NULL if there is no extension with that name
1248 g_io_extension_point_get_extension_by_name (GIOExtensionPoint
*extension_point
,
1253 lazy_load_modules (extension_point
);
1254 for (l
= extension_point
->extensions
; l
!= NULL
; l
= l
->next
)
1256 GIOExtension
*e
= l
->data
;
1258 if (e
->name
!= NULL
&&
1259 strcmp (e
->name
, name
) == 0)
1267 extension_prio_compare (gconstpointer a
,
1270 const GIOExtension
*extension_a
= a
, *extension_b
= b
;
1272 if (extension_a
->priority
> extension_b
->priority
)
1275 if (extension_b
->priority
> extension_a
->priority
)
1282 * g_io_extension_point_implement:
1283 * @extension_point_name: the name of the extension point
1284 * @type: the #GType to register as extension
1285 * @extension_name: the name for the extension
1286 * @priority: the priority for the extension
1288 * Registers @type as extension for the extension point with name
1289 * @extension_point_name.
1291 * If @type has already been registered as an extension for this
1292 * extension point, the existing #GIOExtension object is returned.
1294 * Returns: (transfer none): a #GIOExtension object for #GType
1297 g_io_extension_point_implement (const char *extension_point_name
,
1299 const char *extension_name
,
1302 GIOExtensionPoint
*extension_point
;
1303 GIOExtension
*extension
;
1306 g_return_val_if_fail (extension_point_name
!= NULL
, NULL
);
1308 extension_point
= g_io_extension_point_lookup (extension_point_name
);
1309 if (extension_point
== NULL
)
1311 g_warning ("Tried to implement non-registered extension point %s", extension_point_name
);
1315 if (extension_point
->required_type
!= 0 &&
1316 !g_type_is_a (type
, extension_point
->required_type
))
1318 g_warning ("Tried to register an extension of the type %s to extension point %s. "
1319 "Expected type is %s.",
1321 extension_point_name
,
1322 g_type_name (extension_point
->required_type
));
1326 /* It's safe to register the same type multiple times */
1327 for (l
= extension_point
->extensions
; l
!= NULL
; l
= l
->next
)
1329 extension
= l
->data
;
1330 if (extension
->type
== type
)
1334 extension
= g_slice_new0 (GIOExtension
);
1335 extension
->type
= type
;
1336 extension
->name
= g_strdup (extension_name
);
1337 extension
->priority
= priority
;
1339 extension_point
->extensions
= g_list_insert_sorted (extension_point
->extensions
,
1340 extension
, extension_prio_compare
);
1346 * g_io_extension_ref_class:
1347 * @extension: a #GIOExtension
1349 * Gets a reference to the class for the type that is
1350 * associated with @extension.
1352 * Returns: (transfer full): the #GTypeClass for the type of @extension
1355 g_io_extension_ref_class (GIOExtension
*extension
)
1357 return g_type_class_ref (extension
->type
);
1361 * g_io_extension_get_type:
1362 * @extension: a #GIOExtension
1364 * Gets the type associated with @extension.
1366 * Returns: the type of @extension
1369 g_io_extension_get_type (GIOExtension
*extension
)
1371 return extension
->type
;
1375 * g_io_extension_get_name:
1376 * @extension: a #GIOExtension
1378 * Gets the name under which @extension was registered.
1380 * Note that the same type may be registered as extension
1381 * for multiple extension points, under different names.
1383 * Returns: the name of @extension.
1386 g_io_extension_get_name (GIOExtension
*extension
)
1388 return extension
->name
;
1392 * g_io_extension_get_priority:
1393 * @extension: a #GIOExtension
1395 * Gets the priority with which @extension was registered.
1397 * Returns: the priority of @extension
1400 g_io_extension_get_priority (GIOExtension
*extension
)
1402 return extension
->priority
;