src/xmlpatterns/expr/qncnameconstructor_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_NCNameConstructor_H
  53 #define Patternist_NCNameConstructor_H
  54
  55 #include <private/qsinglecontainer_p.h>
  56 #include <private/qpatternistlocale_p.h>
  57 #include <private/qxmlutils_p.h>
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63 namespace QPatternist
  64 {
  65     /**
  66      * @short Ensures the lexical space of the string value of the Item returned
  67      * from its child Expression is an NCName.
  68      *
  69      * @note It doesn't actually construct an @c xs:NCName. It only ensures the lexical
  70      * space is an @c NCName. The atomic value can be of any string type, such as @c xs:untypedAtomic
  71      * of @c xs:string.
  72      *
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      * @ingroup Patternist_expressions
  75      */
  76     class NCNameConstructor : public SingleContainer
  77     {
  78     public:
  79
  80         NCNameConstructor(const Expression::Ptr &source);
  81
  82         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  83
  84         virtual SequenceType::List expectedOperandTypes() const;
  85
  86         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  87                                           const SequenceType::Ptr &reqType);
  88
  89         virtual SequenceType::Ptr staticType() const;
  90
  91         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  92
  93         /**
  94          *  Validates @p lexicalNCName as a processing instruction's target
  95          *  name, and raise an error if it's not an @c  NCName.
  96          */
  97         template<typename TReportContext,
  98                  const ReportContext::ErrorCode NameIsXML,
  99                  const ReportContext::ErrorCode LexicallyInvalid>
 100         static inline
 101         void validateTargetName(const QString &lexicalNCName,
 102                                 const TReportContext &context,
 103                                 const SourceLocationReflection *const r);
 104     private:
 105
 106         /**
 107          * This translation string is put here in order to avoid duplicate messages and
 108          * hence reduce work for translators and increase consistency.
 109          */
 110         static
 111         const QString nameIsXML(const QString &lexTarget)
 112         {
 113             return QtXmlPatterns::tr("The target name in a processing instruction "
 114                                      "cannot be %1 in any combination of upper "
 115                                      "and lower case. Therefore, %2 is invalid.")
 116                 .arg(formatKeyword("xml"), formatKeyword(lexTarget));
 117         }
 118     };
 119
 120     template<typename TReportContext,
 121              const ReportContext::ErrorCode NameIsXML,
 122              const ReportContext::ErrorCode LexicallyInvalid>
 123     inline
 124     void NCNameConstructor::validateTargetName(const QString &lexicalTarget,
 125                                                const TReportContext &context,
 126                                                const SourceLocationReflection *const r)
 127     {
 128         Q_ASSERT(context);
 129
 130         if(QXmlUtils::isNCName(lexicalTarget))
 131         {
 132             if(QString::compare(QLatin1String("xml"), lexicalTarget, Qt::CaseInsensitive) == 0)
 133                 context->error(nameIsXML(lexicalTarget), NameIsXML, r);
 134         }
 135         else
 136         {
 137             context->error(QtXmlPatterns::tr("%1 is not a valid target name in "
 138                                              "a processing instruction. It "
 139                                              "must be a %2 value, e.g. %3.")
 140                            .arg(formatKeyword(lexicalTarget))
 141                            .arg(formatType(context->namePool(),
 142                                            BuiltinTypes::xsNCName))
 143                            .arg(formatKeyword("my-name.123")),
 144                            LexicallyInvalid,
 145                            r);
 146         }
 147     }
 148 }
 149
 150 QT_END_NAMESPACE
 151
 152 QT_END_HEADER
 153
 154 #endif