Cocoa implementation of QPA menu interface.

Implement the QPA platform menu interface for Cocoa,
including native menubar support and merging with the
predefined menus created from the bundled .nib. Cleanup
code previously used to maintain the menus, and add
a manual test of the menus code.

Change-Id: Ia99267ddb6485e18e05c540eb32c5aee6cbb85db
Reviewed-by: Morten Johan Sørvig <morten.sorvig@nokia.com>

1 files changed, 254 insertions, 0 deletions

diff --git a/src/plugins/platforms/cocoa/qcocoamenubar.mm b/src/plugins/platforms/cocoa/qcocoamenubar.mm
new file mode 100644
index 0000000000..fc403ba504
--- /dev/null
+++ b/src/plugins/platforms/cocoa/qcocoamenubar.mm
@@ -0,0 +1,254 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Klarälvdalens Datakonsult AB, a KDAB Group company, info@kdab.com, author James Turner <james.turner@kdab.com>
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the plugins of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include <Cocoa/Cocoa.h>
+
+#include "qcocoamenubar.h"
+#include "qcocoawindow.h"
+#include "qcocoamenuloader.h"
+#include "qcocoaapplication.h" // for custom application category
+#include "qcocoaautoreleasepool.h"
+
+#include <QtGui/QGuiApplication>
+#include <QtCore/QDebug>
+
+static QList<QCocoaMenuBar*> static_menubars;
+
+static inline QT_MANGLE_NAMESPACE(QCocoaMenuLoader) *getMenuLoader()
+{
+    return [NSApp QT_MANGLE_NAMESPACE(qt_qcocoamenuLoader)];
+}
+
+
+QCocoaMenuBar::QCocoaMenuBar() :
+    m_window(0)
+{
+    static_menubars.append(this);
+
+    m_nativeMenu = [[NSMenu alloc] init];
+#ifdef QT_COCOA_ENABLE_MENU_DEBUG
+    qDebug() << "Construct QCocoaMenuBar" << this << m_nativeMenu;
+#endif
+}
+
+QCocoaMenuBar::~QCocoaMenuBar()
+{
+#ifdef QT_COCOA_ENABLE_MENU_DEBUG
+    qDebug() << "~QCocoaMenuBar" << this;
+#endif
+    [m_nativeMenu release];
+    static_menubars.removeOne(this);
+
+    if (m_window)
+        m_window->setMenubar(0);
+}
+
+void QCocoaMenuBar::insertMenu(QPlatformMenu *platformMenu, QPlatformMenu *before)
+{
+    QCocoaMenu *menu = static_cast<QCocoaMenu *>(platformMenu);
+    QCocoaMenu *beforeMenu = static_cast<QCocoaMenu *>(before);
+#ifdef QT_COCOA_ENABLE_MENU_DEBUG
+    qDebug() << "QCocoaMenuBar" << this << "insertMenu" << menu << "before" << before;
+#endif
+
+    Q_ASSERT(!m_menus.contains(menu));
+    if (beforeMenu) {
+        Q_ASSERT(m_menus.contains(beforeMenu));
+        m_menus.insert(m_menus.indexOf(beforeMenu), menu);
+        NSUInteger nativeIndex = [m_nativeMenu indexOfItem:beforeMenu->nsMenuItem()];
+        [m_nativeMenu insertItem: menu->nsMenuItem() atIndex: nativeIndex];
+    } else {
+        m_menus.append(menu);
+        [m_nativeMenu addItem: menu->nsMenuItem()];
+    }
+
+    [m_nativeMenu setSubmenu: menu->nsMenu() forItem: menu->nsMenuItem()];
+}
+
+void QCocoaMenuBar::removeMenu(QPlatformMenu *platformMenu)
+{
+    QCocoaMenu *menu = static_cast<QCocoaMenu *>(platformMenu);
+    Q_ASSERT(m_menus.contains(menu));
+    m_menus.removeOne(menu);
+
+    NSUInteger realIndex = [m_nativeMenu indexOfItem:menu->nsMenuItem()];
+    [m_nativeMenu removeItemAtIndex: realIndex];
+}
+
+void QCocoaMenuBar::syncMenu(QPlatformMenuItem *menuItem)
+{
+    Q_UNUSED(menuItem);
+}
+
+void QCocoaMenuBar::handleReparent(QWindow *newParentWindow)
+{
+#ifdef QT_COCOA_ENABLE_MENU_DEBUG
+    qDebug() << "QCocoaMenuBar" << this << "handleReparent" << newParentWindow;
+#endif
+
+    if (m_window)
+        m_window->setMenubar(NULL);
+
+    if (newParentWindow == NULL) {
+        m_window = NULL;
+    } else {
+        m_window = static_cast<QCocoaWindow*>(newParentWindow->handle());
+        m_window->setMenubar(this);
+    }
+
+    updateMenuBarImmediately();
+}
+
+QCocoaWindow *QCocoaMenuBar::findWindowForMenubar()
+{
+    if (qApp->focusWindow())
+        return static_cast<QCocoaWindow*>(qApp->focusWindow()->handle());
+
+    return NULL;
+}
+
+QCocoaMenuBar *QCocoaMenuBar::findGlobalMenubar()
+{
+    foreach (QCocoaMenuBar *mb, static_menubars) {
+        if (mb->m_window == NULL)
+            return mb;
+    }
+
+    return NULL;
+}
+
+void QCocoaMenuBar::updateMenuBarImmediately()
+{
+    QCocoaAutoReleasePool pool;
+    QCocoaMenuBar *mb = findGlobalMenubar();
+    QCocoaWindow *cw = findWindowForMenubar();
+    if (cw && cw->menubar())
+        mb = cw->menubar();
+
+    if (!mb)
+        return;
+
+#ifdef QT_COCOA_ENABLE_MENU_DEBUG
+    qDebug() << "QCocoaMenuBar" << "updateMenuBarImmediately" << cw;
+#endif
+    bool disableForModal = mb->shouldDisable(cw);
+    // force a sync?
+    foreach (QCocoaMenu *m, mb->m_menus) {
+        mb->syncMenu(m);
+        m->syncModalState(disableForModal);
+    }
+
+    QT_MANGLE_NAMESPACE(QCocoaMenuLoader) *loader = getMenuLoader();
+    [loader ensureAppMenuInMenu:mb->nsMenu()];
+
+    NSMutableSet *mergedItems = [[NSMutableSet setWithCapacity:0] retain];
+    foreach (QCocoaMenuItem *m, mb->merged()) {
+        [mergedItems addObject:m->nsItem()];
+        m->syncMerged();
+    }
+
+    // hide+disable all mergeable items we're not currently using
+    for (NSMenuItem *mergeable in [loader mergeable]) {
+        if (![mergedItems containsObject:mergeable]) {
+            [mergeable setHidden:YES];
+            [mergeable setEnabled:NO];
+        }
+    }
+
+    [mergedItems release];
+    [NSApp setMainMenu:mb->nsMenu()];
+    [loader qtTranslateApplicationMenu];
+}
+
+QList<QCocoaMenuItem*> QCocoaMenuBar::merged() const
+{
+    QList<QCocoaMenuItem*> r;
+    foreach (QCocoaMenu* menu, m_menus)
+        r.append(menu->merged());
+
+    return r;
+}
+
+bool QCocoaMenuBar::shouldDisable(QCocoaWindow *active) const
+{
+    if (active && (active->window()->windowModality() == Qt::NonModal))
+        return false;
+
+    if (m_window == active) {
+        // modal window owns us, we should be enabled!
+        return false;
+    }
+
+    QWindowList topWindows(qApp->topLevelWindows());
+    // When there is an application modal window on screen, the entries of
+    // the menubar should be disabled. The exception in Qt is that if the
+    // modal window is the only window on screen, then we enable the menu bar.
+    foreach (QWindow *w, topWindows) {
+        if (w->isVisible() && w->windowModality() == Qt::ApplicationModal) {
+            // check for other visible windows
+            foreach (QWindow *other, topWindows) {
+                if ((w != other) && (other->isVisible())) {
+                    // INVARIANT: we found another visible window
+                    // on screen other than our modalWidget. We therefore
+                    // disable the menu bar to follow normal modality logic:
+                    return true;
+                }
+            }
+
+            // INVARIANT: We have only one window on screen that happends
+            // to be application modal. We choose to enable the menu bar
+            // in that case to e.g. enable the quit menu item.
+            return false;
+        }
+    }
+
+    return true;
+}
+
+QPlatformMenu *QCocoaMenuBar::menuForTag(quintptr tag) const
+{
+    foreach (QCocoaMenu *menu, m_menus) {
+        if (menu->tag() ==  tag)
+            return menu;
+    }
+
+    return 0;
+}