Initial import of statemachine branch from the old kinetic repository

4 files changed, 490 insertions, 0 deletions

diff --git a/src/xmlpatterns/projection/projection.pri b/src/xmlpatterns/projection/projection.pri
new file mode 100644
index 0000000..530041d
--- /dev/null
+++ b/src/xmlpatterns/projection/projection.pri
@@ -0,0 +1,4 @@
+SOURCES += $$PWD/qdocumentprojector.cpp
+
+HEADERS += $$PWD/qdocumentprojector_p.h   \
+           $$PWD/qprojectedexpression_p.h
diff --git a/src/xmlpatterns/projection/qdocumentprojector.cpp b/src/xmlpatterns/projection/qdocumentprojector.cpp
new file mode 100644
index 0000000..fd0ef29
--- /dev/null
+++ b/src/xmlpatterns/projection/qdocumentprojector.cpp
@@ -0,0 +1,214 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns 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 either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qdocumentprojector_p.h"
+
+QT_BEGIN_NAMESPACE
+
+using namespace QPatternist;
+
+DocumentProjector::DocumentProjector(const ProjectedExpression::Vector &paths,
+                                     QAbstractXmlReceiver *const receiver) : m_paths(paths)
+                                                                           , m_pathCount(paths.count())
+                                                                           , m_action(ProjectedExpression::Move)
+                                                                           , m_nodesInProcess(0)
+                                                                           , m_receiver(receiver)
+{
+    Q_ASSERT_X(paths.count() > 0, Q_FUNC_INFO,
+               "Using DocumentProjector with no paths is an "
+               "overhead and has also undefined behavior.");
+    Q_ASSERT(m_receiver);
+}
+
+void DocumentProjector::startElement(const QXmlName name)
+{
+    Q_UNUSED(name);
+
+    switch(m_action)
+    {
+        case ProjectedExpression::KeepSubtree:
+        {
+            m_receiver->startElement(name);
+            /* Fallthrough. */
+        }
+        case ProjectedExpression::Skip:
+        {
+            ++m_nodesInProcess;
+            return;
+        }
+        default:
+        {
+            Q_ASSERT_X(m_action == ProjectedExpression::Move, Q_FUNC_INFO,
+                       "We're not supposed to receive Keep here, because "
+                       "endElement() should always end that state.");
+
+            for(int i = 0; i < m_pathCount; ++i)
+            {
+                m_action = m_paths.at(i)->actionForElement(name, m_paths[i]);
+
+                switch(m_action)
+                {
+                    case ProjectedExpression::Keep:
+                    {
+                        m_action = ProjectedExpression::Keep;
+                        continue;
+                    }
+                    case ProjectedExpression::KeepSubtree:
+                    {
+                        /* Ok, at least one path wanted this node. Pass it on,
+                         * and exit. */
+                        m_receiver->startElement(name);
+                        ++m_nodesInProcess;
+                        return;
+                    }
+                    case ProjectedExpression::Skip:
+                    {
+                        /* This particular path doesn't need it, but
+                         * some other path might, so continue looping. */
+                        continue;
+                    }
+                    case ProjectedExpression::Move:
+                        Q_ASSERT_X(false, Q_FUNC_INFO, "The action functions can never return Move.");
+                }
+            }
+
+            ++m_nodesInProcess;
+
+            if(m_action == ProjectedExpression::Keep)
+                m_receiver->startElement(name);
+            else
+            {
+                Q_ASSERT(m_action == ProjectedExpression::Skip);
+            }
+        }
+    }
+}
+
+void DocumentProjector::endElement()
+{
+    if(m_action == ProjectedExpression::Keep)
+    {
+        Q_ASSERT(m_nodesInProcess == 1);
+
+        m_receiver->endElement();
+
+        /* We have now kept the single node, and now wants to skip
+         * all its children. */
+        m_action = ProjectedExpression::Skip;
+        m_nodesInProcess = 0;
+    }
+    else if(m_action == ProjectedExpression::KeepSubtree)
+    {
+        m_receiver->endElement();
+        --m_nodesInProcess;
+
+        if(m_nodesInProcess == 0)
+        {
+            /* We have now skipped all the children, let's do
+             * a new path analysis. */
+            m_action = ProjectedExpression::Move;
+        }
+    }
+    else
+    {
+        Q_ASSERT_X(m_action == ProjectedExpression::Skip, Q_FUNC_INFO,
+                   "We're not supposed to be in a Move action here.");
+        /* We skip calling m_receiver's endElement() here since we're
+         * skipping. */
+        Q_ASSERT(m_nodesInProcess > 0);
+        --m_nodesInProcess;
+
+        if(m_nodesInProcess == 0)
+        {
+            /* Ok, we've skipped them all, let's do something
+             * new -- let's Move on to the next path! */
+            m_action = ProjectedExpression::Move;
+        }
+    }
+}
+
+void DocumentProjector::attribute(const QXmlName name,
+                                  const QString &value)
+{
+    Q_UNUSED(name);
+    Q_UNUSED(value);
+}
+
+void DocumentProjector::namespaceBinding(const QXmlName nb)
+{
+    Q_UNUSED(nb);
+}
+
+void DocumentProjector::comment(const QString &value)
+{
+    Q_ASSERT_X(!value.contains(QLatin1String("--")), Q_FUNC_INFO,
+               "Invalid input; it's the caller's responsibility to ensure the input is correct.");
+    Q_UNUSED(value);
+}
+
+void DocumentProjector::characters(const QString &value)
+{
+    Q_UNUSED(value);
+}
+
+void DocumentProjector::processingInstruction(const QXmlName name,
+                                              const QString &value)
+{
+    Q_ASSERT_X(!value.contains(QLatin1String("?>")), Q_FUNC_INFO,
+               "Invalid input; it's the caller's responsibility to ensure the input is correct.");
+    Q_UNUSED(name);
+    Q_UNUSED(value);
+}
+
+void DocumentProjector::item(const Item &outputItem)
+{
+    Q_UNUSED(outputItem);
+}
+
+void DocumentProjector::startDocument()
+{
+}
+
+void DocumentProjector::endDocument()
+{
+}
+
+QT_END_NAMESPACE
diff --git a/src/xmlpatterns/projection/qdocumentprojector_p.h b/src/xmlpatterns/projection/qdocumentprojector_p.h
new file mode 100644
index 0000000..39e74e4
--- /dev/null
+++ b/src/xmlpatterns/projection/qdocumentprojector_p.h
@@ -0,0 +1,107 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns 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 either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+
+#ifndef Patternist_DocumentProjector_H
+#define Patternist_DocumentProjector_H
+
+#include "qprojectedexpression_p.h"
+#include "qabstractxmlreceiver.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short
+     *
+     * @author Frans Englich <fenglich@trolltech.com>
+     */
+    class DocumentProjector : public QAbstractXmlReceiver
+    {
+    public:
+        DocumentProjector(const ProjectedExpression::Vector &paths,
+                          QAbstractXmlReceiver *const receiver);
+
+        virtual void namespaceBinding(const QXmlName nb);
+
+        virtual void characters(const QString &value);
+        virtual void comment(const QString &value);
+
+        virtual void startElement(const QXmlName name);
+
+        virtual void endElement();
+
+        virtual void attribute(const QXmlName name,
+                               const QString &value);
+
+        virtual void processingInstruction(const QXmlName name,
+                                           const QString &value);
+
+        virtual void item(const Item &item);
+
+        virtual void startDocument();
+        virtual void endDocument();
+
+        ProjectedExpression::Vector m_paths;
+        const int                   m_pathCount;
+        ProjectedExpression::Action m_action;
+        int                         m_nodesInProcess;
+        QAbstractXmlReceiver *const m_receiver;
+    };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif
diff --git a/src/xmlpatterns/projection/qprojectedexpression_p.h b/src/xmlpatterns/projection/qprojectedexpression_p.h
new file mode 100644
index 0000000..8f54902
--- /dev/null
+++ b/src/xmlpatterns/projection/qprojectedexpression_p.h
@@ -0,0 +1,165 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: Qt Software Information (qt-info@nokia.com)
+**
+** This file is part of the QtXmlPatterns 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 either Technology Preview License Agreement or the
+** Beta Release License Agreement.
+**
+** 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.0, 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.
+**
+** If you are unsure which license is appropriate for your use, please
+** contact the sales department at qt-sales@nokia.com.
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+
+#ifndef Patternist_ProjectedExpression_H
+#define Patternist_ProjectedExpression_H
+
+#include "qitem_p.h"
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    class ProjectedExpression
+    {
+    public:
+        typedef ProjectedExpression * Ptr;
+        typedef QVector<ProjectedExpression::Ptr> Vector;
+        virtual ~ProjectedExpression()
+        {
+        }
+
+        enum Action
+        {
+            Move = 0,
+            Skip = 1,
+            Keep = 2,
+            KeepSubtree = 4 | Keep
+        };
+
+        virtual Action actionForElement(const QXmlName name,
+                                        ProjectedExpression::Ptr &next) const
+        {
+            Q_UNUSED(name);
+            Q_UNUSED(next);
+            return Skip;
+        }
+
+    };
+
+    class ProjectedNodeTest
+    {
+    public:
+        typedef ProjectedNodeTest * Ptr;
+        virtual ~ProjectedNodeTest()
+        {
+        }
+
+        virtual bool isMatch(const QXmlNodeModelIndex::NodeKind kind) const
+        {
+            Q_UNUSED(kind);
+            return false;
+        }
+    };
+
+    class ProjectedStep : public ProjectedExpression
+    {
+    public:
+        ProjectedStep(const ProjectedNodeTest::Ptr test,
+                      const QXmlNodeModelIndex::Axis axis) : m_test(test),
+                                               m_axis(axis)
+        {
+            Q_ASSERT(m_test);
+        }
+
+        virtual Action actionForElement(const QXmlName name,
+                                        ProjectedExpression::Ptr &next) const
+        {
+            Q_UNUSED(name);
+            Q_UNUSED(next);
+            // TODO
+            return Skip;
+        }
+
+    private:
+        const ProjectedNodeTest::Ptr    m_test;
+        const QXmlNodeModelIndex::Axis                m_axis;
+    };
+
+    class ProjectedPath : public ProjectedExpression
+    {
+    public:
+        ProjectedPath(const ProjectedExpression::Ptr left,
+                      const ProjectedExpression::Ptr right) : m_left(left),
+                                                              m_right(right)
+        {
+            Q_ASSERT(m_left);
+            Q_ASSERT(m_right);
+        }
+
+        virtual Action actionForElement(const QXmlName name,
+                                        ProjectedExpression::Ptr &next) const
+        {
+            ProjectedExpression::Ptr &candidateNext = next;
+            const Action a = m_left->actionForElement(name, candidateNext);
+
+            if(a != Skip)
+            {
+                /* The test accepted it, so let's replace us with the new step. */
+                next = candidateNext;
+            }
+
+            return a;
+        }
+
+    private:
+        const ProjectedExpression::Ptr  m_left;
+        const ProjectedExpression::Ptr  m_right;
+    };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif