1/****************************************************************************
2**
3** Copyright (C) 2016 The Qt Company Ltd.
4** Contact: https://www.qt.io/licensing/
5**
6** This file is part of the QtXmlPatterns module of the Qt Toolkit.
7**
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 The Qt Company. For licensing terms
14** and conditions see https://www.qt.io/terms-conditions. For further
15** information use the contact form at https://www.qt.io/contact-us.
16**
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 3 as published by the Free Software
20** Foundation and appearing in the file LICENSE.LGPL3 included in the
21** packaging of this file. Please review the following information to
22** ensure the GNU Lesser General Public License version 3 requirements
23** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
24**
25** GNU General Public License Usage
26** Alternatively, this file may be used under the terms of the GNU
27** General Public License version 2.0 or (at your option) the GNU General
28** Public license version 3 or any later version approved by the KDE Free
29** Qt Foundation. The licenses are as published by the Free Software
30** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
31** included in the packaging of this file. Please review the following
32** information to ensure the GNU General Public License requirements will
33** be met: https://www.gnu.org/licenses/gpl-2.0.html and
34** https://www.gnu.org/licenses/gpl-3.0.html.
35**
36** $QT_END_LICENSE$
37**
38****************************************************************************/
39
40//
41// W A R N I N G
42// -------------
43//
44// This file is not part of the Qt API. It exists purely as an
45// implementation detail. This header file may change from version to
46// version without notice, or even be removed.
47//
48// We mean it.
49
50#ifndef Patternist_XsdStateMachineBuilder_H
51#define Patternist_XsdStateMachineBuilder_H
52
53#include <private/qxsdparticle_p.h>
54#include <private/qxsdstatemachine_p.h>
55#include <private/qxsdterm_p.h>
56
57#include <QtCore/QExplicitlySharedDataPointer>
58#include <QtCore/QList>
59
60QT_BEGIN_NAMESPACE
61
62namespace QPatternist
63{
64 /**
65 * @short A helper class to build up validation state machines.
66 *
67 * @ingroup Patternist_schema
68 * @author Tobias Koenig <tobias.koenig@nokia.com>
69 */
70 class XsdStateMachineBuilder : public QSharedData
71 {
72 public:
73 typedef QExplicitlySharedDataPointer<XsdStateMachineBuilder> Ptr;
74
75 enum Mode
76 {
77 CheckingMode,
78 ValidatingMode
79 };
80
81 /**
82 * Creates a new state machine builder.
83 *
84 * @param machine The state machine it should work on.
85 * @param namePool The name pool used by all schema components.
86 * @param mode The mode the machine shall be build for.
87 */
88 XsdStateMachineBuilder(XsdStateMachine<XsdTerm::Ptr> *machine, const NamePool::Ptr &namePool, Mode mode = CheckingMode);
89
90 /**
91 * Resets the state machine.
92 *
93 * @returns The initial end state.
94 */
95 XsdStateMachine<XsdTerm::Ptr>::StateId reset();
96
97 /**
98 * Prepends a start state to the given @p state.
99 * That is needed to allow the conversion of the state machine from a FSA to a DFA.
100 */
101 XsdStateMachine<XsdTerm::Ptr>::StateId addStartState(XsdStateMachine<XsdTerm::Ptr>::StateId state);
102
103 /**
104 * Creates the state machine for the given @p particle that should have the
105 * given @p endState.
106 *
107 * @returns The new start state.
108 */
109 XsdStateMachine<XsdTerm::Ptr>::StateId buildParticle(const XsdParticle::Ptr &particle, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
110
111 /**
112 * Creates the state machine for the given @p term that should have the
113 * given @p endState.
114 *
115 * @returns The new start state.
116 */
117 XsdStateMachine<XsdTerm::Ptr>::StateId buildTerm(const XsdTerm::Ptr &term, XsdStateMachine<XsdTerm::Ptr>::StateId endState);
118
119 /**
120 * Returns a hash that maps each term that appears inside @p particle, to the particle it belongs.
121 *
122 * @note These information are used by XsdParticleChecker to check particle inheritance.
123 */
124 static QHash<XsdTerm::Ptr, XsdParticle::Ptr> particleLookupMap(const XsdParticle::Ptr &particle);
125
126 private:
127 XsdStateMachine<XsdTerm::Ptr> *m_stateMachine;
128 NamePool::Ptr m_namePool;
129 Mode m_mode;
130 };
131}
132
133QT_END_NAMESPACE
134
135#endif
136

source code of qtxmlpatterns/src/xmlpatterns/schema/qxsdstatemachinebuilder_p.h