2010-07-12 Ilya Tikhonovsky <loislo@chromium.org>
[WebKit-https.git] / WebCore / inspector / InspectorTimelineAgent.h
1 /*
2 * Copyright (C) 2009 Google Inc. All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions are
6 * met:
7 *
8 *     * Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 *     * Redistributions in binary form must reproduce the above
11 * copyright notice, this list of conditions and the following disclaimer
12 * in the documentation and/or other materials provided with the
13 * distribution.
14 *     * Neither the name of Google Inc. nor the names of its
15 * contributors may be used to endorse or promote products derived from
16 * this software without specific prior written permission.
17 *
18 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29 */
30
31 #ifndef InspectorTimelineAgent_h
32 #define InspectorTimelineAgent_h
33
34 #if ENABLE(INSPECTOR)
35
36 #include "Document.h"
37 #include "InspectorValues.h"
38 #include "ScriptExecutionContext.h"
39 #include "ScriptGCEvent.h"
40 #include "ScriptGCEventListener.h"
41 #include <wtf/Vector.h>
42
43 namespace WebCore {
44 class Event;
45 class RemoteInspectorFrontend;
46 class IntRect;
47 class ResourceRequest;
48 class ResourceResponse;
49
50 // Must be kept in sync with TimelineAgent.js
51 enum TimelineRecordType {
52     EventDispatchTimelineRecordType = 0,
53     LayoutTimelineRecordType = 1,
54     RecalculateStylesTimelineRecordType = 2,
55     PaintTimelineRecordType = 3,
56     ParseHTMLTimelineRecordType = 4,
57     TimerInstallTimelineRecordType = 5,
58     TimerRemoveTimelineRecordType = 6,
59     TimerFireTimelineRecordType = 7,
60     XHRReadyStateChangeRecordType = 8,
61     XHRLoadRecordType = 9,
62     EvaluateScriptTimelineRecordType = 10,
63     MarkTimelineRecordType = 11,
64     ResourceSendRequestTimelineRecordType = 12,
65     ResourceReceiveResponseTimelineRecordType = 13,
66     ResourceFinishTimelineRecordType = 14,
67     FunctionCallTimelineRecordType = 15,
68     ReceiveResourceDataTimelineRecordType = 16,
69     GCEventTimelineRecordType = 17,
70     MarkDOMContentEventType = 18,
71     MarkLoadEventType = 19,
72     ScheduleResourceRequestTimelineRecordType = 20
73 };
74
75 class InspectorTimelineAgent : ScriptGCEventListener, public Noncopyable {
76 public:
77     InspectorTimelineAgent(RemoteInspectorFrontend* frontend);
78     ~InspectorTimelineAgent();
79
80     void reset();
81     void resetFrontendProxyObject(RemoteInspectorFrontend*);
82
83     // Methods called from WebCore.
84     void willCallFunction(const String& scriptName, int scriptLine);
85     void didCallFunction();
86
87     void willDispatchEvent(const Event&);
88     void didDispatchEvent();
89
90     void willLayout();
91     void didLayout();
92
93     void willRecalculateStyle();
94     void didRecalculateStyle();
95
96     void willPaint(const IntRect&);
97     void didPaint();
98
99     // FIXME: |length| should be passed in didWrite instead willWrite
100     // as the parser can not know how much it will process until it tries.
101     void willWriteHTML(unsigned int length, unsigned int startLine);
102     void didWriteHTML(unsigned int endLine);
103
104     void didInstallTimer(int timerId, int timeout, bool singleShot);
105     void didRemoveTimer(int timerId);
106     void willFireTimer(int timerId);
107     void didFireTimer();
108
109     void willChangeXHRReadyState(const String&, int);
110     void didChangeXHRReadyState();
111     void willLoadXHR(const String&);
112     void didLoadXHR();
113
114     void willEvaluateScript(const String&, int);
115     void didEvaluateScript();
116
117     void didMarkTimeline(const String&);
118     void didMarkDOMContentEvent();
119     void didMarkLoadEvent();
120
121     void didScheduleResourceRequest(const String& url);
122     void willSendResourceRequest(unsigned long, bool isMainResource, const ResourceRequest&);
123     void willReceiveResourceResponse(unsigned long, const ResourceResponse&);
124     void didReceiveResourceResponse();
125     void didFinishLoadingResource(unsigned long, bool didFail);
126     void willReceiveResourceData(unsigned long identifier);
127     void didReceiveResourceData();
128         
129     virtual void didGC(double, double, size_t);
130
131     static int instanceCount() { return s_instanceCount; }
132     static InspectorTimelineAgent* retrieve(ScriptExecutionContext*);
133
134 private:
135     struct TimelineRecordEntry {
136         TimelineRecordEntry(PassRefPtr<InspectorObject> record, PassRefPtr<InspectorObject> data, PassRefPtr<InspectorArray> children, TimelineRecordType type)
137             : record(record), data(data), children(children), type(type)
138         {
139         }
140         RefPtr<InspectorObject> record;
141         RefPtr<InspectorObject> data;
142         RefPtr<InspectorArray> children;
143         TimelineRecordType type;
144     };
145         
146     void pushCurrentRecord(PassRefPtr<InspectorObject>, TimelineRecordType);
147     void setHeapSizeStatistic(InspectorObject* record);
148         
149     void didCompleteCurrentRecord(TimelineRecordType);
150
151     void addRecordToTimeline(PassRefPtr<InspectorObject>, TimelineRecordType);
152
153     void pushGCEventRecords();
154
155     RemoteInspectorFrontend* m_frontend;
156
157     Vector<TimelineRecordEntry> m_recordStack;
158     static int s_instanceCount;
159     struct GCEvent {
160         GCEvent(double startTime, double endTime, size_t collectedBytes)
161             : startTime(startTime), endTime(endTime), collectedBytes(collectedBytes)
162         {
163         }
164         double startTime;
165         double endTime;
166         size_t collectedBytes;
167     };
168     typedef Vector<GCEvent> GCEvents;
169     GCEvents m_gcEvents;
170 };
171
172 inline InspectorTimelineAgent* InspectorTimelineAgent::retrieve(ScriptExecutionContext* context)
173 {
174     if (context && context->isDocument())
175         return static_cast<Document*>(context)->inspectorTimelineAgent();
176     return 0;
177 }
178
179 } // namespace WebCore
180
181 #endif // !ENABLE(INSPECTOR)
182 #endif // !defined(InspectorTimelineAgent_h)