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.1 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, see <http://www.gnu.org/licenses/>.
18 * Author: Alexander Larsson <alexl@redhat.com>
25 #include "giomodule.h"
26 #include "giomodule-priv.h"
27 #include "glocalfilemonitor.h"
28 #include "gnativevolumemonitor.h"
29 #include "gproxyresolver.h"
31 #include "gsettingsbackendinternal.h"
32 #include "ghttpproxy.h"
33 #include "gsocks4proxy.h"
34 #include "gsocks4aproxy.h"
35 #include "gsocks5proxy.h"
36 #include "gtlsbackend.h"
38 #include "gnotificationbackend.h"
39 #include "ginitable.h"
40 #include "gnetworkmonitor.h"
42 #include "gregistrysettingsbackend.h"
44 #include <glib/gstdio.h>
46 #if defined(G_OS_UNIX) && !defined(HAVE_COCOA)
47 #include "gdesktopappinfo.h"
50 #include "gosxappinfo.h"
54 #include <AvailabilityMacros.h>
59 * @short_description: Loadable GIO Modules
62 * Provides an interface and default functions for loading and unloading
63 * modules. This is used internally to make GIO extensible, but can also
64 * be used by others to implement module loading.
69 * SECTION:extensionpoints
70 * @short_description: Extension Points
72 * @see_also: [Extending GIO][extending-gio]
74 * #GIOExtensionPoint provides a mechanism for modules to extend the
75 * functionality of the library or application that loaded it in an
78 * An extension point is identified by a name, and it may optionally
79 * require that any implementation must be of a certain type (or derived
80 * thereof). Use g_io_extension_point_register() to register an
81 * extension point, and g_io_extension_point_set_required_type() to
82 * set a required type.
84 * A module can implement an extension point by specifying the #GType
85 * that implements the functionality. Additionally, each implementation
86 * of an extension point has a name, and a priority. Use
87 * g_io_extension_point_implement() to implement an extension point.
89 * |[<!-- language="C" -->
90 * GIOExtensionPoint *ep;
92 * // Register an extension point
93 * ep = g_io_extension_point_register ("my-extension-point");
94 * g_io_extension_point_set_required_type (ep, MY_TYPE_EXAMPLE);
97 * |[<!-- language="C" -->
98 * // Implement an extension point
99 * G_DEFINE_TYPE (MyExampleImpl, my_example_impl, MY_TYPE_EXAMPLE)
100 * g_io_extension_point_implement ("my-extension-point",
101 * my_example_impl_get_type (),
106 * It is up to the code that registered the extension point how
107 * it uses the implementations that have been associated with it.
108 * Depending on the use case, it may use all implementations, or
109 * only the one with the highest priority, or pick a specific
112 * To avoid opening all modules just to find out what extension
113 * points they implement, GIO makes use of a caching mechanism,
114 * see [gio-querymodules][gio-querymodules].
115 * You are expected to run this command after installing a
118 * The `GIO_EXTRA_MODULES` environment variable can be used to
119 * specify additional directories to automatically load modules
120 * from. This environment variable has the same syntax as the
121 * `PATH`. If two modules have the same base name in different
122 * directories, then the latter one will be ignored. If additional
123 * directories are specified GIO will load modules from the built-in
130 * Represents a scope for loading IO modules. A scope can be used for blocking
131 * duplicate modules, or blocking a module you don't want to load.
133 * The scope can be used with g_io_modules_load_all_in_directory_with_scope()
134 * or g_io_modules_scan_all_in_directory_with_scope().
138 struct _GIOModuleScope
{
139 GIOModuleScopeFlags flags
;
140 GHashTable
*basenames
;
144 * g_io_module_scope_new:
145 * @flags: flags for the new scope
147 * Create a new scope for loading of IO modules. A scope can be used for
148 * blocking duplicate modules, or blocking a module you don't want to load.
150 * Specify the %G_IO_MODULE_SCOPE_BLOCK_DUPLICATES flag to block modules
151 * which have the same base name as a module that has already been seen
154 * Returns: (transfer full): the new module scope
159 g_io_module_scope_new (GIOModuleScopeFlags flags
)
161 GIOModuleScope
*scope
= g_new0 (GIOModuleScope
, 1);
162 scope
->flags
= flags
;
163 scope
->basenames
= g_hash_table_new_full (g_str_hash
, g_str_equal
, g_free
, NULL
);
168 * g_io_module_scope_free:
169 * @scope: a module loading scope
171 * Free a module scope.
176 g_io_module_scope_free (GIOModuleScope
*scope
)
180 g_hash_table_destroy (scope
->basenames
);
185 * g_io_module_scope_block:
186 * @scope: a module loading scope
187 * @basename: the basename to block
189 * Block modules with the given @basename from being loaded when
190 * this scope is used with g_io_modules_scan_all_in_directory_with_scope()
191 * or g_io_modules_load_all_in_directory_with_scope().
196 g_io_module_scope_block (GIOModuleScope
*scope
,
197 const gchar
*basename
)
201 g_return_if_fail (scope
!= NULL
);
202 g_return_if_fail (basename
!= NULL
);
204 key
= g_strdup (basename
);
205 g_hash_table_add (scope
->basenames
, key
);
209 _g_io_module_scope_contains (GIOModuleScope
*scope
,
210 const gchar
*basename
)
212 return g_hash_table_contains (scope
->basenames
, basename
);
216 GTypeModule parent_instance
;
220 gboolean initialized
; /* The module was loaded at least once */
222 void (* load
) (GIOModule
*module
);
223 void (* unload
) (GIOModule
*module
);
226 struct _GIOModuleClass
228 GTypeModuleClass parent_class
;
232 static void g_io_module_finalize (GObject
*object
);
233 static gboolean
g_io_module_load_module (GTypeModule
*gmodule
);
234 static void g_io_module_unload_module (GTypeModule
*gmodule
);
239 * #GIOExtension is an opaque data structure and can only be accessed
240 * using the following functions.
242 struct _GIOExtension
{
251 * #GIOExtensionPoint is an opaque data structure and can only be accessed
252 * using the following functions.
254 struct _GIOExtensionPoint
{
258 GList
*lazy_load_modules
;
261 static GHashTable
*extension_points
= NULL
;
262 G_LOCK_DEFINE_STATIC(extension_points
);
264 G_DEFINE_TYPE (GIOModule
, g_io_module
, G_TYPE_TYPE_MODULE
)
267 g_io_module_class_init (GIOModuleClass
*class)
269 GObjectClass
*object_class
= G_OBJECT_CLASS (class);
270 GTypeModuleClass
*type_module_class
= G_TYPE_MODULE_CLASS (class);
272 object_class
->finalize
= g_io_module_finalize
;
274 type_module_class
->load
= g_io_module_load_module
;
275 type_module_class
->unload
= g_io_module_unload_module
;
279 g_io_module_init (GIOModule
*module
)
284 g_io_module_finalize (GObject
*object
)
286 GIOModule
*module
= G_IO_MODULE (object
);
288 g_free (module
->filename
);
290 G_OBJECT_CLASS (g_io_module_parent_class
)->finalize (object
);
294 load_symbols (GIOModule
*module
)
298 gchar
*unload_symname
;
301 name
= _g_io_module_extract_name (module
->filename
);
302 load_symname
= g_strconcat ("g_io_", name
, "_load", NULL
);
303 unload_symname
= g_strconcat ("g_io_", name
, "_unload", NULL
);
305 ret
= g_module_symbol (module
->library
,
307 (gpointer
) &module
->load
) &&
308 g_module_symbol (module
->library
,
310 (gpointer
) &module
->unload
);
314 /* Fallback to old names */
315 ret
= g_module_symbol (module
->library
,
317 (gpointer
) &module
->load
) &&
318 g_module_symbol (module
->library
,
319 "g_io_module_unload",
320 (gpointer
) &module
->unload
);
324 g_free (load_symname
);
325 g_free (unload_symname
);
331 g_io_module_load_module (GTypeModule
*gmodule
)
333 GIOModule
*module
= G_IO_MODULE (gmodule
);
335 if (!module
->filename
)
337 g_warning ("GIOModule path not set");
341 module
->library
= g_module_open (module
->filename
, G_MODULE_BIND_LAZY
| G_MODULE_BIND_LOCAL
);
343 if (!module
->library
)
345 g_printerr ("%s\n", g_module_error ());
349 /* Make sure that the loaded library contains the required methods */
350 if (!load_symbols (module
))
352 g_printerr ("%s\n", g_module_error ());
353 g_module_close (module
->library
);
358 /* Initialize the loaded module */
359 module
->load (module
);
360 module
->initialized
= TRUE
;
366 g_io_module_unload_module (GTypeModule
*gmodule
)
368 GIOModule
*module
= G_IO_MODULE (gmodule
);
370 module
->unload (module
);
372 g_module_close (module
->library
);
373 module
->library
= NULL
;
376 module
->unload
= NULL
;
381 * @filename: (type filename): filename of the shared library module.
383 * Creates a new GIOModule that will load the specific
384 * shared library when in use.
386 * Returns: a #GIOModule from given @filename,
390 g_io_module_new (const gchar
*filename
)
394 g_return_val_if_fail (filename
!= NULL
, NULL
);
396 module
= g_object_new (G_IO_TYPE_MODULE
, NULL
);
397 module
->filename
= g_strdup (filename
);
403 is_valid_module_name (const gchar
*basename
,
404 GIOModuleScope
*scope
)
408 #if !defined(G_OS_WIN32) && !defined(G_WITH_CYGWIN)
409 if (!g_str_has_prefix (basename
, "lib") ||
410 !g_str_has_suffix (basename
, ".so"))
413 if (!g_str_has_suffix (basename
, ".dll"))
420 result
= _g_io_module_scope_contains (scope
, basename
) ? FALSE
: TRUE
;
421 if (result
&& (scope
->flags
& G_IO_MODULE_SCOPE_BLOCK_DUPLICATES
))
422 g_io_module_scope_block (scope
, basename
);
430 * g_io_modules_scan_all_in_directory_with_scope:
431 * @dirname: (type filename): pathname for a directory containing modules
433 * @scope: a scope to use when scanning the modules
435 * Scans all the modules in the specified directory, ensuring that
436 * any extension point implemented by a module is registered.
438 * This may not actually load and initialize all the types in each
439 * module, some modules may be lazily loaded and initialized when
440 * an extension point it implementes is used with e.g.
441 * g_io_extension_point_get_extensions() or
442 * g_io_extension_point_get_extension_by_name().
444 * If you need to guarantee that all types are loaded in all the modules,
445 * use g_io_modules_load_all_in_directory().
450 g_io_modules_scan_all_in_directory_with_scope (const char *dirname
,
451 GIOModuleScope
*scope
)
461 if (!g_module_supported ())
464 dir
= g_dir_open (dirname
, 0, NULL
);
468 filename
= g_build_filename (dirname
, "giomodule.cache", NULL
);
470 cache
= g_hash_table_new_full (g_str_hash
, g_str_equal
,
471 g_free
, (GDestroyNotify
)g_strfreev
);
474 if (g_stat (filename
, &statbuf
) == 0 &&
475 g_file_get_contents (filename
, &data
, NULL
, NULL
))
480 /* Cache mtime is the time the cache file was created, any file
481 * that has a ctime before this was created then and not modified
482 * since then (userspace can't change ctime). Its possible to change
483 * the ctime forward without changing the file content, by e.g.
484 * chmoding the file, but this is uncommon and will only cause us
485 * to not use the cache so will not cause bugs.
487 cache_mtime
= statbuf
.st_mtime
;
489 lines
= g_strsplit (data
, "\n", -1);
492 for (i
= 0; lines
[i
] != NULL
; i
++)
494 char *line
= lines
[i
];
497 char **extension_points
;
502 colon
= strchr (line
, ':');
503 if (colon
== NULL
|| line
== colon
)
504 continue; /* Invalid line, ignore */
506 *colon
= 0; /* terminate filename */
507 file
= g_strdup (line
);
508 colon
++; /* after colon */
510 while (g_ascii_isspace (*colon
))
513 extension_points
= g_strsplit (colon
, ",", -1);
514 g_hash_table_insert (cache
, file
, extension_points
);
519 while ((name
= g_dir_read_name (dir
)))
521 if (is_valid_module_name (name
, scope
))
523 GIOExtensionPoint
*extension_point
;
526 char **extension_points
;
529 path
= g_build_filename (dirname
, name
, NULL
);
530 module
= g_io_module_new (path
);
532 extension_points
= g_hash_table_lookup (cache
, name
);
533 if (extension_points
!= NULL
&&
534 g_stat (path
, &statbuf
) == 0 &&
535 statbuf
.st_ctime
<= cache_mtime
)
537 /* Lazy load/init the library when first required */
538 for (i
= 0; extension_points
[i
] != NULL
; i
++)
541 g_io_extension_point_register (extension_points
[i
]);
542 extension_point
->lazy_load_modules
=
543 g_list_prepend (extension_point
->lazy_load_modules
,
549 /* Try to load and init types */
550 if (g_type_module_use (G_TYPE_MODULE (module
)))
551 g_type_module_unuse (G_TYPE_MODULE (module
)); /* Unload */
553 { /* Failure to load */
554 g_printerr ("Failed to load module: %s\n", path
);
555 g_object_unref (module
);
567 g_hash_table_destroy (cache
);
573 * g_io_modules_scan_all_in_directory:
574 * @dirname: (type filename): pathname for a directory containing modules
577 * Scans all the modules in the specified directory, ensuring that
578 * any extension point implemented by a module is registered.
580 * This may not actually load and initialize all the types in each
581 * module, some modules may be lazily loaded and initialized when
582 * an extension point it implementes is used with e.g.
583 * g_io_extension_point_get_extensions() or
584 * g_io_extension_point_get_extension_by_name().
586 * If you need to guarantee that all types are loaded in all the modules,
587 * use g_io_modules_load_all_in_directory().
592 g_io_modules_scan_all_in_directory (const char *dirname
)
594 g_io_modules_scan_all_in_directory_with_scope (dirname
, NULL
);
598 * g_io_modules_load_all_in_directory_with_scope:
599 * @dirname: (type filename): pathname for a directory containing modules
601 * @scope: a scope to use when scanning the modules.
603 * Loads all the modules in the specified directory.
605 * If don't require all modules to be initialized (and thus registering
606 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
607 * which allows delayed/lazy loading of modules.
609 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
610 * from the directory,
611 * All the modules are loaded into memory, if you want to
612 * unload them (enabling on-demand loading) you must call
613 * g_type_module_unuse() on all the modules. Free the list
614 * with g_list_free().
619 g_io_modules_load_all_in_directory_with_scope (const char *dirname
,
620 GIOModuleScope
*scope
)
626 if (!g_module_supported ())
629 dir
= g_dir_open (dirname
, 0, NULL
);
634 while ((name
= g_dir_read_name (dir
)))
636 if (is_valid_module_name (name
, scope
))
641 path
= g_build_filename (dirname
, name
, NULL
);
642 module
= g_io_module_new (path
);
644 if (!g_type_module_use (G_TYPE_MODULE (module
)))
646 g_printerr ("Failed to load module: %s\n", path
);
647 g_object_unref (module
);
654 modules
= g_list_prepend (modules
, module
);
664 * g_io_modules_load_all_in_directory:
665 * @dirname: (type filename): pathname for a directory containing modules
668 * Loads all the modules in the specified directory.
670 * If don't require all modules to be initialized (and thus registering
671 * all gtypes) then you can use g_io_modules_scan_all_in_directory()
672 * which allows delayed/lazy loading of modules.
674 * Returns: (element-type GIOModule) (transfer full): a list of #GIOModules loaded
675 * from the directory,
676 * All the modules are loaded into memory, if you want to
677 * unload them (enabling on-demand loading) you must call
678 * g_type_module_unuse() on all the modules. Free the list
679 * with g_list_free().
682 g_io_modules_load_all_in_directory (const char *dirname
)
684 return g_io_modules_load_all_in_directory_with_scope (dirname
, NULL
);
688 try_class (GIOExtension
*extension
,
689 guint is_supported_offset
)
691 GType type
= g_io_extension_get_type (extension
);
692 typedef gboolean (*verify_func
) (void);
695 class = g_type_class_ref (type
);
696 if (!is_supported_offset
|| (* G_STRUCT_MEMBER(verify_func
, class, is_supported_offset
)) ())
699 g_type_class_unref (class);
704 * _g_io_module_get_default_type:
705 * @extension_point: the name of an extension point
706 * @envvar: (nullable): the name of an environment variable to
707 * override the default implementation.
708 * @is_supported_offset: a vtable offset, or zero
710 * Retrieves the default class implementing @extension_point.
712 * If @envvar is not %NULL, and the environment variable with that
713 * name is set, then the implementation it specifies will be tried
714 * first. After that, or if @envvar is not set, all other
715 * implementations will be tried in order of decreasing priority.
717 * If @is_supported_offset is non-zero, then it is the offset into the
718 * class vtable at which there is a function that takes no arguments and
719 * returns a boolean. This function will be called on each candidate
720 * implementation to check if it is actually usable or not.
722 * The result is cached after it is generated the first time, and
723 * the function is thread-safe.
725 * Returns: (transfer none): the type to instantiate to implement
726 * @extension_point, or %G_TYPE_INVALID if there are no usable
730 _g_io_module_get_default_type (const gchar
*extension_point
,
732 guint is_supported_offset
)
734 static GRecMutex default_modules_lock
;
735 static GHashTable
*default_modules
;
736 const char *use_this
;
738 GIOExtensionPoint
*ep
;
739 GIOExtension
*extension
, *preferred
;
742 g_rec_mutex_lock (&default_modules_lock
);
747 if (g_hash_table_lookup_extended (default_modules
, extension_point
, &key
, &impl
))
749 g_rec_mutex_unlock (&default_modules_lock
);
750 return impl
? G_OBJECT_CLASS_TYPE (impl
) : G_TYPE_INVALID
;
755 default_modules
= g_hash_table_new (g_str_hash
, g_str_equal
);
758 _g_io_modules_ensure_loaded ();
759 ep
= g_io_extension_point_lookup (extension_point
);
763 g_warn_if_reached ();
764 g_rec_mutex_unlock (&default_modules_lock
);
765 return G_TYPE_INVALID
;
768 use_this
= envvar
? g_getenv (envvar
) : NULL
;
771 preferred
= g_io_extension_point_get_extension_by_name (ep
, use_this
);
774 impl
= try_class (preferred
, is_supported_offset
);
779 g_warning ("Can't find module '%s' specified in %s", use_this
, envvar
);
784 for (l
= g_io_extension_point_get_extensions (ep
); l
!= NULL
; l
= l
->next
)
787 if (extension
== preferred
)
790 impl
= try_class (extension
, is_supported_offset
);
798 g_hash_table_insert (default_modules
, g_strdup (extension_point
), impl
);
799 g_rec_mutex_unlock (&default_modules_lock
);
801 return impl
? G_OBJECT_CLASS_TYPE (impl
) : G_TYPE_INVALID
;
805 try_implementation (GIOExtension
*extension
,
806 GIOModuleVerifyFunc verify_func
)
808 GType type
= g_io_extension_get_type (extension
);
811 if (g_type_is_a (type
, G_TYPE_INITABLE
))
812 return g_initable_new (type
, NULL
, NULL
, NULL
);
815 impl
= g_object_new (type
, NULL
);
816 if (!verify_func
|| verify_func (impl
))
819 g_object_unref (impl
);
825 * _g_io_module_get_default:
826 * @extension_point: the name of an extension point
827 * @envvar: (nullable): the name of an environment variable to
828 * override the default implementation.
829 * @verify_func: (nullable): a function to call to verify that
830 * a given implementation is usable in the current environment.
832 * Retrieves the default object implementing @extension_point.
834 * If @envvar is not %NULL, and the environment variable with that
835 * name is set, then the implementation it specifies will be tried
836 * first. After that, or if @envvar is not set, all other
837 * implementations will be tried in order of decreasing priority.
839 * If an extension point implementation implements #GInitable, then
840 * that implementation will only be used if it initializes
841 * successfully. Otherwise, if @verify_func is not %NULL, then it will
842 * be called on each candidate implementation after construction, to
843 * check if it is actually usable or not.
845 * The result is cached after it is generated the first time, and
846 * the function is thread-safe.
848 * Returns: (transfer none): an object implementing
849 * @extension_point, or %NULL if there are no usable
853 _g_io_module_get_default (const gchar
*extension_point
,
855 GIOModuleVerifyFunc verify_func
)
857 static GRecMutex default_modules_lock
;
858 static GHashTable
*default_modules
;
859 const char *use_this
;
861 GIOExtensionPoint
*ep
;
862 GIOExtension
*extension
, *preferred
;
865 g_rec_mutex_lock (&default_modules_lock
);
870 if (g_hash_table_lookup_extended (default_modules
, extension_point
,
873 g_rec_mutex_unlock (&default_modules_lock
);
879 default_modules
= g_hash_table_new (g_str_hash
, g_str_equal
);
882 _g_io_modules_ensure_loaded ();
883 ep
= g_io_extension_point_lookup (extension_point
);
887 g_warn_if_reached ();
888 g_rec_mutex_unlock (&default_modules_lock
);
892 use_this
= envvar
? g_getenv (envvar
) : NULL
;
895 preferred
= g_io_extension_point_get_extension_by_name (ep
, use_this
);
898 impl
= try_implementation (preferred
, verify_func
);
903 g_warning ("Can't find module '%s' specified in %s", use_this
, envvar
);
908 for (l
= g_io_extension_point_get_extensions (ep
); l
!= NULL
; l
= l
->next
)
911 if (extension
== preferred
)
914 impl
= try_implementation (extension
, verify_func
);
922 g_hash_table_insert (default_modules
,
923 g_strdup (extension_point
),
924 impl
? g_object_ref (impl
) : NULL
);
925 g_rec_mutex_unlock (&default_modules_lock
);
930 G_LOCK_DEFINE_STATIC (registered_extensions
);
931 G_LOCK_DEFINE_STATIC (loaded_dirs
);
933 extern GType
g_fen_file_monitor_get_type (void);
934 extern GType
g_inotify_file_monitor_get_type (void);
935 extern GType
g_kqueue_file_monitor_get_type (void);
936 extern GType
g_win32_file_monitor_get_type (void);
938 extern GType
_g_unix_volume_monitor_get_type (void);
939 extern GType
_g_local_vfs_get_type (void);
941 extern GType
_g_win32_volume_monitor_get_type (void);
942 extern GType
_g_winhttp_vfs_get_type (void);
944 extern GType
_g_dummy_proxy_resolver_get_type (void);
945 extern GType
_g_dummy_tls_backend_get_type (void);
946 extern GType
g_network_monitor_base_get_type (void);
948 extern GType
_g_network_monitor_netlink_get_type (void);
949 extern GType
_g_network_monitor_nm_get_type (void);
953 extern GType
g_fdo_notification_backend_get_type (void);
954 extern GType
g_gtk_notification_backend_get_type (void);
955 extern GType
g_portal_notification_backend_get_type (void);
956 extern GType
g_proxy_resolver_portal_get_type (void);
957 extern GType
g_network_monitor_portal_get_type (void);
960 #if MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
961 extern GType
g_cocoa_notification_backend_get_type (void);
964 #ifdef G_PLATFORM_WIN32
965 extern GType
g_win32_notification_backend_get_type (void);
968 extern GType
_g_win32_network_monitor_get_type (void);
970 static HMODULE gio_dll
= NULL
;
974 BOOL WINAPI
DllMain (HINSTANCE hinstDLL
,
979 DllMain (HINSTANCE hinstDLL
,
983 if (fdwReason
== DLL_PROCESS_ATTACH
)
992 _g_io_win32_get_module (void)
995 GetModuleHandleExA (GET_MODULE_HANDLE_EX_FLAG_FROM_ADDRESS
,
996 (const char *) _g_io_win32_get_module
,
1004 _g_io_modules_ensure_extension_points_registered (void)
1006 static gboolean registered_extensions
= FALSE
;
1007 GIOExtensionPoint
*ep
;
1009 G_LOCK (registered_extensions
);
1011 if (!registered_extensions
)
1013 registered_extensions
= TRUE
;
1015 #if defined(G_OS_UNIX) && !defined(HAVE_COCOA)
1016 #if !GLIB_CHECK_VERSION (3, 0, 0)
1017 ep
= g_io_extension_point_register (G_DESKTOP_APP_INFO_LOOKUP_EXTENSION_POINT_NAME
);
1018 G_GNUC_BEGIN_IGNORE_DEPRECATIONS
1019 g_io_extension_point_set_required_type (ep
, G_TYPE_DESKTOP_APP_INFO_LOOKUP
);
1020 G_GNUC_END_IGNORE_DEPRECATIONS
1024 ep
= g_io_extension_point_register (G_LOCAL_FILE_MONITOR_EXTENSION_POINT_NAME
);
1025 g_io_extension_point_set_required_type (ep
, G_TYPE_LOCAL_FILE_MONITOR
);
1027 ep
= g_io_extension_point_register (G_NFS_FILE_MONITOR_EXTENSION_POINT_NAME
);
1028 g_io_extension_point_set_required_type (ep
, G_TYPE_LOCAL_FILE_MONITOR
);
1030 ep
= g_io_extension_point_register (G_VOLUME_MONITOR_EXTENSION_POINT_NAME
);
1031 g_io_extension_point_set_required_type (ep
, G_TYPE_VOLUME_MONITOR
);
1033 ep
= g_io_extension_point_register (G_NATIVE_VOLUME_MONITOR_EXTENSION_POINT_NAME
);
1034 g_io_extension_point_set_required_type (ep
, G_TYPE_NATIVE_VOLUME_MONITOR
);
1036 ep
= g_io_extension_point_register (G_VFS_EXTENSION_POINT_NAME
);
1037 g_io_extension_point_set_required_type (ep
, G_TYPE_VFS
);
1039 ep
= g_io_extension_point_register ("gsettings-backend");
1040 g_io_extension_point_set_required_type (ep
, G_TYPE_OBJECT
);
1042 ep
= g_io_extension_point_register (G_PROXY_RESOLVER_EXTENSION_POINT_NAME
);
1043 g_io_extension_point_set_required_type (ep
, G_TYPE_PROXY_RESOLVER
);
1045 ep
= g_io_extension_point_register (G_PROXY_EXTENSION_POINT_NAME
);
1046 g_io_extension_point_set_required_type (ep
, G_TYPE_PROXY
);
1048 ep
= g_io_extension_point_register (G_TLS_BACKEND_EXTENSION_POINT_NAME
);
1049 g_io_extension_point_set_required_type (ep
, G_TYPE_TLS_BACKEND
);
1051 ep
= g_io_extension_point_register (G_NETWORK_MONITOR_EXTENSION_POINT_NAME
);
1052 g_io_extension_point_set_required_type (ep
, G_TYPE_NETWORK_MONITOR
);
1054 ep
= g_io_extension_point_register (G_NOTIFICATION_BACKEND_EXTENSION_POINT_NAME
);
1055 g_io_extension_point_set_required_type (ep
, G_TYPE_NOTIFICATION_BACKEND
);
1058 G_UNLOCK (registered_extensions
);
1062 get_gio_module_dir (void)
1066 module_dir
= g_strdup (g_getenv ("GIO_MODULE_DIR"));
1067 if (module_dir
== NULL
)
1072 install_dir
= g_win32_get_package_installation_directory_of_module (gio_dll
);
1074 /* On Visual Studio builds we have all the libraries and binaries in bin
1075 * so better load the gio modules from bin instead of lib
1077 module_dir
= g_build_filename (install_dir
,
1078 "bin", "gio", "modules",
1081 module_dir
= g_build_filename (install_dir
,
1082 "lib", "gio", "modules",
1085 g_free (install_dir
);
1087 module_dir
= g_strdup (GIO_MODULE_DIR
);
1095 _g_io_modules_ensure_loaded (void)
1097 static gboolean loaded_dirs
= FALSE
;
1098 const char *module_path
;
1099 GIOModuleScope
*scope
;
1101 _g_io_modules_ensure_extension_points_registered ();
1103 G_LOCK (loaded_dirs
);
1110 scope
= g_io_module_scope_new (G_IO_MODULE_SCOPE_BLOCK_DUPLICATES
);
1112 /* First load any overrides, extras */
1113 module_path
= g_getenv ("GIO_EXTRA_MODULES");
1119 paths
= g_strsplit (module_path
, G_SEARCHPATH_SEPARATOR_S
, 0);
1121 for (i
= 0; paths
[i
] != NULL
; i
++)
1123 g_io_modules_scan_all_in_directory_with_scope (paths
[i
], scope
);
1129 /* Then load the compiled in path */
1130 module_dir
= get_gio_module_dir ();
1132 g_io_modules_scan_all_in_directory_with_scope (module_dir
, scope
);
1133 g_free (module_dir
);
1135 g_io_module_scope_free (scope
);
1137 /* Initialize types from built-in "modules" */
1138 g_type_ensure (g_null_settings_backend_get_type ());
1139 g_type_ensure (g_memory_settings_backend_get_type ());
1140 #if defined(HAVE_INOTIFY_INIT1)
1141 g_type_ensure (g_inotify_file_monitor_get_type ());
1143 #if defined(HAVE_KQUEUE)
1144 g_type_ensure (g_kqueue_file_monitor_get_type ());
1146 #if defined(HAVE_FEN)
1147 g_type_ensure (g_fen_file_monitor_get_type ());
1150 g_type_ensure (_g_win32_volume_monitor_get_type ());
1151 g_type_ensure (g_win32_file_monitor_get_type ());
1152 g_type_ensure (g_registry_backend_get_type ());
1155 g_type_ensure (g_nextstep_settings_backend_get_type ());
1156 g_type_ensure (g_osx_app_info_get_type ());
1159 g_type_ensure (_g_unix_volume_monitor_get_type ());
1160 g_type_ensure (g_fdo_notification_backend_get_type ());
1161 g_type_ensure (g_gtk_notification_backend_get_type ());
1162 g_type_ensure (g_portal_notification_backend_get_type ());
1163 g_type_ensure (g_network_monitor_portal_get_type ());
1164 g_type_ensure (g_proxy_resolver_portal_get_type ());
1166 #if HAVE_MAC_OS_X_VERSION_MIN_REQUIRED >= 1090
1167 g_type_ensure (g_cocoa_notification_backend_get_type ());
1170 g_type_ensure (g_win32_notification_backend_get_type ());
1171 g_type_ensure (_g_winhttp_vfs_get_type ());
1173 g_type_ensure (_g_local_vfs_get_type ());
1174 g_type_ensure (_g_dummy_proxy_resolver_get_type ());
1175 g_type_ensure (_g_http_proxy_get_type ());
1176 g_type_ensure (_g_https_proxy_get_type ());
1177 g_type_ensure (_g_socks4a_proxy_get_type ());
1178 g_type_ensure (_g_socks4_proxy_get_type ());
1179 g_type_ensure (_g_socks5_proxy_get_type ());
1180 g_type_ensure (_g_dummy_tls_backend_get_type ());
1181 g_type_ensure (g_network_monitor_base_get_type ());
1183 g_type_ensure (_g_network_monitor_netlink_get_type ());
1184 g_type_ensure (_g_network_monitor_nm_get_type ());
1187 g_type_ensure (_g_win32_network_monitor_get_type ());
1191 G_UNLOCK (loaded_dirs
);
1195 g_io_extension_point_free (GIOExtensionPoint
*ep
)
1202 * g_io_extension_point_register:
1203 * @name: The name of the extension point
1205 * Registers an extension point.
1207 * Returns: (transfer none): the new #GIOExtensionPoint. This object is
1208 * owned by GIO and should not be freed.
1211 g_io_extension_point_register (const char *name
)
1213 GIOExtensionPoint
*ep
;
1215 G_LOCK (extension_points
);
1216 if (extension_points
== NULL
)
1217 extension_points
= g_hash_table_new_full (g_str_hash
,
1220 (GDestroyNotify
)g_io_extension_point_free
);
1222 ep
= g_hash_table_lookup (extension_points
, name
);
1225 G_UNLOCK (extension_points
);
1229 ep
= g_new0 (GIOExtensionPoint
, 1);
1230 ep
->name
= g_strdup (name
);
1232 g_hash_table_insert (extension_points
, ep
->name
, ep
);
1234 G_UNLOCK (extension_points
);
1240 * g_io_extension_point_lookup:
1241 * @name: the name of the extension point
1243 * Looks up an existing extension point.
1245 * Returns: (transfer none): the #GIOExtensionPoint, or %NULL if there
1246 * is no registered extension point with the given name.
1249 g_io_extension_point_lookup (const char *name
)
1251 GIOExtensionPoint
*ep
;
1253 G_LOCK (extension_points
);
1255 if (extension_points
!= NULL
)
1256 ep
= g_hash_table_lookup (extension_points
, name
);
1258 G_UNLOCK (extension_points
);
1265 * g_io_extension_point_set_required_type:
1266 * @extension_point: a #GIOExtensionPoint
1267 * @type: the #GType to require
1269 * Sets the required type for @extension_point to @type.
1270 * All implementations must henceforth have this type.
1273 g_io_extension_point_set_required_type (GIOExtensionPoint
*extension_point
,
1276 extension_point
->required_type
= type
;
1280 * g_io_extension_point_get_required_type:
1281 * @extension_point: a #GIOExtensionPoint
1283 * Gets the required type for @extension_point.
1285 * Returns: the #GType that all implementations must have,
1286 * or #G_TYPE_INVALID if the extension point has no required type
1289 g_io_extension_point_get_required_type (GIOExtensionPoint
*extension_point
)
1291 return extension_point
->required_type
;
1295 lazy_load_modules (GIOExtensionPoint
*extension_point
)
1300 for (l
= extension_point
->lazy_load_modules
; l
!= NULL
; l
= l
->next
)
1304 if (!module
->initialized
)
1306 if (g_type_module_use (G_TYPE_MODULE (module
)))
1307 g_type_module_unuse (G_TYPE_MODULE (module
)); /* Unload */
1309 g_printerr ("Failed to load module: %s\n",
1316 * g_io_extension_point_get_extensions:
1317 * @extension_point: a #GIOExtensionPoint
1319 * Gets a list of all extensions that implement this extension point.
1320 * The list is sorted by priority, beginning with the highest priority.
1322 * Returns: (element-type GIOExtension) (transfer none): a #GList of
1323 * #GIOExtensions. The list is owned by GIO and should not be
1327 g_io_extension_point_get_extensions (GIOExtensionPoint
*extension_point
)
1329 g_return_val_if_fail (extension_point
!= NULL
, NULL
);
1331 lazy_load_modules (extension_point
);
1332 return extension_point
->extensions
;
1336 * g_io_extension_point_get_extension_by_name:
1337 * @extension_point: a #GIOExtensionPoint
1338 * @name: the name of the extension to get
1340 * Finds a #GIOExtension for an extension point by name.
1342 * Returns: (transfer none): the #GIOExtension for @extension_point that has the
1343 * given name, or %NULL if there is no extension with that name
1346 g_io_extension_point_get_extension_by_name (GIOExtensionPoint
*extension_point
,
1351 g_return_val_if_fail (name
!= NULL
, NULL
);
1353 lazy_load_modules (extension_point
);
1354 for (l
= extension_point
->extensions
; l
!= NULL
; l
= l
->next
)
1356 GIOExtension
*e
= l
->data
;
1358 if (e
->name
!= NULL
&&
1359 strcmp (e
->name
, name
) == 0)
1367 extension_prio_compare (gconstpointer a
,
1370 const GIOExtension
*extension_a
= a
, *extension_b
= b
;
1372 if (extension_a
->priority
> extension_b
->priority
)
1375 if (extension_b
->priority
> extension_a
->priority
)
1382 * g_io_extension_point_implement:
1383 * @extension_point_name: the name of the extension point
1384 * @type: the #GType to register as extension
1385 * @extension_name: the name for the extension
1386 * @priority: the priority for the extension
1388 * Registers @type as extension for the extension point with name
1389 * @extension_point_name.
1391 * If @type has already been registered as an extension for this
1392 * extension point, the existing #GIOExtension object is returned.
1394 * Returns: (transfer none): a #GIOExtension object for #GType
1397 g_io_extension_point_implement (const char *extension_point_name
,
1399 const char *extension_name
,
1402 GIOExtensionPoint
*extension_point
;
1403 GIOExtension
*extension
;
1406 g_return_val_if_fail (extension_point_name
!= NULL
, NULL
);
1408 extension_point
= g_io_extension_point_lookup (extension_point_name
);
1409 if (extension_point
== NULL
)
1411 g_warning ("Tried to implement non-registered extension point %s", extension_point_name
);
1415 if (extension_point
->required_type
!= 0 &&
1416 !g_type_is_a (type
, extension_point
->required_type
))
1418 g_warning ("Tried to register an extension of the type %s to extension point %s. "
1419 "Expected type is %s.",
1421 extension_point_name
,
1422 g_type_name (extension_point
->required_type
));
1426 /* It's safe to register the same type multiple times */
1427 for (l
= extension_point
->extensions
; l
!= NULL
; l
= l
->next
)
1429 extension
= l
->data
;
1430 if (extension
->type
== type
)
1434 extension
= g_slice_new0 (GIOExtension
);
1435 extension
->type
= type
;
1436 extension
->name
= g_strdup (extension_name
);
1437 extension
->priority
= priority
;
1439 extension_point
->extensions
= g_list_insert_sorted (extension_point
->extensions
,
1440 extension
, extension_prio_compare
);
1446 * g_io_extension_ref_class:
1447 * @extension: a #GIOExtension
1449 * Gets a reference to the class for the type that is
1450 * associated with @extension.
1452 * Returns: (transfer full): the #GTypeClass for the type of @extension
1455 g_io_extension_ref_class (GIOExtension
*extension
)
1457 return g_type_class_ref (extension
->type
);
1461 * g_io_extension_get_type:
1462 * @extension: a #GIOExtension
1464 * Gets the type associated with @extension.
1466 * Returns: the type of @extension
1469 g_io_extension_get_type (GIOExtension
*extension
)
1471 return extension
->type
;
1475 * g_io_extension_get_name:
1476 * @extension: a #GIOExtension
1478 * Gets the name under which @extension was registered.
1480 * Note that the same type may be registered as extension
1481 * for multiple extension points, under different names.
1483 * Returns: the name of @extension.
1486 g_io_extension_get_name (GIOExtension
*extension
)
1488 return extension
->name
;
1492 * g_io_extension_get_priority:
1493 * @extension: a #GIOExtension
1495 * Gets the priority with which @extension was registered.
1497 * Returns: the priority of @extension
1500 g_io_extension_get_priority (GIOExtension
*extension
)
1502 return extension
->priority
;