src/xmlpatterns/expr/quserfunction_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/legal
   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 Digia.  For licensing terms and
  14 ** conditions see http://qt.digia.com/licensing.  For further information
  15 ** use the contact form at http://qt.digia.com/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 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Digia gives you certain additional
  26 ** rights.  These rights are described in the Digia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** GNU General Public License Usage
  30 ** Alternatively, this file may be used under the terms of the GNU
  31 ** General Public License version 3.0 as published by the Free Software
  32 ** Foundation and appearing in the file LICENSE.GPL included in the
  33 ** packaging of this file.  Please review the following information to
  34 ** ensure the GNU General Public License version 3.0 requirements will be
  35 ** met: http://www.gnu.org/copyleft/gpl.html.
  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_UserFunction_H
  53 #define Patternist_UserFunction_H
  54
  55 #include <QSharedData>
  56
  57 #include <private/qexpression_p.h>
  58 #include <private/qfunctionsignature_p.h>
  59 #include <private/qvariabledeclaration_p.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 template<typename T> class QList;
  66
  67 namespace QPatternist
  68 {
  69     /**
  70      * @short A function created with XQuery's <tt>declare function</tt> declaration.
  71      *
  72      * @see UserFunctionCall
  73      * @see ArgumentReference
  74      * @author Frans Englich <frans.englich@nokia.com>
  75      * @ingroup Patternist_expressions
  76      */
  77     class UserFunction : public QSharedData
  78     {
  79     public:
  80         typedef QExplicitlySharedDataPointer<UserFunction> Ptr;
  81         typedef QList<UserFunction::Ptr> List;
  82
  83         /**
  84          * If @p slotOffset is -1, it means this function has no arguments.
  85          */
  86         UserFunction(const FunctionSignature::Ptr &signature,
  87                      const Expression::Ptr &body,
  88                      const VariableSlotID slotOffset,
  89                      const VariableDeclaration::List &varDecls);
  90
  91         inline const Expression::Ptr &body() const;
  92         inline void setBody(const Expression::Ptr &newBody);
  93         inline FunctionSignature::Ptr signature() const;
  94         inline VariableSlotID expressionSlotOffset() const;
  95         inline VariableDeclaration::List argumentDeclarations() const;
  96
  97     private:
  98         const FunctionSignature::Ptr    m_signature;
  99         Expression::Ptr                 m_body;
 100         const VariableSlotID            m_slotOffset;
 101         const VariableDeclaration::List m_argumentDeclarations;
 102     };
 103
 104     inline const Expression::Ptr &UserFunction::body() const
 105     {
 106         return m_body;
 107     }
 108
 109     inline FunctionSignature::Ptr UserFunction::signature() const
 110     {
 111         return m_signature;
 112     }
 113
 114     inline VariableSlotID UserFunction::expressionSlotOffset() const
 115     {
 116         return m_slotOffset;
 117     }
 118
 119     inline VariableDeclaration::List UserFunction::argumentDeclarations() const
 120     {
 121         return m_argumentDeclarations;
 122     }
 123
 124     void UserFunction::setBody(const Expression::Ptr &newBody)
 125     {
 126         m_body = newBody;
 127     }
 128
 129 }
 130
 131 QT_END_NAMESPACE
 132
 133 QT_END_HEADER
 134
 135 #endif