Pileus Git - ~andy/gtk/blob - gtk/gtkmodules.c

   1 /* GTK - The GIMP Toolkit
   2  * Copyright 1998-2002 Tim Janik, Red Hat, Inc., and others.
   3  * Copyright (C) 2003 Alex Graveley
   4  *
   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.
   9  *
  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.
  14  *
  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.
  19  */
  20
  21 #include "config.h"
  22
  23 #include <string.h>
  24
  25 #include "gtkmodules.h"
  26 #include "gtksettings.h"
  27 #include "gtkdebug.h"
  28 #include "gtkprivate.h" /* GTK_LIBDIR */
  29 #include "gtkmainprivate.h"
  30 #include "gtkintl.h"
  31
  32 #include <gmodule.h>
  33
  34 typedef struct _GtkModuleInfo GtkModuleInfo;
  35 struct _GtkModuleInfo
  36 {
  37   GModule                 *module;
  38   gint                     ref_count;
  39   GtkModuleInitFunc        init_func;
  40   GtkModuleDisplayInitFunc display_init_func;
  41   GSList                  *names;
  42 };
  43
  44 static GSList *gtk_modules = NULL;
  45
  46 static gboolean default_display_opened = FALSE;
  47
  48 /* Saved argc, argv for delayed module initialization
  49  */
  50 static gint    gtk_argc = 0;
  51 static gchar **gtk_argv = NULL;
  52
  53 static gchar **
  54 get_module_path (void)
  55 {
  56   const gchar *module_path_env;
  57   const gchar *exe_prefix;
  58   const gchar *home_dir;
  59   gchar *home_gtk_dir = NULL;
  60   gchar *module_path;
  61   gchar *default_dir;
  62   static gchar **result = NULL;
  63
  64   if (result)
  65     return result;
  66
  67   home_dir = g_get_home_dir();
  68   if (home_dir)
  69     home_gtk_dir = g_build_filename (home_dir, ".gtk-3.0", NULL);
  70
  71   module_path_env = g_getenv ("GTK_PATH");
  72   exe_prefix = g_getenv ("GTK_EXE_PREFIX");
  73
  74   if (exe_prefix)
  75     default_dir = g_build_filename (exe_prefix, "lib", "gtk-3.0", NULL);
  76   else
  77     default_dir = g_build_filename (GTK_LIBDIR, "gtk-3.0", NULL);
  78
  79   if (module_path_env && home_gtk_dir)
  80     module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
  81                                 module_path_env, home_gtk_dir, default_dir, NULL);
  82   else if (module_path_env)
  83     module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
  84                                 module_path_env, default_dir, NULL);
  85   else if (home_gtk_dir)
  86     module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
  87                                 home_gtk_dir, default_dir, NULL);
  88   else
  89     module_path = g_build_path (G_SEARCHPATH_SEPARATOR_S,
  90                                 default_dir, NULL);
  91
  92   g_free (home_gtk_dir);
  93   g_free (default_dir);
  94
  95   result = pango_split_file_list (module_path);
  96   g_free (module_path);
  97
  98   return result;
  99 }
 100
 101 /**
 102  * _gtk_get_module_path:
 103  * @type: the type of the module, for instance 'modules', 'engines', immodules'
 104  *
 105  * Determines the search path for a particular type of module.
 106  *
 107  * Return value: the search path for the module type. Free with g_strfreev().
 108  **/
 109 gchar **
 110 _gtk_get_module_path (const gchar *type)
 111 {
 112   gchar **paths = get_module_path();
 113   gchar **path;
 114   gchar **result;
 115   gint count = 0;
 116
 117   for (path = paths; *path; path++)
 118     count++;
 119
 120   result = g_new (gchar *, count * 4 + 1);
 121
 122   count = 0;
 123   for (path = get_module_path (); *path; path++)
 124     {
 125       gint use_version, use_host;
 126
 127       for (use_version = TRUE; use_version >= FALSE; use_version--)
 128         for (use_host = TRUE; use_host >= FALSE; use_host--)
 129           {
 130             gchar *tmp_dir;
 131
 132             if (use_version && use_host)
 133               tmp_dir = g_build_filename (*path, GTK_BINARY_VERSION, GTK_HOST, type, NULL);
 134             else if (use_version)
 135               tmp_dir = g_build_filename (*path, GTK_BINARY_VERSION, type, NULL);
 136             else if (use_host)
 137               tmp_dir = g_build_filename (*path, GTK_HOST, type, NULL);
 138             else
 139               tmp_dir = g_build_filename (*path, type, NULL);
 140
 141             result[count++] = tmp_dir;
 142           }
 143     }
 144
 145   result[count++] = NULL;
 146
 147   return result;
 148 }
 149
 150 /* Like g_module_path, but use .la as the suffix
 151  */
 152 static gchar*
 153 module_build_la_path (const gchar *directory,
 154                       const gchar *module_name)
 155 {
 156   gchar *filename;
 157   gchar *result;
 158
 159   if (strncmp (module_name, "lib", 3) == 0)
 160     filename = (gchar *)module_name;
 161   else
 162     filename =  g_strconcat ("lib", module_name, ".la", NULL);
 163
 164   if (directory && *directory)
 165     result = g_build_filename (directory, filename, NULL);
 166   else
 167     result = g_strdup (filename);
 168
 169   if (filename != module_name)
 170     g_free (filename);
 171
 172   return result;
 173 }
 174
 175 /**
 176  * _gtk_find_module:
 177  * @name: the name of the module
 178  * @type: the type of the module, for instance 'modules', 'engines', immodules'
 179  *
 180  * Looks for a dynamically module named @name of type @type in the standard GTK+
 181  *  module search path.
 182  *
 183  * Return value: the pathname to the found module, or %NULL if it wasn't found.
 184  *  Free with g_free().
 185  **/
 186 gchar *
 187 _gtk_find_module (const gchar *name,
 188                   const gchar *type)
 189 {
 190   gchar **paths;
 191   gchar **path;
 192   gchar *module_name = NULL;
 193
 194   if (g_path_is_absolute (name))
 195     return g_strdup (name);
 196
 197   paths = _gtk_get_module_path (type);
 198   for (path = paths; *path; path++)
 199     {
 200       gchar *tmp_name;
 201
 202       tmp_name = g_module_build_path (*path, name);
 203       if (g_file_test (tmp_name, G_FILE_TEST_EXISTS))
 204         {
 205           module_name = tmp_name;
 206           goto found;
 207         }
 208       g_free(tmp_name);
 209
 210       tmp_name = module_build_la_path (*path, name);
 211       if (g_file_test (tmp_name, G_FILE_TEST_EXISTS))
 212         {
 213           module_name = tmp_name;
 214           goto found;
 215         }
 216       g_free(tmp_name);
 217     }
 218
 219  found:
 220   g_strfreev (paths);
 221   return module_name;
 222 }
 223
 224 static GModule *
 225 find_module (const gchar *name)
 226 {
 227   GModule *module;
 228   gchar *module_name;
 229
 230   module_name = _gtk_find_module (name, "modules");
 231   if (!module_name)
 232     {
 233       /* As last resort, try loading without an absolute path (using system
 234        * library path)
 235        */
 236       module_name = g_module_build_path (NULL, name);
 237     }
 238
 239   module = g_module_open (module_name, G_MODULE_BIND_LOCAL | G_MODULE_BIND_LAZY);
 240
 241   if (_gtk_module_has_mixed_deps (module))
 242     {
 243       g_warning ("GTK+ module %s cannot be loaded.\n"
 244                  "GTK+ 2.x symbols detected. Using GTK+ 2.x and GTK+ 3 in the same process is not supported.", module_name);
 245       g_module_close (module);
 246       module = NULL;
 247     }
 248
 249   g_free (module_name);
 250
 251   return module;
 252 }
 253
 254 static gint
 255 cmp_module (GtkModuleInfo *info,
 256             GModule       *module)
 257 {
 258   return info->module != module;
 259 }
 260
 261 static gboolean
 262 module_is_blacklisted (const gchar *name)
 263 {
 264   if (g_str_equal (name, "gail"))
 265     {
 266       g_message ("Not loading module \"gail\": The functionality is provided by GTK natively. Please try to not load it.");
 267       return TRUE;
 268     }
 269
 270   return FALSE;
 271 }
 272
 273 static GSList *
 274 load_module (GSList      *module_list,
 275              const gchar *name)
 276 {
 277   GtkModuleInitFunc modinit_func;
 278   gpointer modinit_func_ptr;
 279   GtkModuleInfo *info = NULL;
 280   GModule *module = NULL;
 281   GSList *l;
 282   gboolean success = FALSE;
 283
 284   if (g_module_supported ())
 285     {
 286       for (l = gtk_modules; l; l = l->next)
 287         {
 288           info = l->data;
 289           if (g_slist_find_custom (info->names, name,
 290                                    (GCompareFunc)strcmp))
 291             {
 292               info->ref_count++;
 293
 294               success = TRUE;
 295             }
 296         }
 297
 298       if (!success)
 299         {
 300           module = find_module (name);
 301
 302           if (module)
 303             {
 304               /* Do the check this late so we only warn about existing modules,
 305                * not old modules that are still in the modules path. */
 306               if (module_is_blacklisted (name))
 307                 {
 308                   modinit_func = NULL;
 309                   success = TRUE;
 310                 }
 311               else if (g_module_symbol (module, "gtk_module_init", &modinit_func_ptr))
 312                 modinit_func = modinit_func_ptr;
 313               else
 314                 modinit_func = NULL;
 315
 316               if (!modinit_func)
 317                 g_module_close (module);
 318               else
 319                 {
 320                   GSList *temp;
 321
 322                   success = TRUE;
 323                   info = NULL;
 324
 325                   temp = g_slist_find_custom (gtk_modules, module,
 326                         (GCompareFunc)cmp_module);
 327                   if (temp != NULL)
 328                         info = temp->data;
 329
 330                   if (!info)
 331                     {
 332                       info = g_new0 (GtkModuleInfo, 1);
 333
 334                       info->names = g_slist_prepend (info->names, g_strdup (name));
 335                       info->module = module;
 336                       info->ref_count = 1;
 337                       info->init_func = modinit_func;
 338                       g_module_symbol (module, "gtk_module_display_init",
 339                                        (gpointer *) &info->display_init_func);
 340
 341                       gtk_modules = g_slist_append (gtk_modules, info);
 342
 343                       /* display_init == NULL indicates a non-multihead aware module.
 344                        * For these, we delay the call to init_func until first display is
 345                        * opened, see default_display_notify_cb().
 346                        * For multihead aware modules, we call init_func immediately,
 347                        * and also call display_init_func on all opened displays.
 348                        */
 349                       if (default_display_opened || info->display_init_func)
 350                         (* info->init_func) (&gtk_argc, &gtk_argv);
 351
 352                       if (info->display_init_func)
 353                         {
 354                           GSList *displays, *iter;
 355                           displays = gdk_display_manager_list_displays (gdk_display_manager_get ());
 356                           for (iter = displays; iter; iter = iter->next)
 357                             {
 358                               GdkDisplay *display = iter->data;
 359                           (* info->display_init_func) (display);
 360                             }
 361                           g_slist_free (displays);
 362                         }
 363                     }
 364                   else
 365                     {
 366                       GTK_NOTE (MODULES, g_print ("Module already loaded, ignoring: %s\n", name));
 367                       info->names = g_slist_prepend (info->names, g_strdup (name));
 368                       info->ref_count++;
 369                       /* remove new reference count on module, we already have one */
 370                       g_module_close (module);
 371                     }
 372                 }
 373             }
 374         }
 375     }
 376
 377   if (success)
 378     {
 379       if (!g_slist_find (module_list, info))
 380         {
 381           module_list = g_slist_prepend (module_list, info);
 382         }
 383     }
 384   else
 385     {
 386       const gchar *error = g_module_error ();
 387
 388       g_message ("Failed to load module \"%s\"%s%s",
 389                  name, error ? ": " : "", error ? error : "");
 390     }
 391
 392   return module_list;
 393 }
 394
 395
 396 static void
 397 gtk_module_info_unref (GtkModuleInfo *info)
 398 {
 399   GSList *l;
 400
 401   info->ref_count--;
 402
 403   if (info->ref_count == 0)
 404     {
 405       GTK_NOTE (MODULES,
 406                 g_print ("Unloading module: %s\n", g_module_name (info->module)));
 407
 408       gtk_modules = g_slist_remove (gtk_modules, info);
 409       g_module_close (info->module);
 410       for (l = info->names; l; l = l->next)
 411         g_free (l->data);
 412       g_slist_free (info->names);
 413       g_free (info);
 414     }
 415 }
 416
 417 static GSList *
 418 load_modules (const char *module_str)
 419 {
 420   gchar **module_names;
 421   GSList *module_list = NULL;
 422   gint i;
 423
 424   GTK_NOTE (MODULES, g_print ("Loading module list: %s\n", module_str));
 425
 426   module_names = pango_split_file_list (module_str);
 427   for (i = 0; module_names[i]; i++)
 428     module_list = load_module (module_list, module_names[i]);
 429
 430   module_list = g_slist_reverse (module_list);
 431   g_strfreev (module_names);
 432
 433   return module_list;
 434 }
 435
 436 static void
 437 default_display_notify_cb (GdkDisplayManager *display_manager)
 438 {
 439   GSList *slist;
 440
 441   /* Initialize non-multihead-aware modules when the
 442    * default display is first set to a non-NULL value.
 443    */
 444
 445   if (!gdk_display_get_default () || default_display_opened)
 446     return;
 447
 448   default_display_opened = TRUE;
 449
 450   for (slist = gtk_modules; slist; slist = slist->next)
 451     {
 452       if (slist->data)
 453         {
 454           GtkModuleInfo *info = slist->data;
 455
 456           if (!info->display_init_func)
 457             (* info->init_func) (&gtk_argc, &gtk_argv);
 458         }
 459     }
 460 }
 461
 462 static void
 463 display_closed_cb (GdkDisplay *display,
 464                    gboolean    is_error)
 465 {
 466   GdkScreen *screen;
 467   GtkSettings *settings;
 468   gint i;
 469
 470   for (i = 0; i < gdk_display_get_n_screens (display); i++)
 471     {
 472       screen = gdk_display_get_screen (display, i);
 473
 474       settings = gtk_settings_get_for_screen (screen);
 475
 476       g_object_set_data_full (G_OBJECT (settings),
 477                               I_("gtk-modules"),
 478                               NULL, NULL);
 479     }
 480 }
 481
 482
 483 static void
 484 display_opened_cb (GdkDisplayManager *display_manager,
 485                    GdkDisplay        *display)
 486 {
 487   GSList *slist;
 488   GdkScreen *screen;
 489   GtkSettings *settings;
 490   gint i;
 491
 492   for (slist = gtk_modules; slist; slist = slist->next)
 493     {
 494       if (slist->data)
 495         {
 496           GtkModuleInfo *info = slist->data;
 497
 498           if (info->display_init_func)
 499             (* info->display_init_func) (display);
 500         }
 501     }
 502
 503   for (i = 0; i < gdk_display_get_n_screens (display); i++)
 504     {
 505       GValue value = { 0, };
 506
 507       g_value_init (&value, G_TYPE_STRING);
 508
 509       screen = gdk_display_get_screen (display, i);
 510
 511       if (gdk_screen_get_setting (screen, "gtk-modules", &value))
 512         {
 513           settings = gtk_settings_get_for_screen (screen);
 514           _gtk_modules_settings_changed (settings, g_value_get_string (&value));
 515           g_value_unset (&value);
 516         }
 517     }
 518
 519   /* Since closing display doesn't actually release the resources yet,
 520    * we have to connect to the ::closed signal.
 521    */
 522   g_signal_connect (display, "closed", G_CALLBACK (display_closed_cb), NULL);
 523 }
 524
 525 void
 526 _gtk_modules_init (gint        *argc,
 527                    gchar     ***argv,
 528                    const gchar *gtk_modules_args)
 529 {
 530   GdkDisplayManager *display_manager;
 531   gint i;
 532
 533   g_assert (gtk_argv == NULL);
 534
 535   if (argc && argv)
 536     {
 537       /* store argc and argv for later use in mod initialization */
 538       gtk_argc = *argc;
 539       gtk_argv = g_new (gchar *, *argc + 1);
 540       for (i = 0; i < gtk_argc; i++)
 541         gtk_argv [i] = g_strdup ((*argv) [i]);
 542       gtk_argv [*argc] = NULL;
 543     }
 544
 545   display_manager = gdk_display_manager_get ();
 546   default_display_opened = gdk_display_get_default () != NULL;
 547   g_signal_connect (display_manager, "notify::default-display",
 548                     G_CALLBACK (default_display_notify_cb),
 549                     NULL);
 550   g_signal_connect (display_manager, "display-opened",
 551                     G_CALLBACK (display_opened_cb),
 552                     NULL);
 553
 554   if (gtk_modules_args) {
 555     /* Modules specified in the GTK_MODULES environment variable
 556      * or on the command line are always loaded, so we'll just leak
 557      * the refcounts.
 558      */
 559     g_slist_free (load_modules (gtk_modules_args));
 560   }
 561 }
 562
 563 static void
 564 settings_destroy_notify (gpointer data)
 565 {
 566   GSList *iter, *modules = data;
 567
 568   for (iter = modules; iter; iter = iter->next)
 569     {
 570       GtkModuleInfo *info = iter->data;
 571       gtk_module_info_unref (info);
 572     }
 573   g_slist_free (modules);
 574 }
 575
 576 void
 577 _gtk_modules_settings_changed (GtkSettings *settings,
 578                                const gchar *modules)
 579 {
 580   GSList *new_modules = NULL;
 581
 582   GTK_NOTE (MODULES, g_print ("gtk-modules setting changed to: %s\n", modules));
 583
 584   /* load/ref before unreffing existing */
 585   if (modules && modules[0])
 586     new_modules = load_modules (modules);
 587
 588   g_object_set_data_full (G_OBJECT (settings),
 589                           I_("gtk-modules"),
 590                           new_modules,
 591                           settings_destroy_notify);
 592 }