1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 2000 Red Hat, Inc.
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
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
25 #include "gtkimmulticontext.h"
26 #include "gtkimmodule.h"
28 #include "gtkradiomenuitem.h"
30 #include "gtkprivate.h" /* To get redefinition of GTK_LOCALE_DIR on Win32 */
32 #define NONE_ID "gtk-im-context-none"
34 struct _GtkIMMulticontextPrivate
38 GdkWindow *client_window;
39 GdkRectangle cursor_location;
42 gchar *context_id_aux;
44 guint use_preedit : 1;
45 guint have_cursor_location : 1;
49 static void gtk_im_multicontext_finalize (GObject *object);
51 static void gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
55 static void gtk_im_multicontext_set_client_window (GtkIMContext *context,
57 static void gtk_im_multicontext_get_preedit_string (GtkIMContext *context,
59 PangoAttrList **attrs,
61 static gboolean gtk_im_multicontext_filter_keypress (GtkIMContext *context,
63 static void gtk_im_multicontext_focus_in (GtkIMContext *context);
64 static void gtk_im_multicontext_focus_out (GtkIMContext *context);
65 static void gtk_im_multicontext_reset (GtkIMContext *context);
66 static void gtk_im_multicontext_set_cursor_location (GtkIMContext *context,
68 static void gtk_im_multicontext_set_use_preedit (GtkIMContext *context,
69 gboolean use_preedit);
70 static gboolean gtk_im_multicontext_get_surrounding (GtkIMContext *context,
73 static void gtk_im_multicontext_set_surrounding (GtkIMContext *context,
78 static void gtk_im_multicontext_preedit_start_cb (GtkIMContext *slave,
79 GtkIMMulticontext *multicontext);
80 static void gtk_im_multicontext_preedit_end_cb (GtkIMContext *slave,
81 GtkIMMulticontext *multicontext);
82 static void gtk_im_multicontext_preedit_changed_cb (GtkIMContext *slave,
83 GtkIMMulticontext *multicontext);
84 static void gtk_im_multicontext_commit_cb (GtkIMContext *slave,
86 GtkIMMulticontext *multicontext);
87 static gboolean gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext *slave,
88 GtkIMMulticontext *multicontext);
89 static gboolean gtk_im_multicontext_delete_surrounding_cb (GtkIMContext *slave,
92 GtkIMMulticontext *multicontext);
94 static const gchar *global_context_id = NULL;
96 G_DEFINE_TYPE (GtkIMMulticontext, gtk_im_multicontext, GTK_TYPE_IM_CONTEXT)
99 gtk_im_multicontext_class_init (GtkIMMulticontextClass *class)
101 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
102 GtkIMContextClass *im_context_class = GTK_IM_CONTEXT_CLASS (class);
104 im_context_class->set_client_window = gtk_im_multicontext_set_client_window;
105 im_context_class->get_preedit_string = gtk_im_multicontext_get_preedit_string;
106 im_context_class->filter_keypress = gtk_im_multicontext_filter_keypress;
107 im_context_class->focus_in = gtk_im_multicontext_focus_in;
108 im_context_class->focus_out = gtk_im_multicontext_focus_out;
109 im_context_class->reset = gtk_im_multicontext_reset;
110 im_context_class->set_cursor_location = gtk_im_multicontext_set_cursor_location;
111 im_context_class->set_use_preedit = gtk_im_multicontext_set_use_preedit;
112 im_context_class->set_surrounding = gtk_im_multicontext_set_surrounding;
113 im_context_class->get_surrounding = gtk_im_multicontext_get_surrounding;
115 gobject_class->finalize = gtk_im_multicontext_finalize;
117 g_type_class_add_private (gobject_class, sizeof (GtkIMMulticontextPrivate));
121 gtk_im_multicontext_init (GtkIMMulticontext *multicontext)
123 GtkIMMulticontextPrivate *priv;
125 multicontext->priv = G_TYPE_INSTANCE_GET_PRIVATE (multicontext, GTK_TYPE_IM_MULTICONTEXT, GtkIMMulticontextPrivate);
126 priv = multicontext->priv;
129 priv->use_preedit = TRUE;
130 priv->have_cursor_location = FALSE;
131 priv->focus_in = FALSE;
135 * gtk_im_multicontext_new:
137 * Creates a new #GtkIMMulticontext.
139 * Returns: a new #GtkIMMulticontext.
142 gtk_im_multicontext_new (void)
144 return g_object_new (GTK_TYPE_IM_MULTICONTEXT, NULL);
148 gtk_im_multicontext_finalize (GObject *object)
150 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (object);
151 GtkIMMulticontextPrivate *priv = multicontext->priv;
153 gtk_im_multicontext_set_slave (multicontext, NULL, TRUE);
154 g_free (priv->context_id);
155 g_free (priv->context_id_aux);
157 G_OBJECT_CLASS (gtk_im_multicontext_parent_class)->finalize (object);
161 gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
165 GtkIMMulticontextPrivate *priv = multicontext->priv;
166 gboolean need_preedit_changed = FALSE;
171 gtk_im_context_reset (priv->slave);
173 g_signal_handlers_disconnect_by_func (priv->slave,
174 gtk_im_multicontext_preedit_start_cb,
176 g_signal_handlers_disconnect_by_func (priv->slave,
177 gtk_im_multicontext_preedit_end_cb,
179 g_signal_handlers_disconnect_by_func (priv->slave,
180 gtk_im_multicontext_preedit_changed_cb,
182 g_signal_handlers_disconnect_by_func (priv->slave,
183 gtk_im_multicontext_commit_cb,
186 g_object_unref (priv->slave);
190 need_preedit_changed = TRUE;
197 g_object_ref (priv->slave);
199 g_signal_connect (priv->slave, "preedit-start",
200 G_CALLBACK (gtk_im_multicontext_preedit_start_cb),
202 g_signal_connect (priv->slave, "preedit-end",
203 G_CALLBACK (gtk_im_multicontext_preedit_end_cb),
205 g_signal_connect (priv->slave, "preedit-changed",
206 G_CALLBACK (gtk_im_multicontext_preedit_changed_cb),
208 g_signal_connect (priv->slave, "commit",
209 G_CALLBACK (gtk_im_multicontext_commit_cb),
211 g_signal_connect (priv->slave, "retrieve-surrounding",
212 G_CALLBACK (gtk_im_multicontext_retrieve_surrounding_cb),
214 g_signal_connect (priv->slave, "delete-surrounding",
215 G_CALLBACK (gtk_im_multicontext_delete_surrounding_cb),
218 if (!priv->use_preedit) /* Default is TRUE */
219 gtk_im_context_set_use_preedit (slave, FALSE);
220 if (priv->client_window)
221 gtk_im_context_set_client_window (slave, priv->client_window);
222 if (priv->have_cursor_location)
223 gtk_im_context_set_cursor_location (slave, &priv->cursor_location);
225 gtk_im_context_focus_in (slave);
228 if (need_preedit_changed)
229 g_signal_emit_by_name (multicontext, "preedit-changed");
233 get_effective_context_id (GtkIMMulticontext *multicontext)
235 GtkIMMulticontextPrivate *priv = multicontext->priv;
237 if (priv->context_id_aux)
238 return priv->context_id_aux;
240 if (!global_context_id)
241 global_context_id = _gtk_im_module_get_default_context_id (priv->client_window);
243 return global_context_id;
246 static GtkIMContext *
247 gtk_im_multicontext_get_slave (GtkIMMulticontext *multicontext)
249 GtkIMMulticontextPrivate *priv = multicontext->priv;
255 g_free (priv->context_id);
257 priv->context_id = g_strdup (get_effective_context_id (multicontext));
259 if (g_strcmp0 (priv->context_id, NONE_ID) == 0)
262 slave = _gtk_im_module_create (priv->context_id);
263 gtk_im_multicontext_set_slave (multicontext, slave, FALSE);
264 g_object_unref (slave);
271 im_module_setting_changed (GtkSettings *settings,
274 global_context_id = NULL;
279 gtk_im_multicontext_set_client_window (GtkIMContext *context,
282 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
283 GtkIMMulticontextPrivate *priv = multicontext->priv;
285 GtkSettings *settings;
288 priv->client_window = window;
292 screen = gdk_drawable_get_screen (GDK_DRAWABLE (window));
293 settings = gtk_settings_get_for_screen (screen);
295 connected = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
296 "gtk-im-module-connected"));
299 g_signal_connect (settings, "notify::gtk-im-module",
300 G_CALLBACK (im_module_setting_changed), NULL);
301 g_object_set_data (G_OBJECT (settings), "gtk-im-module-connected",
302 GINT_TO_POINTER (TRUE));
304 global_context_id = NULL;
308 if (g_strcmp0 (priv->context_id, get_effective_context_id (multicontext)) != 0)
309 gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
312 gtk_im_context_set_client_window (priv->slave, window);
316 gtk_im_multicontext_get_preedit_string (GtkIMContext *context,
318 PangoAttrList **attrs,
321 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
322 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
325 gtk_im_context_get_preedit_string (slave, str, attrs, cursor_pos);
329 *str = g_strdup ("");
331 *attrs = pango_attr_list_new ();
336 gtk_im_multicontext_filter_keypress (GtkIMContext *context,
339 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
340 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
343 return gtk_im_context_filter_keypress (slave, event);
344 else if (event->type == GDK_KEY_PRESS &&
345 (event->state & (GDK_MOD1_MASK | GDK_CONTROL_MASK)) == 0)
349 ch = gdk_keyval_to_unicode (event->keyval);
355 len = g_unichar_to_utf8 (ch, buf);
358 g_signal_emit_by_name (multicontext, "commit", buf);
368 gtk_im_multicontext_focus_in (GtkIMContext *context)
370 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
371 GtkIMMulticontextPrivate *priv = multicontext->priv;
374 if (g_strcmp0 (priv->context_id, get_effective_context_id (multicontext)) != 0)
375 gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
377 slave = gtk_im_multicontext_get_slave (multicontext);
379 priv->focus_in = TRUE;
382 gtk_im_context_focus_in (slave);
386 gtk_im_multicontext_focus_out (GtkIMContext *context)
388 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
389 GtkIMMulticontextPrivate *priv = multicontext->priv;
390 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
392 priv->focus_in = FALSE;
395 gtk_im_context_focus_out (slave);
399 gtk_im_multicontext_reset (GtkIMContext *context)
401 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
402 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
405 gtk_im_context_reset (slave);
409 gtk_im_multicontext_set_cursor_location (GtkIMContext *context,
412 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
413 GtkIMMulticontextPrivate *priv = multicontext->priv;
414 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
416 priv->have_cursor_location = TRUE;
417 priv->cursor_location = *area;
420 gtk_im_context_set_cursor_location (slave, area);
424 gtk_im_multicontext_set_use_preedit (GtkIMContext *context,
425 gboolean use_preedit)
427 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
428 GtkIMMulticontextPrivate *priv = multicontext->priv;
429 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
431 use_preedit = use_preedit != FALSE;
433 priv->use_preedit = use_preedit;
436 gtk_im_context_set_use_preedit (slave, use_preedit);
440 gtk_im_multicontext_get_surrounding (GtkIMContext *context,
444 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
445 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
448 return gtk_im_context_get_surrounding (slave, text, cursor_index);
461 gtk_im_multicontext_set_surrounding (GtkIMContext *context,
466 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
467 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
470 gtk_im_context_set_surrounding (slave, text, len, cursor_index);
474 gtk_im_multicontext_preedit_start_cb (GtkIMContext *slave,
475 GtkIMMulticontext *multicontext)
477 g_signal_emit_by_name (multicontext, "preedit-start");
481 gtk_im_multicontext_preedit_end_cb (GtkIMContext *slave,
482 GtkIMMulticontext *multicontext)
484 g_signal_emit_by_name (multicontext, "preedit-end");
488 gtk_im_multicontext_preedit_changed_cb (GtkIMContext *slave,
489 GtkIMMulticontext *multicontext)
491 g_signal_emit_by_name (multicontext, "preedit-changed");
495 gtk_im_multicontext_commit_cb (GtkIMContext *slave,
497 GtkIMMulticontext *multicontext)
499 g_signal_emit_by_name (multicontext, "commit", str);
503 gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext *slave,
504 GtkIMMulticontext *multicontext)
508 g_signal_emit_by_name (multicontext, "retrieve-surrounding", &result);
514 gtk_im_multicontext_delete_surrounding_cb (GtkIMContext *slave,
517 GtkIMMulticontext *multicontext)
521 g_signal_emit_by_name (multicontext, "delete-surrounding",
522 offset, n_chars, &result);
528 activate_cb (GtkWidget *menuitem,
529 GtkIMMulticontext *context)
531 if (gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (menuitem)))
533 const gchar *id = g_object_get_data (G_OBJECT (menuitem), "gtk-context-id");
535 gtk_im_multicontext_set_context_id (context, id);
540 pathnamecmp (const char *a,
544 return strcmp (a, b);
546 /* Ignore case insensitivity, probably not that relevant here. Just
547 * make sure slash and backslash compare equal.
550 if ((G_IS_DIR_SEPARATOR (*a) && G_IS_DIR_SEPARATOR (*b)) ||
560 * gtk_im_multicontext_append_menuitems:
561 * @context: a #GtkIMMulticontext
562 * @menushell: a #GtkMenuShell
564 * Add menuitems for various available input methods to a menu;
565 * the menuitems, when selected, will switch the input method
566 * for the context and the global default input method.
569 gtk_im_multicontext_append_menuitems (GtkIMMulticontext *context,
570 GtkMenuShell *menushell)
572 GtkIMMulticontextPrivate *priv = context->priv;
573 const GtkIMContextInfo **contexts;
575 GSList *group = NULL;
576 GtkWidget *menuitem, *system_menuitem;
577 const char *system_context_id;
579 system_context_id = _gtk_im_module_get_default_context_id (priv->client_window);
580 system_menuitem = menuitem = gtk_radio_menu_item_new_with_label (group, C_("input method menu", "System"));
581 if (!priv->context_id_aux)
582 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
583 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
584 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NULL);
585 g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
587 gtk_widget_show (menuitem);
588 gtk_menu_shell_append (menushell, menuitem);
590 menuitem = gtk_radio_menu_item_new_with_label (group, C_("input method menu", "None"));
591 if (g_strcmp0 (priv->context_id_aux, NONE_ID) == 0)
592 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
593 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NONE_ID);
594 g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
595 gtk_widget_show (menuitem);
596 gtk_menu_shell_append (menushell, menuitem);
597 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
599 menuitem = gtk_separator_menu_item_new ();
600 gtk_widget_show (menuitem);
601 gtk_menu_shell_append (menushell, menuitem);
603 _gtk_im_module_list (&contexts, &n_contexts);
605 for (i = 0; i < n_contexts; i++)
607 const gchar *translated_name;
609 if (contexts[i]->domain && contexts[i]->domain[0])
611 if (strcmp (contexts[i]->domain, GETTEXT_PACKAGE) == 0)
613 /* Same translation domain as GTK+ */
614 if (!(contexts[i]->domain_dirname && contexts[i]->domain_dirname[0]) ||
615 pathnamecmp (contexts[i]->domain_dirname, GTK_LOCALEDIR) == 0)
617 /* Empty or NULL, domain directory, or same as
618 * GTK+. Input method may have a name in the GTK+
621 translated_name = _(contexts[i]->context_name);
625 /* Separate domain directory but the same
626 * translation domain as GTK+. We can't call
627 * bindtextdomain() as that would make GTK+ forget
630 g_warning ("Input method %s should not use GTK's translation domain %s",
631 contexts[i]->context_id, GETTEXT_PACKAGE);
632 /* Try translating the name in GTK+'s domain */
633 translated_name = _(contexts[i]->context_name);
636 else if (contexts[i]->domain_dirname && contexts[i]->domain_dirname[0])
637 /* Input method has own translation domain and message catalog */
639 bindtextdomain (contexts[i]->domain,
640 contexts[i]->domain_dirname);
641 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
642 bind_textdomain_codeset (contexts[i]->domain, "UTF-8");
644 translated_name = g_dgettext (contexts[i]->domain, contexts[i]->context_name);
648 /* Different translation domain, but no domain directory */
649 translated_name = contexts[i]->context_name;
653 /* Empty or NULL domain. We assume that input method does not
654 * want a translated name in this case.
656 translated_name = contexts[i]->context_name;
658 translated_name = contexts[i]->context_name;
660 menuitem = gtk_radio_menu_item_new_with_label (group,
663 if ((priv->context_id_aux &&
664 strcmp (contexts[i]->context_id, priv->context_id_aux) == 0))
665 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
667 if (strcmp (contexts[i]->context_id, system_context_id) == 0)
672 label = gtk_bin_get_child (GTK_BIN (system_menuitem));
673 text = g_strdup_printf (C_("input method menu", "System (%s)"), translated_name);
674 gtk_label_set_text (GTK_LABEL (label), text);
678 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
680 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"),
681 (char *)contexts[i]->context_id);
682 g_signal_connect (menuitem, "activate",
683 G_CALLBACK (activate_cb), context);
685 gtk_widget_show (menuitem);
686 gtk_menu_shell_append (menushell, menuitem);
693 * gtk_im_multicontext_get_context_id:
694 * @context: a #GtkIMMulticontext
696 * Gets the id of the currently active slave of the @context.
698 * Returns: the id of the currently active slave
703 gtk_im_multicontext_get_context_id (GtkIMMulticontext *context)
705 g_return_val_if_fail (GTK_IS_IM_MULTICONTEXT (context), NULL);
707 return context->priv->context_id;
711 * gtk_im_multicontext_set_context_id:
712 * @context: a #GtkIMMulticontext
713 * @context_id: the id to use
715 * Sets the context id for @context.
717 * This causes the currently active slave of @context to be
718 * replaced by the slave corresponding to the new context id.
723 gtk_im_multicontext_set_context_id (GtkIMMulticontext *context,
724 const char *context_id)
726 GtkIMMulticontextPrivate *priv;
728 g_return_if_fail (GTK_IS_IM_MULTICONTEXT (context));
730 priv = context->priv;
732 gtk_im_context_reset (GTK_IM_CONTEXT (context));
733 g_free (priv->context_id_aux);
734 priv->context_id_aux = g_strdup (context_id);
735 gtk_im_multicontext_set_slave (context, NULL, FALSE);