1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2015 The Qt Company Ltd. 4 ** Contact: http://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 http://www.qt.io/terms-conditions. For further 15 ** information use the contact form at http://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 2.1 or version 3 as published by the Free 20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and 21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the 22 ** following information to ensure the GNU Lesser General Public License 23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and 24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. 25 ** 26 ** As a special exception, The Qt Company gives you certain additional 27 ** rights. These rights are described in The Qt Company LGPL Exception 28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package. 29 ** 30 ** GNU General Public License Usage 31 ** Alternatively, this file may be used under the terms of the GNU 32 ** General Public License version 3.0 as published by the Free Software 33 ** Foundation and appearing in the file LICENSE.GPL included in the 34 ** packaging of this file. Please review the following information to 35 ** ensure the GNU General Public License version 3.0 requirements will be 36 ** met: http://www.gnu.org/copyleft/gpl.html. 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(NamePool &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 *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 174