qglobalshortcut_mac.cpp

Go to the documentation of this file.

#include <Carbon/Carbon.h>
#include "qglobalshortcut_p.h"
#include <QMap>
#include <QApplication>

typedef QPair<uint, uint> Identifier;
static QMap<quint32, EventHotKeyRef> keyRefs;
static QHash<Identifier, quint32> keyIDs;
static quint32 hotKeySerial = 0;
static bool q_mac_handler_installed = false;

OSStatus q_mac_handle_hot_key(EventHandlerCallRef nextHandler, EventRef event, void *data)
{
    // pass event to the app event filter
    Q_UNUSED(data);
    qApp->macEventFilter(nextHandler, event);
    return noErr;
}

#if !TTK_QT_VERSION_CHECK(5,0,0)
bool QGlobalShortcutPrivate::eventFilter(void *message)
//bool QGlobalShortcutPrivate::macEventFilter(EventHandlerCallRef caller, EventRef event)
{
    EventRef event = (EventRef) message;
    if(GetEventClass(event) == kEventClassKeyboard && GetEventKind(event) == kEventHotKeyPressed)
    {
        EventHotKeyID keyID;
        GetEventParameter(event, kEventParamDirectObject, typeEventHotKeyID, nullptr, sizeof(keyID), nullptr, &keyID);
        Identifier id = keyIDs.key(keyID.id);
        activateShortcut(id.second, id.first);
    }
    return false;
}
#else
bool QGlobalShortcutPrivate::nativeEventFilter(const QByteArray &, void *message, qint *)
{
    EventRef event = (EventRef) message;
    if(GetEventClass(event) == kEventClassKeyboard && GetEventKind(event) == kEventHotKeyPressed)
    {
        EventHotKeyID keyID;
        GetEventParameter(event, kEventParamDirectObject, typeEventHotKeyID, nullptr, sizeof(keyID), nullptr, &keyID);
        Identifier id = keyIDs.key(keyID.id);
        activateShortcut(id.second, id.first);
    }
    return false;
}
#endif

quint32 QGlobalShortcutPrivate::nativeModifiers(Qt::KeyboardModifiers modifiers)
{
    quint32 native = 0;
    if(modifiers & Qt::ShiftModifier)
        native |= shiftKey;
    if(modifiers & Qt::ControlModifier)
        native |= cmdKey;
    if(modifiers & Qt::AltModifier)
        native |= optionKey;
    if(modifiers & Qt::MetaModifier)
        native |= controlKey;
    if(modifiers & Qt::KeypadModifier)
        native |= kEventKeyModifierNumLockMask;
    return native;
}

quint32 QGlobalShortcutPrivate::nativeKeycode(Qt::Key key)
{
    UTF16Char ch;
    // Constants found in NSEvent.h from AppKit.framework
    if(key == Qt::Key_Up)                               ch = 0xF700;
    else if(key == Qt::Key_Down)                ch = 0xF701;
    else if(key == Qt::Key_Left)                ch = 0xF702;
    else if(key == Qt::Key_Right)               ch = 0xF703;
    else if(key >= Qt::Key_F1 && key <= Qt::Key_F35)
        ch = key - Qt::Key_F1 + 0xF704;
    else if(key == Qt::Key_Insert)              ch = 0xF727;
    else if(key == Qt::Key_Delete)              ch = 0xF728;
    else if(key == Qt::Key_Home)                ch = 0xF729;
    else if(key == Qt::Key_End)                 ch = 0xF72B;
    else if(key == Qt::Key_PageUp)              ch = 0xF72C;
    else if(key == Qt::Key_PageDown)    ch = 0xF72D;
    else if(key == Qt::Key_Print)               ch = 0xF72E;
    else if(key == Qt::Key_ScrollLock)  ch = 0xF72F;
    else if(key == Qt::Key_Pause)               ch = 0xF730;
    else if(key == Qt::Key_SysReq)              ch = 0xF731;
    else if(key == Qt::Key_Stop)                ch = 0xF734;
    else if(key == Qt::Key_Menu)                ch = 0xF735;
    else if(key == Qt::Key_Select)              ch = 0xF741;
    else if(key == Qt::Key_Execute)             ch = 0xF742;
    else if(key == Qt::Key_Help)                ch = 0xF746;
    else if(key == Qt::Key_Mode_switch) ch = 0xF747;
    else if(key == Qt::Key_Escape)              ch = 27;
    else if(key == Qt::Key_Return)              ch = 13;
    else if(key == Qt::Key_Enter)               ch = 3;
    else if(key == Qt::Key_Tab)                 ch = 9;
    else                                                                ch = key;

    KeyboardLayoutRef layout;
    KeyboardLayoutKind layoutKind;
    KLGetCurrentKeyboardLayout(&layout);
    KLGetKeyboardLayoutProperty(layout, kKLKind, TTKConstCast(const void**, TTKReinterpretCast(void**, &layoutKind)));

    if(layoutKind == kKLKCHRKind)
    { // no Unicode available
        if(ch > 255) return 0;

        char *data;
        KLGetKeyboardLayoutProperty(layout, kKLKCHRData, TTKConstCast(const void**, TTKReinterpretCast(void**, &data)));
        int ct = *TTKReinterpretCast(short*, data + 258);
        for(int i = 0; i < ct; ++i)
        {
            char *keyTable = data + 260 + 128 * i;
            for(int j = 0; j < 128; ++j)
            {
                if(keyTable[j] == ch) return j;
            }
        }

        return 0;
    }

    char *data;
    KLGetKeyboardLayoutProperty(layout, kKLuchrData, TTKConstCast(const void**, TTKReinterpretCast(void**, &data)));
    UCKeyboardLayout *header = TTKReinterpretCast(UCKeyboardLayout*, data);
    UCKeyboardTypeHeader *table = header->keyboardTypeList;

    for (quint32 i=0; i < header->keyboardTypeCount; i++)
    {
        UCKeyStateRecordsIndex *stateRec = 0;
        if(table[i].keyStateRecordsIndexOffset != 0)
        {
            stateRec = TTKReinterpretCast(UCKeyStateRecordsIndex*, data + table[i].keyStateRecordsIndexOffset);
            if(stateRec->keyStateRecordsIndexFormat != kUCKeyStateRecordsIndexFormat) stateRec = 0;
        }

        UCKeyToCharTableIndex *charTable = TTKReinterpretCast(UCKeyToCharTableIndex*, data + table[i].keyToCharTableIndexOffset);
        if(charTable->keyToCharTableIndexFormat != kUCKeyToCharTableIndexFormat) continue;

        for (quint32 j=0; j < charTable->keyToCharTableCount; j++)
        {
            UCKeyOutput *keyToChar = TTKReinterpretCast(UCKeyOutput*, data + charTable->keyToCharTableOffsets[j]);
            for (quint32 k=0; k < charTable->keyToCharTableSize; k++)
            {
                if(keyToChar[k] & kUCKeyOutputTestForIndexMask)
                {
                    long idx = keyToChar[k] & kUCKeyOutputGetIndexMask;
                    if(stateRec && idx < stateRec->keyStateRecordCount)
                    {
                        UCKeyStateRecord *rec = TTKReinterpretCast(UCKeyStateRecord*, data + stateRec->keyStateRecordOffsets[idx]);
                        if(rec->stateZeroCharData == ch) return k;
                    }
                }
                else if(!(keyToChar[k] & kUCKeyOutputSequenceIndexMask) && keyToChar[k] < 0xFFFE)
                {
                    if(keyToChar[k] == ch) return k;
                }
            } // for k
        } // for j
    } // for i

    return 0;
}

bool QGlobalShortcutPrivate::registerShortcut(quint32 nativeKey, quint32 nativeMods)
{
    if(!q_mac_handler_installed)
    {
        EventTypeSpec t;
        t.eventClass = kEventClassKeyboard;
        t.eventKind = kEventHotKeyPressed;
        InstallApplicationEventHandler(&q_mac_handle_hot_key, 1, &t, nullptr, nullptr);
    }

    EventHotKeyID keyID;
    keyID.signature = 'cute';
    keyID.id = ++hotKeySerial;

    EventHotKeyRef ref = 0;
    bool rv = !RegisterEventHotKey(nativeKey, nativeMods, keyID, GetApplicationEventTarget(), 0, &ref);
    if(rv)
    {
        keyIDs.insert(Identifier(nativeMods, nativeKey), keyID.id);
        keyRefs.insert(keyID.id, ref);
    }

    return rv;
}

bool QGlobalShortcutPrivate::unregisterShortcut(quint32 nativeKey, quint32 nativeMods)
{
    Identifier id(nativeMods, nativeKey);
    if(!keyIDs.contains(id)) return false;

    EventHotKeyRef ref = keyRefs.take(keyIDs[id]);
    keyIDs.remove(id);
    return !UnregisterEventHotKey(ref);
}