IOHIKeyboardMapper.cpp [plain text]
#include <sys/systm.h>
#include <IOKit/assert.h>
#include <IOKit/IOLib.h>
#include <IOKit/hidsystem/IOLLEvent.h>
#include <IOKit/hidsystem/IOHIKeyboard.h>
#include <IOKit/hidsystem/IOHIKeyboardMapper.h>
#include <IOKit/hidsystem/IOHIDParameter.h>
#include <IOKit/hidsystem/IOHIDSystem.h>
#include <libkern/OSByteOrder.h>
#include "IOHIDKeyboardDevice.h"
#define super OSObject
OSDefineMetaClassAndStructors(IOHIKeyboardMapper, OSObject);
enum
{
kState_ClearHeldKeysFirst = 0x0100, };
enum
{
kState_Aborted_Flag = 0x0200,
kState_In_Progess_Flag = 0x0400,
kState_Is_Repeat_Flag = 0x0800,
};
#define kADB_KEYBOARD_F12 0x6f
#define postSlowKeyTranslateKeyCode(owner,key,keyDown,keyBits) \
if (!owner->f12EjectFilterKey(key, keyDown, keyBits)) \
if (!owner->stickyKeysFilterKey(key, keyDown, keyBits)) \
owner->rawTranslateKeyCode(key, keyDown, keyBits);
#define modifierOfInterest(keyBits) \
((keyBits & NX_MODMASK) && \
((keyBits & NX_WHICHMODMASK) >= NX_MODIFIERKEY_SHIFT) && \
((keyBits & NX_WHICHMODMASK) <= NX_MODIFIERKEY_COMMAND))
IOHIKeyboardMapper * IOHIKeyboardMapper::keyboardMapper(
IOHIKeyboard * delegate,
const UInt8 * mapping,
UInt32 mappingLength,
bool mappingShouldBeFreed )
{
IOHIKeyboardMapper * me = new IOHIKeyboardMapper;
if (me && !me->init(delegate, mapping, mappingLength, mappingShouldBeFreed))
{
me->free();
return 0;
}
return me;
}
bool IOHIKeyboardMapper::init( IOHIKeyboard * delegate,
const UInt8 * mapping,
UInt32 mappingLength,
bool mappingShouldBeFreed )
{
if (!super::init()) return false;
_delegate = delegate;
if (!parseKeyMapping(mapping, mappingLength, &_parsedMapping)) return false;
_mappingShouldBeFreed = mappingShouldBeFreed;
_parsedMapping.mapping = mapping;
_parsedMapping.mappingLen = mappingLength;
_hidSystem = NULL;
_stateDirty = false;
_reserved = IONew(ExpansionData, 1);
_ejectTimerEventSource = 0;
_f12Eject_State = 0;
_eject_Delay_MS = 250;
_slowKeys_State = 0;
_slowKeys_Delay_MS = 0;
_slowKeysTimerEventSource = 0;
_stickyKeysMouseClickEventSource = 0;
_hidKeyboardNub = 0;
if (_parsedMapping.numDefs &&
_delegate && !OSDynamicCast(IOHIDDevice, _delegate->getProvider()))
{
_hidKeyboardNub = IOHIDKeyboardDevice::newKeyboardDevice();
if (_hidKeyboardNub &&
(!_hidKeyboardNub->attach(_delegate) ||
!_hidKeyboardNub->start(_delegate)))
{
_hidKeyboardNub->release();
_hidKeyboardNub = 0;
}
}
return stickyKeysinit();
}
void IOHIKeyboardMapper::free()
{
stickyKeysfree();
if (_ejectTimerEventSource) {
_ejectTimerEventSource->release();
_ejectTimerEventSource = 0;
}
if (_slowKeysTimerEventSource) {
_slowKeysTimerEventSource->release();
_slowKeysTimerEventSource = 0;
}
if (_hidKeyboardNub) {
_hidKeyboardNub->release();
_hidKeyboardNub = 0;
}
if (_stickyKeysMouseClickEventSource) {
_stickyKeysMouseClickEventSource->release();
_stickyKeysMouseClickEventSource = 0;
}
if (_reserved) {
IODelete(_reserved, ExpansionData, 1);
}
if (_mappingShouldBeFreed && _parsedMapping.mapping)
IOFree((void *)_parsedMapping.mapping, _parsedMapping.mappingLen);
super::free();
}
const UInt8 * IOHIKeyboardMapper::mapping()
{
return (const UInt8 *)_parsedMapping.mapping;
}
UInt32 IOHIKeyboardMapper::mappingLength()
{
return _parsedMapping.mappingLen;
}
bool IOHIKeyboardMapper::serialize(OSSerialize *s) const
{
OSData * data;
bool ok;
if (s->previouslySerialized(this)) return true;
data = OSData::withBytesNoCopy( (void *) _parsedMapping.mapping, _parsedMapping.mappingLen );
if (data) {
ok = data->serialize(s);
data->release();
} else
ok = false;
return( ok );
}
void IOHIKeyboardMapper::translateKeyCode(UInt8 key,
bool keyDown,
kbdBitVector keyBits)
{
if (_hidKeyboardNub)
_hidKeyboardNub->postKeyboardEvent(key, keyDown);
if (!slowKeysFilterKey(key, keyDown, keyBits))
if (!f12EjectFilterKey(key, keyDown, keyBits))
if (!stickyKeysFilterKey(key, keyDown, keyBits))
rawTranslateKeyCode(key, keyDown, keyBits);
}
void IOHIKeyboardMapper::rawTranslateKeyCode(UInt8 key,
bool keyDown,
kbdBitVector keyBits)
{
unsigned char thisBits = _parsedMapping.keyBits[key];
if (keyDown)
{
EVK_KEYDOWN(key, keyBits);
if (thisBits & NX_MODMASK) doModCalc(key, keyBits);
if (thisBits & NX_CHARGENMASK) doCharGen(key, keyDown);
}
else
{
EVK_KEYUP(key, keyBits);
if (thisBits & NX_CHARGENMASK) doCharGen(key, keyDown);
if (thisBits & NX_MODMASK) doModCalc(key, keyBits);
}
if( 0 == (thisBits & (NX_MODMASK | NX_CHARGENMASK)))
if (_delegate->interfaceID() == NX_EVS_DEVICE_INTERFACE_ADB)
{
unsigned charCode=0;
switch (key) {
case 0x5F: charCode = ',';
break;
case 0x5E: charCode = '_';
break;
case 0x5d: charCode = '\\';
break;
case 0x0a:
charCode = 0xa7;
break;
case 0x66: case 0x68: default:
break;
}
_delegate->keyboardEvent(keyDown ? NX_KEYDOWN : NX_KEYUP,
_delegate->eventFlags(),
key,
charCode,
0, 0,
0);
}
#ifdef OMITPENDINGKEYCAPS
unsigned char * bp;
if (key == _parsedMapping.specialKeys[NX_KEYTYPE_CAPS_LOCK]) {
if (_delegate->alphaLock() == keyDown)
{
_delegate->keyboardEvent(keyDown ? NX_KEYDOWN : NX_KEYUP,
_delegate->eventFlags(), key, 0, 0, 0, 0);
}
}
bp = _parsedMapping.modDefs[NX_MODIFIERKEY_SECONDARYFN]; if (bp)
{
bp++; if (key == *bp ) {
_delegate->keyboardEvent(keyDown ? NX_KEYDOWN : NX_KEYUP,
_delegate->eventFlags(), key, 0, 0, 0, 0);
}
}
#endif
}
typedef struct {
unsigned const char *bp;
unsigned const char *endPtr;
int shorts;
} NewMappingData;
static inline unsigned int NextNum(NewMappingData *nmd)
{
if (nmd->bp >= nmd->endPtr)
return(0);
if (nmd->shorts)
return OSSwapBigToHostInt16(*((unsigned short *)nmd->bp)++);
else
return (*((unsigned char *)nmd->bp)++);
}
bool IOHIKeyboardMapper::parseKeyMapping(const UInt8 * mapping,
UInt32 mappingLength,
NXParsedKeyMapping * parsedMapping) const
{
NewMappingData nmd;
int i, j, k, l, n;
unsigned int m;
int keyMask, numMods;
int maxSeqNum = -1;
unsigned char * bp;
bzero( parsedMapping, sizeof (NXParsedKeyMapping) );
parsedMapping->maxMod = -1;
parsedMapping->numDefs = -1;
parsedMapping->numSeqs = -1;
nmd.endPtr = mapping + mappingLength;
nmd.bp = mapping;
nmd.shorts = 1;
parsedMapping->mapping = (unsigned char *)mapping;
parsedMapping->mappingLen = mappingLength;
parsedMapping->shorts = nmd.shorts = NextNum(&nmd);
numMods = NextNum(&nmd);
for(i=0; i<numMods; i++)
{
if ((j = NextNum(&nmd)) >= NX_NUMMODIFIERS)
return false;
if (j > parsedMapping->maxMod)
parsedMapping->maxMod = j;
parsedMapping->modDefs[j] = (unsigned char *)nmd.bp;
for(k=0,n = NextNum(&nmd);k<n;k++)
{
if ((l = NextNum(&nmd)) >= NX_NUMKEYCODES)
return false;
if (parsedMapping->keyBits[l] & NX_MODMASK)
return false;
if ((j != NX_MODIFIERKEY_ALPHALOCK) || (_delegate->doesKeyLock(NX_KEYTYPE_CAPS_LOCK)) )
{
parsedMapping->keyBits[l] |=NX_MODMASK | (j & NX_WHICHMODMASK);
}
}
}
if (!_delegate->doesKeyLock(NX_KEYTYPE_CAPS_LOCK))
parsedMapping->modDefs[NX_MODIFIERKEY_ALPHALOCK] = 0;
if (_delegate->interfaceID() == NX_EVS_DEVICE_INTERFACE_ADB)
{
parsedMapping->keyBits[0x3f] |=NX_MODMASK | (NX_MODIFIERKEY_SECONDARYFN & NX_WHICHMODMASK);
}
parsedMapping->numDefs = NextNum(&nmd);
n = parsedMapping->numDefs;
for( i=0; i < NX_NUMKEYCODES; i++)
{
if (i < n)
{
parsedMapping->keyDefs[i] = (unsigned char *)nmd.bp;
if ((keyMask = NextNum(&nmd)) != (nmd.shorts ? 0xFFFF: 0x00FF))
{
parsedMapping->keyBits[i] |= NX_CHARGENMASK;
for(j=0, k=1; j<=parsedMapping->maxMod; j++, keyMask>>=1)
{
if (keyMask & 0x01)
k*= 2;
}
for(j=0; j<k; j++)
{
m = NextNum(&nmd);
l = NextNum(&nmd);
if (m == (unsigned)(nmd.shorts ? 0xFFFF: 0x00FF))
if (((int)l) > maxSeqNum)
maxSeqNum = l;
}
}
else
parsedMapping->keyDefs[i] = NULL;
}
else
{
parsedMapping->keyDefs[i] = NULL;
}
}
parsedMapping->numSeqs = NextNum(&nmd);
if (parsedMapping->numSeqs <= maxSeqNum)
return false;
for(i = 0; i < parsedMapping->numSeqs; i++)
{
parsedMapping->seqDefs[i] = (unsigned char *)nmd.bp;
for(j=0, l=NextNum(&nmd); j<l; j++)
{
NextNum(&nmd);
NextNum(&nmd);
}
}
numMods = NextNum(&nmd);
parsedMapping->numSpecialKeys = numMods;
if ( numMods > NX_NUMSPECIALKEYS )
return false;
if ( numMods )
{
for ( i = 0; i < NX_NUMSPECIALKEYS; ++i )
parsedMapping->specialKeys[i] = NX_NOSPECIALKEY;
if (_delegate->interfaceID() == NX_EVS_DEVICE_INTERFACE_ADB)
{
parsedMapping->specialKeys[NX_KEYTYPE_CAPS_LOCK] = 0x39;
parsedMapping->specialKeys[NX_KEYTYPE_NUM_LOCK] = 0x47;
parsedMapping->keyDefs[0x72] = parsedMapping->keyDefs[0x47];
}
for ( i = 0; i < numMods; ++i )
{
j = NextNum(&nmd);
l = NextNum(&nmd);
if ( j >= NX_NUMSPECIALKEYS )
return false;
parsedMapping->specialKeys[j] = l;
}
}
else
{
return false;
}
for(i=0; i<NX_NUM_SCANNED_SPECIALKEYS; i++)
{
if ( parsedMapping->specialKeys[i] != NX_NOSPECIALKEY )
{
parsedMapping->keyBits[parsedMapping->specialKeys[i]] |=
(NX_CHARGENMASK | NX_SPECIALKEYMASK);
}
}
if (_delegate->doesKeyLock(NX_KEYTYPE_CAPS_LOCK))
{
parsedMapping->keyBits[ parsedMapping->specialKeys[NX_KEYTYPE_CAPS_LOCK] ]
&= ~NX_CHARGENMASK;
}
bp = _parsedMapping.modDefs[NX_MODIFIERKEY_SECONDARYFN]; if (bp)
{
bp++; parsedMapping->keyBits[ *bp ] &= ~NX_CHARGENMASK;
}
return true;
}
UInt8 IOHIKeyboardMapper::getParsedSpecialKey(UInt8 logical)
{
UInt8 retval;
if ( logical < NX_NUMSPECIALKEYS)
retval = _parsedMapping.specialKeys[logical];
else
retval = 0xff; return retval;
}
static inline int NEXTNUM(unsigned char ** mapping, short shorts)
{
int returnValue;
if (shorts)
{
returnValue = OSSwapBigToHostInt16(*((unsigned short *)*mapping));
*mapping += sizeof(unsigned short);
}
else
{
returnValue = **((unsigned char **)mapping);
*mapping += sizeof(unsigned char);
}
return returnValue;
}
static inline int IsModifierDown(NXParsedKeyMapping *parsedMapping,
kbdBitVector keyBits,
int bit )
{
int i, n;
unsigned char *mapping;
unsigned key;
short shorts = parsedMapping->shorts;
if ( (mapping = parsedMapping->modDefs[bit]) != 0 ) {
for(i=0, n=NEXTNUM(&mapping, shorts); i<n; i++)
{
key = NEXTNUM(&mapping, shorts);
if ( EVK_IS_KEYDOWN(key, keyBits) )
return 1;
}
}
return 0;
}
void IOHIKeyboardMapper::calcModBit(int bit, kbdBitVector keyBits)
{
int bitMask;
unsigned myFlags;
bitMask = 1<<(bit+16);
myFlags = _delegate->deviceFlags() & (~bitMask);
if ( IsModifierDown( &_parsedMapping, keyBits, bit ) )
myFlags |= bitMask;
if ( bit == NX_MODIFIERKEY_ALPHALOCK )
_delegate->setAlphaLock((myFlags & NX_ALPHASHIFTMASK) ? true : false);
else if ( bit == NX_MODIFIERKEY_NUMLOCK )
_delegate->setNumLock((myFlags & NX_NUMERICPADMASK) ? true : false);
_delegate->setDeviceFlags(myFlags);
}
void IOHIKeyboardMapper::doModCalc(int key, kbdBitVector keyBits)
{
int thisBits;
thisBits = _parsedMapping.keyBits[key];
if (thisBits & NX_MODMASK)
{
calcModBit((thisBits & NX_WHICHMODMASK), keyBits);
if (!(thisBits & NX_CHARGENMASK))
{
_delegate->keyboardEvent(NX_FLAGSCHANGED,
_delegate->eventFlags(),
key,
0,
0,
0,
0);
}
else
_delegate->updateEventFlags(_delegate->eventFlags());
}
}
void IOHIKeyboardMapper::doCharGen(int keyCode, bool down)
{
int i, n, eventType, adjust, thisMask, modifiers, saveModifiers;
short shorts;
unsigned charSet, origCharSet;
unsigned charCode, origCharCode;
unsigned char *mapping;
unsigned eventFlags, origflags;
_delegate->setCharKeyActive(true);
eventType = (down == true) ? NX_KEYDOWN : NX_KEYUP;
eventFlags = _delegate->eventFlags();
saveModifiers = eventFlags >> 16;
if( saveModifiers & (NX_SHIFTMASK >> 16))
saveModifiers |= (NX_ALPHASHIFTMASK >> 16);
shorts = _parsedMapping.shorts;
mapping = _parsedMapping.keyDefs[keyCode];
modifiers = saveModifiers;
if ( mapping )
{
thisMask = NEXTNUM(&mapping, shorts);
if (thisMask && modifiers)
{
adjust = (shorts ? sizeof(short) : sizeof(char))*2;
for( i = 0; i <= _parsedMapping.maxMod; ++i)
{
if (thisMask & 0x01)
{
if (modifiers & 0x01)
mapping += adjust;
adjust *= 2;
}
thisMask >>= 1;
modifiers >>= 1;
}
}
charSet = NEXTNUM(&mapping, shorts);
charCode = NEXTNUM(&mapping, shorts);
mapping = _parsedMapping.keyDefs[keyCode];
modifiers = saveModifiers & ((NX_ALPHASHIFTMASK | NX_SHIFTMASK) >> 16);
thisMask = NEXTNUM(&mapping, shorts);
if (thisMask && modifiers)
{
adjust = (shorts ? sizeof(short) : sizeof(char)) * 2;
for ( i = 0; i <= _parsedMapping.maxMod; ++i)
{
if (thisMask & 0x01)
{
if (modifiers & 0x01)
mapping += adjust;
adjust *= 2;
}
thisMask >>= 1;
modifiers >>= 1;
}
}
origCharSet = NEXTNUM(&mapping, shorts);
origCharCode = NEXTNUM(&mapping, shorts);
if (charSet == (unsigned)(shorts ? 0xFFFF : 0x00FF))
{
mapping = _parsedMapping.seqDefs[charCode];
origflags = eventFlags;
for(i=0,n=NEXTNUM(&mapping, shorts);i<n;i++)
{
if ( (charSet = NEXTNUM(&mapping, shorts)) == 0xFF )
{
if ( down == true )
{
eventFlags |= (1 << (NEXTNUM(&mapping, shorts) + 16));
_delegate->keyboardEvent(NX_FLAGSCHANGED,
_delegate->deviceFlags(),
keyCode,
0,
0,
0,
0);
}
else
NEXTNUM(&mapping, shorts);
}
else
{
charCode = NEXTNUM(&mapping, shorts);
_delegate->keyboardEvent(eventType,
eventFlags,
keyCode,
charCode,
charSet,
charCode,
charSet);
}
}
if ( eventFlags != origflags )
{
_delegate->keyboardEvent(NX_FLAGSCHANGED,
_delegate->deviceFlags(),
keyCode,
0,
0,
0,
0);
eventFlags = origflags;
}
}
else
{
_delegate->keyboardEvent(eventType,
eventFlags,
keyCode,
charCode,
charSet,
origCharCode,
origCharSet);
}
}
if (_parsedMapping.keyBits[keyCode] & NX_SPECIALKEYMASK)
{
for(i=0; i<NX_NUM_SCANNED_SPECIALKEYS; i++)
{
if ( keyCode == _parsedMapping.specialKeys[i] )
{
_delegate->keyboardSpecialEvent(eventType,
eventFlags,
keyCode,
i);
if (i == NX_KEYTYPE_CAPS_LOCK
&& down == true
&& !_parsedMapping.modDefs[NX_MODIFIERKEY_ALPHALOCK] )
{
unsigned myFlags = _delegate->deviceFlags();
bool alphaLock = (_delegate->alphaLock() == false);
_delegate->setAlphaLock(alphaLock);
if ( alphaLock )
myFlags |= NX_ALPHASHIFTMASK;
else
myFlags &= ~NX_ALPHASHIFTMASK;
_delegate->setDeviceFlags(myFlags);
_delegate->keyboardEvent(NX_FLAGSCHANGED,
myFlags,
keyCode,
0,
0,
0,
0);
}
else if (i == NX_KEYTYPE_NUM_LOCK
&& down == true
&& !_parsedMapping.modDefs[NX_MODIFIERKEY_NUMLOCK] )
{
unsigned myFlags = _delegate->deviceFlags();
bool numLock = (_delegate->numLock() == false);
_delegate->setNumLock(numLock);
if ( numLock )
myFlags |= NX_NUMERICPADMASK;
else
myFlags &= ~NX_NUMERICPADMASK;
_delegate->setDeviceFlags(myFlags);
_delegate->keyboardEvent(NX_FLAGSCHANGED,
myFlags,
keyCode,
0,
0,
0,
0);
}
break;
}
}
}
}
void IOHIKeyboardMapper::setKeyboardTarget (IOService * keyboardTarget)
{
_hidSystem = OSDynamicCast( IOHIDSystem, keyboardTarget );
}
void IOHIKeyboardMapper::makeParamProperty( OSDictionary * dict, const char * key,
const void * bytes, unsigned int length )
{
OSData * data;
data = OSData::withBytes( bytes, length );
if( data) {
dict->setObject( key, data);
data->release();
}
}
bool IOHIKeyboardMapper::updateProperties( void )
{
bool ok = true;
return( ok );
}
IOReturn IOHIKeyboardMapper::setParamProperties( OSDictionary * dict )
{
OSData * data;
IOReturn err = kIOReturnSuccess;
bool updated = false;
bool turnedOff = false;
UInt32 propertydata;
if( (data = OSDynamicCast( OSData,
dict->getObject(kIOHIDF12EjectDelayKey)))) {
propertydata = *((UInt32 *)(data->getBytesNoCopy()));
_eject_Delay_MS = propertydata;
updated = true;
}
if( (data = OSDynamicCast( OSData,
dict->getObject(kIOHIDSlowKeysDelayKey)))) {
propertydata = *((UInt32 *)(data->getBytesNoCopy()));
if ((_slowKeys_Delay_MS > 0) && !propertydata &&
((_slowKeys_State & kState_In_Progess_Flag) != 0))
_slowKeysTimerEventSource->cancelTimeout();
_slowKeys_Delay_MS = propertydata;
updated = true;
}
if( (data = OSDynamicCast( OSData,
dict->getObject(kIOHIDStickyKeysDisabledKey))))
{
propertydata = *((UInt32 *)(data->getBytesNoCopy()));
if (propertydata)
_stickyKeys_State |= kState_Disabled_Flag;
else
_stickyKeys_State &= ~kState_Disabled_Flag;
if (propertydata)
turnedOff = true;
updated = true;
}
if( (data = OSDynamicCast( OSData,
dict->getObject(kIOHIDStickyKeysOnKey))))
{
propertydata = *((UInt32 *)(data->getBytesNoCopy()));
if (propertydata)
_stickyKeys_State |= kState_On;
else
_stickyKeys_State &= ~kState_On;
if (propertydata == 0)
turnedOff = true;
updated = true;
}
if( (data = OSDynamicCast( OSData,
dict->getObject(kIOHIDStickyKeysShiftTogglesKey))))
{
propertydata = *((UInt32 *)(data->getBytesNoCopy()));
if (propertydata)
_stickyKeys_State |= kState_ShiftActivates_Flag;
else
_stickyKeys_State &= ~kState_ShiftActivates_Flag;
updated = true;
}
if (turnedOff)
{
for (int index = 0; index < _stickyKeys_NumModifiersDown; index++)
rawTranslateKeyCode(_stickyKeys_StuckModifiers[index].key, false, _stickyKeys_Modifier_KeyBits);
_stickyKeys_State &= ~kState_On_ModifiersDown;
_stickyKeys_NumModifiersDown = 0;
}
if (updated)
updateProperties();
return( err );
}
bool IOHIKeyboardMapper::stickyKeysinit( void )
{
_stickyKeys_State = 0;
_stickyKeys_NumModifiersDown = 0;
_stickyKeys_ShiftToggle = stickyKeysAllocToggleInfo (kNUM_SHIFTS_TO_ACTIVATE);
if (_stickyKeys_ShiftToggle == NULL)
return false;
_stickyKeys_ShiftToggle->toggleModifier = NX_MODIFIERKEY_SHIFT;
_stickyKeys_ShiftToggle->repetitionsToToggle = kNUM_SHIFTS_TO_ACTIVATE;
clock_interval_to_absolutetime_interval( kDEFAULT_SHIFTEXPIREINTERVAL,
kMillisecondScale,
&_stickyKeys_ShiftToggle->expireInterval);
_stickyKeys_ShiftToggle->currentCount = 0;
_stickyKeys_OptionToggle = stickyKeysAllocToggleInfo (kNUM_SHIFTS_TO_ACTIVATE);
if (_stickyKeys_OptionToggle == NULL)
return false;
_stickyKeys_OptionToggle->toggleModifier = NX_MODIFIERKEY_ALTERNATE;
_stickyKeys_OptionToggle->repetitionsToToggle = kNUM_SHIFTS_TO_ACTIVATE;
clock_interval_to_absolutetime_interval( kDEFAULT_SHIFTEXPIREINTERVAL,
kMillisecondScale,
&_stickyKeys_OptionToggle->expireInterval);
_stickyKeys_OptionToggle->currentCount = 0;
return createParamDicts();
}
void IOHIKeyboardMapper::stickyKeysfree (void)
{
if (_stickyKeys_ShiftToggle)
stickyKeysFreeToggleInfo(_stickyKeys_ShiftToggle);
if (_stickyKeys_OptionToggle)
stickyKeysFreeToggleInfo(_stickyKeys_OptionToggle);
if (_onParamDict)
_onParamDict->release();
if (_offParamDict)
_offParamDict->release();
}
StickyKeys_ToggleInfo * IOHIKeyboardMapper::stickyKeysAllocToggleInfo (unsigned maxCount)
{
StickyKeys_ToggleInfo * toggleInfo;
IOByteCount size;
size = sizeof(StickyKeys_ToggleInfo) +
(sizeof(AbsoluteTime) * (maxCount - 1));
toggleInfo = (StickyKeys_ToggleInfo *)
IOMalloc (size);
if (toggleInfo)
toggleInfo->size = size;
return toggleInfo;
}
void IOHIKeyboardMapper::stickyKeysFreeToggleInfo (StickyKeys_ToggleInfo * toggleInfo)
{
IOFree (toggleInfo, toggleInfo->size);
}
bool IOHIKeyboardMapper::createParamDicts ( void )
{
bool ok = true;
UInt32 propertydata;
_onParamDict = OSDictionary::withCapacity(4);
if (_onParamDict)
{
propertydata = 1; makeParamProperty( _onParamDict, kIOHIDStickyKeysOnKey,
&propertydata, sizeof(propertydata) );
}
else
ok = false;
if (ok)
_offParamDict = OSDictionary::withCapacity(4);
if (_offParamDict)
{
propertydata = 0; makeParamProperty( _offParamDict, kIOHIDStickyKeysOnKey,
&propertydata, sizeof(propertydata) );
}
else
ok = false;
return( ok );
}
void IOHIKeyboardMapper::postKeyboardSpecialEvent (unsigned subtype)
{
_delegate->keyboardSpecialEvent (
NX_SYSDEFINED,
_delegate->eventFlags(),
NX_NOSPECIALKEY,
subtype);
}
bool IOHIKeyboardMapper::stickyKeysModifierToggleCheck(
StickyKeys_ToggleInfo * toggleInfo,
UInt8 key,
bool keyDown,
kbdBitVector keyBits)
{
unsigned char thisBits = _parsedMapping.keyBits[key];
int index, innerindex;
AbsoluteTime now, deadline;
bool shouldToggle = false;
if ((unsigned)(thisBits & NX_WHICHMODMASK) == toggleInfo->toggleModifier)
{
clock_get_uptime(&now);
for (index = toggleInfo->currentCount - 1; index >= 0; index--)
if (AbsoluteTime_to_scalar(&now) >
AbsoluteTime_to_scalar(&toggleInfo->deadlines[index]))
{
int entries_to_delete = index + 1;
for (innerindex = 0; innerindex < (int)(toggleInfo->currentCount - entries_to_delete); innerindex++)
toggleInfo->deadlines[innerindex] =
toggleInfo->deadlines[innerindex + entries_to_delete];
toggleInfo->currentCount -= entries_to_delete;
index = -1;
break;
}
if (keyDown)
{
if (toggleInfo->currentCount < toggleInfo->repetitionsToToggle)
{
clock_absolutetime_interval_to_deadline(toggleInfo->expireInterval, &deadline);
toggleInfo->deadlines[toggleInfo->currentCount++] = deadline;
}
}
else
{
if (toggleInfo->currentCount == toggleInfo->repetitionsToToggle)
{
toggleInfo->currentCount = 0;
shouldToggle = true;
}
}
}
else
toggleInfo->currentCount = 0;
return shouldToggle;
}
void IOHIKeyboardMapper::stickyKeysNonModifierKey(
UInt8 key,
bool keyDown,
kbdBitVector keyBits,
bool mouseClick)
{
int index;
if (!mouseClick)
rawTranslateKeyCode(key, keyDown, keyBits);
for (index = 0; index < _stickyKeys_NumModifiersDown; index++) {
_stickyKeys_StuckModifiers[index].state |= kModifier_DidPerformModifiy;
if (((_stickyKeys_StuckModifiers[index].state & kModifier_DidKeyUp) != 0) &&
((_stickyKeys_StuckModifiers[index].state & kModifier_Locked) == 0)) {
stickyKeysModifierKey(_stickyKeys_StuckModifiers[index].key, false, keyBits);
index --;
}
}
if (_stickyKeys_NumModifiersDown == 0)
_stickyKeys_State &= ~kState_On_ModifiersDown;
}
void IOHIKeyboardMapper::stickyKeysModifierKey(
UInt8 key,
bool keyDown,
kbdBitVector keyBits)
{
unsigned char thisBits = _parsedMapping.keyBits[key];
int index, innerindex;
bool isBeingHeld;
int heldIndex;
isBeingHeld = false;
for (index = 0; index < _stickyKeys_NumModifiersDown; index++)
if (_stickyKeys_StuckModifiers[index].key == key)
{
isBeingHeld = true;
heldIndex = index;
break;
}
if (! keyDown) {
if (isBeingHeld)
{
if (((_stickyKeys_StuckModifiers[heldIndex].state & kModifier_DidPerformModifiy) != 0) &&
((_stickyKeys_StuckModifiers[heldIndex].state & kModifier_Locked) == 0)) {
goto RELEASE_STICKY_MODIFIER_KEY;
}
else
{
_stickyKeys_StuckModifiers[heldIndex].state |= kModifier_DidKeyUp;
}
}
}
else
{
if (isBeingHeld)
{
if ((_stickyKeys_StuckModifiers[heldIndex].state & kModifier_Locked) != 0)
{
RELEASE_STICKY_MODIFIER_KEY:
rawTranslateKeyCode(key, false, keyBits);
_stickyKeys_StuckModifiers[heldIndex].key = 0;
_stickyKeys_StuckModifiers[heldIndex].state = 0;
_stickyKeys_NumModifiersDown--;
if (_stickyKeys_NumModifiersDown == 0)
_stickyKeys_State &= ~kState_On_ModifiersDown;
for (innerindex = heldIndex; innerindex < _stickyKeys_NumModifiersDown; innerindex++) {
_stickyKeys_StuckModifiers[innerindex].key = _stickyKeys_StuckModifiers[innerindex + 1].key;
_stickyKeys_StuckModifiers[innerindex].state = _stickyKeys_StuckModifiers[innerindex + 1].state;
}
if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_SHIFT)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_SHIFT_UP);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_CONTROL)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_CONTROL_UP);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_ALTERNATE)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_ALTERNATE_UP);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_COMMAND)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_COMMAND_UP);
}
else
{
_stickyKeys_StuckModifiers[heldIndex].state |= kModifier_Locked;
if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_SHIFT)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_SHIFT_LOCK);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_CONTROL)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_CONTROL_LOCK);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_ALTERNATE)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_ALTERNATE_LOCK);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_COMMAND)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_COMMAND_LOCK);
}
}
else
{
_stickyKeys_Modifier_KeyBits = keyBits;
rawTranslateKeyCode(key, keyDown, keyBits);
if (_stickyKeys_NumModifiersDown < kMAX_MODIFIERS) {
int modifierIndex = _stickyKeys_NumModifiersDown++;
_stickyKeys_StuckModifiers[modifierIndex].key = key;
_stickyKeys_StuckModifiers[modifierIndex].state = 0;
}
else
;
_stickyKeys_State |= kState_On_ModifiersDown;
if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_SHIFT)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_SHIFT_DOWN);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_CONTROL)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_CONTROL_DOWN);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_ALTERNATE)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_ALTERNATE_DOWN);
else if ((thisBits & NX_WHICHMODMASK) == NX_MODIFIERKEY_COMMAND)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_COMMAND_DOWN);
}
}
}
bool IOHIKeyboardMapper::stickyKeysFilterKey(
UInt8 key,
bool keyDown,
kbdBitVector keyBits)
{
unsigned char thisBits = _parsedMapping.keyBits[key];
bool shouldFilter = false;
int index;
bool shouldToggleState = false;
if ((_stickyKeys_State & kState_Disabled_Flag) != 0)
return false;
if ((_stickyKeys_State & kState_ShiftActivates_Flag) != 0)
{
shouldToggleState = stickyKeysModifierToggleCheck
(_stickyKeys_ShiftToggle, key, keyDown, keyBits);
if (stickyKeysModifierToggleCheck (_stickyKeys_OptionToggle,
key, keyDown, keyBits))
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_TOGGLEMOUSEDRIVING);
}
if (((_stickyKeys_State & kState_On_ModifiersDown) != 0) && keyDown)
{
if (! modifierOfInterest(thisBits))
{
shouldFilter = true;
stickyKeysNonModifierKey (key, keyDown, keyBits);
}
}
if ((_stickyKeys_State & kState_On) != 0)
{
if (modifierOfInterest(thisBits))
{
shouldFilter = true;
stickyKeysModifierKey (key, keyDown, keyBits);
}
}
if (shouldToggleState)
{
if ((_stickyKeys_State & kState_On) != 0)
{
for (index = 0; index < _stickyKeys_NumModifiersDown; index++)
rawTranslateKeyCode(_stickyKeys_StuckModifiers[index].key, false, keyBits);
_stickyKeys_State &= ~kState_On_ModifiersDown;
_stickyKeys_NumModifiersDown = 0;
}
_stickyKeys_State ^= kState_On;
_stateDirty = true;
if ((_stickyKeys_State & kState_On) != 0)
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_ON);
else
postKeyboardSpecialEvent (NX_SUBTYPE_STICKYKEYS_OFF);
}
return shouldFilter;
}
void IOHIKeyboardMapper::keyEventPostProcess (void)
{
bool nowOn;
OSDictionary * dict;
if (_stateDirty)
{
if (_hidSystem)
{
nowOn = ((_stickyKeys_State & kState_On) != 0);
dict = nowOn ? _onParamDict : _offParamDict;
_hidSystem->setParamProperties (dict);
}
_stateDirty = false;
}
}
bool IOHIKeyboardMapper::f12EjectFilterKey (UInt8 key, bool keyDown, kbdBitVector keyBits) {
if (_eject_Delay_MS == 0)
return false;
if ((_delegate->deviceType() >= 0xca) && (_delegate->deviceType() <= 0xcf))
return false;
if (_delegate->interfaceID() != NX_EVS_DEVICE_INTERFACE_ADB)
return false;
if (key == kADB_KEYBOARD_F12) {
if (!_ejectTimerEventSource) {
if (_hidSystem == NULL)
return false;
_ejectTimerEventSource = IOTimerEventSource::timerEventSource
(this, (IOTimerEventSource::Action) &IOHIKeyboardMapper::performF12Eject);
if (_hidSystem->getWorkLoop()->addEventSource(_ejectTimerEventSource) != kIOReturnSuccess)
return false;
}
if (keyDown == true) {
_f12Eject_State |= kState_In_Progess_Flag;
_ejectTimerEventSource->setTimeoutMS(_eject_Delay_MS);
return true;
} else {
if ((_f12Eject_State & kState_In_Progess_Flag) != 0) {
_ejectTimerEventSource->cancelTimeout();
_f12Eject_State &= ~kState_In_Progess_Flag;
rawTranslateKeyCode (key, true, keyBits);
}
else
return true;
}
}
return false;
}
void IOHIKeyboardMapper::performF12Eject(IOHIKeyboardMapper *owner, IOTimerEventSource *sender) {
owner->postKeyboardSpecialEvent(NX_SUBTYPE_EJECT_KEY);
owner->_f12Eject_State &= ~kState_In_Progess_Flag;
}
bool IOHIKeyboardMapper::slowKeysFilterKey (UInt8 key, bool keyDown, kbdBitVector keyBits) {
bool returnValue = true;
if (_slowKeys_Delay_MS == 0)
return false;
if (!_slowKeysTimerEventSource) {
if (_hidSystem == NULL)
return false;
_slowKeysTimerEventSource = IOTimerEventSource::timerEventSource
(this, (IOTimerEventSource::Action) &IOHIKeyboardMapper::slowKeysPostProcess );
if(_hidSystem->getWorkLoop()->addEventSource(_slowKeysTimerEventSource) != kIOReturnSuccess)
return false;
}
if (keyDown) {
if ((_slowKeys_State & kState_In_Progess_Flag) == 0) {
if ((key != _slowKeys_Current_Key) && ((_slowKeys_State & kState_Is_Repeat_Flag) != 0)) {
postSlowKeyTranslateKeyCode(this, _slowKeys_Current_Key, false, _slowKeys_Current_KeyBits);
_slowKeys_State &= ~kState_Is_Repeat_Flag;
}
_slowKeys_State |= kState_In_Progess_Flag;
_slowKeys_Current_Key = key;
_slowKeys_Current_KeyBits = keyBits;
_slowKeysTimerEventSource->setTimeoutMS(_slowKeys_Delay_MS);
if (_delegate->isRepeat())
_slowKeys_State |= kState_Is_Repeat_Flag;
postKeyboardSpecialEvent(NX_SUBTYPE_SLOWKEYS_START);
}
else if (((_slowKeys_State & kState_In_Progess_Flag) != 0) && (key != _slowKeys_Current_Key)) {
_slowKeysTimerEventSource->cancelTimeout();
_slowKeys_State |= kState_Aborted_Flag;
_slowKeys_State &= ~kState_In_Progess_Flag;
_slowKeys_Aborted_Key = key;
if ((_slowKeys_State & kState_Is_Repeat_Flag) != 0) {
postSlowKeyTranslateKeyCode(this, _slowKeys_Current_Key, false, _slowKeys_Current_KeyBits);
_slowKeys_State &= ~kState_Is_Repeat_Flag;
}
postKeyboardSpecialEvent(NX_SUBTYPE_SLOWKEYS_ABORT);
}
}
else {
if (key == _slowKeys_Current_Key) {
if ((_slowKeys_State & kState_In_Progess_Flag) != 0) {
_slowKeysTimerEventSource->cancelTimeout();
_slowKeys_State &= ~kState_In_Progess_Flag;
if ((_slowKeys_State & kState_Is_Repeat_Flag) != 0) {
_slowKeys_State &= ~kState_Is_Repeat_Flag;
returnValue = false;
}
}
else if ((_slowKeys_State & kState_Aborted_Flag) == 0) {
if ((_slowKeys_State & kState_Is_Repeat_Flag) != 0)
_slowKeys_State &= ~kState_Is_Repeat_Flag;
returnValue = false;
}
}
else if ((key == _slowKeys_Aborted_Key) && ((_slowKeys_State & kState_Aborted_Flag) != 0)){
_slowKeysTimerEventSource->cancelTimeout();
_slowKeys_State &= ~kState_Aborted_Flag;
_slowKeys_State &= ~kState_In_Progess_Flag;
if ((_slowKeys_State & kState_Is_Repeat_Flag) != 0) {
postSlowKeyTranslateKeyCode(this, _slowKeys_Current_Key, false, _slowKeys_Current_KeyBits);
_slowKeys_State &= ~kState_Is_Repeat_Flag;
}
postKeyboardSpecialEvent(NX_SUBTYPE_SLOWKEYS_ABORT);
}
else {
returnValue = false;
}
}
return returnValue;
}
void IOHIKeyboardMapper::slowKeysPostProcess (IOHIKeyboardMapper *owner, IOTimerEventSource *sender) {
owner->_slowKeys_State &= ~kState_In_Progess_Flag;
postSlowKeyTranslateKeyCode(owner, owner->_slowKeys_Current_Key, true, owner->_slowKeys_Current_KeyBits);
owner->postKeyboardSpecialEvent(NX_SUBTYPE_SLOWKEYS_END);
}
void IOHIKeyboardMapper::stickyKeysMouseDown(IOHIKeyboardMapper *owner, IOEventSource *sender)
{
owner->stickyKeysNonModifierKey (0, 0, owner->_reserved->stickyKeys_Modifier_KeyBits, true);
}
OSMetaClassDefineReservedUsed(IOHIKeyboardMapper, 0);
IOReturn IOHIKeyboardMapper::message( UInt32 type, IOService * provider, void * argument)
{
switch (type)
{
case kIOHIDSystem508MouseClickMessage:
if ((_stickyKeys_State & kState_On) != 0)
{
if (!_stickyKeysMouseClickEventSource)
{
_stickyKeysMouseClickEventSource = IOInterruptEventSource::interruptEventSource
(this, (IOInterruptEventSource::Action) stickyKeysMouseDown);
if(_stickyKeysMouseClickEventSource &&
_hidSystem &&
(_hidSystem->getWorkLoop()->addEventSource(_stickyKeysMouseClickEventSource) != kIOReturnSuccess)) {
_stickyKeysMouseClickEventSource->release();
_stickyKeysMouseClickEventSource = 0;
}
}
if (_stickyKeysMouseClickEventSource)
_stickyKeysMouseClickEventSource->interruptOccurred(0, 0, 0);
}
break;
default:
break;
}
return kIOReturnSuccess;
}
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 1);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 2);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 3);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 4);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 5);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 6);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 7);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 8);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 9);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 10);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 11);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 12);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 13);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 14);
OSMetaClassDefineReservedUnused(IOHIKeyboardMapper, 15);