src/xmlpatterns/schema/qxsdstatemachinebuilder_p.h
changeset 0 1918ee327afb
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/schema/qxsdstatemachinebuilder_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,141 @@
+/****************************************************************************
+**
+** 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_XsdStateMachineBuilder_H
+#define Patternist_XsdStateMachineBuilder_H
+
+#include "qxsdparticle_p.h"
+#include "qxsdstatemachine_p.h"
+#include "qxsdterm_p.h"
+
+#include <QtCore/QExplicitlySharedDataPointer>
+#include <QtCore/QList>
+
+QT_BEGIN_HEADER
+
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short A helper class to build up validation state machines.
+     *
+     * @ingroup Patternist_schema
+     * @author Tobias Koenig <tobias.koenig@nokia.com>
+     */
+    class XsdStateMachineBuilder : public QSharedData
+    {
+        public:
+            typedef QExplicitlySharedDataPointer<XsdStateMachineBuilder> Ptr;
+
+            enum Mode
+            {
+                CheckingMode,
+                ValidatingMode
+            };
+
+            /**
+             * Creates a new state machine builder.
+             *
+             * @param machine The state machine it should work on.
+             * @param namePool The name pool used by all schema components.
+             * @param mode The mode the machine shall be build for.
+             */
+            XsdStateMachineBuilder(XsdStateMachine<XsdTerm::Ptr> *machine, const NamePool::Ptr &namePool, Mode mode = CheckingMode);
+
+            /**
+             * Resets the state machine.
+             *
+             * @returns The initial end state.
+             */
+            XsdStateMachine<XsdTerm::Ptr>::StateId reset();
+
+            /**
+             * Prepends a start state to the given @p state.
+             * That is needed to allow the conversion of the state machine from a FSA to a DFA.
+             */
+            XsdStateMachine<XsdTerm::Ptr>::StateId addStartState(XsdStateMachine<XsdTerm::Ptr>::StateId state);
+
+            /**
+             * Creates the state machine for the given @p particle that should have the
+             * given @p endState.
+             *
+             * @returns The new start state.
+             */
+            XsdStateMachine<XsdTerm::Ptr>::StateId buildParticle(const XsdParticle::Ptr &particle, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
+
+            /**
+             * Creates the state machine for the given @p term that should have the
+             * given @p endState.
+             *
+             * @returns The new start state.
+             */
+            XsdStateMachine<XsdTerm::Ptr>::StateId buildTerm(const XsdTerm::Ptr &term, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
+
+            /**
+             * Returns a hash that maps each term that appears inside @p particle, to the particle it belongs.
+             *
+             * @note These information are used by XsdParticleChecker to check particle inheritance.
+             */
+            static QHash<XsdTerm::Ptr, XsdParticle::Ptr> particleLookupMap(const XsdParticle::Ptr &particle);
+
+        private:
+            XsdStateMachine<XsdTerm::Ptr> *m_stateMachine;
+            NamePool::Ptr                  m_namePool;
+            Mode                           m_mode;
+    };
+}
+
+QT_END_NAMESPACE
+
+QT_END_HEADER
+
+#endif