src/scripttools/debugging/qscriptdebuggerresponse_p.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 QtSCriptTools module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** Commercial Usage
  11 ** Licensees holding valid Qt Commercial licenses may use this file in
  12 ** accordance with the Qt Commercial License Agreement provided with the
  13 ** Software or, alternatively, in accordance with the terms contained in
  14 ** a written agreement between you and Nokia.
  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 ** 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 have questions regarding the use of this file, please contact
  37 ** Nokia at qt-info@nokia.com.
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QSCRIPTDEBUGGERRESPONSE_P_H
  43 #define QSCRIPTDEBUGGERRESPONSE_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
  58 #include <QtCore/qmap.h>
  59 #include <QtCore/qvariant.h>
  60
  61 #include "qscriptbreakpointdata_p.h"
  62 #include "qscriptscriptdata_p.h"
  63 #include "qscriptdebuggervalue_p.h"
  64 #include "qscriptdebuggervalueproperty_p.h"
  65
  66 QT_BEGIN_NAMESPACE
  67
  68 class QDataStream;
  69 class QScriptContextInfo;
  70
  71 class QScriptDebuggerResponsePrivate;
  72 class Q_AUTOTEST_EXPORT QScriptDebuggerResponse
  73 {
  74 public:
  75     friend Q_AUTOTEST_EXPORT QDataStream &operator<<(QDataStream &, const QScriptDebuggerResponse &);
  76     friend Q_AUTOTEST_EXPORT QDataStream &operator>>(QDataStream &, QScriptDebuggerResponse &);
  77
  78     enum Error {
  79         NoError,
  80         InvalidContextIndex,
  81         InvalidArgumentIndex,
  82         InvalidScriptID,
  83         InvalidBreakpointID,
  84         UserError = 1000,
  85         MaxUserError = 32767
  86     };
  87
  88     QScriptDebuggerResponse();
  89     QScriptDebuggerResponse(const QScriptDebuggerResponse &other);
  90     ~QScriptDebuggerResponse();
  91
  92     Error error() const;
  93     void setError(Error error);
  94
  95     QVariant result() const;
  96     void setResult(const QVariant &value);
  97
  98     void setResult(int value);
  99     void setResult(const QString &value);
 100     void setResult(const QScriptBreakpointData &data);
 101     void setResult(const QScriptBreakpointMap &breakpoints);
 102     void setResult(const QScriptScriptMap &scripts);
 103     void setResult(const QScriptScriptData &data);
 104     void setResult(const QScriptDebuggerValue &value);
 105     void setResult(const QScriptDebuggerValueList &value);
 106     void setResult(const QScriptDebuggerValuePropertyList &props);
 107     void setResult(const QScriptContextInfo &info);
 108
 109     int resultAsInt() const;
 110     qint64 resultAsLongLong() const;
 111     QString resultAsString() const;
 112     QScriptBreakpointData resultAsBreakpointData() const;
 113     QScriptBreakpointMap resultAsBreakpoints() const;
 114     QScriptScriptMap resultAsScripts() const;
 115     QScriptScriptData resultAsScriptData() const;
 116     QScriptDebuggerValue resultAsScriptValue() const;
 117     QScriptDebuggerValueList resultAsScriptValueList() const;
 118     QScriptDebuggerValuePropertyList resultAsScriptValuePropertyList() const;
 119     QScriptContextInfo resultAsContextInfo() const;
 120
 121     bool async() const;
 122     void setAsync(bool async);
 123
 124     QScriptDebuggerResponse &operator=(const QScriptDebuggerResponse &other);
 125
 126     bool operator==(const QScriptDebuggerResponse &other) const;
 127     bool operator!=(const QScriptDebuggerResponse &other) const;
 128
 129 private:
 130     QScriptDebuggerResponsePrivate *d_ptr;
 131
 132     Q_DECLARE_PRIVATE(QScriptDebuggerResponse)
 133 };
 134
 135 Q_AUTOTEST_EXPORT QDataStream &operator<<(QDataStream &, const QScriptDebuggerResponse &);
 136 Q_AUTOTEST_EXPORT QDataStream &operator>>(QDataStream &, QScriptDebuggerResponse &);
 137
 138 QT_END_NAMESPACE
 139
 140 #endif