|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies). |
|
4 ** All rights reserved. |
|
5 ** Contact: Nokia Corporation (qt-info@nokia.com) |
|
6 ** |
|
7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit. |
|
8 ** |
|
9 ** $QT_BEGIN_LICENSE:LGPL$ |
|
10 ** No Commercial Usage |
|
11 ** This file contains pre-release code and may not be distributed. |
|
12 ** You may use this file in accordance with the terms and conditions |
|
13 ** contained in the Technology Preview License Agreement accompanying |
|
14 ** this package. |
|
15 ** |
|
16 ** GNU Lesser General Public License Usage |
|
17 ** Alternatively, this file may be used under the terms of the GNU Lesser |
|
18 ** General Public License version 2.1 as published by the Free Software |
|
19 ** Foundation and appearing in the file LICENSE.LGPL included in the |
|
20 ** packaging of this file. Please review the following information to |
|
21 ** ensure the GNU Lesser General Public License version 2.1 requirements |
|
22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. |
|
23 ** |
|
24 ** In addition, as a special exception, Nokia gives you certain additional |
|
25 ** rights. These rights are described in the Nokia Qt LGPL Exception |
|
26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. |
|
27 ** |
|
28 ** If you have questions regarding the use of this file, please contact |
|
29 ** Nokia at qt-info@nokia.com. |
|
30 ** |
|
31 ** |
|
32 ** |
|
33 ** |
|
34 ** |
|
35 ** |
|
36 ** |
|
37 ** |
|
38 ** $QT_END_LICENSE$ |
|
39 ** |
|
40 ****************************************************************************/ |
|
41 |
|
42 // |
|
43 // W A R N I N G |
|
44 // ------------- |
|
45 // |
|
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. |
|
49 // |
|
50 // We mean it. |
|
51 |
|
52 #ifndef Patternist_NamespaceSupport_H |
|
53 #define Patternist_NamespaceSupport_H |
|
54 |
|
55 #include "qnamepool_p.h" |
|
56 |
|
57 #include <QtCore/QExplicitlySharedDataPointer> |
|
58 #include <QtCore/QHash> |
|
59 #include <QtCore/QSet> |
|
60 #include <QtCore/QStack> |
|
61 #include <QtCore/QXmlStreamNamespaceDeclarations> |
|
62 |
|
63 QT_BEGIN_HEADER |
|
64 |
|
65 QT_BEGIN_NAMESPACE |
|
66 |
|
67 namespace QPatternist |
|
68 { |
|
69 /** |
|
70 * @short A helper class for handling nested namespace declarations. |
|
71 * |
|
72 * This class is mostly an adaption of QXmlNamespaceSupport to the NamePool |
|
73 * mechanism used in XmlPatterns. |
|
74 * |
|
75 * @ingroup Patternist_schema |
|
76 * @author Tobias Koenig <tobias.koenig@nokia.com> |
|
77 */ |
|
78 class NamespaceSupport |
|
79 { |
|
80 public: |
|
81 /** |
|
82 * Describes whether the name to process is an attribute or element. |
|
83 */ |
|
84 enum NameType |
|
85 { |
|
86 AttributeName, ///< An attribute name to process. |
|
87 ElementName ///< An element name to process. |
|
88 }; |
|
89 |
|
90 /** |
|
91 * Creates an empty namespace support object. |
|
92 */ |
|
93 NamespaceSupport(); |
|
94 |
|
95 /** |
|
96 * Creates a new namespace support object. |
|
97 * |
|
98 * @param namePool The name pool where all processed names are stored in. |
|
99 */ |
|
100 NamespaceSupport(const NamePool::Ptr &namePool); |
|
101 |
|
102 /** |
|
103 * Adds a new prefix-to-namespace binding. |
|
104 * |
|
105 * @param prefixCode The name pool code for the prefix. |
|
106 * @param namespaceCode The name pool code for the namespace. |
|
107 */ |
|
108 void setPrefix(const QXmlName::PrefixCode prefixCode, const QXmlName::NamespaceCode namespaceCode); |
|
109 |
|
110 /** |
|
111 * Adds the prefix-to-namespace bindings from @p declarations to |
|
112 * the namespace support. |
|
113 */ |
|
114 void setPrefixes(const QXmlStreamNamespaceDeclarations &declarations); |
|
115 |
|
116 /** |
|
117 * Sets the name pool code of the target namespace of the schema the |
|
118 * namespace support works on. |
|
119 */ |
|
120 void setTargetNamespace(const QXmlName::NamespaceCode code); |
|
121 |
|
122 /** |
|
123 * Returns the prefix code for the given namespace @p code. |
|
124 */ |
|
125 QXmlName::PrefixCode prefix(const QXmlName::NamespaceCode code) const; |
|
126 |
|
127 /** |
|
128 * Returns the namespace code for the given prefix @p code. |
|
129 */ |
|
130 QXmlName::NamespaceCode uri(const QXmlName::PrefixCode code) const; |
|
131 |
|
132 /** |
|
133 * Converts the given @p qualifiedName to a resolved QXmlName @p name according |
|
134 * to the current namespace mapping. |
|
135 * |
|
136 * @param qualifiedName The full qualified name. |
|
137 * @param type The type of name processing. |
|
138 * @param name The resolved QXmlName. |
|
139 * |
|
140 * @returns @c true if the name could be processed correctly or @c false if the |
|
141 * namespace prefix is unknown. |
|
142 */ |
|
143 bool processName(const QString &qualifiedName, NameType type, QXmlName &name) const; |
|
144 |
|
145 /** |
|
146 * Pushes the current namespace mapping onto the stack. |
|
147 */ |
|
148 void pushContext(); |
|
149 |
|
150 /** |
|
151 * Pops the current namespace mapping from the stack. |
|
152 */ |
|
153 void popContext(); |
|
154 |
|
155 /** |
|
156 * Returns the list of namespace bindings. |
|
157 */ |
|
158 QList<QXmlName> namespaceBindings() const; |
|
159 |
|
160 private: |
|
161 typedef QHash<QXmlName::PrefixCode, QXmlName::NamespaceCode> NamespaceHash; |
|
162 |
|
163 NamePool::Ptr m_namePool; |
|
164 QStack<NamespaceHash> m_nsStack; |
|
165 NamespaceHash m_ns; |
|
166 }; |
|
167 } |
|
168 |
|
169 QT_END_NAMESPACE |
|
170 |
|
171 QT_END_HEADER |
|
172 |
|
173 #endif |