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

**

** 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 test suite 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 <QtTest/QtTest>

#include <QAction>

#include <QUndoStack>

//TESTED_CLASS=

//TESTED_FILES=

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

** Commands

*/

class InsertCommand : public QUndoCommand

{

public:

    InsertCommand(QString *str, int idx, const QString &text,

                    QUndoCommand *parent = 0);

    virtual void undo();

    virtual void redo();

private:

    QString *m_str;

    int m_idx;

    QString m_text;

};

class RemoveCommand : public QUndoCommand

{

public:

    RemoveCommand(QString *str, int idx, int len, QUndoCommand *parent = 0);

    virtual void undo();

    virtual void redo();

private:

    QString *m_str;

    int m_idx;

    QString m_text;

};

class AppendCommand : public QUndoCommand

{

public:

    AppendCommand(QString *str, const QString &text, bool _fail_merge = false,

                    QUndoCommand *parent = 0);

    ~AppendCommand();

    virtual void undo();

    virtual void redo();

    virtual int id() const;

    virtual bool mergeWith(const QUndoCommand *other);

    bool merged;

    bool fail_merge;

    static int delete_cnt;

private:

    QString *m_str;

    QString m_text;

};

InsertCommand::InsertCommand(QString *str, int idx, const QString &text,

                            QUndoCommand *parent)

    : QUndoCommand(parent)

{

    QVERIFY(str->length() >= idx);

    setText("insert");

    m_str = str;

    m_idx = idx;

    m_text = text;

}

void InsertCommand::redo()

{

    QVERIFY(m_str->length() >= m_idx);

    m_str->insert(m_idx, m_text);

}

void InsertCommand::undo()

{

    QCOMPARE(m_str->mid(m_idx, m_text.length()), m_text);

    m_str->remove(m_idx, m_text.length());

}

RemoveCommand::RemoveCommand(QString *str, int idx, int len, QUndoCommand *parent)

    : QUndoCommand(parent)

{

    QVERIFY(str->length() >= idx + len);

    setText("remove");

    m_str = str;

    m_idx = idx;

    m_text = m_str->mid(m_idx, len);

}

void RemoveCommand::redo()

{

    QCOMPARE(m_str->mid(m_idx, m_text.length()), m_text);

    m_str->remove(m_idx, m_text.length());

}

void RemoveCommand::undo()

{

    QVERIFY(m_str->length() >= m_idx);

    m_str->insert(m_idx, m_text);

}

int AppendCommand::delete_cnt = 0;

AppendCommand::AppendCommand(QString *str, const QString &text, bool _fail_merge,

                                QUndoCommand *parent)

    : QUndoCommand(parent)

{

    setText("append");

    m_str = str;

    m_text = text;

    merged = false;

    fail_merge = _fail_merge;

}

AppendCommand::~AppendCommand()

{

    ++delete_cnt;

}

void AppendCommand::redo()

{

    m_str->append(m_text);

}

void AppendCommand::undo()

{

    QCOMPARE(m_str->mid(m_str->length() - m_text.length()), m_text);

    m_str->truncate(m_str->length() - m_text.length());

}

int AppendCommand::id() const

{

    return 1;

}

bool AppendCommand::mergeWith(const QUndoCommand *other)

{

    if (other->id() != id())

        return false;

    if (fail_merge)

        return false;

    m_text += static_cast<const AppendCommand*>(other)->m_text;

    merged = true;

    return true;

}

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

** tst_QUndoStack

*/

class tst_QUndoStack : public QObject

{

    Q_OBJECT

public:

    tst_QUndoStack();

private slots:

    void undoRedo();

    void setIndex();

    void setClean();

    void clear();

    void childCommand();

    void macroBeginEnd();

    void compression();

    void undoLimit();

};

tst_QUndoStack::tst_QUndoStack()

{

}

static QString glue(const QString &s1, const QString &s2)

{

    QString result;

    result.append(s1);

    if (!s1.isEmpty() && !s2.isEmpty())

        result.append(' ');

    result.append(s2);

    return result;

}

static void checkState(QSignalSpy &redoTextChangedSpy,

                       QSignalSpy &canRedoChangedSpy,

                       QSignalSpy &undoTextChangedSpy,

                       QAction *const redoAction,

                       QAction *const undoAction,

                       QSignalSpy &canUndoChangedSpy,

                       QSignalSpy &cleanChangedSpy,

                       QSignalSpy &indexChangedSpy,

                       QUndoStack &stack,

                       const bool _clean,

                       const int _count,

                       const int _index,

                       const bool _canUndo,

                       const QString &_undoText,

                       const bool _canRedo,

                       const QString &_redoText,

                       const bool _cleanChanged,

                       const bool _indexChanged,

                       const bool _undoChanged,

                       const bool _redoChanged)

{

    QCOMPARE(stack.count(), _count); 

    QCOMPARE(stack.isClean(), _clean); 

    QCOMPARE(stack.index(), _index); 

    QCOMPARE(stack.canUndo(), _canUndo); 

    QCOMPARE(stack.undoText(), QString(_undoText)); 

    QCOMPARE(stack.canRedo(), _canRedo); 

    QCOMPARE(stack.redoText(), QString(_redoText)); 

    if (_indexChanged) { 

        QCOMPARE(indexChangedSpy.count(), 1); 

        QCOMPARE(indexChangedSpy.at(0).at(0).toInt(), _index); 

        indexChangedSpy.clear(); 

    } else { 

        QCOMPARE(indexChangedSpy.count(), 0); 

    } 

    if (_cleanChanged) { 

        QCOMPARE(cleanChangedSpy.count(), 1); 

        QCOMPARE(cleanChangedSpy.at(0).at(0).toBool(), _clean); 

        cleanChangedSpy.clear(); 

    } else { 

        QCOMPARE(cleanChangedSpy.count(), 0); 

    } 

    if (_undoChanged) { 

        QCOMPARE(canUndoChangedSpy.count(), 1); 

        QCOMPARE(canUndoChangedSpy.at(0).at(0).toBool(), _canUndo); 

        QCOMPARE(undoAction->isEnabled(), _canUndo); 

        QCOMPARE(undoTextChangedSpy.count(), 1); 

        QCOMPARE(undoTextChangedSpy.at(0).at(0).toString(), QString(_undoText)); 

        QCOMPARE(undoAction->text(), glue("foo", _undoText)); 

        canUndoChangedSpy.clear(); 

        undoTextChangedSpy.clear(); 

    } else { 

        QCOMPARE(canUndoChangedSpy.count(), 0); 

        QCOMPARE(undoTextChangedSpy.count(), 0); 

    } 

    if (_redoChanged) { 

        QCOMPARE(canRedoChangedSpy.count(), 1); 

        QCOMPARE(canRedoChangedSpy.at(0).at(0).toBool(), _canRedo); 

        QCOMPARE(redoAction->isEnabled(), _canRedo); 

        QCOMPARE(redoTextChangedSpy.count(), 1); 

        QCOMPARE(redoTextChangedSpy.at(0).at(0).toString(), QString(_redoText)); 

        QCOMPARE(redoAction->text(), glue("bar", _redoText)); 

        canRedoChangedSpy.clear(); 

        redoTextChangedSpy.clear(); 

    } else { 

        QCOMPARE(canRedoChangedSpy.count(), 0); 

        QCOMPARE(redoTextChangedSpy.count(), 0); 

    }

}

void tst_QUndoStack::undoRedo()

{

    QUndoStack stack;

    QAction *undoAction = stack.createUndoAction(0, QString("foo"));

    QAction *redoAction = stack.createRedoAction(0, QString("bar"));

    QSignalSpy indexChangedSpy(&stack, SIGNAL(indexChanged(int)));

    QSignalSpy cleanChangedSpy(&stack, SIGNAL(cleanChanged(bool)));

    QSignalSpy canUndoChangedSpy(&stack, SIGNAL(canUndoChanged(bool)));

    QSignalSpy undoTextChangedSpy(&stack, SIGNAL(undoTextChanged(QString)));

    QSignalSpy canRedoChangedSpy(&stack, SIGNAL(canRedoChanged(bool)));

    QSignalSpy redoTextChangedSpy(&stack, SIGNAL(redoTextChanged(QString)));

    QString str;

    // push, undo, redo

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                true,       // clean

                0,          // count

                0,          // index

                false,      // canUndo

                "",         // undoText

                false,      // canRedo

                "",         // redoText

                false,      // cleanChanged

                false,      // indexChanged

                false,      // undoChanged

                false);     // redoChanged

    stack.undo(); // nothing to undo

    QCOMPARE(str, QString());

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                true,       // clean

                0,          // count

                0,          // index

                false,      // canUndo

                "",         // undoText

                false,      // canRedo

                "",         // redoText

                false,      // cleanChanged

                false,      // indexChanged

                false,      // undoChanged

                false);     // redoChanged

    stack.push(new InsertCommand(&str, 0, "hello"));

    QCOMPARE(str, QString("hello"));

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                false,      // clean

                1,          // count

                1,          // index

                true,       // canUndo

                "insert",   // undoText

                false,      // canRedo

                "",         // redoText

                true,       // cleanChanged

                true,       // indexChanged

                true,       // undoChanged

                true);      // redoChanged

    stack.push(new InsertCommand(&str, 2, "123"));

    QCOMPARE(str, QString("he123llo"));

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                false,      // clean

                2,          // count

                2,          // index

                true,       // canUndo

                "insert",   // undoText

                false,      // canRedo

                "",         // redoText

                false,      // cleanChanged

                true,       // indexChanged

                true,       // undoChanged

                true);      // redoChanged

    stack.undo();

    QCOMPARE(str, QString("hello"));

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                false,      // clean

                2,          // count

                1,          // index

                true,       // canUndo

                "insert",   // undoText

                true,       // canRedo

                "insert",   // redoText

                false,      // cleanChanged

                true,       // indexChanged

                true,       // undoChanged

                true);      // redoChanged

    stack.redo();

    QCOMPARE(str, QString("he123llo"));

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                false,      // clean

                2,          // count

                2,          // index

                true,       // canUndo

                "insert",   // undoText

                false,      // canRedo

                "",         // redoText

                false,      // cleanChanged

                true,       // indexChanged

                true,       // undoChanged

                true);      // redoChanged

    stack.redo(); // nothing to redo

    QCOMPARE(str, QString("he123llo"));

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                false,      // clean

                2,          // count

                2,          // index

                true,       // canUndo

                "insert",   // undoText

                false,      // canRedo

                "",         // redoText

                false,      // cleanChanged

                false,      // indexChanged

                false,      // undoChanged

                false);     // redoChanged

    stack.undo();

    QCOMPARE(str, QString("hello"));

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                false,      // clean

                2,          // count

                1,          // index

                true,       // canUndo

                "insert",   // undoText

                true,       // canRedo

                "insert",   // redoText

                false,      // cleanChanged

                true,       // indexChanged

                true,       // undoChanged

                true);      // redoChanged

    stack.undo();

    QCOMPARE(str, QString());

    checkState(redoTextChangedSpy,

                canRedoChangedSpy,

                undoTextChangedSpy,

                redoAction,

                undoAction,

                canUndoChangedSpy,

                cleanChangedSpy,

                indexChangedSpy,

                stack,

                true,       // clean

                2,          // count

                0,          // index

                false,      // canUndo

                "",         // undoText

                true,       // canRedo

                "insert",   // redoText

                true,       // cleanChanged

                true,       // indexChanged