Allow canvas to use display-list drawing for testing
[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 #ifndef HTMLCanvasElement_h
29 #define HTMLCanvasElement_h
30
31 #include "FloatRect.h"
32 #include "HTMLElement.h"
33 #include "IntSize.h"
34 #include <memory>
35 #include <wtf/Forward.h>
36
37 #if USE(CG)
38 #define DefaultInterpolationQuality InterpolationLow
39 #else
40 #define DefaultInterpolationQuality InterpolationDefault
41 #endif
42
43 namespace WebCore {
44
45 class CanvasContextAttributes;
46 class CanvasRenderingContext;
47 class GraphicsContext;
48 class GraphicsContextStateSaver;
49 class HTMLCanvasElement;
50 class Image;
51 class ImageData;
52 class ImageBuffer;
53 class IntSize;
54
55 namespace DisplayList {
56 typedef unsigned AsTextFlags;
57 }
58
59 class CanvasObserver {
60 public:
61     virtual ~CanvasObserver() { }
62
63     virtual void canvasChanged(HTMLCanvasElement&, const FloatRect& changedRect) = 0;
64     virtual void canvasResized(HTMLCanvasElement&) = 0;
65     virtual void canvasDestroyed(HTMLCanvasElement&) = 0;
66 };
67
68 class HTMLCanvasElement final : public HTMLElement {
69 public:
70     static Ref<HTMLCanvasElement> create(Document&);
71     static Ref<HTMLCanvasElement> create(const QualifiedName&, Document&);
72     virtual ~HTMLCanvasElement();
73
74     void addObserver(CanvasObserver&);
75     void removeObserver(CanvasObserver&);
76
77     // Attributes and functions exposed to script
78     int width() const { return size().width(); }
79     int height() const { return size().height(); }
80
81     const IntSize& size() const { return m_size; }
82
83     void setWidth(int);
84     void setHeight(int);
85
86     void setSize(const IntSize& newSize)
87     { 
88         if (newSize == size())
89             return;
90         m_ignoreReset = true; 
91         setWidth(newSize.width());
92         setHeight(newSize.height());
93         m_ignoreReset = false;
94         reset();
95     }
96
97     CanvasRenderingContext* getContext(const String&, CanvasContextAttributes* attributes = 0);
98     bool probablySupportsContext(const String&, CanvasContextAttributes* = 0);
99     static bool is2dType(const String&);
100 #if ENABLE(WEBGL)
101     static bool is3dType(const String&);
102 #endif
103
104     static String toEncodingMimeType(const String& mimeType);
105     String toDataURL(const String& mimeType, const double* quality, ExceptionCode&);
106     String toDataURL(const String& mimeType, ExceptionCode& ec) { return toDataURL(mimeType, 0, ec); }
107
108     // Used for rendering
109     void didDraw(const FloatRect&);
110     void notifyObserversCanvasChanged(const FloatRect&);
111
112     void paint(GraphicsContext&, const LayoutRect&, bool useLowQualityScale = false);
113
114     GraphicsContext* drawingContext() const;
115     GraphicsContext* existingDrawingContext() const;
116
117     CanvasRenderingContext* renderingContext() const { return m_context.get(); }
118
119     ImageBuffer* buffer() const;
120     Image* copiedImage() const;
121     void clearCopiedImage();
122     RefPtr<ImageData> getImageData();
123     void makePresentationCopy();
124     void clearPresentationCopy();
125
126     FloatRect convertLogicalToDevice(const FloatRect&) const;
127     FloatSize convertLogicalToDevice(const FloatSize&) const;
128
129     FloatSize convertDeviceToLogical(const FloatSize&) const;
130
131     SecurityOrigin* securityOrigin() const;
132     void setOriginTainted() { m_originClean = false; }
133     bool originClean() const { return m_originClean; }
134
135     AffineTransform baseTransform() const;
136
137     void makeRenderingResultsAvailable();
138     bool hasCreatedImageBuffer() const { return m_hasCreatedImageBuffer; }
139
140     bool shouldAccelerate(const IntSize&) const;
141
142     WEBCORE_EXPORT void setUsesDisplayListDrawing(bool);
143     WEBCORE_EXPORT void setTracksDisplayListReplay(bool);
144     WEBCORE_EXPORT String displayListAsText(DisplayList::AsTextFlags) const;
145     WEBCORE_EXPORT String replayDisplayListAsText(DisplayList::AsTextFlags) const;
146
147     size_t memoryCost() const;
148
149 private:
150     HTMLCanvasElement(const QualifiedName&, Document&);
151
152     virtual void parseAttribute(const QualifiedName&, const AtomicString&) override;
153     virtual RenderPtr<RenderElement> createElementRenderer(Ref<RenderStyle>&&, const RenderTreePosition&) override;
154
155     virtual bool canContainRangeEndPoint() const override;
156     virtual bool canStartSelection() const override;
157
158     void reset();
159
160     void createImageBuffer() const;
161     void clearImageBuffer() const;
162
163     void setSurfaceSize(const IntSize&);
164     void setImageBuffer(std::unique_ptr<ImageBuffer>) const;
165     void releaseImageBufferAndContext();
166
167     bool paintsIntoCanvasBuffer() const;
168
169 #if ENABLE(WEBGL)
170     bool is3D() const;
171 #endif
172
173     HashSet<CanvasObserver*> m_observers;
174     std::unique_ptr<CanvasRenderingContext> m_context;
175
176     FloatRect m_dirtyRect;
177     IntSize m_size;
178
179     bool m_originClean { true };
180     bool m_rendererIsCanvas { false };
181     bool m_ignoreReset { false };
182
183     bool m_usesDisplayListDrawing { false };
184     bool m_tracksDisplayListReplay { false };
185
186     // m_createdImageBuffer means we tried to malloc the buffer.  We didn't necessarily get it.
187     mutable bool m_hasCreatedImageBuffer { false };
188     mutable bool m_didClearImageBuffer { false };
189     mutable std::unique_ptr<ImageBuffer> m_imageBuffer;
190     mutable std::unique_ptr<GraphicsContextStateSaver> m_contextStateSaver;
191     
192     mutable RefPtr<Image> m_presentedImage;
193     mutable RefPtr<Image> m_copiedImage; // FIXME: This is temporary for platforms that have to copy the image buffer to render (and for CSSCanvasValue).
194 };
195
196 } //namespace
197
198 #endif