src/xmlpatterns/expr/qtemplateinvoker_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_TemplateInvoker_H
  53 #define Patternist_TemplateInvoker_H
  54
  55 #include <private/qcallsite_p.h>
  56 #include <private/qwithparam_p.h>
  57
  58 QT_BEGIN_HEADER
  59 QT_BEGIN_NAMESPACE
  60
  61 namespace QPatternist
  62 {
  63     /**
  64      * @short Base class for classes that invokes @em templates, such as
  65      * CallTemplate and ApplyTemplate.
  66      *
  67      * TemplateInvoker has the member m_withParams, which is the @c
  68      * xsl:with-param instructions of the caller. The definite source for the
  69      * expressions is m_withParams, not Expression::operands(). However, the
  70      * order of operands() is defined, while m_withParams is not since it's a
  71      * hash. Therefore operands() is definite on order.
  72      *
  73      * TemplateInvoker is intended to be sub-classed.
  74      *
  75      * @author Frans Englich <frans.englich@nokia.com>
  76      * @ingroup Patternist_expressions
  77      * @since 4.5
  78      */
  79     class TemplateInvoker : public CallSite
  80     {
  81     public:
  82         virtual Expression::Ptr compress(const StaticContext::Ptr &context);
  83
  84         inline const WithParam::Hash &withParams() const;
  85         WithParam::Hash m_withParams;
  86
  87         /**
  88          * This is a bit complicated by that we have two required types, one
  89          * specified by @c xsl:param in the template declaration, and one on @c
  90          * xsl:with-param.
  91          *
  92          * @see UserFunctionCallsite::expectedOperandTypes()
  93          * @see <a href="http://www.w3.org/TR/xslt20/#with-param">XSL
  94          * Transformations (XSLT) Version 2.0, 10.1.1 Passing Parameters to Templates</a>
  95          */
  96         virtual SequenceType::List expectedOperandTypes() const;
  97     protected:
  98         /**
  99          * @p withParams may be empty.
 100          */
 101         TemplateInvoker(const WithParam::Hash &withParams,
 102                         const QXmlName &name = QXmlName());
 103
 104     private:
 105         Q_DISABLE_COPY(TemplateInvoker)
 106     };
 107
 108     const WithParam::Hash &TemplateInvoker::withParams() const
 109     {
 110         return m_withParams;
 111     }
 112
 113 }
 114
 115 QT_END_NAMESPACE
 116 QT_END_HEADER
 117
 118 #endif
 119