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