summaryrefslogtreecommitdiff
path: root/src/xmlpatterns/schema/qxsdvalidatinginstancereader_p.h
blob: 03c184397a9e8f774c3b9dcefd9635d39d2b6180 (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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
/****************************************************************************
**
** Copyright (C) 2013 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** 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 Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/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 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, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.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_XsdValidatingInstanceReader_H
#define Patternist_XsdValidatingInstanceReader_H

#include <private/qxsdidchelper_p.h>
#include <private/qxsdinstancereader_p.h>
#include <private/qxsdstatemachine_p.h>
#include <private/qxsdvalidatedxmlnodemodel_p.h>

#include <QtCore/QStack>

QT_BEGIN_NAMESPACE

class QXmlQuery;

namespace QPatternist
{
    /**
     * @short The validating schema instance reader.
     *
     * This class reads in a xml instance document from a QAbstractXmlNodeModel and
     * validates it against a given xml schema.
     *
     * @ingroup Patternist_schema
     * @author Tobias Koenig <tobias.koenig@nokia.com>
     */
    class XsdValidatingInstanceReader : public XsdInstanceReader
    {
        public:
            typedef QExplicitlySharedDataPointer<XsdValidatingInstanceReader> Ptr;

            /**
             * Creates a new validating instance reader that reads the data from
             * the given @p model.
             *
             * @param model The model the data shall be read from.
             * @param documentUri The uri of the document the model is from.
             * @param context The context that is used to report errors etc.
             */
            XsdValidatingInstanceReader(XsdValidatedXmlNodeModel *model, const QUrl &documentUri, const XsdSchemaContext::Ptr &context);

            /**
             * Adds a new @p schema to the pool of schemas that shall be used
             * for validation.
             * The schema is located at the given @p url.
             */
            void addSchema(const XsdSchema::Ptr &schema, const QUrl &url);

            /**
             * Reads and validates the instance document.
             */
            bool read();

        private:
            /**
             * Loads a schema with the given @p targetNamespace from the given @p location
             * and adds it to the pool of schemas that are used for validation.
             *
             * This method is used to load schemas defined in the xsi:schemaLocation or
             * xsi:noNamespaceSchemaLocation attributes in the instance document.
             */
            bool loadSchema(const QString &targetNamespace, const QUrl &location);

            /**
             * Reports an error via the report context.
             */
            void error(const QString &msg) const;

            /**
             * Validates the current element tag of the instance document.
             *
             * @param hasStateMachine Used to remember whether this element represents the start tag
             *                        of a complex type and therefor pushes a new state machine on the stack.
             * @param element Used to remember which element has been validated in this step.
             */
            bool validate(bool &hasStateMachine, XsdElement::Ptr &element);

            /**
             * Validates the current tag of the instance document against the given element @p declaration.
             *
             * @param declaration The element declaration to validate against.
             * @param hasStateMachine Used to remember whether this element represents the start tag
             *                        of a complex type and therefor pushes a new state machine on the stack.
             */
            bool validateElement(const XsdElement::Ptr &declaration, bool &hasStateMachine);

            /**
             * Validates the current tag of the instance document against the given @p type of the element @p declaration.
             *
             * @param declaration The element declaration to validate against.
             * @param type The type to validate against.
             * @param isNilled Defines whether the element is nilled by the instance document.
             * @param hasStateMachine Used to remember whether this element represents the start tag
             *                        of a complex type and therefor pushes a new state machine on the stack.
             *
             * @note The @p type can differ from the element @p declaration type if the instance document has defined
             *       it via xsi:type attribute.
             */
            bool validateElementType(const XsdElement::Ptr &declaration, const SchemaType::Ptr &type, bool isNilled, bool &hasStateMachine);

            /**
             * Validates the current tag of the instance document against the given simple @p type of the element @p declaration.
             *
             * @param declaration The element declaration to validate against.
             * @param type The type to validate against.
             * @param isNilled Defines whether the element is nilled by the instance document.
             *
             * @note The @p type can differ from the element @p declaration type if the instance document has defined
             *       it via xsi:type attribute.
             */
            bool validateElementSimpleType(const XsdElement::Ptr &declaration, const SchemaType::Ptr &type, bool isNilled);

            /**
             * Validates the current tag of the instance document against the given complex @p type of the element @p declaration.
             *
             * @param declaration The element declaration to validate against.
             * @param type The type to validate against.
             * @param isNilled Defines whether the element is nilled by the instance document.
             * @param hasStateMachine Used to remember whether this element represents the start tag
             *                        of a complex type and therefor pushes a new state machine on the stack.
             *
             * @note The @p type can differ from the element @p declaration type if the instance document has defined
             *       it via xsi:type attribute.
             */
            bool validateElementComplexType(const XsdElement::Ptr &declaration, const SchemaType::Ptr &type, bool isNilled, bool &hasStateMachine);

            /**
             * Validates the given @p value against the attribute use @p declaration.
             */
            bool validateAttribute(const XsdAttributeUse::Ptr &declaration, const QString &value);

            /**
             * Validates the given @p value against the attribute @p declaration.
             */
            bool validateAttribute(const XsdAttribute::Ptr &declaration, const QString &value);

            /**
             * Validates the given @p attributeName against the @p wildcard.
             */
            bool validateAttributeWildcard(const QXmlName &attributeName, const XsdWildcard::Ptr &wildcard);

            /**
             * Validates the identity constraints of an @p element.
             */
            bool validateIdentityConstraint(const XsdElement::Ptr &element, const QXmlItem &currentItem);

            /**
             * Validates the <em>unique</em> identity @p constraint of the @p element.
             */
            bool validateUniqueIdentityConstraint(const XsdElement::Ptr &element, const XsdIdentityConstraint::Ptr &constraint, const TargetNode::Set &qualifiedNodeSet);

            /**
             * Validates the <em>key</em> identity @p constraint of the @p element.
             */
            bool validateKeyIdentityConstraint(const XsdElement::Ptr &element, const XsdIdentityConstraint::Ptr &constraint, const TargetNode::Set &targetNodeSet, const TargetNode::Set &qualifiedNodeSet);

            /**
             * Validates the <em>keyref</em> identity @p constraint of the @p element.
             */
            bool validateKeyRefIdentityConstraint(const XsdElement::Ptr &element, const XsdIdentityConstraint::Ptr &constraint, const TargetNode::Set &qualifiedNodeSet);

            /**
             * Selects two sets of nodes that match the given identity @p constraint.
             *
             * @param element The element the identity constraint belongs to.
             * @param currentItem The current element that will be used as focus for the XQuery.
             * @param constraint The constraint (selector and fields) that describe the two sets.
             * @param targetNodeSet The target node set as defined by the schema specification.
             * @param qualifiedNodeSet The qualified node set as defined by the schema specification.
             */
            bool selectNodeSets(const XsdElement::Ptr &element, const QXmlItem &currentItem, const XsdIdentityConstraint::Ptr &constraint, TargetNode::Set &targetNodeSet, TargetNode::Set &qualifiedNodeSet);

            /**
             * Creates an QXmlQuery object with the defined @p namespaceBindings that has the @p contextNode as focus
             * and will execute @p query.
             */
            QXmlQuery createXQuery(const QList<QXmlName> &namespaceBindings, const QXmlItem &contextNode, const QString &query) const;

            /**
             * Returns the element declaration with the given @p name from the pool of all schemas.
             */
            XsdElement::Ptr elementByName(const QXmlName &name) const;

            /**
             * Returns the attribute declaration with the given @p name from the pool of all schemas.
             */
            XsdAttribute::Ptr attributeByName(const QXmlName &name) const;

            /**
             * Returns the type declaration with the given @p name from the pool of all schemas.
             */
            SchemaType::Ptr typeByName(const QXmlName &name) const;

            /**
             * Adds the ID/IDREF binding to the validated model and checks for duplicates.
             */
            void addIdIdRefBinding(const QString &id, const NamedSchemaComponent::Ptr &binding);

            /**
             * Helper method that reads an attribute of type xs:QName and does
             * syntax checking.
             */
            QString qNameAttribute(const QXmlName &attributeName);

            /**
             * Returns the xs:anyType that is used to build up the state machine.
             * We need that as the BuiltinTypes::xsAnyType is not a XsdComplexType.
             */
            XsdComplexType::Ptr anyType();

            /**
             * Helper method that creates a state machine for the given @p particle
             * and pushes it on the state machine stack.
             */
            void createAndPushStateMachine(const XsdParticle::Ptr &particle);

            typedef QHash<QUrl, QStringList> MergedSchemas;
            typedef QHashIterator<QUrl, QStringList> MergedSchemasIterator;

            XsdValidatedXmlNodeModel::Ptr               m_model;
            MergedSchemas                               m_mergedSchemas;
            XsdSchema::Ptr                              m_schema;
            const NamePool::Ptr                         m_namePool;
            const QXmlName                              m_xsiNilName;
            const QXmlName                              m_xsiTypeName;
            const QXmlName                              m_xsiSchemaLocationName;
            const QXmlName                              m_xsiNoNamespaceSchemaLocationName;

            QStack<XsdStateMachine<XsdTerm::Ptr> >      m_stateMachines;
            QUrl                                        m_documentUri;
            XsdComplexType::Ptr                         m_anyType;
            QSet<QString>                               m_processedNamespaces;
            QSet<QString>                               m_processedSchemaLocations;
            QSet<QString>                               m_idRefs;
            QHash<QXmlName, TargetNode::Set>            m_idcKeys;
            SchemaType::Ptr                             m_idRefsType;
    };
}

QT_END_NAMESPACE

#endif