[iOS] Upstream WebCore/platform changes
[WebKit-https.git] / Source / WebCore / platform / graphics / IntRect.h
1 /*
2  * Copyright (C) 2003, 2006, 2009 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef IntRect_h
27 #define IntRect_h
28
29 #include "IntPoint.h"
30 #include <wtf/Vector.h>
31
32 #if USE(CG)
33 typedef struct CGRect CGRect;
34 #endif
35
36 #if PLATFORM(MAC) && !PLATFORM(IOS)
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(IOS)
45 #ifndef NSRect
46 #define NSRect CGRect
47 #endif
48 #endif
49
50 #if PLATFORM(WIN)
51 typedef struct tagRECT RECT;
52 #elif PLATFORM(GTK)
53 #ifdef GTK_API_VERSION_2
54 typedef struct _GdkRectangle GdkRectangle;
55 #endif
56 #elif PLATFORM(EFL)
57 typedef struct _Eina_Rectangle Eina_Rectangle;
58 #elif PLATFORM(BLACKBERRY)
59 namespace BlackBerry {
60 namespace Platform {
61 class IntRect;
62 }
63 }
64 #endif
65
66 #if USE(CAIRO)
67 typedef struct _cairo_rectangle_int cairo_rectangle_int_t;
68 #endif
69
70 namespace WebCore {
71
72 class FloatRect;
73 class LayoutRect;
74
75 class IntRect {
76     WTF_MAKE_FAST_ALLOCATED;
77 public:
78     IntRect() { }
79     IntRect(const IntPoint& location, const IntSize& size)
80         : m_location(location), m_size(size) { }
81     IntRect(int x, int y, int width, int height)
82         : m_location(IntPoint(x, y)), m_size(IntSize(width, height)) { }
83
84     explicit IntRect(const FloatRect&); // don't do this implicitly since it's lossy
85     explicit IntRect(const LayoutRect&); // don't do this implicitly since it's lossy
86         
87     IntPoint location() const { return m_location; }
88     IntSize size() const { return m_size; }
89
90     void setLocation(const IntPoint& location) { m_location = location; }
91     void setSize(const IntSize& size) { m_size = size; }
92
93     int x() const { return m_location.x(); }
94     int y() const { return m_location.y(); }
95     int maxX() const { return x() + width(); }
96     int maxY() const { return y() + height(); }
97     int width() const { return m_size.width(); }
98     int height() const { return m_size.height(); }
99
100     void setX(int x) { m_location.setX(x); }
101     void setY(int y) { m_location.setY(y); }
102     void setWidth(int width) { m_size.setWidth(width); }
103     void setHeight(int height) { m_size.setHeight(height); }
104
105     bool isEmpty() const { return m_size.isEmpty(); }
106
107     // NOTE: The result is rounded to integer values, and thus may be not the exact
108     // center point.
109     IntPoint center() const { return IntPoint(x() + width() / 2, y() + height() / 2); }
110
111     void move(const IntSize& size) { m_location += size; } 
112     void moveBy(const IntPoint& offset) { m_location.move(offset.x(), offset.y()); }
113     void move(int dx, int dy) { m_location.move(dx, dy); } 
114
115     void expand(const IntSize& size) { m_size += size; }
116     void expand(int dw, int dh) { m_size.expand(dw, dh); }
117     void contract(const IntSize& size) { m_size -= size; }
118     void contract(int dw, int dh) { m_size.expand(-dw, -dh); }
119
120     void shiftXEdgeTo(int edge)
121     {
122         int delta = edge - x();
123         setX(edge);
124         setWidth(std::max(0, width() - delta));
125     }
126     void shiftMaxXEdgeTo(int edge)
127     {
128         int delta = edge - maxX();
129         setWidth(std::max(0, width() + delta));
130     }
131     void shiftYEdgeTo(int edge)
132     {
133         int delta = edge - y();
134         setY(edge);
135         setHeight(std::max(0, height() - delta));
136     }
137     void shiftMaxYEdgeTo(int edge)
138     {
139         int delta = edge - maxY();
140         setHeight(std::max(0, height() + delta));
141     }
142
143     IntPoint minXMinYCorner() const { return m_location; } // typically topLeft
144     IntPoint maxXMinYCorner() const { return IntPoint(m_location.x() + m_size.width(), m_location.y()); } // typically topRight
145     IntPoint minXMaxYCorner() const { return IntPoint(m_location.x(), m_location.y() + m_size.height()); } // typically bottomLeft
146     IntPoint maxXMaxYCorner() const { return IntPoint(m_location.x() + m_size.width(), m_location.y() + m_size.height()); } // typically bottomRight
147     
148     bool intersects(const IntRect&) const;
149     bool contains(const IntRect&) const;
150
151     // This checks to see if the rect contains x,y in the traditional sense.
152     // Equivalent to checking if the rect contains a 1x1 rect below and to the right of (px,py).
153     bool contains(int px, int py) const
154         { return px >= x() && px < maxX() && py >= y() && py < maxY(); }
155     bool contains(const IntPoint& point) const { return contains(point.x(), point.y()); }
156
157     void intersect(const IntRect&);
158     void unite(const IntRect&);
159     void uniteIfNonZero(const IntRect&);
160
161     void inflateX(int dx)
162     {
163         m_location.setX(m_location.x() - dx);
164         m_size.setWidth(m_size.width() + dx + dx);
165     }
166     void inflateY(int dy)
167     {
168         m_location.setY(m_location.y() - dy);
169         m_size.setHeight(m_size.height() + dy + dy);
170     }
171     void inflate(int d) { inflateX(d); inflateY(d); }
172     void scale(float s);
173
174     IntSize differenceToPoint(const IntPoint&) const;
175     int distanceSquaredToPoint(const IntPoint& p) const { return differenceToPoint(p).diagonalLengthSquared(); }
176
177     IntRect transposedRect() const { return IntRect(m_location.transposedPoint(), m_size.transposedSize()); }
178
179 #if PLATFORM(WIN)
180     IntRect(const RECT&);
181     operator RECT() const;
182 #elif PLATFORM(GTK)
183 #ifdef GTK_API_VERSION_2
184     IntRect(const GdkRectangle&);
185     operator GdkRectangle() const;
186 #endif
187 #elif PLATFORM(EFL)
188     explicit IntRect(const Eina_Rectangle&);
189     operator Eina_Rectangle() const;
190 #endif
191
192 #if USE(CAIRO)
193     IntRect(const cairo_rectangle_int_t&);
194     operator cairo_rectangle_int_t() const;
195 #endif
196
197 #if USE(CG)
198     operator CGRect() const;
199 #endif
200
201 #if !PLATFORM(IOS)
202 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES))
203     operator NSRect() const;
204 #endif
205 #endif // !PLATFORM(IOS)
206
207 #if PLATFORM(BLACKBERRY)
208     IntRect(const BlackBerry::Platform::IntRect&);
209     operator BlackBerry::Platform::IntRect() const;
210 #endif
211
212     void dump(PrintStream& out) const;
213
214     static IntRect infiniteRect();
215     bool isInfinite() const;
216
217 private:
218     IntPoint m_location;
219     IntSize m_size;
220 };
221
222 inline IntRect intersection(const IntRect& a, const IntRect& b)
223 {
224     IntRect c = a;
225     c.intersect(b);
226     return c;
227 }
228
229 inline IntRect unionRect(const IntRect& a, const IntRect& b)
230 {
231     IntRect c = a;
232     c.unite(b);
233     return c;
234 }
235
236 IntRect unionRect(const Vector<IntRect>&);
237
238 inline bool operator==(const IntRect& a, const IntRect& b)
239 {
240     return a.location() == b.location() && a.size() == b.size();
241 }
242
243 inline bool operator!=(const IntRect& a, const IntRect& b)
244 {
245     return a.location() != b.location() || a.size() != b.size();
246 }
247
248 inline IntRect IntRect::infiniteRect()
249 {
250     static IntRect infiniteRect(-std::numeric_limits<int>::max() / 2, -std::numeric_limits<int>::max() / 2, std::numeric_limits<int>::max(), std::numeric_limits<int>::max());
251     return infiniteRect;
252 }
253
254 inline bool IntRect::isInfinite() const
255 {
256     return *this == infiniteRect();
257 }
258
259 #if USE(CG)
260 IntRect enclosingIntRect(const CGRect&);
261 #endif
262
263 #if !PLATFORM(IOS)
264 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES))
265 IntRect enclosingIntRect(const NSRect&);
266 #endif
267 #endif // !PLATFORM(IOS)
268
269 } // namespace WebCore
270
271 #endif // IntRect_h