src/xmlpatterns/expr/qapplytemplate_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/src/xmlpatterns/expr/qapplytemplate_p.h	Mon Jan 11 14:00:40 2010 +0000
@@ -0,0 +1,144 @@
+/****************************************************************************
+**
+** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
+** 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_ApplyTemplate_H
+#define Patternist_ApplyTemplate_H
+
+#include "qtemplatemode_p.h"
+
+QT_BEGIN_HEADER
+QT_BEGIN_NAMESPACE
+
+namespace QPatternist
+{
+    /**
+     * @short When combined with other components, implements
+     * @c xsl:apply-templates.
+     *
+     * Note that ApplyTemplate isn't named ApplyTemplates. The reason for this
+     * is that ApplyTemplate doesn't do the iteration part. An @c
+     * <xsl:apply-templates/> instruction is rewritten into:
+     *
+     * @code
+     * child::node/() map apply-template()
+     * @endcode
+     *
+     * Hence, this expression requires a focus, although it can consist of
+     * atomic values.
+     *
+     * @since 4.5
+     * @author Frans Englich <frans.englich@nokia.com>
+     * @ingroup Patternist_expressions
+     */
+    class ApplyTemplate : public TemplateInvoker
+    {
+    public:
+        typedef QExplicitlySharedDataPointer<ApplyTemplate> Ptr;
+
+        /**
+         * @short @p mode may be @c null. If it is, ApplyTemplate interprets
+         * that as that it should use the #current mode.
+         *
+         * @see StaticContext::currentTemplateMode()
+         */
+        ApplyTemplate(const TemplateMode::Ptr &mode,
+                      const WithParam::Hash &withParams,
+                      const TemplateMode::Ptr &defaultMode);
+
+        virtual Item::Iterator::Ptr evaluateSequence(const DynamicContext::Ptr &context) const;
+
+        virtual SequenceType::Ptr staticType() const;
+        virtual ExpressionVisitorResult::Ptr accept(const ExpressionVisitor::Ptr &visitor) const;
+        virtual Properties properties() const;
+
+        /**
+         * The only reason this function exists, is in order to convert
+         * QXmlNodeModelIndex to QPatternist::Item. So, this is a huge
+         * performance setback. It applies for one of the builtin templates.
+         */
+        inline Item mapToItem(const QXmlNodeModelIndex &node,
+                              const DynamicContext::Ptr &context) const;
+        inline Item::Iterator::Ptr mapToSequence(const Item &item,
+                                                 const DynamicContext::Ptr &context) const;
+
+        inline TemplateMode::Ptr mode() const;
+
+        virtual bool configureRecursion(const CallTargetDescription::Ptr &sign);
+        virtual Expression::Ptr body() const;
+        virtual CallTargetDescription::Ptr callTargetDescription() const;
+
+        Expression::Ptr compress(const StaticContext::Ptr &context);
+
+    private:
+        typedef QExplicitlySharedDataPointer<const ApplyTemplate> ConstPtr;
+
+        Template::Ptr findTemplate(const DynamicContext::Ptr &context,
+                                   const TemplateMode::Ptr &templateMode) const;
+        /**
+         * @note You typically want to use effectiveMode().
+         */
+        const TemplateMode::Ptr m_mode;
+
+        TemplateMode::Ptr m_defaultMode;
+
+        inline TemplateMode::Ptr effectiveMode(const DynamicContext::Ptr &context) const;
+    };
+
+    TemplateMode::Ptr ApplyTemplate::mode() const
+    {
+        return m_mode;
+    }
+}
+
+QT_END_NAMESPACE
+QT_END_HEADER
+
+#endif