]> Pileus Git - ~andy/gtk/blob - gtk/gtkimmulticontext.c
0aef5c3ca4174267eba41c607bf423dce11181d6
[~andy/gtk] / gtk / gtkimmulticontext.c
1 /* GTK - The GTK+ 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       multicontext->context_id = g_strdup (global_context_id);
241     }
242
243   return multicontext->slave;
244 }
245
246 static void
247 im_module_setting_changed (GtkSettings *settings, 
248                            gpointer     data)
249 {
250   global_context_id = NULL;
251 }
252
253
254 static void
255 gtk_im_multicontext_set_client_window (GtkIMContext *context,
256                                        GdkWindow    *window)
257 {
258   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
259   GtkIMContext *slave; 
260   GdkScreen *screen; 
261   GtkSettings *settings;
262   gboolean connected;
263
264   multicontext->priv->client_window = window;
265
266   slave = gtk_im_multicontext_get_slave (multicontext);
267
268   if (slave)
269     gtk_im_context_set_client_window (slave, window);
270
271   if (window == NULL) 
272     return;
273    
274   screen = gdk_drawable_get_screen (GDK_DRAWABLE (window));
275   if (screen)
276     settings = gtk_settings_get_for_screen (screen);
277   else
278     settings = gtk_settings_get_default ();
279
280   connected = GPOINTER_TO_INT (g_object_get_data (G_OBJECT (settings),
281                                                   "gtk-im-module-connected"));
282   if (!connected) 
283     {
284       g_signal_connect (settings, "notify::gtk-im-module",
285                         G_CALLBACK (im_module_setting_changed), NULL);
286       g_object_set_data (G_OBJECT (settings), "gtk-im-module-connected",
287                          GINT_TO_POINTER (TRUE));
288
289       global_context_id = NULL;  
290     }
291 }
292
293 static void
294 gtk_im_multicontext_get_preedit_string (GtkIMContext   *context,
295                                         gchar         **str,
296                                         PangoAttrList **attrs,
297                                         gint           *cursor_pos)
298 {
299   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
300   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
301
302   if (slave)
303     gtk_im_context_get_preedit_string (slave, str, attrs, cursor_pos);
304   else
305     {
306       if (str)
307         *str = g_strdup ("");
308       if (attrs)
309         *attrs = pango_attr_list_new ();
310     }
311 }
312
313 static gboolean
314 gtk_im_multicontext_filter_keypress (GtkIMContext *context,
315                                      GdkEventKey  *event)
316 {
317   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
318   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
319
320   if (slave)
321     return gtk_im_context_filter_keypress (slave, event);
322   else
323     return FALSE;
324 }
325
326 static void
327 gtk_im_multicontext_focus_in (GtkIMContext   *context)
328 {
329   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
330   GtkIMContext *slave;
331
332   /* If the global context type is different from the context we were
333    * using before, get rid of the old slave and create a new one
334    * for the new global context type.
335    */
336   if (multicontext->context_id == NULL || 
337       global_context_id == NULL ||
338       strcmp (global_context_id, multicontext->context_id) != 0)
339     gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
340
341   slave = gtk_im_multicontext_get_slave (multicontext);
342   
343   multicontext->priv->focus_in = TRUE;
344   
345   if (slave)
346     gtk_im_context_focus_in (slave);
347 }
348
349 static void
350 gtk_im_multicontext_focus_out (GtkIMContext   *context)
351 {
352   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
353   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
354
355   multicontext->priv->focus_in = FALSE;
356   
357   if (slave)
358     gtk_im_context_focus_out (slave);
359 }
360
361 static void
362 gtk_im_multicontext_reset (GtkIMContext   *context)
363 {
364   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
365   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
366
367   if (slave)
368     gtk_im_context_reset (slave);
369 }
370
371 static void
372 gtk_im_multicontext_set_cursor_location (GtkIMContext   *context,
373                                          GdkRectangle   *area)
374 {
375   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
376   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
377
378   multicontext->priv->have_cursor_location = TRUE;
379   multicontext->priv->cursor_location = *area;
380
381   if (slave)
382     gtk_im_context_set_cursor_location (slave, area);
383 }
384
385 static void
386 gtk_im_multicontext_set_use_preedit (GtkIMContext   *context,
387                                      gboolean       use_preedit)
388 {
389   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
390   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
391
392   use_preedit = use_preedit != FALSE;
393
394   multicontext->priv->use_preedit = use_preedit;
395
396   if (slave)
397     gtk_im_context_set_use_preedit (slave, use_preedit);
398 }
399
400 static gboolean
401 gtk_im_multicontext_get_surrounding (GtkIMContext  *context,
402                                      gchar        **text,
403                                      gint          *cursor_index)
404 {
405   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
406   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
407
408   if (slave)
409     return gtk_im_context_get_surrounding (slave, text, cursor_index);
410   else
411     {
412       if (text)
413         *text = NULL;
414       if (cursor_index)
415         *cursor_index = 0;
416
417       return FALSE;
418     }
419 }
420
421 static void
422 gtk_im_multicontext_set_surrounding (GtkIMContext *context,
423                                      const char   *text,
424                                      gint          len,
425                                      gint          cursor_index)
426 {
427   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
428   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
429
430   if (slave)
431     gtk_im_context_set_surrounding (slave, text, len, cursor_index);
432 }
433
434 static void
435 gtk_im_multicontext_preedit_start_cb   (GtkIMContext      *slave,
436                                         GtkIMMulticontext *multicontext)
437 {
438   g_signal_emit_by_name (multicontext, "preedit_start");
439 }
440
441 static void
442 gtk_im_multicontext_preedit_end_cb (GtkIMContext      *slave,
443                                     GtkIMMulticontext *multicontext)
444 {
445   g_signal_emit_by_name (multicontext, "preedit_end");
446 }
447
448 static void
449 gtk_im_multicontext_preedit_changed_cb (GtkIMContext      *slave,
450                                         GtkIMMulticontext *multicontext)
451 {
452   g_signal_emit_by_name (multicontext, "preedit_changed");
453 }
454
455 static void
456 gtk_im_multicontext_commit_cb (GtkIMContext      *slave,
457                                const gchar       *str,
458                                GtkIMMulticontext *multicontext)
459 {
460   g_signal_emit_by_name (multicontext, "commit", str);;
461 }
462
463 static gboolean
464 gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext      *slave,
465                                              GtkIMMulticontext *multicontext)
466 {
467   gboolean result;
468   
469   g_signal_emit_by_name (multicontext, "retrieve_surrounding", &result);
470
471   return result;
472 }
473
474 static gboolean
475 gtk_im_multicontext_delete_surrounding_cb (GtkIMContext      *slave,
476                                            gint               offset,
477                                            gint               n_chars,
478                                            GtkIMMulticontext *multicontext)
479 {
480   gboolean result;
481   
482   g_signal_emit_by_name (multicontext, "delete_surrounding",
483                          offset, n_chars, &result);
484
485   return result;
486 }
487
488 static void
489 activate_cb (GtkWidget         *menuitem,
490              GtkIMMulticontext *context)
491 {
492   if (GTK_CHECK_MENU_ITEM (menuitem)->active)
493     {
494       const gchar *id = g_object_get_data (G_OBJECT (menuitem), "gtk-context-id");
495
496       gtk_im_context_reset (GTK_IM_CONTEXT (context));
497       
498       user_context_id = id;
499       global_context_id = NULL;
500       gtk_im_multicontext_set_slave (context, NULL, FALSE);
501     }
502 }
503
504 static int
505 pathnamecmp (const char *a,
506              const char *b)
507 {
508 #ifndef G_OS_WIN32
509   return strcmp (a, b);
510 #else
511   /* Ignore case insensitivity, probably not that relevant here. Just
512    * make sure slash and backslash compare equal.
513    */
514   while (*a && *b)
515     if ((G_IS_DIR_SEPARATOR (*a) && G_IS_DIR_SEPARATOR (*b)) ||
516         *a == *b)
517       a++, b++;
518     else
519       return (*a - *b);
520   return (*a - *b);
521 #endif
522 }
523
524 /**
525  * gtk_im_multicontext_append_menuitems:
526  * @context: a #GtkIMMultiContext
527  * @menushell: a #GtkMenuShell
528  * 
529  * Add menuitems for various available input methods to a menu;
530  * the menuitems, when selected, will switch the input method
531  * for the context and the global default input method.
532  **/
533 void
534 gtk_im_multicontext_append_menuitems (GtkIMMulticontext *context,
535                                       GtkMenuShell      *menushell)
536 {
537   const GtkIMContextInfo **contexts;
538   guint n_contexts, i;
539   GSList *group = NULL;
540   GtkWidget *menuitem;
541   
542   menuitem = gtk_radio_menu_item_new_with_label (group, Q_("input method menu|System"));
543   if (!user_context_id)
544     gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
545   group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
546   g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"), NULL);
547   g_signal_connect (menuitem, "activate", G_CALLBACK (activate_cb), context);
548
549   gtk_widget_show (menuitem);
550   gtk_menu_shell_append (menushell, menuitem);
551
552   _gtk_im_module_list (&contexts, &n_contexts);
553
554   for (i = 0; i < n_contexts; i++)
555     {
556       const gchar *translated_name;
557 #ifdef ENABLE_NLS
558       if (contexts[i]->domain && contexts[i]->domain[0])
559         {
560           if (strcmp (contexts[i]->domain, GETTEXT_PACKAGE) == 0)
561             {
562               /* Same translation domain as GTK+ */
563               if (!(contexts[i]->domain_dirname && contexts[i]->domain_dirname[0]) ||
564                   pathnamecmp (contexts[i]->domain_dirname, GTK_LOCALEDIR) == 0)
565                 {
566                   /* Empty or NULL, domain directory, or same as
567                    * GTK+. Input method may have a name in the GTK+
568                    * message catalog.
569                    */
570                   translated_name = _(contexts[i]->context_name);
571                 }
572               else
573                 {
574                   /* Separate domain directory but the same
575                    * translation domain as GTK+. We can't call
576                    * bindtextdomain() as that would make GTK+ forget
577                    * its own messages.
578                    */
579                   g_warning ("Input method %s should not use GTK's translation domain %s",
580                              contexts[i]->context_id, GETTEXT_PACKAGE);
581                   /* Try translating the name in GTK+'s domain */
582                   translated_name = _(contexts[i]->context_name);
583                 }
584             }
585           else if (contexts[i]->domain_dirname && contexts[i]->domain_dirname[0])
586             /* Input method has own translation domain and message catalog */
587             {
588               bindtextdomain (contexts[i]->domain,
589                               contexts[i]->domain_dirname);
590 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
591               bind_textdomain_codeset (contexts[i]->domain, "UTF-8");
592 #endif
593               translated_name = g_dgettext (contexts[i]->domain, contexts[i]->context_name);
594             }
595           else
596             {
597               /* Different translation domain, but no domain directory */
598               translated_name = contexts[i]->context_name;
599             }
600         }
601       else
602         /* Empty or NULL domain. We assume that input method does not
603          * want a translated name in this case.
604          */
605         translated_name = contexts[i]->context_name;
606 #else
607       translated_name = contexts[i]->context_name;
608 #endif
609       menuitem = gtk_radio_menu_item_new_with_label (group,
610                                                      translated_name);
611       
612       if ((user_context_id &&
613            strcmp (contexts[i]->context_id, user_context_id) == 0))
614         gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem), TRUE);
615       
616       group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
617       
618       g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"),
619                          (char *)contexts[i]->context_id);
620       g_signal_connect (menuitem, "activate",
621                         G_CALLBACK (activate_cb), context);
622
623       gtk_widget_show (menuitem);
624       gtk_menu_shell_append (menushell, menuitem);
625     }
626
627   g_free (contexts);
628 }
629
630 #define __GTK_IM_MULTICONTEXT_C__
631 #include "gtkaliasdef.c"