src/qml/debugger/qqmldebugserver_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** Contact: http://www.qt-project.org/
   5 **
   6 ** This file is part of the QtQml module of the Qt Toolkit.
   7 **
   8 ** $QT_BEGIN_LICENSE:LGPL$
   9 ** GNU Lesser General Public License Usage
  10 ** This file may be used under the terms of the GNU Lesser General Public
  11 ** License version 2.1 as published by the Free Software Foundation and
  12 ** appearing in the file LICENSE.LGPL included in the packaging of this
  13 ** file. Please review the following information to ensure the GNU Lesser
  14 ** General Public License version 2.1 requirements will be met:
  15 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  16 **
  17 ** In addition, as a special exception, Nokia gives you certain additional
  18 ** rights. These rights are described in the Nokia Qt LGPL Exception
  19 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  20 **
  21 ** GNU General Public License Usage
  22 ** Alternatively, this file may be used under the terms of the GNU General
  23 ** Public License version 3.0 as published by the Free Software Foundation
  24 ** and appearing in the file LICENSE.GPL included in the packaging of this
  25 ** file. Please review the following information to ensure the GNU General
  26 ** Public License version 3.0 requirements will be met:
  27 ** http://www.gnu.org/copyleft/gpl.html.
  28 **
  29 ** Other Usage
  30 ** Alternatively, this file may be used in accordance with the terms and
  31 ** conditions contained in a signed written agreement between you and Nokia.
  32 **
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QQMLDEBUGSERVER_H
  43 #define QQMLDEBUGSERVER_H
  44
  45 #include <QtQml/qtqmlglobal.h>
  46 #include <private/qqmldebugserverconnection_p.h>
  47
  48 //
  49 //  W A R N I N G
  50 //  -------------
  51 //
  52 // This file is not part of the Qt API.  It exists purely as an
  53 // implementation detail.  This header file may change from version to
  54 // version without notice, or even be removed.
  55 //
  56 // We mean it.
  57 //
  58
  59 QT_BEGIN_HEADER
  60
  61 QT_BEGIN_NAMESPACE
  62
  63
  64 class QQmlDebugService;
  65
  66 class QQmlDebugServerPrivate;
  67 class Q_QML_EXPORT QQmlDebugServer : public QObject
  68 {
  69     Q_OBJECT
  70     Q_DECLARE_PRIVATE(QQmlDebugServer)
  71     Q_DISABLE_COPY(QQmlDebugServer)
  72 public:
  73     ~QQmlDebugServer();
  74
  75     static QQmlDebugServer *instance();
  76
  77     void setConnection(QQmlDebugServerConnection *connection);
  78
  79     bool hasDebuggingClient() const;
  80
  81     QList<QQmlDebugService*> services() const;
  82     QStringList serviceNames() const;
  83
  84
  85     bool addService(QQmlDebugService *service);
  86     bool removeService(QQmlDebugService *service);
  87
  88     void receiveMessage(const QByteArray &message);
  89
  90     bool waitForMessage(QQmlDebugService *service);
  91     void sendMessages(QQmlDebugService *service, const QList<QByteArray> &messages);
  92
  93 private:
  94     friend class QQmlDebugService;
  95     friend class QQmlDebugServicePrivate;
  96     friend class QQmlDebugServerThread;
  97     QQmlDebugServer();
  98     Q_PRIVATE_SLOT(d_func(), void _q_sendMessages(QList<QByteArray>))
  99 };
 100
 101 QT_END_NAMESPACE
 102
 103 QT_END_HEADER
 104
 105 #endif // QQMLDEBUGSERVICE_H