]> Pileus Git - ~andy/gtk/blob - gdk/quartz/gdkkeys-quartz.c
Special-case shift-tab and map it to GDK_ISO_Left_Tab, fixes bug #350806.
[~andy/gtk] / gdk / quartz / gdkkeys-quartz.c
1 /* gdkkeys-quartz.c
2  *
3  * Copyright (C) 2000 Red Hat, Inc.
4  * Copyright (C) 2005 Imendio AB
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Lesser General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Lesser General Public License for more details.
15  *
16  * You should have received a copy of the GNU Lesser General Public
17  * License along with this library; if not, write to the
18  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19  * Boston, MA 02111-1307, USA.
20  */
21 /* Some parts of this code come from quartzKeyboard.c,
22  * from the Apple X11 Server.
23  *
24  * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
25  *
26  *  Permission is hereby granted, free of charge, to any person
27  *  obtaining a copy of this software and associated documentation files
28  *  (the "Software"), to deal in the Software without restriction,
29  *  including without limitation the rights to use, copy, modify, merge,
30  *  publish, distribute, sublicense, and/or sell copies of the Software,
31  *  and to permit persons to whom the Software is furnished to do so,
32  *  subject to the following conditions:
33  *
34  *  The above copyright notice and this permission notice shall be
35  *  included in all copies or substantial portions of the Software.
36  *
37  *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
38  *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
39  *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
40  *  NONINFRINGEMENT.  IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT
41  *  HOLDER(S) BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
42  *  WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
43  *  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
44  *  DEALINGS IN THE SOFTWARE.
45  *
46  *  Except as contained in this notice, the name(s) of the above
47  *  copyright holders shall not be used in advertising or otherwise to
48  *  promote the sale, use or other dealings in this Software without
49  *  prior written authorization.
50  */
51
52 #include <config.h>
53
54 #include <Carbon/Carbon.h>
55 #include <AppKit/NSEvent.h>
56 #include "gdk.h"
57 #include "gdkkeysyms.h"
58
59 #define NUM_KEYCODES 128
60 #define KEYVALS_PER_KEYCODE 4
61
62 static GdkKeymap *default_keymap = NULL;
63
64 static KeyboardLayoutRef current_layout = NULL;
65
66 /* This is a table of all keyvals. Each keycode gets KEYVALS_PER_KEYCODE entries.
67  * TThere is 1 keyval per modifier (Nothing, Shift, Alt, Shift+Alt);
68  */
69 static guint *keyval_array = NULL;
70
71 static inline UniChar
72 macroman2ucs (unsigned char c)
73 {
74   /* Precalculated table mapping MacRoman-128 to Unicode. Generated
75      by creating single element CFStringRefs then extracting the
76      first character. */
77   
78   static const unsigned short table[128] = {
79     0xc4, 0xc5, 0xc7, 0xc9, 0xd1, 0xd6, 0xdc, 0xe1,
80     0xe0, 0xe2, 0xe4, 0xe3, 0xe5, 0xe7, 0xe9, 0xe8,
81     0xea, 0xeb, 0xed, 0xec, 0xee, 0xef, 0xf1, 0xf3,
82     0xf2, 0xf4, 0xf6, 0xf5, 0xfa, 0xf9, 0xfb, 0xfc,
83     0x2020, 0xb0, 0xa2, 0xa3, 0xa7, 0x2022, 0xb6, 0xdf,
84     0xae, 0xa9, 0x2122, 0xb4, 0xa8, 0x2260, 0xc6, 0xd8,
85     0x221e, 0xb1, 0x2264, 0x2265, 0xa5, 0xb5, 0x2202, 0x2211,
86     0x220f, 0x3c0, 0x222b, 0xaa, 0xba, 0x3a9, 0xe6, 0xf8,
87     0xbf, 0xa1, 0xac, 0x221a, 0x192, 0x2248, 0x2206, 0xab,
88     0xbb, 0x2026, 0xa0, 0xc0, 0xc3, 0xd5, 0x152, 0x153,
89     0x2013, 0x2014, 0x201c, 0x201d, 0x2018, 0x2019, 0xf7, 0x25ca,
90     0xff, 0x178, 0x2044, 0x20ac, 0x2039, 0x203a, 0xfb01, 0xfb02,
91     0x2021, 0xb7, 0x201a, 0x201e, 0x2030, 0xc2, 0xca, 0xc1,
92     0xcb, 0xc8, 0xcd, 0xce, 0xcf, 0xcc, 0xd3, 0xd4,
93     0xf8ff, 0xd2, 0xda, 0xdb, 0xd9, 0x131, 0x2c6, 0x2dc,
94     0xaf, 0x2d8, 0x2d9, 0x2da, 0xb8, 0x2dd, 0x2db, 0x2c7
95   };
96
97   if (c < 128)
98     return c;
99   else
100     return table[c - 128];
101 }
102
103 const static struct {
104   guint keycode;
105   guint keyval;
106   unsigned int modmask; /* So we can tell when a mod key is pressed/released */
107 } known_keys[] = {
108   {  54, GDK_Meta_R,    NSCommandKeyMask },
109   {  55, GDK_Meta_L,    NSCommandKeyMask },
110   {  56, GDK_Shift_L,   NSShiftKeyMask },
111   {  57, GDK_Caps_Lock, NSAlphaShiftKeyMask },
112   {  58, GDK_Alt_L,     NSAlternateKeyMask },
113   {  59, GDK_Control_L, NSControlKeyMask },
114   {  60, GDK_Shift_R,   NSShiftKeyMask },
115   {  61, GDK_Alt_R,     NSAlternateKeyMask },
116   {  62, GDK_Control_R, NSControlKeyMask },
117   { 122, GDK_F1, 0 },
118   { 120, GDK_F2, 0 },
119   {  99, GDK_F3, 0 },
120   { 118, GDK_F4, 0 },
121   {  96, GDK_F5, 0 },
122   {  97, GDK_F6, 0 },
123   {  98, GDK_F7, 0 },
124   { 100, GDK_F8, 0 },
125   { 101, GDK_F9, 0 },
126   { 109, GDK_F10, 0 },
127   { 103, GDK_F11, 0 },
128   { 111, GDK_F12, 0 },
129   { 105, GDK_F13, 0 },
130   { 107, GDK_F14, 0 },
131   { 113, GDK_F15, 0 }
132 };
133
134 const static struct {
135   guint keycode;
136   guint normal_keyval, keypad_keyval;
137 } known_numeric_keys[] = {
138   { 65, GDK_period, GDK_KP_Decimal },
139   { 67, GDK_asterisk, GDK_KP_Multiply },
140   { 69, GDK_plus, GDK_KP_Add },
141   { 75, GDK_slash, GDK_KP_Divide },
142   { 76, 0x01000003, GDK_KP_Enter },
143   { 78, GDK_minus, GDK_KP_Subtract },
144   { 81, GDK_equal, GDK_KP_Equal },
145   { 82, GDK_0, GDK_KP_0 },
146   { 83, GDK_1, GDK_KP_1 },
147   { 84, GDK_2, GDK_KP_2 },
148   { 85, GDK_3, GDK_KP_3 },
149   { 86, GDK_4, GDK_KP_4 },
150   { 87, GDK_5, GDK_KP_5 },
151   { 88, GDK_6, GDK_KP_6 },
152   { 89, GDK_7, GDK_KP_7 },
153   { 91, GDK_8, GDK_KP_8 },
154   { 92, GDK_9, GDK_KP_9 }
155 };
156
157 /* These values aren't covered by gdk_unicode_to_keyval */
158 const static struct {
159   gunichar ucs_value;
160   guint keyval;
161 } special_ucs_table [] = {
162   { 0x0001, GDK_Home },
163   { 0x0003, GDK_Return },
164   { 0x0004, GDK_End },
165   { 0x0008, GDK_BackSpace },
166   { 0x0009, GDK_Tab },
167   { 0x000b, GDK_Page_Up },
168   { 0x000c, GDK_Page_Down },
169   { 0x000d, GDK_Return },
170   { 0x001b, GDK_Escape },
171   { 0x001c, GDK_Left },
172   { 0x001d, GDK_Right },
173   { 0x001e, GDK_Up },
174   { 0x001f, GDK_Down },
175   { 0x007f, GDK_Delete }
176 };
177
178 static void
179 maybe_update_keymap (void)
180 {
181   KeyboardLayoutRef new_layout;
182
183   KLGetCurrentKeyboardLayout (&new_layout);
184
185   if (new_layout != current_layout)
186     {
187       guint *p;
188       int i;
189
190       KeyboardLayoutKind layout_kind;
191       
192       g_free (keyval_array);
193       keyval_array = g_new0 (guint, NUM_KEYCODES * KEYVALS_PER_KEYCODE);
194
195       /* Get the layout kind */
196       KLGetKeyboardLayoutProperty (new_layout, kKLKind, (const void **)&layout_kind);
197
198       /* 8-bit-only keyabord layout */
199       if (layout_kind == kKLKCHRKind)
200         { 
201           const void *chr_data;
202           
203           /* Get chr data */
204           KLGetKeyboardLayoutProperty (new_layout, kKLKCHRData, (const void **)&chr_data);
205           
206           for (i = 0; i < NUM_KEYCODES; i++) 
207             {
208               int j;
209               UInt32 modifiers[] = {0, shiftKey, optionKey, shiftKey | optionKey};
210
211               p = keyval_array + i * KEYVALS_PER_KEYCODE;
212               
213               for (j = 0; j < KEYVALS_PER_KEYCODE; j++)
214                 {
215                   UInt32 c, state = 0;
216                   UInt16 key_code;
217                   UniChar uc;
218                   
219                   key_code = modifiers[j] | i;
220                   c = KeyTranslate (chr_data, key_code, &state);
221
222                   if (state != 0)
223                     {
224                       UInt32 state2 = 0;
225                       c = KeyTranslate (chr_data, key_code | 128, &state2);
226                     }
227
228                   if (c != 0 && c != 0x10)
229                     {
230                       int k;
231                       gboolean found = FALSE;
232
233                       /* FIXME: some keyboard layouts (e.g. Russian) use
234                        * a different 8-bit character set. We should
235                        * check for this. Not a serious problem, because
236                        * most (all?) of these layouts also have a
237                        * uchr version. 
238                        */
239                       uc = macroman2ucs (c);
240
241                       for (k = 0; k < G_N_ELEMENTS (special_ucs_table); k++) 
242                         {
243                           if (special_ucs_table[k].ucs_value == uc)
244                             {
245                               p[j] = special_ucs_table[k].keyval;
246                               found = TRUE;
247                               break;
248                             }
249                         }
250                       
251                       /* Special-case shift-tab since GTK+ expects
252                        * GDK_ISO_Left_Tab for that. 
253                        */
254                       if (found && p[j] == GDK_Tab && modifiers[j] == shiftKey) 
255                         p[j] = GDK_ISO_Left_Tab;
256
257                       if (!found)
258                         p[j] = gdk_unicode_to_keyval (uc);
259                     }
260                 }
261               
262               if (p[3] == p[2])
263                 p[3] = 0;
264               if (p[2] == p[1])
265                 p[2] = 0;
266               if (p[1] == p[0])
267                 p[1] = 0;
268               if (p[0] == p[2] && 
269                   p[1] == p[3])
270                 p[2] = p[3] = 0;
271             }
272         }
273       /* unicode keyboard layout */
274       else if (layout_kind == kKLKCHRuchrKind || layout_kind == kKLuchrKind)
275         { 
276           const void *chr_data;
277           
278           /* Get chr data */
279           KLGetKeyboardLayoutProperty (new_layout, kKLuchrData, (const void **)&chr_data);
280           
281           for (i = 0; i < NUM_KEYCODES; i++) 
282             {
283               int j;
284               UInt32 modifiers[] = {0, shiftKey, optionKey, shiftKey | optionKey};
285               UniChar chars[4];
286               UniCharCount nChars;
287
288               p = keyval_array + i * KEYVALS_PER_KEYCODE;
289
290               for (j = 0; j < KEYVALS_PER_KEYCODE; j++)
291                 {
292                   UInt32 state = 0;
293                   OSStatus err;
294                   UInt16 key_code;
295                   UniChar uc;
296                   
297                   key_code = modifiers[j] | i;
298                   err = UCKeyTranslate (chr_data, i, kUCKeyActionDown,
299                                         (modifiers[j] >> 8) & 0xFF,
300                                         LMGetKbdType(),
301                                         kUCKeyTranslateNoDeadKeysMask,
302                                         &state, 4, &nChars, chars);
303
304
305                   /* FIXME: Theoretically, we can get multiple UTF-16 values;
306                    * we should convert them to proper unicode and figure
307                    * out whether there are really keyboard layouts that
308                    * give us more than one character for one keypress. */
309                   if (err == noErr && nChars == 1)
310                     {
311                       int k;
312                       gboolean found = FALSE;
313                       
314                       uc = chars[0];
315
316                       for (k = 0; k < G_N_ELEMENTS (special_ucs_table); k++) 
317                         {
318                           if (special_ucs_table[k].ucs_value == uc)
319                             {
320                               p[j] = special_ucs_table[k].keyval;
321                               found = TRUE;
322                               break;
323                             }
324                         }
325                       
326                       if (!found)
327                         p[j] = gdk_unicode_to_keyval (uc);
328                     }
329                 }
330               
331               if (p[3] == p[2])
332                 p[3] = 0;
333               if (p[2] == p[1])
334                 p[2] = 0;
335               if (p[1] == p[0])
336                 p[1] = 0;
337               if (p[0] == p[2] && 
338                   p[1] == p[3])
339                 p[2] = p[3] = 0;
340             }
341         }
342       else
343         {
344           g_error ("unknown type of keyboard layout (neither KCHR nor uchr)"
345                    " - not supported right now");
346         }
347
348       for (i = 0; i < G_N_ELEMENTS (known_keys); i++)
349         {
350           p = keyval_array + known_keys[i].keycode * KEYVALS_PER_KEYCODE;
351
352           if (p[0] == 0 && p[1] == 0 && 
353               p[2] == 0 && p[3] == 0)
354             p[0] = known_keys[i].keyval;
355         }
356
357       for (i = 0; i < G_N_ELEMENTS (known_numeric_keys); i++)
358         {
359           p = keyval_array + known_numeric_keys[i].keycode * KEYVALS_PER_KEYCODE;
360
361           if (p[0] == known_numeric_keys[i].normal_keyval);
362               p[0] = known_numeric_keys[i].keypad_keyval;
363         }
364       
365       if (current_layout)
366         g_signal_emit_by_name (default_keymap, "keys_changed");
367
368       current_layout = new_layout;
369     }
370 }
371
372 GdkKeymap *
373 gdk_keymap_get_for_display (GdkDisplay *display)
374 {
375   g_return_val_if_fail (display == gdk_display_get_default (), NULL);
376
377   if (default_keymap == NULL)
378     default_keymap = g_object_new (gdk_keymap_get_type (), NULL);
379
380   return default_keymap;
381 }
382
383 PangoDirection
384 gdk_keymap_get_direction (GdkKeymap *keymap)
385 {
386   return PANGO_DIRECTION_NEUTRAL;
387 }
388
389 gboolean
390 gdk_keymap_get_entries_for_keyval (GdkKeymap     *keymap,
391                                    guint          keyval,
392                                    GdkKeymapKey **keys,
393                                    gint          *n_keys)
394 {
395   GArray *keys_array;
396   int i;
397
398   g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), FALSE);
399   g_return_val_if_fail (keys != NULL, FALSE);
400   g_return_val_if_fail (n_keys != NULL, FALSE);
401   g_return_val_if_fail (keyval != 0, FALSE);
402
403   maybe_update_keymap ();
404
405   *n_keys = 0;
406   keys_array = g_array_new (FALSE, FALSE, sizeof (GdkKeymapKey));
407
408   for (i = 0; i < NUM_KEYCODES * KEYVALS_PER_KEYCODE; i++)
409     {
410       GdkKeymapKey key;
411
412       if (keyval_array[i] != keyval)
413         continue;
414
415       (*n_keys)++;
416
417       key.keycode = i / KEYVALS_PER_KEYCODE;
418       key.group = 0;
419       key.level = i % KEYVALS_PER_KEYCODE;
420
421       g_array_append_val (keys_array, key);
422     }
423
424   *keys = (GdkKeymapKey *)g_array_free (keys_array, FALSE);
425   
426   return *n_keys > 0;;
427 }
428
429 gboolean
430 gdk_keymap_get_entries_for_keycode (GdkKeymap     *keymap,
431                                     guint          hardware_keycode,
432                                     GdkKeymapKey **keys,
433                                     guint        **keyvals,
434                                     gint          *n_entries)
435 {
436   GArray *keys_array, *keyvals_array;
437   int i;
438   guint *p;
439
440   g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), FALSE);
441   g_return_val_if_fail (n_entries != NULL, FALSE);
442
443   maybe_update_keymap ();
444
445   *n_entries = 0;
446
447   if (hardware_keycode > NUM_KEYCODES)
448     return FALSE;
449
450   if (keys)
451     keys_array = g_array_new (FALSE, FALSE, sizeof (GdkKeymapKey));
452   else
453     keys_array = NULL;
454
455   if (keyvals)
456     keyvals_array = g_array_new (FALSE, FALSE, sizeof (guint));
457   else
458     keyvals_array = NULL;
459
460   p = keyval_array + hardware_keycode * KEYVALS_PER_KEYCODE;
461   
462   for (i = 0; i < KEYVALS_PER_KEYCODE; i++)
463     {
464       if (!p[i])
465         continue;
466
467       (*n_entries)++;
468       
469       if (keyvals_array)
470         g_array_append_val (keyvals_array, p[i]);
471
472       if (keys_array)
473         {
474           GdkKeymapKey key;
475
476           key.keycode = hardware_keycode;
477           key.group = i / 2;
478           key.level = i % 2;
479
480           g_array_append_val (keys_array, key);
481         }
482     }
483   
484   if (keys)
485     *keys = (GdkKeymapKey *)g_array_free (keys_array, FALSE);
486
487   if (keyvals)
488     *keyvals = (guint *)g_array_free (keyvals_array, FALSE);
489
490   return *n_entries > 0;
491 }
492
493 guint
494 gdk_keymap_lookup_key (GdkKeymap          *keymap,
495                        const GdkKeymapKey *key)
496 {
497   g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), 0);
498   g_return_val_if_fail (key != NULL, 0);
499   g_return_val_if_fail (key->group < 4, 0);
500
501   /* FIXME: Implement */
502
503   return 0;
504 }
505
506 #define GET_KEYVAL(keycode, group, level) (keyval_array[(keycode * KEYVALS_PER_KEYCODE + group * 2 + level)])
507
508 static guint
509 translate_keysym (guint           hardware_keycode,
510                   gint            group,
511                   GdkModifierType state,
512                   gint           *effective_group,
513                   gint           *effective_level)
514 {
515   gint level;
516   guint tmp_keyval;
517
518   level = (state & GDK_SHIFT_MASK) ? 1 : 0;
519
520   if (!(GET_KEYVAL (hardware_keycode, group, 0) || GET_KEYVAL (hardware_keycode, group, 1)) &&
521       (GET_KEYVAL (hardware_keycode, 0, 0) || GET_KEYVAL (hardware_keycode, 0, 1)))
522     group = 0;
523
524   if (!GET_KEYVAL (hardware_keycode, group, level) &&
525       GET_KEYVAL (hardware_keycode, group, 0))
526     level = 0;
527
528   tmp_keyval = GET_KEYVAL (hardware_keycode, group, level);
529
530   if (state & GDK_LOCK_MASK)
531     {
532       guint upper = gdk_keyval_to_upper (tmp_keyval);
533         if (upper != tmp_keyval)
534           tmp_keyval = upper;
535     }
536
537   return tmp_keyval;
538 }
539
540 gboolean
541 gdk_keymap_translate_keyboard_state (GdkKeymap       *keymap,
542                                      guint            hardware_keycode,
543                                      GdkModifierType  state,
544                                      gint             group,
545                                      guint           *keyval,
546                                      gint            *effective_group,
547                                      gint            *level,
548                                      GdkModifierType *consumed_modifiers)
549 {
550   guint tmp_keyval;
551   GdkModifierType bit;
552   guint tmp_modifiers = 0;
553
554   g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), FALSE);
555   g_return_val_if_fail (group >= 0 && group <= 1, FALSE);
556   
557   maybe_update_keymap ();
558
559   if (keyval)
560     *keyval = 0;
561   if (effective_group)
562     *effective_group = 0;
563   if (level)
564     *level = 0;
565   if (consumed_modifiers)
566     *consumed_modifiers = 0;
567
568   if (hardware_keycode < 0 || hardware_keycode >= NUM_KEYCODES)
569     return FALSE;
570   
571   /* Check if shift or capslock modify the keyval */
572   for (bit = GDK_SHIFT_MASK; bit < GDK_CONTROL_MASK; bit <<= 1)
573     {
574       if (translate_keysym (hardware_keycode, group, state & ~bit, NULL, NULL) !=
575           translate_keysym (hardware_keycode, group, state | bit, NULL, NULL))
576         tmp_modifiers |= bit;
577     }
578
579   tmp_keyval = translate_keysym (hardware_keycode, group, state, level, effective_group);
580
581   if (consumed_modifiers)
582     *consumed_modifiers = tmp_modifiers;
583
584   if (keyval)
585     *keyval = tmp_keyval; 
586
587   return TRUE;
588 }
589
590 /* What sort of key event is this? Returns one of
591  * GDK_KEY_PRESS, GDK_KEY_RELEASE, GDK_NOTHING (should be ignored)
592  */
593 GdkEventType
594 _gdk_quartz_key_event_type (NSEvent *event)
595 {
596   unsigned short keycode;
597   unsigned int flags;
598   int i;
599   
600   switch ([event type])
601     {
602     case NSKeyDown:
603       return GDK_KEY_PRESS;
604     case NSKeyUp:
605       return GDK_KEY_RELEASE;
606     case NSFlagsChanged:
607       break;
608     default:
609       g_assert_not_reached ();
610     }
611   
612   /* For flags-changed events, we have to find the special key that caused the
613    * event, and see if it's in the modifier mask. */
614   keycode = [event keyCode];
615   flags = [event modifierFlags];
616   
617   for (i = 0; i < G_N_ELEMENTS (known_keys); i++)
618     {
619       if (known_keys[i].keycode == keycode)
620         {
621           if (flags & known_keys[i].modmask)
622             return GDK_KEY_PRESS;
623           else
624             return GDK_KEY_RELEASE;
625         }
626     }
627   
628   /* Some keypresses (eg: Expose' activations) seem to trigger flags-changed
629    * events for no good reason. Ignore them! */
630   return GDK_NOTHING;
631 }
632
633 gboolean
634 _gdk_quartz_key_is_modifier (guint keycode)
635 {
636   gint i;
637   
638   for (i = 0; i < G_N_ELEMENTS (known_keys); i++)
639     {
640       if (known_keys[i].modmask == 0)
641         break;
642
643       if (known_keys[i].keycode == keycode)
644         return TRUE;
645     }
646
647   return FALSE;
648 }