2011-06-22 Sheriff Bot <webkit.review.bot@gmail.com>
[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) || USE(SKIA_ON_MAC_CHROME)
33 typedef struct CGRect CGRect;
34 #endif
35
36 #if PLATFORM(MAC) || (PLATFORM(CHROMIUM) && OS(DARWIN)) || (PLATFORM(QT) && USE(QTKIT))
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(WIN)
45 typedef struct tagRECT RECT;
46 #elif PLATFORM(QT)
47 QT_BEGIN_NAMESPACE
48 class QRect;
49 QT_END_NAMESPACE
50 #elif PLATFORM(GTK)
51 #ifdef GTK_API_VERSION_2
52 typedef struct _GdkRectangle GdkRectangle;
53 #endif
54 #elif PLATFORM(HAIKU)
55 class BRect;
56 #elif PLATFORM(EFL)
57 typedef struct _Eina_Rectangle Eina_Rectangle;
58 #endif
59
60 #if USE(CAIRO)
61 typedef struct _cairo_rectangle_int cairo_rectangle_int_t;
62 #endif
63
64 #if PLATFORM(WX)
65 class wxRect;
66 #endif
67
68 #if USE(SKIA)
69 struct SkRect;
70 struct SkIRect;
71 #endif
72
73 namespace WebCore {
74
75 class FloatRect;
76
77 class IntRect {
78 public:
79     IntRect() { }
80     IntRect(const IntPoint& location, const IntSize& size)
81         : m_location(location), m_size(size) { }
82     IntRect(int x, int y, int width, int height)
83         : m_location(IntPoint(x, y)), m_size(IntSize(width, height)) { }
84
85     explicit IntRect(const FloatRect& rect); // 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     IntRect transposedRect() const { return IntRect(m_location.transposedPoint(), m_size.transposedSize()); }
175
176 #if PLATFORM(WX)
177     IntRect(const wxRect&);
178     operator wxRect() const;
179 #endif
180
181 #if PLATFORM(WIN)
182     IntRect(const RECT&);
183     operator RECT() const;
184 #elif PLATFORM(QT)
185     IntRect(const QRect&);
186     operator QRect() const;
187 #elif PLATFORM(GTK)
188 #ifdef GTK_API_VERSION_2
189     IntRect(const GdkRectangle&);
190     operator GdkRectangle() const;
191 #endif
192 #elif PLATFORM(HAIKU)
193     explicit IntRect(const BRect&);
194     operator BRect() const;
195 #elif PLATFORM(EFL)
196     explicit IntRect(const Eina_Rectangle&);
197     operator Eina_Rectangle() const;
198 #endif
199
200 #if USE(CAIRO)
201     IntRect(const cairo_rectangle_int_t&);
202     operator cairo_rectangle_int_t() const;
203 #endif
204
205 #if USE(CG) || USE(SKIA_ON_MAC_CHROME)
206     operator CGRect() const;
207 #endif
208
209 #if USE(SKIA)
210     IntRect(const SkIRect&);
211     operator SkRect() const;
212     operator SkIRect() const;
213 #endif
214
215 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)) \
216         || (PLATFORM(CHROMIUM) && OS(DARWIN))  || (PLATFORM(QT) && USE(QTKIT))
217     operator NSRect() const;
218 #endif
219
220 private:
221     IntPoint m_location;
222     IntSize m_size;
223 };
224
225 inline IntRect intersection(const IntRect& a, const IntRect& b)
226 {
227     IntRect c = a;
228     c.intersect(b);
229     return c;
230 }
231
232 inline IntRect unionRect(const IntRect& a, const IntRect& b)
233 {
234     IntRect c = a;
235     c.unite(b);
236     return c;
237 }
238
239 IntRect unionRect(const Vector<IntRect>&);
240
241 inline bool operator==(const IntRect& a, const IntRect& b)
242 {
243     return a.location() == b.location() && a.size() == b.size();
244 }
245
246 inline bool operator!=(const IntRect& a, const IntRect& b)
247 {
248     return a.location() != b.location() || a.size() != b.size();
249 }
250
251 #if USE(CG) || USE(SKIA_ON_MAC_CHROME)
252 IntRect enclosingIntRect(const CGRect&);
253 #endif
254
255 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)) \
256         || (PLATFORM(CHROMIUM) && OS(DARWIN)) || (PLATFORM(QT) && USE(QTKIT))
257 IntRect enclosingIntRect(const NSRect&);
258 #endif
259
260 } // namespace WebCore
261
262 #endif // IntRect_h