1 /****************************************************************************
2 **
3 ** Copyright (C) 2015 The Qt Company Ltd.
4 ** Contact: http://www.qt.io/licensing/
5 **
6 ** This file is part of the QtDeclarative module of the Qt Toolkit.
7 **
8 ** $QT_BEGIN_LICENSE:LGPL$
9 ** Commercial License Usage
10 ** Licensees holding valid commercial Qt licenses may use this file in
11 ** accordance with the commercial license agreement provided with the
12 ** Software or, alternatively, in accordance with the terms contained in
13 ** a written agreement between you and The Qt Company. For licensing terms
14 ** and conditions see http://www.qt.io/terms-conditions. For further
15 ** information use the contact form at http://www.qt.io/contact-us.
16 **
17 ** GNU Lesser General Public License Usage
18 ** Alternatively, this file may be used under the terms of the GNU Lesser
19 ** General Public License version 2.1 or version 3 as published by the Free
20 ** Software Foundation and appearing in the file LICENSE.LGPLv21 and
21 ** LICENSE.LGPLv3 included in the packaging of this file. Please review the
22 ** following information to ensure the GNU Lesser General Public License
23 ** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
24 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
25 **
26 ** As a special exception, The Qt Company gives you certain additional
27 ** rights. These rights are described in The Qt Company LGPL Exception
28 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
29 **
30 ** GNU General Public License Usage
31 ** Alternatively, this file may be used under the terms of the GNU
32 ** General Public License version 3.0 as published by the Free Software
33 ** Foundation and appearing in the file LICENSE.GPL included in the
34 ** packaging of this file.  Please review the following information to
35 ** ensure the GNU General Public License version 3.0 requirements will be
36 ** met: http://www.gnu.org/copyleft/gpl.html.
37 **
38 ** $QT_END_LICENSE$
39 **
40 ****************************************************************************/
41 
42 #ifndef QDECLARATIVEDEBUGTRACE_P_H
43 #define QDECLARATIVEDEBUGTRACE_P_H
44 
45 #include <private/qdeclarativedebugservice_p.h>
46 #include <qelapsedtimer.h>
47 
48 QT_BEGIN_HEADER
49 
50 QT_BEGIN_NAMESPACE
51 
52 struct QDeclarativeDebugData
53 {
54     qint64 time;
55     int messageType;
56     int detailType;
57 
58     //###
59     QString detailData; //used by RangeData and RangeLocation
60     int line;           //used by RangeLocation
61 
62     QByteArray toByteArray() const;
63 };
64 
65 class QUrl;
66 class Q_DECLARATIVE_EXPORT QDeclarativeDebugTrace : public QDeclarativeDebugService
67 {
68 public:
69     enum Message {
70         Event,
71         RangeStart,
72         RangeData,
73         RangeLocation,
74         RangeEnd,
75         Complete,
76 
77         MaximumMessage
78     };
79 
80     enum EventType {
81         FramePaint,
82         Mouse,
83         Key,
84 
85         MaximumEventType
86     };
87 
88     enum RangeType {
89         Painting,
90         Compiling,
91         Creating,
92         Binding,            //running a binding
93         HandlingSignal,     //running a signal handler
94 
95         MaximumRangeType
96     };
97 
98     static void addEvent(EventType);
99 
100     static void startRange(RangeType);
101     static void rangeData(RangeType, const QString &);
102     static void rangeData(RangeType, const QUrl &);
103     static void rangeLocation(RangeType, const QString &, int);
104     static void rangeLocation(RangeType, const QUrl &, int);
105     static void endRange(RangeType);
106 
107     QDeclarativeDebugTrace();
108 #ifdef CUSTOM_DECLARATIVE_DEBUG_TRACE_INSTANCE
109 public:
110     static QDeclarativeDebugTrace* globalInstance();
111     static void setGlobalInstance(QDeclarativeDebugTrace *custom_instance);
112 protected:
113     virtual void messageReceived(const QByteArray &);
114 protected:
115     virtual void addEventImpl(EventType);
116     virtual void startRangeImpl(RangeType);
117     virtual void rangeDataImpl(RangeType, const QString &);
118     virtual void rangeDataImpl(RangeType, const QUrl &);
119     virtual void rangeLocationImpl(RangeType, const QString &, int);
120     virtual void rangeLocationImpl(RangeType, const QUrl &, int);
121     virtual void endRangeImpl(RangeType);
122 #else
123 protected:
124     virtual void messageReceived(const QByteArray &);
125 private:
126     void addEventImpl(EventType);
127     void startRangeImpl(RangeType);
128     void rangeDataImpl(RangeType, const QString &);
129     void rangeDataImpl(RangeType, const QUrl &);
130     void rangeLocationImpl(RangeType, const QString &, int);
131     void rangeLocationImpl(RangeType, const QUrl &, int);
132     void endRangeImpl(RangeType);
133 #endif
134     void processMessage(const QDeclarativeDebugData &);
135     void sendMessages();
136     QElapsedTimer m_timer;
137     bool m_enabled;
138     bool m_deferredSend;
139     bool m_messageReceived;
140     QList<QDeclarativeDebugData> m_data;
141 };
142 
143 QT_END_NAMESPACE
144 
145 QT_END_HEADER
146 
147 #endif // QDECLARATIVEDEBUGTRACE_P_H
148 
149