Oops, these files were supposed to go in.
[WebKit-https.git] / WebCore / html / CanvasRenderingContext2D.h
1 /*
2  * Copyright (C) 2006 Apple Computer, 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 COMPUTER, 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 COMPUTER, 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 HTMLCanvas2DContext_h
27 #define HTMLCanvas2DContext_h
28
29 #include "FloatRect.h"
30 #include "PlatformString.h"
31 #include "Shared.h"
32 #include <kxmlcore/PassRefPtr.h>
33 #include <kxmlcore/RefPtr.h>
34 #include <kxmlcore/Vector.h>
35
36 #if __APPLE__
37 #include <ApplicationServices/ApplicationServices.h>
38 #endif
39
40 namespace WebCore {
41
42     class HTMLCanvasElementImpl;
43     class CanvasStyle;
44     class HTMLImageElementImpl;
45     class CanvasGradient;
46     class CanvasPattern;
47
48     class CanvasRenderingContext2D : public Shared<CanvasRenderingContext2D> {
49     public:
50         CanvasRenderingContext2D(HTMLCanvasElementImpl*);
51
52         HTMLCanvasElementImpl* canvas() const { return m_canvas; }
53
54         CanvasStyle* strokeStyle() const;
55         void setStrokeStyle(PassRefPtr<CanvasStyle>);
56
57         CanvasStyle* fillStyle() const;
58         void setFillStyle(PassRefPtr<CanvasStyle>);
59
60         float lineWidth() const;
61         void setLineWidth(float);
62
63         String lineCap() const;
64         void setLineCap(const String&);
65
66         String lineJoin() const;
67         void setLineJoin(const String&);
68
69         float miterLimit() const;
70         void setMiterLimit(float);
71
72         float shadowOffsetX() const;
73         void setShadowOffsetX(float);
74
75         float shadowOffsetY() const;
76         void setShadowOffsetY(float);
77
78         float shadowBlur() const;
79         void setShadowBlur(float);
80
81         String shadowColor() const;
82         void setShadowColor(const String&);
83
84         float globalAlpha() const;
85         void setGlobalAlpha(float);
86
87         String globalCompositeOperation() const;
88         void setGlobalCompositeOperation(const String&);
89
90         void save();
91         void restore();
92
93         void scale(float sx, float sy);
94         void rotate(float angleInRadians);
95         void translate(float tx, float ty);
96
97         void setStrokeColor(const String& color);
98         void setStrokeColor(float grayLevel);
99         void setStrokeColor(const String& color, float alpha);
100         void setStrokeColor(float grayLevel, float alpha);
101         void setStrokeColor(float r, float g, float b, float a);
102         void setStrokeColor(float c, float m, float y, float k, float a);
103
104         void setFillColor(const String& color);
105         void setFillColor(float grayLevel);
106         void setFillColor(const String& color, float alpha);
107         void setFillColor(float grayLevel, float alpha);
108         void setFillColor(float r, float g, float b, float a);
109         void setFillColor(float c, float m, float y, float k, float a);
110
111         void beginPath();
112         void closePath();
113
114         void moveTo(float x, float y);
115         void lineTo(float x, float y);
116         void quadraticCurveTo(float cpx, float cpy, float x, float y);
117         void bezierCurveTo(float cp1x, float cp1y, float cp2x, float cp2y, float x, float y);
118         void arcTo(float x0, float y0, float x1, float y1, float radius);
119         void arc(float x, float y, float r, float sa, float ea, bool clockwise);
120         void rect(float x, float y, float width, float height);
121
122         void fill();
123         void stroke();
124         void clip();
125
126         void clearRect(float x, float y, float width, float height);
127         void fillRect(float x, float y, float width, float height);
128         void strokeRect(float x, float y, float width, float height);
129         void strokeRect(float x, float y, float width, float height, float width);
130
131         void setShadow(float width, float height, float blur);
132         void setShadow(float width, float height, float blur, const String& color);
133         void setShadow(float width, float height, float blur, float grayLevel);
134         void setShadow(float width, float height, float blur, const String& color, float alpha);
135         void setShadow(float width, float height, float blur, float grayLevel, float alpha);
136         void setShadow(float width, float height, float blur, float r, float g, float b, float a);
137         void setShadow(float width, float height, float blur, float c, float m, float y, float k, float a);
138
139         void clearShadow();
140
141         void drawImage(HTMLImageElementImpl*, float x, float y);
142         void drawImage(HTMLImageElementImpl*, float x, float y, float width, float height);
143         void drawImage(HTMLImageElementImpl*, float sx, float sy, float sw, float sh,
144             float dx, float dy, float dw, float dh);
145
146         void drawImageFromRect(HTMLImageElementImpl*, float sx, float sy, float sw, float sh,
147             float dx, float dy, float dw, float dh, const String& compositeOperation);
148
149         void setAlpha(float);
150
151         void setCompositeOperation(const String&);
152
153         PassRefPtr<CanvasGradient> createLinearGradient(float x0, float y0, float x1, float y1);
154         PassRefPtr<CanvasGradient> createRadialGradient(float x0, float y0, float r0, float x1, float y1, float r1);
155         PassRefPtr<CanvasPattern> createPattern(HTMLImageElementImpl*, const String& repetitionType);
156
157         void reset();
158         void detachCanvas() { m_canvas = 0; }
159
160     private:
161         struct State {
162             State();
163
164             RefPtr<CanvasStyle> m_strokeStyle;
165             RefPtr<CanvasStyle> m_fillStyle;
166             float m_lineWidth;
167             String m_lineCap;
168             String m_lineJoin;
169             float m_miterLimit;
170             FloatSize m_shadowOffset;
171             float m_shadowBlur;
172             String m_shadowColor;
173             float m_globalAlpha;
174             String m_globalComposite;
175 #if __APPLE__
176             bool m_platformContextStrokeStyleIsPattern;
177             CGAffineTransform m_strokeStylePatternTransform;
178             bool m_platformContextFillStyleIsPattern;
179             CGAffineTransform m_fillStylePatternTransform;
180 #endif
181         };
182
183         State& state() { return m_stateStack.last(); }
184         const State& state() const { return m_stateStack.last(); }
185
186         void applyShadow();
187
188         void willDraw(const FloatRect&);
189
190 #if __APPLE__
191         void applyStrokePattern();
192         void applyFillPattern();
193
194         // FIXME: Use GraphicsContext instead.
195         CGContextRef drawingContext() const;
196 #endif
197
198         HTMLCanvasElementImpl* m_canvas;
199         Vector<State, 1> m_stateStack;
200     };
201
202 } // namespace WebCore
203
204 #endif