Web Inspector: Remove InspectorState
[WebKit-https.git] / Source / WebCore / inspector / InspectorCanvasAgent.h
1 /*
2  * Copyright (C) 2012 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 InspectorCanvasAgent_h
32 #define InspectorCanvasAgent_h
33
34 #if ENABLE(INSPECTOR)
35
36 #include "InspectorBaseAgent.h"
37 #include "InspectorFrontend.h"
38 #include "InspectorTypeBuilder.h"
39 #include "ScriptState.h"
40 #include <wtf/HashMap.h>
41 #include <wtf/PassOwnPtr.h>
42 #include <wtf/PassRefPtr.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace WebCore {
46
47 class Frame;
48 class InjectedScriptCanvasModule;
49 class InjectedScriptManager;
50 class InspectorPageAgent;
51 class InstrumentingAgents;
52 class ScriptObject;
53
54 typedef String ErrorString;
55
56 class InspectorCanvasAgent : public InspectorBaseAgent<InspectorCanvasAgent>, public InspectorBackendDispatcher::CanvasCommandHandler {
57 public:
58     static PassOwnPtr<InspectorCanvasAgent> create(InstrumentingAgents* instrumentingAgents, InspectorPageAgent* pageAgent, InjectedScriptManager* injectedScriptManager)
59     {
60         return adoptPtr(new InspectorCanvasAgent(instrumentingAgents, pageAgent, injectedScriptManager));
61     }
62     ~InspectorCanvasAgent();
63
64     virtual void setFrontend(InspectorFrontend*);
65     virtual void clearFrontend();
66
67     void frameNavigated(Frame*);
68     void frameDetached(Frame*);
69     void didBeginFrame();
70
71     // Called from InspectorCanvasInstrumentation.
72     ScriptObject wrapCanvas2DRenderingContextForInstrumentation(const ScriptObject&);
73 #if ENABLE(WEBGL)
74     ScriptObject wrapWebGLRenderingContextForInstrumentation(const ScriptObject&);
75 #endif
76
77     // Called from the front-end.
78     virtual void enable(ErrorString*);
79     virtual void disable(ErrorString*);
80     virtual void dropTraceLog(ErrorString*, const TypeBuilder::Canvas::TraceLogId&);
81     virtual void hasUninstrumentedCanvases(ErrorString*, bool*);
82     virtual void captureFrame(ErrorString*, const TypeBuilder::Network::FrameId*, TypeBuilder::Canvas::TraceLogId*);
83     virtual void startCapturing(ErrorString*, const TypeBuilder::Network::FrameId*, TypeBuilder::Canvas::TraceLogId*);
84     virtual void stopCapturing(ErrorString*, const TypeBuilder::Canvas::TraceLogId&);
85     virtual void getTraceLog(ErrorString*, const TypeBuilder::Canvas::TraceLogId&, const int*, const int*, RefPtr<TypeBuilder::Canvas::TraceLog>&);
86     virtual void replayTraceLog(ErrorString*, const TypeBuilder::Canvas::TraceLogId&, int, RefPtr<TypeBuilder::Canvas::ResourceState>&);
87     virtual void getResourceInfo(ErrorString*, const TypeBuilder::Canvas::ResourceId&, RefPtr<TypeBuilder::Canvas::ResourceInfo>&);
88     virtual void getResourceState(ErrorString*, const TypeBuilder::Canvas::TraceLogId&, const TypeBuilder::Canvas::ResourceId&, RefPtr<TypeBuilder::Canvas::ResourceState>&);
89
90 private:
91     InspectorCanvasAgent(InstrumentingAgents*, InspectorPageAgent*, InjectedScriptManager*);
92
93     InjectedScriptCanvasModule injectedScriptCanvasModule(ErrorString*, JSC::ExecState*);
94     InjectedScriptCanvasModule injectedScriptCanvasModule(ErrorString*, const ScriptObject&);
95     InjectedScriptCanvasModule injectedScriptCanvasModule(ErrorString*, const String&);
96
97     void findFramesWithUninstrumentedCanvases();
98     bool checkIsEnabled(ErrorString*) const;
99     ScriptObject notifyRenderingContextWasWrapped(const ScriptObject&);
100
101     InspectorPageAgent* m_pageAgent;
102     InjectedScriptManager* m_injectedScriptManager;
103     InspectorFrontend::Canvas* m_frontend;
104     bool m_enabled;
105     // Contains all frames with canvases, value is true only for frames that have an uninstrumented canvas.
106     typedef HashMap<Frame*, bool> FramesWithUninstrumentedCanvases;
107     FramesWithUninstrumentedCanvases m_framesWithUninstrumentedCanvases;
108 };
109
110 } // namespace WebCore
111
112 #endif // ENABLE(INSPECTOR)
113
114 #endif // !defined(InspectorCanvasAgent_h)