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

**

** Copyright (C) 2009 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 "qshortcutmap_p.h"

#include "private/qobject_p.h"

#include "qkeysequence.h"

#include "qgraphicsscene.h"

#include "qgraphicsview.h"

#include "qdebug.h"

#include "qevent.h"

#include "qwidget.h"

#include "qapplication.h"

#include "qvector.h"

#include "qmenu.h"

#include "qmenubar.h"

#include "qshortcut.h"

#include "qapplication_p.h"

#include <private/qaction_p.h>

#include <private/qkeymapper_p.h>

#include <private/qwidget_p.h>

#ifndef QT_NO_SHORTCUT

QT_BEGIN_NAMESPACE

// To enable verbose output uncomment below

//#define DEBUG_QSHORTCUTMAP

/* \internal

    Entry data for QShortcutMap

    Contains:

        Keysequence for entry

        Pointer to parent owning the sequence

*/

struct QShortcutEntry

{

    QShortcutEntry()

        : keyseq(0), context(Qt::WindowShortcut), enabled(false), autorepeat(1), id(0), owner(0)

    {}

    QShortcutEntry(const QKeySequence &k)

        : keyseq(k), context(Qt::WindowShortcut), enabled(false), autorepeat(1), id(0), owner(0)

    {}

    QShortcutEntry(QObject *o, const QKeySequence &k, Qt::ShortcutContext c, int i)

        : keyseq(k), context(c), enabled(true), autorepeat(1), id(i), owner(o)

    {}

    QShortcutEntry(QObject *o, const QKeySequence &k, Qt::ShortcutContext c, int i, bool a)

        : keyseq(k), context(c), enabled(true), autorepeat(a), id(i), owner(o)

    {}

    bool operator<(const QShortcutEntry &f) const

    { return keyseq < f.keyseq; }

    QKeySequence keyseq;

    Qt::ShortcutContext context;

    bool enabled : 1;

    bool autorepeat : 1;

    signed int id;

    QObject *owner;

};

#if 0 //ndef QT_NO_DEBUG_STREAM

/*! \internal

    QDebug operator<< for easy debug output of the shortcut entries.

*/

static QDebug &operator<<(QDebug &dbg, const QShortcutEntry *se) {

    if (!se)

        return dbg << "QShortcutEntry(0x0)";

    dbg.nospace()

        << "QShortcutEntry(" << se->keyseq

        << "), id(" << se->id << "), enabled(" << se->enabled << "), autorepeat(" << se->autorepeat

        << "), owner(" << se->owner << ')';

    return dbg.space();

}

#endif // QT_NO_DEBUGSTREAM

/* \internal

    Private data for QShortcutMap

*/

class QShortcutMapPrivate

{

    Q_DECLARE_PUBLIC(QShortcutMap)

public:

    QShortcutMapPrivate(QShortcutMap* parent)

        : q_ptr(parent), currentId(0), ambigCount(0), currentState(QKeySequence::NoMatch)

    {

        identicals.reserve(10);

        currentSequences.reserve(10);

    }

    QShortcutMap *q_ptr;                        // Private's parent

    QList<QShortcutEntry> sequences;            // All sequences!

    int currentId;                              // Global shortcut ID number

    int ambigCount;                             // Index of last enabled ambiguous dispatch

    QKeySequence::SequenceMatch currentState;

    QVector<QKeySequence> currentSequences;     // Sequence for the current state

    QVector<QKeySequence> newEntries;

    QKeySequence prevSequence;                  // Sequence for the previous identical match

    QVector<const QShortcutEntry*> identicals;  // Last identical matches

};

/*! \internal

    QShortcutMap constructor.

*/

QShortcutMap::QShortcutMap()

    : d_ptr(new QShortcutMapPrivate(this))

{

    resetState();

}

/*! \internal

    QShortcutMap destructor.

*/

QShortcutMap::~QShortcutMap()

{

}

/*! \internal

    Adds a shortcut to the global map.

    Returns the id of the newly added shortcut.

*/

int QShortcutMap::addShortcut(QObject *owner, const QKeySequence &key, Qt::ShortcutContext context)

{

    Q_ASSERT_X(owner, "QShortcutMap::addShortcut", "All shortcuts need an owner");

    Q_ASSERT_X(!key.isEmpty(), "QShortcutMap::addShortcut", "Cannot add keyless shortcuts to map");

    Q_D(QShortcutMap);

    QShortcutEntry newEntry(owner, key, context, --(d->currentId), true);

    QList<QShortcutEntry>::iterator it = qUpperBound(d->sequences.begin(), d->sequences.end(), newEntry);

    d->sequences.insert(it, newEntry); // Insert sorted

#if defined(DEBUG_QSHORTCUTMAP)

    qDebug().nospace()

        << "QShortcutMap::addShortcut(" << owner << ", "

        << key << ", " << context << ") = " << d->currentId;

#endif

    return d->currentId;

}

/*! \internal

    Removes a shortcut from the global map.

    If \a owner is 0, all entries in the map with the key sequence specified

    is removed. If \a key is null, all sequences for \a owner is removed from

    the map. If \a id is 0, any identical \a key sequences owned by \a owner

    are removed.

    Returns the number of sequences removed from the map.

*/

int QShortcutMap::removeShortcut(int id, QObject *owner, const QKeySequence &key)

{

    Q_D(QShortcutMap);

    int itemsRemoved = 0;

    bool allOwners = (owner == 0);

    bool allKeys = key.isEmpty();

    bool allIds = id == 0;

    // Special case, remove everything

    if (allOwners && allKeys && id == 0) {

        itemsRemoved = d->sequences.size();

        d->sequences.clear();

        return itemsRemoved;

    }

    int i = d->sequences.size()-1;

    while (i>=0)

    {

        const QShortcutEntry &entry = d->sequences.at(i);

        int entryId = entry.id;

        if ((allOwners || entry.owner == owner)

            && (allIds || entry.id == id)

            && (allKeys || entry.keyseq == key)) {

            d->sequences.removeAt(i);

            ++itemsRemoved;

        }

        if (id == entryId)

            return itemsRemoved;

        --i;

    }

#if defined(DEBUG_QSHORTCUTMAP)

    qDebug().nospace()

        << "QShortcutMap::removeShortcut(" << id << ", " << owner << ", "

        << key << ") = " << itemsRemoved;

#endif

    return itemsRemoved;

}

/*! \internal

    Changes the enable state of a shortcut to \a enable.

    If \a owner is 0, all entries in the map with the key sequence specified

    is removed. If \a key is null, all sequences for \a owner is removed from

    the map. If \a id is 0, any identical \a key sequences owned by \a owner

    are changed.

    Returns the number of sequences which are matched in the map.

*/

int QShortcutMap::setShortcutEnabled(bool enable, int id, QObject *owner, const QKeySequence &key)

{

    Q_D(QShortcutMap);

    int itemsChanged = 0;

    bool allOwners = (owner == 0);

    bool allKeys = key.isEmpty();

    bool allIds = id == 0;

    int i = d->sequences.size()-1;

    while (i>=0)

    {

        QShortcutEntry entry = d->sequences.at(i);

        if ((allOwners || entry.owner == owner)

            && (allIds || entry.id == id)

            && (allKeys || entry.keyseq == key)) {

            d->sequences[i].enabled = enable;

            ++itemsChanged;

        }

        if (id == entry.id)

            return itemsChanged;

        --i;

    }

#if defined(DEBUG_QSHORTCUTMAP)

    qDebug().nospace()

        << "QShortcutMap::setShortcutEnabled(" << enable << ", " << id << ", "

        << owner << ", " << key << ") = " << itemsChanged;

#endif

    return itemsChanged;

}

/*! \internal

    Changes the auto repeat state of a shortcut to \a enable.

    If \a owner is 0, all entries in the map with the key sequence specified

    is removed. If \a key is null, all sequences for \a owner is removed from

    the map. If \a id is 0, any identical \a key sequences owned by \a owner

    are changed.

    Returns the number of sequences which are matched in the map.

*/

int QShortcutMap::setShortcutAutoRepeat(bool on, int id, QObject *owner, const QKeySequence &key)

{

    Q_D(QShortcutMap);

    int itemsChanged = 0;

    bool allOwners = (owner == 0);

    bool allKeys = key.isEmpty();

    bool allIds = id == 0;

    int i = d->sequences.size()-1;

    while (i>=0)

    {

        QShortcutEntry entry = d->sequences.at(i);

        if ((allOwners || entry.owner == owner)

            && (allIds || entry.id == id)

            && (allKeys || entry.keyseq == key)) {

                d->sequences[i].autorepeat = on;

                ++itemsChanged;

        }

        if (id == entry.id)

            return itemsChanged;

        --i;

    }

#if defined(DEBUG_QSHORTCUTMAP)

    qDebug().nospace()

        << "QShortcutMap::setShortcutAutoRepeat(" << on << ", " << id << ", "

        << owner << ", " << key << ") = " << itemsChanged;

#endif

    return itemsChanged;

}

/*! \internal

    Resets the state of the statemachine to NoMatch

*/

void QShortcutMap::resetState()

{

    Q_D(QShortcutMap);

    d->currentState = QKeySequence::NoMatch;

    clearSequence(d->currentSequences);

}

/*! \internal

    Returns the current state of the statemachine

*/

QKeySequence::SequenceMatch QShortcutMap::state()

{

    Q_D(QShortcutMap);

    return d->currentState;

}

/*! \internal

    Uses ShortcutOverride event to see if any widgets want to override

    the event. If not, uses nextState(QKeyEvent) to check for a grabbed

    Shortcut, and dispatchEvent() is found an identical.

    \sa nextState dispatchEvent

*/

bool QShortcutMap::tryShortcutEvent(QObject *o, QKeyEvent *e)

{

    Q_D(QShortcutMap);

    bool wasAccepted = e->isAccepted();

    bool wasSpontaneous = e->spont;

    if (d->currentState == QKeySequence::NoMatch) {

        ushort orgType = e->t;

        e->t = QEvent::ShortcutOverride;

        e->ignore();

        QApplication::sendEvent(o, e);

        e->t = orgType;

        e->spont = wasSpontaneous;

        if (e->isAccepted()) {

            if (!wasAccepted)

                e->ignore();

            return false;

        }

    }

    QKeySequence::SequenceMatch result = nextState(e);

    bool stateWasAccepted = e->isAccepted();

    if (wasAccepted)

        e->accept();

    else

        e->ignore();

    int identicalMatches = d->identicals.count();

    switch(result) {

    case QKeySequence::NoMatch:

        return stateWasAccepted;

    case QKeySequence::ExactMatch:

        resetState();

        dispatchEvent(e);

    default:

	break;

    }

    // If nextState is QKeySequence::ExactMatch && identicals.count == 0

    // we've only found disabled shortcuts

    return identicalMatches > 0 || result == QKeySequence::PartialMatch;

}

/*! \internal

    Returns the next state of the statemachine

    If return value is SequenceMatch::ExactMatch, then a call to matches()

    will return a QObjects* list of all matching objects for the last matching

    sequence.

*/

QKeySequence::SequenceMatch QShortcutMap::nextState(QKeyEvent *e)

{

    Q_D(QShortcutMap);

    // Modifiers can NOT be shortcuts...

    if (e->key() >= Qt::Key_Shift &&

        e->key() <= Qt::Key_Alt)

        return d->currentState;

    QKeySequence::SequenceMatch result = QKeySequence::NoMatch;

    // We start fresh each time..

    d->identicals.resize(0);

    result = find(e);

    if (result == QKeySequence::NoMatch && e->modifiers() & Qt::ShiftModifier) {

        // If Shift + Key_Backtab, also try Shift + Qt::Key_Tab

        if (e->key() == Qt::Key_Backtab) {

            QKeyEvent pe = QKeyEvent(e->type(), Qt::Key_Tab, e->modifiers(), e->text());

            result = find(&pe);

        }

    }

    // Should we eat this key press?

    if (d->currentState == QKeySequence::PartialMatch

        || (d->currentState == QKeySequence::ExactMatch && d->identicals.count()))

        e->accept();

    // Does the new state require us to clean up?

    if (result == QKeySequence::NoMatch)

        clearSequence(d->currentSequences);

    d->currentState = result;

#if defined(DEBUG_QSHORTCUTMAP)

    qDebug().nospace() << "QShortcutMap::nextState(" << e << ") = " << result;

#endif

    return result;

}

/*! \internal

    Determines if an enabled shortcut has a matcing key sequence.

*/

bool QShortcutMap::hasShortcutForKeySequence(const QKeySequence &seq) const

{

    Q_D(const QShortcutMap);

    QShortcutEntry entry(seq); // needed for searching

    QList<QShortcutEntry>::ConstIterator itEnd = d->sequences.constEnd();

    QList<QShortcutEntry>::ConstIterator it = qLowerBound(d->sequences.constBegin(), itEnd, entry);

    for (;it != itEnd; ++it) {

        if (matches(entry.keyseq, (*it).keyseq) == QKeySequence::ExactMatch && correctContext(*it) && (*it).enabled) {

            return true;

        }

    }

    //end of the loop: we didn't find anything

    return false;

}

/*! \internal

    Returns the next state of the statemachine, based

    on the new key event \a e.

    Matches are appended to the vector of identicals,

    which can be access through matches().

    \sa matches

*/

QKeySequence::SequenceMatch QShortcutMap::find(QKeyEvent *e)

{

    Q_D(QShortcutMap);

    if (!d->sequences.count())

        return QKeySequence::NoMatch;

    createNewSequences(e, d->newEntries);

#if defined(DEBUG_QSHORTCUTMAP)

    qDebug() << "Possible shortcut key sequences:" << d->newEntries;

#endif

    // Should never happen

    if (d->newEntries == d->currentSequences) {

        Q_ASSERT_X(e->key() != Qt::Key_unknown || e->text().length(),

                   "QShortcutMap::find", "New sequence to find identical to previous");

        return QKeySequence::NoMatch;

    }

    // Looking for new identicals, scrap old

    d->identicals.resize(0);

    bool partialFound = false;

    bool identicalDisabledFound = false;

    QVector<QKeySequence> okEntries;

    int result = QKeySequence::NoMatch;

    for (int i = d->newEntries.count()-1; i >= 0 ; --i) {

        QShortcutEntry entry(d->newEntries.at(i)); // needed for searching

        QList<QShortcutEntry>::ConstIterator itEnd = d->sequences.constEnd();

        QList<QShortcutEntry>::ConstIterator it =

             qLowerBound(d->sequences.constBegin(), itEnd, entry);

        int oneKSResult = QKeySequence::NoMatch;

        int tempRes = QKeySequence::NoMatch;

        do {

            if (it == itEnd)

                break;

            tempRes = matches(entry.keyseq, (*it).keyseq);

            oneKSResult = qMax(oneKSResult, tempRes);

            if (tempRes != QKeySequence::NoMatch && correctContext(*it)) {

                if (tempRes == QKeySequence::ExactMatch) {

                    if ((*it).enabled)

                        d->identicals.append(&*it);

                    else

                        identicalDisabledFound = true;

                } else if (tempRes == QKeySequence::PartialMatch) {

                    // We don't need partials, if we have identicals

                    if (d->identicals.size())

                        break;

                    // We only care about enabled partials, so we don't consume

                    // key events when all partials are disabled!

                    partialFound |= (*it).enabled;

                }

            }

            ++it;

            // If we got a valid match on this run, there might still be more keys to check against,

            // so we'll loop once more. If we get NoMatch, there's guaranteed no more possible

            // matches in the shortcutmap.

        } while (tempRes != QKeySequence::NoMatch);

        // If the type of match improves (ergo, NoMatch->Partial, or Partial->Exact), clear the

        // previous list. If this match is equal or better than the last match, append to the list

        if (oneKSResult > result) {

            okEntries.clear();

#if defined(DEBUG_QSHORTCUTMAP)

            qDebug() << "Found better match (" << d->newEntries << "), clearing key sequence list";

#endif

        }

        if (oneKSResult && oneKSResult >= result) {

            okEntries << d->newEntries.at(i);

#if defined(DEBUG_QSHORTCUTMAP)

            qDebug() << "Added ok key sequence" << d->newEntries;

#endif

        }

    }

    if (d->identicals.size()) {

        result = QKeySequence::ExactMatch;

    } else if (partialFound) {

        result = QKeySequence::PartialMatch;

    } else if (identicalDisabledFound) {

        result = QKeySequence::ExactMatch;

    } else {

        clearSequence(d->currentSequences);

        result = QKeySequence::NoMatch;

    }