1 /****************************************************************************
3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/legal
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and Digia. For licensing terms and
14 ** conditions see http://qt.digia.com/licensing. For further information
15 ** use the contact form at http://qt.digia.com/contact-us.
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 as published by the Free Software
20 ** Foundation and appearing in the file LICENSE.LGPL included in the
21 ** packaging of this file. Please review the following information to
22 ** ensure the GNU Lesser General Public License version 2.1 requirements
23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 ** In addition, as a special exception, Digia gives you certain additional
26 ** rights. These rights are described in the Digia Qt LGPL Exception
27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 ** GNU General Public License Usage
30 ** Alternatively, this file may be used under the terms of the GNU
31 ** General Public License version 3.0 as published by the Free Software
32 ** Foundation and appearing in the file LICENSE.GPL included in the
33 ** packaging of this file. Please review the following information to
34 ** ensure the GNU General Public License version 3.0 requirements will be
35 ** met: http://www.gnu.org/copyleft/gpl.html.
40 ****************************************************************************/
46 // This file is not part of the Qt API. It exists purely as an
47 // implementation detail. This header file may change from version to
48 // version without notice, or even be removed.
52 #ifndef Patternist_XsdStateMachineBuilder_H
53 #define Patternist_XsdStateMachineBuilder_H
55 #include <private/qxsdparticle_p.h>
56 #include <private/qxsdstatemachine_p.h>
57 #include <private/qxsdterm_p.h>
59 #include <QtCore/QExplicitlySharedDataPointer>
60 #include <QtCore/QList>
69 * @short A helper class to build up validation state machines.
71 * @ingroup Patternist_schema
72 * @author Tobias Koenig <tobias.koenig@nokia.com>
74 class XsdStateMachineBuilder : public QSharedData
77 typedef QExplicitlySharedDataPointer<XsdStateMachineBuilder> Ptr;
86 * Creates a new state machine builder.
88 * @param machine The state machine it should work on.
89 * @param namePool The name pool used by all schema components.
90 * @param mode The mode the machine shall be build for.
92 XsdStateMachineBuilder(XsdStateMachine<XsdTerm::Ptr> *machine, const NamePool::Ptr &namePool, Mode mode = CheckingMode);
95 * Resets the state machine.
97 * @returns The initial end state.
99 XsdStateMachine<XsdTerm::Ptr>::StateId reset();
102 * Prepends a start state to the given @p state.
103 * That is needed to allow the conversion of the state machine from a FSA to a DFA.
105 XsdStateMachine<XsdTerm::Ptr>::StateId addStartState(XsdStateMachine<XsdTerm::Ptr>::StateId state);
108 * Creates the state machine for the given @p particle that should have the
111 * @returns The new start state.
113 XsdStateMachine<XsdTerm::Ptr>::StateId buildParticle(const XsdParticle::Ptr &particle, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
116 * Creates the state machine for the given @p term that should have the
119 * @returns The new start state.
121 XsdStateMachine<XsdTerm::Ptr>::StateId buildTerm(const XsdTerm::Ptr &term, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
124 * Returns a hash that maps each term that appears inside @p particle, to the particle it belongs.
126 * @note These information are used by XsdParticleChecker to check particle inheritance.
128 static QHash<XsdTerm::Ptr, XsdParticle::Ptr> particleLookupMap(const XsdParticle::Ptr &particle);
131 XsdStateMachine<XsdTerm::Ptr> *m_stateMachine;
132 NamePool::Ptr m_namePool;