Cocoa: QShortcut(Qt::Key_Enter) does not show in the menu bar

The reason is that cocoa expects the unicode control character for
"enter", rather than the glyph showing an arrow. So rather than
using the glyph-table from QKeySequence, we should use a table
containing a mapping from Qt::Key to Cocoa control key. Luckily,
such a table exists allready in qt_cocoa_helpers, but reversed (
cocoa key to Qt::Key). So this patch creates a function that
binds all this together.

Reviewed-by: cduclos

2 files changed, 104 insertions, 71 deletions

diff --git a/src/gui/kernel/qt_cocoa_helpers_mac.mm b/src/gui/kernel/qt_cocoa_helpers_mac.mm
index cbfbf86..e8b5149 100644
--- a/src/gui/kernel/qt_cocoa_helpers_mac.mm
+++ b/src/gui/kernel/qt_cocoa_helpers_mac.mm
@@ -469,7 +469,6 @@ void qt_dispatchTabletProximityEvent(const ::TabletProximityRec &proxRec)
     qt_sendSpontaneousEvent(qApp, &qtabletProximity);
 }
 
-#ifdef QT_MAC_USE_COCOA
 // Use this method to keep all the information in the TextSegment. As long as it is ordered
 // we are in OK shape, and we can influence that ourselves.
 struct KeyPair
@@ -493,69 +492,107 @@ bool operator<(QChar qchar, const KeyPair &entry)
     return qchar < entry.cocoaKey;
 }
 
+bool operator<(const Qt::Key &key, const KeyPair &entry)
+{
+    return key < entry.qtKey;
+}
+
+bool operator<(const KeyPair &entry, const Qt::Key &key)
+{
+    return entry.qtKey < key;
+}
+
+static bool qtKey2CocoaKeySortLessThan(const KeyPair &entry1, const KeyPair &entry2)
+{
+    return entry1.qtKey < entry2.qtKey;
+}
+
+static const int NumEntries = 59;
+static const KeyPair entries[NumEntries] = {
+    { NSEnterCharacter, Qt::Key_Enter },
+    { NSBackspaceCharacter, Qt::Key_Backspace },
+    { NSTabCharacter, Qt::Key_Tab },
+    { NSNewlineCharacter, Qt::Key_Return },
+    { NSCarriageReturnCharacter, Qt::Key_Return },
+    { NSBackTabCharacter, Qt::Key_Backtab },
+    { NSDeleteCharacter, Qt::Key_Delete },
+    { kEscapeCharCode, Qt::Key_Escape },
+    { NSUpArrowFunctionKey, Qt::Key_Up },
+    { NSDownArrowFunctionKey, Qt::Key_Down },
+    { NSLeftArrowFunctionKey, Qt::Key_Left },
+    { NSRightArrowFunctionKey, Qt::Key_Right },
+    { NSF1FunctionKey, Qt::Key_F1 },
+    { NSF2FunctionKey, Qt::Key_F2 },
+    { NSF3FunctionKey, Qt::Key_F3 },
+    { NSF4FunctionKey, Qt::Key_F4 },
+    { NSF5FunctionKey, Qt::Key_F5 },
+    { NSF6FunctionKey, Qt::Key_F6 },
+    { NSF7FunctionKey, Qt::Key_F7 },
+    { NSF8FunctionKey, Qt::Key_F8 },
+    { NSF9FunctionKey, Qt::Key_F8 },
+    { NSF10FunctionKey, Qt::Key_F10 },
+    { NSF11FunctionKey, Qt::Key_F11 },
+    { NSF12FunctionKey, Qt::Key_F12 },
+    { NSF13FunctionKey, Qt::Key_F13 },
+    { NSF14FunctionKey, Qt::Key_F14 },
+    { NSF15FunctionKey, Qt::Key_F15 },
+    { NSF16FunctionKey, Qt::Key_F16 },
+    { NSF17FunctionKey, Qt::Key_F17 },
+    { NSF18FunctionKey, Qt::Key_F18 },
+    { NSF19FunctionKey, Qt::Key_F19 },
+    { NSF20FunctionKey, Qt::Key_F20 },
+    { NSF21FunctionKey, Qt::Key_F21 },
+    { NSF22FunctionKey, Qt::Key_F22 },
+    { NSF23FunctionKey, Qt::Key_F23 },
+    { NSF24FunctionKey, Qt::Key_F24 },
+    { NSF25FunctionKey, Qt::Key_F25 },
+    { NSF26FunctionKey, Qt::Key_F26 },
+    { NSF27FunctionKey, Qt::Key_F27 },
+    { NSF28FunctionKey, Qt::Key_F28 },
+    { NSF29FunctionKey, Qt::Key_F29 },
+    { NSF30FunctionKey, Qt::Key_F30 },
+    { NSF31FunctionKey, Qt::Key_F31 },
+    { NSF32FunctionKey, Qt::Key_F32 },
+    { NSF33FunctionKey, Qt::Key_F33 },
+    { NSF34FunctionKey, Qt::Key_F34 },
+    { NSF35FunctionKey, Qt::Key_F35 },
+    { NSInsertFunctionKey, Qt::Key_Insert },
+    { NSDeleteFunctionKey, Qt::Key_Delete },
+    { NSHomeFunctionKey, Qt::Key_Home },
+    { NSEndFunctionKey, Qt::Key_End },
+    { NSPageUpFunctionKey, Qt::Key_PageUp },
+    { NSPageDownFunctionKey, Qt::Key_PageDown },
+    { NSPrintScreenFunctionKey, Qt::Key_Print },
+    { NSScrollLockFunctionKey, Qt::Key_ScrollLock },
+    { NSPauseFunctionKey, Qt::Key_Pause },
+    { NSSysReqFunctionKey, Qt::Key_SysReq },
+    { NSMenuFunctionKey, Qt::Key_Menu },
+    { NSHelpFunctionKey, Qt::Key_Help },
+};
+static const KeyPair * const end = entries + NumEntries;
+
+QChar qtKey2CocoaKey(Qt::Key key)
+{
+    // The first time this function is called, create a reverse
+    // looup table sorted on Qt Key rather than Cocoa key:
+    static QVector<KeyPair> rev_entries(NumEntries);
+    static bool mustInit = true;
+    if (mustInit){
+        mustInit = false;
+        for (int i=0; i<NumEntries; ++i)
+            rev_entries[i] = entries[i];
+        qSort(rev_entries.begin(), rev_entries.end(), qtKey2CocoaKeySortLessThan);
+    }
+    const QVector<KeyPair>::iterator i
+            = qBinaryFind(rev_entries.begin(), rev_entries.end(), key);
+    if (i == rev_entries.end())
+        return QChar();
+    return i->cocoaKey;
+}
+
+#ifdef QT_MAC_USE_COCOA
 static Qt::Key cocoaKey2QtKey(QChar keyCode)
 {
-    static const int NumEntries = 57;
-    static const KeyPair entries[NumEntries] = {
-        { NSEnterCharacter, Qt::Key_Enter },
-        { NSTabCharacter, Qt::Key_Tab },
-        { NSCarriageReturnCharacter, Qt::Key_Return },
-        { NSBackTabCharacter, Qt::Key_Backtab },
-        { kEscapeCharCode, Qt::Key_Escape },
-        { NSDeleteCharacter, Qt::Key_Backspace },
-        { NSUpArrowFunctionKey, Qt::Key_Up },
-        { NSDownArrowFunctionKey, Qt::Key_Down },
-        { NSLeftArrowFunctionKey, Qt::Key_Left },
-        { NSRightArrowFunctionKey, Qt::Key_Right },
-        { NSF1FunctionKey, Qt::Key_F1 },
-        { NSF2FunctionKey, Qt::Key_F2 },
-        { NSF3FunctionKey, Qt::Key_F3 },
-        { NSF4FunctionKey, Qt::Key_F4 },
-        { NSF5FunctionKey, Qt::Key_F5 },
-        { NSF6FunctionKey, Qt::Key_F6 },
-        { NSF7FunctionKey, Qt::Key_F7 },
-        { NSF8FunctionKey, Qt::Key_F8 },
-        { NSF9FunctionKey, Qt::Key_F8 },
-        { NSF10FunctionKey, Qt::Key_F10 },
-        { NSF11FunctionKey, Qt::Key_F11 },
-        { NSF12FunctionKey, Qt::Key_F12 },
-        { NSF13FunctionKey, Qt::Key_F13 },
-        { NSF14FunctionKey, Qt::Key_F14 },
-        { NSF15FunctionKey, Qt::Key_F15 },
-        { NSF16FunctionKey, Qt::Key_F16 },
-        { NSF17FunctionKey, Qt::Key_F17 },
-        { NSF18FunctionKey, Qt::Key_F18 },
-        { NSF19FunctionKey, Qt::Key_F19 },
-        { NSF20FunctionKey, Qt::Key_F20 },
-        { NSF21FunctionKey, Qt::Key_F21 },
-        { NSF22FunctionKey, Qt::Key_F22 },
-        { NSF23FunctionKey, Qt::Key_F23 },
-        { NSF24FunctionKey, Qt::Key_F24 },
-        { NSF25FunctionKey, Qt::Key_F25 },
-        { NSF26FunctionKey, Qt::Key_F26 },
-        { NSF27FunctionKey, Qt::Key_F27 },
-        { NSF28FunctionKey, Qt::Key_F28 },
-        { NSF29FunctionKey, Qt::Key_F29 },
-        { NSF30FunctionKey, Qt::Key_F30 },
-        { NSF31FunctionKey, Qt::Key_F31 },
-        { NSF32FunctionKey, Qt::Key_F32 },
-        { NSF33FunctionKey, Qt::Key_F33 },
-        { NSF34FunctionKey, Qt::Key_F34 },
-        { NSF35FunctionKey, Qt::Key_F35 },
-        { NSInsertFunctionKey, Qt::Key_Insert },
-        { NSDeleteFunctionKey, Qt::Key_Delete },
-        { NSHomeFunctionKey, Qt::Key_Home },
-        { NSEndFunctionKey, Qt::Key_End },
-        { NSPageUpFunctionKey, Qt::Key_PageUp },
-        { NSPageDownFunctionKey, Qt::Key_PageDown },
-        { NSPrintScreenFunctionKey, Qt::Key_Print },
-        { NSScrollLockFunctionKey, Qt::Key_ScrollLock },
-        { NSPauseFunctionKey, Qt::Key_Pause },
-        { NSSysReqFunctionKey, Qt::Key_SysReq },
-        { NSMenuFunctionKey, Qt::Key_Menu },
-        { NSHelpFunctionKey, Qt::Key_Help },
-    };
-    static const KeyPair * const end = entries + NumEntries;
     const KeyPair *i = qBinaryFind(entries, end, keyCode);
     if (i == end)
         return Qt::Key(keyCode.unicode());
diff --git a/src/gui/widgets/qmenu_mac.mm b/src/gui/widgets/qmenu_mac.mm
index 8016da9..60023a8 100644
--- a/src/gui/widgets/qmenu_mac.mm
+++ b/src/gui/widgets/qmenu_mac.mm
@@ -1254,15 +1254,11 @@ QMenuPrivate::QMacMenuPrivate::addAction(QMacMenuAction *action, QMacMenuAction
 NSString *keySequenceToKeyEqivalent(const QKeySequence &accel)
 {
     quint32 accel_key = (accel[0] & ~(Qt::MODIFIER_MASK | Qt::UNICODE_ACCEL));
-    extern QChar qt_macSymbolForQtKey(int key); // qkeysequence.cpp
-    QChar keyEquiv = qt_macSymbolForQtKey(accel_key);
-    if (keyEquiv.isNull()) {
-        if (accel_key >= Qt::Key_F1 && accel_key <= Qt::Key_F15)
-            keyEquiv = (accel_key - Qt::Key_F1) + NSF1FunctionKey;
-        else
-            keyEquiv = unichar(QChar(accel_key).toLower().unicode());
-    }
-    return [NSString stringWithCharacters:&keyEquiv.unicode() length:1];
+    extern QChar qtKey2CocoaKey(Qt::Key key);
+    QChar cocoa_key = qtKey2CocoaKey(Qt::Key(accel_key));
+    if (cocoa_key.isNull())
+        cocoa_key = QChar(accel_key).toLower().unicode();
+    return [NSString stringWithCharacters:&cocoa_key.unicode() length:1];
 }
 
 // return the cocoa modifier mask for the QKeySequence (currently only looks at the first one).