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_NCNameConstructor_H
51#define Patternist_NCNameConstructor_H
52
53#include <private/qsinglecontainer_p.h>
54#include <private/qpatternistlocale_p.h>
55#include <private/qxmlutils_p.h>
56
57QT_BEGIN_NAMESPACE
58
59namespace QPatternist
60{
61 /**
62 * @short Ensures the lexical space of the string value of the Item returned
63 * from its child Expression is an NCName.
64 *
65 * @note It doesn't actually construct an @c xs:NCName. It only ensures the lexical
66 * space is an @c NCName. The atomic value can be of any string type, such as @c xs:untypedAtomic
67 * of @c xs:string.
68 *
69 * @author Frans Englich <frans.englich@nokia.com>
70 * @ingroup Patternist_expressions
71 */
72 class NCNameConstructor : public SingleContainer
73 {
74 public:
75
76 NCNameConstructor(const Expression::Ptr &source);
77
78 virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
79
80 virtual SequenceType::List expectedOperandTypes() const;
81
82 virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
83 const SequenceType::Ptr &reqType);
84
85 virtual SequenceType::Ptr staticType() const;
86
87 virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
88
89 /**
90 * Validates @p lexicalNCName as a processing instruction's target
91 * name, and raise an error if it's not an @c NCName.
92 */
93 template<typename TReportContext,
94 const ReportContext::ErrorCode NameIsXML,
95 const ReportContext::ErrorCode LexicallyInvalid>
96 static inline
97 void validateTargetName(const QString &lexicalNCName,
98 const TReportContext &context,
99 const SourceLocationReflection *const r);
100 private:
101
102 /**
103 * This translation string is put here in order to avoid duplicate messages and
104 * hence reduce work for translators and increase consistency.
105 */
106 static
107 const QString nameIsXML(const QString &lexTarget)
108 {
109 return QtXmlPatterns::tr(sourceText: "The target name in a processing instruction "
110 "cannot be %1 in any combination of upper "
111 "and lower case. Therefore, %2 is invalid.")
112 .arg(args: formatKeyword(keyword: "xml"), args: formatKeyword(keyword: lexTarget));
113 }
114 };
115
116 template<typename TReportContext,
117 const ReportContext::ErrorCode NameIsXML,
118 const ReportContext::ErrorCode LexicallyInvalid>
119 inline
120 void NCNameConstructor::validateTargetName(const QString &lexicalTarget,
121 const TReportContext &context,
122 const SourceLocationReflection *const r)
123 {
124 Q_ASSERT(context);
125
126 if(QXmlUtils::isNCName(ncName: lexicalTarget))
127 {
128 if(QString::compare(s1: QLatin1String("xml"), s2: lexicalTarget, cs: Qt::CaseInsensitive) == 0)
129 context->error(nameIsXML(lexTarget: lexicalTarget), NameIsXML, r);
130 }
131 else
132 {
133 context->error(QtXmlPatterns::tr(sourceText: "%1 is not a valid target name in "
134 "a processing instruction. It "
135 "must be a %2 value, e.g. %3.")
136 .arg(a: formatKeyword(keyword: lexicalTarget))
137 .arg(formatType(context->namePool(),
138 BuiltinTypes::xsNCName))
139 .arg(formatKeyword(keyword: "my-name.123")),
140 LexicallyInvalid,
141 r);
142 }
143 }
144}
145
146QT_END_NAMESPACE
147
148#endif
149

source code of qtxmlpatterns/src/xmlpatterns/expr/qncnameconstructor_p.h