]> Pileus Git - ~andy/gtk/blob - gtk/gtkimmulticontext.c
Add docs for new ports.
[~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"
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_class_init         (GtkIMMulticontextClass  *class);
44 static void     gtk_im_multicontext_init               (GtkIMMulticontext       *im_multicontext);
45 static void     gtk_im_multicontext_finalize           (GObject                 *object);
46
47 static void     gtk_im_multicontext_set_slave          (GtkIMMulticontext       *multicontext,
48                                                         GtkIMContext            *slave,
49                                                         gboolean                 finalizing);
50
51 static void     gtk_im_multicontext_set_client_window  (GtkIMContext            *context,
52                                                         GdkWindow               *window);
53 static void     gtk_im_multicontext_get_preedit_string (GtkIMContext            *context,
54                                                         gchar                  **str,
55                                                         PangoAttrList          **attrs,
56                                                         gint                   *cursor_pos);
57 static gboolean gtk_im_multicontext_filter_keypress    (GtkIMContext            *context,
58                                                         GdkEventKey             *event);
59 static void     gtk_im_multicontext_focus_in           (GtkIMContext            *context);
60 static void     gtk_im_multicontext_focus_out          (GtkIMContext            *context);
61 static void     gtk_im_multicontext_reset              (GtkIMContext            *context);
62 static void     gtk_im_multicontext_set_cursor_location (GtkIMContext            *context,
63                                                         GdkRectangle            *area);
64 static void     gtk_im_multicontext_set_use_preedit    (GtkIMContext            *context,
65                                                         gboolean                 use_preedit);
66 static gboolean gtk_im_multicontext_get_surrounding    (GtkIMContext            *context,
67                                                         gchar                  **text,
68                                                         gint                    *cursor_index);
69 static void     gtk_im_multicontext_set_surrounding    (GtkIMContext            *context,
70                                                         const char              *text,
71                                                         gint                     len,
72                                                         gint                     cursor_index);
73
74 static void     gtk_im_multicontext_preedit_start_cb        (GtkIMContext      *slave,
75                                                              GtkIMMulticontext *multicontext);
76 static void     gtk_im_multicontext_preedit_end_cb          (GtkIMContext      *slave,
77                                                              GtkIMMulticontext *multicontext);
78 static void     gtk_im_multicontext_preedit_changed_cb      (GtkIMContext      *slave,
79                                                              GtkIMMulticontext *multicontext);
80 static void     gtk_im_multicontext_commit_cb               (GtkIMContext      *slave,
81                                                              const gchar       *str,
82                                                              GtkIMMulticontext *multicontext);
83 static gboolean gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext      *slave,
84                                                              GtkIMMulticontext *multicontext);
85 static gboolean gtk_im_multicontext_delete_surrounding_cb   (GtkIMContext      *slave,
86                                                              gint               offset,
87                                                              gint               n_chars,
88                                                              GtkIMMulticontext *multicontext);
89 static GtkIMContextClass *parent_class;
90
91 static const gchar *global_context_id = NULL;
92
93 GType
94 gtk_im_multicontext_get_type (void)
95 {
96   static GType im_multicontext_type = 0;
97  
98   if (!im_multicontext_type)
99     {
100       static const GTypeInfo im_multicontext_info =
101       {
102         sizeof (GtkIMMulticontextClass),
103         (GBaseInitFunc) NULL,
104         (GBaseFinalizeFunc) NULL,
105         (GClassInitFunc) gtk_im_multicontext_class_init,
106         NULL,           /* class_finalize */
107         NULL,           /* class_data */
108         sizeof (GtkIMMulticontext),
109         0,              /* n_preallocs */
110         (GInstanceInitFunc) gtk_im_multicontext_init,
111       };
112       
113       im_multicontext_type =
114         g_type_register_static (GTK_TYPE_IM_CONTEXT, I_("GtkIMMulticontext"),
115                                 &im_multicontext_info, 0);
116     }
117
118   return im_multicontext_type;
119 }
120
121 static void
122 gtk_im_multicontext_class_init (GtkIMMulticontextClass *class)
123 {
124   GObjectClass *gobject_class = G_OBJECT_CLASS (class);
125   GtkIMContextClass *im_context_class = GTK_IM_CONTEXT_CLASS (class);
126   
127   parent_class = g_type_class_peek_parent (class);
128
129   im_context_class->set_client_window = gtk_im_multicontext_set_client_window;
130   im_context_class->get_preedit_string = gtk_im_multicontext_get_preedit_string;
131   im_context_class->filter_keypress = gtk_im_multicontext_filter_keypress;
132   im_context_class->focus_in = gtk_im_multicontext_focus_in;
133   im_context_class->focus_out = gtk_im_multicontext_focus_out;
134   im_context_class->reset = gtk_im_multicontext_reset;
135   im_context_class->set_cursor_location = gtk_im_multicontext_set_cursor_location;
136   im_context_class->set_use_preedit = gtk_im_multicontext_set_use_preedit;
137   im_context_class->set_surrounding = gtk_im_multicontext_set_surrounding;
138   im_context_class->get_surrounding = gtk_im_multicontext_get_surrounding;
139
140   gobject_class->finalize = gtk_im_multicontext_finalize;
141
142   g_type_class_add_private (gobject_class, sizeof (GtkIMMulticontextPrivate));   
143 }
144
145 static void
146 gtk_im_multicontext_init (GtkIMMulticontext *multicontext)
147 {
148   multicontext->slave = NULL;
149   
150   multicontext->priv = G_TYPE_INSTANCE_GET_PRIVATE (multicontext, GTK_TYPE_IM_MULTICONTEXT, GtkIMMulticontextPrivate);
151   multicontext->priv->use_preedit = TRUE;
152   multicontext->priv->have_cursor_location = FALSE;
153   multicontext->priv->focus_in = FALSE;
154 }
155
156 /**
157  * gtk_im_multicontext_new:
158  *
159  * Creates a new #GtkIMMulticontext.
160  *
161  * Returns: a new #GtkIMMulticontext.
162  **/
163 GtkIMContext *
164 gtk_im_multicontext_new (void)
165 {
166   return g_object_new (GTK_TYPE_IM_MULTICONTEXT, NULL);
167 }
168
169 static void
170 gtk_im_multicontext_finalize (GObject *object)
171 {
172   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (object);
173   
174   gtk_im_multicontext_set_slave (multicontext, NULL, TRUE);
175
176   G_OBJECT_CLASS (parent_class)->finalize (object);
177 }
178
179 static void
180 gtk_im_multicontext_set_slave (GtkIMMulticontext *multicontext,
181                                GtkIMContext      *slave,
182                                gboolean           finalizing)
183 {
184   GtkIMMulticontextPrivate *priv = multicontext->priv;
185   gboolean need_preedit_changed = FALSE;
186   
187   if (multicontext->slave)
188     {
189       if (!finalizing)
190         gtk_im_context_reset (multicontext->slave);
191       
192       g_signal_handlers_disconnect_by_func (multicontext->slave,
193                                             gtk_im_multicontext_preedit_start_cb,
194                                             multicontext);
195       g_signal_handlers_disconnect_by_func (multicontext->slave,
196                                             gtk_im_multicontext_preedit_end_cb,
197                                             multicontext);
198       g_signal_handlers_disconnect_by_func (multicontext->slave,
199                                             gtk_im_multicontext_preedit_changed_cb,
200                                             multicontext);
201       g_signal_handlers_disconnect_by_func (multicontext->slave,
202                                             gtk_im_multicontext_commit_cb,
203                                             multicontext);
204
205       g_object_unref (multicontext->slave);
206       multicontext->slave = NULL;
207
208       if (!finalizing)
209         need_preedit_changed = TRUE;
210     }
211   
212   multicontext->slave = slave;
213
214   if (multicontext->slave)
215     {
216       g_object_ref (multicontext->slave);
217
218       g_signal_connect (multicontext->slave, "preedit_start",
219                         G_CALLBACK (gtk_im_multicontext_preedit_start_cb),
220                         multicontext);
221       g_signal_connect (multicontext->slave, "preedit_end",
222                         G_CALLBACK (gtk_im_multicontext_preedit_end_cb),
223                         multicontext);
224       g_signal_connect (multicontext->slave, "preedit_changed",
225                         G_CALLBACK (gtk_im_multicontext_preedit_changed_cb),
226                         multicontext);
227       g_signal_connect (multicontext->slave, "commit",
228                         G_CALLBACK (gtk_im_multicontext_commit_cb),
229                         multicontext);
230       g_signal_connect (multicontext->slave, "retrieve_surrounding",
231                         G_CALLBACK (gtk_im_multicontext_retrieve_surrounding_cb),
232                         multicontext);
233       g_signal_connect (multicontext->slave, "delete_surrounding",
234                         G_CALLBACK (gtk_im_multicontext_delete_surrounding_cb),
235                         multicontext);
236       
237       if (!priv->use_preedit)   /* Default is TRUE */
238         gtk_im_context_set_use_preedit (slave, FALSE);
239       if (priv->client_window)
240         gtk_im_context_set_client_window (slave, priv->client_window);
241       if (priv->have_cursor_location)
242         gtk_im_context_set_cursor_location (slave, &priv->cursor_location);
243       if (priv->focus_in)
244         gtk_im_context_focus_in (slave);
245     }
246
247   if (need_preedit_changed)
248     g_signal_emit_by_name (multicontext, "preedit_changed");
249 }
250
251 static GtkIMContext *
252 gtk_im_multicontext_get_slave (GtkIMMulticontext *multicontext)
253 {
254   if (!multicontext->slave)
255     {
256       GtkIMContext *slave;
257
258       if (!global_context_id)
259         {
260           gchar *locale = _gtk_get_lc_ctype ();
261           global_context_id = _gtk_im_module_get_default_context_id (locale);
262           g_free (locale);
263         }
264         
265       slave = _gtk_im_module_create (global_context_id);
266       gtk_im_multicontext_set_slave (multicontext, slave, FALSE);
267       g_object_unref (slave);
268
269       multicontext->context_id = global_context_id;
270     }
271
272   return multicontext->slave;
273 }
274
275 static void
276 gtk_im_multicontext_set_client_window (GtkIMContext *context,
277                                        GdkWindow    *window)
278 {
279   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
280   
281   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
282
283   multicontext->priv->client_window = window;
284   
285   if (slave)
286     gtk_im_context_set_client_window (slave, window);
287 }
288
289 static void
290 gtk_im_multicontext_get_preedit_string (GtkIMContext   *context,
291                                         gchar         **str,
292                                         PangoAttrList **attrs,
293                                         gint           *cursor_pos)
294 {
295   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
296   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
297
298   if (slave)
299     gtk_im_context_get_preedit_string (slave, str, attrs, cursor_pos);
300   else
301     {
302       if (str)
303         *str = g_strdup ("");
304       if (attrs)
305         *attrs = pango_attr_list_new ();
306     }
307 }
308
309 static gboolean
310 gtk_im_multicontext_filter_keypress (GtkIMContext *context,
311                                      GdkEventKey  *event)
312 {
313   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
314   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
315
316   if (slave)
317     return gtk_im_context_filter_keypress (slave, event);
318   else
319     return FALSE;
320 }
321
322 static void
323 gtk_im_multicontext_focus_in (GtkIMContext   *context)
324 {
325   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
326   GtkIMContext *slave;
327
328   /* If the global context type is different from the context we were
329    * using before, get rid of the old slave and create a new one
330    * for the new global context type.
331    */
332   if (!multicontext->context_id ||
333       strcmp (global_context_id, multicontext->context_id) != 0)
334     gtk_im_multicontext_set_slave (multicontext, NULL, FALSE);
335
336   slave = gtk_im_multicontext_get_slave (multicontext);
337   
338   multicontext->priv->focus_in = TRUE;
339   
340   if (slave)
341     gtk_im_context_focus_in (slave);
342 }
343
344 static void
345 gtk_im_multicontext_focus_out (GtkIMContext   *context)
346 {
347   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
348   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
349
350   multicontext->priv->focus_in = FALSE;
351   
352   if (slave)
353     gtk_im_context_focus_out (slave);
354 }
355
356 static void
357 gtk_im_multicontext_reset (GtkIMContext   *context)
358 {
359   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
360   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
361
362   if (slave)
363     gtk_im_context_reset (slave);
364 }
365
366 static void
367 gtk_im_multicontext_set_cursor_location (GtkIMContext   *context,
368                                          GdkRectangle   *area)
369 {
370   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
371   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
372
373   multicontext->priv->have_cursor_location = TRUE;
374   multicontext->priv->cursor_location = *area;
375
376   if (slave)
377     gtk_im_context_set_cursor_location (slave, area);
378 }
379
380 static void
381 gtk_im_multicontext_set_use_preedit (GtkIMContext   *context,
382                                      gboolean       use_preedit)
383 {
384   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
385   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
386
387   use_preedit = use_preedit != FALSE;
388
389   multicontext->priv->use_preedit = use_preedit;
390
391   if (slave)
392     gtk_im_context_set_use_preedit (slave, use_preedit);
393 }
394
395 static gboolean
396 gtk_im_multicontext_get_surrounding (GtkIMContext  *context,
397                                      gchar        **text,
398                                      gint          *cursor_index)
399 {
400   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
401   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
402
403   if (slave)
404     return gtk_im_context_get_surrounding (slave, text, cursor_index);
405   else
406     {
407       if (text)
408         *text = NULL;
409       if (cursor_index)
410         *cursor_index = 0;
411
412       return FALSE;
413     }
414 }
415
416 static void
417 gtk_im_multicontext_set_surrounding (GtkIMContext *context,
418                                      const char   *text,
419                                      gint          len,
420                                      gint          cursor_index)
421 {
422   GtkIMMulticontext *multicontext = GTK_IM_MULTICONTEXT (context);
423   GtkIMContext *slave = gtk_im_multicontext_get_slave (multicontext);
424
425   if (slave)
426     gtk_im_context_set_surrounding (slave, text, len, cursor_index);
427 }
428
429 static void
430 gtk_im_multicontext_preedit_start_cb   (GtkIMContext      *slave,
431                                         GtkIMMulticontext *multicontext)
432 {
433   g_signal_emit_by_name (multicontext, "preedit_start");
434 }
435
436 static void
437 gtk_im_multicontext_preedit_end_cb (GtkIMContext      *slave,
438                                     GtkIMMulticontext *multicontext)
439 {
440   g_signal_emit_by_name (multicontext, "preedit_end");
441 }
442
443 static void
444 gtk_im_multicontext_preedit_changed_cb (GtkIMContext      *slave,
445                                         GtkIMMulticontext *multicontext)
446 {
447   g_signal_emit_by_name (multicontext, "preedit_changed");
448 }
449
450 static void
451 gtk_im_multicontext_commit_cb (GtkIMContext      *slave,
452                                const gchar       *str,
453                                GtkIMMulticontext *multicontext)
454 {
455   g_signal_emit_by_name (multicontext, "commit", str);;
456 }
457
458 static gboolean
459 gtk_im_multicontext_retrieve_surrounding_cb (GtkIMContext      *slave,
460                                              GtkIMMulticontext *multicontext)
461 {
462   gboolean result;
463   
464   g_signal_emit_by_name (multicontext, "retrieve_surrounding", &result);
465
466   return result;
467 }
468
469 static gboolean
470 gtk_im_multicontext_delete_surrounding_cb (GtkIMContext      *slave,
471                                            gint               offset,
472                                            gint               n_chars,
473                                            GtkIMMulticontext *multicontext)
474 {
475   gboolean result;
476   
477   g_signal_emit_by_name (multicontext, "delete_surrounding",
478                          offset, n_chars, &result);
479
480   return result;
481 }
482
483 static void
484 activate_cb (GtkWidget         *menuitem,
485              GtkIMMulticontext *context)
486 {
487   if (GTK_CHECK_MENU_ITEM (menuitem)->active)
488     {
489       const gchar *id = g_object_get_data (G_OBJECT (menuitem), "gtk-context-id");
490
491       gtk_im_context_reset (GTK_IM_CONTEXT (context));
492       
493       global_context_id = id;
494       gtk_im_multicontext_set_slave (context, NULL, FALSE);
495     }
496 }
497
498 /**
499  * gtk_im_multicontext_append_menuitems:
500  * @context: a #GtkIMMultiContext
501  * @menushell: a #GtkMenuShell
502  * 
503  * Add menuitems for various available input methods to a menu;
504  * the menuitems, when selected, will switch the input method
505  * for the context and the global default input method.
506  **/
507 void
508 gtk_im_multicontext_append_menuitems (GtkIMMulticontext *context,
509                                       GtkMenuShell      *menushell)
510 {
511   const GtkIMContextInfo **contexts;
512   guint n_contexts, i;
513   GSList *group = NULL;
514   
515   _gtk_im_module_list (&contexts, &n_contexts);
516
517   for (i=0; i < n_contexts; i++)
518     {
519       GtkWidget *menuitem;
520       const gchar *translated_name;
521 #ifdef ENABLE_NLS
522       if (contexts[i]->domain && contexts[i]->domain_dirname &&
523           contexts[i]->domain[0] && contexts[i]->domain_dirname[0])
524         {
525           if (strcmp (contexts[i]->domain, GETTEXT_PACKAGE) == 0 &&
526               strcmp (contexts[i]->domain_dirname, GTK_LOCALEDIR) == 0)
527             /* Input method may have a name in the GTK+ message catalog */
528             translated_name = _(contexts[i]->context_name);
529           else
530             /* Input method has own message catalog */
531             {
532               bindtextdomain (contexts[i]->domain,
533                               contexts[i]->domain_dirname);
534 #ifdef HAVE_BIND_TEXTDOMAIN_CODESET
535               bind_textdomain_codeset (contexts[i]->domain, "UTF-8");
536 #endif
537               translated_name = dgettext (contexts[i]->domain, contexts[i]->context_name);
538             }
539         }
540       else
541         /* Either domain or domain_dirname is NULL or "". We assume that
542          * input method does not want a translated name in this case
543          */
544         translated_name = contexts[i]->context_name;
545 #else
546       translated_name = contexts[i]->context_name;
547 #endif
548       menuitem = gtk_radio_menu_item_new_with_label (group,
549                                                      translated_name);
550       
551       if ((global_context_id == NULL && group == NULL) ||
552           (global_context_id &&
553            strcmp (contexts[i]->context_id, global_context_id) == 0))
554         gtk_check_menu_item_set_active (GTK_CHECK_MENU_ITEM (menuitem),
555                                         TRUE);
556       
557       group = gtk_radio_menu_item_get_group (GTK_RADIO_MENU_ITEM (menuitem));
558       
559       g_object_set_data (G_OBJECT (menuitem), I_("gtk-context-id"),
560                          (char *)contexts[i]->context_id);
561       g_signal_connect (menuitem, "activate",
562                         G_CALLBACK (activate_cb), context);
563
564       gtk_widget_show (menuitem);
565       gtk_menu_shell_append (menushell, menuitem);
566     }
567
568   g_free (contexts);
569 }
570
571 #define __GTK_IM_MULTICONTEXT_C__
572 #include "gtkaliasdef.c"