1 /* GTK - The GIMP Toolkit
2 * Copyright 1998-2002 Tim Janik, Red Hat, Inc., and others.
3 * Copyright (C) 2003 Alex Graveley
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 Public
16 * 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.
25 #include "gtkmodules.h"
26 #include "gtksettings.h"
28 #include "gtkprivate.h" /* GTK_LIBDIR */
33 typedef struct _GtkModuleInfo GtkModuleInfo;
38 GtkModuleInitFunc init_func;
39 GtkModuleDisplayInitFunc display_init_func;
43 static GSList *gtk_modules = NULL;
45 static gboolean default_display_opened = FALSE;
47 /* Saved argc, argv for delayed module initialization
49 static gint gtk_argc = 0;
50 static gchar **gtk_argv = NULL;
53 get_module_path (void)
55 const gchar *module_path_env;
56 const gchar *exe_prefix;
57 const gchar *home_dir;
58 gchar *home_gtk_dir = NULL;
61 static gchar **result = NULL;
66 home_dir = g_get_home_dir();
68 home_gtk_dir = g_build_filename (home_dir, ".gtk-3.0", NULL);
70 module_path_env = g_getenv ("GTK_PATH");
71 exe_prefix = g_getenv ("GTK_EXE_PREFIX");
74 default_dir = g_build_filename (exe_prefix, "lib", "gtk-3.0", NULL);
76 default_dir = g_build_filename (GTK_LIBDIR, "gtk-3.0", NULL);
78 if (module_path_env && home_gtk_dir)
79 module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
80 module_path_env, home_gtk_dir, default_dir, NULL);
81 else if (module_path_env)
82 module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
83 module_path_env, default_dir, NULL);
84 else if (home_gtk_dir)
85 module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
86 home_gtk_dir, default_dir, NULL);
88 module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
91 g_free (home_gtk_dir);
94 result = pango_split_file_list (module_path);
101 * _gtk_get_module_path:
102 * @type: the type of the module, for instance 'modules', 'engines', immodules'
104 * Determines the search path for a particular type of module.
106 * Return value: the search path for the module type. Free with g_strfreev().
109 _gtk_get_module_path (const gchar *type)
111 gchar **paths = get_module_path();
116 for (path = paths; *path; path++)
119 result = g_new (gchar *, count * 4 + 1);
122 for (path = get_module_path (); *path; path++)
124 gint use_version, use_host;
126 for (use_version = TRUE; use_version >= FALSE; use_version--)
127 for (use_host = TRUE; use_host >= FALSE; use_host--)
131 if (use_version && use_host)
132 tmp_dir = g_build_filename (*path, GTK_BINARY_VERSION, GTK_HOST, type, NULL);
133 else if (use_version)
134 tmp_dir = g_build_filename (*path, GTK_BINARY_VERSION, type, NULL);
136 tmp_dir = g_build_filename (*path, GTK_HOST, type, NULL);
138 tmp_dir = g_build_filename (*path, type, NULL);
140 result[count++] = tmp_dir;
144 result[count++] = NULL;
149 /* Like g_module_path, but use .la as the suffix
152 module_build_la_path (const gchar *directory,
153 const gchar *module_name)
158 if (strncmp (module_name, "lib", 3) == 0)
159 filename = (gchar *)module_name;
161 filename = g_strconcat ("lib", module_name, ".la", NULL);
163 if (directory && *directory)
164 result = g_build_filename (directory, filename, NULL);
166 result = g_strdup (filename);
168 if (filename != module_name)
176 * @name: the name of the module
177 * @type: the type of the module, for instance 'modules', 'engines', immodules'
179 * Looks for a dynamically module named @name of type @type in the standard GTK+
180 * module search path.
182 * Return value: the pathname to the found module, or %NULL if it wasn't found.
183 * Free with g_free().
186 _gtk_find_module (const gchar *name,
191 gchar *module_name = NULL;
193 if (g_path_is_absolute (name))
194 return g_strdup (name);
196 paths = _gtk_get_module_path (type);
197 for (path = paths; *path; path++)
201 tmp_name = g_module_build_path (*path, name);
202 if (g_file_test (tmp_name, G_FILE_TEST_EXISTS))
204 module_name = tmp_name;
209 tmp_name = module_build_la_path (*path, name);
210 if (g_file_test (tmp_name, G_FILE_TEST_EXISTS))
212 module_name = tmp_name;
224 find_module (const gchar *name)
229 module_name = _gtk_find_module (name, "modules");
232 /* As last resort, try loading without an absolute path (using system
235 module_name = g_module_build_path (NULL, name);
238 module = g_module_open (module_name, G_MODULE_BIND_LOCAL | G_MODULE_BIND_LAZY);
245 cmp_module (GtkModuleInfo *info,
248 return info->module != module;
252 load_module (GSList *module_list,
255 GtkModuleInitFunc modinit_func;
256 gpointer modinit_func_ptr;
257 GtkModuleInfo *info = NULL;
258 GModule *module = NULL;
260 gboolean success = FALSE;
262 if (g_module_supported ())
264 for (l = gtk_modules; l; l = l->next)
267 if (g_slist_find_custom (info->names, name,
268 (GCompareFunc)strcmp))
278 module = find_module (name);
282 if (g_module_symbol (module, "gtk_module_init", &modinit_func_ptr))
283 modinit_func = modinit_func_ptr;
288 g_module_close (module);
296 temp = g_slist_find_custom (gtk_modules, module,
297 (GCompareFunc)cmp_module);
303 info = g_new0 (GtkModuleInfo, 1);
305 info->names = g_slist_prepend (info->names, g_strdup (name));
306 info->module = module;
308 info->init_func = modinit_func;
309 g_module_symbol (module, "gtk_module_display_init",
310 (gpointer *) &info->display_init_func);
312 gtk_modules = g_slist_append (gtk_modules, info);
314 /* display_init == NULL indicates a non-multihead aware module.
315 * For these, we delay the call to init_func until first display is
316 * opened, see default_display_notify_cb().
317 * For multihead aware modules, we call init_func immediately,
318 * and also call display_init_func on all opened displays.
320 if (default_display_opened || info->display_init_func)
321 (* info->init_func) (>k_argc, >k_argv);
323 if (info->display_init_func)
325 GSList *displays, *iter;
326 displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
327 for (iter = displays; iter; iter = iter->next)
329 GdkDisplay *display = iter->data;
330 (* info->display_init_func) (display);
332 g_slist_free (displays);
337 GTK_NOTE (MODULES, g_print ("Module already loaded, ignoring: %s\n", name));
338 info->names = g_slist_prepend (info->names, g_strdup (name));
340 /* remove new reference count on module, we already have one */
341 g_module_close (module);
350 if (!g_slist_find (module_list, info))
352 module_list = g_slist_prepend (module_list, info);
356 g_message ("Failed to load module \"%s\": %s", name, g_module_error ());
363 gtk_module_info_unref (GtkModuleInfo *info)
369 if (info->ref_count == 0)
372 g_print ("Unloading module: %s\n", g_module_name (info->module)));
374 gtk_modules = g_slist_remove (gtk_modules, info);
375 g_module_close (info->module);
376 for (l = info->names; l; l = l->next)
378 g_slist_free (info->names);
384 load_modules (const char *module_str)
386 gchar **module_names;
387 GSList *module_list = NULL;
390 GTK_NOTE (MODULES, g_print ("Loading module list: %s\n", module_str));
392 module_names = pango_split_file_list (module_str);
393 for (i = 0; module_names[i]; i++)
394 module_list = load_module (module_list, module_names[i]);
396 module_list = g_slist_reverse (module_list);
397 g_strfreev (module_names);
403 default_display_notify_cb (GdkDisplayManager *display_manager)
407 /* Initialize non-multihead-aware modules when the
408 * default display is first set to a non-NULL value.
411 if (!gdk_display_get_default () || default_display_opened)
414 default_display_opened = TRUE;
416 for (slist = gtk_modules; slist; slist = slist->next)
420 GtkModuleInfo *info = slist->data;
422 if (!info->display_init_func)
423 (* info->init_func) (>k_argc, >k_argv);
429 display_closed_cb (GdkDisplay *display,
433 GtkSettings *settings;
436 for (i = 0; i < gdk_display_get_n_screens (display); i++)
438 screen = gdk_display_get_screen (display, i);
440 settings = gtk_settings_get_for_screen (screen);
442 g_object_set_data_full (G_OBJECT (settings),
450 display_opened_cb (GdkDisplayManager *display_manager,
455 GtkSettings *settings;
458 for (slist = gtk_modules; slist; slist = slist->next)
462 GtkModuleInfo *info = slist->data;
464 if (info->display_init_func)
465 (* info->display_init_func) (display);
469 for (i = 0; i < gdk_display_get_n_screens (display); i++)
471 GValue value = { 0, };
473 g_value_init (&value, G_TYPE_STRING);
475 screen = gdk_display_get_screen (display, i);
477 if (gdk_screen_get_setting (screen, "gtk-modules", &value))
479 settings = gtk_settings_get_for_screen (screen);
480 _gtk_modules_settings_changed (settings, g_value_get_string (&value));
481 g_value_unset (&value);
485 /* Since closing display doesn't actually release the resources yet,
486 * we have to connect to the ::closed signal.
488 g_signal_connect (display, "closed", G_CALLBACK (display_closed_cb), NULL);
492 _gtk_modules_init (gint *argc,
494 const gchar *gtk_modules_args)
496 GdkDisplayManager *display_manager;
499 g_assert (gtk_argv == NULL);
503 /* store argc and argv for later use in mod initialization */
505 gtk_argv = g_new (gchar *, *argc + 1);
506 for (i = 0; i < gtk_argc; i++)
507 gtk_argv [i] = g_strdup ((*argv) [i]);
508 gtk_argv [*argc] = NULL;
511 display_manager = gdk_display_manager_get ();
512 default_display_opened = gdk_display_get_default () != NULL;
513 g_signal_connect (display_manager, "notify::default-display",
514 G_CALLBACK (default_display_notify_cb),
516 g_signal_connect (display_manager, "display-opened",
517 G_CALLBACK (display_opened_cb),
520 if (gtk_modules_args) {
521 /* Modules specified in the GTK_MODULES environment variable
522 * or on the command line are always loaded, so we'll just leak
525 g_slist_free (load_modules (gtk_modules_args));
530 settings_destroy_notify (gpointer data)
532 GSList *iter, *modules = data;
534 for (iter = modules; iter; iter = iter->next)
536 GtkModuleInfo *info = iter->data;
537 gtk_module_info_unref (info);
539 g_slist_free (modules);
543 _gtk_modules_settings_changed (GtkSettings *settings,
544 const gchar *modules)
546 GSList *new_modules = NULL;
548 GTK_NOTE (MODULES, g_print ("gtk-modules setting changed to: %s\n", modules));
550 /* load/ref before unreffing existing */
551 if (modules && modules[0])
552 new_modules = load_modules (modules);
554 g_object_set_data_full (G_OBJECT (settings),
557 settings_destroy_notify);