src/xmlpatterns/expr/qtemplate_p.h
changeset 0 1918ee327afb
child 4 3b1da2848fc7
equal deleted inserted replaced
-1:000000000000 0:1918ee327afb
       
     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_Template_H
       
    53 #define Patternist_Template_H
       
    54 
       
    55 #include <QSharedData>
       
    56 #include <QVector>
       
    57 
       
    58 #include "qdynamiccontext_p.h"
       
    59 #include "qexpression_p.h"
       
    60 #include "qsourcelocationreflection_p.h"
       
    61 #include "qtemplateinvoker_p.h"
       
    62 #include "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