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