src/declarative/debugger/qdeclarativedebugtrace_p.h

   1 /****************************************************************************
   2 **
   3 ** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
   4 ** All rights reserved.
   5 ** Contact: http://www.qt-project.org/
   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 #include <QtCore/qvector.h>
  60
  61 QT_BEGIN_HEADER
  62
  63 QT_BEGIN_NAMESPACE
  64
  65 struct Q_AUTOTEST_EXPORT QDeclarativeDebugData
  66 {
  67     qint64 time;
  68     int messageType;
  69     int detailType;
  70
  71     //###
  72     QString detailData; //used by RangeData and RangeLocation
  73     int line;           //used by RangeLocation
  74     int column;         //used by RangeLocation
  75     int framerate;      //used by animation events
  76     int animationcount; //used by animation events
  77
  78     QByteArray toByteArray() const;
  79 };
  80
  81 Q_DECLARE_TYPEINFO(QDeclarativeDebugData, Q_MOVABLE_TYPE);
  82
  83 class QUrl;
  84 class QDeclarativeEngine;
  85
  86 class Q_DECLARATIVE_EXPORT QDeclarativeDebugTrace : public QDeclarativeDebugService
  87 {
  88 public:
  89     enum Message {
  90         Event,
  91         RangeStart,
  92         RangeData,
  93         RangeLocation,
  94         RangeEnd,
  95         Complete,
  96
  97         MaximumMessage
  98     };
  99
 100     enum EventType {
 101         FramePaint,
 102         Mouse,
 103         Key,
 104         AnimationFrame,
 105         EndTrace,
 106         StartTrace,
 107
 108         MaximumEventType
 109     };
 110
 111     enum RangeType {
 112         Painting,
 113         Compiling,
 114         Creating,
 115         Binding,            //running a binding
 116         HandlingSignal,     //running a signal handler
 117
 118         MaximumRangeType
 119     };
 120
 121     static void initialize();
 122
 123     static bool startProfiling();
 124     static bool stopProfiling();
 125     static void addEvent(EventType);
 126     static void startRange(RangeType);
 127     static void rangeData(RangeType, const QString &);
 128     static void rangeData(RangeType, const QUrl &);
 129     static void rangeLocation(RangeType, const QString &, int, int);
 130     static void rangeLocation(RangeType, const QUrl &, int, int);
 131     static void endRange(RangeType);
 132     static void animationFrame(qint64);
 133
 134     static void sendProfilingData();
 135
 136     QDeclarativeDebugTrace();
 137     ~QDeclarativeDebugTrace();
 138
 139 protected:
 140     virtual void messageReceived(const QByteArray &);
 141
 142 private:
 143     bool startProfilingImpl();
 144     bool stopProfilingImpl();
 145     void addEventImpl(EventType);
 146     void startRangeImpl(RangeType);
 147     void rangeDataImpl(RangeType, const QString &);
 148     void rangeDataImpl(RangeType, const QUrl &);
 149     void rangeLocationImpl(RangeType, const QString &, int, int);
 150     void rangeLocationImpl(RangeType, const QUrl &, int, int);
 151     void endRangeImpl(RangeType);
 152     void animationFrameImpl(qint64);
 153
 154     bool profilingEnabled();
 155     void setProfilingEnabled(bool enable);
 156     void sendMessages();
 157     void processMessage(const QDeclarativeDebugData &);
 158
 159 private:
 160     QElapsedTimer m_timer;
 161     bool m_enabled;
 162     bool m_messageReceived;
 163     QVector<QDeclarativeDebugData> m_data;
 164     QMutex m_mutex;
 165 };
 166
 167 QT_END_NAMESPACE
 168
 169 QT_END_HEADER
 170
 171 #endif // QDECLARATIVEDEBUGTRACE_P_H
 172