/****************************************************************************

**

** All rights reserved.

** Contact: Nokia Corporation (qt-info@nokia.com)

**

** This file is part of the QtXmlPatterns module of the Qt Toolkit.

**

** $QT_BEGIN_LICENSE:LGPL$

** No Commercial Usage

** This file contains pre-release code and may not be distributed.

** You may use this file in accordance with the terms and conditions

** contained in the Technology Preview License Agreement accompanying

** this package.

**

** GNU Lesser General Public License Usage

** Alternatively, this file may be used under the terms of the GNU Lesser

** General Public License version 2.1 as published by the Free Software

** Foundation and appearing in the file LICENSE.LGPL included in the

** packaging of this file.  Please review the following information to

** ensure the GNU Lesser General Public License version 2.1 requirements

** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.

**

** In addition, as a special exception, Nokia gives you certain additional

** rights.  These rights are described in the Nokia Qt LGPL Exception

** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.

**

** If you have questions regarding the use of this file, please contact

** Nokia at qt-info@nokia.com.

**

**

**

**

**

**

**

**

** $QT_END_LICENSE$

**

****************************************************************************/

//

//  W A R N I N G

//  -------------

//

// This file is not part of the Qt API.  It exists purely as an

// implementation detail.  This header file may change from version to

// version without notice, or even be removed.

//

// We mean it.

#ifndef Patternist_ExpressionVariableReference_H

#define Patternist_ExpressionVariableReference_H

#include "qvariabledeclaration_p.h"

#include "qvariablereference_p.h"

QT_BEGIN_HEADER

QT_BEGIN_NAMESPACE

namespace QPatternist

{

    /**

     * @short A reference to a variable declared with <tt>declare variable</tt> or @c let.

     *

     * It's also used by variable bindings in @c case branches of the @c typeswitch

     * expression.

     *

     * This AST node is only used up until the typeCheck() stage. Therefore it

     * has no functions for evaluation, such as evaluateSequence().

     *

     * @author Frans Englich <frans.englich@nokia.com>

     * @ingroup Patternist_expressions

     */

    class ExpressionVariableReference : public VariableReference

    {

    public:

        ExpressionVariableReference(const VariableSlotID slot,

                                    const VariableDeclaration::Ptr &varDecl);

        virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;

        virtual Item evaluateSingleton(const DynamicContext::Ptr &context) const;

        virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;

        virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,

                                          const SequenceType::Ptr &reqType);

        virtual SequenceType::Ptr staticType() const;

        virtual ID id() const;

        virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;

        inline const Expression::Ptr &sourceExpression() const;

        inline const VariableDeclaration::Ptr &variableDeclaration() const;

    private:

        const VariableDeclaration::Ptr m_varDecl;

    };

    inline const Expression::Ptr &ExpressionVariableReference::sourceExpression() const

    {

        return m_varDecl->expression();

    }

    inline const VariableDeclaration::Ptr &ExpressionVariableReference::variableDeclaration() const

    {

        return m_varDecl;

    }

}

QT_END_NAMESPACE

QT_END_HEADER

#endif