Add new renderer for SVGRectElement.
[WebKit.git] / Source / WebCore / platform / graphics / FloatRect.h
1 /*
2  * Copyright (C) 2003, 2006, 2007 Apple Inc.  All rights reserved.
3  * Copyright (C) 2005 Nokia.  All rights reserved.
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  * 1. Redistributions of source code must retain the above copyright
9  *    notice, this list of conditions and the following disclaimer.
10  * 2. Redistributions in binary form must reproduce the above copyright
11  *    notice, this list of conditions and the following disclaimer in the
12  *    documentation and/or other materials provided with the distribution.
13  *
14  * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
17  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
18  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
19  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
20  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
21  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
22  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
24  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25  */
26
27 #ifndef FloatRect_h
28 #define FloatRect_h
29
30 #include "FloatPoint.h"
31
32 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
33 typedef struct CGRect CGRect;
34 #endif
35
36 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN))
37 #ifdef NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES
38 typedef struct CGRect NSRect;
39 #else
40 typedef struct _NSRect NSRect;
41 #endif
42 #endif
43
44 #if PLATFORM(QT)
45 QT_BEGIN_NAMESPACE
46 class QRectF;
47 QT_END_NAMESPACE
48 #endif
49
50 #if PLATFORM(WX) && USE(WXGC)
51 class wxRect2DDouble;
52 #endif
53
54 #if USE(SKIA)
55 struct SkRect;
56 #endif
57
58 #if USE(CAIRO)
59 typedef struct _cairo_rectangle cairo_rectangle_t;
60 #endif
61
62 namespace WebCore {
63
64 #if PLATFORM(OPENVG)
65 class VGRect;
66 #endif
67
68 class IntRect;
69 class IntPoint;
70
71 class FloatRect {
72 public:
73     enum ContainsMode {
74         InsideOrOnStroke,
75         InsideButNotOnStroke
76     };
77
78     FloatRect() { }
79     FloatRect(const FloatPoint& location, const FloatSize& size)
80         : m_location(location), m_size(size) { }
81     FloatRect(float x, float y, float width, float height)
82         : m_location(FloatPoint(x, y)), m_size(FloatSize(width, height)) { }
83     FloatRect(const IntRect&);
84
85     static FloatRect narrowPrecision(double x, double y, double width, double height);
86
87     FloatPoint location() const { return m_location; }
88     FloatSize size() const { return m_size; }
89
90     void setLocation(const FloatPoint& location) { m_location = location; }
91     void setSize(const FloatSize& size) { m_size = size; }
92
93     float x() const { return m_location.x(); }
94     float y() const { return m_location.y(); }
95     float maxX() const { return x() + width(); }
96     float maxY() const { return y() + height(); }
97     float width() const { return m_size.width(); }
98     float height() const { return m_size.height(); }
99
100     void setX(float x) { m_location.setX(x); }
101     void setY(float y) { m_location.setY(y); }
102     void setWidth(float width) { m_size.setWidth(width); }
103     void setHeight(float height) { m_size.setHeight(height); }
104
105     bool isEmpty() const { return m_size.isEmpty(); }
106     bool isZero() const { return m_size.isZero(); }
107     bool isExpressibleAsIntRect() const;
108
109     FloatPoint center() const { return FloatPoint(x() + width() / 2, y() + height() / 2); }
110
111     void move(const FloatSize& delta) { m_location += delta; } 
112     void moveBy(const FloatPoint& delta) { m_location.move(delta.x(), delta.y()); }
113     void move(float dx, float dy) { m_location.move(dx, dy); }
114
115     void expand(const FloatSize& size) { m_size += size; }
116     void expand(float dw, float dh) { m_size.expand(dw, dh); }
117     void contract(const FloatSize& size) { m_size -= size; }
118     void contract(float dw, float dh) { m_size.expand(-dw, -dh); }
119
120     void shiftXEdgeTo(float edge)
121     {
122         float delta = edge - x();
123         setX(edge);
124         setWidth(std::max(0.0f, width() - delta));
125     }
126     void shiftMaxXEdgeTo(float edge)
127     {
128         float delta = edge - maxX();
129         setWidth(std::max(0.0f, width() + delta));
130     }
131     void shiftYEdgeTo(float edge)
132     {
133         float delta = edge - y();
134         setY(edge);
135         setHeight(std::max(0.0f, height() - delta));
136     }
137     void shiftMaxYEdgeTo(float edge)
138     {
139         float delta = edge - maxY();
140         setHeight(std::max(0.0f, height() + delta));
141     }
142
143     FloatPoint minXMinYCorner() const { return m_location; } // typically topLeft
144     FloatPoint maxXMinYCorner() const { return FloatPoint(m_location.x() + m_size.width(), m_location.y()); } // typically topRight
145     FloatPoint minXMaxYCorner() const { return FloatPoint(m_location.x(), m_location.y() + m_size.height()); } // typically bottomLeft
146     FloatPoint maxXMaxYCorner() const { return FloatPoint(m_location.x() + m_size.width(), m_location.y() + m_size.height()); } // typically bottomRight
147
148     bool intersects(const FloatRect&) const;
149     bool contains(const FloatRect&) const;
150     bool contains(const FloatPoint&, ContainsMode = InsideOrOnStroke) const;
151
152     void intersect(const FloatRect&);
153     void unite(const FloatRect&);
154     void uniteIfNonZero(const FloatRect&);
155
156     // Note, this doesn't match what IntRect::contains(IntPoint&) does; the int version
157     // is really checking for containment of 1x1 rect, but that doesn't make sense with floats.
158     bool contains(float px, float py) const
159         { return px >= x() && px <= maxX() && py >= y() && py <= maxY(); }
160
161     void inflateX(float dx) {
162         m_location.setX(m_location.x() - dx);
163         m_size.setWidth(m_size.width() + dx + dx);
164     }
165     void inflateY(float dy) {
166         m_location.setY(m_location.y() - dy);
167         m_size.setHeight(m_size.height() + dy + dy);
168     }
169     void inflate(float d) { inflateX(d); inflateY(d); }
170     void scale(float s) { scale(s, s); }
171     void scale(float sx, float sy);
172
173     FloatRect transposedRect() const { return FloatRect(m_location.transposedPoint(), m_size.transposedSize()); }
174
175     // Re-initializes this rectangle to fit the sets of passed points.
176     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1);
177     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1, const FloatPoint& p2);
178     void fitToPoints(const FloatPoint& p0, const FloatPoint& p1, const FloatPoint& p2, const FloatPoint& p3);
179
180 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
181     FloatRect(const CGRect&);
182     operator CGRect() const;
183 #endif
184
185 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)) \
186         || (PLATFORM(CHROMIUM) && OS(DARWIN))
187     FloatRect(const NSRect&);
188     operator NSRect() const;
189 #endif
190
191 #if PLATFORM(QT)
192     FloatRect(const QRectF&);
193     operator QRectF() const;
194     FloatRect normalized() const;
195 #endif
196
197 #if PLATFORM(WX) && USE(WXGC)
198     FloatRect(const wxRect2DDouble&);
199     operator wxRect2DDouble() const;
200 #endif
201
202 #if USE(SKIA)
203     FloatRect(const SkRect&);
204     operator SkRect() const;
205 #endif
206
207 #if PLATFORM(OPENVG)
208     operator VGRect() const;
209 #endif
210
211 #if USE(CAIRO)
212     FloatRect(const cairo_rectangle_t&);
213     operator cairo_rectangle_t() const;
214 #endif
215
216 private:
217     FloatPoint m_location;
218     FloatSize m_size;
219
220     void setLocationAndSizeFromEdges(float left, float top, float right, float bottom)
221     {
222         m_location.set(left, top);
223         m_size.setWidth(right - left);
224         m_size.setHeight(bottom - top);
225     }
226 };
227
228 inline FloatRect intersection(const FloatRect& a, const FloatRect& b)
229 {
230     FloatRect c = a;
231     c.intersect(b);
232     return c;
233 }
234
235 inline FloatRect unionRect(const FloatRect& a, const FloatRect& b)
236 {
237     FloatRect c = a;
238     c.unite(b);
239     return c;
240 }
241
242 inline FloatRect& operator+=(FloatRect& a, const FloatRect& b)
243 {
244     a.move(b.x(), b.y());
245     a.setWidth(a.width() + b.width());
246     a.setHeight(a.height() + b.height());
247     return a;
248 }
249
250 inline FloatRect operator+(const FloatRect& a, const FloatRect& b)
251 {
252     FloatRect c = a;
253     c += b;
254     return c;
255 }
256
257 inline bool operator==(const FloatRect& a, const FloatRect& b)
258 {
259     return a.location() == b.location() && a.size() == b.size();
260 }
261
262 inline bool operator!=(const FloatRect& a, const FloatRect& b)
263 {
264     return a.location() != b.location() || a.size() != b.size();
265 }
266
267 IntRect enclosingIntRect(const FloatRect&);
268
269 // Map rect r from srcRect to an equivalent rect in destRect.
270 FloatRect mapRect(const FloatRect& r, const FloatRect& srcRect, const FloatRect& destRect);
271
272 }
273
274 #endif