Update test262 to commit 62b8fce38971
[WebKit-https.git] / Source / WebCore / inspector / InspectorCanvas.h
1 /*
2  * Copyright (C) 2017-2018 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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "CallTracerTypes.h"
29 #include "CanvasRenderingContext.h"
30 #include <JavaScriptCore/InspectorProtocolObjects.h>
31 #include <JavaScriptCore/JSCInlines.h>
32 #include <JavaScriptCore/ScriptCallFrame.h>
33 #include <JavaScriptCore/ScriptCallStack.h>
34 #include <initializer_list>
35 #include <wtf/HashSet.h>
36 #include <wtf/Variant.h>
37 #include <wtf/Vector.h>
38 #include <wtf/text/WTFString.h>
39
40 #if ENABLE(WEBGPU)
41 #include "WebGPUDevice.h"
42 #endif
43
44 namespace WebCore {
45
46 class CanvasGradient;
47 class CanvasPattern;
48 class Element;
49 class HTMLCanvasElement;
50 class HTMLImageElement;
51 class HTMLVideoElement;
52 class ImageBitmap;
53 class ImageData;
54 #if ENABLE(OFFSCREEN_CANVAS)
55 class OffscreenCanvas;
56 #endif
57 #if ENABLE(CSS_TYPED_OM)
58 class TypedOMCSSImageValue;
59 #endif
60
61 typedef String ErrorString;
62
63 class InspectorCanvas final : public RefCounted<InspectorCanvas> {
64 public:
65     static Ref<InspectorCanvas> create(CanvasRenderingContext&);
66 #if ENABLE(WEBGPU)
67     static Ref<InspectorCanvas> create(WebGPUDevice&);
68 #endif
69
70     const String& identifier() const { return m_identifier; }
71
72     CanvasRenderingContext* canvasContext() const;
73     HTMLCanvasElement* canvasElement() const;
74
75 #if ENABLE(WEBGPU)
76     WebGPUDevice* deviceContext() const;
77     bool isDeviceForCanvasContext(CanvasRenderingContext&) const;
78 #endif
79
80     ScriptExecutionContext* scriptExecutionContext() const;
81
82     JSC::JSValue resolveContext(JSC::JSGlobalObject*) const;
83
84     HashSet<Element*> clientNodes() const;
85
86     void canvasChanged();
87
88     void resetRecordingData();
89     bool hasRecordingData() const;
90     bool currentFrameHasData() const;
91     void recordAction(const String&, std::initializer_list<RecordCanvasActionVariant>&& = { });
92
93     Ref<JSON::ArrayOf<Inspector::Protocol::Recording::Frame>> releaseFrames() { return m_frames.releaseNonNull(); }
94
95     void finalizeFrame();
96     void markCurrentFrameIncomplete();
97
98     void setRecordingName(const String& name) { m_recordingName = name; }
99
100     void setBufferLimit(long);
101     bool hasBufferSpace() const;
102     long bufferUsed() const { return m_bufferUsed; }
103
104     void setFrameCount(long);
105     bool overFrameCount() const;
106
107     Ref<Inspector::Protocol::Canvas::Canvas> buildObjectForCanvas(bool captureBacktrace);
108     Ref<Inspector::Protocol::Recording::Recording> releaseObjectForRecording();
109
110     String getCanvasContentAsDataURL(ErrorString&);
111
112 private:
113     InspectorCanvas(CanvasRenderingContext&);
114 #if ENABLE(WEBGPU)
115     InspectorCanvas(WebGPUDevice&);
116 #endif
117
118     void appendActionSnapshotIfNeeded();
119
120     using DuplicateDataVariant = Variant<
121         RefPtr<CanvasGradient>,
122         RefPtr<CanvasPattern>,
123         RefPtr<HTMLCanvasElement>,
124         RefPtr<HTMLImageElement>,
125 #if ENABLE(VIDEO)
126         RefPtr<HTMLVideoElement>,
127 #endif
128         RefPtr<ImageData>,
129         RefPtr<ImageBitmap>,
130         RefPtr<Inspector::ScriptCallStack>,
131 #if ENABLE(CSS_TYPED_OM)
132         RefPtr<TypedOMCSSImageValue>,
133 #endif
134         Inspector::ScriptCallFrame,
135 #if ENABLE(OFFSCREEN_CANVAS)
136         RefPtr<OffscreenCanvas>,
137 #endif
138         String
139     >;
140
141     int indexForData(DuplicateDataVariant);
142     String stringIndexForKey(const String&);
143     Ref<Inspector::Protocol::Recording::InitialState> buildInitialState();
144     Ref<JSON::ArrayOf<JSON::Value>> buildAction(const String&, std::initializer_list<RecordCanvasActionVariant>&& = { });
145     Ref<JSON::ArrayOf<JSON::Value>> buildArrayForCanvasGradient(const CanvasGradient&);
146     Ref<JSON::ArrayOf<JSON::Value>> buildArrayForCanvasPattern(const CanvasPattern&);
147     Ref<JSON::ArrayOf<JSON::Value>> buildArrayForImageData(const ImageData&);
148
149     String m_identifier;
150
151     Variant<
152         std::reference_wrapper<CanvasRenderingContext>,
153 #if ENABLE(WEBGPU)
154         std::reference_wrapper<WebGPUDevice>,
155 #endif
156         Monostate
157     > m_context;
158
159     RefPtr<Inspector::Protocol::Recording::InitialState> m_initialState;
160     RefPtr<JSON::ArrayOf<Inspector::Protocol::Recording::Frame>> m_frames;
161     RefPtr<JSON::ArrayOf<JSON::Value>> m_currentActions;
162     RefPtr<JSON::ArrayOf<JSON::Value>> m_lastRecordedAction;
163     RefPtr<JSON::ArrayOf<JSON::Value>> m_serializedDuplicateData;
164     Vector<DuplicateDataVariant> m_indexedDuplicateData;
165
166     String m_recordingName;
167     MonotonicTime m_currentFrameStartTime { MonotonicTime::nan() };
168     size_t m_bufferLimit { 100 * 1024 * 1024 };
169     size_t m_bufferUsed { 0 };
170     Optional<size_t> m_frameCount;
171     size_t m_framesCaptured { 0 };
172     bool m_contentChanged { false };
173 };
174
175 } // namespace WebCore