1 /****************************************************************************
3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
4 ** Contact: http://www.qt-project.org/
6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** GNU Lesser General Public License Usage
10 ** This file may be used under the terms of the GNU Lesser General Public
11 ** License version 2.1 as published by the Free Software Foundation and
12 ** appearing in the file LICENSE.LGPL included in the packaging of this
13 ** file. Please review the following information to ensure the GNU Lesser
14 ** General Public License version 2.1 requirements will be met:
15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
17 ** In addition, as a special exception, Nokia gives you certain additional
18 ** rights. These rights are described in the Nokia Qt LGPL Exception
19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
21 ** GNU General Public License Usage
22 ** Alternatively, this file may be used under the terms of the GNU General
23 ** Public License version 3.0 as published by the Free Software Foundation
24 ** and appearing in the file LICENSE.GPL included in the packaging of this
25 ** file. Please review the following information to ensure the GNU General
26 ** Public License version 3.0 requirements will be met:
27 ** http://www.gnu.org/copyleft/gpl.html.
30 ** Alternatively, this file may be used in accordance with the terms and
31 ** conditions contained in a signed written agreement between you and Nokia.
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_XsdWildcard_H
53 #define Patternist_XsdWildcard_H
55 #include <private/qxsdterm_p.h>
57 #include <QtCore/QSet>
66 * @short Represents a XSD wildcard object.
68 * This class represents the <em>wildcard</em> object of a XML schema as described
69 * <a href="http://www.w3.org/TR/xmlschema11-1/#Wildcards">here</a>.
71 * It contains information from either an <em>any</em> object or an <em>anyAttribute</em> object.
73 * @see <a href="http://www.w3.org/Submission/2004/SUBM-xmlschema-api-20040309/xml-schema-api.html#Interface-XSWildcard">XML Schema API reference</a>
74 * @ingroup Patternist_schema
75 * @author Tobias Koenig <tobias.koenig@nokia.com>
77 class XsdWildcard : public XsdTerm
80 typedef QExplicitlySharedDataPointer<XsdWildcard> Ptr;
83 * Defines the absent namespace that is used in wildcards.
85 static QString absentNamespace();
88 * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#w-namespace_constraint">namespace constraint</a> of the wildcard.
90 class NamespaceConstraint : public QSharedData
93 typedef QExplicitlySharedDataPointer<NamespaceConstraint> Ptr;
96 * Describes the variety of the namespace constraint.
98 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nc-variety">Variety Definition</a>
102 Any, ///< Any namespace is allowed.
103 Enumeration, ///< Namespaces in the namespaces set are allowed.
104 Not ///< Namespaces in the namespaces set are not allowed.
108 * Sets the @p variety of the namespace constraint.
110 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#nc-variety">Variety Definition</a>
112 void setVariety(Variety variety);
115 * Returns the variety of the namespace constraint.
117 Variety variety() const;
120 * Sets the set of @p namespaces of the namespace constraint.
122 void setNamespaces(const QSet<QString> &namespaces);
125 * Returns the set of namespaces of the namespace constraint.
127 QSet<QString> namespaces() const;
130 * Sets the set of disallowed @p names of the namespace constraint.
132 void setDisallowedNames(const QSet<QString> &names);
135 * Returns the set of disallowed names of the namespace constraint.
137 QSet<QString> disallowedNames() const;
141 QSet<QString> m_namespaces;
142 QSet<QString> m_disallowedNames;
146 * Describes the <a href="http://www.w3.org/TR/xmlschema11-1/#w-process_contents">type of content processing</a> of the wildcard.
150 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.
151 Lax, ///< If the item has a uniquely determined declaration available, it must be valid with respect to that definition.
152 Skip ///< No constraints at all: the item must simply be well-formed XML.
156 * Creates a new wildcard object.
161 * Returns always @c true, used to avoid dynamic casts.
163 virtual bool isWildcard() const;
166 * Sets the namespace @p constraint of the wildcard.
168 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#w-namespace_constraint">Namespace Constraint Definition</a>
170 void setNamespaceConstraint(const NamespaceConstraint::Ptr &constraint);
173 * Returns the namespace constraint of the wildcard.
175 NamespaceConstraint::Ptr namespaceConstraint() const;
178 * Sets the process @p contents of the wildcard.
180 * @see <a href="http://www.w3.org/TR/xmlschema11-1/#w-process_contents">Process Contents Definition</a>
182 void setProcessContents(ProcessContents contents);
185 * Returns the process contents of the wildcard.
187 ProcessContents processContents() const;
190 NamespaceConstraint::Ptr m_namespaceConstraint;
191 ProcessContents m_processContents;