1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free
16 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
21 * file for a list of people on the GTK+ Team. See the ChangeLog
22 * files for a list of changes. These files are distributed with
23 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
33 #include <glib/gstdio.h>
35 #include "gtkimmodule.h"
36 #include "gtkimcontextsimple.h"
37 #include "gtksettings.h"
38 #include "gtkprivate.h"
41 #define SIMPLE_ID "gtk-im-context-simple"
45 * @context_id: The unique identification string of the input method.
46 * @context_name: The human-readable name of the input method.
47 * @domain: Translation domain to be used with dgettext()
48 * @domain_dirname: Name of locale directory for use with bindtextdomain()
49 * @default_locales: A colon-separated list of locales where this input method
50 * should be the default. The asterisk "*" sets the default for all locales.
52 * Bookkeeping information about a loadable input method.
55 typedef struct _GtkIMModule GtkIMModule;
56 typedef struct _GtkIMModuleClass GtkIMModuleClass;
58 #define GTK_TYPE_IM_MODULE (gtk_im_module_get_type ())
59 #define GTK_IM_MODULE(im_module) (G_TYPE_CHECK_INSTANCE_CAST ((im_module), GTK_TYPE_IM_MODULE, GtkIMModule))
60 #define GTK_IS_IM_MODULE(im_module) (G_TYPE_CHECK_INSTANCE_TYPE ((im_module), GTK_TYPE_IM_MODULE))
64 GTypeModule parent_instance;
70 void (*list) (const GtkIMContextInfo ***contexts,
72 void (*init) (GTypeModule *module);
74 GtkIMContext *(*create) (const gchar *context_id);
76 GtkIMContextInfo **contexts;
82 struct _GtkIMModuleClass
84 GTypeModuleClass parent_class;
87 static GType gtk_im_module_get_type (void);
89 static gint n_loaded_contexts = 0;
90 static GHashTable *contexts_hash = NULL;
91 static GSList *modules_list = NULL;
93 static GObjectClass *parent_class = NULL;
96 gtk_im_module_load (GTypeModule *module)
98 GtkIMModule *im_module = GTK_IM_MODULE (module);
100 if (!im_module->builtin)
102 im_module->library = g_module_open (im_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
103 if (!im_module->library)
105 g_warning ("%s", g_module_error());
109 /* extract symbols from the lib */
110 if (!g_module_symbol (im_module->library, "im_module_init",
111 (gpointer *)&im_module->init) ||
112 !g_module_symbol (im_module->library, "im_module_exit",
113 (gpointer *)&im_module->exit) ||
114 !g_module_symbol (im_module->library, "im_module_list",
115 (gpointer *)&im_module->list) ||
116 !g_module_symbol (im_module->library, "im_module_create",
117 (gpointer *)&im_module->create))
119 g_warning ("%s", g_module_error());
120 g_module_close (im_module->library);
126 /* call the module's init function to let it */
127 /* setup anything it needs to set up. */
128 im_module->init (module);
134 gtk_im_module_unload (GTypeModule *module)
136 GtkIMModule *im_module = GTK_IM_MODULE (module);
140 if (!im_module->builtin)
142 g_module_close (im_module->library);
143 im_module->library = NULL;
145 im_module->init = NULL;
146 im_module->exit = NULL;
147 im_module->list = NULL;
148 im_module->create = NULL;
152 /* This only will ever be called if an error occurs during
156 gtk_im_module_finalize (GObject *object)
158 GtkIMModule *module = GTK_IM_MODULE (object);
160 g_free (module->path);
162 parent_class->finalize (object);
165 G_DEFINE_TYPE (GtkIMModule, gtk_im_module, G_TYPE_TYPE_MODULE)
168 gtk_im_module_class_init (GtkIMModuleClass *class)
170 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
171 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
173 parent_class = G_OBJECT_CLASS (g_type_class_peek_parent (class));
175 module_class->load = gtk_im_module_load;
176 module_class->unload = gtk_im_module_unload;
178 gobject_class->finalize = gtk_im_module_finalize;
182 gtk_im_module_init (GtkIMModule* object)
187 free_info (GtkIMContextInfo *info)
189 g_free ((char *)info->context_id);
190 g_free ((char *)info->context_name);
191 g_free ((char *)info->domain);
192 g_free ((char *)info->domain_dirname);
193 g_free ((char *)info->default_locales);
198 add_module (GtkIMModule *module, GSList *infos)
200 GSList *tmp_list = infos;
202 gint n = g_slist_length (infos);
203 module->contexts = g_new (GtkIMContextInfo *, n);
207 GtkIMContextInfo *info = tmp_list->data;
209 if (g_hash_table_lookup (contexts_hash, info->context_id))
211 free_info (info); /* Duplicate */
215 g_hash_table_insert (contexts_hash, (char *)info->context_id, module);
216 module->contexts[i++] = tmp_list->data;
220 tmp_list = tmp_list->next;
222 g_slist_free (infos);
223 module->n_contexts = i;
225 modules_list = g_slist_prepend (modules_list, module);
231 correct_libdir_prefix (gchar **path)
233 /* GTK_LIBDIR is the build-time libdir */
234 if (strncmp (*path, GTK_LIBDIR, strlen (GTK_LIBDIR)) == 0)
236 /* This is an entry put there by make install on the
237 * packager's system. On Windows a prebuilt GTK+
238 * package can be installed in a random
239 * location. The gtk.immodules file distributed in
240 * such a package contains paths from the package
241 * builder's machine. Replace the path with the real
242 * one on this machine.
245 *path = g_strconcat (_gtk_get_libdir (), tem + strlen (GTK_LIBDIR), NULL);
251 correct_localedir_prefix (gchar **path)
254 if (strncmp (*path, GTK_LOCALEDIR, strlen (GTK_LOCALEDIR)) == 0)
257 *path = g_strconcat (_gtk_get_localedir (), tem + strlen (GTK_LOCALEDIR), NULL);
264 G_GNUC_UNUSED static GtkIMModule *
265 add_builtin_module (const gchar *module_name,
266 const GtkIMContextInfo **contexts,
269 GtkIMModule *module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
270 GSList *infos = NULL;
273 for (i = 0; i < n_contexts; i++)
275 GtkIMContextInfo *info = g_new (GtkIMContextInfo, 1);
276 info->context_id = g_strdup (contexts[i]->context_id);
277 info->context_name = g_strdup (contexts[i]->context_name);
278 info->domain = g_strdup (contexts[i]->domain);
279 info->domain_dirname = g_strdup (contexts[i]->domain_dirname);
281 correct_localedir_prefix ((char **) &info->domain_dirname);
283 info->default_locales = g_strdup (contexts[i]->default_locales);
284 infos = g_slist_prepend (infos, info);
287 module->builtin = TRUE;
288 g_type_module_set_name (G_TYPE_MODULE (module), module_name);
289 add_module (module, infos);
295 gtk_im_module_initialize (void)
297 GString *line_buf = g_string_new (NULL);
298 GString *tmp_buf = g_string_new (NULL);
299 gchar *filename = gtk_rc_get_im_module_file();
301 gboolean have_error = FALSE;
303 GtkIMModule *module = NULL;
304 GSList *infos = NULL;
306 contexts_hash = g_hash_table_new (g_str_hash, g_str_equal);
308 #define do_builtin(m) \
310 const GtkIMContextInfo **contexts; \
312 extern void _gtk_immodule_ ## m ## _list (const GtkIMContextInfo ***contexts, \
313 guint *n_contexts); \
314 extern void _gtk_immodule_ ## m ## _init (GTypeModule *module); \
315 extern void _gtk_immodule_ ## m ## _exit (void); \
316 extern GtkIMContext *_gtk_immodule_ ## m ## _create (const gchar *context_id); \
318 _gtk_immodule_ ## m ## _list (&contexts, &n_contexts); \
319 module = add_builtin_module (#m, contexts, n_contexts); \
320 module->init = _gtk_immodule_ ## m ## _init; \
321 module->exit = _gtk_immodule_ ## m ## _exit; \
322 module->create = _gtk_immodule_ ## m ## _create; \
326 #ifdef INCLUDE_IM_am_et
329 #ifdef INCLUDE_IM_cedilla
330 do_builtin (cedilla);
332 #ifdef INCLUDE_IM_cyrillic_translit
333 do_builtin (cyrillic_translit);
335 #ifdef INCLUDE_IM_ime
338 #ifdef INCLUDE_IM_inuktitut
339 do_builtin (inuktitut);
341 #ifdef INCLUDE_IM_ipa
344 #ifdef INCLUDE_IM_multipress
345 do_builtin (multipress);
347 #ifdef INCLUDE_IM_thai
350 #ifdef INCLUDE_IM_ti_er
353 #ifdef INCLUDE_IM_ti_et
356 #ifdef INCLUDE_IM_viqr
359 #ifdef INCLUDE_IM_xim
365 file = g_fopen (filename, "r");
368 /* In case someone wants only the default input method,
369 * we allow no file at all.
371 g_string_free (line_buf, TRUE);
372 g_string_free (tmp_buf, TRUE);
377 while (!have_error && pango_read_line (file, line_buf))
383 if (!pango_skip_space (&p))
385 /* Blank line marking the end of a module
387 if (module && *p != '#')
389 add_module (module, infos);
399 /* Read a module location
401 module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
403 if (!pango_scan_string (&p, tmp_buf) ||
404 pango_skip_space (&p))
406 g_warning ("Error parsing context info in '%s'\n %s",
407 filename, line_buf->str);
411 module->path = g_strdup (tmp_buf->str);
413 correct_libdir_prefix (&module->path);
415 g_type_module_set_name (G_TYPE_MODULE (module), module->path);
419 GtkIMContextInfo *info = g_new0 (GtkIMContextInfo, 1);
421 /* Read information about a context type
423 if (!pango_scan_string (&p, tmp_buf))
425 info->context_id = g_strdup (tmp_buf->str);
427 if (!pango_scan_string (&p, tmp_buf))
429 info->context_name = g_strdup (tmp_buf->str);
431 if (!pango_scan_string (&p, tmp_buf))
433 info->domain = g_strdup (tmp_buf->str);
435 if (!pango_scan_string (&p, tmp_buf))
437 info->domain_dirname = g_strdup (tmp_buf->str);
439 correct_localedir_prefix ((char **) &info->domain_dirname);
442 if (!pango_scan_string (&p, tmp_buf))
444 info->default_locales = g_strdup (tmp_buf->str);
446 if (pango_skip_space (&p))
449 infos = g_slist_prepend (infos, info);
453 g_warning ("Error parsing context info in '%s'\n %s",
454 filename, line_buf->str);
461 GSList *tmp_list = infos;
464 free_info (tmp_list->data);
465 tmp_list = tmp_list->next;
467 g_slist_free (infos);
469 g_object_unref (module);
472 add_module (module, infos);
475 g_string_free (line_buf, TRUE);
476 g_string_free (tmp_buf, TRUE);
481 compare_gtkimcontextinfo_name(const GtkIMContextInfo **a,
482 const GtkIMContextInfo **b)
484 return g_utf8_collate ((*a)->context_name, (*b)->context_name);
488 * _gtk_im_module_list:
489 * @contexts: location to store an array of pointers to #GtkIMContextInfo
490 * this array should be freed with g_free() when you are finished.
491 * The structures it points are statically allocated and should
492 * not be modified or freed.
493 * @n_contexts: the length of the array stored in @contexts
495 * List all available types of input method context
498 _gtk_im_module_list (const GtkIMContextInfo ***contexts,
507 GtkIMContextInfo simple_context_info = {
520 static gboolean beenhere = FALSE;
524 gtk_im_module_initialize ();
530 /* correct_localedir_prefix() requires its parameter to be a
533 simple_context_info.domain_dirname = g_strdup (simple_context_info.domain_dirname);
534 correct_localedir_prefix ((char **) &simple_context_info.domain_dirname);
539 *n_contexts = (n_loaded_contexts + 1);
546 *contexts = g_new (const GtkIMContextInfo *, n_loaded_contexts + 1);
548 (*contexts)[n++] = &simple_context_info;
550 tmp_list = modules_list;
553 GtkIMModule *module = tmp_list->data;
555 for (i=0; i<module->n_contexts; i++)
556 (*contexts)[n++] = module->contexts[i];
558 tmp_list = tmp_list->next;
561 /* fisrt element (Default) should always be at top */
562 qsort ((*contexts)+1, n-1, sizeof (GtkIMContextInfo *), (GCompareFunc)compare_gtkimcontextinfo_name);
567 * _gtk_im_module_create:
568 * @context_id: the context ID for the context type to create
570 * Create an IM context of a type specified by the string
573 * Return value: a newly created input context of or @context_id, or
574 * if that could not be created, a newly created GtkIMContextSimple.
577 _gtk_im_module_create (const gchar *context_id)
579 GtkIMModule *im_module;
580 GtkIMContext *context = NULL;
583 gtk_im_module_initialize ();
585 if (strcmp (context_id, SIMPLE_ID) != 0)
587 im_module = g_hash_table_lookup (contexts_hash, context_id);
590 g_warning ("Attempt to load unknown IM context type '%s'", context_id);
594 if (g_type_module_use (G_TYPE_MODULE (im_module)))
596 context = im_module->create (context_id);
597 g_type_module_unuse (G_TYPE_MODULE (im_module));
601 g_warning ("Loading IM context type '%s' failed", context_id);
606 return gtk_im_context_simple_new ();
611 /* Match @locale against @against.
613 * 'en_US' against 'en_US' => 4
614 * 'en_US' against 'en' => 3
615 * 'en', 'en_UK' against 'en_US' => 2
616 * all locales, against '*' => 1
619 match_locale (const gchar *locale,
620 const gchar *against,
623 if (strcmp (against, "*") == 0)
626 if (g_ascii_strcasecmp (locale, against) == 0)
629 if (g_ascii_strncasecmp (locale, against, 2) == 0)
630 return (against_len == 2) ? 3 : 2;
636 * _gtk_im_module_get_default_context_id:
637 * @client_window: a window
639 * Return the context_id of the best IM context type
640 * for the given window.
642 * Return value: the context ID (will never be %NULL)
645 _gtk_im_module_get_default_context_id (GdkWindow *client_window)
648 const gchar *context_id = NULL;
649 gint best_goodness = 0;
651 gchar *tmp_locale, *tmp;
654 GtkSettings *settings;
657 gtk_im_module_initialize ();
659 envvar = g_getenv ("GTK_IM_MODULE");
661 (strcmp (envvar, SIMPLE_ID) == 0 ||
662 g_hash_table_lookup (contexts_hash, envvar)))
665 /* Check if the certain immodule is set in XSETTINGS.
667 if (GDK_IS_WINDOW (client_window))
669 screen = gdk_window_get_screen (client_window);
670 settings = gtk_settings_get_for_screen (screen);
671 g_object_get (G_OBJECT (settings), "gtk-im-module", &tmp, NULL);
674 if (strcmp (tmp, SIMPLE_ID) == 0)
675 context_id = SIMPLE_ID;
679 module = g_hash_table_lookup (contexts_hash, tmp);
681 context_id = module->contexts[0]->context_id;
690 /* Strip the locale code down to the essentials
692 tmp_locale = _gtk_get_lc_ctype ();
693 tmp = strchr (tmp_locale, '.');
696 tmp = strchr (tmp_locale, '@');
700 tmp_list = modules_list;
703 GtkIMModule *module = tmp_list->data;
705 for (i = 0; i < module->n_contexts; i++)
707 const gchar *p = module->contexts[i]->default_locales;
710 const gchar *q = strchr (p, ':');
711 gint goodness = match_locale (tmp_locale, p, q ? q - p : strlen (p));
713 if (goodness > best_goodness)
715 context_id = module->contexts[i]->context_id;
716 best_goodness = goodness;
719 p = q ? q + 1 : NULL;
723 tmp_list = tmp_list->next;
728 return context_id ? context_id : SIMPLE_ID;