src/script/api/qscriptcontextinfo.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: Nokia Corporation (qt-info@nokia.com)
   6 **
   7 ** This file is part of the QtScript module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL-ONLY$
  10 ** No Commercial Usage
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 ** Alternatively, this file may be used under the terms of the GNU Lesser
  18 ** General Public License version 2.1 as published by the Free Software
  19 ** Foundation and appearing in the file LICENSE.LGPL included in the
  20 ** packaging of this file.  Please review the following information to
  21 ** ensure the GNU Lesser General Public License version 2.1 requirements
  22 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  23 **
  24 ** In addition, as a special exception, Nokia gives you certain additional
  25 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  26 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at qt-info@nokia.com.
  30 **
  31 **
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSCRIPTCONTEXTINFO_H
  43 #define QSCRIPTCONTEXTINFO_H
  44
  45 #include <QtCore/qobjectdefs.h>
  46
  47 #include <QtCore/qlist.h>
  48 #include <QtCore/qstringlist.h>
  49 #include <QtCore/qsharedpointer.h>
  50
  51 QT_BEGIN_HEADER
  52
  53 QT_BEGIN_NAMESPACE
  54
  55 QT_MODULE(Script)
  56
  57 class QScriptContext;
  58 #ifndef QT_NO_DATASTREAM
  59 class QDataStream;
  60 #endif
  61
  62 class QScriptContextInfoPrivate;
  63 class Q_SCRIPT_EXPORT QScriptContextInfo
  64 {
  65 public:
  66 #ifndef QT_NO_DATASTREAM
  67     friend Q_SCRIPT_EXPORT QDataStream &operator<<(QDataStream &, const QScriptContextInfo &);
  68     friend Q_SCRIPT_EXPORT QDataStream &operator>>(QDataStream &, QScriptContextInfo &);
  69 #endif
  70
  71     enum FunctionType {
  72         ScriptFunction,
  73         QtFunction,
  74         QtPropertyFunction,
  75         NativeFunction
  76     };
  77
  78     QScriptContextInfo(const QScriptContext *context);
  79     QScriptContextInfo(const QScriptContextInfo &other);
  80     QScriptContextInfo();
  81     ~QScriptContextInfo();
  82
  83     QScriptContextInfo &operator=(const QScriptContextInfo &other);
  84
  85     bool isNull() const;
  86
  87     qint64 scriptId() const;
  88     QString fileName() const;
  89     int lineNumber() const;
  90     int columnNumber() const;
  91
  92     QString functionName() const;
  93     FunctionType functionType() const;
  94
  95     QStringList functionParameterNames() const;
  96
  97     int functionStartLineNumber() const;
  98     int functionEndLineNumber() const;
  99
 100     int functionMetaIndex() const;
 101
 102     bool operator==(const QScriptContextInfo &other) const;
 103     bool operator!=(const QScriptContextInfo &other) const;
 104
 105 private:
 106     QExplicitlySharedDataPointer<QScriptContextInfoPrivate> d_ptr;
 107
 108     Q_DECLARE_PRIVATE(QScriptContextInfo)
 109 };
 110
 111 typedef QList<QScriptContextInfo> QScriptContextInfoList;
 112
 113 #ifndef QT_NO_DATASTREAM
 114 Q_SCRIPT_EXPORT QDataStream &operator<<(QDataStream &, const QScriptContextInfo &);
 115 Q_SCRIPT_EXPORT QDataStream &operator>>(QDataStream &, QScriptContextInfo &);
 116 #endif
 117
 118 QT_END_NAMESPACE
 119
 120 QT_END_HEADER
 121
 122 #endif