src/script/qscriptcontextinfo.h

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