Roll out r107887
[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_CHROMIUM)
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(EFL)
55 typedef struct _Eina_Rectangle Eina_Rectangle;
56 #endif
57
58 #if USE(CAIRO)
59 typedef struct _cairo_rectangle_int cairo_rectangle_int_t;
60 #endif
61
62 #if PLATFORM(WX)
63 class wxRect;
64 #endif
65
66 #if USE(SKIA)
67 struct SkRect;
68 struct SkIRect;
69 #endif
70
71 namespace WebCore {
72
73 class FloatRect;
74
75 class IntRect {
76 public:
77     IntRect() { }
78     IntRect(const IntPoint& location, const IntSize& size)
79         : m_location(location), m_size(size) { }
80     IntRect(int x, int y, int width, int height)
81         : m_location(IntPoint(x, y)), m_size(IntSize(width, height)) { }
82
83     explicit IntRect(const FloatRect& rect); // don't do this implicitly since it's lossy
84         
85     IntPoint location() const { return m_location; }
86     IntSize size() const { return m_size; }
87
88     void setLocation(const IntPoint& location) { m_location = location; }
89     void setSize(const IntSize& size) { m_size = size; }
90
91     int x() const { return m_location.x(); }
92     int y() const { return m_location.y(); }
93     int maxX() const { return x() + width(); }
94     int maxY() const { return y() + height(); }
95     int width() const { return m_size.width(); }
96     int height() const { return m_size.height(); }
97
98     void setX(int x) { m_location.setX(x); }
99     void setY(int y) { m_location.setY(y); }
100     void setWidth(int width) { m_size.setWidth(width); }
101     void setHeight(int height) { m_size.setHeight(height); }
102
103     bool isEmpty() const { return m_size.isEmpty(); }
104
105     // NOTE: The result is rounded to integer values, and thus may be not the exact
106     // center point.
107     IntPoint center() const { return IntPoint(x() + width() / 2, y() + height() / 2); }
108
109     void move(const IntSize& size) { m_location += size; } 
110     void moveBy(const IntPoint& offset) { m_location.move(offset.x(), offset.y()); }
111     void move(int dx, int dy) { m_location.move(dx, dy); } 
112
113     void expand(const IntSize& size) { m_size += size; }
114     void expand(int dw, int dh) { m_size.expand(dw, dh); }
115     void contract(const IntSize& size) { m_size -= size; }
116     void contract(int dw, int dh) { m_size.expand(-dw, -dh); }
117
118     void shiftXEdgeTo(int edge)
119     {
120         int delta = edge - x();
121         setX(edge);
122         setWidth(std::max(0, width() - delta));
123     }
124     void shiftMaxXEdgeTo(int edge)
125     {
126         int delta = edge - maxX();
127         setWidth(std::max(0, width() + delta));
128     }
129     void shiftYEdgeTo(int edge)
130     {
131         int delta = edge - y();
132         setY(edge);
133         setHeight(std::max(0, height() - delta));
134     }
135     void shiftMaxYEdgeTo(int edge)
136     {
137         int delta = edge - maxY();
138         setHeight(std::max(0, height() + delta));
139     }
140
141     IntPoint minXMinYCorner() const { return m_location; } // typically topLeft
142     IntPoint maxXMinYCorner() const { return IntPoint(m_location.x() + m_size.width(), m_location.y()); } // typically topRight
143     IntPoint minXMaxYCorner() const { return IntPoint(m_location.x(), m_location.y() + m_size.height()); } // typically bottomLeft
144     IntPoint maxXMaxYCorner() const { return IntPoint(m_location.x() + m_size.width(), m_location.y() + m_size.height()); } // typically bottomRight
145     
146     bool intersects(const IntRect&) const;
147     bool contains(const IntRect&) const;
148
149     // This checks to see if the rect contains x,y in the traditional sense.
150     // Equivalent to checking if the rect contains a 1x1 rect below and to the right of (px,py).
151     bool contains(int px, int py) const
152         { return px >= x() && px < maxX() && py >= y() && py < maxY(); }
153     bool contains(const IntPoint& point) const { return contains(point.x(), point.y()); }
154
155     void intersect(const IntRect&);
156     void unite(const IntRect&);
157     void uniteIfNonZero(const IntRect&);
158
159     void inflateX(int dx)
160     {
161         m_location.setX(m_location.x() - dx);
162         m_size.setWidth(m_size.width() + dx + dx);
163     }
164     void inflateY(int dy)
165     {
166         m_location.setY(m_location.y() - dy);
167         m_size.setHeight(m_size.height() + dy + dy);
168     }
169     void inflate(int d) { inflateX(d); inflateY(d); }
170     void scale(float s);
171
172     IntRect transposedRect() const { return IntRect(m_location.transposedPoint(), m_size.transposedSize()); }
173
174 #if PLATFORM(WX)
175     IntRect(const wxRect&);
176     operator wxRect() const;
177 #endif
178
179 #if PLATFORM(WIN)
180     IntRect(const RECT&);
181     operator RECT() const;
182 #elif PLATFORM(QT)
183     IntRect(const QRect&);
184     operator QRect() const;
185 #elif PLATFORM(GTK)
186 #ifdef GTK_API_VERSION_2
187     IntRect(const GdkRectangle&);
188     operator GdkRectangle() const;
189 #endif
190 #elif PLATFORM(EFL)
191     explicit IntRect(const Eina_Rectangle&);
192     operator Eina_Rectangle() const;
193 #endif
194
195 #if USE(CAIRO)
196     IntRect(const cairo_rectangle_int_t&);
197     operator cairo_rectangle_int_t() const;
198 #endif
199
200 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
201     operator CGRect() const;
202 #endif
203
204 #if USE(SKIA)
205     IntRect(const SkIRect&);
206     operator SkRect() const;
207     operator SkIRect() const;
208 #endif
209
210 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)) \
211         || (PLATFORM(CHROMIUM) && OS(DARWIN))  || (PLATFORM(QT) && USE(QTKIT))
212     operator NSRect() const;
213 #endif
214
215 private:
216     IntPoint m_location;
217     IntSize m_size;
218 };
219
220 inline IntRect intersection(const IntRect& a, const IntRect& b)
221 {
222     IntRect c = a;
223     c.intersect(b);
224     return c;
225 }
226
227 inline IntRect unionRect(const IntRect& a, const IntRect& b)
228 {
229     IntRect c = a;
230     c.unite(b);
231     return c;
232 }
233
234 IntRect unionRect(const Vector<IntRect>&);
235
236 inline bool operator==(const IntRect& a, const IntRect& b)
237 {
238     return a.location() == b.location() && a.size() == b.size();
239 }
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 #if USE(CG) || USE(SKIA_ON_MAC_CHROMIUM)
247 IntRect enclosingIntRect(const CGRect&);
248 #endif
249
250 #if (PLATFORM(MAC) && !defined(NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES)) \
251         || (PLATFORM(CHROMIUM) && OS(DARWIN)) || (PLATFORM(QT) && USE(QTKIT))
252 IntRect enclosingIntRect(const NSRect&);
253 #endif
254
255 } // namespace WebCore
256
257 #endif // IntRect_h