cappuccino/AppKit/CPKeyBinding.j

/*
 * CPKeyBinding.j
 * AppKit
 *
 * Created by Nicholas Small.
 * Copyright 2010, 280 North, Inc.
 *
 * 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 Street, Fifth Floor, Boston, MA 02110-1301 USA
 */

@import <Foundation/CPObject.j>
@import <Foundation/CPArray.j>

@import "CPEvent_Constants.j"
@import "CPText.j"

// TODO: These are the macOS standard key bindings and are applied on every
// platform. "@" is always Command, and the Emacs-style Control bindings
// (^a, ^e, ^k, ^v, ^y, ...) and arrow/Home/End behaviour conflict with
// Windows and Linux conventions. Provide per-platform tables keyed off
// CPBrowserIsOperatingSystem, mapping the primary modifier through
// CPPlatformActionKeyMask.
CPStandardKeyBindings = {
    @"@.": @"cancelOperation:",

    @"@a": @"selectAll:",
    @"@~$v": @"pasteAsPlainText:",
    @"^a": @"moveToBeginningOfParagraph:",
    @"^$a": @"moveToBeginningOfParagraphAndModifySelection:",
    @"^b": @"moveBackward:",
    @"^$b": @"moveBackwardAndModifySelection:",
    @"^~b": @"moveWordBackward:",
    @"^~$b": @"moveWordBackwardAndModifySelection:",
    @"^d": @"deleteForward:",
    @"^e": @"moveToEndOfParagraph:",
    @"^$e": @"moveToEndOfParagraphAndModifySelection:",
    @"^f": @"moveForward:",
    @"^$f": @"moveForwardAndModifySelection:",
    @"^~f": @"moveWordForward:",
    @"^~$f": @"moveWordForwardAndModifySelection:",
    @"^h": @"deleteBackward:",
    @"^k": @"deleteToEndOfParagraph:",
    @"^l": @"centerSelectionInVisibleArea:",
    @"^n": @"moveDown:",
    @"^$n": @"moveDownAndModifySelection:",
    @"^o": [@"insertNewlineIgnoringFieldEditor:", @"moveBackward:"],
    @"^p": @"moveUp:",
    @"^$p": @"moveUpAndModifySelection:",
    @"^t": @"transpose:",
    @"^v": @"pageDown:",
    @"^$v": @"pageDownAndModifySelection:",
    @"^y": @"yank:"
};

CPStandardKeyBindings[CPNewlineCharacter] = @"insertNewline:";
CPStandardKeyBindings[CPCarriageReturnCharacter] = @"insertNewline:";
CPStandardKeyBindings[CPEnterCharacter] = @"insertNewline:";
CPStandardKeyBindings[@"~" + CPNewlineCharacter] = @"insertNewlineIgnoringFieldEditor:";
CPStandardKeyBindings[@"~" + CPCarriageReturnCharacter] = @"insertNewlineIgnoringFieldEditor:";
CPStandardKeyBindings[@"~" + CPEnterCharacter] = @"insertNewlineIgnoringFieldEditor:";
CPStandardKeyBindings[@"^" + CPNewlineCharacter] = @"insertLineBreak:";
CPStandardKeyBindings[@"^" + CPCarriageReturnCharacter] = @"insertLineBreak:";
CPStandardKeyBindings[@"^" + CPEnterCharacter] = @"insertLineBreak:";

CPStandardKeyBindings[CPBackspaceCharacter] = @"deleteBackward:";
CPStandardKeyBindings[@"~" + CPBackspaceCharacter] = @"deleteWordBackward:";
CPStandardKeyBindings[CPDeleteCharacter] = @"deleteBackward:";
CPStandardKeyBindings[@"@" + CPDeleteCharacter] = @"deleteToBeginningOfLine:";
CPStandardKeyBindings[@"~" + CPDeleteCharacter] = @"deleteWordBackward:";
CPStandardKeyBindings[@"^" + CPDeleteCharacter] = @"deleteBackwardByDecomposingPreviousCharacter:";
CPStandardKeyBindings[@"^~" + CPDeleteCharacter] = @"deleteWordBackward:";

CPStandardKeyBindings[CPDeleteFunctionKey] = @"deleteForward:";
CPStandardKeyBindings[@"~" + CPDeleteFunctionKey] = @"deleteWordForward:";

CPStandardKeyBindings[CPTabCharacter] = @"insertTab:";
CPStandardKeyBindings[@"~" + CPTabCharacter] = @"insertTabIgnoringFieldEditor:";
CPStandardKeyBindings[@"^" + CPTabCharacter] = @"selectNextKeyView:";
CPStandardKeyBindings[@"$" + CPTabCharacter] = @"insertBacktab:";
CPStandardKeyBindings[CPBackTabCharacter] = @"insertBacktab:";
CPStandardKeyBindings[@"^" + CPBackTabCharacter] = @"selectPreviousKeyView:";

CPStandardKeyBindings[CPEscapeFunctionKey] = @"cancelOperation:";
CPStandardKeyBindings[@"~" + CPEscapeFunctionKey] = @"complete:";
CPStandardKeyBindings[CPF5FunctionKey] = @"complete:";

CPStandardKeyBindings[CPLeftArrowFunctionKey] = @"moveLeft:";
CPStandardKeyBindings[@"~" + CPLeftArrowFunctionKey] = @"moveWordLeft:";
CPStandardKeyBindings[@"^" + CPLeftArrowFunctionKey] = @"moveToLeftEndOfLine:";
CPStandardKeyBindings[@"@" + CPLeftArrowFunctionKey] = @"moveToLeftEndOfLine:";
CPStandardKeyBindings[@"$" + CPLeftArrowFunctionKey] = @"moveLeftAndModifySelection:";
CPStandardKeyBindings[@"$~" + CPLeftArrowFunctionKey] = @"moveWordLeftAndModifySelection:";
CPStandardKeyBindings[@"$^" + CPLeftArrowFunctionKey] = @"moveToLeftEndOfLineAndModifySelection:";
CPStandardKeyBindings[@"$@" + CPLeftArrowFunctionKey] = @"moveToLeftEndOfLineAndModifySelection:";
CPStandardKeyBindings[@"@^" + CPLeftArrowFunctionKey] = @"makeBaseWritingDirectionRightToLeft:";
CPStandardKeyBindings[@"@^~" + CPLeftArrowFunctionKey] = @"makeTextWritingDirectionRightToLeft:";

CPStandardKeyBindings[CPRightArrowFunctionKey] = @"moveRight:";
CPStandardKeyBindings[@"~" + CPRightArrowFunctionKey] = @"moveWordRight:";
CPStandardKeyBindings[@"^" + CPRightArrowFunctionKey] = @"moveToRightEndOfLine:";
CPStandardKeyBindings[@"@" + CPRightArrowFunctionKey] = @"moveToRightEndOfLine:";
CPStandardKeyBindings[@"$" + CPRightArrowFunctionKey] = @"moveRightAndModifySelection:";
CPStandardKeyBindings[@"$~" + CPRightArrowFunctionKey] = @"moveWordRightAndModifySelection:";
CPStandardKeyBindings[@"$^" + CPRightArrowFunctionKey] = @"moveToRightEndOfLineAndModifySelection:";
CPStandardKeyBindings[@"$@" + CPRightArrowFunctionKey] = @"moveToRightEndOfLineAndModifySelection:";
CPStandardKeyBindings[@"@^" + CPRightArrowFunctionKey] = @"makeBaseWritingDirectionLeftToRight:";
CPStandardKeyBindings[@"@^~" + CPRightArrowFunctionKey] = @"makeTextWritingDirectionLeftToRight:";

CPStandardKeyBindings[CPUpArrowFunctionKey] = @"moveUp:";
CPStandardKeyBindings[@"~" + CPUpArrowFunctionKey] = [@"moveBackward:", @"moveToBeginningOfParagraph:"];
CPStandardKeyBindings[@"^" + CPUpArrowFunctionKey] = @"scrollPageUp:";
CPStandardKeyBindings[@"@" + CPUpArrowFunctionKey] = @"moveToBeginningOfDocument:";
CPStandardKeyBindings[@"$" + CPUpArrowFunctionKey] = @"moveUpAndModifySelection:";
CPStandardKeyBindings[@"$~" + CPUpArrowFunctionKey] = @"moveParagraphBackwardAndModifySelection:";
CPStandardKeyBindings[@"$@" + CPUpArrowFunctionKey] = @"moveToBeginningOfDocumentAndModifySelection:";

CPStandardKeyBindings[CPDownArrowFunctionKey] = @"moveDown:";
CPStandardKeyBindings[@"~" + CPDownArrowFunctionKey] = [@"moveForward:", @"moveToEndOfParagraph:"];
CPStandardKeyBindings[@"^" + CPDownArrowFunctionKey] = @"scrollPageDown:";
CPStandardKeyBindings[@"@" + CPDownArrowFunctionKey] = @"moveToEndOfDocument:";
CPStandardKeyBindings[@"$" + CPDownArrowFunctionKey] = @"moveDownAndModifySelection:";
CPStandardKeyBindings[@"$~" + CPDownArrowFunctionKey] = @"moveParagraphForwardAndModifySelection:";
CPStandardKeyBindings[@"$@" + CPDownArrowFunctionKey] = @"moveToEndOfDocumentAndModifySelection:";
CPStandardKeyBindings[@"@^" + CPDownArrowFunctionKey] = @"makeBaseWritingDirectionNatural:";
CPStandardKeyBindings[@"@^~" + CPDownArrowFunctionKey] = @"makeTextWritingDirectionNatural:";

CPStandardKeyBindings[CPHomeFunctionKey] = @"scrollToBeginningOfDocument:";
CPStandardKeyBindings[@"$" + CPHomeFunctionKey] = @"moveToBeginningOfDocumentAndModifySelection:";
CPStandardKeyBindings[CPEndFunctionKey] = @"scrollToEndOfDocument:";
CPStandardKeyBindings[@"$" + CPEndFunctionKey] = @"moveToEndOfDocumentAndModifySelection:";

CPStandardKeyBindings[CPPageUpFunctionKey] = @"scrollPageUp:";
CPStandardKeyBindings[@"~" + CPPageUpFunctionKey] = @"pageUp:";
CPStandardKeyBindings[@"$" + CPPageUpFunctionKey] = @"pageUpAndModifySelection:";
CPStandardKeyBindings[CPPageDownFunctionKey] = @"scrollPageDown:";
CPStandardKeyBindings[@"~" + CPPageDownFunctionKey] = @"pageDown:";
CPStandardKeyBindings[@"$" + CPPageDownFunctionKey] = @"pageDownAndModifySelection:";

var CPKeyBindingCache = {};

@implementation CPKeyBinding : CPObject
{
    CPString    _key;
    unsigned    _modifierFlags;

    CPArray     _selectors;

    CPString    _cacheName;
}

+ (void)initialize
{
    if (self !== [CPKeyBinding class])
        return;

    [self createKeyBindingsFromJSObject:CPStandardKeyBindings];
}

+ (void)createKeyBindingsFromJSObject:(JSObject)anObject
{
    var binding;
    for (binding in anObject)
        [self cacheKeyBinding:[[CPKeyBinding alloc] initWithPhysicalKeyString:binding selectors:anObject[binding]]];
}

+ (void)cacheKeyBinding:(CPKeyBinding)aBinding
{
    if (!aBinding)
        return;

    CPKeyBindingCache[[aBinding _cacheName]] = aBinding;
}

+ (CPKeyBinding)keyBindingForKey:(CPString)aKey modifierFlags:(unsigned)aFlag
{
    var tempBinding = [[self alloc] initWithKey:aKey modifierFlags:aFlag selectors:nil];
    return CPKeyBindingCache[[tempBinding _cacheName]];
}

+ (CPArray)selectorsForKey:(CPString)aKey modifierFlags:(unsigned)aFlag
{
    return [[self keyBindingForKey:aKey modifierFlags:aFlag] selectors];
}

- (id)initWithPhysicalKeyString:(CPString)binding selectors:(CPArray)selectors
{
    var components = binding.split(@""),
        modifierFlags = ([components containsObject:@"$"] ? CPShiftKeyMask : 0) |
                        ([components containsObject:@"^"] ? CPControlKeyMask : 0) |
                        ([components containsObject:@"~"] ? CPAlternateKeyMask : 0) |
                        ([components containsObject:@"@"] ? CPCommandKeyMask : 0);

    if (![selectors isKindOfClass:CPArray])
        selectors = [selectors];

    return [self initWithKey:[components lastObject] modifierFlags:modifierFlags selectors:selectors];
}

- (id)initWithKey:(CPString)aKey modifierFlags:(unsigned)aFlag selectors:(CPArray)selectors
{
    self = [super init];

    if (self)
    {
        _key = aKey;
        _modifierFlags = aFlag;

        _selectors = selectors;

        // We normalize our key binding string in order to properly cache it.
        // We want to ensure the modifiers are always in the same order.
        var cacheName = [];

        if (_modifierFlags & CPCommandKeyMask)
            cacheName.push(@"@");
        if (_modifierFlags & CPControlKeyMask)
            cacheName.push(@"^");
        if (_modifierFlags & CPAlternateKeyMask)
            cacheName.push(@"~");
        if (_modifierFlags & CPShiftKeyMask)
            cacheName.push(@"$");

        cacheName.push(_key);

        _cacheName = cacheName.join(@"");
    }

    return self;
}

- (CPString)key
{
    return _key;
}

- (unsigned)modifierFlags
{
    return _modifierFlags;
}

- (CPArray)selectors
{
    return _selectors;
}

- (CPString)_cacheName
{
    return _cacheName;
}

- (BOOL)isEqual:(CPKeyBinding)rhs
{
    return _key === [rhs key] && _modifierFlags === [rhs modifierFlags];
}

- (CPString)description
{
    return [CPString stringWithFormat:@"<KeyBinding string: '%@' modifierFlags: 0x%lx selectors: %@>", _key, _modifierFlags, _selectors];
}

@end