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 QtSCriptTools module of the Qt Toolkit.

     8 **

     9 ** $QT_BEGIN_LICENSE:LGPL$

    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 QSCRIPTDEBUGGEREVENT_P_H

    43 #define QSCRIPTDEBUGGEREVENT_P_H

    44 

    45 //

    46 //  W A R N I N G

    47 //  -------------

    48 //

    49 // This file is not part of the Qt API.  It exists purely as an

    50 // implementation detail.  This header file may change from version to

    51 // version without notice, or even be removed.

    52 //

    53 // We mean it.

    54 //

    55 

    56 #include <QtCore/qobjectdefs.h>

    57 #include <QtCore/qcoreevent.h>

    58 #include <QtCore/qhash.h>

    59 #include <QtCore/qvariant.h>

    60 #include <QtCore/qscopedpointer.h>

    61 

    62 QT_BEGIN_NAMESPACE

    63 

    64 class QDataStream;

    65 class QScriptDebuggerValue;

    66 

    67 class QScriptDebuggerEventPrivate;

    68 class Q_AUTOTEST_EXPORT QScriptDebuggerEvent

    69 {

    70 public:

    71     friend Q_AUTOTEST_EXPORT QDataStream &operator<<(QDataStream &, const QScriptDebuggerEvent &);

    72     friend Q_AUTOTEST_EXPORT QDataStream &operator>>(QDataStream &, QScriptDebuggerEvent &);

    73 

    74     enum Type {

    75         None,

    76         Interrupted,

    77         SteppingFinished,

    78         LocationReached,

    79         Breakpoint,

    80         Exception,

    81         Trace,

    82         InlineEvalFinished,

    83         DebuggerInvocationRequest,

    84         ForcedReturn,

    85         UserEvent = 1000,

    86         MaxUserEvent = 32767

    87     };

    88 

    89     enum Attribute {

    90         ScriptID,

    91         FileName,

    92         BreakpointID,

    93         LineNumber,

    94         ColumnNumber,

    95         Value,

    96         Message,

    97         IsNestedEvaluate,

    98         HasExceptionHandler,

    99         UserAttribute = 1000,

   100         MaxUserAttribute = 32767

   101     };

   102 

   103     QScriptDebuggerEvent();

   104     QScriptDebuggerEvent(Type type);

   105     QScriptDebuggerEvent(Type type, qint64 scriptId, int lineNumber, int columnNumber);

   106     QScriptDebuggerEvent(const QScriptDebuggerEvent &other);

   107     ~QScriptDebuggerEvent();

   108 

   109     Type type() const;

   110 

   111     QVariant attribute(Attribute attribute,

   112                        const QVariant &defaultValue = QVariant()) const;

   113     void setAttribute(Attribute attribute, const QVariant &value);

   114     QHash<Attribute, QVariant> attributes() const;

   115 

   116     qint64 scriptId() const;

   117     void setScriptId(qint64 id);

   118     QString fileName() const;

   119     void setFileName(const QString &fileName);

   120     int lineNumber() const;

   121     void setLineNumber(int lineNumber);

   122     int columnNumber() const;

   123     void setColumnNumber(int columnNumber);

   124     int breakpointId() const;

   125     void setBreakpointId(int id);

   126     QString message() const;

   127     void setMessage(const QString &message);

   128     QScriptDebuggerValue scriptValue() const;

   129     void setScriptValue(const QScriptDebuggerValue &value);

   130     void setNestedEvaluate(bool nested);

   131     bool isNestedEvaluate() const;

   132     void setHasExceptionHandler(bool hasHandler);

   133     bool hasExceptionHandler() const;

   134 

   135     QScriptDebuggerEvent &operator=(const QScriptDebuggerEvent &other);

   136 

   137     bool operator==(const QScriptDebuggerEvent &other) const;

   138     bool operator!=(const QScriptDebuggerEvent &other) const;

   139 

   140 private:

   141     QScopedPointer<QScriptDebuggerEventPrivate> d_ptr;

   142 

   143     Q_DECLARE_PRIVATE(QScriptDebuggerEvent)

   144 };

   145 

   146 Q_AUTOTEST_EXPORT QDataStream &operator<<(QDataStream &, const QScriptDebuggerEvent &);

   147 Q_AUTOTEST_EXPORT QDataStream &operator>>(QDataStream &, QScriptDebuggerEvent &);

   148 

   149 // helper class that's used to transport a debugger event through the Qt event loop

   150 class QScriptDebuggerEventEvent : public QEvent

   151 {

   152 public:

   153     QScriptDebuggerEventEvent(const QScriptDebuggerEvent &event)

   154         : QEvent(QEvent::Type(QEvent::User+1)), m_event(event) {}

   155     ~QScriptDebuggerEventEvent() {}

   156     const QScriptDebuggerEvent &event() const

   157         { return m_event; }

   158 private:

   159     QScriptDebuggerEvent m_event;

   160 };

   161 

   162 QT_END_NAMESPACE

   163 

   164 #endif