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, see <http://www.gnu.org/licenses/>.
23 #include "gtkimmulticontext.h"
24 #include "gtkimmoduleprivate.h"
28 #include "gtkprivate.h"
29 #include "gtkradiomenuitem.h"
30 #include "gtkseparatormenuitem.h"
31 #include "gtksettings.h"
35 * SECTION:gtkimmulticontext
36 * @Short_description: An input method context supporting multiple, loadable input methods
37 * @Title: GtkIMMulticontext
41 #define NONE_ID "gtk-im-context-none"
43 struct _GtkIMMulticontextPrivate
47 GdkWindow *client_window;
48 GdkRectangle cursor_location;
51 gchar *context_id_aux;
53 guint use_preedit : 1;
54 guint have_cursor_location : 1;
58 static void gtk_im_multicontext_finalize (GObject *object);
60 static void gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
64 static void gtk_im_multicontext_set_client_window (GtkIMContext *context,
66 static void gtk_im_multicontext_get_preedit_string (GtkIMContext *context,
68 PangoAttrList **attrs,
70 static gboolean gtk_im_multicontext_filter_keypress (GtkIMContext *context,
72 static void gtk_im_multicontext_focus_in (GtkIMContext *context);
73 static void gtk_im_multicontext_focus_out (GtkIMContext *context);
74 static void gtk_im_multicontext_reset (GtkIMContext *context);
75 static void gtk_im_multicontext_set_cursor_location (GtkIMContext *context,
77 static void gtk_im_multicontext_set_use_preedit (GtkIMContext *context,
78 gboolean use_preedit);
79 static gboolean gtk_im_multicontext_get_surrounding (GtkIMContext *context,
82 static void gtk_im_multicontext_set_surrounding (GtkIMContext *context,
87 static void gtk_im_multicontext_preedit_start_cb (GtkIMContext *slave,
88 GtkIMMulticontext *multicontext);
89 static void gtk_im_multicontext_preedit_end_cb (GtkIMContext *slave,
90 GtkIMMulticontext *multicontext);
91 static void gtk_im_multicontext_preedit_changed_cb (GtkIMContext *slave,
92 GtkIMMulticontext *multicontext);
93 static void gtk_im_multicontext_commit_cb (GtkIMContext *slave,
95 GtkIMMulticontext *multicontext);
96 static gboolean gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext *slave,
97 GtkIMMulticontext *multicontext);
98 static gboolean gtk_im_multicontext_delete_surrounding_cb (GtkIMContext *slave,
101 GtkIMMulticontext *multicontext);
103 static const gchar *global_context_id = NULL;
105 G_DEFINE_TYPE (GtkIMMulticontext, gtk_im_multicontext, GTK_TYPE_IM_CONTEXT)
108 gtk_im_multicontext_class_init (GtkIMMulticontextClass *class)
110 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
111 GtkIMContextClass *im_context_class = GTK_IM_CONTEXT_CLASS (class);
113 im_context_class->set_client_window = gtk_im_multicontext_set_client_window;
114 im_context_class->get_preedit_string = gtk_im_multicontext_get_preedit_string;
115 im_context_class->filter_keypress = gtk_im_multicontext_filter_keypress;
116 im_context_class->focus_in = gtk_im_multicontext_focus_in;
117 im_context_class->focus_out = gtk_im_multicontext_focus_out;
118 im_context_class->reset = gtk_im_multicontext_reset;
119 im_context_class->set_cursor_location = gtk_im_multicontext_set_cursor_location;
120 im_context_class->set_use_preedit = gtk_im_multicontext_set_use_preedit;
121 im_context_class->set_surrounding = gtk_im_multicontext_set_surrounding;
122 im_context_class->get_surrounding = gtk_im_multicontext_get_surrounding;
124 gobject_class->finalize = gtk_im_multicontext_finalize;
126 g_type_class_add_private (gobject_class, sizeof (GtkIMMulticontextPrivate));
130 gtk_im_multicontext_init (GtkIMMulticontext *multicontext)
132 GtkIMMulticontextPrivate *priv;
134 multicontext->priv = G_TYPE_INSTANCE_GET_PRIVATE (multicontext, GTK_TYPE_IM_MULTICONTEXT, GtkIMMulticontextPrivate);
135 priv = multicontext->priv;
138 priv->use_preedit = TRUE;
139 priv->have_cursor_location = FALSE;
140 priv->focus_in = FALSE;
144 * gtk_im_multicontext_new:
146 * Creates a new #GtkIMMulticontext.
148 * Returns: a new #GtkIMMulticontext.
151 gtk_im_multicontext_new (void)
153 return g_object_new (GTK_TYPE_IM_MULTICONTEXT, NULL);
157 gtk_im_multicontext_finalize (GObject *object)
159 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (object);
160 GtkIMMulticontextPrivate *priv = multicontext->priv;
162 gtk_im_multicontext_set_slave (multicontext, NULL, TRUE);
163 g_free (priv->context_id);
164 g_free (priv->context_id_aux);
166 G_OBJECT_CLASS (gtk_im_multicontext_parent_class)->finalize (object);
170 gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
174 GtkIMMulticontextPrivate *priv = multicontext->priv;
175 gboolean need_preedit_changed = FALSE;
180 gtk_im_context_reset (priv->slave);
182 g_signal_handlers_disconnect_by_func (priv->slave,
183 gtk_im_multicontext_preedit_start_cb,
185 g_signal_handlers_disconnect_by_func (priv->slave,
186 gtk_im_multicontext_preedit_end_cb,
188 g_signal_handlers_disconnect_by_func (priv->slave,
189 gtk_im_multicontext_preedit_changed_cb,
191 g_signal_handlers_disconnect_by_func (priv->slave,
192 gtk_im_multicontext_commit_cb,
195 g_object_unref (priv->slave);
199 need_preedit_changed = TRUE;
206 g_object_ref (priv->slave);
208 g_signal_connect (priv->slave, "preedit-start",
209 G_CALLBACK (gtk_im_multicontext_preedit_start_cb),
211 g_signal_connect (priv->slave, "preedit-end",
212 G_CALLBACK (gtk_im_multicontext_preedit_end_cb),
214 g_signal_connect (priv->slave, "preedit-changed",
215 G_CALLBACK (gtk_im_multicontext_preedit_changed_cb),
217 g_signal_connect (priv->slave, "commit",
218 G_CALLBACK (gtk_im_multicontext_commit_cb),
220 g_signal_connect (priv->slave, "retrieve-surrounding",
221 G_CALLBACK (gtk_im_multicontext_retrieve_surrounding_cb),
223 g_signal_connect (priv->slave, "delete-surrounding",
224 G_CALLBACK (gtk_im_multicontext_delete_surrounding_cb),
227 if (!priv->use_preedit) /* Default is TRUE */
228 gtk_im_context_set_use_preedit (slave, FALSE);
229 if (priv->client_window)
230 gtk_im_context_set_client_window (slave, priv->client_window);
231 if (priv->have_cursor_location)
232 gtk_im_context_set_cursor_location (slave, &priv->cursor_location);
234 gtk_im_context_focus_in (slave);
237 if (need_preedit_changed)
238 g_signal_emit_by_name (multicontext, "preedit-changed");
242 get_effective_context_id (GtkIMMulticontext *multicontext)
244 GtkIMMulticontextPrivate *priv = multicontext->priv;
246 if (priv->context_id_aux)
247 return priv->context_id_aux;
249 if (!global_context_id)
250 global_context_id = _gtk_im_module_get_default_context_id (priv->client_window);
252 return global_context_id;
255 static GtkIMContext *
256 gtk_im_multicontext_get_slave (GtkIMMulticontext *multicontext)
258 GtkIMMulticontextPrivate *priv = multicontext->priv;
260 if (g_strcmp0 (priv->context_id, get_effective_context_id (multicontext)) != 0)
261 gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
267 g_free (priv->context_id);
269 priv->context_id = g_strdup (get_effective_context_id (multicontext));
271 if (g_strcmp0 (priv->context_id, NONE_ID) == 0)
274 slave = _gtk_im_module_create (priv->context_id);
275 gtk_im_multicontext_set_slave (multicontext, slave, FALSE);
276 g_object_unref (slave);
283 im_module_setting_changed (GtkSettings *settings,
286 global_context_id = NULL;
291 gtk_im_multicontext_set_client_window (GtkIMContext *context,
294 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
295 GtkIMMulticontextPrivate *priv = multicontext->priv;
298 GtkSettings *settings;
301 priv->client_window = window;
305 screen = gdk_window_get_screen (window);
306 settings = gtk_settings_get_for_screen (screen);
308 connected = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
309 "gtk-im-module-connected"));
312 g_signal_connect (settings, "notify::gtk-im-module",
313 G_CALLBACK (im_module_setting_changed), NULL);
314 g_object_set_data (G_OBJECT (settings), "gtk-im-module-connected",
315 GINT_TO_POINTER (TRUE));
317 global_context_id = NULL;
321 slave = gtk_im_multicontext_get_slave (multicontext);
323 gtk_im_context_set_client_window (slave, window);
327 gtk_im_multicontext_get_preedit_string (GtkIMContext *context,
329 PangoAttrList **attrs,
332 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
333 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
336 gtk_im_context_get_preedit_string (slave, str, attrs, cursor_pos);
340 *str = g_strdup ("");
342 *attrs = pango_attr_list_new ();
347 gtk_im_multicontext_filter_keypress (GtkIMContext *context,
350 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
351 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
355 return gtk_im_context_filter_keypress (slave, event);
360 GdkModifierType no_text_input_mask;
362 display = gdk_window_get_display (event->window);
365 gdk_keymap_get_modifier_mask (gdk_keymap_get_for_display (display),
366 GDK_MODIFIER_INTENT_NO_TEXT_INPUT);
368 if (event->type == GDK_KEY_PRESS &&
369 (event->state & no_text_input_mask) == 0)
373 ch = gdk_keyval_to_unicode (event->keyval);
374 if (ch != 0 && !g_unichar_iscntrl (ch))
379 len = g_unichar_to_utf8 (ch, buf);
382 g_signal_emit_by_name (multicontext, "commit", buf);
393 gtk_im_multicontext_focus_in (GtkIMContext *context)
395 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
396 GtkIMMulticontextPrivate *priv = multicontext->priv;
397 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
399 priv->focus_in = TRUE;
402 gtk_im_context_focus_in (slave);
406 gtk_im_multicontext_focus_out (GtkIMContext *context)
408 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
409 GtkIMMulticontextPrivate *priv = multicontext->priv;
410 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
412 priv->focus_in = FALSE;
415 gtk_im_context_focus_out (slave);
419 gtk_im_multicontext_reset (GtkIMContext *context)
421 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
422 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
425 gtk_im_context_reset (slave);
429 gtk_im_multicontext_set_cursor_location (GtkIMContext *context,
432 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
433 GtkIMMulticontextPrivate *priv = multicontext->priv;
434 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
436 priv->have_cursor_location = TRUE;
437 priv->cursor_location = *area;
440 gtk_im_context_set_cursor_location (slave, area);
444 gtk_im_multicontext_set_use_preedit (GtkIMContext *context,
445 gboolean use_preedit)
447 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
448 GtkIMMulticontextPrivate *priv = multicontext->priv;
449 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
451 use_preedit = use_preedit != FALSE;
453 priv->use_preedit = use_preedit;
456 gtk_im_context_set_use_preedit (slave, use_preedit);
460 gtk_im_multicontext_get_surrounding (GtkIMContext *context,
464 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
465 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
468 return gtk_im_context_get_surrounding (slave, text, cursor_index);
481 gtk_im_multicontext_set_surrounding (GtkIMContext *context,
486 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
487 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
490 gtk_im_context_set_surrounding (slave, text, len, cursor_index);
494 gtk_im_multicontext_preedit_start_cb (GtkIMContext *slave,
495 GtkIMMulticontext *multicontext)
497 g_signal_emit_by_name (multicontext, "preedit-start");
501 gtk_im_multicontext_preedit_end_cb (GtkIMContext *slave,
502 GtkIMMulticontext *multicontext)
504 g_signal_emit_by_name (multicontext, "preedit-end");
508 gtk_im_multicontext_preedit_changed_cb (GtkIMContext *slave,
509 GtkIMMulticontext *multicontext)
511 g_signal_emit_by_name (multicontext, "preedit-changed");
515 gtk_im_multicontext_commit_cb (GtkIMContext *slave,
517 GtkIMMulticontext *multicontext)
519 g_signal_emit_by_name (multicontext, "commit", str);
523 gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext *slave,
524 GtkIMMulticontext *multicontext)
528 g_signal_emit_by_name (multicontext, "retrieve-surrounding", &result);
534 gtk_im_multicontext_delete_surrounding_cb (GtkIMContext *slave,
537 GtkIMMulticontext *multicontext)
541 g_signal_emit_by_name (multicontext, "delete-surrounding",
542 offset, n_chars, &result);
548 activate_cb (GtkWidget *menuitem,
549 GtkIMMulticontext *context)
551 if (gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (menuitem)))
553 const gchar *id = g_object_get_data (G_OBJECT (menuitem), "gtk-context-id");
555 gtk_im_multicontext_set_context_id (context, id);
560 pathnamecmp (const char *a,
564 return strcmp (a, b);
566 /* Ignore case insensitivity, probably not that relevant here. Just
567 * make sure slash and backslash compare equal.
570 if ((G_IS_DIR_SEPARATOR (*a) && G_IS_DIR_SEPARATOR (*b)) ||
580 * gtk_im_multicontext_append_menuitems:
581 * @context: a #GtkIMMulticontext
582 * @menushell: a #GtkMenuShell
584 * Add menuitems for various available input methods to a menu;
585 * the menuitems, when selected, will switch the input method
586 * for the context and the global default input method.
589 gtk_im_multicontext_append_menuitems (GtkIMMulticontext *context,
590 GtkMenuShell *menushell)
592 GtkIMMulticontextPrivate *priv = context->priv;
593 const GtkIMContextInfo **contexts;
595 GSList *group = NULL;
596 GtkWidget *menuitem, *system_menuitem;
597 const char *system_context_id;
599 system_context_id = _gtk_im_module_get_default_context_id (priv->client_window);
600 system_menuitem = menuitem = gtk_radio_menu_item_new_with_label (group, C_("input method menu", "System"));
601 if (!priv->context_id_aux)
602 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
603 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
604 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NULL);
605 g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
607 gtk_widget_show (menuitem);
608 gtk_menu_shell_append (menushell, menuitem);
610 menuitem = gtk_radio_menu_item_new_with_label (group, C_("input method menu", "None"));
611 if (g_strcmp0 (priv->context_id_aux, NONE_ID) == 0)
612 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
613 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NONE_ID);
614 g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
615 gtk_widget_show (menuitem);
616 gtk_menu_shell_append (menushell, menuitem);
617 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
619 menuitem = gtk_separator_menu_item_new ();
620 gtk_widget_show (menuitem);
621 gtk_menu_shell_append (menushell, menuitem);
623 _gtk_im_module_list (&contexts, &n_contexts);
625 for (i = 0; i < n_contexts; i++)
627 const gchar *translated_name;
629 if (contexts[i]->domain && contexts[i]->domain[0])
631 if (strcmp (contexts[i]->domain, GETTEXT_PACKAGE) == 0)
633 /* Same translation domain as GTK+ */
634 if (!(contexts[i]->domain_dirname && contexts[i]->domain_dirname[0]) ||
635 pathnamecmp (contexts[i]->domain_dirname, _gtk_get_localedir ()) == 0)
637 /* Empty or NULL, domain directory, or same as
638 * GTK+. Input method may have a name in the GTK+
641 translated_name = _(contexts[i]->context_name);
645 /* Separate domain directory but the same
646 * translation domain as GTK+. We can't call
647 * bindtextdomain() as that would make GTK+ forget
650 g_warning ("Input method %s should not use GTK's translation domain %s",
651 contexts[i]->context_id, GETTEXT_PACKAGE);
652 /* Try translating the name in GTK+'s domain */
653 translated_name = _(contexts[i]->context_name);
656 else if (contexts[i]->domain_dirname && contexts[i]->domain_dirname[0])
657 /* Input method has own translation domain and message catalog */
659 bindtextdomain (contexts[i]->domain,
660 contexts[i]->domain_dirname);
661 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
662 bind_textdomain_codeset (contexts[i]->domain, "UTF-8");
664 translated_name = g_dgettext (contexts[i]->domain, contexts[i]->context_name);
668 /* Different translation domain, but no domain directory */
669 translated_name = contexts[i]->context_name;
673 /* Empty or NULL domain. We assume that input method does not
674 * want a translated name in this case.
676 translated_name = contexts[i]->context_name;
678 translated_name = contexts[i]->context_name;
680 menuitem = gtk_radio_menu_item_new_with_label (group,
683 if ((priv->context_id_aux &&
684 strcmp (contexts[i]->context_id, priv->context_id_aux) == 0))
685 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
687 if (strcmp (contexts[i]->context_id, system_context_id) == 0)
692 label = gtk_bin_get_child (GTK_BIN (system_menuitem));
693 text = g_strdup_printf (C_("input method menu", "System (%s)"), translated_name);
694 gtk_label_set_text (GTK_LABEL (label), text);
698 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
700 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"),
701 (char *)contexts[i]->context_id);
702 g_signal_connect (menuitem, "activate",
703 G_CALLBACK (activate_cb), context);
705 gtk_widget_show (menuitem);
706 gtk_menu_shell_append (menushell, menuitem);
713 * gtk_im_multicontext_get_context_id:
714 * @context: a #GtkIMMulticontext
716 * Gets the id of the currently active slave of the @context.
718 * Returns: the id of the currently active slave
723 gtk_im_multicontext_get_context_id (GtkIMMulticontext *context)
725 g_return_val_if_fail (GTK_IS_IM_MULTICONTEXT (context), NULL);
727 return context->priv->context_id;
731 * gtk_im_multicontext_set_context_id:
732 * @context: a #GtkIMMulticontext
733 * @context_id: the id to use
735 * Sets the context id for @context.
737 * This causes the currently active slave of @context to be
738 * replaced by the slave corresponding to the new context id.
743 gtk_im_multicontext_set_context_id (GtkIMMulticontext *context,
744 const char *context_id)
746 GtkIMMulticontextPrivate *priv;
748 g_return_if_fail (GTK_IS_IM_MULTICONTEXT (context));
750 priv = context->priv;
752 gtk_im_context_reset (GTK_IM_CONTEXT (context));
753 g_free (priv->context_id_aux);
754 priv->context_id_aux = g_strdup (context_id);
755 gtk_im_multicontext_set_slave (context, NULL, FALSE);