src/declarative/debugger/qdeclarativedebugtrace_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2011 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 QtDeclarative module of the Qt Toolkit.
   8 **
   9 ** $QT_BEGIN_LICENSE:LGPL$
  10 ** GNU Lesser General Public License Usage
  11 ** This file may be used under the terms of the GNU Lesser General Public
  12 ** License version 2.1 as published by the Free Software Foundation and
  13 ** appearing in the file LICENSE.LGPL included in the packaging of this
  14 ** file. Please review the following information to ensure the GNU Lesser
  15 ** General Public License version 2.1 requirements will be met:
  16 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  17 **
  18 ** In addition, as a special exception, Nokia gives you certain additional
  19 ** rights. These rights are described in the Nokia Qt LGPL Exception
  20 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  21 **
  22 ** GNU General Public License Usage
  23 ** Alternatively, this file may be used under the terms of the GNU General
  24 ** Public License version 3.0 as published by the Free Software Foundation
  25 ** and appearing in the file LICENSE.GPL included in the packaging of this
  26 ** file. Please review the following information to ensure the GNU General
  27 ** Public License version 3.0 requirements will be met:
  28 ** http://www.gnu.org/copyleft/gpl.html.
  29 **
  30 ** Other Usage
  31 ** Alternatively, this file may be used in accordance with the terms and
  32 ** conditions contained in a signed written agreement between you and Nokia.
  33 **
  34 **
  35 **
  36 **
  37 **
  38 ** $QT_END_LICENSE$
  39 **
  40 ****************************************************************************/
  41
  42 #ifndef QDECLARATIVEDEBUGTRACE_P_H
  43 #define QDECLARATIVEDEBUGTRACE_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 <private/qdeclarativedebugservice_p.h>
  57 #include <QtCore/qelapsedtimer.h>
  58 #include <QtCore/qmutex.h>
  59
  60 QT_BEGIN_HEADER
  61
  62 QT_BEGIN_NAMESPACE
  63
  64 struct QDeclarativeDebugData
  65 {
  66     qint64 time;
  67     int messageType;
  68     int detailType;
  69
  70     //###
  71     QString detailData; //used by RangeData and RangeLocation
  72     int line;           //used by RangeLocation
  73     int framerate;      //used by animation events
  74     int animationcount; //used by animation events
  75
  76     QByteArray toByteArray() const;
  77 };
  78
  79 class QUrl;
  80 class QDeclarativeEngine;
  81
  82 class Q_DECLARATIVE_EXPORT QDeclarativeDebugTrace : public QDeclarativeDebugService
  83 {
  84 public:
  85     enum Message {
  86         Event,
  87         RangeStart,
  88         RangeData,
  89         RangeLocation,
  90         RangeEnd,
  91         Complete,
  92
  93         MaximumMessage
  94     };
  95
  96     enum EventType {
  97         FramePaint,
  98         Mouse,
  99         Key,
 100         AnimationFrame,
 101         EndTrace,
 102
 103         MaximumEventType
 104     };
 105
 106     enum RangeType {
 107         Painting,
 108         Compiling,
 109         Creating,
 110         Binding,            //running a binding
 111         HandlingSignal,     //running a signal handler
 112
 113         MaximumRangeType
 114     };
 115
 116     static void addEngine(QDeclarativeEngine *engine);
 117     static void removeEngine(QDeclarativeEngine *engine);
 118
 119     static void addEvent(EventType);
 120
 121     static void startRange(RangeType);
 122     static void rangeData(RangeType, const QString &);
 123     static void rangeData(RangeType, const QUrl &);
 124     static void rangeLocation(RangeType, const QString &, int);
 125     static void rangeLocation(RangeType, const QUrl &, int);
 126     static void endRange(RangeType);
 127     static void animationFrame(qint64);
 128
 129     QDeclarativeDebugTrace();
 130     ~QDeclarativeDebugTrace();
 131 protected:
 132     virtual void messageReceived(const QByteArray &);
 133 private:
 134     void addEventImpl(EventType);
 135     void startRangeImpl(RangeType);
 136     void rangeDataImpl(RangeType, const QString &);
 137     void rangeDataImpl(RangeType, const QUrl &);
 138     void rangeLocationImpl(RangeType, const QString &, int);
 139     void rangeLocationImpl(RangeType, const QUrl &, int);
 140     void endRangeImpl(RangeType);
 141     void animationFrameImpl(qint64);
 142     void processMessage(const QDeclarativeDebugData &);
 143     void sendMessages();
 144     QElapsedTimer m_timer;
 145     bool m_enabled;
 146     bool m_deferredSend;
 147     bool m_messageReceived;
 148     QList<QDeclarativeDebugData> m_data;
 149     QMutex m_mutex;
 150 };
 151
 152 QT_END_NAMESPACE
 153
 154 QT_END_HEADER
 155
 156 #endif // QDECLARATIVEDEBUGTRACE_P_H
 157