src/xmlpatterns/expr/qcalltemplate_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_CallTemplate_H
  53 #define Patternist_CallTemplate_H
  54
  55 #include <private/qcallsite_p.h>
  56 #include <private/qtemplateinvoker_p.h>
  57 #include <private/qtemplate_p.h>
  58
  59 QT_BEGIN_HEADER
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Implements @c xsl:call-template.
  66      *
  67      * @since 4.5
  68      * @author Frans Englich <frans.englich@nokia.com>
  69      * @ingroup Patternist_expressions
  70      */
  71     class CallTemplate : public TemplateInvoker
  72     {
  73     public:
  74         typedef QExplicitlySharedDataPointer<CallTemplate> Ptr;
  75
  76         CallTemplate(const QXmlName &name,
  77                      const WithParam::Hash &withParams);
  78
  79         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  80         virtual bool evaluateEBV(const DynamicContext::Ptr &context) const;
  81         virtual void evaluateToSequenceReceiver(const DynamicContext::Ptr &context) const;
  82
  83         virtual SequenceType::Ptr staticType() const;
  84         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
  85         virtual Properties properties() const;
  86         virtual Properties dependencies() const;
  87
  88         /**
  89          * This is a bit complicated by that we have two required types, one
  90          * specified by @c xsl:param in the template declaration, and one on @c
  91          * xsl:with-param.
  92          *
  93          * @see UserFunctionCallsite::expectedOperandTypes()
  94          * @see <a href="http://www.w3.org/TR/xslt20/#with-param">XSL
  95          * Transformations (XSLT) Version 2.0, 10.1.1 Passing Parameters to Templates</a>
  96          */
  97         virtual Expression::Ptr typeCheck(const StaticContext::Ptr &context,
  98                                           const SequenceType::Ptr &reqType);
  99
 100
 101         inline void setTemplate(const Template::Ptr &templ)
 102         {
 103             m_template = templ;
 104         }
 105
 106         virtual bool configureRecursion(const CallTargetDescription::Ptr &sign);
 107         virtual Expression::Ptr body() const;
 108         virtual CallTargetDescription::Ptr callTargetDescription() const;
 109     private:
 110         Template::Ptr   m_template;
 111     };
 112 }
 113
 114 QT_END_NAMESPACE
 115 QT_END_HEADER
 116
 117 #endif