src/xmlpatterns/expr/qapplytemplate_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_ApplyTemplate_H
  53 #define Patternist_ApplyTemplate_H
  54
  55 #include <private/qtemplatemode_p.h>
  56
  57 QT_BEGIN_HEADER
  58 QT_BEGIN_NAMESPACE
  59
  60 namespace QPatternist
  61 {
  62     /**
  63      * @short When combined with other components, implements
  64      * @c xsl:apply-templates.
  65      *
  66      * Note that ApplyTemplate isn't named ApplyTemplates. The reason for this
  67      * is that ApplyTemplate doesn't do the iteration part. An @c
  68      * <xsl:apply-templates/> instruction is rewritten into:
  69      *
  70      * @code
  71      * child::node/() map apply-template()
  72      * @endcode
  73      *
  74      * Hence, this expression requires a focus, although it can consist of
  75      * atomic values.
  76      *
  77      * @since 4.5
  78      * @author Frans Englich <frans.englich@nokia.com>
  79      * @ingroup Patternist_expressions
  80      */
  81     class ApplyTemplate : public TemplateInvoker
  82     {
  83     public:
  84         typedef QExplicitlySharedDataPointer<ApplyTemplate> Ptr;
  85
  86         /**
  87          * @short @p mode may be @c null. If it is, ApplyTemplate interprets
  88          * that as that it should use the #current mode.
  89          *
  90          * @see StaticContext::currentTemplateMode()
  91          */
  92         ApplyTemplate(const TemplateMode::Ptr &mode,
  93                       const WithParam::Hash &withParams,
  94                       const TemplateMode::Ptr &defaultMode);
  95
  96         virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
  97
  98         virtual SequenceType::Ptr staticType() const;
  99         virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
 100         virtual Properties properties() const;
 101
 102         /**
 103          * The only reason this function exists, is in order to convert
 104          * QXmlNodeModelIndex to QPatternist::Item. So, this is a huge
 105          * performance setback. It applies for one of the builtin templates.
 106          */
 107         inline Item mapToItem(const QXmlNodeModelIndex &node,
 108                               const DynamicContext::Ptr &context) const;
 109         inline Item::Iterator::Ptr mapToSequence(const Item &item,
 110                                                  const DynamicContext::Ptr &context) const;
 111
 112         inline TemplateMode::Ptr mode() const;
 113
 114         virtual bool configureRecursion(const CallTargetDescription::Ptr &sign);
 115         virtual Expression::Ptr body() const;
 116         virtual CallTargetDescription::Ptr callTargetDescription() const;
 117
 118         Expression::Ptr compress(const StaticContext::Ptr &context);
 119
 120     private:
 121         typedef QExplicitlySharedDataPointer<const ApplyTemplate> ConstPtr;
 122
 123         Template::Ptr findTemplate(const DynamicContext::Ptr &context,
 124                                    const TemplateMode::Ptr &templateMode) const;
 125         /**
 126          * @note You typically want to use effectiveMode().
 127          */
 128         const TemplateMode::Ptr m_mode;
 129
 130         TemplateMode::Ptr m_defaultMode;
 131
 132         inline TemplateMode::Ptr effectiveMode(const DynamicContext::Ptr &context) const;
 133     };
 134
 135     TemplateMode::Ptr ApplyTemplate::mode() const
 136     {
 137         return m_mode;
 138     }
 139 }
 140
 141 QT_END_NAMESPACE
 142 QT_END_HEADER
 143
 144 #endif