src/xmlpatterns/schema/qxsdstatemachine_p.h
changeset 0 1918ee327afb
child 3 41300fa6a67c
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/schema/qxsdstatemachine_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,245 @@
+/****************************************************************************
+**
+** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies).
+** All rights reserved.
+** Contact: Nokia Corporation (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 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$
+**
+****************************************************************************/
+
+//
+//  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_XsdStateMachine_H
+#define Patternist_XsdStateMachine_H
+
+#include "qnamepool_p.h"
+
+#include <QtCore/QHash>
+#include <QtCore/QSet>
+#include <QtCore/QTextStream>
+
+class QIODevice;
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short A state machine used for evaluation.
+     *
+     * @ingroup Patternist_schema
+     * @author Tobias Koenig <tobias.koenig@nokia.com>
+     */
+    template <typename TransitionType>
+    class XsdStateMachine
+    {
+        public:
+            typedef qint32 StateId;
+
+            /**
+             * Describes the type of state.
+             */
+            enum StateType
+            {
+                StartState,     ///< The state the machine will start with.
+                StartEndState,  ///< The state the machine will start with, can be end state as well.
+                InternalState,  ///< Any state that is not start or end state.
+                EndState        ///< Any state where the machine is allowed to stop.
+            };
+
+            /**
+             * Creates a new state machine object.
+             */
+            XsdStateMachine();
+
+            /**
+             * Creates a new state machine object.
+             *
+             * The name pool to use for accessing object names.
+             */
+            XsdStateMachine(const NamePool::Ptr &namePool);
+
+            /**
+             * Adds a new state of the given @p type to the state machine.
+             *
+             * @return The id of the new state.
+             */
+            StateId addState(StateType type);
+
+            /**
+             * Adds a new @p transition to the state machine.
+             *
+             * @param start The start state.
+             * @param transition The transition to come from the start to the end state.
+             * @param end The end state.
+             */
+            void addTransition(StateId start, TransitionType transition, StateId end);
+
+            /**
+             * Adds a new epsilon @p transition to the state machine.
+             *
+             * @param start The start state.
+             * @param end The end state.
+             */
+            void addEpsilonTransition(StateId start, StateId end);
+
+            /**
+             * Resets the machine to the start state.
+             */
+            void reset();
+
+            /**
+             * Removes all states and transitions from the state machine.
+             */
+            void clear();
+
+            /**
+             * Continues execution of the machine with the given input @p transition.
+             *
+             * @return @c true if the transition was successfull, @c false otherwise.
+             */
+            bool proceed(TransitionType transition);
+
+            /**
+             * Returns the list of transitions that are reachable from the current
+             * state.
+             */
+            QList<TransitionType> possibleTransitions() const;
+
+            /**
+             * Continues execution of the machine with the given @p input.
+             *
+             * @note To use this method, inputEqualsTransition must be implemented
+             *       to find the right transition to use.
+             *
+             * @return @c true if the transition was successfull, @c false otherwise.
+             */
+            template <typename InputType>
+            bool proceed(InputType input);
+
+            /**
+             * Returns whether the given @p input matches the given @p transition.
+             */
+            template <typename InputType>
+            bool inputEqualsTransition(InputType input, TransitionType transition) const;
+
+            /**
+             * Returns whether the machine is in an allowed end state.
+             */
+            bool inEndState() const;
+
+            /**
+             * Returns the last transition that was taken.
+             */
+            TransitionType lastTransition() const;
+
+            /**
+             * Returns the start state of the machine.
+             */
+            StateId startState() const;
+
+            /**
+             * This method should be redefined by template specialization for every
+             * concret TransitionType.
+             */
+            QString transitionTypeToString(TransitionType type) const;
+
+            /**
+             * Outputs the state machine in DOT format to the given
+             * output @p device.
+             */
+            bool outputGraph(QIODevice *device, const QString &graphName) const;
+
+            /**
+             * Returns a DFA that is equal to the NFA of the state machine.
+             */
+            XsdStateMachine<TransitionType> toDFA() const;
+
+            /**
+             * Returns the information of all states of the state machine.
+             */
+            QHash<StateId, StateType> states() const;
+
+            /**
+             * Returns the information of all transitions of the state machine.
+             */
+            QHash<StateId, QHash<TransitionType, QVector<StateId> > > transitions() const;
+
+        private:
+            /**
+             * Returns the DFA state for the given @p nfaStat from the given @p stateTable.
+             * If there is no corresponding DFA state yet, a new one is created.
+             */
+            StateId dfaStateForNfaState(QSet<StateId> nfaState, QList< QPair< QSet<StateId>, StateId> > &stateTable, XsdStateMachine<TransitionType> &dfa) const;
+
+            /**
+             * Returns the set of all states that can be reached from the set of @p input states
+             * by the epsilon transition.
+             */
+            QSet<StateId> epsilonClosure(const QSet<StateId> &input) const;
+
+            /**
+             * Returns the set of all states that can be reached from the set of given @p states
+             * by the given @p input.
+             */
+            QSet<StateId> move(const QSet<StateId> &states, TransitionType input) const;
+
+            NamePool::Ptr                                             m_namePool;
+            QHash<StateId, StateType>                                 m_states;
+            QHash<StateId, QHash<TransitionType, QVector<StateId> > > m_transitions;
+            QHash<StateId, QVector<StateId> >                         m_epsilonTransitions;
+            StateId                                                   m_currentState;
+            qint32                                                    m_counter;
+            TransitionType                                            m_lastTransition;
+    };
+
+    #include "qxsdstatemachine.cpp"
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif