[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / html / HTMLCanvasElement.h
1 /*
2  * Copyright (C) 2004, 2006, 2009, 2010 Apple Inc. All rights reserved.
3  * Copyright (C) 2007 Alp Toker <alp@atoker.com>
4  * Copyright (C) 2010 Torch Mobile (Beijing) Co. Ltd. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #pragma once
29
30 #include "FloatRect.h"
31 #include "HTMLElement.h"
32 #include "IntSize.h"
33 #include <memory>
34 #include <wtf/Forward.h>
35
36 namespace WebCore {
37
38 class CanvasContextAttributes;
39 class CanvasRenderingContext;
40 class GraphicsContext;
41 class GraphicsContextStateSaver;
42 class HTMLCanvasElement;
43 class Image;
44 class ImageBuffer;
45 class ImageData;
46
47 namespace DisplayList {
48 using AsTextFlags = unsigned;
49 }
50
51 class CanvasObserver {
52 public:
53     virtual ~CanvasObserver() { }
54
55     virtual void canvasChanged(HTMLCanvasElement&, const FloatRect& changedRect) = 0;
56     virtual void canvasResized(HTMLCanvasElement&) = 0;
57     virtual void canvasDestroyed(HTMLCanvasElement&) = 0;
58 };
59
60 class HTMLCanvasElement final : public HTMLElement {
61 public:
62     static Ref<HTMLCanvasElement> create(Document&);
63     static Ref<HTMLCanvasElement> create(const QualifiedName&, Document&);
64     virtual ~HTMLCanvasElement();
65
66     void addObserver(CanvasObserver&);
67     void removeObserver(CanvasObserver&);
68
69     unsigned width() const { return size().width(); }
70     unsigned height() const { return size().height(); }
71
72     const IntSize& size() const { return m_size; }
73
74     WEBCORE_EXPORT void setWidth(unsigned);
75     WEBCORE_EXPORT void setHeight(unsigned);
76
77     void setSize(const IntSize& newSize)
78     { 
79         if (newSize == size())
80             return;
81         m_ignoreReset = true; 
82         setWidth(newSize.width());
83         setHeight(newSize.height());
84         m_ignoreReset = false;
85         reset();
86     }
87
88     CanvasRenderingContext* getContext(const String&, CanvasContextAttributes* = nullptr);
89     static bool is2dType(const String&);
90 #if ENABLE(WEBGL)
91     static bool is3dType(const String&);
92 #endif
93
94     static String toEncodingMimeType(const String& mimeType);
95     WEBCORE_EXPORT ExceptionOr<String> toDataURL(const String& mimeType, std::optional<double> quality);
96     ExceptionOr<String> toDataURL(const String& mimeType) { return toDataURL(mimeType, std::nullopt); }
97
98     // Used for rendering
99     void didDraw(const FloatRect&);
100     void notifyObserversCanvasChanged(const FloatRect&);
101
102     void paint(GraphicsContext&, const LayoutRect&);
103
104     GraphicsContext* drawingContext() const;
105     GraphicsContext* existingDrawingContext() const;
106
107     CanvasRenderingContext* renderingContext() const { return m_context.get(); }
108
109     ImageBuffer* buffer() const;
110     Image* copiedImage() const;
111     void clearCopiedImage();
112     RefPtr<ImageData> getImageData();
113     void makePresentationCopy();
114     void clearPresentationCopy();
115
116     FloatRect convertLogicalToDevice(const FloatRect&) const;
117     FloatSize convertLogicalToDevice(const FloatSize&) const;
118
119     FloatSize convertDeviceToLogical(const FloatSize&) const;
120
121     SecurityOrigin* securityOrigin() const;
122     void setOriginTainted() { m_originClean = false; }
123     bool originClean() const { return m_originClean; }
124
125     AffineTransform baseTransform() const;
126
127     void makeRenderingResultsAvailable();
128     bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
129
130     bool shouldAccelerate(const IntSize&) const;
131
132     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
133     WEBCORE_EXPORT void setTracksDisplayListReplay(bool);
134     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
135     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
136
137     size_t memoryCost() const;
138     size_t externalMemoryCost() const;
139
140 private:
141     HTMLCanvasElement(const QualifiedName&, Document&);
142
143     void parseAttribute(const QualifiedName&, const AtomicString&) final;
144     RenderPtr<RenderElement> createElementRenderer(RenderStyle&&, const RenderTreePosition&) final;
145
146     bool canContainRangeEndPoint() const final;
147     bool canStartSelection() const final;
148
149     void reset();
150
151     void createImageBuffer() const;
152     void clearImageBuffer() const;
153
154     void setSurfaceSize(const IntSize&);
155     void setImageBuffer(std::unique_ptr<ImageBuffer>) const;
156     void releaseImageBufferAndContext();
157
158     bool paintsIntoCanvasBuffer() const;
159
160 #if ENABLE(WEBGL)
161     bool is3D() const;
162 #endif
163
164     HashSet<CanvasObserver*> m_observers;
165     std::unique_ptr<CanvasRenderingContext> m_context;
166
167     FloatRect m_dirtyRect;
168     IntSize m_size;
169
170     bool m_originClean { true };
171     bool m_ignoreReset { false };
172
173     bool m_usesDisplayListDrawing { false };
174     bool m_tracksDisplayListReplay { false };
175
176     // m_createdImageBuffer means we tried to malloc the buffer.  We didn't necessarily get it.
177     mutable bool m_hasCreatedImageBuffer { false };
178     mutable bool m_didClearImageBuffer { false };
179     mutable std::unique_ptr<ImageBuffer> m_imageBuffer;
180     mutable std::unique_ptr<GraphicsContextStateSaver> m_contextStateSaver;
181     
182     mutable RefPtr<Image> m_presentedImage;
183     mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).
184 };
185
186 } // namespace WebCore