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_XsdWildcard_H
51#define Patternist_XsdWildcard_H
52
53#include <private/qxsdterm_p.h>
54
55#include <QtCore/QSet>
56
57QT_BEGIN_NAMESPACE
58
59namespace QPatternist
60{
61 /**
62 * @short Represents a XSD wildcard object.
63 *
64 * This class represents the <em>wildcard</em> object of a XML schema as described
65 * <a href="http://www.w3.org/TR/xmlschema11-1/#Wildcards">here</a>.
66 *
67 * It contains information from either an <em>any</em> object or an <em>anyAttribute</em> object.
68 *
69 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSWildcard">XML Schema API reference</a>
70 * @ingroup Patternist_schema
71 * @author Tobias Koenig <tobias.koenig@nokia.com>
72 */
73 class XsdWildcard : public XsdTerm
74 {
75 public:
76 typedef QExplicitlySharedDataPointer<XsdWildcard> Ptr;
77
78 /**
79 * Defines the absent namespace that is used in wildcards.
80 */
81 static QString absentNamespace();
82
83 /**
84 * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#w-namespace_constraint">namespace constraint</a> of the wildcard.
85 */
86 class NamespaceConstraint : public QSharedData
87 {
88 public:
89 typedef QExplicitlySharedDataPointer<NamespaceConstraint> Ptr;
90
91 /**
92 * Describes the variety of the namespace constraint.
93 *
94 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nc-variety">Variety Definition</a>
95 */
96 enum Variety
97 {
98 Any, ///< Any namespace is allowed.
99 Enumeration, ///< Namespaces in the namespaces set are allowed.
100 Not ///< Namespaces in the namespaces set are not allowed.
101 };
102
103 /**
104 * Sets the @p variety of the namespace constraint.
105 *
106 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nc-variety">Variety Definition</a>
107 */
108 void setVariety(Variety variety);
109
110 /**
111 * Returns the variety of the namespace constraint.
112 */
113 Variety variety() const;
114
115 /**
116 * Sets the set of @p namespaces of the namespace constraint.
117 */
118 void setNamespaces(const QSet<QString> &namespaces);
119
120 /**
121 * Returns the set of namespaces of the namespace constraint.
122 */
123 QSet<QString> namespaces() const;
124
125 /**
126 * Sets the set of disallowed @p names of the namespace constraint.
127 */
128 void setDisallowedNames(const QSet<QString> &names);
129
130 /**
131 * Returns the set of disallowed names of the namespace constraint.
132 */
133 QSet<QString> disallowedNames() const;
134
135 private:
136 Variety m_variety;
137 QSet<QString> m_namespaces;
138 QSet<QString> m_disallowedNames;
139 };
140
141 /**
142 * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#w-process_contents">type of content processing</a> of the wildcard.
143 */
144 enum ProcessContents
145 {
146 Strict, ///< There must be a top-level declaration for the item available, or the item must have an xsi:type, and the item must be valid as appropriate.
147 Lax, ///< If the item has a uniquely determined declaration available, it must be valid with respect to that definition.
148 Skip ///< No constraints at all: the item must simply be well-formed XML.
149 };
150
151 /**
152 * Creates a new wildcard object.
153 */
154 XsdWildcard();
155
156 /**
157 * Returns always @c true, used to avoid dynamic casts.
158 */
159 virtual bool isWildcard() const;
160
161 /**
162 * Sets the namespace @p constraint of the wildcard.
163 *
164 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#w-namespace_constraint">Namespace Constraint Definition</a>
165 */
166 void setNamespaceConstraint(const NamespaceConstraint::Ptr &constraint);
167
168 /**
169 * Returns the namespace constraint of the wildcard.
170 */
171 NamespaceConstraint::Ptr namespaceConstraint() const;
172
173 /**
174 * Sets the process @p contents of the wildcard.
175 *
176 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#w-process_contents">Process Contents Definition</a>
177 */
178 void setProcessContents(ProcessContents contents);
179
180 /**
181 * Returns the process contents of the wildcard.
182 */
183 ProcessContents processContents() const;
184
185 private:
186 NamespaceConstraint::Ptr m_namespaceConstraint;
187 ProcessContents m_processContents;
188 };
189}
190
191QT_END_NAMESPACE
192
193#endif
194

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