3 * Copyright (C) 2000 Red Hat, Inc.
4 * Copyright (C) 2005 Imendio AB
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.
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.
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.
21 /* Some parts of this code come from quartzKeyboard.c,
22 * from the Apple X11 Server.
24 * Copyright (c) 2003 Apple Computer, Inc. All rights reserved.
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:
34 * The above copyright notice and this permission notice shall be
35 * included in all copies or substantial portions of the Software.
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.
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.
54 #include <Carbon/Carbon.h>
55 #include <AppKit/NSEvent.h>
57 #include "gdkkeysyms.h"
59 #define NUM_KEYCODES 128
60 #define KEYVALS_PER_KEYCODE 4
62 static GdkKeymap *default_keymap = NULL;
64 static KeyboardLayoutRef current_layout = NULL;
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);
69 static guint *keyval_array = NULL;
72 macroman2ucs (unsigned char c)
74 /* Precalculated table mapping MacRoman-128 to Unicode. Generated
75 by creating single element CFStringRefs then extracting the
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
100 return table[c - 128];
103 const static struct {
106 unsigned int modmask; /* So we can tell when a mod key is pressed/released */
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 },
134 const static struct {
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 }
157 /* These values aren't covered by gdk_unicode_to_keyval */
158 const static struct {
161 } special_ucs_table [] = {
162 { 0x0001, GDK_Home },
163 { 0x0003, GDK_Return },
165 { 0x0008, GDK_BackSpace },
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 },
174 { 0x001f, GDK_Down },
175 { 0x007f, GDK_Delete }
179 maybe_update_keymap (void)
181 KeyboardLayoutRef new_layout;
183 KLGetCurrentKeyboardLayout (&new_layout);
185 if (new_layout != current_layout)
190 KeyboardLayoutKind layout_kind;
192 g_free (keyval_array);
193 keyval_array = g_new0 (guint, NUM_KEYCODES * KEYVALS_PER_KEYCODE);
195 /* Get the layout kind */
196 KLGetKeyboardLayoutProperty (new_layout, kKLKind, (const void **)&layout_kind);
198 /* 8-bit-only keyabord layout */
199 if (layout_kind == kKLKCHRKind)
201 const void *chr_data;
204 KLGetKeyboardLayoutProperty (new_layout, kKLKCHRData, (const void **)&chr_data);
206 for (i = 0; i < NUM_KEYCODES; i++)
209 UInt32 modifiers[] = {0, shiftKey, optionKey, shiftKey | optionKey};
211 p = keyval_array + i * KEYVALS_PER_KEYCODE;
213 for (j = 0; j < KEYVALS_PER_KEYCODE; j++)
219 key_code = modifiers[j] | i;
220 c = KeyTranslate (chr_data, key_code, &state);
225 c = KeyTranslate (chr_data, key_code | 128, &state2);
228 if (c != 0 && c != 0x10)
231 gboolean found = FALSE;
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
239 uc = macroman2ucs (c);
241 for (k = 0; k < G_N_ELEMENTS (special_ucs_table); k++)
243 if (special_ucs_table[k].ucs_value == uc)
245 p[j] = special_ucs_table[k].keyval;
251 /* Special-case shift-tab since GTK+ expects
252 * GDK_ISO_Left_Tab for that.
254 if (found && p[j] == GDK_Tab && modifiers[j] == shiftKey)
255 p[j] = GDK_ISO_Left_Tab;
258 p[j] = gdk_unicode_to_keyval (uc);
273 /* unicode keyboard layout */
274 else if (layout_kind == kKLKCHRuchrKind || layout_kind == kKLuchrKind)
276 const void *chr_data;
279 KLGetKeyboardLayoutProperty (new_layout, kKLuchrData, (const void **)&chr_data);
281 for (i = 0; i < NUM_KEYCODES; i++)
284 UInt32 modifiers[] = {0, shiftKey, optionKey, shiftKey | optionKey};
288 p = keyval_array + i * KEYVALS_PER_KEYCODE;
290 for (j = 0; j < KEYVALS_PER_KEYCODE; j++)
297 key_code = modifiers[j] | i;
298 err = UCKeyTranslate (chr_data, i, kUCKeyActionDown,
299 (modifiers[j] >> 8) & 0xFF,
301 kUCKeyTranslateNoDeadKeysMask,
302 &state, 4, &nChars, chars);
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)
312 gboolean found = FALSE;
316 for (k = 0; k < G_N_ELEMENTS (special_ucs_table); k++)
318 if (special_ucs_table[k].ucs_value == uc)
320 p[j] = special_ucs_table[k].keyval;
327 p[j] = gdk_unicode_to_keyval (uc);
344 g_error ("unknown type of keyboard layout (neither KCHR nor uchr)"
345 " - not supported right now");
348 for (i = 0; i < G_N_ELEMENTS (known_keys); i++)
350 p = keyval_array + known_keys[i].keycode * KEYVALS_PER_KEYCODE;
352 if (p[0] == 0 && p[1] == 0 &&
353 p[2] == 0 && p[3] == 0)
354 p[0] = known_keys[i].keyval;
357 for (i = 0; i < G_N_ELEMENTS (known_numeric_keys); i++)
359 p = keyval_array + known_numeric_keys[i].keycode * KEYVALS_PER_KEYCODE;
361 if (p[0] == known_numeric_keys[i].normal_keyval);
362 p[0] = known_numeric_keys[i].keypad_keyval;
366 g_signal_emit_by_name (default_keymap, "keys_changed");
368 current_layout = new_layout;
373 gdk_keymap_get_for_display (GdkDisplay *display)
375 g_return_val_if_fail (display == gdk_display_get_default (), NULL);
377 if (default_keymap == NULL)
378 default_keymap = g_object_new (gdk_keymap_get_type (), NULL);
380 return default_keymap;
384 gdk_keymap_get_direction (GdkKeymap *keymap)
386 return PANGO_DIRECTION_NEUTRAL;
390 gdk_keymap_have_bidi_layouts (GdkKeymap *keymap)
392 /* FIXME: Can we implement this? */
397 gdk_keymap_get_entries_for_keyval (GdkKeymap *keymap,
405 g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), FALSE);
406 g_return_val_if_fail (keys != NULL, FALSE);
407 g_return_val_if_fail (n_keys != NULL, FALSE);
408 g_return_val_if_fail (keyval != 0, FALSE);
410 maybe_update_keymap ();
413 keys_array = g_array_new (FALSE, FALSE, sizeof (GdkKeymapKey));
415 for (i = 0; i < NUM_KEYCODES * KEYVALS_PER_KEYCODE; i++)
419 if (keyval_array[i] != keyval)
424 key.keycode = i / KEYVALS_PER_KEYCODE;
426 key.level = i % KEYVALS_PER_KEYCODE;
428 g_array_append_val (keys_array, key);
431 *keys = (GdkKeymapKey *)g_array_free (keys_array, FALSE);
437 gdk_keymap_get_entries_for_keycode (GdkKeymap *keymap,
438 guint hardware_keycode,
443 GArray *keys_array, *keyvals_array;
447 g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), FALSE);
448 g_return_val_if_fail (n_entries != NULL, FALSE);
450 maybe_update_keymap ();
454 if (hardware_keycode > NUM_KEYCODES)
458 keys_array = g_array_new (FALSE, FALSE, sizeof (GdkKeymapKey));
463 keyvals_array = g_array_new (FALSE, FALSE, sizeof (guint));
465 keyvals_array = NULL;
467 p = keyval_array + hardware_keycode * KEYVALS_PER_KEYCODE;
469 for (i = 0; i < KEYVALS_PER_KEYCODE; i++)
477 g_array_append_val (keyvals_array, p[i]);
483 key.keycode = hardware_keycode;
487 g_array_append_val (keys_array, key);
492 *keys = (GdkKeymapKey *)g_array_free (keys_array, FALSE);
495 *keyvals = (guint *)g_array_free (keyvals_array, FALSE);
497 return *n_entries > 0;
501 gdk_keymap_lookup_key (GdkKeymap *keymap,
502 const GdkKeymapKey *key)
504 g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), 0);
505 g_return_val_if_fail (key != NULL, 0);
506 g_return_val_if_fail (key->group < 4, 0);
508 /* FIXME: Implement */
513 #define GET_KEYVAL(keycode, group, level) (keyval_array[(keycode * KEYVALS_PER_KEYCODE + group * 2 + level)])
516 translate_keysym (guint hardware_keycode,
518 GdkModifierType state,
519 gint *effective_group,
520 gint *effective_level)
525 level = (state & GDK_SHIFT_MASK) ? 1 : 0;
527 if (!(GET_KEYVAL (hardware_keycode, group, 0) || GET_KEYVAL (hardware_keycode, group, 1)) &&
528 (GET_KEYVAL (hardware_keycode, 0, 0) || GET_KEYVAL (hardware_keycode, 0, 1)))
531 if (!GET_KEYVAL (hardware_keycode, group, level) &&
532 GET_KEYVAL (hardware_keycode, group, 0))
535 tmp_keyval = GET_KEYVAL (hardware_keycode, group, level);
537 if (state & GDK_LOCK_MASK)
539 guint upper = gdk_keyval_to_upper (tmp_keyval);
540 if (upper != tmp_keyval)
548 gdk_keymap_translate_keyboard_state (GdkKeymap *keymap,
549 guint hardware_keycode,
550 GdkModifierType state,
553 gint *effective_group,
555 GdkModifierType *consumed_modifiers)
559 guint tmp_modifiers = 0;
561 g_return_val_if_fail (keymap == NULL || GDK_IS_KEYMAP (keymap), FALSE);
562 g_return_val_if_fail (group >= 0 && group <= 1, FALSE);
564 maybe_update_keymap ();
569 *effective_group = 0;
572 if (consumed_modifiers)
573 *consumed_modifiers = 0;
575 if (hardware_keycode < 0 || hardware_keycode >= NUM_KEYCODES)
578 /* Check if shift or capslock modify the keyval */
579 for (bit = GDK_SHIFT_MASK; bit < GDK_CONTROL_MASK; bit <<= 1)
581 if (translate_keysym (hardware_keycode, group, state & ~bit, NULL, NULL) !=
582 translate_keysym (hardware_keycode, group, state | bit, NULL, NULL))
583 tmp_modifiers |= bit;
586 tmp_keyval = translate_keysym (hardware_keycode, group, state, level, effective_group);
588 if (consumed_modifiers)
589 *consumed_modifiers = tmp_modifiers;
592 *keyval = tmp_keyval;
597 /* What sort of key event is this? Returns one of
598 * GDK_KEY_PRESS, GDK_KEY_RELEASE, GDK_NOTHING (should be ignored)
601 _gdk_quartz_keys_event_type (NSEvent *event)
603 unsigned short keycode;
607 switch ([event type])
610 return GDK_KEY_PRESS;
612 return GDK_KEY_RELEASE;
616 g_assert_not_reached ();
619 /* For flags-changed events, we have to find the special key that caused the
620 * event, and see if it's in the modifier mask. */
621 keycode = [event keyCode];
622 flags = [event modifierFlags];
624 for (i = 0; i < G_N_ELEMENTS (known_keys); i++)
626 if (known_keys[i].keycode == keycode)
628 if (flags & known_keys[i].modmask)
629 return GDK_KEY_PRESS;
631 return GDK_KEY_RELEASE;
635 /* Some keypresses (eg: Expose' activations) seem to trigger flags-changed
636 * events for no good reason. Ignore them! */
641 _gdk_quartz_keys_is_modifier (guint keycode)
645 for (i = 0; i < G_N_ELEMENTS (known_keys); i++)
647 if (known_keys[i].modmask == 0)
650 if (known_keys[i].keycode == keycode)