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 */
34 * SECTION:gtkimmulticontext
35 * @Short_description: An input method context supporting multiple, loadable input methods
36 * @Title: GtkIMMulticontext
40 #define NONE_ID "gtk-im-context-none"
42 struct _GtkIMMulticontextPrivate
46 GdkWindow *client_window;
47 GdkRectangle cursor_location;
50 gchar *context_id_aux;
52 guint use_preedit : 1;
53 guint have_cursor_location : 1;
57 static void gtk_im_multicontext_finalize (GObject *object);
59 static void gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
63 static void gtk_im_multicontext_set_client_window (GtkIMContext *context,
65 static void gtk_im_multicontext_get_preedit_string (GtkIMContext *context,
67 PangoAttrList **attrs,
69 static gboolean gtk_im_multicontext_filter_keypress (GtkIMContext *context,
71 static void gtk_im_multicontext_focus_in (GtkIMContext *context);
72 static void gtk_im_multicontext_focus_out (GtkIMContext *context);
73 static void gtk_im_multicontext_reset (GtkIMContext *context);
74 static void gtk_im_multicontext_set_cursor_location (GtkIMContext *context,
76 static void gtk_im_multicontext_set_use_preedit (GtkIMContext *context,
77 gboolean use_preedit);
78 static gboolean gtk_im_multicontext_get_surrounding (GtkIMContext *context,
81 static void gtk_im_multicontext_set_surrounding (GtkIMContext *context,
86 static void gtk_im_multicontext_preedit_start_cb (GtkIMContext *slave,
87 GtkIMMulticontext *multicontext);
88 static void gtk_im_multicontext_preedit_end_cb (GtkIMContext *slave,
89 GtkIMMulticontext *multicontext);
90 static void gtk_im_multicontext_preedit_changed_cb (GtkIMContext *slave,
91 GtkIMMulticontext *multicontext);
92 static void gtk_im_multicontext_commit_cb (GtkIMContext *slave,
94 GtkIMMulticontext *multicontext);
95 static gboolean gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext *slave,
96 GtkIMMulticontext *multicontext);
97 static gboolean gtk_im_multicontext_delete_surrounding_cb (GtkIMContext *slave,
100 GtkIMMulticontext *multicontext);
102 static const gchar *global_context_id = NULL;
104 G_DEFINE_TYPE (GtkIMMulticontext, gtk_im_multicontext, GTK_TYPE_IM_CONTEXT)
107 gtk_im_multicontext_class_init (GtkIMMulticontextClass *class)
109 GObjectClass *gobject_class = G_OBJECT_CLASS (class);
110 GtkIMContextClass *im_context_class = GTK_IM_CONTEXT_CLASS (class);
112 im_context_class->set_client_window = gtk_im_multicontext_set_client_window;
113 im_context_class->get_preedit_string = gtk_im_multicontext_get_preedit_string;
114 im_context_class->filter_keypress = gtk_im_multicontext_filter_keypress;
115 im_context_class->focus_in = gtk_im_multicontext_focus_in;
116 im_context_class->focus_out = gtk_im_multicontext_focus_out;
117 im_context_class->reset = gtk_im_multicontext_reset;
118 im_context_class->set_cursor_location = gtk_im_multicontext_set_cursor_location;
119 im_context_class->set_use_preedit = gtk_im_multicontext_set_use_preedit;
120 im_context_class->set_surrounding = gtk_im_multicontext_set_surrounding;
121 im_context_class->get_surrounding = gtk_im_multicontext_get_surrounding;
123 gobject_class->finalize = gtk_im_multicontext_finalize;
125 g_type_class_add_private (gobject_class, sizeof (GtkIMMulticontextPrivate));
129 gtk_im_multicontext_init (GtkIMMulticontext *multicontext)
131 GtkIMMulticontextPrivate *priv;
133 multicontext->priv = G_TYPE_INSTANCE_GET_PRIVATE (multicontext, GTK_TYPE_IM_MULTICONTEXT, GtkIMMulticontextPrivate);
134 priv = multicontext->priv;
137 priv->use_preedit = TRUE;
138 priv->have_cursor_location = FALSE;
139 priv->focus_in = FALSE;
143 * gtk_im_multicontext_new:
145 * Creates a new #GtkIMMulticontext.
147 * Returns: a new #GtkIMMulticontext.
150 gtk_im_multicontext_new (void)
152 return g_object_new (GTK_TYPE_IM_MULTICONTEXT, NULL);
156 gtk_im_multicontext_finalize (GObject *object)
158 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (object);
159 GtkIMMulticontextPrivate *priv = multicontext->priv;
161 gtk_im_multicontext_set_slave (multicontext, NULL, TRUE);
162 g_free (priv->context_id);
163 g_free (priv->context_id_aux);
165 G_OBJECT_CLASS (gtk_im_multicontext_parent_class)->finalize (object);
169 gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
173 GtkIMMulticontextPrivate *priv = multicontext->priv;
174 gboolean need_preedit_changed = FALSE;
179 gtk_im_context_reset (priv->slave);
181 g_signal_handlers_disconnect_by_func (priv->slave,
182 gtk_im_multicontext_preedit_start_cb,
184 g_signal_handlers_disconnect_by_func (priv->slave,
185 gtk_im_multicontext_preedit_end_cb,
187 g_signal_handlers_disconnect_by_func (priv->slave,
188 gtk_im_multicontext_preedit_changed_cb,
190 g_signal_handlers_disconnect_by_func (priv->slave,
191 gtk_im_multicontext_commit_cb,
194 g_object_unref (priv->slave);
198 need_preedit_changed = TRUE;
205 g_object_ref (priv->slave);
207 g_signal_connect (priv->slave, "preedit-start",
208 G_CALLBACK (gtk_im_multicontext_preedit_start_cb),
210 g_signal_connect (priv->slave, "preedit-end",
211 G_CALLBACK (gtk_im_multicontext_preedit_end_cb),
213 g_signal_connect (priv->slave, "preedit-changed",
214 G_CALLBACK (gtk_im_multicontext_preedit_changed_cb),
216 g_signal_connect (priv->slave, "commit",
217 G_CALLBACK (gtk_im_multicontext_commit_cb),
219 g_signal_connect (priv->slave, "retrieve-surrounding",
220 G_CALLBACK (gtk_im_multicontext_retrieve_surrounding_cb),
222 g_signal_connect (priv->slave, "delete-surrounding",
223 G_CALLBACK (gtk_im_multicontext_delete_surrounding_cb),
226 if (!priv->use_preedit) /* Default is TRUE */
227 gtk_im_context_set_use_preedit (slave, FALSE);
228 if (priv->client_window)
229 gtk_im_context_set_client_window (slave, priv->client_window);
230 if (priv->have_cursor_location)
231 gtk_im_context_set_cursor_location (slave, &priv->cursor_location);
233 gtk_im_context_focus_in (slave);
236 if (need_preedit_changed)
237 g_signal_emit_by_name (multicontext, "preedit-changed");
241 get_effective_context_id (GtkIMMulticontext *multicontext)
243 GtkIMMulticontextPrivate *priv = multicontext->priv;
245 if (priv->context_id_aux)
246 return priv->context_id_aux;
248 if (!global_context_id)
249 global_context_id = _gtk_im_module_get_default_context_id (priv->client_window);
251 return global_context_id;
254 static GtkIMContext *
255 gtk_im_multicontext_get_slave (GtkIMMulticontext *multicontext)
257 GtkIMMulticontextPrivate *priv = multicontext->priv;
263 g_free (priv->context_id);
265 priv->context_id = g_strdup (get_effective_context_id (multicontext));
267 if (g_strcmp0 (priv->context_id, NONE_ID) == 0)
270 slave = _gtk_im_module_create (priv->context_id);
271 gtk_im_multicontext_set_slave (multicontext, slave, FALSE);
272 g_object_unref (slave);
279 im_module_setting_changed (GtkSettings *settings,
282 global_context_id = NULL;
287 gtk_im_multicontext_set_client_window (GtkIMContext *context,
290 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
291 GtkIMMulticontextPrivate *priv = multicontext->priv;
293 GtkSettings *settings;
296 priv->client_window = window;
300 screen = gdk_window_get_screen (window);
301 settings = gtk_settings_get_for_screen (screen);
303 connected = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
304 "gtk-im-module-connected"));
307 g_signal_connect (settings, "notify::gtk-im-module",
308 G_CALLBACK (im_module_setting_changed), NULL);
309 g_object_set_data (G_OBJECT (settings), "gtk-im-module-connected",
310 GINT_TO_POINTER (TRUE));
312 global_context_id = NULL;
316 if (g_strcmp0 (priv->context_id, get_effective_context_id (multicontext)) != 0)
317 gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
320 gtk_im_context_set_client_window (priv->slave, window);
324 gtk_im_multicontext_get_preedit_string (GtkIMContext *context,
326 PangoAttrList **attrs,
329 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
330 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
333 gtk_im_context_get_preedit_string (slave, str, attrs, cursor_pos);
337 *str = g_strdup ("");
339 *attrs = pango_attr_list_new ();
344 gtk_im_multicontext_filter_keypress (GtkIMContext *context,
347 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
348 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
352 return gtk_im_context_filter_keypress (slave, event);
357 GdkModifierType no_text_input_mask;
359 display = gdk_window_get_display (event->window);
362 gdk_keymap_get_modifier_mask (gdk_keymap_get_for_display (display),
363 GDK_MODIFIER_INTENT_NO_TEXT_INPUT);
365 if (event->type == GDK_KEY_PRESS &&
366 (event->state & no_text_input_mask) == 0)
370 ch = gdk_keyval_to_unicode (event->keyval);
371 if (ch != 0 && !g_unichar_iscntrl (ch))
376 len = g_unichar_to_utf8 (ch, buf);
379 g_signal_emit_by_name (multicontext, "commit", buf);
390 gtk_im_multicontext_focus_in (GtkIMContext *context)
392 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
393 GtkIMMulticontextPrivate *priv = multicontext->priv;
396 if (g_strcmp0 (priv->context_id, get_effective_context_id (multicontext)) != 0)
397 gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
399 slave = gtk_im_multicontext_get_slave (multicontext);
401 priv->focus_in = TRUE;
404 gtk_im_context_focus_in (slave);
408 gtk_im_multicontext_focus_out (GtkIMContext *context)
410 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
411 GtkIMMulticontextPrivate *priv = multicontext->priv;
412 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
414 priv->focus_in = FALSE;
417 gtk_im_context_focus_out (slave);
421 gtk_im_multicontext_reset (GtkIMContext *context)
423 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
424 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
427 gtk_im_context_reset (slave);
431 gtk_im_multicontext_set_cursor_location (GtkIMContext *context,
434 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
435 GtkIMMulticontextPrivate *priv = multicontext->priv;
436 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
438 priv->have_cursor_location = TRUE;
439 priv->cursor_location = *area;
442 gtk_im_context_set_cursor_location (slave, area);
446 gtk_im_multicontext_set_use_preedit (GtkIMContext *context,
447 gboolean use_preedit)
449 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
450 GtkIMMulticontextPrivate *priv = multicontext->priv;
451 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
453 use_preedit = use_preedit != FALSE;
455 priv->use_preedit = use_preedit;
458 gtk_im_context_set_use_preedit (slave, use_preedit);
462 gtk_im_multicontext_get_surrounding (GtkIMContext *context,
466 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
467 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
470 return gtk_im_context_get_surrounding (slave, text, cursor_index);
483 gtk_im_multicontext_set_surrounding (GtkIMContext *context,
488 GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
489 GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
492 gtk_im_context_set_surrounding (slave, text, len, cursor_index);
496 gtk_im_multicontext_preedit_start_cb (GtkIMContext *slave,
497 GtkIMMulticontext *multicontext)
499 g_signal_emit_by_name (multicontext, "preedit-start");
503 gtk_im_multicontext_preedit_end_cb (GtkIMContext *slave,
504 GtkIMMulticontext *multicontext)
506 g_signal_emit_by_name (multicontext, "preedit-end");
510 gtk_im_multicontext_preedit_changed_cb (GtkIMContext *slave,
511 GtkIMMulticontext *multicontext)
513 g_signal_emit_by_name (multicontext, "preedit-changed");
517 gtk_im_multicontext_commit_cb (GtkIMContext *slave,
519 GtkIMMulticontext *multicontext)
521 g_signal_emit_by_name (multicontext, "commit", str);
525 gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext *slave,
526 GtkIMMulticontext *multicontext)
530 g_signal_emit_by_name (multicontext, "retrieve-surrounding", &result);
536 gtk_im_multicontext_delete_surrounding_cb (GtkIMContext *slave,
539 GtkIMMulticontext *multicontext)
543 g_signal_emit_by_name (multicontext, "delete-surrounding",
544 offset, n_chars, &result);
550 activate_cb (GtkWidget *menuitem,
551 GtkIMMulticontext *context)
553 if (gtk_check_menu_item_get_active (GTK_CHECK_MENU_ITEM (menuitem)))
555 const gchar *id = g_object_get_data (G_OBJECT (menuitem), "gtk-context-id");
557 gtk_im_multicontext_set_context_id (context, id);
562 pathnamecmp (const char *a,
566 return strcmp (a, b);
568 /* Ignore case insensitivity, probably not that relevant here. Just
569 * make sure slash and backslash compare equal.
572 if ((G_IS_DIR_SEPARATOR (*a) && G_IS_DIR_SEPARATOR (*b)) ||
582 * gtk_im_multicontext_append_menuitems:
583 * @context: a #GtkIMMulticontext
584 * @menushell: a #GtkMenuShell
586 * Add menuitems for various available input methods to a menu;
587 * the menuitems, when selected, will switch the input method
588 * for the context and the global default input method.
591 gtk_im_multicontext_append_menuitems (GtkIMMulticontext *context,
592 GtkMenuShell *menushell)
594 GtkIMMulticontextPrivate *priv = context->priv;
595 const GtkIMContextInfo **contexts;
597 GSList *group = NULL;
598 GtkWidget *menuitem, *system_menuitem;
599 const char *system_context_id;
601 system_context_id = _gtk_im_module_get_default_context_id (priv->client_window);
602 system_menuitem = menuitem = gtk_radio_menu_item_new_with_label (group, C_("input method menu", "System"));
603 if (!priv->context_id_aux)
604 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
605 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
606 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NULL);
607 g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
609 gtk_widget_show (menuitem);
610 gtk_menu_shell_append (menushell, menuitem);
612 menuitem = gtk_radio_menu_item_new_with_label (group, C_("input method menu", "None"));
613 if (g_strcmp0 (priv->context_id_aux, NONE_ID) == 0)
614 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
615 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NONE_ID);
616 g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
617 gtk_widget_show (menuitem);
618 gtk_menu_shell_append (menushell, menuitem);
619 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
621 menuitem = gtk_separator_menu_item_new ();
622 gtk_widget_show (menuitem);
623 gtk_menu_shell_append (menushell, menuitem);
625 _gtk_im_module_list (&contexts, &n_contexts);
627 for (i = 0; i < n_contexts; i++)
629 const gchar *translated_name;
631 if (contexts[i]->domain && contexts[i]->domain[0])
633 if (strcmp (contexts[i]->domain, GETTEXT_PACKAGE) == 0)
635 /* Same translation domain as GTK+ */
636 if (!(contexts[i]->domain_dirname && contexts[i]->domain_dirname[0]) ||
637 pathnamecmp (contexts[i]->domain_dirname, GTK_LOCALEDIR) == 0)
639 /* Empty or NULL, domain directory, or same as
640 * GTK+. Input method may have a name in the GTK+
643 translated_name = _(contexts[i]->context_name);
647 /* Separate domain directory but the same
648 * translation domain as GTK+. We can't call
649 * bindtextdomain() as that would make GTK+ forget
652 g_warning ("Input method %s should not use GTK's translation domain %s",
653 contexts[i]->context_id, GETTEXT_PACKAGE);
654 /* Try translating the name in GTK+'s domain */
655 translated_name = _(contexts[i]->context_name);
658 else if (contexts[i]->domain_dirname && contexts[i]->domain_dirname[0])
659 /* Input method has own translation domain and message catalog */
661 bindtextdomain (contexts[i]->domain,
662 contexts[i]->domain_dirname);
663 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
664 bind_textdomain_codeset (contexts[i]->domain, "UTF-8");
666 translated_name = g_dgettext (contexts[i]->domain, contexts[i]->context_name);
670 /* Different translation domain, but no domain directory */
671 translated_name = contexts[i]->context_name;
675 /* Empty or NULL domain. We assume that input method does not
676 * want a translated name in this case.
678 translated_name = contexts[i]->context_name;
680 translated_name = contexts[i]->context_name;
682 menuitem = gtk_radio_menu_item_new_with_label (group,
685 if ((priv->context_id_aux &&
686 strcmp (contexts[i]->context_id, priv->context_id_aux) == 0))
687 gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
689 if (strcmp (contexts[i]->context_id, system_context_id) == 0)
694 label = gtk_bin_get_child (GTK_BIN (system_menuitem));
695 text = g_strdup_printf (C_("input method menu", "System (%s)"), translated_name);
696 gtk_label_set_text (GTK_LABEL (label), text);
700 group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
702 g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"),
703 (char *)contexts[i]->context_id);
704 g_signal_connect (menuitem, "activate",
705 G_CALLBACK (activate_cb), context);
707 gtk_widget_show (menuitem);
708 gtk_menu_shell_append (menushell, menuitem);
715 * gtk_im_multicontext_get_context_id:
716 * @context: a #GtkIMMulticontext
718 * Gets the id of the currently active slave of the @context.
720 * Returns: the id of the currently active slave
725 gtk_im_multicontext_get_context_id (GtkIMMulticontext *context)
727 g_return_val_if_fail (GTK_IS_IM_MULTICONTEXT (context), NULL);
729 return context->priv->context_id;
733 * gtk_im_multicontext_set_context_id:
734 * @context: a #GtkIMMulticontext
735 * @context_id: the id to use
737 * Sets the context id for @context.
739 * This causes the currently active slave of @context to be
740 * replaced by the slave corresponding to the new context id.
745 gtk_im_multicontext_set_context_id (GtkIMMulticontext *context,
746 const char *context_id)
748 GtkIMMulticontextPrivate *priv;
750 g_return_if_fail (GTK_IS_IM_MULTICONTEXT (context));
752 priv = context->priv;
754 gtk_im_context_reset (GTK_IM_CONTEXT (context));
755 g_free (priv->context_id_aux);
756 priv->context_id_aux = g_strdup (context_id);
757 gtk_im_multicontext_set_slave (context, NULL, FALSE);