00b98063c3f11cc7b727fcbc003f38d9d023ec86
[WebKit-https.git] / Source / WebCore / html / canvas / CanvasRenderingContext2D.h
1 /*
2  * Copyright (C) 2006, 2007, 2009, 2010, 2011, 2012 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 #ifndef CanvasRenderingContext2D_h
27 #define CanvasRenderingContext2D_h
28
29 #include "AffineTransform.h"
30 #include "CanvasPathMethods.h"
31 #include "CanvasRenderingContext.h"
32 #include "CanvasStyle.h"
33 #include "Color.h"
34 #include "FloatSize.h"
35 #include "FontCascade.h"
36 #include "FontSelectorClient.h"
37 #include "GraphicsContext.h"
38 #include "GraphicsTypes.h"
39 #include "ImageBuffer.h"
40 #include "Path.h"
41 #include "PlatformLayer.h"
42 #include "TextFlags.h"
43 #include <wtf/Vector.h>
44 #include <wtf/text/WTFString.h>
45
46 namespace WebCore {
47
48 class CanvasGradient;
49 class CanvasPattern;
50 class DOMPath;
51 class FloatRect;
52 class GraphicsContext;
53 class HTMLCanvasElement;
54 class HTMLImageElement;
55 class HTMLVideoElement;
56 class ImageData;
57 class TextMetrics;
58
59 typedef int ExceptionCode;
60
61 class CanvasRenderingContext2D final : public CanvasRenderingContext, public CanvasPathMethods {
62 public:
63     CanvasRenderingContext2D(HTMLCanvasElement*, bool usesCSSCompatibilityParseMode, bool usesDashboardCompatibilityMode);
64     virtual ~CanvasRenderingContext2D();
65
66     const CanvasStyle& strokeStyle() const { return state().strokeStyle; }
67     void setStrokeStyle(CanvasStyle);
68
69     const CanvasStyle& fillStyle() const { return state().fillStyle; }
70     void setFillStyle(CanvasStyle);
71
72     float lineWidth() const;
73     void setLineWidth(float);
74
75     String lineCap() const;
76     void setLineCap(const String&);
77
78     String lineJoin() const;
79     void setLineJoin(const String&);
80
81     float miterLimit() const;
82     void setMiterLimit(float);
83
84     const Vector<float>& getLineDash() const;
85     void setLineDash(const Vector<float>&);
86     void setWebkitLineDash(const Vector<float>&);
87
88     float lineDashOffset() const;
89     void setLineDashOffset(float);
90     float webkitLineDashOffset() const;
91     void setWebkitLineDashOffset(float);
92
93     float shadowOffsetX() const;
94     void setShadowOffsetX(float);
95
96     float shadowOffsetY() const;
97     void setShadowOffsetY(float);
98
99     float shadowBlur() const;
100     void setShadowBlur(float);
101
102     String shadowColor() const;
103     void setShadowColor(const String&);
104
105     float globalAlpha() const;
106     void setGlobalAlpha(float);
107
108     String globalCompositeOperation() const;
109     void setGlobalCompositeOperation(const String&);
110
111     void save() { ++m_unrealizedSaveCount; }
112     void restore();
113
114     void scale(float sx, float sy);
115     void rotate(float angleInRadians);
116     void translate(float tx, float ty);
117     void transform(float m11, float m12, float m21, float m22, float dx, float dy);
118     void setTransform(float m11, float m12, float m21, float m22, float dx, float dy);
119
120     void setStrokeColor(const String& color, Optional<float> alpha = Nullopt);
121     void setStrokeColor(float grayLevel, float alpha = 1.0);
122     void setStrokeColor(float r, float g, float b, float a);
123     void setStrokeColor(float c, float m, float y, float k, float a);
124
125     void setFillColor(const String& color, Optional<float> alpha = Nullopt);
126     void setFillColor(float grayLevel, float alpha = 1.0f);
127     void setFillColor(float r, float g, float b, float a);
128     void setFillColor(float c, float m, float y, float k, float a);
129
130     void beginPath();
131
132     void fill(const String& winding = ASCIILiteral("nonzero"));
133     void stroke();
134     void clip(const String& winding = ASCIILiteral("nonzero"));
135
136     void fill(DOMPath&, const String& winding = ASCIILiteral("nonzero"));
137     void stroke(DOMPath&);
138     void clip(DOMPath&, const String& winding = ASCIILiteral("nonzero"));
139
140     bool isPointInPath(const float x, const float y, const String& winding = ASCIILiteral("nonzero"));
141     bool isPointInStroke(const float x, const float y);
142
143     bool isPointInPath(DOMPath&, const float x, const float y, const String& winding = ASCIILiteral("nonzero"));
144     bool isPointInStroke(DOMPath&, const float x, const float y);
145
146     void clearRect(float x, float y, float width, float height);
147     void fillRect(float x, float y, float width, float height);
148     void strokeRect(float x, float y, float width, float height);
149
150     void setShadow(float width, float height, float blur, const String& color = String(), Optional<float> alpha = Nullopt);
151     void setShadow(float width, float height, float blur, float grayLevel, float alpha = 1.0);
152     void setShadow(float width, float height, float blur, float r, float g, float b, float a);
153     void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
154
155     void clearShadow();
156
157     void drawImage(HTMLImageElement&, float x, float y, ExceptionCode&);
158     void drawImage(HTMLImageElement&, float x, float y, float width, float height, ExceptionCode&);
159     void drawImage(HTMLImageElement&, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
160     void drawImage(HTMLImageElement&, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
161     void drawImage(HTMLCanvasElement&, float x, float y, ExceptionCode&);
162     void drawImage(HTMLCanvasElement&, float x, float y, float width, float height, ExceptionCode&);
163     void drawImage(HTMLCanvasElement&, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
164     void drawImage(HTMLCanvasElement&, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
165     void drawImage(HTMLImageElement&, const FloatRect& srcRect, const FloatRect& dstRect, const CompositeOperator&, const BlendMode&, ExceptionCode&);
166 #if ENABLE(VIDEO)
167     void drawImage(HTMLVideoElement&, float x, float y, ExceptionCode&);
168     void drawImage(HTMLVideoElement&, float x, float y, float width, float height, ExceptionCode&);
169     void drawImage(HTMLVideoElement&, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
170     void drawImage(HTMLVideoElement&, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
171 #endif
172
173     void drawImageFromRect(HTMLImageElement&, float sx = 0, float sy = 0, float sw = 0, float sh = 0,
174                            float dx = 0, float dy = 0, float dw = 0, float dh = 0, const String& compositeOperation = emptyString());
175
176     void setAlpha(float);
177
178     void setCompositeOperation(const String&);
179
180     RefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1, ExceptionCode&);
181     RefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1, ExceptionCode&);
182     RefPtr<CanvasPattern> createPattern(HTMLImageElement*, const String& repetitionType, ExceptionCode&);
183     RefPtr<CanvasPattern> createPattern(HTMLCanvasElement*, const String& repetitionType, ExceptionCode&);
184
185     RefPtr<ImageData> createImageData(RefPtr<ImageData>&&, ExceptionCode&) const;
186     RefPtr<ImageData> createImageData(float width, float height, ExceptionCode&) const;
187     RefPtr<ImageData> getImageData(float sx, float sy, float sw, float sh, ExceptionCode&) const;
188     RefPtr<ImageData> webkitGetImageDataHD(float sx, float sy, float sw, float sh, ExceptionCode&) const;
189     void putImageData(ImageData*, float dx, float dy, ExceptionCode&);
190     void putImageData(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
191     void webkitPutImageDataHD(ImageData*, float dx, float dy, ExceptionCode&);
192     void webkitPutImageDataHD(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
193
194     void drawFocusIfNeeded(Element*);
195     void drawFocusIfNeeded(DOMPath&, Element*);
196
197     float webkitBackingStorePixelRatio() const { return 1; }
198
199     void reset();
200
201     String font() const;
202     void setFont(const String&);
203
204     String textAlign() const;
205     void setTextAlign(const String&);
206
207     String textBaseline() const;
208     void setTextBaseline(const String&);
209
210     String direction() const;
211     void setDirection(const String&);
212
213     void fillText(const String& text, float x, float y, Optional<float> maxWidth = Nullopt);
214     void strokeText(const String& text, float x, float y, Optional<float> maxWidth = Nullopt);
215     Ref<TextMetrics> measureText(const String& text);
216
217     LineCap getLineCap() const { return state().lineCap; }
218     LineJoin getLineJoin() const { return state().lineJoin; }
219
220     bool imageSmoothingEnabled() const;
221     void setImageSmoothingEnabled(bool);
222
223     String imageSmoothingQuality() const;
224     void setImageSmoothingQuality(const String&);
225
226     enum class SmoothingQuality {
227         Low,
228         Medium,
229         High
230     };
231
232     bool usesDisplayListDrawing() const { return m_usesDisplayListDrawing; };
233     void setUsesDisplayListDrawing(bool flag) { m_usesDisplayListDrawing = flag; };
234
235     bool tracksDisplayListReplay() const { return m_tracksDisplayListReplay; }
236     void setTracksDisplayListReplay(bool);
237
238     String displayListAsText(DisplayList::AsTextFlags) const;
239     String replayDisplayListAsText(DisplayList::AsTextFlags) const;
240
241 private:
242     enum class Direction {
243         Inherit,
244         RTL,
245         LTR
246     };
247
248     class FontProxy : public FontSelectorClient {
249     public:
250         FontProxy() = default;
251         virtual ~FontProxy();
252         FontProxy(const FontProxy&);
253         FontProxy& operator=(const FontProxy&);
254
255         bool realized() const { return m_font.fontSelector(); }
256         void initialize(FontSelector&, const RenderStyle&);
257         FontMetrics fontMetrics() const;
258         const FontCascadeDescription& fontDescription() const;
259         float width(const TextRun&) const;
260         void drawBidiText(GraphicsContext&, const TextRun&, const FloatPoint&, FontCascade::CustomFontNotReadyAction) const;
261
262     private:
263         void update(FontSelector&);
264         void fontsNeedUpdate(FontSelector&) override;
265
266         FontCascade m_font;
267     };
268
269     struct State final {
270         State();
271
272         State(const State&);
273         State& operator=(const State&);
274
275         String unparsedStrokeColor;
276         String unparsedFillColor;
277         CanvasStyle strokeStyle;
278         CanvasStyle fillStyle;
279         float lineWidth;
280         LineCap lineCap;
281         LineJoin lineJoin;
282         float miterLimit;
283         FloatSize shadowOffset;
284         float shadowBlur;
285         RGBA32 shadowColor;
286         float globalAlpha;
287         CompositeOperator globalComposite;
288         BlendMode globalBlend;
289         AffineTransform transform;
290         bool hasInvertibleTransform;
291         Vector<float> lineDash;
292         float lineDashOffset;
293         bool imageSmoothingEnabled;
294         SmoothingQuality imageSmoothingQuality;
295
296         // Text state.
297         TextAlign textAlign;
298         TextBaseline textBaseline;
299         Direction direction;
300
301         String unparsedFont;
302         FontProxy font;
303     };
304
305     enum CanvasDidDrawOption {
306         CanvasDidDrawApplyNone = 0,
307         CanvasDidDrawApplyTransform = 1,
308         CanvasDidDrawApplyShadow = 1 << 1,
309         CanvasDidDrawApplyClip = 1 << 2,
310         CanvasDidDrawApplyAll = 0xffffffff
311     };
312
313     State& modifiableState() { ASSERT(!m_unrealizedSaveCount); return m_stateStack.last(); }
314     const State& state() const { return m_stateStack.last(); }
315
316     void applyLineDash() const;
317     void setShadow(const FloatSize& offset, float blur, RGBA32 color);
318     void applyShadow();
319     bool shouldDrawShadows() const;
320
321     void didDraw(const FloatRect&, unsigned options = CanvasDidDrawApplyAll);
322     void didDrawEntireCanvas();
323
324     void paintRenderingResultsToCanvas() override;
325
326     GraphicsContext* drawingContext() const;
327
328     void unwindStateStack();
329     void realizeSaves()
330     {
331         if (m_unrealizedSaveCount)
332             realizeSavesLoop();
333     }
334     void realizeSavesLoop();
335
336     void applyStrokePattern();
337     void applyFillPattern();
338
339     void drawTextInternal(const String& text, float x, float y, bool fill, Optional<float> maxWidth = Nullopt);
340
341     // The relationship between FontCascade and CanvasRenderingContext2D::FontProxy must hold certain invariants.
342     // Therefore, all font operations must pass through the State.
343     const FontProxy& fontProxy();
344
345 #if ENABLE(DASHBOARD_SUPPORT)
346     void clearPathForDashboardBackwardCompatibilityMode();
347 #endif
348
349     void beginCompositeLayer();
350     void endCompositeLayer();
351
352     void fillInternal(const Path&, const String& winding);
353     void strokeInternal(const Path&);
354     void clipInternal(const Path&, const String& winding);
355
356     bool isPointInPathInternal(const Path&, float x, float y, const String& winding);
357     bool isPointInStrokeInternal(const Path&, float x, float y);
358
359     void drawFocusIfNeededInternal(const Path&, Element*);
360
361     void clearCanvas();
362     Path transformAreaToDevice(const Path&) const;
363     Path transformAreaToDevice(const FloatRect&) const;
364     bool rectContainsCanvas(const FloatRect&) const;
365
366     template<class T> IntRect calculateCompositingBufferRect(const T&, IntSize*);
367     std::unique_ptr<ImageBuffer> createCompositingBuffer(const IntRect&);
368     void compositeBuffer(ImageBuffer&, const IntRect&, CompositeOperator);
369
370     void inflateStrokeRect(FloatRect&) const;
371
372     template<class T> void fullCanvasCompositedDrawImage(T&, const FloatRect&, const FloatRect&, CompositeOperator);
373
374     void prepareGradientForDashboard(CanvasGradient& gradient) const;
375
376     RefPtr<ImageData> getImageData(ImageBuffer::CoordinateSystem, float sx, float sy, float sw, float sh, ExceptionCode&) const;
377     void putImageData(ImageData*, ImageBuffer::CoordinateSystem, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
378
379     bool is2d() const override { return true; }
380     bool isAccelerated() const override;
381
382     bool hasInvertibleTransform() const override { return state().hasInvertibleTransform; }
383     TextDirection toTextDirection(Direction, const RenderStyle** computedStyle = nullptr) const;
384
385 #if ENABLE(ACCELERATED_2D_CANVAS)
386     PlatformLayer* platformLayer() const override;
387 #endif
388
389     Vector<State, 1> m_stateStack;
390     unsigned m_unrealizedSaveCount { 0 };
391     bool m_usesCSSCompatibilityParseMode;
392 #if ENABLE(DASHBOARD_SUPPORT)
393     bool m_usesDashboardCompatibilityMode;
394 #endif
395
396     bool m_usesDisplayListDrawing { false };
397     bool m_tracksDisplayListReplay { false };
398     mutable std::unique_ptr<struct DisplayListDrawingContext> m_recordingContext;
399 };
400
401 } // namespace WebCore
402
403 SPECIALIZE_TYPE_TRAITS_CANVASRENDERINGCONTEXT(WebCore::CanvasRenderingContext2D, is2d())
404
405 #endif