49c44cb9f0f00eb12fc93c039b5683a45d665ccc
[WebKit.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 "ColorSpace.h"
35 #include "FloatSize.h"
36 #include "FontCascade.h"
37 #include "GraphicsTypes.h"
38 #include "ImageBuffer.h"
39 #include "Path.h"
40 #include "PlatformLayer.h"
41 #include "TextDirection.h"
42 #include <wtf/Vector.h>
43 #include <wtf/text/WTFString.h>
44
45 namespace WebCore {
46
47 class CanvasGradient;
48 class CanvasPattern;
49 class DOMPath;
50 class FloatRect;
51 class GraphicsContext;
52 class HTMLCanvasElement;
53 class HTMLImageElement;
54 class HTMLVideoElement;
55 class ImageData;
56 class TextMetrics;
57
58 typedef int ExceptionCode;
59
60 class CanvasRenderingContext2D final : public CanvasRenderingContext, public CanvasPathMethods {
61 public:
62     CanvasRenderingContext2D(HTMLCanvasElement*, bool usesCSSCompatibilityParseMode, bool usesDashboardCompatibilityMode);
63     virtual ~CanvasRenderingContext2D();
64
65     const CanvasStyle& strokeStyle() const { return state().m_strokeStyle; }
66     void setStrokeStyle(CanvasStyle);
67
68     const CanvasStyle& fillStyle() const { return state().m_fillStyle; }
69     void setFillStyle(CanvasStyle);
70
71     float lineWidth() const;
72     void setLineWidth(float);
73
74     String lineCap() const;
75     void setLineCap(const String&);
76
77     String lineJoin() const;
78     void setLineJoin(const String&);
79
80     float miterLimit() const;
81     void setMiterLimit(float);
82
83     const Vector<float>& getLineDash() const;
84     void setLineDash(const Vector<float>&);
85     void setWebkitLineDash(const Vector<float>&);
86
87     float lineDashOffset() const;
88     void setLineDashOffset(float);
89     float webkitLineDashOffset() const;
90     void setWebkitLineDashOffset(float);
91
92     float shadowOffsetX() const;
93     void setShadowOffsetX(float);
94
95     float shadowOffsetY() const;
96     void setShadowOffsetY(float);
97
98     float shadowBlur() const;
99     void setShadowBlur(float);
100
101     String shadowColor() const;
102     void setShadowColor(const String&);
103
104     float globalAlpha() const;
105     void setGlobalAlpha(float);
106
107     String globalCompositeOperation() const;
108     void setGlobalCompositeOperation(const String&);
109
110     void save() { ++m_unrealizedSaveCount; }
111     void restore();
112
113     void scale(float sx, float sy);
114     void rotate(float angleInRadians);
115     void translate(float tx, float ty);
116     void transform(float m11, float m12, float m21, float m22, float dx, float dy);
117     void setTransform(float m11, float m12, float m21, float m22, float dx, float dy);
118
119     void setStrokeColor(const String& color);
120     void setStrokeColor(float grayLevel);
121     void setStrokeColor(const String& color, float alpha);
122     void setStrokeColor(float grayLevel, float alpha);
123     void setStrokeColor(float r, float g, float b, float a);
124     void setStrokeColor(float c, float m, float y, float k, float a);
125
126     void setFillColor(const String& color);
127     void setFillColor(float grayLevel);
128     void setFillColor(const String& color, float alpha);
129     void setFillColor(float grayLevel, float alpha);
130     void setFillColor(float r, float g, float b, float a);
131     void setFillColor(float c, float m, float y, float k, float a);
132
133     void beginPath();
134
135     void fill(const String& winding = "nonzero");
136     void stroke();
137     void clip(const String& winding = "nonzero");
138
139     void fill(DOMPath*, const String& winding = "nonzero");
140     void stroke(DOMPath*);
141     void clip(DOMPath*, const String& winding = "nonzero");
142
143     bool isPointInPath(const float x, const float y, const String& winding = "nonzero");
144     bool isPointInStroke(const float x, const float y);
145
146     bool isPointInPath(DOMPath*, const float x, const float y, const String& winding = "nonzero");
147     bool isPointInStroke(DOMPath*, const float x, const float y);
148
149     void clearRect(float x, float y, float width, float height);
150     void fillRect(float x, float y, float width, float height);
151     void strokeRect(float x, float y, float width, float height);
152
153     void setShadow(float width, float height, float blur);
154     void setShadow(float width, float height, float blur, const String& color);
155     void setShadow(float width, float height, float blur, float grayLevel);
156     void setShadow(float width, float height, float blur, const String& color, float alpha);
157     void setShadow(float width, float height, float blur, float grayLevel, float alpha);
158     void setShadow(float width, float height, float blur, float r, float g, float b, float a);
159     void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
160
161     void clearShadow();
162
163     void drawImage(HTMLImageElement*, float x, float y, ExceptionCode&);
164     void drawImage(HTMLImageElement*, float x, float y, float width, float height, ExceptionCode&);
165     void drawImage(HTMLImageElement*, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
166     void drawImage(HTMLImageElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
167     void drawImage(HTMLCanvasElement*, float x, float y, ExceptionCode&);
168     void drawImage(HTMLCanvasElement*, float x, float y, float width, float height, ExceptionCode&);
169     void drawImage(HTMLCanvasElement*, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
170     void drawImage(HTMLCanvasElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
171     void drawImage(HTMLImageElement*, const FloatRect& srcRect, const FloatRect& dstRect, const CompositeOperator&, const BlendMode&, ExceptionCode&);
172 #if ENABLE(VIDEO)
173     void drawImage(HTMLVideoElement*, float x, float y, ExceptionCode&);
174     void drawImage(HTMLVideoElement*, float x, float y, float width, float height, ExceptionCode&);
175     void drawImage(HTMLVideoElement*, float sx, float sy, float sw, float sh, float dx, float dy, float dw, float dh, ExceptionCode&);
176     void drawImage(HTMLVideoElement*, const FloatRect& srcRect, const FloatRect& dstRect, ExceptionCode&);
177 #endif
178
179     void drawImageFromRect(HTMLImageElement*, float sx = 0, float sy = 0, float sw = 0, float sh = 0,
180                            float dx = 0, float dy = 0, float dw = 0, float dh = 0, const String& compositeOperation = emptyString());
181
182     void setAlpha(float);
183
184     void setCompositeOperation(const String&);
185
186     RefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1, ExceptionCode&);
187     RefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1, ExceptionCode&);
188     RefPtr<CanvasPattern> createPattern(HTMLImageElement*, const String& repetitionType, ExceptionCode&);
189     RefPtr<CanvasPattern> createPattern(HTMLCanvasElement*, const String& repetitionType, ExceptionCode&);
190
191     RefPtr<ImageData> createImageData(RefPtr<ImageData>&&, ExceptionCode&) const;
192     RefPtr<ImageData> createImageData(float width, float height, ExceptionCode&) const;
193     RefPtr<ImageData> getImageData(float sx, float sy, float sw, float sh, ExceptionCode&) const;
194     RefPtr<ImageData> webkitGetImageDataHD(float sx, float sy, float sw, float sh, ExceptionCode&) const;
195     void putImageData(ImageData*, float dx, float dy, ExceptionCode&);
196     void putImageData(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
197     void webkitPutImageDataHD(ImageData*, float dx, float dy, ExceptionCode&);
198     void webkitPutImageDataHD(ImageData*, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
199
200     void drawFocusIfNeeded(Element*);
201     void drawFocusIfNeeded(DOMPath*, Element*);
202
203     float webkitBackingStorePixelRatio() const { return 1; }
204
205     void reset();
206
207     String font() const;
208     void setFont(const String&);
209
210     String textAlign() const;
211     void setTextAlign(const String&);
212
213     String textBaseline() const;
214     void setTextBaseline(const String&);
215
216     String direction() const;
217     void setDirection(const String&);
218
219     void fillText(const String& text, float x, float y);
220     void fillText(const String& text, float x, float y, float maxWidth);
221     void strokeText(const String& text, float x, float y);
222     void strokeText(const String& text, float x, float y, float maxWidth);
223     Ref<TextMetrics> measureText(const String& text);
224
225     LineCap getLineCap() const { return state().m_lineCap; }
226     LineJoin getLineJoin() const { return state().m_lineJoin; }
227
228     bool webkitImageSmoothingEnabled() const;
229     void setWebkitImageSmoothingEnabled(bool);
230
231 private:
232     enum class Direction {
233         Inherit,
234         RTL,
235         LTR
236     };
237
238     struct State final : FontSelectorClient {
239         State();
240         virtual ~State();
241
242         State(const State&);
243         State& operator=(const State&);
244
245         virtual void fontsNeedUpdate(FontSelector*) override;
246
247         String m_unparsedStrokeColor;
248         String m_unparsedFillColor;
249         CanvasStyle m_strokeStyle;
250         CanvasStyle m_fillStyle;
251         float m_lineWidth;
252         LineCap m_lineCap;
253         LineJoin m_lineJoin;
254         float m_miterLimit;
255         FloatSize m_shadowOffset;
256         float m_shadowBlur;
257         RGBA32 m_shadowColor;
258         float m_globalAlpha;
259         CompositeOperator m_globalComposite;
260         BlendMode m_globalBlend;
261         AffineTransform m_transform;
262         bool m_hasInvertibleTransform;
263         Vector<float> m_lineDash;
264         float m_lineDashOffset;
265         bool m_imageSmoothingEnabled;
266
267         // Text state.
268         TextAlign m_textAlign;
269         TextBaseline m_textBaseline;
270         Direction m_direction;
271
272         String m_unparsedFont;
273         FontCascade m_font;
274         bool m_realizedFont;
275     };
276
277     enum CanvasDidDrawOption {
278         CanvasDidDrawApplyNone = 0,
279         CanvasDidDrawApplyTransform = 1,
280         CanvasDidDrawApplyShadow = 1 << 1,
281         CanvasDidDrawApplyClip = 1 << 2,
282         CanvasDidDrawApplyAll = 0xffffffff
283     };
284
285     State& modifiableState() { ASSERT(!m_unrealizedSaveCount); return m_stateStack.last(); }
286     const State& state() const { return m_stateStack.last(); }
287
288     void applyLineDash() const;
289     void setShadow(const FloatSize& offset, float blur, RGBA32 color);
290     void applyShadow();
291     bool shouldDrawShadows() const;
292
293     void didDraw(const FloatRect&, unsigned options = CanvasDidDrawApplyAll);
294     void didDrawEntireCanvas();
295
296     GraphicsContext* drawingContext() const;
297
298     void unwindStateStack();
299     void realizeSaves()
300     {
301         if (m_unrealizedSaveCount)
302             realizeSavesLoop();
303     }
304     void realizeSavesLoop();
305
306     void applyStrokePattern();
307     void applyFillPattern();
308
309     void drawTextInternal(const String& text, float x, float y, bool fill, float maxWidth = 0, bool useMaxWidth = false);
310
311     const FontCascade& accessFont();
312
313 #if ENABLE(DASHBOARD_SUPPORT)
314     void clearPathForDashboardBackwardCompatibilityMode();
315 #endif
316
317     void beginCompositeLayer();
318     void endCompositeLayer();
319
320     void fillInternal(const Path&, const String& winding);
321     void strokeInternal(const Path&);
322     void clipInternal(const Path&, const String& winding);
323
324     bool isPointInPathInternal(const Path&, float x, float y, const String& winding);
325     bool isPointInStrokeInternal(const Path&, float x, float y);
326
327     void drawFocusIfNeededInternal(const Path&, Element*);
328
329     void clearCanvas();
330     Path transformAreaToDevice(const Path&) const;
331     Path transformAreaToDevice(const FloatRect&) const;
332     bool rectContainsCanvas(const FloatRect&) const;
333
334     template<class T> IntRect calculateCompositingBufferRect(const T&, IntSize*);
335     std::unique_ptr<ImageBuffer> createCompositingBuffer(const IntRect&);
336     void compositeBuffer(ImageBuffer*, const IntRect&, CompositeOperator);
337
338     void inflateStrokeRect(FloatRect&) const;
339
340     template<class T> void fullCanvasCompositedDrawImage(T*, ColorSpace, const FloatRect&, const FloatRect&, CompositeOperator);
341
342     void prepareGradientForDashboard(CanvasGradient& gradient) const;
343
344     RefPtr<ImageData> getImageData(ImageBuffer::CoordinateSystem, float sx, float sy, float sw, float sh, ExceptionCode&) const;
345     void putImageData(ImageData*, ImageBuffer::CoordinateSystem, float dx, float dy, float dirtyX, float dirtyY, float dirtyWidth, float dirtyHeight, ExceptionCode&);
346
347     virtual bool is2d() const override { return true; }
348     virtual bool isAccelerated() const override;
349
350     virtual bool hasInvertibleTransform() const override { return state().m_hasInvertibleTransform; }
351     TextDirection toTextDirection(Direction, RenderStyle** computedStyle = nullptr) const;
352
353 #if ENABLE(ACCELERATED_2D_CANVAS)
354     virtual PlatformLayer* platformLayer() const override;
355 #endif
356
357     Vector<State, 1> m_stateStack;
358     unsigned m_unrealizedSaveCount;
359     bool m_usesCSSCompatibilityParseMode;
360 #if ENABLE(DASHBOARD_SUPPORT)
361     bool m_usesDashboardCompatibilityMode;
362 #endif
363 };
364
365 } // namespace WebCore
366
367 #endif