baedd467cd9717d656bc7376e0eebd223d2c0fa6
[WebKit-https.git] / Source / WebCore / inspector / agents / 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 "CanvasBase.h"
30 #include "InspectorCanvas.h"
31 #include "InspectorWebAgentBase.h"
32 #include "Timer.h"
33 #include <JavaScriptCore/InspectorBackendDispatchers.h>
34 #include <JavaScriptCore/InspectorFrontendDispatchers.h>
35 #include <initializer_list>
36 #include <wtf/HashMap.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/WTFString.h>
40
41 #if ENABLE(WEBGL)
42 #include "InspectorShaderProgram.h"
43 #endif
44
45 namespace Inspector {
46 class InjectedScriptManager;
47 }
48
49 namespace WebCore {
50
51 class CanvasRenderingContext;
52 #if ENABLE(WEBGL)
53 class WebGLProgram;
54 class WebGLRenderingContextBase;
55 #endif
56 #if ENABLE(WEBGPU)
57 class GPUCanvasContext;
58 class WebGPUDevice;
59 class WebGPUSwapChain;
60 #endif
61
62 typedef String ErrorString;
63
64 class InspectorCanvasAgent final : public InspectorAgentBase, public Inspector::CanvasBackendDispatcherHandler, public CanvasObserver {
65     WTF_MAKE_NONCOPYABLE(InspectorCanvasAgent);
66     WTF_MAKE_FAST_ALLOCATED;
67 public:
68     InspectorCanvasAgent(PageAgentContext&);
69     virtual ~InspectorCanvasAgent();
70
71     // InspectorAgentBase
72     void didCreateFrontendAndBackend(Inspector::FrontendRouter*, Inspector::BackendDispatcher*);
73     void willDestroyFrontendAndBackend(Inspector::DisconnectReason);
74     void discardAgent();
75
76     // CanvasBackendDispatcherHandler
77     void enable(ErrorString&);
78     void disable(ErrorString&);
79     void requestNode(ErrorString&, const String& canvasId, int* nodeId);
80     void requestContent(ErrorString&, const String& canvasId, String* content);
81     void requestClientNodes(ErrorString&, const String& canvasId, RefPtr<JSON::ArrayOf<int>>&);
82     void resolveContext(ErrorString&, const String& canvasId, const String* objectGroup, RefPtr<Inspector::Protocol::Runtime::RemoteObject>&);
83     void setRecordingAutoCaptureFrameCount(ErrorString&, int count);
84     void startRecording(ErrorString&, const String& canvasId, const int* frameCount, const int* memoryLimit);
85     void stopRecording(ErrorString&, const String& canvasId);
86     void requestShaderSource(ErrorString&, const String& programId, const String& shaderType, String*);
87     void updateShader(ErrorString&, const String& programId, const String& shaderType, const String& source);
88     void setShaderProgramDisabled(ErrorString&, const String& programId, bool disabled);
89     void setShaderProgramHighlighted(ErrorString&, const String& programId, bool highlighted);
90
91     // CanvasObserver
92     void canvasChanged(CanvasBase&, const FloatRect&);
93     void canvasResized(CanvasBase&) { }
94     void canvasDestroyed(CanvasBase&);
95
96     // InspectorInstrumentation
97     void frameNavigated(Frame&);
98     void didChangeCSSCanvasClientNodes(CanvasBase&);
99     void didCreateCanvasRenderingContext(CanvasRenderingContext&);
100     void didChangeCanvasMemory(CanvasRenderingContext&);
101     void recordCanvasAction(CanvasRenderingContext&, const String&, std::initializer_list<RecordCanvasActionVariant>&& = { });
102     void didFinishRecordingCanvasFrame(CanvasRenderingContext&, bool forceDispatch = false);
103     void consoleStartRecordingCanvas(CanvasRenderingContext&, JSC::ExecState&, JSC::JSObject* options);
104 #if ENABLE(WEBGL)
105     void didEnableExtension(WebGLRenderingContextBase&, const String&);
106     void didCreateProgram(WebGLRenderingContextBase&, WebGLProgram&);
107     void willDeleteProgram(WebGLProgram&);
108     bool isShaderProgramDisabled(WebGLProgram&);
109     bool isShaderProgramHighlighted(WebGLProgram&);
110 #endif
111 #if ENABLE(WEBGPU)
112     void didCreateWebGPUDevice(WebGPUDevice&);
113     void willDestroyWebGPUDevice(WebGPUDevice&);
114     void willConfigureSwapChain(GPUCanvasContext&, WebGPUSwapChain&);
115 #endif
116
117 private:
118     struct RecordingOptions {
119         Optional<long> frameCount;
120         Optional<long> memoryLimit;
121         Optional<String> name;
122     };
123     void startRecording(InspectorCanvas&, Inspector::Protocol::Recording::Initiator, RecordingOptions&& = { });
124
125     void canvasDestroyedTimerFired();
126     void clearCanvasData();
127     InspectorCanvas& bindCanvas(CanvasRenderingContext&, bool captureBacktrace);
128 #if ENABLE(WEBGPU)
129     InspectorCanvas& bindCanvas(WebGPUDevice&, bool captureBacktrace);
130 #endif
131     void unbindCanvas(InspectorCanvas&);
132     RefPtr<InspectorCanvas> assertInspectorCanvas(ErrorString&, const String& canvasId);
133     RefPtr<InspectorCanvas> findInspectorCanvas(CanvasRenderingContext&);
134 #if ENABLE(WEBGPU)
135     RefPtr<InspectorCanvas> findInspectorCanvas(WebGPUDevice&);
136 #endif
137
138 #if ENABLE(WEBGL)
139     String unbindProgram(InspectorShaderProgram&);
140     RefPtr<InspectorShaderProgram> assertInspectorProgram(ErrorString&, const String& programId);
141     RefPtr<InspectorShaderProgram> findInspectorProgram(WebGLProgram&);
142 #endif
143
144     std::unique_ptr<Inspector::CanvasFrontendDispatcher> m_frontendDispatcher;
145     RefPtr<Inspector::CanvasBackendDispatcher> m_backendDispatcher;
146
147     Inspector::InjectedScriptManager& m_injectedScriptManager;
148     Page& m_inspectedPage;
149
150     HashMap<String, RefPtr<InspectorCanvas>> m_identifierToInspectorCanvas;
151 #if ENABLE(WEBGL)
152     HashMap<String, RefPtr<InspectorShaderProgram>> m_identifierToInspectorProgram;
153 #endif
154     Vector<String> m_removedCanvasIdentifiers;
155
156     Optional<size_t> m_recordingAutoCaptureFrameCount;
157
158     Timer m_canvasDestroyedTimer;
159 };
160
161 } // namespace WebCore