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_NamespaceResolver_H |
51 | #define Patternist_NamespaceResolver_H |
52 | |
53 | #include <QSharedData> |
54 | #include <QXmlName> |
55 | |
56 | |
57 | QT_BEGIN_NAMESPACE |
58 | |
59 | template<typename A, typename B> class QHash; |
60 | |
61 | namespace QPatternist |
62 | { |
63 | |
64 | /** |
65 | * @short Base class for namespace resolvers. |
66 | * |
67 | * @ingroup Patternist |
68 | * @author Frans Englich <frans.englich@nokia.com> |
69 | */ |
70 | class NamespaceResolver : public QSharedData |
71 | { |
72 | public: |
73 | enum Constants |
74 | { |
75 | NoBinding = -1 |
76 | }; |
77 | |
78 | typedef QExplicitlySharedDataPointer<NamespaceResolver> Ptr; |
79 | |
80 | /** |
81 | * A list of namespace bindings. The key is the prefix, and the value is |
82 | * the namespace URI. |
83 | */ |
84 | typedef QHash<QXmlName::PrefixCode, QXmlName::NamespaceCode> Bindings; |
85 | |
86 | NamespaceResolver(); |
87 | virtual ~NamespaceResolver(); |
88 | |
89 | /** |
90 | * Adds the mapping from @p prefix to @p namespaceURI to |
91 | * this NamespaceResolver. If this NamespaceResolver already contains |
92 | * a binding involving @p prefix, the old binding is replaced. |
93 | */ |
94 | virtual void addBinding(const QXmlName nb) = 0; |
95 | |
96 | /** |
97 | * Resolves the @p prefix to the corresponding namespace URI. If no binding |
98 | * exists for @p prefix, NoBinding is returned. |
99 | * |
100 | * @returns the namespace corresponding to @p prefix. |
101 | */ |
102 | virtual QXmlName::NamespaceCode lookupNamespaceURI(const QXmlName::PrefixCode prefix) const = 0; |
103 | |
104 | /** |
105 | * @returns all bindings this NamespaceResolver handles. |
106 | */ |
107 | virtual Bindings bindings() const = 0; |
108 | }; |
109 | } |
110 | |
111 | QT_END_NAMESPACE |
112 | |
113 | #endif |
114 | |