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_CallTargetDescription_H 51 #define Patternist_CallTargetDescription_H 52 53 #include <QSharedData> 54 55 #include <private/qexpression_p.h> 56 57 QT_BEGIN_NAMESPACE 58 59 template<typename Key, typename Value> class QHash; 60 template<typename T> class QList; 61 62 namespace QPatternist 63 { 64 class CallSite; 65 66 /** 67 * @short Contains metadata for a callable component, such as a function or 68 * template. 69 * 70 * CallTargetDescription can be used directly and is so for templates, but 71 * can also be sub-classed which FunctionSignature do. 72 * 73 * @ingroup Patternist_expr 74 * @author Frans Englich <frans.englich@nokia.com> 75 */ 76 class Q_AUTOTEST_EXPORT CallTargetDescription : public QSharedData 77 { 78 public: 79 typedef QExplicitlySharedDataPointer<CallTargetDescription> Ptr; 80 typedef QList<Ptr> List; 81 82 CallTargetDescription(const QXmlName &name); 83 84 /** 85 * The function's name. For example, the name of the signature 86 * <tt>fn:string() as xs:string</tt> is <tt>fn:string</tt>. 87 */ 88 QXmlName name() const; 89 90 /** 91 * Flags callsites to be aware of their recursion by calling 92 * UserFunctionCallsite::configureRecursion(), if that is the case. 93 * 94 * @note We pass @p expr by value here intentionally. 95 */ 96 static void checkCallsiteCircularity(CallTargetDescription::List &signList, 97 const Expression::Ptr expr); 98 private: 99 /** 100 * Helper function for checkCallsiteCircularity(). If C++ allowed it, 101 * it would have been local to it. 102 */ 103 static void checkArgumentsCircularity(CallTargetDescription::List &signList, 104 const Expression::Ptr callsite); 105 106 Q_DISABLE_COPY(CallTargetDescription) 107 const QXmlName m_name; 108 }; 109 } 110 111 QT_END_NAMESPACE 112 113 #endif 114 115