]> Pileus Git - ~andy/gtk/blob - gtk/gtkimmulticontext.c
f33a6cc7506074776251a318f14cd569d5f2cb33
[~andy/gtk] / gtk / gtkimmulticontext.c
1 /* GTK - The GIMP Toolkit
2  * Copyright (C) 2000 Red Hat, Inc.
3  *
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.
8  *
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.
13  *
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.
18  */
19
20 #include "config.h"
21
22 #include <string.h>
23 #include <locale.h>
24
25 #include "gtkimmulticontext.h"
26 #include "gtkimmodule.h"
27 #include "gtkmain.h"
28 #include "gtkradiomenuitem.h"
29 #include "gtkintl.h"
30 #include "gtkprivate.h" /* To get redefinition of GTK_LOCALE_DIR on Win32 */
31 #include "gtkalias.h"
32
33 struct _GtkIMMulticontextPrivate
34 {
35   GdkWindow *client_window;
36   GdkRectangle cursor_location;
37
38   guint use_preedit : 1;
39   guint have_cursor_location : 1;
40   guint focus_in : 1;
41 };
42
43 static void     gtk_im_multicontext_finalize           (GObject                 *object);
44
45 static void     gtk_im_multicontext_set_slave          (GtkIMMulticontext       *multicontext,
46                                                         GtkIMContext            *slave,
47                                                         gboolean                 finalizing);
48
49 static void     gtk_im_multicontext_set_client_window  (GtkIMContext            *context,
50                                                         GdkWindow               *window);
51 static void     gtk_im_multicontext_get_preedit_string (GtkIMContext            *context,
52                                                         gchar                  **str,
53                                                         PangoAttrList          **attrs,
54                                                         gint                   *cursor_pos);
55 static gboolean gtk_im_multicontext_filter_keypress    (GtkIMContext            *context,
56                                                         GdkEventKey             *event);
57 static void     gtk_im_multicontext_focus_in           (GtkIMContext            *context);
58 static void     gtk_im_multicontext_focus_out          (GtkIMContext            *context);
59 static void     gtk_im_multicontext_reset              (GtkIMContext            *context);
60 static void     gtk_im_multicontext_set_cursor_location (GtkIMContext            *context,
61                                                         GdkRectangle            *area);
62 static void     gtk_im_multicontext_set_use_preedit    (GtkIMContext            *context,
63                                                         gboolean                 use_preedit);
64 static gboolean gtk_im_multicontext_get_surrounding    (GtkIMContext            *context,
65                                                         gchar                  **text,
66                                                         gint                    *cursor_index);
67 static void     gtk_im_multicontext_set_surrounding    (GtkIMContext            *context,
68                                                         const char              *text,
69                                                         gint                     len,
70                                                         gint                     cursor_index);
71
72 static void     gtk_im_multicontext_preedit_start_cb        (GtkIMContext      *slave,
73                                                              GtkIMMulticontext *multicontext);
74 static void     gtk_im_multicontext_preedit_end_cb          (GtkIMContext      *slave,
75                                                              GtkIMMulticontext *multicontext);
76 static void     gtk_im_multicontext_preedit_changed_cb      (GtkIMContext      *slave,
77                                                              GtkIMMulticontext *multicontext);
78 static void     gtk_im_multicontext_commit_cb               (GtkIMContext      *slave,
79                                                              const gchar       *str,
80                                                              GtkIMMulticontext *multicontext);
81 static gboolean gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext      *slave,
82                                                              GtkIMMulticontext *multicontext);
83 static gboolean gtk_im_multicontext_delete_surrounding_cb   (GtkIMContext      *slave,
84                                                              gint               offset,
85                                                              gint               n_chars,
86                                                              GtkIMMulticontext *multicontext);
87
88 static const gchar *user_context_id = NULL;
89 static const gchar *global_context_id = NULL;
90
91 G_DEFINE_TYPE (GtkIMMulticontext, gtk_im_multicontext, GTK_TYPE_IM_CONTEXT)
92
93 static void
94 gtk_im_multicontext_class_init (GtkIMMulticontextClass *class)
95 {
96   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
97   GtkIMContextClass *im_context_class = GTK_IM_CONTEXT_CLASS (class);
98   
99   im_context_class->set_client_window = gtk_im_multicontext_set_client_window;
100   im_context_class->get_preedit_string = gtk_im_multicontext_get_preedit_string;
101   im_context_class->filter_keypress = gtk_im_multicontext_filter_keypress;
102   im_context_class->focus_in = gtk_im_multicontext_focus_in;
103   im_context_class->focus_out = gtk_im_multicontext_focus_out;
104   im_context_class->reset = gtk_im_multicontext_reset;
105   im_context_class->set_cursor_location = gtk_im_multicontext_set_cursor_location;
106   im_context_class->set_use_preedit = gtk_im_multicontext_set_use_preedit;
107   im_context_class->set_surrounding = gtk_im_multicontext_set_surrounding;
108   im_context_class->get_surrounding = gtk_im_multicontext_get_surrounding;
109
110   gobject_class->finalize = gtk_im_multicontext_finalize;
111
112   g_type_class_add_private (gobject_class, sizeof (GtkIMMulticontextPrivate));   
113 }
114
115 static void
116 gtk_im_multicontext_init (GtkIMMulticontext *multicontext)
117 {
118   multicontext->slave = NULL;
119   
120   multicontext->priv = G_TYPE_INSTANCE_GET_PRIVATE (multicontext, GTK_TYPE_IM_MULTICONTEXT, GtkIMMulticontextPrivate);
121   multicontext->priv->use_preedit = TRUE;
122   multicontext->priv->have_cursor_location = FALSE;
123   multicontext->priv->focus_in = FALSE;
124 }
125
126 /**
127  * gtk_im_multicontext_new:
128  *
129  * Creates a new #GtkIMMulticontext.
130  *
131  * Returns: a new #GtkIMMulticontext.
132  **/
133 GtkIMContext *
134 gtk_im_multicontext_new (void)
135 {
136   return g_object_new (GTK_TYPE_IM_MULTICONTEXT, NULL);
137 }
138
139 static void
140 gtk_im_multicontext_finalize (GObject *object)
141 {
142   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (object);
143   
144   gtk_im_multicontext_set_slave (multicontext, NULL, TRUE);
145   g_free (multicontext->context_id);
146
147   G_OBJECT_CLASS (gtk_im_multicontext_parent_class)->finalize (object);
148 }
149
150 static void
151 gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
152                                GtkIMContext      *slave,
153                                gboolean           finalizing)
154 {
155   GtkIMMulticontextPrivate *priv = multicontext->priv;
156   gboolean need_preedit_changed = FALSE;
157   
158   if (multicontext->slave)
159     {
160       if (!finalizing)
161         gtk_im_context_reset (multicontext->slave);
162       
163       g_signal_handlers_disconnect_by_func (multicontext->slave,
164                                             gtk_im_multicontext_preedit_start_cb,
165                                             multicontext);
166       g_signal_handlers_disconnect_by_func (multicontext->slave,
167                                             gtk_im_multicontext_preedit_end_cb,
168                                             multicontext);
169       g_signal_handlers_disconnect_by_func (multicontext->slave,
170                                             gtk_im_multicontext_preedit_changed_cb,
171                                             multicontext);
172       g_signal_handlers_disconnect_by_func (multicontext->slave,
173                                             gtk_im_multicontext_commit_cb,
174                                             multicontext);
175
176       g_object_unref (multicontext->slave);
177       multicontext->slave = NULL;
178
179       if (!finalizing)
180         need_preedit_changed = TRUE;
181     }
182   
183   multicontext->slave = slave;
184
185   if (multicontext->slave)
186     {
187       g_object_ref (multicontext->slave);
188
189       g_signal_connect (multicontext->slave, "preedit-start",
190                         G_CALLBACK (gtk_im_multicontext_preedit_start_cb),
191                         multicontext);
192       g_signal_connect (multicontext->slave, "preedit-end",
193                         G_CALLBACK (gtk_im_multicontext_preedit_end_cb),
194                         multicontext);
195       g_signal_connect (multicontext->slave, "preedit-changed",
196                         G_CALLBACK (gtk_im_multicontext_preedit_changed_cb),
197                         multicontext);
198       g_signal_connect (multicontext->slave, "commit",
199                         G_CALLBACK (gtk_im_multicontext_commit_cb),
200                         multicontext);
201       g_signal_connect (multicontext->slave, "retrieve-surrounding",
202                         G_CALLBACK (gtk_im_multicontext_retrieve_surrounding_cb),
203                         multicontext);
204       g_signal_connect (multicontext->slave, "delete-surrounding",
205                         G_CALLBACK (gtk_im_multicontext_delete_surrounding_cb),
206                         multicontext);
207       
208       if (!priv->use_preedit)   /* Default is TRUE */
209         gtk_im_context_set_use_preedit (slave, FALSE);
210       if (priv->client_window)
211         gtk_im_context_set_client_window (slave, priv->client_window);
212       if (priv->have_cursor_location)
213         gtk_im_context_set_cursor_location (slave, &priv->cursor_location);
214       if (priv->focus_in)
215         gtk_im_context_focus_in (slave);
216     }
217
218   if (need_preedit_changed)
219     g_signal_emit_by_name (multicontext, "preedit-changed");
220 }
221
222 static GtkIMContext *
223 gtk_im_multicontext_get_slave (GtkIMMulticontext *multicontext)
224 {
225   if (!multicontext->slave)
226     {
227       GtkIMContext *slave;
228
229       if (!global_context_id) 
230         {
231           if (user_context_id)
232             global_context_id = user_context_id;
233           else
234             global_context_id = _gtk_im_module_get_default_context_id (multicontext->priv->client_window);
235         }
236       slave = _gtk_im_module_create (global_context_id);
237       gtk_im_multicontext_set_slave (multicontext, slave, FALSE);
238       g_object_unref (slave);
239
240       g_free (multicontext->context_id);
241       multicontext->context_id = g_strdup (global_context_id);
242     }
243
244   return multicontext->slave;
245 }
246
247 static void
248 im_module_setting_changed (GtkSettings *settings, 
249                            gpointer     data)
250 {
251   global_context_id = NULL;
252 }
253
254
255 static void
256 gtk_im_multicontext_set_client_window (GtkIMContext *context,
257                                        GdkWindow    *window)
258 {
259   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
260   GtkIMContext *slave; 
261   GdkScreen *screen; 
262   GtkSettings *settings;
263   gboolean connected;
264
265   multicontext->priv->client_window = window;
266
267   slave = gtk_im_multicontext_get_slave (multicontext);
268
269   if (slave)
270     gtk_im_context_set_client_window (slave, window);
271
272   if (window == NULL) 
273     return;
274    
275   screen = gdk_drawable_get_screen (GDK_DRAWABLE (window));
276   if (screen)
277     settings = gtk_settings_get_for_screen (screen);
278   else
279     settings = gtk_settings_get_default ();
280
281   connected = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
282                                                   "gtk-im-module-connected"));
283   if (!connected) 
284     {
285       g_signal_connect (settings, "notify::gtk-im-module",
286                         G_CALLBACK (im_module_setting_changed), NULL);
287       g_object_set_data (G_OBJECT (settings), "gtk-im-module-connected",
288                          GINT_TO_POINTER (TRUE));
289
290       global_context_id = NULL;  
291     }
292 }
293
294 static void
295 gtk_im_multicontext_get_preedit_string (GtkIMContext   *context,
296                                         gchar         **str,
297                                         PangoAttrList **attrs,
298                                         gint           *cursor_pos)
299 {
300   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
301   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
302
303   if (slave)
304     gtk_im_context_get_preedit_string (slave, str, attrs, cursor_pos);
305   else
306     {
307       if (str)
308         *str = g_strdup ("");
309       if (attrs)
310         *attrs = pango_attr_list_new ();
311     }
312 }
313
314 static gboolean
315 gtk_im_multicontext_filter_keypress (GtkIMContext *context,
316                                      GdkEventKey  *event)
317 {
318   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
319   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
320
321   if (slave)
322     return gtk_im_context_filter_keypress (slave, event);
323   else
324     return FALSE;
325 }
326
327 static void
328 gtk_im_multicontext_focus_in (GtkIMContext   *context)
329 {
330   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
331   GtkIMContext *slave;
332
333   /* If the global context type is different from the context we were
334    * using before, get rid of the old slave and create a new one
335    * for the new global context type.
336    */
337   if (multicontext->context_id == NULL || 
338       global_context_id == NULL ||
339       strcmp (global_context_id, multicontext->context_id) != 0)
340     gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
341
342   slave = gtk_im_multicontext_get_slave (multicontext);
343   
344   multicontext->priv->focus_in = TRUE;
345   
346   if (slave)
347     gtk_im_context_focus_in (slave);
348 }
349
350 static void
351 gtk_im_multicontext_focus_out (GtkIMContext   *context)
352 {
353   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
354   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
355
356   multicontext->priv->focus_in = FALSE;
357   
358   if (slave)
359     gtk_im_context_focus_out (slave);
360 }
361
362 static void
363 gtk_im_multicontext_reset (GtkIMContext   *context)
364 {
365   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
366   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
367
368   if (slave)
369     gtk_im_context_reset (slave);
370 }
371
372 static void
373 gtk_im_multicontext_set_cursor_location (GtkIMContext   *context,
374                                          GdkRectangle   *area)
375 {
376   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
377   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
378
379   multicontext->priv->have_cursor_location = TRUE;
380   multicontext->priv->cursor_location = *area;
381
382   if (slave)
383     gtk_im_context_set_cursor_location (slave, area);
384 }
385
386 static void
387 gtk_im_multicontext_set_use_preedit (GtkIMContext   *context,
388                                      gboolean       use_preedit)
389 {
390   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
391   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
392
393   use_preedit = use_preedit != FALSE;
394
395   multicontext->priv->use_preedit = use_preedit;
396
397   if (slave)
398     gtk_im_context_set_use_preedit (slave, use_preedit);
399 }
400
401 static gboolean
402 gtk_im_multicontext_get_surrounding (GtkIMContext  *context,
403                                      gchar        **text,
404                                      gint          *cursor_index)
405 {
406   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
407   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
408
409   if (slave)
410     return gtk_im_context_get_surrounding (slave, text, cursor_index);
411   else
412     {
413       if (text)
414         *text = NULL;
415       if (cursor_index)
416         *cursor_index = 0;
417
418       return FALSE;
419     }
420 }
421
422 static void
423 gtk_im_multicontext_set_surrounding (GtkIMContext *context,
424                                      const char   *text,
425                                      gint          len,
426                                      gint          cursor_index)
427 {
428   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
429   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
430
431   if (slave)
432     gtk_im_context_set_surrounding (slave, text, len, cursor_index);
433 }
434
435 static void
436 gtk_im_multicontext_preedit_start_cb   (GtkIMContext      *slave,
437                                         GtkIMMulticontext *multicontext)
438 {
439   g_signal_emit_by_name (multicontext, "preedit-start");
440 }
441
442 static void
443 gtk_im_multicontext_preedit_end_cb (GtkIMContext      *slave,
444                                     GtkIMMulticontext *multicontext)
445 {
446   g_signal_emit_by_name (multicontext, "preedit-end");
447 }
448
449 static void
450 gtk_im_multicontext_preedit_changed_cb (GtkIMContext      *slave,
451                                         GtkIMMulticontext *multicontext)
452 {
453   g_signal_emit_by_name (multicontext, "preedit-changed");
454 }
455
456 static void
457 gtk_im_multicontext_commit_cb (GtkIMContext      *slave,
458                                const gchar       *str,
459                                GtkIMMulticontext *multicontext)
460 {
461   g_signal_emit_by_name (multicontext, "commit", str);;
462 }
463
464 static gboolean
465 gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext      *slave,
466                                              GtkIMMulticontext *multicontext)
467 {
468   gboolean result;
469   
470   g_signal_emit_by_name (multicontext, "retrieve-surrounding", &result);
471
472   return result;
473 }
474
475 static gboolean
476 gtk_im_multicontext_delete_surrounding_cb (GtkIMContext      *slave,
477                                            gint               offset,
478                                            gint               n_chars,
479                                            GtkIMMulticontext *multicontext)
480 {
481   gboolean result;
482   
483   g_signal_emit_by_name (multicontext, "delete-surrounding",
484                          offset, n_chars, &result);
485
486   return result;
487 }
488
489 static void
490 activate_cb (GtkWidget         *menuitem,
491              GtkIMMulticontext *context)
492 {
493   if (GTK_CHECK_MENU_ITEM (menuitem)->active)
494     {
495       const gchar *id = g_object_get_data (G_OBJECT (menuitem), "gtk-context-id");
496
497       gtk_im_context_reset (GTK_IM_CONTEXT (context));
498       
499       user_context_id = id;
500       global_context_id = NULL;
501       gtk_im_multicontext_set_slave (context, NULL, FALSE);
502     }
503 }
504
505 static int
506 pathnamecmp (const char *a,
507              const char *b)
508 {
509 #ifndef G_OS_WIN32
510   return strcmp (a, b);
511 #else
512   /* Ignore case insensitivity, probably not that relevant here. Just
513    * make sure slash and backslash compare equal.
514    */
515   while (*a && *b)
516     if ((G_IS_DIR_SEPARATOR (*a) && G_IS_DIR_SEPARATOR (*b)) ||
517         *a == *b)
518       a++, b++;
519     else
520       return (*a - *b);
521   return (*a - *b);
522 #endif
523 }
524
525 /**
526  * gtk_im_multicontext_append_menuitems:
527  * @context: a #GtkIMMultiContext
528  * @menushell: a #GtkMenuShell
529  * 
530  * Add menuitems for various available input methods to a menu;
531  * the menuitems, when selected, will switch the input method
532  * for the context and the global default input method.
533  **/
534 void
535 gtk_im_multicontext_append_menuitems (GtkIMMulticontext *context,
536                                       GtkMenuShell      *menushell)
537 {
538   const GtkIMContextInfo **contexts;
539   guint n_contexts, i;
540   GSList *group = NULL;
541   GtkWidget *menuitem;
542   
543   menuitem = gtk_radio_menu_item_new_with_label (group, Q_("input method menu|System"));
544   if (!user_context_id)
545     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
546   group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
547   g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NULL);
548   g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
549
550   gtk_widget_show (menuitem);
551   gtk_menu_shell_append (menushell, menuitem);
552
553   _gtk_im_module_list (&contexts, &n_contexts);
554
555   for (i = 0; i < n_contexts; i++)
556     {
557       const gchar *translated_name;
558 #ifdef ENABLE_NLS
559       if (contexts[i]->domain && contexts[i]->domain[0])
560         {
561           if (strcmp (contexts[i]->domain, GETTEXT_PACKAGE) == 0)
562             {
563               /* Same translation domain as GTK+ */
564               if (!(contexts[i]->domain_dirname && contexts[i]->domain_dirname[0]) ||
565                   pathnamecmp (contexts[i]->domain_dirname, GTK_LOCALEDIR) == 0)
566                 {
567                   /* Empty or NULL, domain directory, or same as
568                    * GTK+. Input method may have a name in the GTK+
569                    * message catalog.
570                    */
571                   translated_name = _(contexts[i]->context_name);
572                 }
573               else
574                 {
575                   /* Separate domain directory but the same
576                    * translation domain as GTK+. We can't call
577                    * bindtextdomain() as that would make GTK+ forget
578                    * its own messages.
579                    */
580                   g_warning ("Input method %s should not use GTK's translation domain %s",
581                              contexts[i]->context_id, GETTEXT_PACKAGE);
582                   /* Try translating the name in GTK+'s domain */
583                   translated_name = _(contexts[i]->context_name);
584                 }
585             }
586           else if (contexts[i]->domain_dirname && contexts[i]->domain_dirname[0])
587             /* Input method has own translation domain and message catalog */
588             {
589               bindtextdomain (contexts[i]->domain,
590                               contexts[i]->domain_dirname);
591 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
592               bind_textdomain_codeset (contexts[i]->domain, "UTF-8");
593 #endif
594               translated_name = g_dgettext (contexts[i]->domain, contexts[i]->context_name);
595             }
596           else
597             {
598               /* Different translation domain, but no domain directory */
599               translated_name = contexts[i]->context_name;
600             }
601         }
602       else
603         /* Empty or NULL domain. We assume that input method does not
604          * want a translated name in this case.
605          */
606         translated_name = contexts[i]->context_name;
607 #else
608       translated_name = contexts[i]->context_name;
609 #endif
610       menuitem = gtk_radio_menu_item_new_with_label (group,
611                                                      translated_name);
612       
613       if ((user_context_id &&
614            strcmp (contexts[i]->context_id, user_context_id) == 0))
615         gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
616       
617       group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
618       
619       g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"),
620                          (char *)contexts[i]->context_id);
621       g_signal_connect (menuitem, "activate",
622                         G_CALLBACK (activate_cb), context);
623
624       gtk_widget_show (menuitem);
625       gtk_menu_shell_append (menushell, menuitem);
626     }
627
628   g_free (contexts);
629 }
630
631 #define __GTK_IM_MULTICONTEXT_C__
632 #include "gtkaliasdef.c"