src/xmlpatterns/expr/qletclause_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  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_LetClause_H
  53 #define Patternist_LetClause_H
  54
  55 #include <private/qpaircontainer_p.h>
  56 #include <private/qvariabledeclaration_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64
  65     /**
  66      * @short Represents a <tt>let</tt>-clause, but is only used at compile
  67      * time.
  68      *
  69      * LetClause is inserted into the AST tree for the single purpose of
  70      * ensuring that the focus is correct for the binding expression. Once
  71      * that is done, LetClause sometimes rewrites itself to its
  72      * <tt>return</tt> expression, and the ExpressionVariableReference will
  73      * handle the evaluation of the variable.
  74      *
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      * @ingroup Patternist_expressions
  77      */
  78     class LetClause : public PairContainer
  79     {
  80     public:
  81         LetClause(const Expression::Ptr &operand1,
  82                   const Expression::Ptr &operand2,
  83                   const VariableDeclaration::Ptr &decl);
  84
  85         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  86         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  87         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  88         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
  89
  90         virtual SequenceType::List expectedOperandTypes() const;
  91         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  92                                           const SequenceType::Ptr &reqType);
  93         virtual SequenceType::Ptr staticType() const;
  94         virtual Properties properties() const;
  95         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  96         virtual ID id() const;
  97
  98     private:
  99         inline DynamicContext::Ptr bindVariable(const DynamicContext::Ptr &context) const;
 100
 101         const VariableDeclaration::Ptr m_varDecl;
 102     };
 103 }
 104
 105 QT_END_NAMESPACE
 106
 107 QT_END_HEADER
 108
 109 #endif