Reviewed by Mitz.
[WebKit-https.git] / WebCore / platform / graphics / GraphicsContext.h
1 /*
2  * Copyright (C) 2003, 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 GraphicsContext_h
27 #define GraphicsContext_h
28
29 #include "FloatRect.h"
30 #include "Image.h"
31 #include "IntRect.h"
32 #include "Path.h"
33 #include "Pen.h"
34 #include "TextDirection.h"
35 #include "UChar.h"
36 #include <wtf/Noncopyable.h>
37 #include <wtf/Platform.h>
38
39 #if PLATFORM(CG)
40 typedef struct CGContext PlatformGraphicsContext;
41 #elif PLATFORM(CAIRO)
42 typedef struct _cairo PlatformGraphicsContext;
43 #elif PLATFORM(QT)
44 class QPainter;
45 typedef QPainter PlatformGraphicsContext;
46 #else
47 typedef void PlatformGraphicsContext;
48 #endif
49
50 #if PLATFORM(WIN)
51 typedef struct HDC__* HDC;
52 #endif
53
54 namespace WebCore {
55
56     const int cMisspellingLineThickness = 3;
57     const int cMisspellingLinePatternWidth = 4;
58     const int cMisspellingLinePatternGapWidth = 1;
59
60     class AffineTransform;
61     class Font;
62     class GraphicsContextPrivate;
63     class GraphicsContextPlatformPrivate;
64     class KURL;
65     class Path;
66     class TextRun;
67     class TextStyle;
68
69     class GraphicsContext : Noncopyable {
70     public:
71         GraphicsContext(PlatformGraphicsContext*);
72         ~GraphicsContext();
73        
74         PlatformGraphicsContext* platformContext() const;
75
76         const Font& font() const;
77         void setFont(const Font&);
78         
79         const Pen& pen() const;
80         void setPen(const Pen&);
81         void setPen(Pen::PenStyle);
82         void setPen(RGBA32);
83         
84         Color fillColor() const;
85         void setFillColor(const Color&);
86
87         void save();
88         void restore();
89         
90         void drawRect(const IntRect&);
91         void drawLine(const IntPoint&, const IntPoint&);
92         void drawEllipse(const IntRect&);
93         void drawArc(const IntRect&, float thickness, int startAngle, int angleSpan);
94         void drawConvexPolygon(size_t numPoints, const FloatPoint*, bool shouldAntialias = false);
95
96         void fillRect(const IntRect&, const Color&);
97         void fillRect(const FloatRect&, const Color&);
98         void clearRect(const FloatRect&);
99         void strokeRect(const FloatRect&, float lineWidth);
100
101         void drawImage(Image*, const IntPoint&, CompositeOperator = CompositeSourceOver);
102         void drawImage(Image*, const IntRect&, CompositeOperator = CompositeSourceOver);
103         void drawImage(Image*, const IntPoint& destPoint, const IntRect& srcRect, CompositeOperator = CompositeSourceOver);
104         void drawImage(Image*, const IntRect& destRect, const IntRect& srcRect, CompositeOperator = CompositeSourceOver);
105         void drawImage(Image*, const FloatRect& destRect, const FloatRect& srcRect = FloatRect(0, 0, -1, -1),
106             CompositeOperator = CompositeSourceOver);
107         void drawTiledImage(Image*, const IntRect& destRect, const IntPoint& srcPoint, const IntSize& tileSize,
108             CompositeOperator = CompositeSourceOver);
109         void drawTiledImage(Image*, const IntRect& destRect, const IntRect& srcRect, 
110             Image::TileRule hRule = Image::StretchTile, Image::TileRule vRule = Image::StretchTile,
111             CompositeOperator = CompositeSourceOver);
112
113         void clip(const IntRect&);
114         void addRoundedRectClip(const IntRect&, const IntSize& topLeft, const IntSize& topRight, const IntSize& bottomLeft, const IntSize& bottomRight);
115         void addInnerRoundedRectClip(const IntRect&, int thickness);
116
117         // Functions to work around bugs in focus ring clipping on Mac.
118         void setFocusRingClip(const IntRect&);
119         void clearFocusRingClip();
120
121         void drawText(const TextRun&, const IntPoint&);
122         void drawText(const TextRun&, const IntPoint&, const TextStyle&);
123         void drawHighlightForText(const TextRun&, const IntPoint&, int h, const TextStyle&, const Color& backgroundColor);
124
125         FloatRect roundToDevicePixels(const FloatRect&);
126         
127         void drawLineForText(const IntPoint&, int yOffset, int width, bool printing);
128         void drawLineForMisspellingOrBadGrammar(const IntPoint&, int width, bool grammar);
129         
130         bool paintingDisabled() const;
131         void setPaintingDisabled(bool);
132         
133         bool updatingControlTints() const;
134         void setUpdatingControlTints(bool);
135
136         void beginTransparencyLayer(float opacity);
137         void endTransparencyLayer();
138
139         void setShadow(const IntSize&, int blur, const Color&);
140         void clearShadow();
141
142         void initFocusRing(int width, int offset);
143         void addFocusRingRect(const IntRect&);
144         void drawFocusRing(const Color&);
145         void clearFocusRing();
146         IntRect focusRingBoundingRect();
147
148         void setLineWidth(float);
149         void setLineCap(LineCap);
150         void setLineJoin(LineJoin);
151         void setMiterLimit(float);
152
153         void setAlpha(float);
154
155         void setCompositeOperation(CompositeOperator);
156
157         void beginPath();
158         void addPath(const Path& path);
159
160         void clip(const Path&);
161
162         void scale(const FloatSize&);
163         void rotate(float angleInRadians);
164         void translate(float x, float y);
165         IntPoint origin();
166         
167         void setURLForRect(const KURL&, const IntRect&);
168
169         void concatCTM(const AffineTransform&);
170
171 #if PLATFORM(WIN)
172         GraphicsContext(HDC); // FIXME: To be removed.
173         HDC getWindowsContext(bool supportAlphaBlend = false, const IntRect* = 0); // The passed in rect is used to create a bitmap for compositing inside transparency layers.
174         void releaseWindowsContext(HDC, bool supportAlphaBlend = false, const IntRect* = 0);    // The passed in HDC should be the one handed back by getWindowsContext.
175 #endif
176
177 #if PLATFORM(QT)
178         void setFillRule(WindRule);
179         PlatformPath* currentPath();
180 #endif
181
182     private:
183         void savePlatformState();
184         void restorePlatformState();
185         void setPlatformPen(const Pen& pen);
186         void setPlatformFillColor(const Color& fill);
187         void setPlatformFont(const Font& font);
188
189         int focusRingWidth() const;
190         int focusRingOffset() const;
191         const Vector<IntRect>& focusRingRects() const;
192
193         static GraphicsContextPrivate* createGraphicsContextPrivate();
194         static void destroyGraphicsContextPrivate(GraphicsContextPrivate*);
195
196         GraphicsContextPrivate* m_common;
197         GraphicsContextPlatformPrivate* m_data;
198     };
199
200 #ifdef SVG_SUPPORT
201     class SVGResourceImage;
202     GraphicsContext* contextForImage(SVGResourceImage*);
203 #endif
204
205 } // namespace WebCore
206
207 #endif // GraphicsContext_h