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