src/xmlpatterns/expr/qattributenamevalidator_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_AttributeNameValidator_H
  53 #define Patternist_AttributeNameValidator_H
  54
  55 #include <private/qsinglecontainer_p.h>
  56
  57 QT_BEGIN_HEADER
  58
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Ensures the lexical space of the string value of the Item returned
  65      * from its child Expression is an NCName. Also possibly changes the name
  66      * by generating a prefix if one is needed.
  67      *
  68      * @note It doesn't actually construct an @c xs:NCName. It only ensures the lexical
  69      * space is an @c NCName. The atomic value can be of any string type, such as @c xs:untypedAtomic
  70      * of @c xs:string.
  71      *
  72      * @author Frans Englich <frans.englich@nokia.com>
  73      * @ingroup Patternist_expressions
  74      */
  75     class AttributeNameValidator : public SingleContainer
  76     {
  77     public:
  78         AttributeNameValidator(const Expression::Ptr &source);
  79
  80         virtual Item evaluateSingleton(const DynamicContext::Ptr &) const;
  81
  82         virtual SequenceType::List expectedOperandTypes() const;
  83
  84         /**
  85          * @returns the static type of its operand. This is returned as opposed
  86          * CommonSequenceTypes::ExactlyOneQName, since the operand might return a subtype
  87          * of @c xs:QName.
  88          */
  89         virtual SequenceType::Ptr staticType() const;
  90
  91         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  92     };
  93 }
  94
  95 QT_END_NAMESPACE
  96
  97 QT_END_HEADER
  98
  99 #endif