summaryrefslogtreecommitdiff
path: root/src/xmlpatterns/schema/qxsdschemaparsercontext_p.h
blob: f35a9b3696d91073ca2a18d426ff0e9f24ab5f23 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtXmlPatterns module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $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_XsdSchemaParserContext_H
#define Patternist_XsdSchemaParserContext_H

#include <private/qmaintainingreader_p.h> // for definition of ElementDescription
#include <private/qxsdschematoken_p.h>
#include <private/qxsdschema_p.h>
#include <private/qxsdschemachecker_p.h>
#include <private/qxsdschemacontext_p.h>
#include <private/qxsdschemaresolver_p.h>

#include <QtCore/QSharedData>

QT_BEGIN_NAMESPACE

namespace QPatternist
{
    /**
     * @short A namespace class that contains identifiers for the different
     *        scopes a tag from the xml schema spec can appear in.
     */
    class XsdTagScope
    {
        public:
            enum Type
            {
                Schema,
                Include,
                Import,
                Redefine,
                Annotation,
                AppInfo,
                Documentation,
                GlobalSimpleType,
                LocalSimpleType,
                SimpleRestriction,
                List,
                Union,
                MinExclusiveFacet,
                MinInclusiveFacet,
                MaxExclusiveFacet,
                MaxInclusiveFacet,
                TotalDigitsFacet,
                FractionDigitsFacet,
                LengthFacet,
                MinLengthFacet,
                MaxLengthFacet,
                EnumerationFacet,
                WhiteSpaceFacet,
                PatternFacet,
                GlobalComplexType,
                LocalComplexType,
                SimpleContent,
                SimpleContentRestriction,
                SimpleContentExtension,
                ComplexContent,
                ComplexContentRestriction,
                ComplexContentExtension,
                NamedGroup,
                ReferredGroup,
                All,
                LocalAll,
                Choice,
                LocalChoice,
                Sequence,
                LocalSequence,
                GlobalAttribute,
                LocalAttribute,
                NamedAttributeGroup,
                ReferredAttributeGroup,
                GlobalElement,
                LocalElement,
                Unique,
                Key,
                KeyRef,
                Selector,
                Field,
                Notation,
                Any,
                AnyAttribute,
                Alternative,
                Assert,
                Assertion,
                OpenContent,
                DefaultOpenContent,
                Override
            };
    };

    /**
     * A hash that keeps the mapping between the single components that can appear
     * in a schema document (e.g. elements, attributes, type definitions) and their
     * source locations inside the document.
     */
    typedef QHash<NamedSchemaComponent::Ptr, QSourceLocation> ComponentLocationHash;

    /**
     * @short A context for schema parsing.
     *
     * This class provides a context for all components that are
     * nedded for parsing and compiling the XML schema.
     *
     * @ingroup Patternist_schema
     * @author Tobias Koenig <tobias.koenig@nokia.com>
     */
    class XsdSchemaParserContext : public QSharedData
    {
        public:
            /**
             * A smart pointer wrapping XsdSchemaParserContext instances.
             */
            typedef QExplicitlySharedDataPointer<XsdSchemaParserContext> Ptr;

            /**
             * Creates a new schema parser context object.
             *
             * @param namePool The name pool where all names of the schema will be stored in.
             * @param context The schema context to use for error reporting etc.
             */
            XsdSchemaParserContext(const NamePool::Ptr &namePool, const XsdSchemaContext::Ptr &context);

            /**
             * Returns the name pool of the schema parser context.
             */
            NamePool::Ptr namePool() const;

            /**
             * Returns the schema resolver of the schema context.
             */
            XsdSchemaResolver::Ptr resolver() const;

            /**
             * Returns the schema resolver of the schema context.
             */
            XsdSchemaChecker::Ptr checker() const;

            /**
             * Returns the schema object of the schema context.
             */
            XsdSchema::Ptr schema() const;

            /**
             * Returns the element descriptions for the schema parser.
             *
             * The element descriptions are a fast lookup table for
             * verifying whether certain attributes are allowed for
             * a given element type.
             */
            ElementDescription<XsdSchemaToken, XsdTagScope::Type>::Hash elementDescriptions() const;

            /**
             * Returns an unique name that is used by the schema parser
             * for anonymous types.
             *
             * @param targetNamespace The namespace of the name.
             */
            QXmlName createAnonymousName(const QString &targetNamespace) const;

        private:
            /**
             * Fills the element description hash with the required and prohibited
             * attributes.
             */
            static ElementDescription<XsdSchemaToken, XsdTagScope::Type>::Hash setupElementDescriptions();

            NamePool::Ptr                                                     m_namePool;
            XsdSchema::Ptr                                                    m_schema;
            XsdSchemaChecker::Ptr                                             m_checker;
            XsdSchemaResolver::Ptr                                            m_resolver;
            const ElementDescription<XsdSchemaToken, XsdTagScope::Type>::Hash m_elementDescriptions;
            mutable QAtomicInt                                                m_anonymousNameCounter;
    };
}

QT_END_NAMESPACE

#endif