Blame client/iOS/Models/RDPKeyboard.m

Packit Service fa4841
/*
Packit Service fa4841
 RDP Keyboard helper
Packit Service fa4841
Packit Service fa4841
 Copyright 2013 Thincast Technologies GmbH, Author: Martin Fleisz
Packit Service fa4841
Packit Service fa4841
 This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0.
Packit Service fa4841
 If a copy of the MPL was not distributed with this file, You can obtain one at
Packit Service fa4841
 http://mozilla.org/MPL/2.0/.
Packit Service fa4841
 */
Packit Service fa4841
Packit Service fa4841
#import "RDPKeyboard.h"
Packit Service fa4841
#include <freerdp/locale/keyboard.h>
Packit Service fa4841
Packit Service fa4841
@interface RDPKeyboard (Private)
Packit Service fa4841
- (void)sendVirtualKey:(int)vKey up:(BOOL)up;
Packit Service fa4841
- (void)handleSpecialKey:(int)character;
Packit Service fa4841
- (void)handleAlphaNumChar:(int)character;
Packit Service fa4841
- (void)notifyDelegateModifiersChanged;
Packit Service fa4841
@end
Packit Service fa4841
Packit Service fa4841
@implementation RDPKeyboard
Packit Service fa4841
Packit Service fa4841
@synthesize delegate = _delegate, ctrlPressed = _ctrl_pressed, altPressed = _alt_pressed,
Packit Service fa4841
            shiftPressed = _shift_pressed, winPressed = _win_pressed;
Packit Service fa4841
Packit Service fa4841
- (id)init
Packit Service fa4841
{
Packit Service fa4841
	if ((self = [super init]) != nil)
Packit Service fa4841
	{
Packit Service fa4841
		[self initWithSession:nil delegate:nil];
Packit Service fa4841
Packit Service fa4841
		memset(_virtual_key_map, 0, sizeof(_virtual_key_map));
Packit Service fa4841
		memset(_unicode_map, 0, sizeof(_unicode_map));
Packit Service fa4841
Packit Service fa4841
		// init vkey map - used for alpha-num characters
Packit Service fa4841
		_virtual_key_map['0'] = VK_KEY_0;
Packit Service fa4841
		_virtual_key_map['1'] = VK_KEY_1;
Packit Service fa4841
		_virtual_key_map['2'] = VK_KEY_2;
Packit Service fa4841
		_virtual_key_map['3'] = VK_KEY_3;
Packit Service fa4841
		_virtual_key_map['4'] = VK_KEY_4;
Packit Service fa4841
		_virtual_key_map['5'] = VK_KEY_5;
Packit Service fa4841
		_virtual_key_map['6'] = VK_KEY_6;
Packit Service fa4841
		_virtual_key_map['7'] = VK_KEY_7;
Packit Service fa4841
		_virtual_key_map['8'] = VK_KEY_8;
Packit Service fa4841
		_virtual_key_map['9'] = VK_KEY_9;
Packit Service fa4841
Packit Service fa4841
		_virtual_key_map['a'] = VK_KEY_A;
Packit Service fa4841
		_virtual_key_map['b'] = VK_KEY_B;
Packit Service fa4841
		_virtual_key_map['c'] = VK_KEY_C;
Packit Service fa4841
		_virtual_key_map['d'] = VK_KEY_D;
Packit Service fa4841
		_virtual_key_map['e'] = VK_KEY_E;
Packit Service fa4841
		_virtual_key_map['f'] = VK_KEY_F;
Packit Service fa4841
		_virtual_key_map['g'] = VK_KEY_G;
Packit Service fa4841
		_virtual_key_map['h'] = VK_KEY_H;
Packit Service fa4841
		_virtual_key_map['i'] = VK_KEY_I;
Packit Service fa4841
		_virtual_key_map['j'] = VK_KEY_J;
Packit Service fa4841
		_virtual_key_map['k'] = VK_KEY_K;
Packit Service fa4841
		_virtual_key_map['l'] = VK_KEY_L;
Packit Service fa4841
		_virtual_key_map['m'] = VK_KEY_M;
Packit Service fa4841
		_virtual_key_map['n'] = VK_KEY_N;
Packit Service fa4841
		_virtual_key_map['o'] = VK_KEY_O;
Packit Service fa4841
		_virtual_key_map['p'] = VK_KEY_P;
Packit Service fa4841
		_virtual_key_map['q'] = VK_KEY_Q;
Packit Service fa4841
		_virtual_key_map['r'] = VK_KEY_R;
Packit Service fa4841
		_virtual_key_map['s'] = VK_KEY_S;
Packit Service fa4841
		_virtual_key_map['t'] = VK_KEY_T;
Packit Service fa4841
		_virtual_key_map['u'] = VK_KEY_U;
Packit Service fa4841
		_virtual_key_map['v'] = VK_KEY_V;
Packit Service fa4841
		_virtual_key_map['w'] = VK_KEY_W;
Packit Service fa4841
		_virtual_key_map['x'] = VK_KEY_X;
Packit Service fa4841
		_virtual_key_map['y'] = VK_KEY_Y;
Packit Service fa4841
		_virtual_key_map['z'] = VK_KEY_Z;
Packit Service fa4841
Packit Service fa4841
		// init scancode map - used for special characters
Packit Service fa4841
		_unicode_map['-'] = 45;
Packit Service fa4841
		_unicode_map['/'] = 47;
Packit Service fa4841
		_unicode_map[':'] = 58;
Packit Service fa4841
		_unicode_map[';'] = 59;
Packit Service fa4841
		_unicode_map['('] = 40;
Packit Service fa4841
		_unicode_map[')'] = 41;
Packit Service fa4841
		_unicode_map['&'] = 38;
Packit Service fa4841
		_unicode_map['@'] = 64;
Packit Service fa4841
		_unicode_map['.'] = 46;
Packit Service fa4841
		_unicode_map[','] = 44;
Packit Service fa4841
		_unicode_map['?'] = 63;
Packit Service fa4841
		_unicode_map['!'] = 33;
Packit Service fa4841
		_unicode_map['\''] = 39;
Packit Service fa4841
		_unicode_map['\"'] = 34;
Packit Service fa4841
Packit Service fa4841
		_unicode_map['['] = 91;
Packit Service fa4841
		_unicode_map[']'] = 93;
Packit Service fa4841
		_unicode_map['{'] = 123;
Packit Service fa4841
		_unicode_map['}'] = 125;
Packit Service fa4841
		_unicode_map['#'] = 35;
Packit Service fa4841
		_unicode_map['%'] = 37;
Packit Service fa4841
		_unicode_map['^'] = 94;
Packit Service fa4841
		_unicode_map['*'] = 42;
Packit Service fa4841
		_unicode_map['+'] = 43;
Packit Service fa4841
		_unicode_map['='] = 61;
Packit Service fa4841
Packit Service fa4841
		_unicode_map['_'] = 95;
Packit Service fa4841
		_unicode_map['\\'] = 92;
Packit Service fa4841
		_unicode_map['|'] = 124;
Packit Service fa4841
		_unicode_map['~'] = 126;
Packit Service fa4841
		_unicode_map['<'] = 60;
Packit Service fa4841
		_unicode_map['>'] = 62;
Packit Service fa4841
		_unicode_map['$'] = 36;
Packit Service fa4841
	}
Packit Service fa4841
	return self;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
- (void)dealloc
Packit Service fa4841
{
Packit Service fa4841
	[super dealloc];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
#pragma mark -
Packit Service fa4841
#pragma mark class methods
Packit Service fa4841
Packit Service fa4841
// return a keyboard instance
Packit Service fa4841
+ (RDPKeyboard *)getSharedRDPKeyboard
Packit Service fa4841
{
Packit Service fa4841
	static RDPKeyboard *_shared_keyboard = nil;
Packit Service fa4841
Packit Service fa4841
	if (_shared_keyboard == nil)
Packit Service fa4841
	{
Packit Service fa4841
		@synchronized(self)
Packit Service fa4841
		{
Packit Service fa4841
			if (_shared_keyboard == nil)
Packit Service fa4841
				_shared_keyboard = [[RDPKeyboard alloc] init];
Packit Service fa4841
		}
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	return _shared_keyboard;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// reset the keyboard instance and assign the given rdp instance
Packit Service fa4841
- (void)initWithSession:(RDPSession *)session delegate:(NSObject<RDPKeyboardDelegate> *)delegate
Packit Service fa4841
{
Packit Service fa4841
	_alt_pressed = NO;
Packit Service fa4841
	_ctrl_pressed = NO;
Packit Service fa4841
	_shift_pressed = NO;
Packit Service fa4841
	_win_pressed = NO;
Packit Service fa4841
Packit Service fa4841
	_session = session;
Packit Service fa4841
	_delegate = delegate;
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
- (void)reset
Packit Service fa4841
{
Packit Service fa4841
	// reset pressed ctrl, alt, shift or win key
Packit Service fa4841
	if (_shift_pressed)
Packit Service fa4841
		[self toggleShiftKey];
Packit Service fa4841
	if (_alt_pressed)
Packit Service fa4841
		[self toggleAltKey];
Packit Service fa4841
	if (_ctrl_pressed)
Packit Service fa4841
		[self toggleCtrlKey];
Packit Service fa4841
	if (_win_pressed)
Packit Service fa4841
		[self toggleWinKey];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// handles button pressed input event from the iOS keyboard
Packit Service fa4841
// performs all conversions etc.
Packit Service fa4841
- (void)sendUnicode:(int)character
Packit Service fa4841
{
Packit Service fa4841
	if (isalnum(character))
Packit Service fa4841
		[self handleAlphaNumChar:character];
Packit Service fa4841
	else
Packit Service fa4841
		[self handleSpecialKey:character];
Packit Service fa4841
Packit Service fa4841
	[self reset];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// send a backspace key press
Packit Service fa4841
- (void)sendVirtualKeyCode:(int)keyCode
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKey:keyCode up:NO];
Packit Service fa4841
	[self sendVirtualKey:keyCode up:YES];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
#pragma mark modifier key handling
Packit Service fa4841
// toggle ctrl key, returns true if pressed, otherwise false
Packit Service fa4841
- (void)toggleCtrlKey
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKey:VK_LCONTROL up:_ctrl_pressed];
Packit Service fa4841
	_ctrl_pressed = !_ctrl_pressed;
Packit Service fa4841
	[self notifyDelegateModifiersChanged];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// toggle alt key, returns true if pressed, otherwise false
Packit Service fa4841
- (void)toggleAltKey
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKey:VK_LMENU up:_alt_pressed];
Packit Service fa4841
	_alt_pressed = !_alt_pressed;
Packit Service fa4841
	[self notifyDelegateModifiersChanged];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// toggle shift key, returns true if pressed, otherwise false
Packit Service fa4841
- (void)toggleShiftKey
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKey:VK_LSHIFT up:_shift_pressed];
Packit Service fa4841
	_shift_pressed = !_shift_pressed;
Packit Service fa4841
	[self notifyDelegateModifiersChanged];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// toggle windows key, returns true if pressed, otherwise false
Packit Service fa4841
- (void)toggleWinKey
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKey:(VK_LWIN | KBDEXT) up:_win_pressed];
Packit Service fa4841
	_win_pressed = !_win_pressed;
Packit Service fa4841
	[self notifyDelegateModifiersChanged];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
#pragma mark Sending special key strokes
Packit Service fa4841
Packit Service fa4841
- (void)sendEnterKeyStroke
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKeyCode:(VK_RETURN | KBDEXT)];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
- (void)sendEscapeKeyStroke
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKeyCode:VK_ESCAPE];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
- (void)sendBackspaceKeyStroke
Packit Service fa4841
{
Packit Service fa4841
	[self sendVirtualKeyCode:VK_BACK];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
@end
Packit Service fa4841
Packit Service fa4841
#pragma mark -
Packit Service fa4841
@implementation RDPKeyboard (Private)
Packit Service fa4841
Packit Service fa4841
- (void)handleAlphaNumChar:(int)character
Packit Service fa4841
{
Packit Service fa4841
	// if we recive an uppercase letter - make it lower and send an shift down event to server
Packit Service fa4841
	BOOL shift_was_sent = NO;
Packit Service fa4841
	if (isupper(character) && _shift_pressed == NO)
Packit Service fa4841
	{
Packit Service fa4841
		character = tolower(character);
Packit Service fa4841
		[self sendVirtualKey:VK_LSHIFT up:NO];
Packit Service fa4841
		shift_was_sent = YES;
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	// convert the character to a VK
Packit Service fa4841
	int vk = _virtual_key_map[character];
Packit Service fa4841
	if (vk != 0)
Packit Service fa4841
	{
Packit Service fa4841
		// send key pressed
Packit Service fa4841
		[self sendVirtualKey:vk up:NO];
Packit Service fa4841
		[self sendVirtualKey:vk up:YES];
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	// send the missing shift up if we had a shift down
Packit Service fa4841
	if (shift_was_sent)
Packit Service fa4841
		[self sendVirtualKey:VK_LSHIFT up:YES];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
- (void)handleSpecialKey:(int)character
Packit Service fa4841
{
Packit Service fa4841
	NSDictionary *eventDescriptor = nil;
Packit Service fa4841
	if (character < 256)
Packit Service fa4841
	{
Packit Service fa4841
		// convert the character to a unicode character
Packit Service fa4841
		int code = _unicode_map[character];
Packit Service fa4841
		if (code != 0)
Packit Service fa4841
			eventDescriptor = [NSDictionary
Packit Service fa4841
			    dictionaryWithObjectsAndKeys:@"keyboard", @"type", @"unicode", @"subtype",
Packit Service fa4841
			                                 [NSNumber numberWithUnsignedShort:0], @"flags",
Packit Service fa4841
			                                 [NSNumber numberWithUnsignedShort:code],
Packit Service fa4841
			                                 @"unicode_char", nil];
Packit Service fa4841
	}
Packit Service fa4841
Packit Service fa4841
	if (eventDescriptor == nil)
Packit Service fa4841
		eventDescriptor = [NSDictionary
Packit Service fa4841
		    dictionaryWithObjectsAndKeys:@"keyboard", @"type", @"unicode", @"subtype",
Packit Service fa4841
		                                 [NSNumber numberWithUnsignedShort:0], @"flags",
Packit Service fa4841
		                                 [NSNumber numberWithUnsignedShort:character],
Packit Service fa4841
		                                 @"unicode_char", nil];
Packit Service fa4841
Packit Service fa4841
	[_session sendInputEvent:eventDescriptor];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
// sends the vk code to the session
Packit Service fa4841
- (void)sendVirtualKey:(int)vKey up:(BOOL)up
Packit Service fa4841
{
Packit Service fa4841
	DWORD scancode = GetVirtualScanCodeFromVirtualKeyCode(vKey, 4);
Packit Service fa4841
	int flags = (up ? KBD_FLAGS_RELEASE : KBD_FLAGS_DOWN);
Packit Service fa4841
	flags |= ((scancode & KBDEXT) ? KBD_FLAGS_EXTENDED : 0);
Packit Service fa4841
	[_session
Packit Service fa4841
	    sendInputEvent:[NSDictionary
Packit Service fa4841
	                       dictionaryWithObjectsAndKeys:@"keyboard", @"type", @"scancode",
Packit Service fa4841
	                                                    @"subtype",
Packit Service fa4841
	                                                    [NSNumber numberWithUnsignedShort:flags],
Packit Service fa4841
	                                                    @"flags",
Packit Service fa4841
	                                                    [NSNumber
Packit Service fa4841
	                                                        numberWithUnsignedShort:(scancode &
Packit Service fa4841
	                                                                                 0xFF)],
Packit Service fa4841
	                                                    @"scancode", nil]];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
- (void)notifyDelegateModifiersChanged
Packit Service fa4841
{
Packit Service fa4841
	if ([[self delegate] respondsToSelector:@selector(modifiersChangedForKeyboard:)])
Packit Service fa4841
		[[self delegate] modifiersChangedForKeyboard:self];
Packit Service fa4841
}
Packit Service fa4841
Packit Service fa4841
@end