26c86710345bb725bdd700e4c685d7580d7730cd
[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 <JavaScriptCore/InspectorProtocolObjects.h>
30 #include <JavaScriptCore/ScriptCallFrame.h>
31 #include <JavaScriptCore/ScriptCallStack.h>
32 #include <wtf/Variant.h>
33 #include <wtf/Vector.h>
34 #include <wtf/text/WTFString.h>
35
36 namespace WebCore {
37
38 class CanvasGradient;
39 class CanvasPattern;
40 class CanvasRenderingContext;
41 class HTMLCanvasElement;
42 class HTMLImageElement;
43 class HTMLVideoElement;
44 class ImageBitmap;
45 class ImageData;
46
47 typedef String ErrorString;
48
49 class InspectorCanvas final : public RefCounted<InspectorCanvas> {
50 public:
51     static Ref<InspectorCanvas> create(CanvasRenderingContext&);
52
53     const String& identifier() { return m_identifier; }
54     CanvasRenderingContext& context() { return m_context; }
55
56     HTMLCanvasElement* canvasElement();
57
58     void resetRecordingData();
59     bool hasRecordingData() const;
60     bool currentFrameHasData() const;
61     void recordAction(const String&, Vector<RecordCanvasActionVariant>&& = { });
62
63     Ref<JSON::ArrayOf<Inspector::Protocol::Recording::Frame>> releaseFrames() { return m_frames.releaseNonNull(); }
64
65     void finalizeFrame();
66     void markCurrentFrameIncomplete();
67
68     void setRecordingName(const String& name) { m_recordingName = name; }
69
70     void setBufferLimit(long);
71     bool hasBufferSpace() const;
72     long bufferUsed() const { return m_bufferUsed; }
73
74     void setFrameCount(long);
75     bool overFrameCount() const;
76
77     Ref<Inspector::Protocol::Canvas::Canvas> buildObjectForCanvas(bool captureBacktrace);
78     Ref<Inspector::Protocol::Recording::Recording> releaseObjectForRecording();
79
80     String getCanvasContentAsDataURL(ErrorString&);
81
82 private:
83     InspectorCanvas(CanvasRenderingContext&);
84     void appendActionSnapshotIfNeeded();
85
86     using DuplicateDataVariant = Variant<
87         RefPtr<CanvasGradient>,
88         RefPtr<CanvasPattern>,
89         RefPtr<HTMLCanvasElement>,
90         RefPtr<HTMLImageElement>,
91 #if ENABLE(VIDEO)
92         RefPtr<HTMLVideoElement>,
93 #endif
94         RefPtr<ImageData>,
95         RefPtr<ImageBitmap>,
96         RefPtr<Inspector::ScriptCallStack>,
97         Inspector::ScriptCallFrame,
98         String
99     >;
100
101     int indexForData(DuplicateDataVariant);
102     String stringIndexForKey(const String&);
103     Ref<Inspector::Protocol::Recording::InitialState> buildInitialState();
104     Ref<JSON::ArrayOf<JSON::Value>> buildAction(const String&, Vector<RecordCanvasActionVariant>&& = { });
105     Ref<JSON::ArrayOf<JSON::Value>> buildArrayForCanvasGradient(const CanvasGradient&);
106     Ref<JSON::ArrayOf<JSON::Value>> buildArrayForCanvasPattern(const CanvasPattern&);
107     Ref<JSON::ArrayOf<JSON::Value>> buildArrayForImageData(const ImageData&);
108
109     String m_identifier;
110     CanvasRenderingContext& m_context;
111
112     RefPtr<Inspector::Protocol::Recording::InitialState> m_initialState;
113     RefPtr<JSON::ArrayOf<Inspector::Protocol::Recording::Frame>> m_frames;
114     RefPtr<JSON::ArrayOf<JSON::Value>> m_currentActions;
115     RefPtr<JSON::ArrayOf<JSON::Value>> m_actionNeedingSnapshot;
116     RefPtr<JSON::ArrayOf<JSON::Value>> m_serializedDuplicateData;
117     Vector<DuplicateDataVariant> m_indexedDuplicateData;
118
119     String m_recordingName;
120     MonotonicTime m_currentFrameStartTime { MonotonicTime::nan() };
121     size_t m_bufferLimit { 100 * 1024 * 1024 };
122     size_t m_bufferUsed { 0 };
123     Optional<size_t> m_frameCount;
124     size_t m_framesCaptured { 0 };
125 };
126
127 } // namespace WebCore