src/video/cocoa/SDL_cocoakeyboard.m
author Sam Lantinga <slouken@libsdl.org>
Tue, 20 Jul 2010 23:25:24 -0700
changeset 4560 95352c671a6e
parent 4498 3d91e31fcf71
child 4565 e2d46c5c7483
permissions -rw-r--r--
Added support for keyboard repeat (only tested on Windows so far)
slouken@1931
     1
/*
slouken@1931
     2
    SDL - Simple DirectMedia Layer
slouken@4498
     3
    Copyright (C) 1997-2010 Sam Lantinga
slouken@1931
     4
slouken@1931
     5
    This library is free software; you can redistribute it and/or
slouken@1931
     6
    modify it under the terms of the GNU Lesser General Public
slouken@1931
     7
    License as published by the Free Software Foundation; either
slouken@1931
     8
    version 2.1 of the License, or (at your option) any later version.
slouken@1931
     9
slouken@1931
    10
    This library is distributed in the hope that it will be useful,
slouken@1931
    11
    but WITHOUT ANY WARRANTY; without even the implied warranty of
slouken@1931
    12
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
slouken@1931
    13
    Lesser General Public License for more details.
slouken@1931
    14
slouken@1931
    15
    You should have received a copy of the GNU Lesser General Public
slouken@1931
    16
    License along with this library; if not, write to the Free Software
slouken@1931
    17
    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
slouken@1931
    18
slouken@1931
    19
    Sam Lantinga
slouken@1931
    20
    slouken@libsdl.org
slouken@1931
    21
*/
slouken@1931
    22
#include "SDL_config.h"
slouken@1931
    23
slouken@1931
    24
#include "SDL_cocoavideo.h"
slouken@1931
    25
slouken@1931
    26
#include "../../events/SDL_keyboard_c.h"
slouken@2305
    27
#include "../../events/scancodes_darwin.h"
slouken@1931
    28
slouken@2268
    29
#include <Carbon/Carbon.h>
slouken@2268
    30
slouken@3280
    31
//#define DEBUG_IME NSLog
slouken@3280
    32
#define DEBUG_IME
slouken@1959
    33
slouken@1959
    34
#ifndef NX_DEVICERCTLKEYMASK
slouken@1959
    35
    #define NX_DEVICELCTLKEYMASK    0x00000001
slouken@1959
    36
#endif
slouken@1959
    37
#ifndef NX_DEVICELSHIFTKEYMASK
slouken@1959
    38
    #define NX_DEVICELSHIFTKEYMASK  0x00000002
slouken@1959
    39
#endif
slouken@1959
    40
#ifndef NX_DEVICERSHIFTKEYMASK
slouken@1959
    41
    #define NX_DEVICERSHIFTKEYMASK  0x00000004
slouken@1959
    42
#endif
slouken@1959
    43
#ifndef NX_DEVICELCMDKEYMASK
slouken@1959
    44
    #define NX_DEVICELCMDKEYMASK    0x00000008
slouken@1959
    45
#endif
slouken@1959
    46
#ifndef NX_DEVICERCMDKEYMASK
slouken@1959
    47
    #define NX_DEVICERCMDKEYMASK    0x00000010
slouken@1959
    48
#endif
slouken@1959
    49
#ifndef NX_DEVICELALTKEYMASK
slouken@1959
    50
    #define NX_DEVICELALTKEYMASK    0x00000020
slouken@1959
    51
#endif
slouken@1959
    52
#ifndef NX_DEVICERALTKEYMASK
slouken@1959
    53
    #define NX_DEVICERALTKEYMASK    0x00000040
slouken@1959
    54
#endif
slouken@1959
    55
#ifndef NX_DEVICERCTLKEYMASK
slouken@1959
    56
    #define NX_DEVICERCTLKEYMASK    0x00002000
slouken@1959
    57
#endif
slouken@1959
    58
slouken@3280
    59
@interface SDLTranslatorResponder : NSView <NSTextInput>
slouken@2289
    60
{
slouken@3280
    61
    NSString *_markedText;
slouken@3280
    62
    NSRange   _markedRange;
slouken@3280
    63
    NSRange   _selectedRange;
slouken@3280
    64
    SDL_Rect  _inputRect;
slouken@2289
    65
}
slouken@2289
    66
- (void) doCommandBySelector:(SEL)myselector;
slouken@3280
    67
- (void) setInputRect:(SDL_Rect *) rect;
slouken@2289
    68
@end
slouken@2289
    69
slouken@2289
    70
@implementation SDLTranslatorResponder
slouken@3280
    71
slouken@3280
    72
- (void) setInputRect:(SDL_Rect *) rect
slouken@3280
    73
{
slouken@3280
    74
    _inputRect = *rect;
slouken@3280
    75
}
slouken@3280
    76
slouken@3280
    77
- (void) insertText:(id) aString
slouken@3280
    78
{
slouken@3280
    79
    const char *str;
slouken@3280
    80
slouken@3280
    81
    DEBUG_IME(@"insertText: %@", aString);
slouken@3280
    82
slouken@3280
    83
    /* Could be NSString or NSAttributedString, so we have
slouken@3280
    84
     * to test and convert it before return as SDL event */
slouken@3280
    85
    if ([aString isKindOfClass: [NSAttributedString class]])
slouken@3280
    86
        str = [[aString string] UTF8String];
slouken@3280
    87
    else
slouken@3280
    88
        str = [aString UTF8String];
slouken@3280
    89
slouken@4465
    90
    SDL_SendKeyboardText(str);
slouken@3280
    91
}
slouken@3280
    92
slouken@3280
    93
- (void) doCommandBySelector:(SEL) myselector
slouken@3280
    94
{
slouken@3683
    95
    // No need to do anything since we are not using Cocoa
slouken@3683
    96
    // selectors to handle special keys, instead we use SDL
slouken@3683
    97
    // key events to do the same job.
slouken@3280
    98
}
slouken@3280
    99
slouken@3280
   100
- (BOOL) hasMarkedText
slouken@3280
   101
{
slouken@3280
   102
    return _markedText != nil;
slouken@3280
   103
}
slouken@3280
   104
slouken@3280
   105
- (NSRange) markedRange
slouken@3280
   106
{
slouken@3280
   107
    return _markedRange;
slouken@3280
   108
}
slouken@3280
   109
slouken@3280
   110
- (NSRange) selectedRange
slouken@3280
   111
{
slouken@3280
   112
    return _selectedRange;
slouken@3280
   113
}
slouken@3280
   114
slouken@3280
   115
- (void) setMarkedText:(id) aString
slouken@3280
   116
         selectedRange:(NSRange) selRange
slouken@3280
   117
{
slouken@3280
   118
    if ([aString isKindOfClass: [NSAttributedString class]])
slouken@3280
   119
        aString = [aString string];
slouken@3280
   120
slouken@3280
   121
    if ([aString length] == 0)
slouken@3280
   122
    {
slouken@3280
   123
        [self unmarkText];
slouken@3280
   124
        return;
slouken@3280
   125
    }
slouken@3280
   126
slouken@3280
   127
    if (_markedText != aString)
slouken@3280
   128
    {
slouken@3280
   129
        [_markedText release];
slouken@3280
   130
        _markedText = [aString retain];
slouken@3280
   131
    }
slouken@3280
   132
slouken@3280
   133
    _selectedRange = selRange;
slouken@3280
   134
    _markedRange = NSMakeRange(0, [aString length]);
slouken@3280
   135
slouken@4465
   136
    SDL_SendEditingText([aString UTF8String],
slouken@4434
   137
                        selRange.location, selRange.length);
slouken@3280
   138
slouken@3280
   139
    DEBUG_IME(@"setMarkedText: %@, (%d, %d)", _markedText,
slouken@3280
   140
          selRange.location, selRange.length);
slouken@3280
   141
}
slouken@3280
   142
slouken@3280
   143
- (void) unmarkText
slouken@3280
   144
{
slouken@3280
   145
    [_markedText release];
slouken@3280
   146
    _markedText = nil;
slouken@3280
   147
}
slouken@3280
   148
slouken@3280
   149
- (NSRect) firstRectForCharacterRange: (NSRange) theRange
slouken@3280
   150
{
slouken@4436
   151
    NSWindow *window = [self window];
slouken@4436
   152
    NSRect contentRect = [window contentRectForFrameRect: [window frame]];
slouken@4436
   153
    float windowHeight = contentRect.size.height;
slouken@3280
   154
    NSRect rect = NSMakeRect(_inputRect.x, windowHeight - _inputRect.y - _inputRect.h,
slouken@3280
   155
                             _inputRect.w, _inputRect.h);
slouken@3280
   156
slouken@3280
   157
    DEBUG_IME(@"firstRectForCharacterRange: (%d, %d): windowHeight = %g, rect = %@",
slouken@3280
   158
            theRange.location, theRange.length, windowHeight,
slouken@3280
   159
            NSStringFromRect(rect));
slouken@3280
   160
    rect.origin = [[self window] convertBaseToScreen: rect.origin];
slouken@3280
   161
slouken@3280
   162
    return rect;
slouken@3280
   163
}
slouken@3280
   164
slouken@3280
   165
- (NSAttributedString *) attributedSubstringFromRange: (NSRange) theRange
slouken@3280
   166
{
slouken@3280
   167
    DEBUG_IME(@"attributedSubstringFromRange: (%d, %d)", theRange.location, theRange.length);
slouken@3280
   168
    return nil;
slouken@3280
   169
}
slouken@3280
   170
slouken@3525
   171
/* Needs long instead of NSInteger for compilation on Mac OS X 10.4 */
slouken@3525
   172
- (long) conversationIdentifier
slouken@3280
   173
{
slouken@3525
   174
    return (long) self;
slouken@3280
   175
}
slouken@3280
   176
slouken@3280
   177
// This method returns the index for character that is 
slouken@3280
   178
// nearest to thePoint.  thPoint is in screen coordinate system.
slouken@3280
   179
- (NSUInteger) characterIndexForPoint:(NSPoint) thePoint
slouken@3280
   180
{
slouken@3280
   181
    DEBUG_IME(@"characterIndexForPoint: (%g, %g)", thePoint.x, thePoint.y);
slouken@3280
   182
    return 0;
slouken@3280
   183
}
slouken@3280
   184
slouken@3280
   185
// This method is the key to attribute extension. 
slouken@3280
   186
// We could add new attributes through this method.
slouken@3280
   187
// NSInputServer examines the return value of this
slouken@3280
   188
// method & constructs appropriate attributed string.
slouken@3280
   189
- (NSArray *) validAttributesForMarkedText
slouken@3280
   190
{
slouken@3280
   191
    return [NSArray array];
slouken@3280
   192
}
slouken@3280
   193
slouken@2289
   194
@end
slouken@2289
   195
slouken@1959
   196
/* This is the original behavior, before support was added for 
slouken@1959
   197
 * differentiating between left and right versions of the keys.
slouken@1959
   198
 */
slouken@1959
   199
static void
slouken@4465
   200
DoUnsidedModifiers(unsigned short scancode,
slouken@1959
   201
                   unsigned int oldMods, unsigned int newMods)
slouken@1959
   202
{
slouken@2303
   203
    const int mapping[] = {
slouken@2303
   204
        SDL_SCANCODE_CAPSLOCK,
slouken@2303
   205
        SDL_SCANCODE_LSHIFT,
slouken@2303
   206
        SDL_SCANCODE_LCTRL,
slouken@2303
   207
        SDL_SCANCODE_LALT,
slouken@2303
   208
        SDL_SCANCODE_LGUI
slouken@2303
   209
    };
slouken@1959
   210
    unsigned int i, bit;
slouken@1959
   211
slouken@1959
   212
    /* Iterate through the bits, testing each against the current modifiers */
slouken@1959
   213
    for (i = 0, bit = NSAlphaShiftKeyMask; bit <= NSCommandKeyMask; bit <<= 1, ++i) {
slouken@1959
   214
        unsigned int oldMask, newMask;
slouken@1959
   215
slouken@1959
   216
        oldMask = oldMods & bit;
slouken@1959
   217
        newMask = newMods & bit;
slouken@1959
   218
slouken@1959
   219
        if (oldMask && oldMask != newMask) {        /* modifier up event */
slouken@1959
   220
            /* If this was Caps Lock, we need some additional voodoo to make SDL happy */
slouken@1959
   221
            if (bit == NSAlphaShiftKeyMask) {
slouken@4560
   222
                SDL_SendKeyboardKey(SDL_PRESSED, mapping[i], SDL_FALSE);
slouken@1959
   223
            }
slouken@4560
   224
            SDL_SendKeyboardKey(SDL_RELEASED, mapping[i], SDL_FALSE);
slouken@1959
   225
        } else if (newMask && oldMask != newMask) { /* modifier down event */
slouken@4560
   226
            SDL_SendKeyboardKey(SDL_PRESSED, mapping[i], SDL_FALSE);
slouken@1959
   227
            /* If this was Caps Lock, we need some additional voodoo to make SDL happy */
slouken@1959
   228
            if (bit == NSAlphaShiftKeyMask) {
slouken@4560
   229
                SDL_SendKeyboardKey(SDL_RELEASED, mapping[i], SDL_FALSE);
slouken@1959
   230
            }
slouken@1959
   231
        }
slouken@1959
   232
    }
slouken@1959
   233
}
slouken@1959
   234
slouken@1959
   235
/* This is a helper function for HandleModifierSide. This 
slouken@1959
   236
 * function reverts back to behavior before the distinction between
slouken@1959
   237
 * sides was made.
slouken@1959
   238
 */
slouken@1959
   239
static void
slouken@4465
   240
HandleNonDeviceModifier(unsigned int device_independent_mask,
slouken@1959
   241
                        unsigned int oldMods,
slouken@1959
   242
                        unsigned int newMods,
slouken@2303
   243
                        SDL_scancode scancode)
slouken@1959
   244
{
slouken@1959
   245
    unsigned int oldMask, newMask;
slouken@1959
   246
    
slouken@1959
   247
    /* Isolate just the bits we care about in the depedent bits so we can 
slouken@1959
   248
     * figure out what changed
slouken@1959
   249
     */ 
slouken@1959
   250
    oldMask = oldMods & device_independent_mask;
slouken@1959
   251
    newMask = newMods & device_independent_mask;
slouken@1959
   252
    
slouken@1959
   253
    if (oldMask && oldMask != newMask) {
slouken@4560
   254
        SDL_SendKeyboardKey(SDL_RELEASED, scancode, SDL_FALSE);
slouken@1959
   255
    } else if (newMask && oldMask != newMask) {
slouken@4560
   256
        SDL_SendKeyboardKey(SDL_PRESSED, scancode, SDL_FALSE);
slouken@1959
   257
    }
slouken@1959
   258
}
slouken@1959
   259
slouken@1959
   260
/* This is a helper function for HandleModifierSide. 
slouken@1959
   261
 * This function sets the actual SDL_PrivateKeyboard event.
slouken@1959
   262
 */
slouken@1959
   263
static void
slouken@4465
   264
HandleModifierOneSide(unsigned int oldMods, unsigned int newMods,
slouken@2303
   265
                      SDL_scancode scancode, 
slouken@1959
   266
                      unsigned int sided_device_dependent_mask)
slouken@1959
   267
{
slouken@1959
   268
    unsigned int old_dep_mask, new_dep_mask;
slouken@1959
   269
slouken@1959
   270
    /* Isolate just the bits we care about in the depedent bits so we can 
slouken@1959
   271
     * figure out what changed
slouken@1959
   272
     */ 
slouken@1959
   273
    old_dep_mask = oldMods & sided_device_dependent_mask;
slouken@1959
   274
    new_dep_mask = newMods & sided_device_dependent_mask;
slouken@1959
   275
slouken@1959
   276
    /* We now know that this side bit flipped. But we don't know if
slouken@1959
   277
     * it went pressed to released or released to pressed, so we must 
slouken@1959
   278
     * find out which it is.
slouken@1959
   279
     */
slouken@1959
   280
    if (new_dep_mask && old_dep_mask != new_dep_mask) {
slouken@4560
   281
        SDL_SendKeyboardKey(SDL_PRESSED, scancode, SDL_FALSE);
slouken@1959
   282
    } else {
slouken@4560
   283
        SDL_SendKeyboardKey(SDL_RELEASED, scancode, SDL_FALSE);
slouken@1959
   284
    }
slouken@1959
   285
}
slouken@1959
   286
slouken@1959
   287
/* This is a helper function for DoSidedModifiers.
slouken@1959
   288
 * This function will figure out if the modifier key is the left or right side, 
slouken@1959
   289
 * e.g. left-shift vs right-shift. 
slouken@1959
   290
 */
slouken@1959
   291
static void
slouken@4465
   292
HandleModifierSide(int device_independent_mask, 
slouken@1959
   293
                   unsigned int oldMods, unsigned int newMods, 
slouken@2303
   294
                   SDL_scancode left_scancode, 
slouken@2303
   295
                   SDL_scancode right_scancode,
slouken@1959
   296
                   unsigned int left_device_dependent_mask, 
slouken@1959
   297
                   unsigned int right_device_dependent_mask)
slouken@1959
   298
{
slouken@1959
   299
    unsigned int device_dependent_mask = (left_device_dependent_mask |
slouken@1959
   300
                                         right_device_dependent_mask);
slouken@1959
   301
    unsigned int diff_mod;
slouken@1959
   302
    
slouken@1959
   303
    /* On the basis that the device independent mask is set, but there are 
slouken@1959
   304
     * no device dependent flags set, we'll assume that we can't detect this 
slouken@1959
   305
     * keyboard and revert to the unsided behavior.
slouken@1959
   306
     */
slouken@1959
   307
    if ((device_dependent_mask & newMods) == 0) {
slouken@1959
   308
        /* Revert to the old behavior */
slouken@4465
   309
        HandleNonDeviceModifier(device_independent_mask, oldMods, newMods, left_scancode);
slouken@1959
   310
        return;
slouken@1959
   311
    }
slouken@1959
   312
slouken@1959
   313
    /* XOR the previous state against the new state to see if there's a change */
slouken@1959
   314
    diff_mod = (device_dependent_mask & oldMods) ^
slouken@1959
   315
               (device_dependent_mask & newMods);
slouken@1959
   316
    if (diff_mod) {
slouken@1959
   317
        /* A change in state was found. Isolate the left and right bits 
slouken@1959
   318
         * to handle them separately just in case the values can simulataneously
slouken@1959
   319
         * change or if the bits don't both exist.
slouken@1959
   320
         */
slouken@1959
   321
        if (left_device_dependent_mask & diff_mod) {
slouken@4465
   322
            HandleModifierOneSide(oldMods, newMods, left_scancode, left_device_dependent_mask);
slouken@1959
   323
        }
slouken@1959
   324
        if (right_device_dependent_mask & diff_mod) {
slouken@4465
   325
            HandleModifierOneSide(oldMods, newMods, right_scancode, right_device_dependent_mask);
slouken@1959
   326
        }
slouken@1959
   327
    }
slouken@1959
   328
}
slouken@1959
   329
   
slouken@1959
   330
/* This is a helper function for DoSidedModifiers.
slouken@1959
   331
 * This function will release a key press in the case that 
slouken@1959
   332
 * it is clear that the modifier has been released (i.e. one side 
slouken@1959
   333
 * can't still be down).
slouken@1959
   334
 */
slouken@1959
   335
static void
slouken@4465
   336
ReleaseModifierSide(unsigned int device_independent_mask, 
slouken@1959
   337
                    unsigned int oldMods, unsigned int newMods,
slouken@2303
   338
                    SDL_scancode left_scancode, 
slouken@2303
   339
                    SDL_scancode right_scancode,
slouken@1959
   340
                    unsigned int left_device_dependent_mask, 
slouken@1959
   341
                    unsigned int right_device_dependent_mask)
slouken@1959
   342
{
slouken@1959
   343
    unsigned int device_dependent_mask = (left_device_dependent_mask |
slouken@1959
   344
                                          right_device_dependent_mask);
slouken@1959
   345
slouken@1959
   346
    /* On the basis that the device independent mask is set, but there are 
slouken@1959
   347
     * no device dependent flags set, we'll assume that we can't detect this 
slouken@1959
   348
     * keyboard and revert to the unsided behavior.
slouken@1959
   349
     */
slouken@1959
   350
    if ((device_dependent_mask & oldMods) == 0) {
slouken@1959
   351
        /* In this case, we can't detect the keyboard, so use the left side 
slouken@1959
   352
         * to represent both, and release it. 
slouken@1959
   353
         */
slouken@4560
   354
        SDL_SendKeyboardKey(SDL_RELEASED, left_scancode, SDL_FALSE);
slouken@1959
   355
        return;
slouken@1959
   356
    }
slouken@1959
   357
slouken@1959
   358
    /* 
slouken@1959
   359
     * This could have been done in an if-else case because at this point,
slouken@1959
   360
     * we know that all keys have been released when calling this function. 
slouken@1959
   361
     * But I'm being paranoid so I want to handle each separately,
slouken@1959
   362
     * so I hope this doesn't cause other problems.
slouken@1959
   363
     */
slouken@1959
   364
    if ( left_device_dependent_mask & oldMods ) {
slouken@4560
   365
        SDL_SendKeyboardKey(SDL_RELEASED, left_scancode, SDL_FALSE);
slouken@1959
   366
    }
slouken@1959
   367
    if ( right_device_dependent_mask & oldMods ) {
slouken@4560
   368
        SDL_SendKeyboardKey(SDL_RELEASED, right_scancode, SDL_FALSE);
slouken@1959
   369
    }
slouken@1959
   370
}
slouken@1959
   371
slouken@1959
   372
/* This is a helper function for DoSidedModifiers.
slouken@1959
   373
 * This function handles the CapsLock case.
slouken@1959
   374
 */
slouken@1959
   375
static void
slouken@4465
   376
HandleCapsLock(unsigned short scancode,
slouken@1959
   377
               unsigned int oldMods, unsigned int newMods)
slouken@1959
   378
{
slouken@1959
   379
    unsigned int oldMask, newMask;
slouken@1959
   380
    
slouken@1959
   381
    oldMask = oldMods & NSAlphaShiftKeyMask;
slouken@1959
   382
    newMask = newMods & NSAlphaShiftKeyMask;
slouken@1959
   383
slouken@1959
   384
    if (oldMask != newMask) {
slouken@4560
   385
        SDL_SendKeyboardKey(SDL_PRESSED, SDL_SCANCODE_CAPSLOCK, SDL_FALSE);
slouken@4560
   386
        SDL_SendKeyboardKey(SDL_RELEASED, SDL_SCANCODE_CAPSLOCK, SDL_FALSE);
slouken@1959
   387
    }
slouken@1960
   388
slouken@1960
   389
    oldMask = oldMods & NSNumericPadKeyMask;
slouken@1960
   390
    newMask = newMods & NSNumericPadKeyMask;
slouken@1960
   391
slouken@1960
   392
    if (oldMask != newMask) {
slouken@4560
   393
        SDL_SendKeyboardKey(SDL_PRESSED, SDL_SCANCODE_NUMLOCKCLEAR, SDL_FALSE);
slouken@4560
   394
        SDL_SendKeyboardKey(SDL_RELEASED, SDL_SCANCODE_NUMLOCKCLEAR, SDL_FALSE);
slouken@1960
   395
    }
slouken@1959
   396
}
slouken@1959
   397
slouken@1959
   398
/* This function will handle the modifier keys and also determine the 
slouken@1959
   399
 * correct side of the key.
slouken@1959
   400
 */
slouken@1959
   401
static void
slouken@4465
   402
DoSidedModifiers(unsigned short scancode,
slouken@1959
   403
                 unsigned int oldMods, unsigned int newMods)
slouken@1959
   404
{
slouken@1959
   405
	/* Set up arrays for the key syms for the left and right side. */
slouken@2303
   406
    const SDL_scancode left_mapping[]  = {
slouken@2303
   407
        SDL_SCANCODE_LSHIFT,
slouken@2303
   408
        SDL_SCANCODE_LCTRL,
slouken@2303
   409
        SDL_SCANCODE_LALT,
slouken@2303
   410
        SDL_SCANCODE_LGUI
slouken@2303
   411
    };
slouken@2303
   412
    const SDL_scancode right_mapping[] = {
slouken@2303
   413
        SDL_SCANCODE_RSHIFT,
slouken@2303
   414
        SDL_SCANCODE_RCTRL,
slouken@2303
   415
        SDL_SCANCODE_RALT,
slouken@2303
   416
        SDL_SCANCODE_RGUI
slouken@2303
   417
    };
slouken@1959
   418
	/* Set up arrays for the device dependent masks with indices that 
slouken@1959
   419
     * correspond to the _mapping arrays 
slouken@1959
   420
     */
slouken@1959
   421
    const unsigned int left_device_mapping[]  = { NX_DEVICELSHIFTKEYMASK, NX_DEVICELCTLKEYMASK, NX_DEVICELALTKEYMASK, NX_DEVICELCMDKEYMASK };
slouken@1959
   422
    const unsigned int right_device_mapping[] = { NX_DEVICERSHIFTKEYMASK, NX_DEVICERCTLKEYMASK, NX_DEVICERALTKEYMASK, NX_DEVICERCMDKEYMASK };
slouken@1959
   423
slouken@1959
   424
    unsigned int i, bit;
slouken@1959
   425
slouken@1959
   426
    /* Handle CAPSLOCK separately because it doesn't have a left/right side */
slouken@4465
   427
    HandleCapsLock(scancode, oldMods, newMods);
slouken@1959
   428
slouken@1959
   429
    /* Iterate through the bits, testing each against the old modifiers */
slouken@1959
   430
    for (i = 0, bit = NSShiftKeyMask; bit <= NSCommandKeyMask; bit <<= 1, ++i) {
slouken@1959
   431
        unsigned int oldMask, newMask;
slouken@1959
   432
		
slouken@1959
   433
        oldMask = oldMods & bit;
slouken@1959
   434
        newMask = newMods & bit;
slouken@1959
   435
		
slouken@1959
   436
        /* If the bit is set, we must always examine it because the left
slouken@1959
   437
         * and right side keys may alternate or both may be pressed.
slouken@1959
   438
         */
slouken@1959
   439
        if (newMask) {
slouken@4465
   440
            HandleModifierSide(bit, oldMods, newMods,
slouken@1959
   441
                               left_mapping[i], right_mapping[i],
slouken@1959
   442
                               left_device_mapping[i], right_device_mapping[i]);
slouken@1959
   443
        }
slouken@1959
   444
        /* If the state changed from pressed to unpressed, we must examine
slouken@1959
   445
            * the device dependent bits to release the correct keys.
slouken@1959
   446
            */
slouken@1959
   447
        else if (oldMask && oldMask != newMask) {
slouken@4465
   448
            ReleaseModifierSide(bit, oldMods, newMods,
slouken@1959
   449
                              left_mapping[i], right_mapping[i],
slouken@1959
   450
                              left_device_mapping[i], right_device_mapping[i]);
slouken@1959
   451
        }
slouken@1959
   452
    }
slouken@1959
   453
}
slouken@1959
   454
slouken@1959
   455
static void
slouken@1959
   456
HandleModifiers(_THIS, unsigned short scancode, unsigned int modifierFlags)
slouken@1959
   457
{
slouken@1959
   458
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@1959
   459
slouken@1959
   460
    if (modifierFlags == data->modifierFlags) {
slouken@1959
   461
    	return;
slouken@1959
   462
    }
slouken@1959
   463
slouken@1959
   464
    /* 
slouken@1959
   465
     * Starting with Panther (10.3.0), the ability to distinguish between 
slouken@1959
   466
     * left side and right side modifiers is available.
slouken@1959
   467
     */
slouken@1959
   468
    if (data->osversion >= 0x1030) {
slouken@4465
   469
        DoSidedModifiers(scancode, data->modifierFlags, modifierFlags);
slouken@1959
   470
    } else {
slouken@4465
   471
        DoUnsidedModifiers(scancode, data->modifierFlags, modifierFlags);
slouken@1959
   472
    }
slouken@1959
   473
    data->modifierFlags = modifierFlags;
slouken@1959
   474
}
slouken@1959
   475
slouken@2303
   476
static void
slouken@2303
   477
UpdateKeymap(SDL_VideoData *data)
slouken@2303
   478
{
slouken@3247
   479
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
slouken@3247
   480
    TISInputSourceRef key_layout;
slouken@3247
   481
#else
slouken@2303
   482
    KeyboardLayoutRef key_layout;
slouken@3247
   483
#endif
slouken@2303
   484
    const void *chr_data;
slouken@2303
   485
    int i;
slouken@2303
   486
    SDL_scancode scancode;
slouken@2303
   487
    SDLKey keymap[SDL_NUM_SCANCODES];
slouken@2303
   488
slouken@2303
   489
    /* See if the keymap needs to be updated */
slouken@3247
   490
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
slouken@3247
   491
    key_layout = TISCopyCurrentKeyboardLayoutInputSource();
slouken@3247
   492
#else
slouken@2303
   493
    KLGetCurrentKeyboardLayout(&key_layout);
slouken@3247
   494
#endif
slouken@2303
   495
    if (key_layout == data->key_layout) {
slouken@2303
   496
        return;
slouken@2303
   497
    }
slouken@2303
   498
    data->key_layout = key_layout;
slouken@2303
   499
slouken@2303
   500
    SDL_GetDefaultKeymap(keymap);
slouken@2303
   501
slouken@2303
   502
    /* Try Unicode data first (preferred as of Mac OS X 10.5) */
slouken@3247
   503
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
slouken@3247
   504
    CFDataRef uchrDataRef = TISGetInputSourceProperty(key_layout, kTISPropertyUnicodeKeyLayoutData);
slouken@3247
   505
    if (uchrDataRef)
slouken@3247
   506
        chr_data = CFDataGetBytePtr(uchrDataRef);
slouken@3247
   507
    else
slouken@3247
   508
        goto cleanup;
slouken@3247
   509
#else
slouken@2303
   510
    KLGetKeyboardLayoutProperty(key_layout, kKLuchrData, &chr_data);
slouken@3247
   511
#endif
slouken@2303
   512
    if (chr_data) {
slouken@2303
   513
        UInt32 keyboard_type = LMGetKbdType();
slouken@2303
   514
        OSStatus err;
slouken@2303
   515
slouken@2305
   516
        for (i = 0; i < SDL_arraysize(darwin_scancode_table); i++) {
slouken@2303
   517
            UniChar s[8];
slouken@2303
   518
            UniCharCount len;
slouken@2303
   519
            UInt32 dead_key_state;
slouken@2303
   520
slouken@2303
   521
            /* Make sure this scancode is a valid character scancode */
slouken@2305
   522
            scancode = darwin_scancode_table[i];
slouken@2303
   523
            if (scancode == SDL_SCANCODE_UNKNOWN ||
slouken@2303
   524
                (keymap[scancode] & SDLK_SCANCODE_MASK)) {
slouken@2303
   525
                continue;
slouken@2303
   526
            }
slouken@2303
   527
slouken@2303
   528
            dead_key_state = 0;
slouken@3247
   529
            err = UCKeyTranslate ((UCKeyboardLayout *) chr_data,
slouken@3247
   530
                                  i, kUCKeyActionDown,
slouken@2303
   531
                                  0, keyboard_type,
slouken@2303
   532
                                  kUCKeyTranslateNoDeadKeysMask,
slouken@2303
   533
                                  &dead_key_state, 8, &len, s);
slouken@2303
   534
            if (err != noErr)
slouken@2303
   535
                continue;
slouken@2303
   536
slouken@2303
   537
            if (len > 0 && s[0] != 0x10) {
slouken@2303
   538
                keymap[scancode] = s[0];
slouken@2303
   539
            }
slouken@2303
   540
        }
slouken@4465
   541
        SDL_SetKeymap(0, keymap, SDL_NUM_SCANCODES);
slouken@2303
   542
        return;
slouken@2303
   543
    }
slouken@2303
   544
slouken@3247
   545
#if MAC_OS_X_VERSION_MAX_ALLOWED >= 1050
slouken@3247
   546
cleanup:
slouken@3247
   547
    CFRelease(key_layout);
slouken@3247
   548
#else
slouken@2303
   549
    /* Fall back to older style key map data */
slouken@2303
   550
    KLGetKeyboardLayoutProperty(key_layout, kKLKCHRData, &chr_data);
slouken@2303
   551
    if (chr_data) {
slouken@2303
   552
        for (i = 0; i < 128; i++) {
slouken@2303
   553
            UInt32 c, state = 0;
slouken@2303
   554
slouken@2303
   555
            /* Make sure this scancode is a valid character scancode */
slouken@2305
   556
            scancode = darwin_scancode_table[i];
slouken@2303
   557
            if (scancode == SDL_SCANCODE_UNKNOWN ||
slouken@2303
   558
                (keymap[scancode] & SDLK_SCANCODE_MASK)) {
slouken@2303
   559
                continue;
slouken@2303
   560
            }
slouken@2303
   561
slouken@2304
   562
            c = KeyTranslate (chr_data, i, &state) & 255;
slouken@2303
   563
            if (state) {
slouken@2303
   564
                /* Dead key, process key up */
slouken@2304
   565
                c = KeyTranslate (chr_data, i | 128, &state) & 255;
slouken@2303
   566
            }
slouken@2303
   567
slouken@2304
   568
            if (c != 0 && c != 0x10) {
slouken@2303
   569
                /* MacRoman to Unicode table, taken from X.org sources */
slouken@2303
   570
                static const unsigned short macroman_table[128] = {
slouken@2303
   571
                    0xc4, 0xc5, 0xc7, 0xc9, 0xd1, 0xd6, 0xdc, 0xe1,
slouken@2303
   572
                    0xe0, 0xe2, 0xe4, 0xe3, 0xe5, 0xe7, 0xe9, 0xe8,
slouken@2303
   573
                    0xea, 0xeb, 0xed, 0xec, 0xee, 0xef, 0xf1, 0xf3,
slouken@2303
   574
                    0xf2, 0xf4, 0xf6, 0xf5, 0xfa, 0xf9, 0xfb, 0xfc,
slouken@2303
   575
                    0x2020, 0xb0, 0xa2, 0xa3, 0xa7, 0x2022, 0xb6, 0xdf,
slouken@2303
   576
                    0xae, 0xa9, 0x2122, 0xb4, 0xa8, 0x2260, 0xc6, 0xd8,
slouken@2303
   577
                    0x221e, 0xb1, 0x2264, 0x2265, 0xa5, 0xb5, 0x2202, 0x2211,
slouken@2303
   578
                    0x220f, 0x3c0, 0x222b, 0xaa, 0xba, 0x3a9, 0xe6, 0xf8,
slouken@2303
   579
                    0xbf, 0xa1, 0xac, 0x221a, 0x192, 0x2248, 0x2206, 0xab,
slouken@2303
   580
                    0xbb, 0x2026, 0xa0, 0xc0, 0xc3, 0xd5, 0x152, 0x153,
slouken@2303
   581
                    0x2013, 0x2014, 0x201c, 0x201d, 0x2018, 0x2019, 0xf7, 0x25ca,
slouken@2303
   582
                    0xff, 0x178, 0x2044, 0x20ac, 0x2039, 0x203a, 0xfb01, 0xfb02,
slouken@2303
   583
                    0x2021, 0xb7, 0x201a, 0x201e, 0x2030, 0xc2, 0xca, 0xc1,
slouken@2303
   584
                    0xcb, 0xc8, 0xcd, 0xce, 0xcf, 0xcc, 0xd3, 0xd4,
slouken@2303
   585
                    0xf8ff, 0xd2, 0xda, 0xdb, 0xd9, 0x131, 0x2c6, 0x2dc,
slouken@2303
   586
                    0xaf, 0x2d8, 0x2d9, 0x2da, 0xb8, 0x2dd, 0x2db, 0x2c7,
slouken@2303
   587
                };
slouken@2303
   588
slouken@2303
   589
                if (c >= 128) {
slouken@2303
   590
                    c = macroman_table[c - 128];
slouken@2303
   591
                }
slouken@2303
   592
                keymap[scancode] = c;
slouken@2303
   593
            }
slouken@2303
   594
        }
slouken@4465
   595
        SDL_SetKeymap(0, keymap, SDL_NUM_SCANCODES);
slouken@2303
   596
        return;
slouken@2303
   597
    }
slouken@3247
   598
#endif
slouken@2303
   599
}
slouken@2303
   600
slouken@1931
   601
void
slouken@1931
   602
Cocoa_InitKeyboard(_THIS)
slouken@1931
   603
{
slouken@1931
   604
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@1931
   605
slouken@2303
   606
    UpdateKeymap(data);
slouken@2268
   607
    
slouken@2268
   608
    /* Set our own names for the platform-dependent but layout-independent keys */
slouken@2303
   609
    /* This key is NumLock on the MacBook keyboard. :) */
slouken@2303
   610
    /*SDL_SetScancodeName(SDL_SCANCODE_NUMLOCKCLEAR, "Clear");*/
slouken@2303
   611
    SDL_SetScancodeName(SDL_SCANCODE_LALT, "Left Option");
slouken@2303
   612
    SDL_SetScancodeName(SDL_SCANCODE_LGUI, "Left Command");
slouken@2303
   613
    SDL_SetScancodeName(SDL_SCANCODE_RALT, "Right Option");
slouken@2303
   614
    SDL_SetScancodeName(SDL_SCANCODE_RGUI, "Right Command");
slouken@1931
   615
}
slouken@1931
   616
slouken@1931
   617
void
slouken@3280
   618
Cocoa_StartTextInput(_THIS)
slouken@3280
   619
{
slouken@3280
   620
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@3280
   621
    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
slouken@3280
   622
    NSView *parentView = [[NSApp keyWindow] contentView];
slouken@3280
   623
slouken@4434
   624
    /* We only keep one field editor per process, since only the front most
slouken@4434
   625
     * window can receive text input events, so it make no sense to keep more
slouken@4434
   626
     * than one copy. When we switched to another window and requesting for
slouken@4434
   627
     * text input, simply remove the field editor from its superview then add
slouken@4434
   628
     * it to the front most window's content view */
slouken@4435
   629
    if (!data->fieldEdit) {
slouken@4434
   630
        data->fieldEdit =
slouken@4434
   631
            [[SDLTranslatorResponder alloc] initWithFrame: NSMakeRect(0.0, 0.0, 0.0, 0.0)];
slouken@4435
   632
    }
slouken@4434
   633
slouken@4435
   634
    if (![[data->fieldEdit superview] isEqual: parentView])
slouken@3280
   635
    {
slouken@3280
   636
        // DEBUG_IME(@"add fieldEdit to window contentView");
slouken@3280
   637
        [data->fieldEdit removeFromSuperview];
slouken@3280
   638
        [parentView addSubview: data->fieldEdit];
slouken@3280
   639
        [[NSApp keyWindow] makeFirstResponder: data->fieldEdit];
slouken@3280
   640
    }
slouken@3280
   641
slouken@3280
   642
    [pool release];
slouken@3280
   643
}
slouken@3280
   644
slouken@3280
   645
void
slouken@3280
   646
Cocoa_StopTextInput(_THIS)
slouken@3280
   647
{
slouken@3280
   648
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@3280
   649
slouken@3683
   650
    if (data && data->fieldEdit) {
slouken@3683
   651
        NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
slouken@3683
   652
        [data->fieldEdit removeFromSuperview];
slouken@3683
   653
        [data->fieldEdit release];
slouken@3683
   654
        data->fieldEdit = nil;
slouken@3683
   655
        [pool release];
slouken@3683
   656
    }
slouken@3280
   657
}
slouken@3280
   658
slouken@3280
   659
void
slouken@3280
   660
Cocoa_SetTextInputRect(_THIS, SDL_Rect *rect)
slouken@3280
   661
{
slouken@3280
   662
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@3280
   663
slouken@3280
   664
    [data->fieldEdit setInputRect: rect];
slouken@3280
   665
}
slouken@3280
   666
slouken@3280
   667
void
slouken@1959
   668
Cocoa_HandleKeyEvent(_THIS, NSEvent *event)
slouken@1959
   669
{
slouken@1959
   670
    SDL_VideoData *data = (SDL_VideoData *) _this->driverdata;
slouken@1959
   671
    unsigned short scancode = [event keyCode];
slouken@2303
   672
    SDL_scancode code;
slouken@4560
   673
    SDL_bool repeat;
slouken@4465
   674
#if 0
slouken@1959
   675
    const char *text;
slouken@4465
   676
#endif
slouken@1959
   677
slouken@2268
   678
    if ((scancode == 10 || scancode == 50) && KBGetLayoutType(LMGetKbdType()) == kKeyboardISO) {
slouken@2268
   679
        /* see comments in SDL_cocoakeys.h */
slouken@2268
   680
        scancode = 60 - scancode;
slouken@2268
   681
    }
slouken@2305
   682
    if (scancode < SDL_arraysize(darwin_scancode_table)) {
slouken@2305
   683
        code = darwin_scancode_table[scancode];
slouken@2268
   684
    }
slouken@2268
   685
    else {
slouken@1959
   686
        /* Hmm, does this ever happen?  If so, need to extend the keymap... */
slouken@2303
   687
        code = SDL_SCANCODE_UNKNOWN;
slouken@1959
   688
    }
slouken@1959
   689
slouken@1959
   690
    switch ([event type]) {
slouken@1959
   691
    case NSKeyDown:
slouken@4560
   692
        repeat = [event isARepeat] ? SDL_TRUE : SDL_FALSE;
slouken@4560
   693
        if (!repeat) {
slouken@2303
   694
            /* See if we need to rebuild the keyboard layout */
slouken@2303
   695
            UpdateKeymap(data);
slouken@4560
   696
        }
slouken@2303
   697
slouken@4560
   698
        SDL_SendKeyboardKey(SDL_PRESSED, code, repeat);
slouken@2268
   699
#if 1
slouken@4560
   700
        if (code == SDL_SCANCODE_UNKNOWN) {
slouken@4560
   701
            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);
slouken@4560
   702
        }
slouken@2268
   703
#endif
slouken@2129
   704
        if (SDL_EventState(SDL_TEXTINPUT, SDL_QUERY)) {
slouken@2268
   705
            /* 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. */
slouken@2169
   706
            [data->fieldEdit interpretKeyEvents:[NSArray arrayWithObject:event]];
slouken@3280
   707
#if 0
slouken@2129
   708
            text = [[event characters] UTF8String];
slouken@2129
   709
            if(text && *text) {
slouken@4465
   710
                SDL_SendKeyboardText(text);
slouken@2273
   711
                [data->fieldEdit setString:@""];
slouken@2129
   712
            }
slouken@3280
   713
#endif
slouken@1959
   714
        }
slouken@1959
   715
        break;
slouken@1959
   716
    case NSKeyUp:
slouken@4560
   717
        SDL_SendKeyboardKey(SDL_RELEASED, code, SDL_FALSE);
slouken@1959
   718
        break;
slouken@1959
   719
    case NSFlagsChanged:
slouken@2268
   720
        /* FIXME CW 2007-08-14: check if this whole mess that takes up half of this file is really necessary */
slouken@1959
   721
        HandleModifiers(_this, scancode, [event modifierFlags]);
slouken@1959
   722
        break;
slouken@2268
   723
    default: /* just to avoid compiler warnings */
slouken@2268
   724
        break;
slouken@2268
   725
    }
slouken@2268
   726
}
slouken@2268
   727
slouken@1959
   728
void
slouken@1931
   729
Cocoa_QuitKeyboard(_THIS)
slouken@1931
   730
{
slouken@1931
   731
}
slouken@1931
   732
slouken@1931
   733
/* vi: set ts=4 sw=4 expandtab: */