Reviewed by Eric. Landed by rwlbuis.
[WebKit-https.git] / WebCore / platform / IntRect.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 INTRECT_H_
27 #define INTRECT_H_
28
29 #include "IntPoint.h"
30 #include <wtf/Platform.h>
31
32 #if __APPLE__
33
34 typedef struct CGRect CGRect;
35
36 #ifdef NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES
37 typedef struct CGRect NSRect;
38 #else
39 typedef struct _NSRect NSRect;
40 #endif
41
42 #endif // __APPLE__
43
44 #if PLATFORM(WIN)
45 typedef struct tagRECT RECT;
46 #elif PLATFORM(QT)
47 class QRect;
48 #endif
49
50 namespace WebCore {
51
52 class IntRect {
53 public:
54     IntRect() { }
55     IntRect(const IntPoint& location, const IntSize& size)
56         : m_location(location), m_size(size) { }
57     IntRect(int x, int y, int width, int height)
58         : m_location(IntPoint(x, y)), m_size(IntSize(width, height)) { }
59
60     IntPoint location() const { return m_location; }
61     IntSize size() const { return m_size; }
62
63     void setLocation(const IntPoint& location) { m_location = location; }
64     void setSize(const IntSize& size) { m_size = size; }
65
66     int x() const { return m_location.x(); }
67     int y() const { return m_location.y(); }
68     int width() const { return m_size.width(); }
69     int height() const { return m_size.height(); }
70
71     void setX(int x) { m_location.setX(x); }
72     void setY(int y) { m_location.setY(y); }
73     void setWidth(int width) { m_size.setWidth(width); }
74     void setHeight(int height) { m_size.setHeight(height); }
75
76     bool isEmpty() const { return m_size.isEmpty(); }
77
78     int right() const { return x() + width(); }
79     int bottom() const { return y() + height(); }
80
81     void move(const IntSize& s) { m_location += s; } 
82     void move(int dx, int dy) { m_location.move(dx, dy); } 
83
84     bool intersects(const IntRect&) const;
85     bool contains(const IntRect&) const;
86
87     // This checks to see if the rect contains x,y in the traditional sense.
88     // Equivalent to checking if the rect contains a 1x1 rect below and to the right of (px,py).
89     bool contains(int px, int py) const
90         { return px >= x() && px < right() && py >= y() && py < bottom(); }
91     bool contains(const IntPoint& point) const { return contains(point.x(), point.y()); }
92
93     void intersect(const IntRect&);
94     void unite(const IntRect&);
95
96     void inflateX(int dx)
97     {
98         m_location.setX(m_location.x() - dx);
99         m_size.setWidth(m_size.width() + dx + dx);
100     }
101     void inflateY(int dy)
102     {
103         m_location.setY(m_location.y() - dy);
104         m_size.setHeight(m_size.height() + dy + dy);
105     }
106     void inflate(int d) { inflateX(d); inflateY(d); }
107     void scale(float s);
108
109 #if PLATFORM(WIN)
110     IntRect(const RECT&);
111     operator RECT() const;
112 #elif PLATFORM(QT)
113     IntRect(const QRect&);
114     operator QRect() const;
115 #endif
116
117 #if __APPLE__
118
119     operator CGRect() const;
120
121 #ifndef NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES
122     operator NSRect() const;
123 #endif
124
125 #endif
126
127 private:
128     IntPoint m_location;
129     IntSize m_size;
130 };
131
132 inline IntRect intersection(const IntRect& a, const IntRect& b)
133 {
134     IntRect c = a;
135     c.intersect(b);
136     return c;
137 }
138
139 inline IntRect unionRect(const IntRect& a, const IntRect& b)
140 {
141     IntRect c = a;
142     c.unite(b);
143     return c;
144 }
145
146 inline bool operator==(const IntRect& a, const IntRect& b)
147 {
148     return a.location() == b.location() && a.size() == b.size();
149 }
150
151 inline bool operator!=(const IntRect& a, const IntRect& b)
152 {
153     return a.location() != b.location() || a.size() != b.size();
154 }
155
156 #if __APPLE__
157
158 IntRect enclosingIntRect(const CGRect&);
159
160 #ifndef NSGEOMETRY_TYPES_SAME_AS_CGGEOMETRY_TYPES
161
162 IntRect enclosingIntRect(const NSRect&);
163
164 #endif
165
166 #endif
167
168 } // namespace WebCore
169
170 #endif // INTRECT_H_