src/xmlpatterns/expr/qwithparam_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_TemplateParam_H
       
    53 #define Patternist_TemplateParam_H
       
    54 
       
    55 #include "qfunctionargument_p.h"
       
    56 
       
    57 QT_BEGIN_HEADER
       
    58 
       
    59 QT_BEGIN_NAMESPACE
       
    60 
       
    61 namespace QPatternist
       
    62 {
       
    63     /**
       
    64      * @short Carries meta data for @c xsl:with-param as encountered in
       
    65      * template callsites such as @c xsl:call-template and @c
       
    66      * xsl:apply-templates.
       
    67      *
       
    68      * WithParam is similar to FunctionArgument, but has in addition a default
       
    69      * value in the form of an Expression.
       
    70      *
       
    71      * @since 4.5
       
    72      * @ingroup Patternist_expressions
       
    73      * @author Frans Englich <frans.englich@nokia.com>
       
    74      */
       
    75     class WithParam : public FunctionArgument
       
    76     {
       
    77     public:
       
    78         typedef QExplicitlySharedDataPointer<WithParam> Ptr;
       
    79         typedef QHash<QXmlName, Ptr> Hash;
       
    80 
       
    81         /**
       
    82          * @p sourceExpression can not be @c null.
       
    83          */
       
    84         inline WithParam(const QXmlName name,
       
    85                          const SequenceType::Ptr &type,
       
    86                          const Expression::Ptr &sourceExpression);
       
    87 
       
    88         inline void setSourceExpression(const Expression::Ptr &expr)
       
    89         {
       
    90             Q_ASSERT(expr);
       
    91             m_sourceExpression = expr;
       
    92         }
       
    93 
       
    94         /**
       
    95          * @short Returns the expression which is the source the value for this
       
    96          * parameter.
       
    97          *
       
    98          * Guaranteed to never be @c null.
       
    99          */
       
   100         inline Expression::Ptr sourceExpression() const
       
   101         {
       
   102             return m_sourceExpression;
       
   103         }
       
   104 
       
   105     private:
       
   106         Expression::Ptr m_sourceExpression;
       
   107     };
       
   108 
       
   109     WithParam::WithParam(const QXmlName name,
       
   110                          const SequenceType::Ptr &type,
       
   111                          const Expression::Ptr &sourceExpression) : FunctionArgument(name, type)
       
   112                                                                   , m_sourceExpression(sourceExpression)
       
   113     {
       
   114         Q_ASSERT(m_sourceExpression);
       
   115     }
       
   116 
       
   117 }
       
   118 
       
   119 QT_END_NAMESPACE
       
   120 
       
   121 QT_END_HEADER
       
   122 
       
   123 #endif