/****************************************************************************

**

** Copyright (C) 2010 Nokia Corporation and/or its subsidiary(-ies).

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtGui module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, 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.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

#include "qmenu.h"

#ifndef QT_NO_MENU

#include "qdebug.h"

#include "qstyle.h"

#include "qevent.h"

#include "qtimer.h"

#include "qlayout.h"

#include "qpainter.h"

#include "qapplication.h"

#include "qdesktopwidget.h"

#ifndef QT_NO_ACCESSIBILITY

# include "qaccessible.h"

#endif

#ifndef QT_NO_EFFECTS

# include <private/qeffects_p.h>

#endif

#ifndef QT_NO_WHATSTHIS

# include <qwhatsthis.h>

#endif

#include "qmenu_p.h"

#include "qmenubar_p.h"

#include "qwidgetaction.h"

#include "qtoolbutton.h"

#include "qpushbutton.h"

#include <private/qpushbutton_p.h>

#include <private/qaction_p.h>

#include <private/qsoftkeymanager_p.h>

#ifdef QT3_SUPPORT

#include <qmenudata.h>

#endif // QT3_SUPPORT

#ifdef Q_WS_X11

#   include <private/qt_x11_p.h>

#endif

#if defined(Q_WS_MAC) && !defined(QT_NO_EFFECTS)

#   include <private/qcore_mac_p.h>

#   include <private/qt_cocoa_helpers_mac_p.h>

#endif

QT_BEGIN_NAMESPACE

/* QMenu code */

// internal class used for the torn off popup

class QTornOffMenu : public QMenu

{

    Q_OBJECT

    class QTornOffMenuPrivate : public QMenuPrivate

    {

        Q_DECLARE_PUBLIC(QMenu)

    public:

        QTornOffMenuPrivate(QMenu *p) : causedMenu(p) {

            tornoff = 1;

            causedPopup.widget = 0;

            causedPopup.action = ((QTornOffMenu*)p)->d_func()->causedPopup.action;

            causedStack = ((QTornOffMenu*)p)->d_func()->calcCausedStack();

        }

        QList<QPointer<QWidget> > calcCausedStack() const { return causedStack; }

        QPointer<QMenu> causedMenu;

        QList<QPointer<QWidget> > causedStack;

    };

public:

    QTornOffMenu(QMenu *p) : QMenu(*(new QTornOffMenuPrivate(p)))

    {

        Q_D(QTornOffMenu);

        // make the torn-off menu a sibling of p (instead of a child)

        QWidget *parentWidget = d->causedStack.isEmpty() ? p : d->causedStack.last();

        if (parentWidget->parentWidget())

            parentWidget = parentWidget->parentWidget();

        setParent(parentWidget, Qt::Window | Qt::Tool);

        setAttribute(Qt::WA_DeleteOnClose, true);

        setAttribute(Qt::WA_X11NetWmWindowTypeMenu, true);

        setWindowTitle(p->windowTitle());

        setEnabled(p->isEnabled());

        //QObject::connect(this, SIGNAL(triggered(QAction*)), this, SLOT(onTrigger(QAction*)));

        //QObject::connect(this, SIGNAL(hovered(QAction*)), this, SLOT(onHovered(QAction*)));

        QList<QAction*> items = p->actions();

        for(int i = 0; i < items.count(); i++)

            addAction(items.at(i));

    }

    void syncWithMenu(QMenu *menu, QActionEvent *act)

    {

        Q_D(QTornOffMenu);

        if(menu != d->causedMenu)

            return;

        if (act->type() == QEvent::ActionAdded) {

            insertAction(act->before(), act->action());

        } else if (act->type() == QEvent::ActionRemoved)

            removeAction(act->action());

    }

    void actionEvent(QActionEvent *e)

    {

        QMenu::actionEvent(e);

        setFixedSize(sizeHint());

    }

public slots:

    void onTrigger(QAction *action) { d_func()->activateAction(action, QAction::Trigger, false); }

    void onHovered(QAction *action) { d_func()->activateAction(action, QAction::Hover, false); }

private:

    Q_DECLARE_PRIVATE(QTornOffMenu)

    friend class QMenuPrivate;

};

void QMenuPrivate::init()

{

    Q_Q(QMenu);

#ifndef QT_NO_WHATSTHIS

    q->setAttribute(Qt::WA_CustomWhatsThis);

#endif

    q->setAttribute(Qt::WA_X11NetWmWindowTypePopupMenu);

    defaultMenuAction = menuAction = new QAction(q);

    menuAction->d_func()->menu = q;

    q->setMouseTracking(q->style()->styleHint(QStyle::SH_Menu_MouseTracking, 0, q));

    if (q->style()->styleHint(QStyle::SH_Menu_Scrollable, 0, q)) {

        scroll = new QMenuPrivate::QMenuScroller;

        scroll->scrollFlags = QMenuPrivate::QMenuScroller::ScrollNone;

    }

#ifdef QT_SOFTKEYS_ENABLED

    selectAction = QSoftKeyManager::createKeyedAction(QSoftKeyManager::SelectSoftKey, Qt::Key_Select, q);

    cancelAction = QSoftKeyManager::createKeyedAction(QSoftKeyManager::CancelSoftKey, Qt::Key_Back, q);

    selectAction->setPriority(QAction::HighPriority);

    cancelAction->setPriority(QAction::HighPriority);

    q->addAction(selectAction);

    q->addAction(cancelAction);

#endif

}

int QMenuPrivate::scrollerHeight() const

{

    Q_Q(const QMenu);

    return qMax(QApplication::globalStrut().height(), q->style()->pixelMetric(QStyle::PM_MenuScrollerHeight, 0, q));

}

//Windows and KDE allows menus to cover the taskbar, while GNOME and Mac don't

QRect QMenuPrivate::popupGeometry(const QWidget *widget) const

{

#ifdef Q_WS_WIN

    return QApplication::desktop()->screenGeometry(widget);

#elif defined Q_WS_X11

    if (X11->desktopEnvironment == DE_KDE)

        return QApplication::desktop()->screenGeometry(widget);

    else

        return QApplication::desktop()->availableGeometry(widget);

#else

        return QApplication::desktop()->availableGeometry(widget);

#endif

}

//Windows and KDE allows menus to cover the taskbar, while GNOME and Mac don't

QRect QMenuPrivate::popupGeometry(int screen) const

{

#ifdef Q_WS_WIN

    return QApplication::desktop()->screenGeometry(screen);

#elif defined Q_WS_X11

    if (X11->desktopEnvironment == DE_KDE)

        return QApplication::desktop()->screenGeometry(screen);

    else

        return QApplication::desktop()->availableGeometry(screen);

#else

        return QApplication::desktop()->availableGeometry(screen);

#endif

}

QList<QPointer<QWidget> > QMenuPrivate::calcCausedStack() const

{

    QList<QPointer<QWidget> > ret;

    for(QWidget *widget = causedPopup.widget; widget; ) {

        ret.append(widget);

        if (QTornOffMenu *qtmenu = qobject_cast<QTornOffMenu*>(widget))

            ret += qtmenu->d_func()->causedStack;

        if (QMenu *qmenu = qobject_cast<QMenu*>(widget))

            widget = qmenu->d_func()->causedPopup.widget;

        else

            break;

    }

    return ret;

}

void QMenuPrivate::updateActionRects() const

{

    Q_Q(const QMenu);

    if (!itemsDirty)

        return;

    q->ensurePolished();

    //let's reinitialize the buffer

    actionRects.resize(actions.count());

    actionRects.fill(QRect());

    //let's try to get the last visible action

    int lastVisibleAction = actions.count() - 1;

    for(;lastVisibleAction >= 0; --lastVisibleAction) {

        const QAction *action = actions.at(lastVisibleAction);

        if (action->isVisible()) {

            //removing trailing separators

            if (action->isSeparator() && collapsibleSeparators)

                continue;

            break;

        }

    }

    int max_column_width = 0,

        dh = popupGeometry(q).height(),

        y = 0;

    QStyle *style = q->style();

    QStyleOption opt;

    opt.init(q);

    const int hmargin = style->pixelMetric(QStyle::PM_MenuHMargin, &opt, q),

              vmargin = style->pixelMetric(QStyle::PM_MenuVMargin, &opt, q),

              icone = style->pixelMetric(QStyle::PM_SmallIconSize, &opt, q);

    const int fw = style->pixelMetric(QStyle::PM_MenuPanelWidth, &opt, q);

    const int deskFw = style->pixelMetric(QStyle::PM_MenuDesktopFrameWidth, &opt, q);

    const int tearoffHeight = tearoff ? style->pixelMetric(QStyle::PM_MenuTearoffHeight, &opt, q) : 0;

    //for compatability now - will have to refactor this away..

    tabWidth = 0;

    maxIconWidth = 0;

    hasCheckableItems = false;

    ncols = 1;

    sloppyAction = 0;

    for (int i = 0; i < actions.count(); ++i) {

        QAction *action = actions.at(i);

        if (action->isSeparator() || !action->isVisible() || widgetItems.contains(action))

            continue;

        //..and some members

        hasCheckableItems |= action->isCheckable();

        QIcon is = action->icon();

        if (!is.isNull()) {

            maxIconWidth = qMax<uint>(maxIconWidth, icone + 4);

        }

    }

    //calculate size

    QFontMetrics qfm = q->fontMetrics();

    bool previousWasSeparator = true; // this is true to allow removing the leading separators

    for(int i = 0; i <= lastVisibleAction; i++) {

        QAction *action = actions.at(i);

        if (!action->isVisible() ||

            (collapsibleSeparators && previousWasSeparator && action->isSeparator()))

            continue; // we continue, this action will get an empty QRect

        previousWasSeparator = action->isSeparator();

        //let the style modify the above size..

        QStyleOptionMenuItem opt;

        q->initStyleOption(&opt, action);

        const QFontMetrics &fm = opt.fontMetrics;

        QSize sz;

        if (QWidget *w = widgetItems.value(action)) {

          sz = w->sizeHint().expandedTo(w->minimumSize()).expandedTo(w->minimumSizeHint()).boundedTo(w->maximumSize());

        } else {

            //calc what I think the size is..

            if (action->isSeparator()) {

                sz = QSize(2, 2);

            } else {

                QString s = action->text();

                int t = s.indexOf(QLatin1Char('\t'));

                if (t != -1) {

                    tabWidth = qMax(int(tabWidth), qfm.width(s.mid(t+1)));

                    s = s.left(t);

    #ifndef QT_NO_SHORTCUT

                } else {

                    QKeySequence seq = action->shortcut();

                    if (!seq.isEmpty())

                        tabWidth = qMax(int(tabWidth), qfm.width(seq));

    #endif

                }

                sz.setWidth(fm.boundingRect(QRect(), Qt::TextSingleLine | Qt::TextShowMnemonic, s).width());

                sz.setHeight(qMax(fm.height(), qfm.height()));

                QIcon is = action->icon();

                if (!is.isNull()) {

                    QSize is_sz = QSize(icone, icone);

                    if (is_sz.height() > sz.height())

                        sz.setHeight(is_sz.height());

                }

            }

            sz = style->sizeFromContents(QStyle::CT_MenuItem, &opt, sz, q);

        }

        if (!sz.isEmpty()) {

            max_column_width = qMax(max_column_width, sz.width());

            //wrapping

            if (!scroll &&

               y+sz.height()+vmargin > dh - (deskFw * 2)) {

                ncols++;

                y = vmargin;

            }

            y += sz.height();

            //update the item

            actionRects[i] = QRect(0, 0, sz.width(), sz.height());

        }

    }

    max_column_width += tabWidth; //finally add in the tab width

    const int sfcMargin = style->sizeFromContents(QStyle::CT_Menu, &opt, QApplication::globalStrut(), q).width() - QApplication::globalStrut().width();

    const int min_column_width = q->minimumWidth() - (sfcMargin + leftmargin + rightmargin + 2 * (fw + hmargin));

    max_column_width = qMax(min_column_width, max_column_width);

    //calculate position

    const int base_y = vmargin + fw + topmargin +

        (scroll ? scroll->scrollOffset : 0) +

        tearoffHeight;

    int x = hmargin + fw + leftmargin;

    y = base_y;

    for(int i = 0; i < actions.count(); i++) {

        QRect &rect = actionRects[i];

        if (rect.isNull())

            continue;

        if (!scroll &&

           y+rect.height() > dh - deskFw * 2) {

            x += max_column_width + hmargin;

            y = base_y;

        }

        rect.translate(x, y);                        //move

        rect.setWidth(max_column_width); //uniform width

        //we need to update the widgets geometry

        if (QWidget *widget = widgetItems.value(actions.at(i))) {

            widget->setGeometry(rect);

            widget->setVisible(actions.at(i)->isVisible());

        }

        y += rect.height();

    }

    itemsDirty = 0;

}

QRect QMenuPrivate::actionRect(QAction *act) const

{

    int index = actions.indexOf(act);

    if (index == -1)

        return QRect();

    updateActionRects();

    //we found the action

    return actionRects.at(index);

}

#if defined(Q_WS_MAC)

static const qreal MenuFadeTimeInSec = 0.150;

#endif

void QMenuPrivate::hideUpToMenuBar()

{

    Q_Q(QMenu);

    bool fadeMenus = q->style()->styleHint(QStyle::SH_Menu_FadeOutOnHide);

    if (!tornoff) {

        QWidget *caused = causedPopup.widget;

        hideMenu(q); //hide after getting causedPopup

        while(caused) {

#ifndef QT_NO_MENUBAR

            if (QMenuBar *mb = qobject_cast<QMenuBar*>(caused)) {

                mb->d_func()->setCurrentAction(0);

                mb->d_func()->setKeyboardMode(false);

                caused = 0;

            } else

#endif

            if (QMenu *m = qobject_cast<QMenu*>(caused)) {

                caused = m->d_func()->causedPopup.widget;

                if (!m->d_func()->tornoff)

                    hideMenu(m, fadeMenus);

                if (!fadeMenus) // Mac doesn't clear the action until after hidden.

                    m->d_func()->setCurrentAction(0);

            } else {                caused = 0;

            }

        }

#if defined(Q_WS_MAC)

        if (fadeMenus) {

            QEventLoop eventLoop;

            QTimer::singleShot(int(MenuFadeTimeInSec * 1000), &eventLoop, SLOT(quit()));

            QMacWindowFader::currentFader()->performFade();

            eventLoop.exec();

        }

#endif

    }

    setCurrentAction(0);

}

void QMenuPrivate::hideMenu(QMenu *menu, bool justRegister)

{

    if (!menu)

        return;

#if !defined(QT_NO_EFFECTS)

    menu->blockSignals(true);

    aboutToHide = true;

    // Flash item which is about to trigger (if any).

    if (menu->style()->styleHint(QStyle::SH_Menu_FlashTriggeredItem)

        && currentAction && currentAction == actionAboutToTrigger

        && menu->actions().contains(currentAction)) {

        QEventLoop eventLoop;

        QAction *activeAction = currentAction;

        menu->setActiveAction(0);

        QTimer::singleShot(60, &eventLoop, SLOT(quit()));

        eventLoop.exec();

        // Select and wait 20 ms.

        menu->setActiveAction(activeAction);

        QTimer::singleShot(20, &eventLoop, SLOT(quit()));

        eventLoop.exec();

    }

    // Fade out.

    if (menu->style()->styleHint(QStyle::SH_Menu_FadeOutOnHide)) {

        // ### Qt 4.4:

        // Should be something like: q->transitionWindow(Qt::FadeOutTransition, MenuFadeTimeInSec);

        // Hopefully we'll integrate qt/research/windowtransitions into main before 4.4.

        // Talk to Richard, Trenton or Bjoern.

#if defined(Q_WS_MAC)

        if (justRegister) {

            QMacWindowFader::currentFader()->setFadeDuration(MenuFadeTimeInSec);

            QMacWindowFader::currentFader()->registerWindowToFade(menu);

        } else {

            macWindowFade(qt_mac_window_for(menu), MenuFadeTimeInSec);

        }

#endif // Q_WS_MAC

    }

    aboutToHide = false;

    menu->blockSignals(false);

#endif // QT_NO_EFFECTS

    if (!justRegister)

        menu->hide();

}

void QMenuPrivate::popupAction(QAction *action, int delay, bool activateFirst)

{

    Q_Q(QMenu);

    if (action && action->isEnabled()) {

        if (!delay)

            q->internalDelayedPopup();

        if (activateFirst && action->menu())

            action->menu()->d_func()->setFirstActionActive();

    } else if (QMenu *menu = activeMenu) {  //hide the current item

        activeMenu = 0;

        hideMenu(menu);

    }

}

void QMenuPrivate::setSyncAction()

{

    Q_Q(QMenu);

    QAction *current = currentAction;

    if(current && (!current->isEnabled() || current->menu() || current->isSeparator()))

        current = 0;

    for(QWidget *caused = q; caused;) {

        if (QMenu *m = qobject_cast<QMenu*>(caused)) {

            caused = m->d_func()->causedPopup.widget;

            if (m->d_func()->eventLoop)

                m->d_func()->syncAction = current; // synchronous operation

        } else {

            break;

        }

    }

}

void QMenuPrivate::setFirstActionActive()

{

    Q_Q(QMenu);

    updateActionRects();

    for(int i = 0, saccum = 0; i < actions.count(); i++) {

        const QRect &rect = actionRects.at(i);

        if (rect.isNull())

            continue;