359c72d70cbe18e096367bc4852c74058728b715
[WebKit-https.git] / Source / WebCore / layout / displaytree / DisplayBox.h
1 /*
2  * Copyright (C) 2018 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 #pragma once
27
28 #if ENABLE(LAYOUT_FORMATTING_CONTEXT)
29
30 #include "LayoutPoint.h"
31 #include "LayoutRect.h"
32 #include "LayoutUnit.h"
33 #include "RenderStyleConstants.h"
34 #include <wtf/IsoMalloc.h>
35
36 namespace WebCore {
37
38 class RenderStyle;
39
40 namespace Layout {
41 class BlockFormattingContext;
42 class FormattingContext;
43 class LayoutContext;
44 }
45
46 namespace Display {
47
48 class Box {
49     WTF_MAKE_ISO_ALLOCATED(Box);
50 public:
51     friend class Layout::BlockFormattingContext;
52     friend class Layout::FormattingContext;
53     friend class Layout::LayoutContext;
54
55     class Rect {
56     public:
57         Rect() = default;
58         
59         LayoutUnit top() const;
60         LayoutUnit left() const;
61         LayoutPoint topLeft() const;
62
63         LayoutUnit bottom() const;
64         LayoutUnit right() const;        
65         LayoutPoint bottomRight() const;
66
67         LayoutUnit width() const;
68         LayoutUnit height() const;
69         LayoutSize size() const;
70
71         void setTop(LayoutUnit);
72         void setLeft(LayoutUnit);
73         void setTopLeft(const LayoutPoint&);
74         void setWidth(LayoutUnit);
75         void setHeight(LayoutUnit);
76         void setSize(const LayoutSize&);
77
78         void shiftLeftTo(LayoutUnit);
79         void shiftRightTo(LayoutUnit);
80         void shiftTopTo(LayoutUnit);
81         void shiftBottomTo(LayoutUnit);
82
83         void moveHorizontally(LayoutUnit);
84         void moveVertically(LayoutUnit);
85
86         void expand(LayoutUnit, LayoutUnit);
87
88         Rect clone() const;
89         operator LayoutRect() const;
90
91     private:
92 #if !ASSERT_DISABLED
93         void invalidateTop() { m_hasValidTop = false; }
94         void invalidateLeft() { m_hasValidLeft = false; }
95         void invalidateWidth() { m_hasValidWidth = false; }
96         void invalidateHeight() { m_hasValidHeight = false; }
97         void invalidatePosition();
98
99         bool hasValidPosition() const { return m_hasValidTop && m_hasValidLeft; }
100         bool hasValidSize() const { return m_hasValidWidth && m_hasValidHeight; }
101         bool hasValidGeometry() const { return hasValidPosition() && hasValidSize(); }
102     
103         void setHasValidPosition();
104         void setHasValidSize();
105
106         bool m_hasValidTop { false };
107         bool m_hasValidLeft { false };
108         bool m_hasValidWidth { false };
109         bool m_hasValidHeight { false };
110 #endif
111         LayoutRect m_rect;
112     };
113
114     ~Box();
115
116     LayoutUnit top() const { return m_topLeft.y(); }
117     LayoutUnit left() const { return m_topLeft.x(); }
118     LayoutUnit bottom() const { return top() + height(); }
119     LayoutUnit right() const { return left() + width(); }
120
121     LayoutPoint topLeft() const { return m_topLeft; }
122     LayoutPoint bottomRight() const { return { right(), bottom() }; }
123
124     LayoutSize size() const { return { width(), height() }; }
125     LayoutUnit width() const { return borderLeft() + paddingLeft() + contentBoxWidth() + paddingRight() + borderRight(); }
126     LayoutUnit height() const { return borderTop() + paddingTop() + contentBoxHeight() + paddingBottom() + borderBottom(); }
127     LayoutRect rect() const { return { left(), top(), width(), height() }; }
128
129     LayoutUnit marginTop() const;
130     LayoutUnit marginLeft() const;
131     LayoutUnit marginBottom() const;
132     LayoutUnit marginRight() const;
133
134     LayoutUnit borderTop() const;
135     LayoutUnit borderLeft() const;
136     LayoutUnit borderBottom() const;
137     LayoutUnit borderRight() const;
138
139     LayoutUnit paddingTop() const;
140     LayoutUnit paddingLeft() const;
141     LayoutUnit paddingBottom() const;
142     LayoutUnit paddingRight() const;
143
144     LayoutUnit contentBoxHeight() const;
145     LayoutUnit contentBoxWidth() const;
146
147     Rect marginBox() const;
148     Rect borderBox() const;
149     Rect paddingBox() const;
150     Rect contentBox() const;
151
152 private:
153     Box(const RenderStyle&);
154
155     struct Style {
156         Style(const RenderStyle&);
157
158         BoxSizing boxSizing { BoxSizing::ContentBox };
159     };
160
161     void setTopLeft(const LayoutPoint& topLeft) { m_topLeft = topLeft; }
162     void setTop(LayoutUnit top) { m_topLeft.setY(top); }
163     void setLeft(LayoutUnit left) { m_topLeft.setX(left); }
164     void moveHorizontally(LayoutUnit offset) { m_topLeft.move(offset, { }); }
165     void moveVertically(LayoutUnit offset) { m_topLeft.move({ }, offset); }
166
167     void setContentBoxHeight(LayoutUnit);
168     void setContentBoxWidth(LayoutUnit);
169
170     struct HorizontalEdges {
171         LayoutUnit left;
172         LayoutUnit right;
173     };
174
175     struct VerticalEdges {
176         LayoutUnit top;
177         LayoutUnit bottom;
178     };
179
180     struct Edges {
181         HorizontalEdges horizontal;
182         VerticalEdges vertical;
183     };
184
185     void setHorizontalMargin(HorizontalEdges);
186     void setVerticalMargin(VerticalEdges);
187     void setBorder(Edges);
188     void setPadding(Edges);
189
190 #if !ASSERT_DISABLED
191     void invalidateMargin();
192     void invalidateBorder() { m_hasValidBorder = false; }
193     void invalidatePadding() { m_hasValidPadding = false; }
194
195     void setHasValidVerticalMargin() { m_hasValidVerticalMargin = true; }
196     void setHasValidHorizontalMargin() { m_hasValidHorizontalMargin = true; }
197
198     void setHasValidBorder() { m_hasValidBorder = true; }
199     void setHasValidPadding() { m_hasValidPadding = true; }
200
201     void setHasValidContentHeight() { m_hasValidContentHeight = true; }
202     void setHasValidContentWidth() { m_hasValidContentWidth = true; }
203 #endif
204
205     const Style m_style;
206
207     LayoutPoint m_topLeft;
208     LayoutUnit m_contentWidth;
209     LayoutUnit m_contentHeight;
210
211     Edges m_margin;
212     Edges m_border;
213     Edges m_padding;
214
215 #if !ASSERT_DISABLED
216     bool m_hasValidHorizontalMargin { false };
217     bool m_hasValidVerticalMargin { false };
218     bool m_hasValidBorder { false };
219     bool m_hasValidPadding { false };
220     bool m_hasValidContentHeight { false };
221     bool m_hasValidContentWidth { false };
222 #endif
223 };
224
225 #if !ASSERT_DISABLED
226 inline void Box::Rect::invalidatePosition()
227 {
228     invalidateTop();
229     invalidateLeft();
230 }
231
232 inline void Box::Rect::setHasValidPosition()
233 {
234     m_hasValidTop = true;
235     m_hasValidLeft = true;
236 }
237
238 inline void Box::Rect::setHasValidSize()
239 {
240     m_hasValidWidth = true;
241     m_hasValidHeight = true;
242 }
243
244 inline void Box::invalidateMargin()
245 {
246     m_hasValidHorizontalMargin = false;
247     m_hasValidVerticalMargin = false;
248 }
249 #endif
250
251 inline LayoutUnit Box::Rect::top() const
252 {
253     ASSERT(m_hasValidTop);
254     return m_rect.y();
255 }
256
257 inline LayoutUnit Box::Rect::left() const
258 {
259     ASSERT(m_hasValidLeft);
260     return m_rect.x();
261 }
262
263 inline LayoutUnit Box::Rect::bottom() const
264 {
265     ASSERT(m_hasValidTop && m_hasValidHeight);
266     return m_rect.maxY();
267 }
268
269 inline LayoutUnit Box::Rect::right() const
270 {
271     ASSERT(m_hasValidLeft && m_hasValidWidth);
272     return m_rect.maxX();
273 }
274
275 inline LayoutPoint Box::Rect::topLeft() const
276 {
277     ASSERT(hasValidPosition());
278     return m_rect.minXMinYCorner();
279 }
280
281 inline LayoutPoint Box::Rect::bottomRight() const
282 {
283     ASSERT(hasValidGeometry());
284     return m_rect.maxXMaxYCorner();
285 }
286
287 inline LayoutSize Box::Rect::size() const
288 {
289     ASSERT(hasValidSize());
290     return m_rect.size();
291 }
292
293 inline LayoutUnit Box::Rect::width() const
294 {
295     ASSERT(m_hasValidWidth);
296     return m_rect.width();
297 }
298
299 inline LayoutUnit Box::Rect::height() const
300 {
301     ASSERT(m_hasValidHeight);
302     return m_rect.height();
303 }
304
305 inline void Box::Rect::setTopLeft(const LayoutPoint& topLeft)
306 {
307 #if !ASSERT_DISABLED
308     setHasValidPosition();
309 #endif
310     m_rect.setLocation(topLeft);
311 }
312
313 inline void Box::Rect::setTop(LayoutUnit top)
314 {
315 #if !ASSERT_DISABLED
316     m_hasValidTop = true;
317 #endif
318     m_rect.setY(top);
319 }
320
321 inline void Box::Rect::setLeft(LayoutUnit left)
322 {
323 #if !ASSERT_DISABLED
324     m_hasValidLeft = true;
325 #endif
326     m_rect.setX(left);
327 }
328
329 inline void Box::Rect::setWidth(LayoutUnit width)
330 {
331 #if !ASSERT_DISABLED
332     m_hasValidWidth = true;
333 #endif
334     m_rect.setWidth(width);
335 }
336
337 inline void Box::Rect::setHeight(LayoutUnit height)
338 {
339 #if !ASSERT_DISABLED
340     m_hasValidHeight = true;
341 #endif
342     m_rect.setHeight(height);
343 }
344
345 inline void Box::Rect::setSize(const LayoutSize& size)
346 {
347 #if !ASSERT_DISABLED
348     setHasValidSize();
349 #endif
350     m_rect.setSize(size);
351 }
352
353 inline void Box::Rect::shiftLeftTo(LayoutUnit left)
354 {
355     ASSERT(m_hasValidLeft);
356     m_rect.shiftXEdgeTo(left);
357 }
358
359 inline void Box::Rect::shiftRightTo(LayoutUnit right)
360 {
361     ASSERT(m_hasValidLeft && m_hasValidWidth);
362     m_rect.shiftMaxXEdgeTo(right);
363 }
364
365 inline void Box::Rect::shiftTopTo(LayoutUnit top)
366 {
367     ASSERT(m_hasValidTop);
368     m_rect.shiftYEdgeTo(top);
369 }
370
371 inline void Box::Rect::shiftBottomTo(LayoutUnit bottom)
372 {
373     ASSERT(m_hasValidTop && m_hasValidHeight);
374     m_rect.shiftMaxYEdgeTo(bottom);
375 }
376
377 inline void Box::Rect::moveHorizontally(LayoutUnit offset)
378 {
379     ASSERT(m_hasValidLeft);
380     m_rect.move(offset, { });
381 }
382
383 inline void Box::Rect::moveVertically(LayoutUnit offset)
384 {
385     ASSERT(m_hasValidTop);
386     m_rect.move({ }, offset);
387 }
388
389 inline void Box::Rect::expand(LayoutUnit width, LayoutUnit height)
390 {
391     ASSERT(hasValidGeometry());
392     m_rect.expand(width, height);
393 }
394
395 inline Box::Rect Box::Rect::clone() const
396 {
397     Rect rect;
398 #if !ASSERT_DISABLED
399     rect.m_hasValidTop = m_hasValidTop;
400     rect.m_hasValidLeft = m_hasValidLeft;
401     rect.m_hasValidWidth = m_hasValidWidth;
402     rect.m_hasValidHeight  = m_hasValidHeight;
403 #endif 
404     rect.m_rect = m_rect;
405     return rect;
406 }
407
408 inline Box::Rect::operator LayoutRect() const
409 {
410     ASSERT(hasValidGeometry()); 
411     return m_rect;
412 }
413
414 inline void Box::setContentBoxHeight(LayoutUnit height)
415
416 #if !ASSERT_DISABLED
417     setHasValidContentHeight();
418 #endif
419     m_contentHeight = height;
420 }
421
422 inline void Box::setContentBoxWidth(LayoutUnit width)
423
424 #if !ASSERT_DISABLED
425     setHasValidContentWidth();
426 #endif
427     m_contentWidth = width;
428 }
429
430 inline LayoutUnit Box::contentBoxHeight() const
431 {
432     ASSERT(m_hasValidContentHeight);
433     return m_contentHeight;
434 }
435
436 inline LayoutUnit Box::contentBoxWidth() const
437 {
438     ASSERT(m_hasValidContentWidth);
439     return m_contentWidth;
440 }
441
442 inline void Box::setHorizontalMargin(HorizontalEdges margin)
443 {
444 #if !ASSERT_DISABLED
445     setHasValidHorizontalMargin();
446 #endif
447     m_margin.horizontal = margin;
448 }
449
450 inline void Box::setVerticalMargin(VerticalEdges margin)
451 {
452 #if !ASSERT_DISABLED
453     setHasValidVerticalMargin();
454 #endif
455     m_margin.vertical = margin;
456 }
457
458 inline void Box::setBorder(Edges border)
459 {
460 #if !ASSERT_DISABLED
461     setHasValidBorder();
462 #endif
463     m_border = border;
464 }
465
466 inline void Box::setPadding(Edges padding)
467 {
468 #if !ASSERT_DISABLED
469     setHasValidPadding();
470 #endif
471     m_padding = padding;
472 }
473
474 inline LayoutUnit Box::marginTop() const
475 {
476     ASSERT(m_hasValidVerticalMargin);
477     return m_margin.vertical.top;
478 }
479
480 inline LayoutUnit Box::marginLeft() const
481 {
482     ASSERT(m_hasValidHorizontalMargin);
483     return m_margin.horizontal.left;
484 }
485
486 inline LayoutUnit Box::marginBottom() const
487 {
488     ASSERT(m_hasValidVerticalMargin);
489     return m_margin.vertical.bottom;
490 }
491
492 inline LayoutUnit Box::marginRight() const
493 {
494     ASSERT(m_hasValidHorizontalMargin);
495     return m_margin.horizontal.right;
496 }
497
498 inline LayoutUnit Box::paddingTop() const
499 {
500     ASSERT(m_hasValidPadding);
501     return m_padding.vertical.top;
502 }
503
504 inline LayoutUnit Box::paddingLeft() const
505 {
506     ASSERT(m_hasValidPadding);
507     return m_padding.horizontal.left;
508 }
509
510 inline LayoutUnit Box::paddingBottom() const
511 {
512     ASSERT(m_hasValidPadding);
513     return m_padding.vertical.bottom;
514 }
515
516 inline LayoutUnit Box::paddingRight() const
517 {
518     ASSERT(m_hasValidPadding);
519     return m_padding.horizontal.right;
520 }
521
522 inline LayoutUnit Box::borderTop() const
523 {
524     ASSERT(m_hasValidBorder);
525     return m_border.vertical.top;
526 }
527
528 inline LayoutUnit Box::borderLeft() const
529 {
530     ASSERT(m_hasValidBorder);
531     return m_border.horizontal.left;
532 }
533
534 inline LayoutUnit Box::borderBottom() const
535 {
536     ASSERT(m_hasValidBorder);
537     return m_border.vertical.bottom;
538 }
539
540 inline LayoutUnit Box::borderRight() const
541 {
542     ASSERT(m_hasValidBorder);
543     return m_border.horizontal.right;
544 }
545
546 }
547 }
548 #endif