d34cddd2ae922c18778ef5ca5ad648c525bc6da9
[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 nonCollapsedMarginTop() const;
135     LayoutUnit nonCollapsedMarginBottom() const;
136
137     LayoutUnit borderTop() const;
138     LayoutUnit borderLeft() const;
139     LayoutUnit borderBottom() const;
140     LayoutUnit borderRight() const;
141
142     LayoutUnit paddingTop() const;
143     LayoutUnit paddingLeft() const;
144     LayoutUnit paddingBottom() const;
145     LayoutUnit paddingRight() const;
146
147     LayoutUnit contentBoxTop() const { return borderTop() + paddingTop(); }
148     LayoutUnit contentBoxLeft() const { return borderLeft() + paddingLeft(); }
149     LayoutUnit contentBoxBottom() const { return contentBoxTop() + contentBoxHeight(); }
150     LayoutUnit contentBoxRight() const { return contentBoxLeft() + contentBoxWidth(); }
151     LayoutUnit contentBoxHeight() const;
152     LayoutUnit contentBoxWidth() const;
153
154     Rect marginBox() const;
155     Rect nonCollapsedMarginBox() const;
156
157     Rect borderBox() const;
158     Rect paddingBox() const;
159     Rect contentBox() const;
160
161 private:
162     Box(const RenderStyle&);
163
164     struct Style {
165         Style(const RenderStyle&);
166
167         BoxSizing boxSizing { BoxSizing::ContentBox };
168     };
169
170     void setTopLeft(const LayoutPoint& topLeft) { m_topLeft = topLeft; }
171     void setTop(LayoutUnit top) { m_topLeft.setY(top); }
172     void setLeft(LayoutUnit left) { m_topLeft.setX(left); }
173     void moveHorizontally(LayoutUnit offset) { m_topLeft.move(offset, { }); }
174     void moveVertically(LayoutUnit offset) { m_topLeft.move({ }, offset); }
175
176     void setContentBoxHeight(LayoutUnit);
177     void setContentBoxWidth(LayoutUnit);
178
179     struct HorizontalEdges {
180         LayoutUnit left;
181         LayoutUnit right;
182     };
183
184     struct VerticalEdges {
185         LayoutUnit top;
186         LayoutUnit bottom;
187     };
188
189     struct Edges {
190         HorizontalEdges horizontal;
191         VerticalEdges vertical;
192     };
193
194     void setHorizontalMargin(HorizontalEdges);
195     void setVerticalMargin(VerticalEdges);
196     void setVerticalNonCollapsedMargin(VerticalEdges);
197
198     void setBorder(Edges);
199     void setPadding(Edges);
200
201 #if !ASSERT_DISABLED
202     void invalidateMargin();
203     void invalidateBorder() { m_hasValidBorder = false; }
204     void invalidatePadding() { m_hasValidPadding = false; }
205
206     void setHasValidVerticalMargin() { m_hasValidVerticalMargin = true; }
207     void setHasValidVerticalNonCollapsedMargin() { m_hasValidVerticalNonCollapsedMargin = true; }
208     void setHasValidHorizontalMargin() { m_hasValidHorizontalMargin = true; }
209
210     void setHasValidBorder() { m_hasValidBorder = true; }
211     void setHasValidPadding() { m_hasValidPadding = true; }
212
213     void setHasValidContentHeight() { m_hasValidContentHeight = true; }
214     void setHasValidContentWidth() { m_hasValidContentWidth = true; }
215 #endif
216
217     const Style m_style;
218
219     LayoutPoint m_topLeft;
220     LayoutUnit m_contentWidth;
221     LayoutUnit m_contentHeight;
222
223     Edges m_margin;
224     VerticalEdges m_verticalNonCollapsedMargin;
225
226     Edges m_border;
227     Edges m_padding;
228
229 #if !ASSERT_DISABLED
230     bool m_hasValidHorizontalMargin { false };
231     bool m_hasValidVerticalMargin { false };
232     bool m_hasValidVerticalNonCollapsedMargin { false };
233     bool m_hasValidBorder { false };
234     bool m_hasValidPadding { false };
235     bool m_hasValidContentHeight { false };
236     bool m_hasValidContentWidth { false };
237 #endif
238 };
239
240 #if !ASSERT_DISABLED
241 inline void Box::Rect::invalidatePosition()
242 {
243     invalidateTop();
244     invalidateLeft();
245 }
246
247 inline void Box::Rect::setHasValidPosition()
248 {
249     m_hasValidTop = true;
250     m_hasValidLeft = true;
251 }
252
253 inline void Box::Rect::setHasValidSize()
254 {
255     m_hasValidWidth = true;
256     m_hasValidHeight = true;
257 }
258
259 inline void Box::invalidateMargin()
260 {
261     m_hasValidHorizontalMargin = false;
262     m_hasValidVerticalMargin = false;
263 }
264 #endif
265
266 inline LayoutUnit Box::Rect::top() const
267 {
268     ASSERT(m_hasValidTop);
269     return m_rect.y();
270 }
271
272 inline LayoutUnit Box::Rect::left() const
273 {
274     ASSERT(m_hasValidLeft);
275     return m_rect.x();
276 }
277
278 inline LayoutUnit Box::Rect::bottom() const
279 {
280     ASSERT(m_hasValidTop && m_hasValidHeight);
281     return m_rect.maxY();
282 }
283
284 inline LayoutUnit Box::Rect::right() const
285 {
286     ASSERT(m_hasValidLeft && m_hasValidWidth);
287     return m_rect.maxX();
288 }
289
290 inline LayoutPoint Box::Rect::topLeft() const
291 {
292     ASSERT(hasValidPosition());
293     return m_rect.minXMinYCorner();
294 }
295
296 inline LayoutPoint Box::Rect::bottomRight() const
297 {
298     ASSERT(hasValidGeometry());
299     return m_rect.maxXMaxYCorner();
300 }
301
302 inline LayoutSize Box::Rect::size() const
303 {
304     ASSERT(hasValidSize());
305     return m_rect.size();
306 }
307
308 inline LayoutUnit Box::Rect::width() const
309 {
310     ASSERT(m_hasValidWidth);
311     return m_rect.width();
312 }
313
314 inline LayoutUnit Box::Rect::height() const
315 {
316     ASSERT(m_hasValidHeight);
317     return m_rect.height();
318 }
319
320 inline void Box::Rect::setTopLeft(const LayoutPoint& topLeft)
321 {
322 #if !ASSERT_DISABLED
323     setHasValidPosition();
324 #endif
325     m_rect.setLocation(topLeft);
326 }
327
328 inline void Box::Rect::setTop(LayoutUnit top)
329 {
330 #if !ASSERT_DISABLED
331     m_hasValidTop = true;
332 #endif
333     m_rect.setY(top);
334 }
335
336 inline void Box::Rect::setLeft(LayoutUnit left)
337 {
338 #if !ASSERT_DISABLED
339     m_hasValidLeft = true;
340 #endif
341     m_rect.setX(left);
342 }
343
344 inline void Box::Rect::setWidth(LayoutUnit width)
345 {
346 #if !ASSERT_DISABLED
347     m_hasValidWidth = true;
348 #endif
349     m_rect.setWidth(width);
350 }
351
352 inline void Box::Rect::setHeight(LayoutUnit height)
353 {
354 #if !ASSERT_DISABLED
355     m_hasValidHeight = true;
356 #endif
357     m_rect.setHeight(height);
358 }
359
360 inline void Box::Rect::setSize(const LayoutSize& size)
361 {
362 #if !ASSERT_DISABLED
363     setHasValidSize();
364 #endif
365     m_rect.setSize(size);
366 }
367
368 inline void Box::Rect::shiftLeftTo(LayoutUnit left)
369 {
370     ASSERT(m_hasValidLeft);
371     m_rect.shiftXEdgeTo(left);
372 }
373
374 inline void Box::Rect::shiftRightTo(LayoutUnit right)
375 {
376     ASSERT(m_hasValidLeft && m_hasValidWidth);
377     m_rect.shiftMaxXEdgeTo(right);
378 }
379
380 inline void Box::Rect::shiftTopTo(LayoutUnit top)
381 {
382     ASSERT(m_hasValidTop);
383     m_rect.shiftYEdgeTo(top);
384 }
385
386 inline void Box::Rect::shiftBottomTo(LayoutUnit bottom)
387 {
388     ASSERT(m_hasValidTop && m_hasValidHeight);
389     m_rect.shiftMaxYEdgeTo(bottom);
390 }
391
392 inline void Box::Rect::moveHorizontally(LayoutUnit offset)
393 {
394     ASSERT(m_hasValidLeft);
395     m_rect.move(offset, { });
396 }
397
398 inline void Box::Rect::moveVertically(LayoutUnit offset)
399 {
400     ASSERT(m_hasValidTop);
401     m_rect.move({ }, offset);
402 }
403
404 inline void Box::Rect::expand(LayoutUnit width, LayoutUnit height)
405 {
406     ASSERT(hasValidGeometry());
407     m_rect.expand(width, height);
408 }
409
410 inline Box::Rect Box::Rect::clone() const
411 {
412     Rect rect;
413 #if !ASSERT_DISABLED
414     rect.m_hasValidTop = m_hasValidTop;
415     rect.m_hasValidLeft = m_hasValidLeft;
416     rect.m_hasValidWidth = m_hasValidWidth;
417     rect.m_hasValidHeight  = m_hasValidHeight;
418 #endif 
419     rect.m_rect = m_rect;
420     return rect;
421 }
422
423 inline Box::Rect::operator LayoutRect() const
424 {
425     ASSERT(hasValidGeometry()); 
426     return m_rect;
427 }
428
429 inline void Box::setContentBoxHeight(LayoutUnit height)
430
431 #if !ASSERT_DISABLED
432     setHasValidContentHeight();
433 #endif
434     m_contentHeight = height;
435 }
436
437 inline void Box::setContentBoxWidth(LayoutUnit width)
438
439 #if !ASSERT_DISABLED
440     setHasValidContentWidth();
441 #endif
442     m_contentWidth = width;
443 }
444
445 inline LayoutUnit Box::contentBoxHeight() const
446 {
447     ASSERT(m_hasValidContentHeight);
448     return m_contentHeight;
449 }
450
451 inline LayoutUnit Box::contentBoxWidth() const
452 {
453     ASSERT(m_hasValidContentWidth);
454     return m_contentWidth;
455 }
456
457 inline void Box::setHorizontalMargin(HorizontalEdges margin)
458 {
459 #if !ASSERT_DISABLED
460     setHasValidHorizontalMargin();
461 #endif
462     m_margin.horizontal = margin;
463 }
464
465 inline void Box::setVerticalMargin(VerticalEdges margin)
466 {
467 #if !ASSERT_DISABLED
468     setHasValidVerticalMargin();
469 #endif
470     m_margin.vertical = margin;
471 }
472
473 inline void Box::setVerticalNonCollapsedMargin(VerticalEdges margin)
474 {
475 #if !ASSERT_DISABLED
476     setHasValidVerticalNonCollapsedMargin();
477 #endif
478     m_verticalNonCollapsedMargin = margin;
479 }
480
481 inline void Box::setBorder(Edges border)
482 {
483 #if !ASSERT_DISABLED
484     setHasValidBorder();
485 #endif
486     m_border = border;
487 }
488
489 inline void Box::setPadding(Edges padding)
490 {
491 #if !ASSERT_DISABLED
492     setHasValidPadding();
493 #endif
494     m_padding = padding;
495 }
496
497 inline LayoutUnit Box::marginTop() const
498 {
499     ASSERT(m_hasValidVerticalMargin);
500     return m_margin.vertical.top;
501 }
502
503 inline LayoutUnit Box::marginLeft() const
504 {
505     ASSERT(m_hasValidHorizontalMargin);
506     return m_margin.horizontal.left;
507 }
508
509 inline LayoutUnit Box::marginBottom() const
510 {
511     ASSERT(m_hasValidVerticalMargin);
512     return m_margin.vertical.bottom;
513 }
514
515 inline LayoutUnit Box::marginRight() const
516 {
517     ASSERT(m_hasValidHorizontalMargin);
518     return m_margin.horizontal.right;
519 }
520
521 inline LayoutUnit Box::nonCollapsedMarginTop() const
522 {
523     ASSERT(m_hasValidVerticalNonCollapsedMargin);
524     return m_verticalNonCollapsedMargin.top;
525 }
526
527 inline LayoutUnit Box::nonCollapsedMarginBottom() const
528 {
529     ASSERT(m_hasValidVerticalNonCollapsedMargin);
530     return m_verticalNonCollapsedMargin.bottom;
531 }
532
533 inline LayoutUnit Box::paddingTop() const
534 {
535     ASSERT(m_hasValidPadding);
536     return m_padding.vertical.top;
537 }
538
539 inline LayoutUnit Box::paddingLeft() const
540 {
541     ASSERT(m_hasValidPadding);
542     return m_padding.horizontal.left;
543 }
544
545 inline LayoutUnit Box::paddingBottom() const
546 {
547     ASSERT(m_hasValidPadding);
548     return m_padding.vertical.bottom;
549 }
550
551 inline LayoutUnit Box::paddingRight() const
552 {
553     ASSERT(m_hasValidPadding);
554     return m_padding.horizontal.right;
555 }
556
557 inline LayoutUnit Box::borderTop() const
558 {
559     ASSERT(m_hasValidBorder);
560     return m_border.vertical.top;
561 }
562
563 inline LayoutUnit Box::borderLeft() const
564 {
565     ASSERT(m_hasValidBorder);
566     return m_border.horizontal.left;
567 }
568
569 inline LayoutUnit Box::borderBottom() const
570 {
571     ASSERT(m_hasValidBorder);
572     return m_border.vertical.bottom;
573 }
574
575 inline LayoutUnit Box::borderRight() const
576 {
577     ASSERT(m_hasValidBorder);
578     return m_border.horizontal.right;
579 }
580
581 }
582 }
583 #endif