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_UserFunction_H 51 #define Patternist_UserFunction_H 52 53 #include <QSharedData> 54 55 #include <private/qexpression_p.h> 56 #include <private/qfunctionsignature_p.h> 57 #include <private/qvariabledeclaration_p.h> 58 59 QT_BEGIN_NAMESPACE 60 61 template<typename T> class QList; 62 63 namespace QPatternist 64 { 65 /** 66 * @short A function created with XQuery's <tt>declare function</tt> declaration. 67 * 68 * @see UserFunctionCall 69 * @see ArgumentReference 70 * @author Frans Englich <frans.englich@nokia.com> 71 * @ingroup Patternist_expressions 72 */ 73 class UserFunction : public QSharedData 74 { 75 public: 76 typedef QExplicitlySharedDataPointer<UserFunction> Ptr; 77 typedef QList<UserFunction::Ptr> List; 78 79 /** 80 * If @p slotOffset is -1, it means this function has no arguments. 81 */ 82 UserFunction(const FunctionSignature::Ptr &signature, 83 const Expression::Ptr &body, 84 const VariableSlotID slotOffset, 85 const VariableDeclaration::List &varDecls); 86 87 inline const Expression::Ptr &body() const; 88 inline void setBody(const Expression::Ptr &newBody); 89 inline FunctionSignature::Ptr signature() const; 90 inline VariableSlotID expressionSlotOffset() const; 91 inline VariableDeclaration::List argumentDeclarations() const; 92 93 private: 94 const FunctionSignature::Ptr m_signature; 95 Expression::Ptr m_body; 96 const VariableSlotID m_slotOffset; 97 const VariableDeclaration::List m_argumentDeclarations; 98 }; 99 body()100 inline const Expression::Ptr &UserFunction::body() const 101 { 102 return m_body; 103 } 104 signature()105 inline FunctionSignature::Ptr UserFunction::signature() const 106 { 107 return m_signature; 108 } 109 expressionSlotOffset()110 inline VariableSlotID UserFunction::expressionSlotOffset() const 111 { 112 return m_slotOffset; 113 } 114 argumentDeclarations()115 inline VariableDeclaration::List UserFunction::argumentDeclarations() const 116 { 117 return m_argumentDeclarations; 118 } 119 setBody(const Expression::Ptr & newBody)120 void UserFunction::setBody(const Expression::Ptr &newBody) 121 { 122 m_body = newBody; 123 } 124 125 } 126 127 QT_END_NAMESPACE 128 129 #endif 130