src/xmlpatterns/expr/qexpressionvariablereference_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_ExpressionVariableReference_H
  53 #define Patternist_ExpressionVariableReference_H
  54
  55 #include <private/qvariabledeclaration_p.h>
  56 #include <private/qvariablereference_p.h>
  57
  58 QT_BEGIN_HEADER
  59
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short A reference to a variable declared with <tt>declare variable</tt> or @c let.
  66      *
  67      * It's also used by variable bindings in @c case branches of the @c typeswitch
  68      * expression.
  69      *
  70      * This AST node is only used up until the typeCheck() stage. Therefore it
  71      * has no functions for evaluation, such as evaluateSequence().
  72      *
  73      * @author Frans Englich <frans.englich@nokia.com>
  74      * @ingroup Patternist_expressions
  75      */
  76     class ExpressionVariableReference : public VariableReference
  77     {
  78     public:
  79         ExpressionVariableReference(const VariableSlotID slot,
  80                                     const VariableDeclaration::Ptr &varDecl);
  81
  82         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  83         virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;
  84         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  85
  86         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  87                                           const SequenceType::Ptr &reqType);
  88         virtual SequenceType::Ptr staticType() const;
  89         virtual ID id() const;
  90         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  91
  92         inline const Expression::Ptr &sourceExpression() const;
  93         inline const VariableDeclaration::Ptr &variableDeclaration() const;
  94     private:
  95         const VariableDeclaration::Ptr m_varDecl;
  96     };
  97
  98     inline const Expression::Ptr &ExpressionVariableReference::sourceExpression() const
  99     {
 100         return m_varDecl->expression();
 101     }
 102
 103     inline const VariableDeclaration::Ptr &ExpressionVariableReference::variableDeclaration() const
 104     {
 105         return m_varDecl;
 106     }
 107
 108 }
 109
 110 QT_END_NAMESPACE
 111
 112 QT_END_HEADER
 113
 114 #endif