This repository has been archived by the owner on Feb 11, 2021. It is now read-only.
/
SDL_cocoakeyboard.m
575 lines (504 loc) · 20.4 KB
1
2
/*
SDL - Simple DirectMedia Layer
3
Copyright (C) 1997-2009 Sam Lantinga
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
Sam Lantinga
slouken@libsdl.org
*/
#include "SDL_config.h"
#include "SDL_cocoavideo.h"
#include "../../events/SDL_keyboard_c.h"
27
#include "../../events/scancodes_darwin.h"
28
29
30
#include <Carbon/Carbon.h>
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
#ifndef NX_DEVICERCTLKEYMASK
#define NX_DEVICELCTLKEYMASK 0x00000001
#endif
#ifndef NX_DEVICELSHIFTKEYMASK
#define NX_DEVICELSHIFTKEYMASK 0x00000002
#endif
#ifndef NX_DEVICERSHIFTKEYMASK
#define NX_DEVICERSHIFTKEYMASK 0x00000004
#endif
#ifndef NX_DEVICELCMDKEYMASK
#define NX_DEVICELCMDKEYMASK 0x00000008
#endif
#ifndef NX_DEVICERCMDKEYMASK
#define NX_DEVICERCMDKEYMASK 0x00000010
#endif
#ifndef NX_DEVICELALTKEYMASK
#define NX_DEVICELALTKEYMASK 0x00000020
#endif
#ifndef NX_DEVICERALTKEYMASK
#define NX_DEVICERALTKEYMASK 0x00000040
#endif
#ifndef NX_DEVICERCTLKEYMASK
#define NX_DEVICERCTLKEYMASK 0x00002000
#endif
57
58
59
60
61
62
63
@interface SDLTranslatorResponder : NSTextView
{
}
- (void) doCommandBySelector:(SEL)myselector;
@end
@implementation SDLTranslatorResponder
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
- (void) insertText:(id) aString
{
const char *str;
NSLog(@"insertText: %@", aString);
if ([aString isKindOfClass: [NSAttributedString class]])
str = [[aString string] UTF8String];
else
str = [aString UTF8String];
SDL_SendKeyboardText(0, str);
}
- (void) doCommandBySelector:(SEL) myselector
{
NSLog(@"doCommandBySelector, passed down");
[super doCommandBySelector: myselector];
}
84
85
@end
86
87
88
89
90
91
92
/* This is the original behavior, before support was added for
* differentiating between left and right versions of the keys.
*/
static void
DoUnsidedModifiers(int keyboard, unsigned short scancode,
unsigned int oldMods, unsigned int newMods)
{
93
94
95
96
97
98
99
const int mapping[] = {
SDL_SCANCODE_CAPSLOCK,
SDL_SCANCODE_LSHIFT,
SDL_SCANCODE_LCTRL,
SDL_SCANCODE_LALT,
SDL_SCANCODE_LGUI
};
100
101
102
103
104
105
106
107
108
109
110
111
unsigned int i, bit;
/* Iterate through the bits, testing each against the current modifiers */
for (i = 0, bit = NSAlphaShiftKeyMask; bit <= NSCommandKeyMask; bit <<= 1, ++i) {
unsigned int oldMask, newMask;
oldMask = oldMods & bit;
newMask = newMods & bit;
if (oldMask && oldMask != newMask) { /* modifier up event */
/* If this was Caps Lock, we need some additional voodoo to make SDL happy */
if (bit == NSAlphaShiftKeyMask) {
112
SDL_SendKeyboardKey(keyboard, SDL_PRESSED, mapping[i]);
113
}
114
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, mapping[i]);
115
} else if (newMask && oldMask != newMask) { /* modifier down event */
116
SDL_SendKeyboardKey(keyboard, SDL_PRESSED, mapping[i]);
117
118
/* If this was Caps Lock, we need some additional voodoo to make SDL happy */
if (bit == NSAlphaShiftKeyMask) {
119
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, mapping[i]);
120
121
122
123
124
125
126
127
128
129
}
}
}
}
/* This is a helper function for HandleModifierSide. This
* function reverts back to behavior before the distinction between
* sides was made.
*/
static void
130
HandleNonDeviceModifier(int keyboard,
131
132
133
unsigned int device_independent_mask,
unsigned int oldMods,
unsigned int newMods,
134
SDL_scancode scancode)
135
136
137
138
139
140
141
142
143
144
{
unsigned int oldMask, newMask;
/* Isolate just the bits we care about in the depedent bits so we can
* figure out what changed
*/
oldMask = oldMods & device_independent_mask;
newMask = newMods & device_independent_mask;
if (oldMask && oldMask != newMask) {
145
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, scancode);
146
} else if (newMask && oldMask != newMask) {
147
SDL_SendKeyboardKey(keyboard, SDL_PRESSED, scancode);
148
149
150
151
152
153
154
}
}
/* This is a helper function for HandleModifierSide.
* This function sets the actual SDL_PrivateKeyboard event.
*/
static void
155
HandleModifierOneSide(int keyboard,
156
unsigned int oldMods, unsigned int newMods,
157
SDL_scancode scancode,
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
unsigned int sided_device_dependent_mask)
{
unsigned int old_dep_mask, new_dep_mask;
/* Isolate just the bits we care about in the depedent bits so we can
* figure out what changed
*/
old_dep_mask = oldMods & sided_device_dependent_mask;
new_dep_mask = newMods & sided_device_dependent_mask;
/* We now know that this side bit flipped. But we don't know if
* it went pressed to released or released to pressed, so we must
* find out which it is.
*/
if (new_dep_mask && old_dep_mask != new_dep_mask) {
173
SDL_SendKeyboardKey(keyboard, SDL_PRESSED, scancode);
174
} else {
175
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, scancode);
176
177
178
179
180
181
182
183
}
}
/* This is a helper function for DoSidedModifiers.
* This function will figure out if the modifier key is the left or right side,
* e.g. left-shift vs right-shift.
*/
static void
184
HandleModifierSide(int keyboard,
185
186
int device_independent_mask,
unsigned int oldMods, unsigned int newMods,
187
188
SDL_scancode left_scancode,
SDL_scancode right_scancode,
189
190
191
192
193
194
195
196
197
198
199
200
201
unsigned int left_device_dependent_mask,
unsigned int right_device_dependent_mask)
{
unsigned int device_dependent_mask = (left_device_dependent_mask |
right_device_dependent_mask);
unsigned int diff_mod;
/* On the basis that the device independent mask is set, but there are
* no device dependent flags set, we'll assume that we can't detect this
* keyboard and revert to the unsided behavior.
*/
if ((device_dependent_mask & newMods) == 0) {
/* Revert to the old behavior */
202
HandleNonDeviceModifier(keyboard, device_independent_mask, oldMods, newMods, left_scancode);
203
204
205
206
207
208
209
210
211
212
213
214
return;
}
/* XOR the previous state against the new state to see if there's a change */
diff_mod = (device_dependent_mask & oldMods) ^
(device_dependent_mask & newMods);
if (diff_mod) {
/* A change in state was found. Isolate the left and right bits
* to handle them separately just in case the values can simulataneously
* change or if the bits don't both exist.
*/
if (left_device_dependent_mask & diff_mod) {
215
HandleModifierOneSide(keyboard, oldMods, newMods, left_scancode, left_device_dependent_mask);
216
217
}
if (right_device_dependent_mask & diff_mod) {
218
HandleModifierOneSide(keyboard, oldMods, newMods, right_scancode, right_device_dependent_mask);
219
220
221
222
223
224
225
226
227
228
}
}
}
/* This is a helper function for DoSidedModifiers.
* This function will release a key press in the case that
* it is clear that the modifier has been released (i.e. one side
* can't still be down).
*/
static void
229
ReleaseModifierSide(int keyboard,
230
231
unsigned int device_independent_mask,
unsigned int oldMods, unsigned int newMods,
232
233
SDL_scancode left_scancode,
SDL_scancode right_scancode,
234
235
236
237
238
239
240
241
242
243
244
245
246
247
unsigned int left_device_dependent_mask,
unsigned int right_device_dependent_mask)
{
unsigned int device_dependent_mask = (left_device_dependent_mask |
right_device_dependent_mask);
/* On the basis that the device independent mask is set, but there are
* no device dependent flags set, we'll assume that we can't detect this
* keyboard and revert to the unsided behavior.
*/
if ((device_dependent_mask & oldMods) == 0) {
/* In this case, we can't detect the keyboard, so use the left side
* to represent both, and release it.
*/
248
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, left_scancode);
249
250
251
252
253
254
255
256
257
258
return;
}
/*
* This could have been done in an if-else case because at this point,
* we know that all keys have been released when calling this function.
* But I'm being paranoid so I want to handle each separately,
* so I hope this doesn't cause other problems.
*/
if ( left_device_dependent_mask & oldMods ) {
259
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, left_scancode);
260
261
}
if ( right_device_dependent_mask & oldMods ) {
262
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, right_scancode);
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
}
}
/* This is a helper function for DoSidedModifiers.
* This function handles the CapsLock case.
*/
static void
HandleCapsLock(int keyboard, unsigned short scancode,
unsigned int oldMods, unsigned int newMods)
{
unsigned int oldMask, newMask;
oldMask = oldMods & NSAlphaShiftKeyMask;
newMask = newMods & NSAlphaShiftKeyMask;
if (oldMask != newMask) {
279
280
SDL_SendKeyboardKey(keyboard, SDL_PRESSED, SDL_SCANCODE_CAPSLOCK);
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, SDL_SCANCODE_CAPSLOCK);
281
}
282
283
284
285
286
oldMask = oldMods & NSNumericPadKeyMask;
newMask = newMods & NSNumericPadKeyMask;
if (oldMask != newMask) {
287
288
SDL_SendKeyboardKey(keyboard, SDL_PRESSED, SDL_SCANCODE_NUMLOCKCLEAR);
SDL_SendKeyboardKey(keyboard, SDL_RELEASED, SDL_SCANCODE_NUMLOCKCLEAR);
289
}
290
291
292
293
294
295
296
297
298
299
}
/* This function will handle the modifier keys and also determine the
* correct side of the key.
*/
static void
DoSidedModifiers(int keyboard, unsigned short scancode,
unsigned int oldMods, unsigned int newMods)
{
/* Set up arrays for the key syms for the left and right side. */
300
301
302
303
304
305
306
307
308
309
310
311
const SDL_scancode left_mapping[] = {
SDL_SCANCODE_LSHIFT,
SDL_SCANCODE_LCTRL,
SDL_SCANCODE_LALT,
SDL_SCANCODE_LGUI
};
const SDL_scancode right_mapping[] = {
SDL_SCANCODE_RSHIFT,
SDL_SCANCODE_RCTRL,
SDL_SCANCODE_RALT,
SDL_SCANCODE_RGUI
};
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/* Set up arrays for the device dependent masks with indices that
* correspond to the _mapping arrays
*/
const unsigned int left_device_mapping[] = { NX_DEVICELSHIFTKEYMASK, NX_DEVICELCTLKEYMASK, NX_DEVICELALTKEYMASK, NX_DEVICELCMDKEYMASK };
const unsigned int right_device_mapping[] = { NX_DEVICERSHIFTKEYMASK, NX_DEVICERCTLKEYMASK, NX_DEVICERALTKEYMASK, NX_DEVICERCMDKEYMASK };
unsigned int i, bit;
/* Handle CAPSLOCK separately because it doesn't have a left/right side */
HandleCapsLock(keyboard, scancode, oldMods, newMods);
/* Iterate through the bits, testing each against the old modifiers */
for (i = 0, bit = NSShiftKeyMask; bit <= NSCommandKeyMask; bit <<= 1, ++i) {
unsigned int oldMask, newMask;
oldMask = oldMods & bit;
newMask = newMods & bit;
/* If the bit is set, we must always examine it because the left
* and right side keys may alternate or both may be pressed.
*/
if (newMask) {
334
HandleModifierSide(keyboard, bit, oldMods, newMods,
335
336
337
338
339
340
341
left_mapping[i], right_mapping[i],
left_device_mapping[i], right_device_mapping[i]);
}
/* If the state changed from pressed to unpressed, we must examine
* the device dependent bits to release the correct keys.
*/
else if (oldMask && oldMask != newMask) {
342
ReleaseModifierSide(keyboard, bit, oldMods, newMods,
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
left_mapping[i], right_mapping[i],
left_device_mapping[i], right_device_mapping[i]);
}
}
}
static void
HandleModifiers(_THIS, unsigned short scancode, unsigned int modifierFlags)
{
SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
if (modifierFlags == data->modifierFlags) {
return;
}
/*
* Starting with Panther (10.3.0), the ability to distinguish between
* left side and right side modifiers is available.
*/
if (data->osversion >= 0x1030) {
DoSidedModifiers(data->keyboard, scancode, data->modifierFlags, modifierFlags);
} else {
DoUnsidedModifiers(data->keyboard, scancode, data->modifierFlags, modifierFlags);
}
data->modifierFlags = modifierFlags;
}
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
static void
UpdateKeymap(SDL_VideoData *data)
{
KeyboardLayoutRef key_layout;
const void *chr_data;
int i;
SDL_scancode scancode;
SDLKey keymap[SDL_NUM_SCANCODES];
/* See if the keymap needs to be updated */
KLGetCurrentKeyboardLayout(&key_layout);
if (key_layout == data->key_layout) {
return;
}
data->key_layout = key_layout;
SDL_GetDefaultKeymap(keymap);
/* Try Unicode data first (preferred as of Mac OS X 10.5) */
KLGetKeyboardLayoutProperty(key_layout, kKLuchrData, &chr_data);
if (chr_data) {
UInt32 keyboard_type = LMGetKbdType();
OSStatus err;
394
for (i = 0; i < SDL_arraysize(darwin_scancode_table); i++) {
395
396
397
398
399
UniChar s[8];
UniCharCount len;
UInt32 dead_key_state;
/* Make sure this scancode is a valid character scancode */
400
scancode = darwin_scancode_table[i];
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
if (scancode == SDL_SCANCODE_UNKNOWN ||
(keymap[scancode] & SDLK_SCANCODE_MASK)) {
continue;
}
dead_key_state = 0;
err = UCKeyTranslate (chr_data, i, kUCKeyActionDown,
0, keyboard_type,
kUCKeyTranslateNoDeadKeysMask,
&dead_key_state, 8, &len, s);
if (err != noErr)
continue;
if (len > 0 && s[0] != 0x10) {
keymap[scancode] = s[0];
}
}
SDL_SetKeymap(data->keyboard, 0, keymap, SDL_NUM_SCANCODES);
return;
}
/* Fall back to older style key map data */
KLGetKeyboardLayoutProperty(key_layout, kKLKCHRData, &chr_data);
if (chr_data) {
for (i = 0; i < 128; i++) {
UInt32 c, state = 0;
/* Make sure this scancode is a valid character scancode */
429
scancode = darwin_scancode_table[i];
430
431
432
433
434
if (scancode == SDL_SCANCODE_UNKNOWN ||
(keymap[scancode] & SDLK_SCANCODE_MASK)) {
continue;
}
435
c = KeyTranslate (chr_data, i, &state) & 255;
436
437
if (state) {
/* Dead key, process key up */
438
c = KeyTranslate (chr_data, i | 128, &state) & 255;
439
440
}
441
if (c != 0 && c != 0x10) {
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
/* MacRoman to Unicode table, taken from X.org sources */
static const unsigned short macroman_table[128] = {
0xc4, 0xc5, 0xc7, 0xc9, 0xd1, 0xd6, 0xdc, 0xe1,
0xe0, 0xe2, 0xe4, 0xe3, 0xe5, 0xe7, 0xe9, 0xe8,
0xea, 0xeb, 0xed, 0xec, 0xee, 0xef, 0xf1, 0xf3,
0xf2, 0xf4, 0xf6, 0xf5, 0xfa, 0xf9, 0xfb, 0xfc,
0x2020, 0xb0, 0xa2, 0xa3, 0xa7, 0x2022, 0xb6, 0xdf,
0xae, 0xa9, 0x2122, 0xb4, 0xa8, 0x2260, 0xc6, 0xd8,
0x221e, 0xb1, 0x2264, 0x2265, 0xa5, 0xb5, 0x2202, 0x2211,
0x220f, 0x3c0, 0x222b, 0xaa, 0xba, 0x3a9, 0xe6, 0xf8,
0xbf, 0xa1, 0xac, 0x221a, 0x192, 0x2248, 0x2206, 0xab,
0xbb, 0x2026, 0xa0, 0xc0, 0xc3, 0xd5, 0x152, 0x153,
0x2013, 0x2014, 0x201c, 0x201d, 0x2018, 0x2019, 0xf7, 0x25ca,
0xff, 0x178, 0x2044, 0x20ac, 0x2039, 0x203a, 0xfb01, 0xfb02,
0x2021, 0xb7, 0x201a, 0x201e, 0x2030, 0xc2, 0xca, 0xc1,
0xcb, 0xc8, 0xcd, 0xce, 0xcf, 0xcc, 0xd3, 0xd4,
0xf8ff, 0xd2, 0xda, 0xdb, 0xd9, 0x131, 0x2c6, 0x2dc,
0xaf, 0x2d8, 0x2d9, 0x2da, 0xb8, 0x2dd, 0x2db, 0x2c7,
};
if (c >= 128) {
c = macroman_table[c - 128];
}
keymap[scancode] = c;
}
}
SDL_SetKeymap(data->keyboard, 0, keymap, SDL_NUM_SCANCODES);
return;
}
}
473
474
475
476
477
void
Cocoa_InitKeyboard(_THIS)
{
SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
SDL_Keyboard keyboard;
478
NSAutoreleasePool *pool;
479
480
pool = [[NSAutoreleasePool alloc] init];
481
data->fieldEdit = [[SDLTranslatorResponder alloc] initWithFrame:NSMakeRect(0.0, 0.0, 0.0, 0.0)];
482
[pool release];
483
484
485
SDL_zero(keyboard);
data->keyboard = SDL_AddKeyboard(&keyboard, -1);
486
UpdateKeymap(data);
487
488
/* Set our own names for the platform-dependent but layout-independent keys */
489
490
491
492
493
494
/* This key is NumLock on the MacBook keyboard. :) */
/*SDL_SetScancodeName(SDL_SCANCODE_NUMLOCKCLEAR, "Clear");*/
SDL_SetScancodeName(SDL_SCANCODE_LALT, "Left Option");
SDL_SetScancodeName(SDL_SCANCODE_LGUI, "Left Command");
SDL_SetScancodeName(SDL_SCANCODE_RALT, "Right Option");
SDL_SetScancodeName(SDL_SCANCODE_RGUI, "Right Command");
495
496
}
497
498
499
500
501
void
Cocoa_HandleKeyEvent(_THIS, NSEvent *event)
{
SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
unsigned short scancode = [event keyCode];
502
SDL_scancode code;
503
504
const char *text;
505
506
507
508
if ((scancode == 10 || scancode == 50) && KBGetLayoutType(LMGetKbdType()) == kKeyboardISO) {
/* see comments in SDL_cocoakeys.h */
scancode = 60 - scancode;
}
509
510
if (scancode < SDL_arraysize(darwin_scancode_table)) {
code = darwin_scancode_table[scancode];
511
512
}
else {
513
/* Hmm, does this ever happen? If so, need to extend the keymap... */
514
code = SDL_SCANCODE_UNKNOWN;
515
516
517
518
}
switch ([event type]) {
case NSKeyDown:
519
if (![event isARepeat]) {
520
521
522
523
/* See if we need to rebuild the keyboard layout */
UpdateKeymap(data);
SDL_SendKeyboardKey(data->keyboard, SDL_PRESSED, code);
524
#if 1
525
if (code == SDL_SCANCODE_UNKNOWN) {
526
527
528
fprintf(stderr, "The key you just pressed is not recognized by SDL. To help get this fixed, report this to the SDL mailing list <sdl@libsdl.org> or to Christian Walther <cwalther@gmx.ch>. Mac virtual key code is %d.\n", scancode);
}
#endif
529
}
530
if (SDL_EventState(SDL_TEXTINPUT, SDL_QUERY)) {
531
/* FIXME CW 2007-08-16: only send those events to the field editor for which we actually want text events, not e.g. esc or function keys. Arrow keys in particular seem to produce crashes sometimes. */
532
533
534
535
536
537
538
539
NSLog(@"interpretKeyEvents");
if (! [[data->fieldEdit superview] isEqual: [[event window] contentView]])
{
NSLog(@"add fieldEdit to window contentView");
[data->fieldEdit removeFromSuperview];
[[[event window] contentView] addSubview: data->fieldEdit];
[[event window] makeFirstResponder: data->fieldEdit];
}
540
[data->fieldEdit interpretKeyEvents:[NSArray arrayWithObject:event]];
541
#if 0
542
543
544
text = [[event characters] UTF8String];
if(text && *text) {
SDL_SendKeyboardText(data->keyboard, text);
545
[data->fieldEdit setString:@""];
546
}
547
#endif
548
549
550
}
break;
case NSKeyUp:
551
SDL_SendKeyboardKey(data->keyboard, SDL_RELEASED, code);
552
553
break;
case NSFlagsChanged:
554
/* FIXME CW 2007-08-14: check if this whole mess that takes up half of this file is really necessary */
555
556
HandleModifiers(_this, scancode, [event modifierFlags]);
break;
557
558
559
560
561
default: /* just to avoid compiler warnings */
break;
}
}
562
563
564
565
void
Cocoa_QuitKeyboard(_THIS)
{
SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
566
NSAutoreleasePool *pool;
567
568
SDL_DelKeyboard(data->keyboard);
569
570
pool = [[NSAutoreleasePool alloc] init];
571
[data->fieldEdit release];
572
[pool release];
573
574
575
}
/* vi: set ts=4 sw=4 expandtab: */