1 /****************************************************************************

     2 **

     3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).

     4 ** All rights reserved.

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

     6 **

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

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    10 ** No Commercial Usage

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

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

    13 ** contained in the Technology Preview License Agreement accompanying

    14 ** this package.

    15 **

    16 ** GNU Lesser General Public License Usage

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

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

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

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

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

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

    23 **

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

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

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

    27 **

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

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

    30 **

    31 **

    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 "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