1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * Themes added by The Rasterman <raster@redhat.com>
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free
18 * Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
22 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
23 * file for a list of people on the GTK+ Team. See the ChangeLog
24 * files for a list of changes. These files are distributed with
25 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
35 #include <glib/gstdio.h>
37 #include <pango/pango-utils.h>
38 #include "gtkimmodule.h"
39 #include "gtkimcontextsimple.h"
44 /* Do *not* include "gtkprivate.h" in this file. If you do, the
45 * correct_libdir_prefix() function below will have to move somewhere
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;
68 void (*list) (const GtkIMContextInfo ***contexts,
70 void (*init) (GTypeModule *module);
72 GtkIMContext *(*create) (const gchar *context_id);
74 GtkIMContextInfo **contexts;
80 struct _GtkIMModuleClass
82 GTypeModuleClass parent_class;
85 static GType gtk_im_module_get_type (void);
87 static gint n_loaded_contexts = 0;
88 static GHashTable *contexts_hash = NULL;
89 static GSList *modules_list = NULL;
91 static GObjectClass *parent_class = NULL;
94 gtk_im_module_load (GTypeModule *module)
96 GtkIMModule *im_module = GTK_IM_MODULE (module);
98 im_module->library = g_module_open (im_module->path, 0);
99 if (!im_module->library)
101 g_warning (g_module_error());
105 /* extract symbols from the lib */
106 if (!g_module_symbol (im_module->library, "im_module_init",
107 (gpointer *)&im_module->init) ||
108 !g_module_symbol (im_module->library, "im_module_exit",
109 (gpointer *)&im_module->exit) ||
110 !g_module_symbol (im_module->library, "im_module_list",
111 (gpointer *)&im_module->list) ||
112 !g_module_symbol (im_module->library, "im_module_create",
113 (gpointer *)&im_module->create))
115 g_warning (g_module_error());
116 g_module_close (im_module->library);
121 /* call the theme's init (theme_init) function to let it */
122 /* setup anything it needs to set up. */
123 im_module->init (module);
129 gtk_im_module_unload (GTypeModule *module)
131 GtkIMModule *im_module = GTK_IM_MODULE (module);
135 g_module_close (im_module->library);
136 im_module->library = NULL;
138 im_module->init = NULL;
139 im_module->exit = NULL;
140 im_module->list = NULL;
141 im_module->create = NULL;
144 /* This only will ever be called if an error occurs during
148 gtk_im_module_finalize (GObject *object)
150 GtkIMModule *module = GTK_IM_MODULE (object);
152 g_free (module->path);
154 parent_class->finalize (object);
158 gtk_im_module_class_init (GtkIMModuleClass *class)
160 GTypeModuleClass *module_class = G_TYPE_MODULE_CLASS (class);
161 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
163 parent_class = G_OBJECT_CLASS (g_type_class_peek_parent (class));
165 module_class->load = gtk_im_module_load;
166 module_class->unload = gtk_im_module_unload;
168 gobject_class->finalize = gtk_im_module_finalize;
172 gtk_im_module_get_type (void)
174 static GType im_module_type = 0;
178 static const GTypeInfo im_module_info = {
179 sizeof (GtkIMModuleClass),
180 NULL, /* base_init */
181 NULL, /* base_finalize */
182 (GClassInitFunc) gtk_im_module_class_init,
183 NULL, /* class_finalize */
184 NULL, /* class_data */
185 sizeof (GtkIMModule),
187 NULL, /* instance_init */
191 g_type_register_static (G_TYPE_TYPE_MODULE, I_("GtkIMModule"),
195 return im_module_type;
199 free_info (GtkIMContextInfo *info)
201 g_free ((char *)info->context_id);
202 g_free ((char *)info->context_name);
203 g_free ((char *)info->domain);
204 g_free ((char *)info->domain_dirname);
205 g_free ((char *)info->default_locales);
210 add_module (GtkIMModule *module, GSList *infos)
212 GSList *tmp_list = infos;
214 gint n = g_slist_length (infos);
215 module->contexts = g_new (GtkIMContextInfo *, n);
219 GtkIMContextInfo *info = tmp_list->data;
221 if (g_hash_table_lookup (contexts_hash, info->context_id))
223 free_info (info); /* Duplicate */
227 g_hash_table_insert (contexts_hash, (char *)info->context_id, module);
228 module->contexts[i++] = tmp_list->data;
232 tmp_list = tmp_list->next;
234 g_slist_free (infos);
235 module->n_contexts = i;
237 modules_list = g_slist_prepend (modules_list, module);
240 #if defined (G_OS_WIN32) && defined (GTK_LIBDIR)
241 /* This is needes on Win32, but not wanted when compiling with MSVC,
242 * as the makefile.msc doesn't define any GTK_LIBDIR value.
245 #define DO_CORRECT_LIBDIR_PREFIX /* Flag to check below whether to call this */
248 correct_libdir_prefix (gchar **path)
250 /* GTK_LIBDIR here is supposed to still have the definition from
251 * Makefile.am, i.e. the build-time value. Do *not* include gtkprivate.h
254 if (strncmp (*path, GTK_LIBDIR, strlen (GTK_LIBDIR)) == 0)
256 /* This is an entry put there by make install on the
257 * packager's system. On Windows a prebuilt GTK+
258 * package can be installed in a random
259 * location. The gtk.immodules file distributed in
260 * such a package contains paths from the package
261 * builder's machine. Replace the path with the real
262 * one on this machine.
264 extern const gchar *_gtk_get_libdir ();
266 *path = g_strconcat (_gtk_get_libdir (), tem + strlen (GTK_LIBDIR), NULL);
274 gtk_im_module_init (void)
276 GString *line_buf = g_string_new (NULL);
277 GString *tmp_buf = g_string_new (NULL);
278 gchar *filename = gtk_rc_get_im_module_file();
280 gboolean have_error = FALSE;
282 GtkIMModule *module = NULL;
283 GSList *infos = NULL;
285 contexts_hash = g_hash_table_new (g_str_hash, g_str_equal);
287 file = g_fopen (filename, "r");
290 /* In case someone wants only the default input method,
291 * we allow no file at all.
293 g_string_free (line_buf, TRUE);
294 g_string_free (tmp_buf, TRUE);
299 while (!have_error && pango_read_line (file, line_buf))
305 if (!pango_skip_space (&p))
307 /* Blank line marking the end of a module
309 if (module && *p != '#')
311 add_module (module, infos);
321 /* Read a module location
323 module = g_object_new (GTK_TYPE_IM_MODULE, NULL);
325 if (!pango_scan_string (&p, tmp_buf) ||
326 pango_skip_space (&p))
328 g_warning ("Error parsing context info in '%s'\n %s",
329 filename, line_buf->str);
333 module->path = g_strdup (tmp_buf->str);
334 #ifdef DO_CORRECT_LIBDIR_PREFIX
335 correct_libdir_prefix (&module->path);
337 g_type_module_set_name (G_TYPE_MODULE (module), module->path);
341 GtkIMContextInfo *info = g_new0 (GtkIMContextInfo, 1);
343 /* Read information about a context type
345 if (!pango_scan_string (&p, tmp_buf))
347 info->context_id = g_strdup (tmp_buf->str);
349 if (!pango_scan_string (&p, tmp_buf))
351 info->context_name = g_strdup (tmp_buf->str);
353 if (!pango_scan_string (&p, tmp_buf))
355 info->domain = g_strdup (tmp_buf->str);
357 if (!pango_scan_string (&p, tmp_buf))
359 info->domain_dirname = g_strdup (tmp_buf->str);
360 #ifdef DO_CORRECT_LIBDIR_PREFIX
361 correct_libdir_prefix ((char **) &info->domain_dirname);
364 if (!pango_scan_string (&p, tmp_buf))
366 info->default_locales = g_strdup (tmp_buf->str);
368 if (pango_skip_space (&p))
371 infos = g_slist_prepend (infos, info);
375 g_warning ("Error parsing context info in '%s'\n %s",
376 filename, line_buf->str);
383 GSList *tmp_list = infos;
386 free_info (tmp_list->data);
387 tmp_list = tmp_list->next;
389 g_slist_free (infos);
391 g_object_unref (module);
394 add_module (module, infos);
397 g_string_free (line_buf, TRUE);
398 g_string_free (tmp_buf, TRUE);
403 compare_gtkimcontextinfo_name(const GtkIMContextInfo **a,
404 const GtkIMContextInfo **b)
406 return g_utf8_collate ((*a)->context_name, (*b)->context_name);
410 * _gtk_im_module_list:
411 * @contexts: location to store an array of pointers to #GtkIMContextInfo
412 * this array should be freed with g_free() when you are finished.
413 * The structures it points are statically allocated and should
414 * not be modified or freed.
415 * @n_contexts: the length of the array stored in @contexts
417 * List all available types of input method context
420 _gtk_im_module_list (const GtkIMContextInfo ***contexts,
425 static const GtkIMContextInfo simple_context_info = {
438 gtk_im_module_init ();
441 *n_contexts = (n_loaded_contexts + 1);
448 *contexts = g_new (const GtkIMContextInfo *, n_loaded_contexts + 1);
450 (*contexts)[n++] = &simple_context_info;
452 tmp_list = modules_list;
455 GtkIMModule *module = tmp_list->data;
457 for (i=0; i<module->n_contexts; i++)
458 (*contexts)[n++] = module->contexts[i];
460 tmp_list = tmp_list->next;
463 /* fisrt element (Default) should always be at top */
464 qsort ((*contexts)+1, n-1, sizeof (GtkIMContextInfo *), (GCompareFunc)compare_gtkimcontextinfo_name);
469 * _gtk_im_module_create:
470 * @context_id: the context ID for the context type to create
472 * Create an IM context of a type specified by the string
475 * Return value: a newly created input context of or @context_id, or
476 * if that could not be created, a newly created GtkIMContextSimple.
479 _gtk_im_module_create (const gchar *context_id)
481 GtkIMModule *im_module;
482 GtkIMContext *context = NULL;
485 gtk_im_module_init ();
487 if (strcmp (context_id, SIMPLE_ID) != 0)
489 im_module = g_hash_table_lookup (contexts_hash, context_id);
492 g_warning ("Attempt to load unknown IM context type '%s'", context_id);
496 if (g_type_module_use (G_TYPE_MODULE (im_module)))
498 context = im_module->create (context_id);
499 g_type_module_unuse (G_TYPE_MODULE (im_module));
503 g_warning ("Loading IM context type '%s' failed", context_id);
508 return gtk_im_context_simple_new ();
513 /* Match @locale against @against.
515 * 'en_US' against 'en_US' => 4
516 * 'en_US' against 'en' => 3
517 * 'en', 'en_UK' against 'en_US' => 2
518 * all locales, against '*' => 1
521 match_locale (const gchar *locale,
522 const gchar *against,
525 if (strcmp (against, "*") == 0)
528 if (g_ascii_strcasecmp (locale, against) == 0)
531 if (g_ascii_strncasecmp (locale, against, 2) == 0)
532 return (against_len == 2) ? 3 : 2;
538 * _gtk_im_module_get_default_context_id:
539 * @locale: a locale id in the form 'en_US'
541 * Return the context_id of the best IM context type
542 * for the given locale ID.
544 * Return value: the context ID (will never be %NULL)
545 * the value is newly allocated and must be freed
549 _gtk_im_module_get_default_context_id (const gchar *locale)
552 const gchar *context_id = NULL;
553 gint best_goodness = 0;
555 gchar *tmp_locale, *tmp;
559 gtk_im_module_init ();
561 envvar = g_getenv ("GTK_IM_MODULE");
563 (strcmp (envvar, SIMPLE_ID) == 0 ||
564 g_hash_table_lookup (contexts_hash, envvar)))
565 return g_strdup (envvar);
567 /* Strip the locale code down to the essentials
569 tmp_locale = g_strdup (locale);
570 tmp = strchr (tmp_locale, '.');
573 tmp = strchr (tmp_locale, '@');
577 tmp_list = modules_list;
580 GtkIMModule *module = tmp_list->data;
582 for (i=0; i<module->n_contexts; i++)
584 const gchar *p = module->contexts[i]->default_locales;
587 const gchar *q = strchr (p, ':');
588 gint goodness = match_locale (tmp_locale, p, q ? q - p : strlen (p));
590 if (goodness > best_goodness)
592 context_id = module->contexts[i]->context_id;
593 best_goodness = goodness;
596 p = q ? q + 1 : NULL;
600 tmp_list = tmp_list->next;
605 return g_strdup (context_id ? context_id : SIMPLE_ID);