Web Inspector: provide way for ShaderPrograms to be enabled/disabled
[WebKit-https.git] / Source / WebCore / inspector / InspectorCanvasAgent.h
1 /*
2  * Copyright (C) 2017 Apple 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
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "CallTracerTypes.h"
29 #include "HTMLCanvasElement.h"
30 #include "InspectorCanvas.h"
31 #include "InspectorWebAgentBase.h"
32 #include "Timer.h"
33 #include <inspector/InspectorBackendDispatchers.h>
34 #include <inspector/InspectorFrontendDispatchers.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/RefPtr.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/WTFString.h>
39
40 #if ENABLE(WEBGL)
41 #include "InspectorShaderProgram.h"
42 #endif
43
44 namespace Inspector {
45 class InjectedScriptManager;
46 }
47
48 namespace WebCore {
49
50 class CanvasRenderingContext;
51 #if ENABLE(WEBGL)
52 class WebGLProgram;
53 class WebGLRenderingContextBase;
54 #endif
55
56 typedef String ErrorString;
57
58 class InspectorCanvasAgent final : public InspectorAgentBase, public CanvasObserver, public Inspector::CanvasBackendDispatcherHandler {
59     WTF_MAKE_NONCOPYABLE(InspectorCanvasAgent);
60     WTF_MAKE_FAST_ALLOCATED;
61 public:
62     explicit InspectorCanvasAgent(WebAgentContext&);
63     virtual ~InspectorCanvasAgent() { }
64
65     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*) override;
66     void willDestroyFrontendAndBackend(Inspector::DisconnectReason) override;
67     void discardAgent() override;
68
69     // CanvasBackendDispatcherHandler
70     void enable(ErrorString&) override;
71     void disable(ErrorString&) override;
72     void requestNode(ErrorString&, const String& canvasId, int* nodeId) override;
73     void requestContent(ErrorString&, const String& canvasId, String* content) override;
74     void requestCSSCanvasClientNodes(ErrorString&, const String& canvasId, RefPtr<Inspector::Protocol::Array<int>>&) override;
75     void resolveCanvasContext(ErrorString&, const String& canvasId, const String* const objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>&) override;
76     void requestRecording(ErrorString&, const String& canvasId, const bool* const singleFrame, const int* const memoryLimit) override;
77     void cancelRecording(ErrorString&, const String& canvasId) override;
78     void requestShaderSource(ErrorString&, const String& programId, const String& shaderType, String*) override;
79     void updateShader(ErrorString&, const String& programId, const String& shaderType, const String& source) override;
80     void setShaderProgramDisabled(ErrorString&, const String& programId, bool disabled) override;
81
82     // InspectorInstrumentation
83     void frameNavigated(Frame&);
84     void didCreateCSSCanvas(HTMLCanvasElement&, const String&);
85     void didChangeCSSCanvasClientNodes(HTMLCanvasElement&);
86     void didCreateCanvasRenderingContext(HTMLCanvasElement&);
87     void didChangeCanvasMemory(HTMLCanvasElement&);
88     void recordCanvasAction(CanvasRenderingContext&, const String&, Vector<RecordCanvasActionVariant>&& = { });
89     void didFinishRecordingCanvasFrame(HTMLCanvasElement&, bool forceDispatch = false);
90 #if ENABLE(WEBGL)
91     void didCreateProgram(WebGLRenderingContextBase&, WebGLProgram&);
92     void willDeleteProgram(WebGLProgram&);
93     bool isShaderProgramDisabled(WebGLProgram&);
94 #endif
95
96     // CanvasObserver
97     void canvasChanged(HTMLCanvasElement&, const FloatRect&) override { }
98     void canvasResized(HTMLCanvasElement&) override { }
99     void canvasDestroyed(HTMLCanvasElement&) override;
100
101 private:
102     void canvasDestroyedTimerFired();
103     void canvasRecordingTimerFired();
104     void clearCanvasData();
105     String unbindCanvas(InspectorCanvas&);
106     InspectorCanvas* assertInspectorCanvas(ErrorString&, const String& identifier);
107     InspectorCanvas* findInspectorCanvas(HTMLCanvasElement&);
108 #if ENABLE(WEBGL)
109     String unbindProgram(InspectorShaderProgram&);
110     InspectorShaderProgram* assertInspectorProgram(ErrorString&, const String& identifier);
111     InspectorShaderProgram* findInspectorProgram(WebGLProgram&);
112
113     HashMap<String, RefPtr<InspectorShaderProgram>> m_identifierToInspectorProgram;
114 #endif
115
116     std::unique_ptr<Inspector::CanvasFrontendDispatcher> m_frontendDispatcher;
117     RefPtr<Inspector::CanvasBackendDispatcher> m_backendDispatcher;
118     Inspector::InjectedScriptManager& m_injectedScriptManager;
119     HashMap<String, RefPtr<InspectorCanvas>> m_identifierToInspectorCanvas;
120     HashMap<HTMLCanvasElement*, String> m_canvasToCSSCanvasName;
121     Vector<String> m_removedCanvasIdentifiers;
122     Timer m_canvasDestroyedTimer;
123     Timer m_canvasRecordingTimer;
124
125     bool m_enabled { false };
126 };
127
128 } // namespace WebCore