IOHIKeyboardMapper.cpp [plain text]
#include <IOKit/assert.h>
#include <IOKit/IOLib.h>
#include <IOKit/hidsystem/IOLLEvent.h>
#include <IOKit/hidsystem/IOHIKeyboard.h>
#include <IOKit/hidsystem/IOHIKeyboardMapper.h>
#define super OSObject
OSDefineMetaClassAndStructors(IOHIKeyboardMapper, OSObject);
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;
return true;
}
void IOHIKeyboardMapper::free()
{
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)
{
unsigned char thisBits = _parsedMapping.keyBits[key];
unsigned char * bp;
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
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(*((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);
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 = *((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;
}
}
}
}