Add libkundo2 to Calligra

kundo2 is a fork of Qt's Undo Framework (QUndoStack, QUndoView, ...).
It contains two bugfixes the are going to be available only in Qt 4.8:
	https://qt.gitorious.org/qt/qt/merge_requests/1212
	https://qt.gitorious.org/qt/qt/merge_requests/2610

To start using kundo2, one should port Calligra to it. This can be done
by adding target_link_libraries(... kundo2) into CMakeLists.txt files
for all modules from Calligra that use Qt Undo Framework, and by
switching from QUndo**** classes to KUndo2**** classes.
(switching to KUndo2 classes can easily be done by using a script)

After Calligra starts requiring Qt 4.8+, this library can be removed,
because it has no advantages over Qt's Undo Framework 4.8.

libs/CMakeLists.txt

@@ -6,6 +6,7 @@ add_subdirectory( kotext )
 add_subdirectory( flake )
 add_subdirectory( pigment )
 add_subdirectory( main )
+add_subdirectory( kundo2 )
 if (SHOULD_BUILD_SCRIPTING)
     add_subdirectory( kokross )
 endif (SHOULD_BUILD_SCRIPTING)

libs/kundo2/CMakeLists.txt

+include_directories( ${QT_INCLUDES} )
+
+set(kundo2_LIB_SRCS
+	kundo2stack.cpp
+	kundo2group.cpp
+	kundo2view.cpp
+	kundo2model.cpp
+)
+
+kde4_add_library(kundo2 SHARED ${kundo2_LIB_SRCS})
+
+target_link_libraries(kundo2 ${QT_QTCORE_LIBRARY} ${QT_QTGUI_LIBRARY} ${KDE4_KDECORE_LIBS} ${KDE4_KDEUI_LIBS})
+
+set_target_properties(koplugin PROPERTIES
+    VERSION ${GENERIC_KOFFICE_LIB_VERSION} SOVERSION ${GENERIC_KOFFICE_LIB_SOVERSION}
+)
+install(TARGETS kundo2 ${INSTALL_TARGETS_DEFAULT_ARGS})
+
+install(FILES
+	kundo2stack.h
+	kundo2qstack.h
+	kundo2group.h
+	kundo2view.h
+	kundo2model.h
+	kundo2command.h
+	DESTINATION ${INCLUDE_INSTALL_DIR} COMPONENT Devel
+)
+

libs/kundo2/kundo2_export.h

+/*  This file is part of the KDE project
+    Copyright (C) 2007 David Faure <faure@kde.org>
+
+    This library is free software; you can redistribute it and/or
+    modify it under the terms of the GNU Library General Public
+    License as published by the Free Software Foundation; either
+    version 2 of the License, or (at your option) any later version.
+
+    This library is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+    Library General Public License for more details.
+
+    You should have received a copy of the GNU Library General Public License
+    along with this library; see the file COPYING.LIB.  If not, write to
+    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+    Boston, MA 02110-1301, USA.
+*/
+
+#ifndef KUNDO2_EXPORT_H
+#define KUNDO2_EXPORT_H
+
+/* needed for KDE_EXPORT and KDE_IMPORT macros */
+#include <kdemacros.h>
+
+#ifndef KUNDO2_EXPORT
+# if defined(KDELIBS_STATIC_LIBS)
+   /* No export/import for static libraries */
+#  define KUNDO2_EXPORT
+# elif defined(MAKE_KUNDO2_LIB)
+   /* We are building this library */ 
+#  define KUNDO2_EXPORT KDE_EXPORT
+# else
+   /* We are using this library */ 
+#  define KUNDO2_EXPORT KDE_IMPORT
+# endif
+#endif
+
+# ifndef KUNDO2_EXPORT_DEPRECATED
+#  define KUNDO2_EXPORT_DEPRECATED KDE_DEPRECATED KUNDO2_EXPORT
+# endif
+
+#endif

libs/kundo2/kundo2command.h

+#include <kundo2stack.h>

libs/kundo2/kundo2group.cpp

+/****************************************************************************
+**
+** Copyright (C) 2011 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 "kundo2group.h"
+#include "kundo2stack.h"
+#include "kundo2stack_p.h"
+#include <KDE/KLocale>
+
+#ifndef QT_NO_UNDOGROUP
+
+/*!
+    \class KUndo2Group
+    \brief The KUndo2Group class is a group of KUndo2QStack objects.
+    \since 4.2
+
+    For an overview of the Qt's undo framework, see the
+    \link qundo.html overview\endlink.
+
+    An application often has multiple undo stacks, one for each opened document. At the
+    same time, an application usually has one undo action and one redo action, which
+    triggers undo or redo in the active document.
+
+    KUndo2Group is a group of KUndo2QStack objects, one of which may be active. It has
+    an undo() and redo() slot, which calls KUndo2QStack::undo() and KUndo2QStack::redo()
+    for the active stack. It also has the functions createUndoAction() and createRedoAction().
+    The actions returned by these functions behave in the same way as those returned by
+    KUndo2QStack::createUndoAction() and KUndo2QStack::createRedoAction() of the active
+    stack.
+
+    Stacks are added to a group with addStack() and removed with removeStack(). A stack
+    is implicitly added to a group when it is created with the group as its parent
+    QObject.
+
+    It is the programmer's responsibility to specify which stack is active by
+    calling KUndo2QStack::setActive(), usually when the associated document window receives focus.
+    The active stack may also be set with setActiveStack(), and is returned by activeStack().
+
+    When a stack is added to a group using addStack(), the group does not take ownership
+    of the stack. This means the stack has to be deleted separately from the group. When
+    a stack is deleted, it is automatically removed from a group. A stack may belong to
+    only one group. Adding it to another group will cause it to be removed from the previous
+    group.
+
+    A KUndo2Group is also useful in conjunction with KUndo2View. If a KUndo2View is
+    set to watch a group using KUndo2View::setGroup(), it will update itself to display
+    the active stack.
+*/
+
+/*!
+    Creates an empty KUndo2Group object with parent \a parent.
+
+    \sa addStack()
+*/
+
+KUndo2Group::KUndo2Group(QObject *parent)
+    : QObject(parent), m_active(0)
+{
+}
+
+/*!
+    Destroys the KUndo2Group.
+*/
+KUndo2Group::~KUndo2Group()
+{
+    // Ensure all KUndo2Stacks no longer refer to this group.
+    QList<KUndo2QStack *>::iterator it = m_stack_list.begin();
+    QList<KUndo2QStack *>::iterator end = m_stack_list.end();
+    while (it != end) {
+        (*it)->m_group = 0;
+        ++it;
+    }
+}
+
+/*!
+    Adds \a stack to this group. The group does not take ownership of the stack. Another
+    way of adding a stack to a group is by specifying the group as the stack's parent
+    QObject in KUndo2QStack::KUndo2QStack(). In this case, the stack is deleted when the
+    group is deleted, in the usual manner of QObjects.
+
+    \sa removeStack() stacks() KUndo2QStack::KUndo2QStack()
+*/
+
+void KUndo2Group::addStack(KUndo2QStack *stack)
+{
+    if (m_stack_list.contains(stack))
+        return;
+    m_stack_list.append(stack);
+
+    if (KUndo2Group *other = stack->m_group)
+        other->removeStack(stack);
+    stack->m_group = this;
+}
+
+/*!
+    Removes \a stack from this group. If the stack was the active stack in the group,
+    the active stack becomes 0.
+
+    \sa addStack() stacks() KUndo2QStack::~KUndo2QStack()
+*/
+
+void KUndo2Group::removeStack(KUndo2QStack *stack)
+{
+    if (m_stack_list.removeAll(stack) == 0)
+        return;
+    if (stack == m_active)
+        setActiveStack(0);
+    stack->m_group = 0;
+}
+
+/*!
+    Returns a list of stacks in this group.
+
+    \sa addStack() removeStack()
+*/
+
+QList<KUndo2QStack*> KUndo2Group::stacks() const
+{
+    return m_stack_list;
+}
+
+/*!
+    Sets the active stack of this group to \a stack.
+
+    If the stack is not a member of this group, this function does nothing.
+
+    Synonymous with calling KUndo2QStack::setActive() on \a stack.
+
+    The actions returned by createUndoAction() and createRedoAction() will now behave
+    in the same way as those returned by \a stack's KUndo2QStack::createUndoAction()
+    and KUndo2QStack::createRedoAction().
+
+    \sa KUndo2QStack::setActive() activeStack()
+*/
+
+void KUndo2Group::setActiveStack(KUndo2QStack *stack)
+{
+    if (m_active == stack)
+        return;
+
+    if (m_active != 0) {
+        disconnect(m_active, SIGNAL(canUndoChanged(bool)),
+                    this, SIGNAL(canUndoChanged(bool)));
+        disconnect(m_active, SIGNAL(undoTextChanged(QString)),
+                    this, SIGNAL(undoTextChanged(QString)));
+        disconnect(m_active, SIGNAL(canRedoChanged(bool)),
+                    this, SIGNAL(canRedoChanged(bool)));
+        disconnect(m_active, SIGNAL(redoTextChanged(QString)),
+                    this, SIGNAL(redoTextChanged(QString)));
+        disconnect(m_active, SIGNAL(indexChanged(int)),
+                    this, SIGNAL(indexChanged(int)));
+        disconnect(m_active, SIGNAL(cleanChanged(bool)),
+                    this, SIGNAL(cleanChanged(bool)));
+    }
+
+    m_active = stack;
+
+    if (m_active == 0) {
+        emit canUndoChanged(false);
+        emit undoTextChanged(QString());
+        emit canRedoChanged(false);
+        emit redoTextChanged(QString());
+        emit cleanChanged(true);
+        emit indexChanged(0);
+    } else {
+        connect(m_active, SIGNAL(canUndoChanged(bool)),
+                this, SIGNAL(canUndoChanged(bool)));
+        connect(m_active, SIGNAL(undoTextChanged(QString)),
+                this, SIGNAL(undoTextChanged(QString)));
+        connect(m_active, SIGNAL(canRedoChanged(bool)),
+                this, SIGNAL(canRedoChanged(bool)));
+        connect(m_active, SIGNAL(redoTextChanged(QString)),
+                this, SIGNAL(redoTextChanged(QString)));
+        connect(m_active, SIGNAL(indexChanged(int)),
+                this, SIGNAL(indexChanged(int)));
+        connect(m_active, SIGNAL(cleanChanged(bool)),
+                this, SIGNAL(cleanChanged(bool)));
+        emit canUndoChanged(m_active->canUndo());
+        emit undoTextChanged(m_active->undoText());
+        emit canRedoChanged(m_active->canRedo());
+        emit redoTextChanged(m_active->redoText());
+        emit cleanChanged(m_active->isClean());
+        emit indexChanged(m_active->index());
+    }
+
+    emit activeStackChanged(m_active);
+}
+
+/*!
+    Returns the active stack of this group.
+
+    If none of the stacks are active, or if the group is empty, this function
+    returns 0.
+
+    \sa setActiveStack() KUndo2QStack::setActive()
+*/
+
+KUndo2QStack *KUndo2Group::activeStack() const
+{
+    return m_active;
+}
+
+/*!
+    Calls KUndo2QStack::undo() on the active stack.
+
+    If none of the stacks are active, or if the group is empty, this function
+    does nothing.
+
+    \sa redo() canUndo() setActiveStack()
+*/
+
+void KUndo2Group::undo()
+{
+    if (m_active != 0)
+        m_active->undo();
+}
+
+/*!
+    Calls KUndo2QStack::redo() on the active stack.
+
+    If none of the stacks are active, or if the group is empty, this function
+    does nothing.
+
+    \sa undo() canRedo() setActiveStack()
+*/
+
+
+void KUndo2Group::redo()
+{
+    if (m_active != 0)
+        m_active->redo();
+}
+
+/*!
+    Returns the value of the active stack's KUndo2QStack::canUndo().
+
+    If none of the stacks are active, or if the group is empty, this function
+    returns false.
+
+    \sa canRedo() setActiveStack()
+*/
+
+bool KUndo2Group::canUndo() const
+{
+    return m_active != 0 && m_active->canUndo();
+}
+
+/*!
+    Returns the value of the active stack's KUndo2QStack::canRedo().
+
+    If none of the stacks are active, or if the group is empty, this function
+    returns false.
+
+    \sa canUndo() setActiveStack()
+*/
+
+bool KUndo2Group::canRedo() const
+{
+    return m_active != 0 && m_active->canRedo();
+}
+
+/*!
+    Returns the value of the active stack's KUndo2QStack::undoActionText().
+
+    If none of the stacks are active, or if the group is empty, this function
+    returns an empty string.
+
+    \sa undoItemText() redoActionText() setActiveStack()
+*/
+
+QString KUndo2Group::undoText() const
+{
+    return m_active == 0 ? QString() : m_active->undoText();
+}
+
+/*!
+    Returns the value of the active stack's KUndo2QStack::redoActionText().
+
+    If none of the stacks are active, or if the group is empty, this function
+    returns an empty string.
+
+    \sa redoItemText() undoActionText() setActiveStack()
+*/
+
+QString KUndo2Group::redoText() const
+{
+    return m_active == 0 ? QString() : m_active->redoText();
+}
+
+/*!
+    Returns the value of the active stack's KUndo2QStack::isClean().
+
+    If none of the stacks are active, or if the group is empty, this function
+    returns true.
+
+    \sa setActiveStack()
+*/
+
+bool KUndo2Group::isClean() const
+{
+    return m_active == 0 || m_active->isClean();
+}
+
+#ifndef QT_NO_ACTION
+
+/*!
+    Creates an undo QAction object with parent \a parent.
+
+    Triggering this action will cause a call to KUndo2QStack::undo() on the active stack.
+    The text of this action will always be the text of the command which will be undone
+    in the next call to undo(), prefixed by \a prefix. If there is no command available
+    for undo, if the group is empty or if none of the stacks are active, this action will
+    be disabled.
+
+    If \a prefix is empty, the default prefix "Undo" is used.
+
+    \sa createRedoAction() canUndo() KUndo2Command::text()
+*/
+
+QAction *KUndo2Group::createUndoAction(QObject *parent) const
+{
+    KUndo2Action *result = new KUndo2Action(i18n("Undo %1"), i18nc("Default text for undo action", "Undo"), parent);
+    result->setEnabled(canUndo());
+    result->setPrefixedText(undoText());
+    connect(this, SIGNAL(canUndoChanged(bool)),
+            result, SLOT(setEnabled(bool)));
+    connect(this, SIGNAL(undoTextChanged(QString)),
+            result, SLOT(setPrefixedText(QString)));
+    connect(result, SIGNAL(triggered()), this, SLOT(undo()));
+    return result;
+}
+
+/*!
+    Creates an redo QAction object with parent \a parent.
+
+    Triggering this action will cause a call to KUndo2QStack::redo() on the active stack.
+    The text of this action will always be the text of the command which will be redone
+    in the next call to redo(), prefixed by \a prefix. If there is no command available
+    for redo, if the group is empty or if none of the stacks are active, this action will
+    be disabled.
+
+    If \a prefix is empty, the default prefix "Undo" is used.
+
+    \sa createUndoAction() canRedo() KUndo2Command::text()
+*/
+
+QAction *KUndo2Group::createRedoAction(QObject *parent) const
+{
+    KUndo2Action *result = new KUndo2Action(i18n("Redo %1"), i18nc("Default text for redo action", "Redo"), parent);
+    result->setEnabled(canRedo());
+    result->setPrefixedText(redoText());
+    connect(this, SIGNAL(canRedoChanged(bool)),
+            result, SLOT(setEnabled(bool)));
+    connect(this, SIGNAL(redoTextChanged(QString)),
+            result, SLOT(setPrefixedText(QString)));
+    connect(result, SIGNAL(triggered()), this, SLOT(redo()));
+    return result;
+}
+
+#endif // QT_NO_ACTION
+
+/*! \fn void KUndo2Group::activeStackChanged(KUndo2QStack *stack)
+
+    This signal is emitted whenever the active stack of the group changes. This can happen
+    when setActiveStack() or KUndo2QStack::setActive() is called, or when the active stack
+    is removed form the group. \a stack is the new active stack. If no stack is active,
+    \a stack is 0.
+
+    \sa setActiveStack() KUndo2QStack::setActive()
+*/
+
+/*! \fn void KUndo2Group::indexChanged(int idx)
+
+    This signal is emitted whenever the active stack emits KUndo2QStack::indexChanged()
+    or the active stack changes.
+
+    \a idx is the new current index, or 0 if the active stack is 0.
+
+    \sa KUndo2QStack::indexChanged() setActiveStack()
+*/
+
+/*! \fn void KUndo2Group::cleanChanged(bool clean)
+
+    This signal is emitted whenever the active stack emits KUndo2QStack::cleanChanged()
+    or the active stack changes.
+
+    \a clean is the new state, or true if the active stack is 0.
+
+    \sa KUndo2QStack::cleanChanged() setActiveStack()
+*/
+
+/*! \fn void KUndo2Group::canUndoChanged(bool canUndo)
+
+    This signal is emitted whenever the active stack emits KUndo2QStack::canUndoChanged()
+    or the active stack changes.
+
+    \a canUndo is the new state, or false if the active stack is 0.
+
+    \sa KUndo2QStack::canUndoChanged() setActiveStack()
+*/
+
+/*! \fn void KUndo2Group::canRedoChanged(bool canRedo)
+
+    This signal is emitted whenever the active stack emits KUndo2QStack::canRedoChanged()
+    or the active stack changes.
+
+    \a canRedo is the new state, or false if the active stack is 0.
+
+    \sa KUndo2QStack::canRedoChanged() setActiveStack()
+*/
+
+/*! \fn void KUndo2Group::undoTextChanged(const QString &undoText)
+
+    This signal is emitted whenever the active stack emits KUndo2QStack::undoTextChanged()
+    or the active stack changes.
+
+    \a undoText is the new state, or an empty string if the active stack is 0.
+
+    \sa KUndo2QStack::undoTextChanged() setActiveStack()
+*/
+
+/*! \fn void KUndo2Group::redoTextChanged(const QString &redoText)
+
+    This signal is emitted whenever the active stack emits KUndo2QStack::redoTextChanged()
+    or the active stack changes.
+
+    \a redoText is the new state, or an empty string if the active stack is 0.
+
+    \sa KUndo2QStack::redoTextChanged() setActiveStack()
+*/
+
+#endif // QT_NO_UNDOGROUP

libs/kundo2/kundo2group.h

+/****************************************************************************
+**
+** Copyright (C) 2011 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$
+**
+****************************************************************************/
+
+#ifndef KUNDO2GROUP_H
+#define KUNDO2GROUP_H
+
+#include <QtCore/qobject.h>
+#include <QtCore/qstring.h>
+
+#include "kundo2_export.h"
+
+class KUndo2GroupPrivate;
+class KUndo2QStack;
+class QAction;
+
+#ifndef QT_NO_UNDOGROUP
+
+class KUNDO2_EXPORT KUndo2Group : public QObject
+{
+    Q_OBJECT
+    Q_DECLARE_PRIVATE(KUndo2Group)
+
+public:
+    explicit KUndo2Group(QObject *parent = 0);
+    ~KUndo2Group();
+
+    void addStack(KUndo2QStack *stack);
+    void removeStack(KUndo2QStack *stack);
+    QList<KUndo2QStack*> stacks() const;
+    KUndo2QStack *activeStack() const;
+
+#ifndef QT_NO_ACTION
+    QAction *createUndoAction(QObject *parent) const;
+    QAction *createRedoAction(QObject *parent) const;
+#endif // QT_NO_ACTION
+    bool canUndo() const;
+    bool canRedo() const;
+    QString undoText() const;