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