1 /**************************************************************************** 2 ** 3 ** Copyright (C) 2016 The Qt Company Ltd. 4 ** Contact: https://www.qt.io/licensing/ 5 ** 6 ** This file is part of the QtXmlPatterns module of the Qt Toolkit. 7 ** 8 ** $QT_BEGIN_LICENSE:LGPL$ 9 ** Commercial License Usage 10 ** Licensees holding valid commercial Qt licenses may use this file in 11 ** accordance with the commercial license agreement provided with the 12 ** Software or, alternatively, in accordance with the terms contained in 13 ** a written agreement between you and The Qt Company. For licensing terms 14 ** and conditions see https://www.qt.io/terms-conditions. For further 15 ** information use the contact form at https://www.qt.io/contact-us. 16 ** 17 ** GNU Lesser General Public License Usage 18 ** Alternatively, this file may be used under the terms of the GNU Lesser 19 ** General Public License version 3 as published by the Free Software 20 ** Foundation and appearing in the file LICENSE.LGPL3 included in the 21 ** packaging of this file. Please review the following information to 22 ** ensure the GNU Lesser General Public License version 3 requirements 23 ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. 24 ** 25 ** GNU General Public License Usage 26 ** Alternatively, this file may be used under the terms of the GNU 27 ** General Public License version 2.0 or (at your option) the GNU General 28 ** Public license version 3 or any later version approved by the KDE Free 29 ** Qt Foundation. The licenses are as published by the Free Software 30 ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 31 ** included in the packaging of this file. Please review the following 32 ** information to ensure the GNU General Public License requirements will 33 ** be met: https://www.gnu.org/licenses/gpl-2.0.html and 34 ** https://www.gnu.org/licenses/gpl-3.0.html. 35 ** 36 ** $QT_END_LICENSE$ 37 ** 38 ****************************************************************************/ 39 40 // 41 // W A R N I N G 42 // ------------- 43 // 44 // This file is not part of the Qt API. It exists purely as an 45 // implementation detail. This header file may change from version to 46 // version without notice, or even be removed. 47 // 48 // We mean it. 49 50 #ifndef Patternist_CallSite_H 51 #define Patternist_CallSite_H 52 53 #include <private/qunlimitedcontainer_p.h> 54 #include <private/qcalltargetdescription_p.h> 55 #include <QXmlName> 56 57 QT_BEGIN_NAMESPACE 58 59 namespace QPatternist 60 { 61 /** 62 * @short Abstract base-class for Expression instances that are callsites 63 * to other components, such as templates or user functions. 64 * 65 * @author Frans Englich <frans.englich@nokia.com> 66 * @ingroup Patternist_expressions 67 * @since 4.5 68 */ 69 class CallSite : public UnlimitedContainer 70 { 71 public: 72 QXmlName name() const; 73 bool isRecursive() const; 74 void setIsRecursive(const bool value); 75 76 /** 77 * Called in the earliest stages of the compilation process. @p sign can 78 * be any function signature for a user declared function. If @p sign 79 * matches this UserFunctionCallsite, it means the UserFunction represented 80 * by @p sign is recursive and that this UserFunctionCallsite should take 81 * appropriate measures. 82 * 83 * @returns @c true if is recursive, otherwise @c false 84 */ 85 virtual bool configureRecursion(const CallTargetDescription::Ptr &sign) = 0; 86 87 /** 88 * @short Returns the body of the function/template/component that is 89 * being called. 90 */ 91 virtual Expression::Ptr body() const = 0; 92 93 virtual CallTargetDescription::Ptr callTargetDescription() const = 0; 94 95 protected: 96 CallSite(const QXmlName &name = QXmlName()); 97 98 private: 99 Q_DISABLE_COPY(CallSite) 100 bool m_isRecursive; 101 const QXmlName m_name; 102 }; 103 } 104 105 QT_END_NAMESPACE 106 107 #endif 108