Implement object-fit CSS property
[WebKit-https.git] / Source / WebCore / platform / graphics / LayoutRect.h
1 /*
2  * Copyright (c) 2012, Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef LayoutRect_h
32 #define LayoutRect_h
33
34 #include "FloatRect.h"
35 #include "IntRect.h"
36 #include "LayoutBoxExtent.h"
37 #include "LayoutPoint.h"
38 #include <wtf/Vector.h>
39
40 namespace WebCore {
41
42 class FloatRect;
43
44 class LayoutRect {
45 public:
46     LayoutRect() { }
47     LayoutRect(const LayoutPoint& location, const LayoutSize& size)
48         : m_location(location), m_size(size) { }
49     LayoutRect(LayoutUnit x, LayoutUnit y, LayoutUnit width, LayoutUnit height)
50         : m_location(LayoutPoint(x, y)), m_size(LayoutSize(width, height)) { }
51     LayoutRect(const FloatPoint& location, const FloatSize& size)
52         : m_location(location), m_size(size) { }
53     LayoutRect(const IntRect& rect) : m_location(rect.location()), m_size(rect.size()) { }
54
55     explicit LayoutRect(const FloatRect&); // don't do this implicitly since it's lossy
56         
57     LayoutPoint location() const { return m_location; }
58     LayoutSize size() const { return m_size; }
59
60     IntPoint pixelSnappedLocation() const { return roundedIntPoint(m_location); }
61     IntSize pixelSnappedSize() const { return IntSize(snapSizeToPixel(m_size.width(), m_location.x()), snapSizeToPixel(m_size.height(), m_location.y())); }
62
63     void setLocation(const LayoutPoint& location) { m_location = location; }
64     void setSize(const LayoutSize& size) { m_size = size; }
65
66     LayoutUnit x() const { return m_location.x(); }
67     LayoutUnit y() const { return m_location.y(); }
68     LayoutUnit maxX() const { return x() + width(); }
69     LayoutUnit maxY() const { return y() + height(); }
70     LayoutUnit width() const { return m_size.width(); }
71     LayoutUnit height() const { return m_size.height(); }
72
73     int pixelSnappedX() const { return x().round(); }
74     int pixelSnappedY() const { return y().round(); }
75     int pixelSnappedWidth() const { return snapSizeToPixel(width(), x()); }
76     int pixelSnappedHeight() const { return snapSizeToPixel(height(), y()); }
77     int pixelSnappedMaxX() const { return (m_location.x() + m_size.width()).round(); }
78     int pixelSnappedMaxY() const { return (m_location.y() + m_size.height()).round(); }
79
80     void setX(LayoutUnit x) { m_location.setX(x); }
81     void setY(LayoutUnit y) { m_location.setY(y); }
82     void setWidth(LayoutUnit width) { m_size.setWidth(width); }
83     void setHeight(LayoutUnit height) { m_size.setHeight(height); }
84
85     bool isEmpty() const { return m_size.isEmpty(); }
86
87     // NOTE: The result is rounded to integer values, and thus may be not the exact
88     // center point.
89     LayoutPoint center() const { return LayoutPoint(x() + width() / 2, y() + height() / 2); }
90
91     void move(const LayoutSize& size) { m_location += size; } 
92     void moveBy(const LayoutPoint& offset) { m_location.move(offset.x(), offset.y()); }
93     void move(LayoutUnit dx, LayoutUnit dy) { m_location.move(dx, dy); } 
94
95     void expand(const LayoutSize& size) { m_size += size; }
96     void expand(const LayoutBoxExtent& box)
97     {
98         m_location.move(-box.left(), -box.top());
99         m_size.expand(box.left() + box.right(), box.top() + box.bottom());
100     }
101     void expand(LayoutUnit dw, LayoutUnit dh) { m_size.expand(dw, dh); }
102     void contract(const LayoutSize& size) { m_size -= size; }
103     void contract(const LayoutBoxExtent& box)
104     {
105         m_location.move(box.left(), box.top());
106         m_size.shrink(box.left() + box.right(), box.top() + box.bottom());
107     }
108     void contract(LayoutUnit dw, LayoutUnit dh) { m_size.expand(-dw, -dh); }
109
110     void shiftXEdgeTo(LayoutUnit edge)
111     {
112         LayoutUnit delta = edge - x();
113         setX(edge);
114         setWidth(std::max<LayoutUnit>(0, width() - delta));
115     }
116     void shiftMaxXEdgeTo(LayoutUnit edge)
117     {
118         LayoutUnit delta = edge - maxX();
119         setWidth(std::max<LayoutUnit>(0, width() + delta));
120     }
121     void shiftYEdgeTo(LayoutUnit edge)
122     {
123         LayoutUnit delta = edge - y();
124         setY(edge);
125         setHeight(std::max<LayoutUnit>(0, height() - delta));
126     }
127     void shiftMaxYEdgeTo(LayoutUnit edge)
128     {
129         LayoutUnit delta = edge - maxY();
130         setHeight(std::max<LayoutUnit>(0, height() + delta));
131     }
132
133     LayoutPoint minXMinYCorner() const { return m_location; } // typically topLeft
134     LayoutPoint maxXMinYCorner() const { return LayoutPoint(m_location.x() + m_size.width(), m_location.y()); } // typically topRight
135     LayoutPoint minXMaxYCorner() const { return LayoutPoint(m_location.x(), m_location.y() + m_size.height()); } // typically bottomLeft
136     LayoutPoint maxXMaxYCorner() const { return LayoutPoint(m_location.x() + m_size.width(), m_location.y() + m_size.height()); } // typically bottomRight
137     
138     bool intersects(const LayoutRect&) const;
139     bool contains(const LayoutRect&) const;
140
141     // This checks to see if the rect contains x,y in the traditional sense.
142     // Equivalent to checking if the rect contains a 1x1 rect below and to the right of (px,py).
143     bool contains(LayoutUnit px, LayoutUnit py) const
144         { return px >= x() && px < maxX() && py >= y() && py < maxY(); }
145     bool contains(const LayoutPoint& point) const { return contains(point.x(), point.y()); }
146
147     void intersect(const LayoutRect&);
148     void unite(const LayoutRect&);
149     void uniteIfNonZero(const LayoutRect&);
150
151     void inflateX(LayoutUnit dx)
152     {
153         m_location.setX(m_location.x() - dx);
154         m_size.setWidth(m_size.width() + dx + dx);
155     }
156     void inflateY(LayoutUnit dy)
157     {
158         m_location.setY(m_location.y() - dy);
159         m_size.setHeight(m_size.height() + dy + dy);
160     }
161     void inflate(LayoutUnit d) { inflateX(d); inflateY(d); }
162     void scale(float s);
163     void scale(float xScale, float yScale);
164
165     LayoutRect transposedRect() const { return LayoutRect(m_location.transposedPoint(), m_size.transposedSize()); }
166
167     static LayoutRect infiniteRect()
168     {
169         // Return a rect that is slightly smaller than the true max rect to allow pixelSnapping to round up to the nearest IntRect without overflowing.
170         return LayoutRect(LayoutUnit::nearlyMin() / 2, LayoutUnit::nearlyMin() / 2, LayoutUnit::nearlyMax(), LayoutUnit::nearlyMax());
171     }
172     
173     operator FloatRect() const { return FloatRect(m_location, m_size); }
174
175 private:
176     LayoutPoint m_location;
177     LayoutSize m_size;
178 };
179
180 inline LayoutRect intersection(const LayoutRect& a, const LayoutRect& b)
181 {
182     LayoutRect c = a;
183     c.intersect(b);
184     return c;
185 }
186
187 inline LayoutRect unionRect(const LayoutRect& a, const LayoutRect& b)
188 {
189     LayoutRect c = a;
190     c.unite(b);
191     return c;
192 }
193
194 LayoutRect unionRect(const Vector<LayoutRect>&);
195
196 inline bool operator==(const LayoutRect& a, const LayoutRect& b)
197 {
198     return a.location() == b.location() && a.size() == b.size();
199 }
200
201 inline bool operator!=(const LayoutRect& a, const LayoutRect& b)
202 {
203     return a.location() != b.location() || a.size() != b.size();
204 }
205
206 inline IntRect pixelSnappedIntRect(const LayoutRect& rect)
207 {
208 #if ENABLE(SUBPIXEL_LAYOUT)
209     return IntRect(roundedIntPoint(rect.location()), IntSize(snapSizeToPixel(rect.width(), rect.x()),
210                                                              snapSizeToPixel(rect.height(), rect.y())));
211
212 #else
213     return IntRect(rect);
214 #endif
215 }
216
217 IntRect enclosingIntRect(const LayoutRect&);
218 LayoutRect enclosingLayoutRect(const FloatRect&);
219
220
221 inline IntRect pixelSnappedIntRect(LayoutUnit left, LayoutUnit top, LayoutUnit width, LayoutUnit height)
222 {
223     return IntRect(left.round(), top.round(), snapSizeToPixel(width, left), snapSizeToPixel(height, top));
224 }
225
226 inline IntRect pixelSnappedIntRectFromEdges(LayoutUnit left, LayoutUnit top, LayoutUnit right, LayoutUnit bottom)
227 {
228     return IntRect(left.round(), top.round(), snapSizeToPixel(right - left, left), snapSizeToPixel(bottom - top, top));
229 }
230
231 inline IntRect pixelSnappedIntRect(LayoutPoint location, LayoutSize size)
232 {
233     return IntRect(roundedIntPoint(location), pixelSnappedIntSize(size, location));
234 }
235
236 } // namespace WebCore
237
238 #endif // LayoutRect_h