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"
43 /* Do *not* include "gtkprivate.h" in this file. If you do, the
44 * correct_libdir_prefix() and correct_localedir_prefix() functions
45 * below will have to move somewhere else.
48 #ifdef __GTK_PRIVATE_H__
49 #error gtkprivate.h should not be included in this file
52 #define SIMPLE_ID "gtk-im-context-simple"
54 typedef struct _GtkIMModule GtkIMModule;
55 typedef struct _GtkIMModuleClass GtkIMModuleClass;
57 #define GTK_TYPE_IM_MODULE (gtk_im_module_get_type ())
58 #define GTK_IM_MODULE(im_module) (G_TYPE_CHECK_INSTANCE_CAST ((im_module), GTK_TYPE_IM_MODULE, GtkIMModule))
59 #define GTK_IS_IM_MODULE(im_module) (G_TYPE_CHECK_INSTANCE_TYPE ((im_module), GTK_TYPE_IM_MODULE))
63 GTypeModule parent_instance;
69 void (*list) (const GtkIMContextInfo ***contexts,
71 void (*init) (GTypeModule *module);
73 GtkIMContext *(*create) (const gchar *context_id);
75 GtkIMContextInfo **contexts;
81 struct _GtkIMModuleClass
83 GTypeModuleClass parent_class;
86 static GType gtk_im_module_get_type (void);
88 static gint n_loaded_contexts = 0;
89 static GHashTable *contexts_hash = NULL;
90 static GSList *modules_list = NULL;
92 static GObjectClass *parent_class = NULL;
95 gtk_im_module_load (GTypeModule *module)
97 GtkIMModule *im_module = GTK_IM_MODULE (module);
99 if (!im_module->builtin)
101 im_module->library = g_module_open (im_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
102 if (!im_module->library)
104 g_warning (g_module_error());
108 /* extract symbols from the lib */
109 if (!g_module_symbol (im_module->library, "im_module_init",
110 (gpointer *)&im_module->init) ||
111 !g_module_symbol (im_module->library, "im_module_exit",
112 (gpointer *)&im_module->exit) ||
113 !g_module_symbol (im_module->library, "im_module_list",
114 (gpointer *)&im_module->list) ||
115 !g_module_symbol (im_module->library, "im_module_create",
116 (gpointer *)&im_module->create))
118 g_warning (g_module_error());
119 g_module_close (im_module->library);
125 /* call the module's init function to let it */
126 /* setup anything it needs to set up. */
127 im_module->init (module);
133 gtk_im_module_unload (GTypeModule *module)
135 GtkIMModule *im_module = GTK_IM_MODULE (module);
139 if (!im_module->builtin)
141 g_module_close (im_module->library);
142 im_module->library = NULL;
144 im_module->init = NULL;
145 im_module->exit = NULL;
146 im_module->list = NULL;
147 im_module->create = NULL;
151 /* This only will ever be called if an error occurs during
155 gtk_im_module_finalize (GObject *object)
157 GtkIMModule *module = GTK_IM_MODULE (object);
159 g_free (module->path);
161 parent_class->finalize (object);
164 G_DEFINE_TYPE (GtkIMModule, gtk_im_module, G_TYPE_TYPE_MODULE)
167 gtk_im_module_class_init (GtkIMModuleClass *class)
169 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
170 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
172 parent_class = G_OBJECT_CLASS (g_type_class_peek_parent (class));
174 module_class->load = gtk_im_module_load;
175 module_class->unload = gtk_im_module_unload;
177 gobject_class->finalize = gtk_im_module_finalize;
181 gtk_im_module_init (GtkIMModule* object)
186 free_info (GtkIMContextInfo *info)
188 g_free ((char *)info->context_id);
189 g_free ((char *)info->context_name);
190 g_free ((char *)info->domain);
191 g_free ((char *)info->domain_dirname);
192 g_free ((char *)info->default_locales);
197 add_module (GtkIMModule *module, GSList *infos)
199 GSList *tmp_list = infos;
201 gint n = g_slist_length (infos);
202 module->contexts = g_new (GtkIMContextInfo *, n);
206 GtkIMContextInfo *info = tmp_list->data;
208 if (g_hash_table_lookup (contexts_hash, info->context_id))
210 free_info (info); /* Duplicate */
214 g_hash_table_insert (contexts_hash, (char *)info->context_id, module);
215 module->contexts[i++] = tmp_list->data;
219 tmp_list = tmp_list->next;
221 g_slist_free (infos);
222 module->n_contexts = i;
224 modules_list = g_slist_prepend (modules_list, module);
230 correct_libdir_prefix (gchar **path)
232 /* GTK_LIBDIR here is supposed to still have the definition from
233 * Makefile.am, i.e. the build-time value. Do *not* include gtkprivate.h
236 if (strncmp (*path, GTK_LIBDIR, strlen (GTK_LIBDIR)) == 0)
238 /* This is an entry put there by make install on the
239 * packager's system. On Windows a prebuilt GTK+
240 * package can be installed in a random
241 * location. The gtk.immodules file distributed in
242 * such a package contains paths from the package
243 * builder's machine. Replace the path with the real
244 * one on this machine.
246 extern const gchar *_gtk_get_libdir ();
248 *path = g_strconcat (_gtk_get_libdir (), tem + strlen (GTK_LIBDIR), NULL);
254 correct_localedir_prefix (gchar **path)
256 /* As above, but for GTK_LOCALEDIR. Use separate function in case
257 * GTK_LOCALEDIR isn't a subfolder of GTK_LIBDIR.
259 if (strncmp (*path, GTK_LOCALEDIR, strlen (GTK_LOCALEDIR)) == 0)
261 extern const gchar *_gtk_get_localedir ();
263 *path = g_strconcat (_gtk_get_localedir (), tem + strlen (GTK_LOCALEDIR), NULL);
271 add_builtin_module (const gchar *module_name,
272 const GtkIMContextInfo **contexts,
275 GtkIMModule *module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
276 GSList *infos = NULL;
279 for (i = 0; i < n_contexts; i++)
281 GtkIMContextInfo *info = g_new (GtkIMContextInfo, 1);
282 info->context_id = g_strdup (contexts[i]->context_id);
283 info->context_name = g_strdup (contexts[i]->context_name);
284 info->domain = g_strdup (contexts[i]->domain);
285 info->domain_dirname = g_strdup (contexts[i]->domain_dirname);
287 correct_localedir_prefix ((char **) &info->domain_dirname);
289 info->default_locales = g_strdup (contexts[i]->default_locales);
290 infos = g_slist_prepend (infos, info);
293 module->builtin = TRUE;
294 g_type_module_set_name (G_TYPE_MODULE (module), module_name);
295 add_module (module, infos);
301 gtk_im_module_initialize (void)
303 GString *line_buf = g_string_new (NULL);
304 GString *tmp_buf = g_string_new (NULL);
305 gchar *filename = gtk_rc_get_im_module_file();
307 gboolean have_error = FALSE;
309 GtkIMModule *module = NULL;
310 GSList *infos = NULL;
312 contexts_hash = g_hash_table_new (g_str_hash, g_str_equal);
314 #define do_builtin(m) \
316 const GtkIMContextInfo **contexts; \
318 extern void _gtk_immodule_ ## m ## _list (const GtkIMContextInfo ***contexts, \
319 guint *n_contexts); \
320 extern void _gtk_immodule_ ## m ## _init (GTypeModule *module); \
321 extern void _gtk_immodule_ ## m ## _exit (void); \
322 extern GtkIMContext *_gtk_immodule_ ## m ## _create (const gchar *context_id); \
324 _gtk_immodule_ ## m ## _list (&contexts, &n_contexts); \
325 module = add_builtin_module (#m, contexts, n_contexts); \
326 module->init = _gtk_immodule_ ## m ## _init; \
327 module->exit = _gtk_immodule_ ## m ## _exit; \
328 module->create = _gtk_immodule_ ## m ## _create; \
332 #ifdef INCLUDE_IM_am_et
335 #ifdef INCLUDE_IM_cedilla
336 do_builtin (cedilla);
338 #ifdef INCLUDE_IM_cyrillic_translit
339 do_builtin (cyrillic_translit);
341 #ifdef INCLUDE_IM_ime
344 #ifdef INCLUDE_IM_inuktitut
345 do_builtin (inuktitut);
347 #ifdef INCLUDE_IM_ipa
350 #ifdef INCLUDE_IM_multipress
351 do_builtin (multipress);
353 #ifdef INCLUDE_IM_thai
356 #ifdef INCLUDE_IM_ti_er
359 #ifdef INCLUDE_IM_ti_et
362 #ifdef INCLUDE_IM_viqr
365 #ifdef INCLUDE_IM_xim
371 file = g_fopen (filename, "r");
374 /* In case someone wants only the default input method,
375 * we allow no file at all.
377 g_string_free (line_buf, TRUE);
378 g_string_free (tmp_buf, TRUE);
383 while (!have_error && pango_read_line (file, line_buf))
389 if (!pango_skip_space (&p))
391 /* Blank line marking the end of a module
393 if (module && *p != '#')
395 add_module (module, infos);
405 /* Read a module location
407 module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
409 if (!pango_scan_string (&p, tmp_buf) ||
410 pango_skip_space (&p))
412 g_warning ("Error parsing context info in '%s'\n %s",
413 filename, line_buf->str);
417 module->path = g_strdup (tmp_buf->str);
419 correct_libdir_prefix (&module->path);
421 g_type_module_set_name (G_TYPE_MODULE (module), module->path);
425 GtkIMContextInfo *info = g_new0 (GtkIMContextInfo, 1);
427 /* Read information about a context type
429 if (!pango_scan_string (&p, tmp_buf))
431 info->context_id = g_strdup (tmp_buf->str);
433 if (!pango_scan_string (&p, tmp_buf))
435 info->context_name = g_strdup (tmp_buf->str);
437 if (!pango_scan_string (&p, tmp_buf))
439 info->domain = g_strdup (tmp_buf->str);
441 if (!pango_scan_string (&p, tmp_buf))
443 info->domain_dirname = g_strdup (tmp_buf->str);
445 correct_localedir_prefix ((char **) &info->domain_dirname);
448 if (!pango_scan_string (&p, tmp_buf))
450 info->default_locales = g_strdup (tmp_buf->str);
452 if (pango_skip_space (&p))
455 infos = g_slist_prepend (infos, info);
459 g_warning ("Error parsing context info in '%s'\n %s",
460 filename, line_buf->str);
467 GSList *tmp_list = infos;
470 free_info (tmp_list->data);
471 tmp_list = tmp_list->next;
473 g_slist_free (infos);
475 g_object_unref (module);
478 add_module (module, infos);
481 g_string_free (line_buf, TRUE);
482 g_string_free (tmp_buf, TRUE);
487 compare_gtkimcontextinfo_name(const GtkIMContextInfo **a,
488 const GtkIMContextInfo **b)
490 return g_utf8_collate ((*a)->context_name, (*b)->context_name);
494 * _gtk_im_module_list:
495 * @contexts: location to store an array of pointers to #GtkIMContextInfo
496 * this array should be freed with g_free() when you are finished.
497 * The structures it points are statically allocated and should
498 * not be modified or freed.
499 * @n_contexts: the length of the array stored in @contexts
501 * List all available types of input method context
504 _gtk_im_module_list (const GtkIMContextInfo ***contexts,
513 GtkIMContextInfo simple_context_info = {
526 static gboolean beenhere = FALSE;
530 gtk_im_module_initialize ();
536 /* correct_localedir_prefix() requires its parameter to be a
539 simple_context_info.domain_dirname = g_strdup (simple_context_info.domain_dirname);
540 correct_localedir_prefix ((char **) &simple_context_info.domain_dirname);
545 *n_contexts = (n_loaded_contexts + 1);
552 *contexts = g_new (const GtkIMContextInfo *, n_loaded_contexts + 1);
554 (*contexts)[n++] = &simple_context_info;
556 tmp_list = modules_list;
559 GtkIMModule *module = tmp_list->data;
561 for (i=0; i<module->n_contexts; i++)
562 (*contexts)[n++] = module->contexts[i];
564 tmp_list = tmp_list->next;
567 /* fisrt element (Default) should always be at top */
568 qsort ((*contexts)+1, n-1, sizeof (GtkIMContextInfo *), (GCompareFunc)compare_gtkimcontextinfo_name);
573 * _gtk_im_module_create:
574 * @context_id: the context ID for the context type to create
576 * Create an IM context of a type specified by the string
579 * Return value: a newly created input context of or @context_id, or
580 * if that could not be created, a newly created GtkIMContextSimple.
583 _gtk_im_module_create (const gchar *context_id)
585 GtkIMModule *im_module;
586 GtkIMContext *context = NULL;
589 gtk_im_module_initialize ();
591 if (strcmp (context_id, SIMPLE_ID) != 0)
593 im_module = g_hash_table_lookup (contexts_hash, context_id);
596 g_warning ("Attempt to load unknown IM context type '%s'", context_id);
600 if (g_type_module_use (G_TYPE_MODULE (im_module)))
602 context = im_module->create (context_id);
603 g_type_module_unuse (G_TYPE_MODULE (im_module));
607 g_warning ("Loading IM context type '%s' failed", context_id);
612 return gtk_im_context_simple_new ();
617 /* Match @locale against @against.
619 * 'en_US' against 'en_US' => 4
620 * 'en_US' against 'en' => 3
621 * 'en', 'en_UK' against 'en_US' => 2
622 * all locales, against '*' => 1
625 match_locale (const gchar *locale,
626 const gchar *against,
629 if (strcmp (against, "*") == 0)
632 if (g_ascii_strcasecmp (locale, against) == 0)
635 if (g_ascii_strncasecmp (locale, against, 2) == 0)
636 return (against_len == 2) ? 3 : 2;
642 * _gtk_im_module_get_default_context_id:
643 * @client_window: a window
645 * Return the context_id of the best IM context type
646 * for the given window.
648 * Return value: the context ID (will never be %NULL)
651 _gtk_im_module_get_default_context_id (GdkWindow *client_window)
654 const gchar *context_id = NULL;
655 gint best_goodness = 0;
657 gchar *tmp_locale, *tmp;
660 GtkSettings *settings;
663 gtk_im_module_initialize ();
665 envvar = g_getenv ("GTK_IM_MODULE");
667 (strcmp (envvar, SIMPLE_ID) == 0 ||
668 g_hash_table_lookup (contexts_hash, envvar)))
671 /* Check if the certain immodule is set in XSETTINGS.
673 if (client_window != NULL && GDK_IS_DRAWABLE (client_window))
675 screen = gdk_drawable_get_screen (GDK_DRAWABLE (client_window));
677 settings = gtk_settings_get_for_screen (screen);
679 settings = gtk_settings_get_default ();
681 g_object_get (G_OBJECT (settings), "gtk-im-module", &tmp, NULL);
684 if (strcmp (tmp, SIMPLE_ID) == 0)
685 context_id = SIMPLE_ID;
689 module = g_hash_table_lookup (contexts_hash, tmp);
691 context_id = module->contexts[0]->context_id;
700 /* Strip the locale code down to the essentials
702 tmp_locale = _gtk_get_lc_ctype ();
703 tmp = strchr (tmp_locale, '.');
706 tmp = strchr (tmp_locale, '@');
710 tmp_list = modules_list;
713 GtkIMModule *module = tmp_list->data;
715 for (i = 0; i < module->n_contexts; i++)
717 const gchar *p = module->contexts[i]->default_locales;
720 const gchar *q = strchr (p, ':');
721 gint goodness = match_locale (tmp_locale, p, q ? q - p : strlen (p));
723 if (goodness > best_goodness)
725 context_id = module->contexts[i]->context_id;
726 best_goodness = goodness;
729 p = q ? q + 1 : NULL;
733 tmp_list = tmp_list->next;
738 return context_id ? context_id : SIMPLE_ID;