src/xmlpatterns/expr/qwithparam_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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 ** 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_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