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