|
1 /**************************************************************************** |
|
2 ** |
|
3 ** Copyright (C) 2009 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_XPathHelper_H |
|
53 #define Patternist_XPathHelper_H |
|
54 |
|
55 #include "qcommonnamespaces_p.h" |
|
56 #include "qitem_p.h" |
|
57 #include "qpatternistlocale_p.h" |
|
58 #include "qreportcontext_p.h" |
|
59 |
|
60 QT_BEGIN_HEADER |
|
61 |
|
62 QT_BEGIN_NAMESPACE |
|
63 |
|
64 namespace QPatternist |
|
65 { |
|
66 /** |
|
67 * @short Contains helper and utility functions. |
|
68 * |
|
69 * The common denominator of its functions is that they do not fit in |
|
70 * well elsewhere, such as in a particular class. It is preferred if XPathHelper |
|
71 * goes away, and that functions are in more specific classes. |
|
72 * |
|
73 * @ingroup Patternist |
|
74 * @author Frans Englich <frans.englich@nokia.com> |
|
75 */ |
|
76 class XPathHelper |
|
77 { |
|
78 public: |
|
79 /** |
|
80 * Determines whether @p qName is a valid QName. For example, "body" and "xhtml:body" |
|
81 * is, but "xhtml::body" or "x:body "(note the whitespace) is not. |
|
82 * |
|
83 * @see QNameConstructor::expandQName() |
|
84 * @see QNameValue |
|
85 */ |
|
86 static bool isQName(const QString &qName); |
|
87 |
|
88 /** |
|
89 * @short Splits @p qName into @p localName and @p prefix. |
|
90 * |
|
91 * @note @p qName must be a valid QName, and that is not checked. |
|
92 */ |
|
93 static void splitQName(const QString &qName, QString &prefix, QString &localName); |
|
94 |
|
95 /** |
|
96 * Determines whether @p ns is a reserved namespace. |
|
97 * |
|
98 * @see <a href="http://www.w3.org/TR/xslt20/#reserved-namespaces">XSL Transformations |
|
99 * (XSLT) Version 2.0, 3.2 Reserved Namespaces</a> |
|
100 * @see <a href="http://www.w3.org/TR/xquery/#FunctionDeclns">XQuery 1.0: An XML |
|
101 * Query Language, 4.15 Function Declaration</a> |
|
102 * @returns @c true if @p ns is a reserved namespace, otherwise @c false. |
|
103 */ |
|
104 static bool isReservedNamespace(const QXmlName::NamespaceCode ns); |
|
105 |
|
106 /** |
|
107 * Determines whether @p collation is a supported string collation. If it is |
|
108 * not, error code @p code is raised via @p context. |
|
109 */ |
|
110 template<const ReportContext::ErrorCode code, typename TReportContext> |
|
111 static inline void checkCollationSupport(const QString &collation, |
|
112 const TReportContext &context, |
|
113 const SourceLocationReflection *const r) |
|
114 { |
|
115 Q_ASSERT(context); |
|
116 Q_ASSERT(r); |
|
117 |
|
118 if(collation != QLatin1String(CommonNamespaces::UNICODE_COLLATION)) |
|
119 { |
|
120 context->error(QtXmlPatterns::tr("Only the Unicode Codepoint " |
|
121 "Collation is supported(%1). %2 is unsupported.") |
|
122 .arg(formatURI(QLatin1String(CommonNamespaces::UNICODE_COLLATION))) |
|
123 .arg(formatURI(collation)), |
|
124 code, r); |
|
125 } |
|
126 } |
|
127 |
|
128 static QPatternist::ItemTypePtr typeFromKind(const QXmlNodeModelIndex::NodeKind nodeKind); |
|
129 |
|
130 /** |
|
131 * Normalizes an @p uri by resolving it to the application directory if empty. |
|
132 */ |
|
133 static QUrl normalizeQueryURI(const QUrl &uri); |
|
134 |
|
135 /** |
|
136 * @short Determines whether @p consists only of whitespace. Characters |
|
137 * considered whitespace are the ones for which QChar::isSpace() returns @c true for. |
|
138 * |
|
139 * For the empty string, @c true is returned. |
|
140 * |
|
141 * @returns @c true if @p string consists only of whitespace, otherwise @c false. |
|
142 */ |
|
143 static inline bool isWhitespaceOnly(const QStringRef &string) |
|
144 { |
|
145 const int len = string.length(); |
|
146 |
|
147 for(int i = 0; i < len; ++i) |
|
148 { |
|
149 if(!string.at(i).isSpace()) // TODO and this is wrong, see sdk/TODO |
|
150 return false; |
|
151 } |
|
152 |
|
153 return true; |
|
154 } |
|
155 |
|
156 /** |
|
157 * @overload |
|
158 */ |
|
159 static inline bool isWhitespaceOnly(const QString &string) |
|
160 { |
|
161 return isWhitespaceOnly(QStringRef(&string)); |
|
162 } |
|
163 |
|
164 private: |
|
165 /** |
|
166 * @short This default constructor has no definition, in order to avoid |
|
167 * instantiation, since it makes no sense to instantiate this class. |
|
168 */ |
|
169 inline XPathHelper(); |
|
170 |
|
171 Q_DISABLE_COPY(XPathHelper) |
|
172 }; |
|
173 } |
|
174 |
|
175 QT_END_NAMESPACE |
|
176 |
|
177 QT_END_HEADER |
|
178 |
|
179 #endif |