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 "gtkimmoduleprivate.h"
36 #include "gtkimcontextsimple.h"
37 #include "gtksettings.h"
38 #include "gtkprivate.h"
42 #undef GDK_DEPRECATED_FOR
43 #define GDK_DEPRECATED
44 #define GDK_DEPRECATED_FOR(f)
45 #undef GTK_DISABLE_DEPRECATED
47 #include "deprecated/gtkrc.h"
49 #define SIMPLE_ID "gtk-im-context-simple"
53 * @context_id: The unique identification string of the input method.
54 * @context_name: The human-readable name of the input method.
55 * @domain: Translation domain to be used with dgettext()
56 * @domain_dirname: Name of locale directory for use with bindtextdomain()
57 * @default_locales: A colon-separated list of locales where this input method
58 * should be the default. The asterisk "*" sets the default for all locales.
60 * Bookkeeping information about a loadable input method.
63 typedef struct _GtkIMModule GtkIMModule;
64 typedef struct _GtkIMModuleClass GtkIMModuleClass;
66 #define GTK_TYPE_IM_MODULE (gtk_im_module_get_type ())
67 #define GTK_IM_MODULE(im_module) (G_TYPE_CHECK_INSTANCE_CAST ((im_module), GTK_TYPE_IM_MODULE, GtkIMModule))
68 #define GTK_IS_IM_MODULE(im_module) (G_TYPE_CHECK_INSTANCE_TYPE ((im_module), GTK_TYPE_IM_MODULE))
72 GTypeModule parent_instance;
78 void (*list) (const GtkIMContextInfo ***contexts,
80 void (*init) (GTypeModule *module);
82 GtkIMContext *(*create) (const gchar *context_id);
84 GtkIMContextInfo **contexts;
90 struct _GtkIMModuleClass
92 GTypeModuleClass parent_class;
95 static GType gtk_im_module_get_type (void);
97 static gint n_loaded_contexts = 0;
98 static GHashTable *contexts_hash = NULL;
99 static GSList *modules_list = NULL;
101 static GObjectClass *parent_class = NULL;
104 gtk_im_module_load (GTypeModule *module)
106 GtkIMModule *im_module = GTK_IM_MODULE (module);
108 if (!im_module->builtin)
110 im_module->library = g_module_open (im_module->path, G_MODULE_BIND_LAZY | G_MODULE_BIND_LOCAL);
111 if (!im_module->library)
113 g_warning ("%s", g_module_error());
117 /* extract symbols from the lib */
118 if (!g_module_symbol (im_module->library, "im_module_init",
119 (gpointer *)&im_module->init) ||
120 !g_module_symbol (im_module->library, "im_module_exit",
121 (gpointer *)&im_module->exit) ||
122 !g_module_symbol (im_module->library, "im_module_list",
123 (gpointer *)&im_module->list) ||
124 !g_module_symbol (im_module->library, "im_module_create",
125 (gpointer *)&im_module->create))
127 g_warning ("%s", g_module_error());
128 g_module_close (im_module->library);
134 /* call the module's init function to let it */
135 /* setup anything it needs to set up. */
136 im_module->init (module);
142 gtk_im_module_unload (GTypeModule *module)
144 GtkIMModule *im_module = GTK_IM_MODULE (module);
148 if (!im_module->builtin)
150 g_module_close (im_module->library);
151 im_module->library = NULL;
153 im_module->init = NULL;
154 im_module->exit = NULL;
155 im_module->list = NULL;
156 im_module->create = NULL;
160 /* This only will ever be called if an error occurs during
164 gtk_im_module_finalize (GObject *object)
166 GtkIMModule *module = GTK_IM_MODULE (object);
168 g_free (module->path);
170 parent_class->finalize (object);
173 G_DEFINE_TYPE (GtkIMModule, gtk_im_module, G_TYPE_TYPE_MODULE)
176 gtk_im_module_class_init (GtkIMModuleClass *class)
178 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
179 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
181 parent_class = G_OBJECT_CLASS (g_type_class_peek_parent (class));
183 module_class->load = gtk_im_module_load;
184 module_class->unload = gtk_im_module_unload;
186 gobject_class->finalize = gtk_im_module_finalize;
190 gtk_im_module_init (GtkIMModule* object)
195 free_info (GtkIMContextInfo *info)
197 g_free ((char *)info->context_id);
198 g_free ((char *)info->context_name);
199 g_free ((char *)info->domain);
200 g_free ((char *)info->domain_dirname);
201 g_free ((char *)info->default_locales);
206 add_module (GtkIMModule *module, GSList *infos)
208 GSList *tmp_list = infos;
210 gint n = g_slist_length (infos);
211 module->contexts = g_new (GtkIMContextInfo *, n);
215 GtkIMContextInfo *info = tmp_list->data;
217 if (g_hash_table_lookup (contexts_hash, info->context_id))
219 free_info (info); /* Duplicate */
223 g_hash_table_insert (contexts_hash, (char *)info->context_id, module);
224 module->contexts[i++] = tmp_list->data;
228 tmp_list = tmp_list->next;
230 g_slist_free (infos);
231 module->n_contexts = i;
233 modules_list = g_slist_prepend (modules_list, module);
239 correct_libdir_prefix (gchar **path)
241 /* GTK_LIBDIR is the build-time libdir */
242 if (strncmp (*path, GTK_LIBDIR, strlen (GTK_LIBDIR)) == 0)
244 /* This is an entry put there by make install on the
245 * packager's system. On Windows a prebuilt GTK+
246 * package can be installed in a random
247 * location. The gtk.immodules file distributed in
248 * such a package contains paths from the package
249 * builder's machine. Replace the path with the real
250 * one on this machine.
253 *path = g_strconcat (_gtk_get_libdir (), tem + strlen (GTK_LIBDIR), NULL);
259 correct_localedir_prefix (gchar **path)
262 if (strncmp (*path, GTK_LOCALEDIR, strlen (GTK_LOCALEDIR)) == 0)
265 *path = g_strconcat (_gtk_get_localedir (), tem + strlen (GTK_LOCALEDIR), NULL);
272 G_GNUC_UNUSED static GtkIMModule *
273 add_builtin_module (const gchar *module_name,
274 const GtkIMContextInfo **contexts,
277 GtkIMModule *module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
278 GSList *infos = NULL;
281 for (i = 0; i < n_contexts; i++)
283 GtkIMContextInfo *info = g_new (GtkIMContextInfo, 1);
284 info->context_id = g_strdup (contexts[i]->context_id);
285 info->context_name = g_strdup (contexts[i]->context_name);
286 info->domain = g_strdup (contexts[i]->domain);
287 info->domain_dirname = g_strdup (contexts[i]->domain_dirname);
289 correct_localedir_prefix ((char **) &info->domain_dirname);
291 info->default_locales = g_strdup (contexts[i]->default_locales);
292 infos = g_slist_prepend (infos, info);
295 module->builtin = TRUE;
296 g_type_module_set_name (G_TYPE_MODULE (module), module_name);
297 add_module (module, infos);
303 gtk_im_module_initialize (void)
305 GString *line_buf = g_string_new (NULL);
306 GString *tmp_buf = g_string_new (NULL);
307 gchar *filename = gtk_rc_get_im_module_file();
309 gboolean have_error = FALSE;
311 GtkIMModule *module = NULL;
312 GSList *infos = NULL;
314 contexts_hash = g_hash_table_new (g_str_hash, g_str_equal);
316 #define do_builtin(m) \
318 const GtkIMContextInfo **contexts; \
320 extern void _gtk_immodule_ ## m ## _list (const GtkIMContextInfo ***contexts, \
321 guint *n_contexts); \
322 extern void _gtk_immodule_ ## m ## _init (GTypeModule *module); \
323 extern void _gtk_immodule_ ## m ## _exit (void); \
324 extern GtkIMContext *_gtk_immodule_ ## m ## _create (const gchar *context_id); \
326 _gtk_immodule_ ## m ## _list (&contexts, &n_contexts); \
327 module = add_builtin_module (#m, contexts, n_contexts); \
328 module->init = _gtk_immodule_ ## m ## _init; \
329 module->exit = _gtk_immodule_ ## m ## _exit; \
330 module->create = _gtk_immodule_ ## m ## _create; \
334 #ifdef INCLUDE_IM_am_et
337 #ifdef INCLUDE_IM_cedilla
338 do_builtin (cedilla);
340 #ifdef INCLUDE_IM_cyrillic_translit
341 do_builtin (cyrillic_translit);
343 #ifdef INCLUDE_IM_ime
346 #ifdef INCLUDE_IM_inuktitut
347 do_builtin (inuktitut);
349 #ifdef INCLUDE_IM_ipa
352 #ifdef INCLUDE_IM_multipress
353 do_builtin (multipress);
355 #ifdef INCLUDE_IM_thai
358 #ifdef INCLUDE_IM_ti_er
361 #ifdef INCLUDE_IM_ti_et
364 #ifdef INCLUDE_IM_viqr
367 #ifdef INCLUDE_IM_xim
373 file = g_fopen (filename, "r");
376 /* In case someone wants only the default input method,
377 * we allow no file at all.
379 g_string_free (line_buf, TRUE);
380 g_string_free (tmp_buf, TRUE);
385 while (!have_error && pango_read_line (file, line_buf))
391 if (!pango_skip_space (&p))
393 /* Blank line marking the end of a module
395 if (module && *p != '#')
397 add_module (module, infos);
407 /* Read a module location
409 module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
411 if (!pango_scan_string (&p, tmp_buf) ||
412 pango_skip_space (&p))
414 g_warning ("Error parsing context info in '%s'\n %s",
415 filename, line_buf->str);
419 module->path = g_strdup (tmp_buf->str);
421 correct_libdir_prefix (&module->path);
423 g_type_module_set_name (G_TYPE_MODULE (module), module->path);
427 GtkIMContextInfo *info = g_new0 (GtkIMContextInfo, 1);
429 /* Read information about a context type
431 if (!pango_scan_string (&p, tmp_buf))
433 info->context_id = g_strdup (tmp_buf->str);
435 if (!pango_scan_string (&p, tmp_buf))
437 info->context_name = g_strdup (tmp_buf->str);
439 if (!pango_scan_string (&p, tmp_buf))
441 info->domain = g_strdup (tmp_buf->str);
443 if (!pango_scan_string (&p, tmp_buf))
445 info->domain_dirname = g_strdup (tmp_buf->str);
447 correct_localedir_prefix ((char **) &info->domain_dirname);
450 if (!pango_scan_string (&p, tmp_buf))
452 info->default_locales = g_strdup (tmp_buf->str);
454 if (pango_skip_space (&p))
457 infos = g_slist_prepend (infos, info);
461 g_warning ("Error parsing context info in '%s'\n %s",
462 filename, line_buf->str);
469 GSList *tmp_list = infos;
472 free_info (tmp_list->data);
473 tmp_list = tmp_list->next;
475 g_slist_free (infos);
477 g_object_unref (module);
480 add_module (module, infos);
483 g_string_free (line_buf, TRUE);
484 g_string_free (tmp_buf, TRUE);
489 compare_gtkimcontextinfo_name(const GtkIMContextInfo **a,
490 const GtkIMContextInfo **b)
492 return g_utf8_collate ((*a)->context_name, (*b)->context_name);
496 * _gtk_im_module_list:
497 * @contexts: location to store an array of pointers to #GtkIMContextInfo
498 * this array should be freed with g_free() when you are finished.
499 * The structures it points are statically allocated and should
500 * not be modified or freed.
501 * @n_contexts: the length of the array stored in @contexts
503 * List all available types of input method context
506 _gtk_im_module_list (const GtkIMContextInfo ***contexts,
515 GtkIMContextInfo simple_context_info = {
528 static gboolean beenhere = FALSE;
532 gtk_im_module_initialize ();
538 /* correct_localedir_prefix() requires its parameter to be a
541 simple_context_info.domain_dirname = g_strdup (simple_context_info.domain_dirname);
542 correct_localedir_prefix ((char **) &simple_context_info.domain_dirname);
547 *n_contexts = (n_loaded_contexts + 1);
554 *contexts = g_new (const GtkIMContextInfo *, n_loaded_contexts + 1);
556 (*contexts)[n++] = &simple_context_info;
558 tmp_list = modules_list;
561 GtkIMModule *module = tmp_list->data;
563 for (i=0; i<module->n_contexts; i++)
564 (*contexts)[n++] = module->contexts[i];
566 tmp_list = tmp_list->next;
569 /* fisrt element (Default) should always be at top */
570 qsort ((*contexts)+1, n-1, sizeof (GtkIMContextInfo *), (GCompareFunc)compare_gtkimcontextinfo_name);
575 * _gtk_im_module_create:
576 * @context_id: the context ID for the context type to create
578 * Create an IM context of a type specified by the string
581 * Return value: a newly created input context of or @context_id, or
582 * if that could not be created, a newly created GtkIMContextSimple.
585 _gtk_im_module_create (const gchar *context_id)
587 GtkIMModule *im_module;
588 GtkIMContext *context = NULL;
591 gtk_im_module_initialize ();
593 if (strcmp (context_id, SIMPLE_ID) != 0)
595 im_module = g_hash_table_lookup (contexts_hash, context_id);
598 g_warning ("Attempt to load unknown IM context type '%s'", context_id);
602 if (g_type_module_use (G_TYPE_MODULE (im_module)))
604 context = im_module->create (context_id);
605 g_type_module_unuse (G_TYPE_MODULE (im_module));
609 g_warning ("Loading IM context type '%s' failed", context_id);
614 return gtk_im_context_simple_new ();
619 /* Match @locale against @against.
621 * 'en_US' against 'en_US' => 4
622 * 'en_US' against 'en' => 3
623 * 'en', 'en_UK' against 'en_US' => 2
624 * all locales, against '*' => 1
627 match_locale (const gchar *locale,
628 const gchar *against,
631 if (strcmp (against, "*") == 0)
634 if (g_ascii_strcasecmp (locale, against) == 0)
637 if (g_ascii_strncasecmp (locale, against, 2) == 0)
638 return (against_len == 2) ? 3 : 2;
644 lookup_immodule (gchar **immodules_list)
646 while (immodules_list && *immodules_list)
648 if (g_strcmp0 (*immodules_list, SIMPLE_ID) == 0)
653 module = g_hash_table_lookup (contexts_hash, *immodules_list);
655 return module->contexts[0]->context_id;
664 * _gtk_im_module_get_default_context_id:
665 * @client_window: a window
667 * Return the context_id of the best IM context type
668 * for the given window.
670 * Return value: the context ID (will never be %NULL)
673 _gtk_im_module_get_default_context_id (GdkWindow *client_window)
676 const gchar *context_id = NULL;
677 gint best_goodness = 0;
679 gchar *tmp_locale, *tmp, **immodules;
682 GtkSettings *settings;
685 gtk_im_module_initialize ();
687 envvar = g_getenv("GTK_IM_MODULE");
690 immodules = g_strsplit(envvar, ":", 0);
691 context_id = lookup_immodule(immodules);
692 g_strfreev(immodules);
698 /* Check if the certain immodule is set in XSETTINGS.
700 if (GDK_IS_WINDOW (client_window))
702 screen = gdk_window_get_screen (client_window);
703 settings = gtk_settings_get_for_screen (screen);
704 g_object_get (G_OBJECT (settings), "gtk-im-module", &tmp, NULL);
707 immodules = g_strsplit(tmp, ":", 0);
708 context_id = lookup_immodule(immodules);
709 g_strfreev(immodules);
717 /* Strip the locale code down to the essentials
719 tmp_locale = _gtk_get_lc_ctype ();
720 tmp = strchr (tmp_locale, '.');
723 tmp = strchr (tmp_locale, '@');
727 tmp_list = modules_list;
730 GtkIMModule *module = tmp_list->data;
732 for (i = 0; i < module->n_contexts; i++)
734 const gchar *p = module->contexts[i]->default_locales;
737 const gchar *q = strchr (p, ':');
738 gint goodness = match_locale (tmp_locale, p, q ? q - p : strlen (p));
740 if (goodness > best_goodness)
742 context_id = module->contexts[i]->context_id;
743 best_goodness = goodness;
746 p = q ? q + 1 : NULL;
750 tmp_list = tmp_list->next;
755 return context_id ? context_id : SIMPLE_ID;