src/xmlpatterns/expr/qcallsite_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_CallSite_H
  53 #define Patternist_CallSite_H
  54
  55 #include "qunlimitedcontainer_p.h"
  56 #include "qcalltargetdescription_p.h"
  57 #include "qxmlname.h"
  58
  59 QT_BEGIN_HEADER
  60 QT_BEGIN_NAMESPACE
  61
  62 namespace QPatternist
  63 {
  64     /**
  65      * @short Abstract base-class for Expression instances that are callsites
  66      * to other components, such as templates or user functions.
  67      *
  68      * @author Frans Englich <frans.englich@nokia.com>
  69      * @ingroup Patternist_expressions
  70      * @since 4.5
  71      */
  72     class CallSite : public UnlimitedContainer
  73     {
  74     public:
  75         QXmlName name() const;
  76         bool isRecursive() const;
  77         void setIsRecursive(const bool value);
  78
  79         /**
  80          * Called in the earliest stages of the compilation process. @p sign can
  81          * be any function signature for a user declared function. If @p sign
  82          * matches this UserFunctionCallsite, it means the UserFunction represented
  83          * by @p sign is recursive and that this UserFunctionCallsite should take
  84          * appropriate measures.
  85          *
  86          * @returns @c true if is recursive, otherwise @c false
  87          */
  88         virtual bool configureRecursion(const CallTargetDescription::Ptr &sign) = 0;
  89
  90         /**
  91          * @short Returns the body of the function/template/component that is
  92          * being called.
  93          */
  94         virtual Expression::Ptr body() const = 0;
  95
  96         virtual CallTargetDescription::Ptr callTargetDescription() const = 0;
  97
  98     protected:
  99         CallSite(const QXmlName &name = QXmlName());
 100
 101     private:
 102         Q_DISABLE_COPY(CallSite)
 103         bool            m_isRecursive;
 104         const QXmlName  m_name;
 105     };
 106 }
 107
 108 QT_END_NAMESPACE
 109 QT_END_HEADER
 110
 111 #endif