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 <pango/pango-utils.h>
36 #include "gtkimmodule.h"
37 #include "gtkimcontextsimple.h"
38 #include "gtksettings.h"
44 /* Do *not* include "gtkprivate.h" in this file. If you do, the
45 * correct_libdir_prefix() and correct_localedir_prefix() functions
46 * below will have to move somewhere else.
49 #ifdef __GTK_PRIVATE_H__
50 #error gtkprivate.h should not be included in this file
53 #define SIMPLE_ID "gtk-im-context-simple"
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 (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 (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 here is supposed to still have the definition from
234 * Makefile.am, i.e. the build-time value. Do *not* include gtkprivate.h
237 if (strncmp (*path, GTK_LIBDIR, strlen (GTK_LIBDIR)) == 0)
239 /* This is an entry put there by make install on the
240 * packager's system. On Windows a prebuilt GTK+
241 * package can be installed in a random
242 * location. The gtk.immodules file distributed in
243 * such a package contains paths from the package
244 * builder's machine. Replace the path with the real
245 * one on this machine.
247 extern const gchar *_gtk_get_libdir ();
249 *path = g_strconcat (_gtk_get_libdir (), tem + strlen (GTK_LIBDIR), NULL);
255 correct_localedir_prefix (gchar **path)
257 /* As above, but for GTK_LOCALEDIR. Use separate function in case
258 * GTK_LOCALEDIR isn't a subfolder of GTK_LIBDIR.
260 if (strncmp (*path, GTK_LOCALEDIR, strlen (GTK_LOCALEDIR)) == 0)
262 extern const gchar *_gtk_get_localedir ();
264 *path = g_strconcat (_gtk_get_localedir (), tem + strlen (GTK_LOCALEDIR), NULL);
272 add_builtin_module (const gchar *module_name,
273 const GtkIMContextInfo **contexts,
276 GtkIMModule *module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
277 GSList *infos = NULL;
280 for (i = 0; i < n_contexts; i++)
282 GtkIMContextInfo *info = g_new (GtkIMContextInfo, 1);
283 info->context_id = g_strdup (contexts[i]->context_id);
284 info->context_name = g_strdup (contexts[i]->context_name);
285 info->domain = g_strdup (contexts[i]->domain);
286 info->domain_dirname = g_strdup (contexts[i]->domain_dirname);
288 correct_localedir_prefix ((char **) &info->domain_dirname);
290 info->default_locales = g_strdup (contexts[i]->default_locales);
291 infos = g_slist_prepend (infos, info);
294 module->builtin = TRUE;
295 g_type_module_set_name (G_TYPE_MODULE (module), module_name);
296 add_module (module, infos);
302 gtk_im_module_initialize (void)
304 GString *line_buf = g_string_new (NULL);
305 GString *tmp_buf = g_string_new (NULL);
306 gchar *filename = gtk_rc_get_im_module_file();
308 gboolean have_error = FALSE;
310 GtkIMModule *module = NULL;
311 GSList *infos = NULL;
313 contexts_hash = g_hash_table_new (g_str_hash, g_str_equal);
315 #define do_builtin(m) \
317 const GtkIMContextInfo **contexts; \
319 extern void _gtk_immodule_ ## m ## _list (const GtkIMContextInfo ***contexts, \
320 guint *n_contexts); \
321 extern void _gtk_immodule_ ## m ## _init (GTypeModule *module); \
322 extern void _gtk_immodule_ ## m ## _exit (void); \
323 extern GtkIMContext *_gtk_immodule_ ## m ## _create (const gchar *context_id); \
325 _gtk_immodule_ ## m ## _list (&contexts, &n_contexts); \
326 module = add_builtin_module (#m, contexts, n_contexts); \
327 module->init = _gtk_immodule_ ## m ## _init; \
328 module->exit = _gtk_immodule_ ## m ## _exit; \
329 module->create = _gtk_immodule_ ## m ## _create; \
333 #ifdef INCLUDE_IM_am_et
336 #ifdef INCLUDE_IM_cedilla
337 do_builtin (cedilla);
339 #ifdef INCLUDE_IM_cyrillic_translit
340 do_builtin (cyrillic_translit);
342 #ifdef INCLUDE_IM_ime
345 #ifdef INCLUDE_IM_inuktitut
346 do_builtin (inuktitut);
348 #ifdef INCLUDE_IM_ipa
351 #ifdef INCLUDE_IM_multipress
352 do_builtin (multipress);
354 #ifdef INCLUDE_IM_thai
357 #ifdef INCLUDE_IM_ti_er
360 #ifdef INCLUDE_IM_ti_et
363 #ifdef INCLUDE_IM_viqr
366 #ifdef INCLUDE_IM_xim
372 file = g_fopen (filename, "r");
375 /* In case someone wants only the default input method,
376 * we allow no file at all.
378 g_string_free (line_buf, TRUE);
379 g_string_free (tmp_buf, TRUE);
384 while (!have_error && pango_read_line (file, line_buf))
390 if (!pango_skip_space (&p))
392 /* Blank line marking the end of a module
394 if (module && *p != '#')
396 add_module (module, infos);
406 /* Read a module location
408 module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
410 if (!pango_scan_string (&p, tmp_buf) ||
411 pango_skip_space (&p))
413 g_warning ("Error parsing context info in '%s'\n %s",
414 filename, line_buf->str);
418 module->path = g_strdup (tmp_buf->str);
420 correct_libdir_prefix (&module->path);
422 g_type_module_set_name (G_TYPE_MODULE (module), module->path);
426 GtkIMContextInfo *info = g_new0 (GtkIMContextInfo, 1);
428 /* Read information about a context type
430 if (!pango_scan_string (&p, tmp_buf))
432 info->context_id = g_strdup (tmp_buf->str);
434 if (!pango_scan_string (&p, tmp_buf))
436 info->context_name = g_strdup (tmp_buf->str);
438 if (!pango_scan_string (&p, tmp_buf))
440 info->domain = g_strdup (tmp_buf->str);
442 if (!pango_scan_string (&p, tmp_buf))
444 info->domain_dirname = g_strdup (tmp_buf->str);
446 correct_localedir_prefix ((char **) &info->domain_dirname);
449 if (!pango_scan_string (&p, tmp_buf))
451 info->default_locales = g_strdup (tmp_buf->str);
453 if (pango_skip_space (&p))
456 infos = g_slist_prepend (infos, info);
460 g_warning ("Error parsing context info in '%s'\n %s",
461 filename, line_buf->str);
468 GSList *tmp_list = infos;
471 free_info (tmp_list->data);
472 tmp_list = tmp_list->next;
474 g_slist_free (infos);
476 g_object_unref (module);
479 add_module (module, infos);
482 g_string_free (line_buf, TRUE);
483 g_string_free (tmp_buf, TRUE);
488 compare_gtkimcontextinfo_name(const GtkIMContextInfo **a,
489 const GtkIMContextInfo **b)
491 return g_utf8_collate ((*a)->context_name, (*b)->context_name);
495 * _gtk_im_module_list:
496 * @contexts: location to store an array of pointers to #GtkIMContextInfo
497 * this array should be freed with g_free() when you are finished.
498 * The structures it points are statically allocated and should
499 * not be modified or freed.
500 * @n_contexts: the length of the array stored in @contexts
502 * List all available types of input method context
505 _gtk_im_module_list (const GtkIMContextInfo ***contexts,
514 GtkIMContextInfo simple_context_info = {
527 static gboolean beenhere = FALSE;
531 gtk_im_module_initialize ();
537 /* correct_localedir_prefix() requires its parameter to be a
540 simple_context_info.domain_dirname = g_strdup (simple_context_info.domain_dirname);
541 correct_localedir_prefix ((char **) &simple_context_info.domain_dirname);
546 *n_contexts = (n_loaded_contexts + 1);
553 *contexts = g_new (const GtkIMContextInfo *, n_loaded_contexts + 1);
555 (*contexts)[n++] = &simple_context_info;
557 tmp_list = modules_list;
560 GtkIMModule *module = tmp_list->data;
562 for (i=0; i<module->n_contexts; i++)
563 (*contexts)[n++] = module->contexts[i];
565 tmp_list = tmp_list->next;
568 /* fisrt element (Default) should always be at top */
569 qsort ((*contexts)+1, n-1, sizeof (GtkIMContextInfo *), (GCompareFunc)compare_gtkimcontextinfo_name);
574 * _gtk_im_module_create:
575 * @context_id: the context ID for the context type to create
577 * Create an IM context of a type specified by the string
580 * Return value: a newly created input context of or @context_id, or
581 * if that could not be created, a newly created GtkIMContextSimple.
584 _gtk_im_module_create (const gchar *context_id)
586 GtkIMModule *im_module;
587 GtkIMContext *context = NULL;
590 gtk_im_module_initialize ();
592 if (strcmp (context_id, SIMPLE_ID) != 0)
594 im_module = g_hash_table_lookup (contexts_hash, context_id);
597 g_warning ("Attempt to load unknown IM context type '%s'", context_id);
601 if (g_type_module_use (G_TYPE_MODULE (im_module)))
603 context = im_module->create (context_id);
604 g_type_module_unuse (G_TYPE_MODULE (im_module));
608 g_warning ("Loading IM context type '%s' failed", context_id);
613 return gtk_im_context_simple_new ();
618 /* Match @locale against @against.
620 * 'en_US' against 'en_US' => 4
621 * 'en_US' against 'en' => 3
622 * 'en', 'en_UK' against 'en_US' => 2
623 * all locales, against '*' => 1
626 match_locale (const gchar *locale,
627 const gchar *against,
630 if (strcmp (against, "*") == 0)
633 if (g_ascii_strcasecmp (locale, against) == 0)
636 if (g_ascii_strncasecmp (locale, against, 2) == 0)
637 return (against_len == 2) ? 3 : 2;
643 * _gtk_im_module_get_default_context_id:
644 * @client_window: a window
646 * Return the context_id of the best IM context type
647 * for the given window.
649 * Return value: the context ID (will never be %NULL)
652 _gtk_im_module_get_default_context_id (GdkWindow *client_window)
655 const gchar *context_id = NULL;
656 gint best_goodness = 0;
658 gchar *tmp_locale, *tmp;
661 GtkSettings *settings;
664 gtk_im_module_initialize ();
666 envvar = g_getenv ("GTK_IM_MODULE");
668 (strcmp (envvar, SIMPLE_ID) == 0 ||
669 g_hash_table_lookup (contexts_hash, envvar)))
672 /* Check if the certain immodule is set in XSETTINGS.
674 if (client_window != NULL && GDK_IS_DRAWABLE (client_window))
676 screen = gdk_drawable_get_screen (GDK_DRAWABLE (client_window));
678 settings = gtk_settings_get_for_screen (screen);
680 settings = gtk_settings_get_default ();
682 g_object_get (G_OBJECT (settings), "gtk-im-module", &tmp, NULL);
685 if (strcmp (tmp, SIMPLE_ID) == 0)
686 context_id = SIMPLE_ID;
690 module = g_hash_table_lookup (contexts_hash, tmp);
692 context_id = module->contexts[0]->context_id;
701 /* Strip the locale code down to the essentials
703 tmp_locale = _gtk_get_lc_ctype ();
704 tmp = strchr (tmp_locale, '.');
707 tmp = strchr (tmp_locale, '@');
711 tmp_list = modules_list;
714 GtkIMModule *module = tmp_list->data;
716 for (i = 0; i < module->n_contexts; i++)
718 const gchar *p = module->contexts[i]->default_locales;
721 const gchar *q = strchr (p, ':');
722 gint goodness = match_locale (tmp_locale, p, q ? q - p : strlen (p));
724 if (goodness > best_goodness)
726 context_id = module->contexts[i]->context_id;
727 best_goodness = goodness;
730 p = q ? q + 1 : NULL;
734 tmp_list = tmp_list->next;
739 return context_id ? context_id : SIMPLE_ID;