util/src/script/api/qscriptcontextinfo.h
changeset 7 f7bc934e204c
equal deleted inserted replaced
3:41300fa6a67c 7:f7bc934e204c
       
     1 /****************************************************************************
       
     2 **
       
     3 ** Copyright (C) 2010 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 ** GNU Lesser General Public License Usage
       
    11 ** This file may be used under the terms of the GNU Lesser
       
    12 ** General Public License version 2.1 as published by the Free Software
       
    13 ** Foundation and appearing in the file LICENSE.LGPL included in the
       
    14 ** packaging of this file.  Please review the following information to
       
    15 ** ensure the GNU Lesser General Public License version 2.1 requirements
       
    16 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
       
    17 **
       
    18 ** If you have questions regarding the use of this file, please contact
       
    19 ** Nokia at qt-info@nokia.com.
       
    20 ** $QT_END_LICENSE$
       
    21 **
       
    22 ****************************************************************************/
       
    23 
       
    24 #ifndef QSCRIPTCONTEXTINFO_H
       
    25 #define QSCRIPTCONTEXTINFO_H
       
    26 
       
    27 #include <QtCore/qobjectdefs.h>
       
    28 
       
    29 #include <QtCore/qlist.h>
       
    30 #include <QtCore/qstringlist.h>
       
    31 #include <QtCore/qsharedpointer.h>
       
    32 
       
    33 QT_BEGIN_HEADER
       
    34 
       
    35 QT_BEGIN_NAMESPACE
       
    36 
       
    37 QT_MODULE(Script)
       
    38 
       
    39 class QScriptContext;
       
    40 #ifndef QT_NO_DATASTREAM
       
    41 class QDataStream;
       
    42 #endif
       
    43 
       
    44 class QScriptContextInfoPrivate;
       
    45 class Q_SCRIPT_EXPORT QScriptContextInfo
       
    46 {
       
    47 public:
       
    48 #ifndef QT_NO_DATASTREAM
       
    49     friend Q_SCRIPT_EXPORT QDataStream &operator<<(QDataStream &, const QScriptContextInfo &);
       
    50     friend Q_SCRIPT_EXPORT QDataStream &operator>>(QDataStream &, QScriptContextInfo &);
       
    51 #endif
       
    52 
       
    53     enum FunctionType {
       
    54         ScriptFunction,
       
    55         QtFunction,
       
    56         QtPropertyFunction,
       
    57         NativeFunction
       
    58     };
       
    59 
       
    60     QScriptContextInfo(const QScriptContext *context);
       
    61     QScriptContextInfo(const QScriptContextInfo &other);
       
    62     QScriptContextInfo();
       
    63     ~QScriptContextInfo();
       
    64 
       
    65     QScriptContextInfo &operator=(const QScriptContextInfo &other);
       
    66 
       
    67     bool isNull() const;
       
    68 
       
    69     qint64 scriptId() const;
       
    70     QString fileName() const;
       
    71     int lineNumber() const;
       
    72     int columnNumber() const;
       
    73 
       
    74     QString functionName() const;
       
    75     FunctionType functionType() const;
       
    76 
       
    77     QStringList functionParameterNames() const;
       
    78 
       
    79     int functionStartLineNumber() const;
       
    80     int functionEndLineNumber() const;
       
    81 
       
    82     int functionMetaIndex() const;
       
    83 
       
    84     bool operator==(const QScriptContextInfo &other) const;
       
    85     bool operator!=(const QScriptContextInfo &other) const;
       
    86 
       
    87 private:
       
    88     QExplicitlySharedDataPointer<QScriptContextInfoPrivate> d_ptr;
       
    89 
       
    90     Q_DECLARE_PRIVATE(QScriptContextInfo)
       
    91 };
       
    92 
       
    93 typedef QList<QScriptContextInfo> QScriptContextInfoList;
       
    94 
       
    95 #ifndef QT_NO_DATASTREAM
       
    96 Q_SCRIPT_EXPORT QDataStream &operator<<(QDataStream &, const QScriptContextInfo &);
       
    97 Q_SCRIPT_EXPORT QDataStream &operator>>(QDataStream &, QScriptContextInfo &);
       
    98 #endif
       
    99 
       
   100 QT_END_NAMESPACE
       
   101 
       
   102 QT_END_HEADER
       
   103 
       
   104 #endif