src/xmlpatterns/expr/qtreatas_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_TreatAs_H
  53 #define Patternist_TreatAs_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 Implements XPath 2.0's <tt>treat as</tt> expression.
  65      *
  66      * TreatAs is always a compile-time class only, and is always deallocated
  67      * by re-writing to CardinalityVerifier or ItemVerifier or both, by calling
  68      * TypeChecker::applyFunctionConversion().
  69      *
  70      *
  71      * One approach could be to skip instantiating TreatAs and simply let the
  72      * return value of TypeChecker::applyFunctionConversion() be inserted into
  73      * the AST, but that wouldn't handle type checking the context item
  74      * properly, which depends on that the StaticContext have been set by the
  75      * parent Expression.
  76      *
  77      * @see <a href="http://www.w3.org/TR/xpath20/#id-treat">XML Path Language
  78      * (XPath) 2.0, 3.10.5 Treat</a>
  79      * @author Frans Englich <frans.englich@nokia.com>
  80      * @ingroup Patternist_expressions
  81      */
  82     class TreatAs : public SingleContainer
  83     {
  84     public:
  85         /**
  86          * Creats a TreatAs where it is checked that the expression @p operand conforms
  87          * to the type @p reqType.
  88          */
  89         TreatAs(const Expression::Ptr &operand,
  90                 const SequenceType::Ptr &reqType);
  91
  92         /**
  93          * This function rewrites always. First the type that this TreatAs expression tests for
  94          * is verified. Then, the type the <tt>treat as</tt> expression itself must match, @p reqType,
  95          * is verified.
  96          */
  97         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  98                                           const SequenceType::Ptr &reqType);
  99
 100         /**
 101          * @returns always the SequenceType passed in the constructor to this class. That is, the
 102          * SequenceType that the operand must conform to.
 103          */
 104         virtual SequenceType::Ptr staticType() const;
 105
 106         /**
 107          * @returns a list containing one CommonSequenceTypes::ZeroOrMoreItems
 108          */
 109         virtual SequenceType::List expectedOperandTypes() const;
 110
 111         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 112
 113     private:
 114         const SequenceType::Ptr m_reqType;
 115     };
 116 }
 117
 118 QT_END_NAMESPACE
 119
 120 QT_END_HEADER
 121
 122 #endif