src/xmlpatterns/expr/qtemplate_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   6 **
   7 ** This file is part of the QtXmlPatterns module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  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_Template_H
  53 #define Patternist_Template_H
  54
  55 #include <QSharedData>
  56 #include <QVector>
  57
  58 #include <private/qdynamiccontext_p.h>
  59 #include <private/qexpression_p.h>
  60 #include <private/qsourcelocationreflection_p.h>
  61 #include <private/qtemplateinvoker_p.h>
  62 #include <private/qvariabledeclaration_p.h>
  63
  64 QT_BEGIN_HEADER
  65 QT_BEGIN_NAMESPACE
  66
  67 namespace QPatternist
  68 {
  69     /**
  70      * @short Contains data related to a template.
  71      *
  72      * A Template is associated with a mode, by being housed
  73      * inside a TemplateMode instance.
  74      *
  75      * Template has role very similar to UserFunction.
  76      *
  77      * @see TemplateMode
  78      * @see TemplatePattern
  79      * @see UserFunction
  80      * @author Frans Englich <frans.englich@nokia.com>
  81      * @ingroup Patternist_expressions
  82      * @since 4.5
  83      */
  84     class Template : public QSharedData
  85                    , public SourceLocationReflection
  86
  87     {
  88     public:
  89         typedef QExplicitlySharedDataPointer<Template> Ptr;
  90         typedef QVector<Template::Ptr> Vector;
  91
  92         inline Template(const ImportPrecedence ip,
  93                         const SequenceType::Ptr &reqType) : importPrecedence(ip)
  94                                                           , m_reqType(reqType)
  95         {
  96         }
  97
  98         Expression::Ptr body;
  99
 100         /**
 101          * Returns @c this.
 102          */
 103         virtual const SourceLocationReflection* actualReflection() const;
 104
 105         const ImportPrecedence importPrecedence;
 106
 107         VariableDeclaration::List templateParameters;
 108
 109         /**
 110          * If @p isCallTemplate, the caller is @c xsl:call-template, as opposed
 111          * to for instance @c xsl:apply-templates. This affects error
 112          * reporting.
 113          */
 114         DynamicContext::Ptr createContext(const TemplateInvoker *const invoker,
 115                                          const DynamicContext::Ptr &context,
 116                                          const bool isCallTemplate) const;
 117
 118         /**
 119          * Since we have our template parameters in templateParameters, we need
 120          * this separate step to do the regular phases:
 121          * Expression::typeCheck(), and Expression::compress().
 122          */
 123         void compileParameters(const StaticContext::Ptr &context);
 124
 125         /**
 126          * A value which takes into account the body and its template
 127          * parameters.
 128          */
 129         Expression::Properties properties() const;
 130
 131         Expression::Properties dependencies() const;
 132
 133         static void raiseXTSE0680(const ReportContext::Ptr &context,
 134                                   const QXmlName &name,
 135                                   const SourceLocationReflection *const reflection);
 136
 137     private:
 138         DynamicContext::TemplateParameterHash parametersAsHash() const;
 139         const SequenceType::Ptr m_reqType;
 140     };
 141 }
 142
 143 QT_END_NAMESPACE
 144 QT_END_HEADER
 145
 146 #endif