[WTF] Import std::optional reference implementation as WTF::Optional
[WebKit-https.git] / Source / WebCore / rendering / RenderBlockFlow.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2007 David Smith (catfish.man@gmail.com)
5  * Copyright (C) 2003-2013,  Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  */
22
23 #pragma once
24
25 #include "FloatingObjects.h"
26 #include "LineWidth.h"
27 #include "RenderBlock.h"
28 #include "RenderLineBoxList.h"
29 #include "SimpleLineLayout.h"
30 #include "TrailingObjects.h"
31 #include <memory>
32
33 namespace WebCore {
34
35 class FloatWithRect;
36 class LayoutStateMaintainer;
37 class LineBreaker;
38 class LineInfo;
39 class RenderMultiColumnFlowThread;
40 class RenderNamedFlowFragment;
41 class RenderRubyRun;
42
43 struct WordMeasurement;
44
45 template <class Run> class BidiRunList;
46 typedef Vector<WordMeasurement, 64> WordMeasurements;
47
48 #if ENABLE(TEXT_AUTOSIZING)
49 enum LineCount {
50     NOT_SET = 0, NO_LINE = 1, ONE_LINE = 2, MULTI_LINE = 3
51 };
52 #endif
53
54 class RenderBlockFlow : public RenderBlock {
55 public:
56     RenderBlockFlow(Element&, RenderStyle&&);
57     RenderBlockFlow(Document&, RenderStyle&&);
58     virtual ~RenderBlockFlow();
59         
60     void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) override;
61
62 protected:
63     void insertedIntoTree() override;
64     void willBeDestroyed() override;
65     
66     // This method is called at the start of layout to wipe away all of the floats in our floating objects list. It also
67     // repopulates the list with any floats that intrude from previous siblings or parents. Floats that were added by
68     // descendants are gone when this call completes and will get added back later on after the children have gotten
69     // a relayout.
70     void rebuildFloatingObjectSetFromIntrudingFloats();
71
72     // RenderBlockFlow always contains either lines or paragraphs. When the children are all blocks (e.g. paragraphs), we call layoutBlockChildren.
73     // When the children are are all inline (e.g., lines), we call layoutInlineChildren.
74     void layoutBlockChildren(bool relayoutChildren, LayoutUnit& maxFloatLogicalBottom);
75     void layoutInlineChildren(bool relayoutChildren, LayoutUnit& repaintLogicalTop, LayoutUnit& repaintLogicalBottom);
76
77     // RenderBlockFlows override these methods, since they are the only class that supports margin collapsing.
78     LayoutUnit collapsedMarginBefore() const final { return maxPositiveMarginBefore() - maxNegativeMarginBefore(); }
79     LayoutUnit collapsedMarginAfter() const final { return maxPositiveMarginAfter() - maxNegativeMarginAfter(); }
80
81     void dirtyLinesFromChangedChild(RenderObject& child) final { lineBoxes().dirtyLinesFromChangedChild(*this, child); }
82     void updateLogicalHeight() override;
83
84     void paintColumnRules(PaintInfo&, const LayoutPoint&) override;
85
86 public:
87     class MarginValues {
88     public:
89         MarginValues(LayoutUnit beforePos, LayoutUnit beforeNeg, LayoutUnit afterPos, LayoutUnit afterNeg)
90             : m_positiveMarginBefore(beforePos)
91             , m_negativeMarginBefore(beforeNeg)
92             , m_positiveMarginAfter(afterPos)
93             , m_negativeMarginAfter(afterNeg)
94         {
95         }
96         
97         LayoutUnit positiveMarginBefore() const { return m_positiveMarginBefore; }
98         LayoutUnit negativeMarginBefore() const { return m_negativeMarginBefore; }
99         LayoutUnit positiveMarginAfter() const { return m_positiveMarginAfter; }
100         LayoutUnit negativeMarginAfter() const { return m_negativeMarginAfter; }
101         
102         void setPositiveMarginBefore(LayoutUnit pos) { m_positiveMarginBefore = pos; }
103         void setNegativeMarginBefore(LayoutUnit neg) { m_negativeMarginBefore = neg; }
104         void setPositiveMarginAfter(LayoutUnit pos) { m_positiveMarginAfter = pos; }
105         void setNegativeMarginAfter(LayoutUnit neg) { m_negativeMarginAfter = neg; }
106     
107     private:
108         LayoutUnit m_positiveMarginBefore;
109         LayoutUnit m_negativeMarginBefore;
110         LayoutUnit m_positiveMarginAfter;
111         LayoutUnit m_negativeMarginAfter;
112     };
113     MarginValues marginValuesForChild(RenderBox& child) const;
114
115     // Allocated only when some of these fields have non-default values
116     struct RenderBlockFlowRareData {
117         WTF_MAKE_NONCOPYABLE(RenderBlockFlowRareData); WTF_MAKE_FAST_ALLOCATED;
118     public:
119         RenderBlockFlowRareData(const RenderBlockFlow& block)
120             : m_margins(positiveMarginBeforeDefault(block), negativeMarginBeforeDefault(block), positiveMarginAfterDefault(block), negativeMarginAfterDefault(block))
121             , m_lineBreakToAvoidWidow(-1)
122             , m_renderNamedFlowFragment(nullptr)
123             , m_multiColumnFlowThread(nullptr)
124             , m_discardMarginBefore(false)
125             , m_discardMarginAfter(false)
126             , m_didBreakAtLineToAvoidWidow(false)
127         { 
128         }
129
130         ~RenderBlockFlowRareData()
131         {
132         }
133
134         static LayoutUnit positiveMarginBeforeDefault(const RenderBlock& block)
135         { 
136             return std::max<LayoutUnit>(block.marginBefore(), 0);
137         }
138         static LayoutUnit negativeMarginBeforeDefault(const RenderBlock& block)
139         { 
140             return std::max<LayoutUnit>(-block.marginBefore(), 0);
141         }
142         static LayoutUnit positiveMarginAfterDefault(const RenderBlock& block)
143         {
144             return std::max<LayoutUnit>(block.marginAfter(), 0);
145         }
146         static LayoutUnit negativeMarginAfterDefault(const RenderBlock& block)
147         {
148             return std::max<LayoutUnit>(-block.marginAfter(), 0);
149         }
150         
151         MarginValues m_margins;
152         int m_lineBreakToAvoidWidow;
153         std::unique_ptr<RootInlineBox> m_lineGridBox;
154         RenderNamedFlowFragment* m_renderNamedFlowFragment;
155
156         RenderMultiColumnFlowThread* m_multiColumnFlowThread;
157         
158         bool m_discardMarginBefore : 1;
159         bool m_discardMarginAfter : 1;
160         bool m_didBreakAtLineToAvoidWidow : 1;
161     };
162
163     class MarginInfo {
164         // Collapsing flags for whether we can collapse our margins with our children's margins.
165         bool m_canCollapseWithChildren : 1;
166         bool m_canCollapseMarginBeforeWithChildren : 1;
167         bool m_canCollapseMarginAfterWithChildren : 1;
168
169         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
170         // margins in our container. Table cells and the body are the common examples. We
171         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
172         bool m_quirkContainer : 1;
173
174         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.  
175         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
176         // always be collapsing with one another. This variable can remain set to true through multiple iterations 
177         // as long as we keep encountering self-collapsing blocks.
178         bool m_atBeforeSideOfBlock : 1;
179
180         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
181         bool m_atAfterSideOfBlock : 1;
182
183         // These variables are used to detect quirky margins that we need to collapse away (in table cells
184         // and in the body element).
185         bool m_hasMarginBeforeQuirk : 1;
186         bool m_hasMarginAfterQuirk : 1;
187         bool m_determinedMarginBeforeQuirk : 1;
188
189         bool m_discardMargin : 1;
190
191         // These flags track the previous maximal positive and negative margins.
192         LayoutUnit m_positiveMargin;
193         LayoutUnit m_negativeMargin;
194
195     public:
196         MarginInfo(const RenderBlockFlow&, LayoutUnit beforeBorderPadding, LayoutUnit afterBorderPadding);
197
198         void setAtBeforeSideOfBlock(bool b) { m_atBeforeSideOfBlock = b; }
199         void setAtAfterSideOfBlock(bool b) { m_atAfterSideOfBlock = b; }
200         void clearMargin()
201         {
202             m_positiveMargin = 0;
203             m_negativeMargin = 0;
204         }
205         void setHasMarginBeforeQuirk(bool b) { m_hasMarginBeforeQuirk = b; }
206         void setHasMarginAfterQuirk(bool b) { m_hasMarginAfterQuirk = b; }
207         void setDeterminedMarginBeforeQuirk(bool b) { m_determinedMarginBeforeQuirk = b; }
208         void setPositiveMargin(LayoutUnit p) { ASSERT(!m_discardMargin); m_positiveMargin = p; }
209         void setNegativeMargin(LayoutUnit n) { ASSERT(!m_discardMargin); m_negativeMargin = n; }
210         void setPositiveMarginIfLarger(LayoutUnit p)
211         {
212             ASSERT(!m_discardMargin);
213             if (p > m_positiveMargin)
214                 m_positiveMargin = p;
215         }
216         void setNegativeMarginIfLarger(LayoutUnit n)
217         {
218             ASSERT(!m_discardMargin);
219             if (n > m_negativeMargin)
220                 m_negativeMargin = n;
221         }
222
223         void setMargin(LayoutUnit p, LayoutUnit n) { ASSERT(!m_discardMargin); m_positiveMargin = p; m_negativeMargin = n; }
224         void setCanCollapseMarginAfterWithChildren(bool collapse) { m_canCollapseMarginAfterWithChildren = collapse; }
225         void setDiscardMargin(bool value) { m_discardMargin = value; }
226
227         bool atBeforeSideOfBlock() const { return m_atBeforeSideOfBlock; }
228         bool canCollapseWithMarginBefore() const { return m_atBeforeSideOfBlock && m_canCollapseMarginBeforeWithChildren; }
229         bool canCollapseWithMarginAfter() const { return m_atAfterSideOfBlock && m_canCollapseMarginAfterWithChildren; }
230         bool canCollapseMarginBeforeWithChildren() const { return m_canCollapseMarginBeforeWithChildren; }
231         bool canCollapseMarginAfterWithChildren() const { return m_canCollapseMarginAfterWithChildren; }
232         bool quirkContainer() const { return m_quirkContainer; }
233         bool determinedMarginBeforeQuirk() const { return m_determinedMarginBeforeQuirk; }
234         bool hasMarginBeforeQuirk() const { return m_hasMarginBeforeQuirk; }
235         bool hasMarginAfterQuirk() const { return m_hasMarginAfterQuirk; }
236         LayoutUnit positiveMargin() const { return m_positiveMargin; }
237         LayoutUnit negativeMargin() const { return m_negativeMargin; }
238         bool discardMargin() const { return m_discardMargin; }
239         LayoutUnit margin() const { return m_positiveMargin - m_negativeMargin; }
240     };
241     LayoutUnit marginOffsetForSelfCollapsingBlock();
242
243     void layoutBlockChild(RenderBox& child, MarginInfo&, LayoutUnit& previousFloatLogicalBottom, LayoutUnit& maxFloatLogicalBottom);
244     void adjustPositionedBlock(RenderBox& child, const MarginInfo&);
245     void adjustFloatingBlock(const MarginInfo&);
246
247     void setStaticInlinePositionForChild(RenderBox& child, LayoutUnit blockOffset, LayoutUnit inlinePosition);
248     void updateStaticInlinePositionForChild(RenderBox& child, LayoutUnit logicalTop, IndentTextOrNot shouldIndentText);
249
250     LayoutUnit collapseMargins(RenderBox& child, MarginInfo&);
251     LayoutUnit collapseMarginsWithChildInfo(RenderBox* child, RenderObject* prevSibling, MarginInfo&);
252
253     LayoutUnit clearFloatsIfNeeded(RenderBox& child, MarginInfo&, LayoutUnit oldTopPosMargin, LayoutUnit oldTopNegMargin, LayoutUnit yPos);
254     LayoutUnit estimateLogicalTopPosition(RenderBox& child, const MarginInfo&, LayoutUnit& estimateWithoutPagination);
255     void marginBeforeEstimateForChild(RenderBox&, LayoutUnit&, LayoutUnit&, bool&) const;
256     void handleAfterSideOfBlock(LayoutUnit top, LayoutUnit bottom, MarginInfo&);
257     void setCollapsedBottomMargin(const MarginInfo&);
258
259     bool childrenPreventSelfCollapsing() const final;
260
261     bool shouldBreakAtLineToAvoidWidow() const { return hasRareBlockFlowData() && rareBlockFlowData()->m_lineBreakToAvoidWidow >= 0; }
262     void clearShouldBreakAtLineToAvoidWidow() const;
263     int lineBreakToAvoidWidow() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_lineBreakToAvoidWidow : -1; }
264     void setBreakAtLineToAvoidWidow(int);
265     void clearDidBreakAtLineToAvoidWidow();
266     void setDidBreakAtLineToAvoidWidow();
267     bool didBreakAtLineToAvoidWidow() const { return hasRareBlockFlowData() && rareBlockFlowData()->m_didBreakAtLineToAvoidWidow; }
268     bool relayoutToAvoidWidows(LayoutStateMaintainer&);
269
270     bool canHaveGeneratedChildren() const override;
271
272     RootInlineBox* lineGridBox() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_lineGridBox.get() : nullptr; }
273     void setLineGridBox(std::unique_ptr<RootInlineBox> box)
274     {
275         ensureRareBlockFlowData().m_lineGridBox = WTFMove(box);
276     }
277     void layoutLineGridBox();
278
279     bool canDropAnonymousBlockChild() const override { return !renderNamedFlowFragment(); }
280     RenderNamedFlowFragment* renderNamedFlowFragment() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_renderNamedFlowFragment : nullptr; }
281     void setRenderNamedFlowFragment(RenderNamedFlowFragment*);
282
283     RenderMultiColumnFlowThread* multiColumnFlowThread() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_multiColumnFlowThread : nullptr; }
284     void setMultiColumnFlowThread(RenderMultiColumnFlowThread*);
285     
286     bool containsFloats() const override { return m_floatingObjects && !m_floatingObjects->set().isEmpty(); }
287     bool containsFloat(RenderBox&) const;
288
289     void deleteLines() override;
290     void computeOverflow(LayoutUnit oldClientAfterEdge, bool recomputeFloats = false) override;
291     VisiblePosition positionForPoint(const LayoutPoint&, const RenderRegion*) override;
292
293     void removeFloatingObjects();
294     void markAllDescendantsWithFloatsForLayout(RenderBox* floatToRemove = nullptr, bool inLayout = true);
295     void markSiblingsWithFloatsForLayout(RenderBox* floatToRemove = nullptr);
296
297     const FloatingObjectSet* floatingObjectSet() const { return m_floatingObjects ? &m_floatingObjects->set() : nullptr; }
298
299     LayoutUnit logicalTopForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.y() : floatingObject.x(); }
300     LayoutUnit logicalBottomForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.maxY() : floatingObject.maxX(); }
301     LayoutUnit logicalLeftForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.x() : floatingObject.y(); }
302     LayoutUnit logicalRightForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.maxX() : floatingObject.maxY(); }
303     LayoutUnit logicalWidthForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.width() : floatingObject.height(); }
304     LayoutUnit logicalHeightForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.height() : floatingObject.width(); }
305
306     void setLogicalTopForFloat(FloatingObject& floatingObject, LayoutUnit logicalTop)
307     {
308         if (isHorizontalWritingMode())
309             floatingObject.setY(logicalTop);
310         else
311             floatingObject.setX(logicalTop);
312     }
313     void setLogicalLeftForFloat(FloatingObject& floatingObject, LayoutUnit logicalLeft)
314     {
315         if (isHorizontalWritingMode())
316             floatingObject.setX(logicalLeft);
317         else
318             floatingObject.setY(logicalLeft);
319     }
320     void setLogicalHeightForFloat(FloatingObject& floatingObject, LayoutUnit logicalHeight)
321     {
322         if (isHorizontalWritingMode())
323             floatingObject.setHeight(logicalHeight);
324         else
325             floatingObject.setWidth(logicalHeight);
326     }
327     void setLogicalWidthForFloat(FloatingObject& floatingObject, LayoutUnit logicalWidth)
328     {
329         if (isHorizontalWritingMode())
330             floatingObject.setWidth(logicalWidth);
331         else
332             floatingObject.setHeight(logicalWidth);
333     }
334
335     LayoutUnit xPositionForFloatIncludingMargin(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.x() + floatingObject.renderer().marginLeft() : floatingObject.x() + marginBeforeForChild(floatingObject.renderer()); }
336     LayoutUnit yPositionForFloatIncludingMargin(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.y() + marginBeforeForChild(floatingObject.renderer()) : floatingObject.y() + floatingObject.renderer().marginTop(); }
337
338     LayoutPoint flipFloatForWritingModeForChild(const FloatingObject&, const LayoutPoint&) const;
339
340     RenderLineBoxList& lineBoxes() { return m_lineBoxes; }
341     const RenderLineBoxList& lineBoxes() const { return m_lineBoxes; }
342
343     RootInlineBox* firstRootBox() const { return downcast<RootInlineBox>(m_lineBoxes.firstLineBox()); }
344     RootInlineBox* lastRootBox() const { return downcast<RootInlineBox>(m_lineBoxes.lastLineBox()); }
345
346     bool hasLines() const;
347     void invalidateLineLayoutPath() final;
348
349     enum LineLayoutPath { UndeterminedPath = 0, SimpleLinesPath, LineBoxesPath, ForceLineBoxesPath };
350     LineLayoutPath lineLayoutPath() const { return static_cast<LineLayoutPath>(renderBlockFlowLineLayoutPath()); }
351     void setLineLayoutPath(LineLayoutPath path) { setRenderBlockFlowLineLayoutPath(path); }
352
353     // Helper methods for computing line counts and heights for line counts.
354     RootInlineBox* lineAtIndex(int) const;
355     int lineCount(const RootInlineBox* = nullptr, bool* = nullptr) const;
356     int heightForLineCount(int);
357     void clearTruncation();
358
359     void setHasMarkupTruncation(bool b) { setRenderBlockFlowHasMarkupTruncation(b); }
360     bool hasMarkupTruncation() const { return renderBlockFlowHasMarkupTruncation(); }
361
362     bool containsNonZeroBidiLevel() const;
363
364     const SimpleLineLayout::Layout* simpleLineLayout() const;
365     void deleteLineBoxesBeforeSimpleLineLayout();
366     void ensureLineBoxes();
367
368 #if ENABLE(TREE_DEBUGGING)
369     void showLineTreeAndMark(const InlineBox* markedBox, int depth) const;
370 #endif
371
372     // Returns the logicalOffset at the top of the next page. If the offset passed in is already at the top of the current page,
373     // then nextPageLogicalTop with ExcludePageBoundary will still move to the top of the next page. nextPageLogicalTop with
374     // IncludePageBoundary set will not.
375     //
376     // For a page height of 800px, the first rule will return 800 if the value passed in is 0. The second rule will simply return 0.
377     enum PageBoundaryRule { ExcludePageBoundary, IncludePageBoundary };
378     LayoutUnit nextPageLogicalTop(LayoutUnit logicalOffset, PageBoundaryRule = ExcludePageBoundary) const;
379     LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const;
380     LayoutUnit pageLogicalHeightForOffset(LayoutUnit offset) const;
381     LayoutUnit pageRemainingLogicalHeightForOffset(LayoutUnit offset, PageBoundaryRule = IncludePageBoundary) const;
382     LayoutUnit logicalHeightForChildForFragmentation(const RenderBox& child) const;
383     bool hasNextPage(LayoutUnit logicalOffset, PageBoundaryRule = ExcludePageBoundary) const;
384
385     void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) override;
386     void removeChild(RenderObject&) override;
387
388     void createMultiColumnFlowThread();
389     void destroyMultiColumnFlowThread();
390
391     void updateColumnProgressionFromStyle(RenderStyle&);
392     void updateStylesForColumnChildren();
393
394     bool needsLayoutAfterRegionRangeChange() const override;
395     WEBCORE_EXPORT RenderText* findClosestTextAtAbsolutePoint(const FloatPoint&);
396
397 protected:
398     void computeIntrinsicLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const override;
399     
400     // A page break is required at some offset due to space shortage in the current fragmentainer.
401     void setPageBreak(LayoutUnit offset, LayoutUnit spaceShortage);
402
403     // Update minimum page height required to avoid fragmentation where it shouldn't occur (inside
404     // unbreakable content, between orphans and widows, etc.). This will be used as a hint to the
405     // column balancer to help set a good minimum column height.
406     void updateMinimumPageHeight(LayoutUnit offset, LayoutUnit minHeight);
407     bool pushToNextPageWithMinimumLogicalHeight(LayoutUnit& adjustment, LayoutUnit logicalOffset, LayoutUnit minimumLogicalHeight) const;
408
409     // If the child is unsplittable and can't fit on the current page, return the top of the next page/column.
410     LayoutUnit adjustForUnsplittableChild(RenderBox& child, LayoutUnit logicalOffset, bool includeMargins = false);
411     LayoutUnit adjustBlockChildForPagination(LayoutUnit logicalTopAfterClear, LayoutUnit estimateWithoutPagination, RenderBox& child, bool atBeforeSideOfBlock);
412     LayoutUnit applyBeforeBreak(RenderBox& child, LayoutUnit logicalOffset); // If the child has a before break, then return a new yPos that shifts to the top of the next page/column.
413     LayoutUnit applyAfterBreak(RenderBox& child, LayoutUnit logicalOffset, MarginInfo&); // If the child has an after break, then return a new offset that shifts to the top of the next page/column.
414
415     LayoutUnit maxPositiveMarginBefore() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_margins.positiveMarginBefore() : RenderBlockFlowRareData::positiveMarginBeforeDefault(*this); }
416     LayoutUnit maxNegativeMarginBefore() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_margins.negativeMarginBefore() : RenderBlockFlowRareData::negativeMarginBeforeDefault(*this); }
417     LayoutUnit maxPositiveMarginAfter() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_margins.positiveMarginAfter() : RenderBlockFlowRareData::positiveMarginAfterDefault(*this); }
418     LayoutUnit maxNegativeMarginAfter() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_margins.negativeMarginAfter() : RenderBlockFlowRareData::negativeMarginAfterDefault(*this); }
419
420     void initMaxMarginValues()
421     {
422         if (!hasRareBlockFlowData())
423             return;
424
425         rareBlockFlowData()->m_margins = MarginValues(RenderBlockFlowRareData::positiveMarginBeforeDefault(*this) , RenderBlockFlowRareData::negativeMarginBeforeDefault(*this),
426             RenderBlockFlowRareData::positiveMarginAfterDefault(*this), RenderBlockFlowRareData::negativeMarginAfterDefault(*this));
427         rareBlockFlowData()->m_discardMarginBefore = false;
428         rareBlockFlowData()->m_discardMarginAfter = false;
429     }
430
431     void setMaxMarginBeforeValues(LayoutUnit pos, LayoutUnit neg);
432     void setMaxMarginAfterValues(LayoutUnit pos, LayoutUnit neg);
433
434     void setMustDiscardMarginBefore(bool = true);
435     void setMustDiscardMarginAfter(bool = true);
436
437     bool mustDiscardMarginBefore() const;
438     bool mustDiscardMarginAfter() const;
439
440     bool mustDiscardMarginBeforeForChild(const RenderBox&) const;
441     bool mustDiscardMarginAfterForChild(const RenderBox&) const;
442     bool mustSeparateMarginBeforeForChild(const RenderBox&) const;
443     bool mustSeparateMarginAfterForChild(const RenderBox&) const;
444
445     void styleWillChange(StyleDifference, const RenderStyle& newStyle) override;
446     void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
447
448     void createFloatingObjects();
449
450     std::optional<int> firstLineBaseline() const override;
451     std::optional<int> inlineBlockBaseline(LineDirectionMode) const override;
452
453     bool isMultiColumnBlockFlow() const override { return multiColumnFlowThread(); }
454     
455     void setComputedColumnCountAndWidth(int, LayoutUnit);
456
457     LayoutUnit computedColumnWidth() const;
458     unsigned computedColumnCount() const;
459     
460     bool isTopLayoutOverflowAllowed() const override;
461     bool isLeftLayoutOverflowAllowed() const override;
462
463     void moveFloatsTo(RenderBlockFlow* toBlock);
464     
465     virtual void computeColumnCountAndWidth();
466     virtual bool requiresColumns(int) const;
467     
468     virtual void cachePriorCharactersIfNeeded(const LazyLineBreakIterator&) {};
469     
470 private:
471     bool recomputeLogicalWidthAndColumnWidth();
472     LayoutUnit columnGap() const;
473     
474     RenderBlockFlow* previousSiblingWithOverhangingFloats(bool& parentHasFloats) const;
475
476     // Called to lay out the legend for a fieldset or the ruby text of a ruby run. Also used by multi-column layout to handle
477     // the flow thread child.
478     virtual RenderObject* layoutSpecialExcludedChild(bool /*relayoutChildren*/);
479
480     void checkForPaginationLogicalHeightChange(bool& relayoutChildren, LayoutUnit& pageLogicalHeight, bool& pageLogicalHeightChanged);
481     
482     void paintInlineChildren(PaintInfo&, const LayoutPoint&) override;
483     void paintFloats(PaintInfo&, const LayoutPoint&, bool preservePhase = false) override;
484
485     void moveAllChildrenIncludingFloatsTo(RenderBlock& toBlock, bool fullRemoveInsert) override;
486     void repaintOverhangingFloats(bool paintAllDescendants) final;
487     void clipOutFloatingObjects(RenderBlock&, const PaintInfo*, const LayoutPoint&, const LayoutSize&) override;
488
489     FloatingObject* insertFloatingObject(RenderBox&);
490     void removeFloatingObject(RenderBox&);
491     void removeFloatingObjectsBelow(FloatingObject*, int logicalOffset);
492     LayoutPoint computeLogicalLocationForFloat(const FloatingObject&, LayoutUnit logicalTopOffset);
493
494     // Called from lineWidth, to position the floats added in the last line.
495     // Returns true if and only if it has positioned any floats.
496     bool positionNewFloats();
497
498     void clearFloats(EClear);
499
500     LayoutUnit logicalRightFloatOffsetForLine(LayoutUnit logicalTop, LayoutUnit fixedOffset, LayoutUnit logicalHeight) const override;
501     LayoutUnit logicalLeftFloatOffsetForLine(LayoutUnit logicalTop, LayoutUnit fixedOffset, LayoutUnit logicalHeight) const override;
502
503     LayoutUnit logicalRightOffsetForPositioningFloat(LayoutUnit logicalTop, LayoutUnit fixedOffset, bool applyTextIndent, LayoutUnit* heightRemaining) const;
504     LayoutUnit logicalLeftOffsetForPositioningFloat(LayoutUnit logicalTop, LayoutUnit fixedOffset, bool applyTextIndent, LayoutUnit* heightRemaining) const;
505
506     LayoutUnit lowestInitialLetterLogicalBottom() const;
507     
508     LayoutUnit lowestFloatLogicalBottom(FloatingObject::Type = FloatingObject::FloatLeftRight) const; 
509     LayoutUnit nextFloatLogicalBottomBelow(LayoutUnit) const;
510     LayoutUnit nextFloatLogicalBottomBelowForBlock(LayoutUnit) const;
511     
512     LayoutUnit addOverhangingFloats(RenderBlockFlow& child, bool makeChildPaintOtherFloats);
513     bool hasOverhangingFloat(RenderBox&);
514     void addIntrudingFloats(RenderBlockFlow* prev, RenderBlockFlow* container, LayoutUnit xoffset, LayoutUnit yoffset);
515     bool hasOverhangingFloats() { return parent() && containsFloats() && lowestFloatLogicalBottom() > logicalHeight(); }
516     LayoutUnit getClearDelta(RenderBox& child, LayoutUnit yPos);
517
518     void determineLogicalLeftPositionForChild(RenderBox& child, ApplyLayoutDeltaMode = DoNotApplyLayoutDelta);
519     
520     bool hitTestFloats(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset) override;
521     bool hitTestInlineChildren(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
522
523     void addOverflowFromFloats();
524     void addOverflowFromInlineChildren() override;
525     
526     void fitBorderToLinesIfNeeded(); // Shrink the box in which the border paints if border-fit is set.
527     void adjustForBorderFit(LayoutUnit x, LayoutUnit& left, LayoutUnit& right) const;
528
529     void markLinesDirtyInBlockRange(LayoutUnit logicalTop, LayoutUnit logicalBottom, RootInlineBox* highest = 0);
530
531     GapRects inlineSelectionGaps(RenderBlock& rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
532         LayoutUnit& lastLogicalTop, LayoutUnit& lastLogicalLeft, LayoutUnit& lastLogicalRight, const LogicalSelectionOffsetCaches&, const PaintInfo*) override;
533     
534     Position positionForBox(InlineBox*, bool start = true) const;
535     VisiblePosition positionForPointWithInlineChildren(const LayoutPoint& pointInLogicalContents, const RenderRegion*) override;
536     void addFocusRingRectsForInlineChildren(Vector<LayoutRect>& rects, const LayoutPoint& additionalOffset, const RenderLayerModelObject*) override;
537
538 // FIXME-BLOCKFLOW: These methods have implementations in
539 // RenderBlockLineLayout. They should be moved to the proper header once the
540 // line layout code is separated from RenderBlock and RenderBlockFlow.
541 // START METHODS DEFINED IN RenderBlockLineLayout
542 public:
543     static void appendRunsForObject(BidiRunList<BidiRun>*, int start, int end, RenderObject&, InlineBidiResolver&);
544     RootInlineBox* createAndAppendRootInlineBox();
545
546     LayoutUnit startAlignedOffsetForLine(LayoutUnit position, IndentTextOrNot shouldIndentText);
547     virtual ETextAlign textAlignmentForLine(bool endsWithSoftBreak) const;
548     virtual void adjustInlineDirectionLineBounds(int /* expansionOpportunityCount */, float& /* logicalLeft */, float& /* logicalWidth */) const { }
549
550 private:        
551     void adjustIntrinsicLogicalWidthsForColumns(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const;
552
553     void layoutLineBoxes(bool relayoutChildren, LayoutUnit& repaintLogicalTop, LayoutUnit& repaintLogicalBottom);
554     void layoutSimpleLines(bool relayoutChildren, LayoutUnit& repaintLogicalTop, LayoutUnit& repaintLogicalBottom);
555
556     virtual std::unique_ptr<RootInlineBox> createRootInlineBox(); // Subclassed by RenderSVGText.
557     InlineFlowBox* createLineBoxes(RenderObject*, const LineInfo&, InlineBox* childBox);
558     RootInlineBox* constructLine(BidiRunList<BidiRun>&, const LineInfo&);
559     void setMarginsForRubyRun(BidiRun*, RenderRubyRun&, RenderObject*, const LineInfo&);
560     void computeInlineDirectionPositionsForLine(RootInlineBox*, const LineInfo&, BidiRun* firstRun, BidiRun* trailingSpaceRun, bool reachedEnd, GlyphOverflowAndFallbackFontsMap&, VerticalPositionCache&, WordMeasurements&);
561     void updateRubyForJustifiedText(RenderRubyRun&, BidiRun&, const Vector<unsigned, 16>& expansionOpportunities, unsigned& expansionOpportunityCount, float& totalLogicalWidth, float availableLogicalWidth, size_t& expansionIndex);
562     void computeExpansionForJustifiedText(BidiRun* firstRun, BidiRun* trailingSpaceRun, const Vector<unsigned, 16>& expansionOpportunities, unsigned expansionOpportunityCount, float totalLogicalWidth, float availableLogicalWidth);
563     BidiRun* computeInlineDirectionPositionsForSegment(RootInlineBox*, const LineInfo&, ETextAlign, float& logicalLeft,
564         float& availableLogicalWidth, BidiRun* firstRun, BidiRun* trailingSpaceRun, GlyphOverflowAndFallbackFontsMap& textBoxDataMap, VerticalPositionCache&, WordMeasurements&);
565     void computeBlockDirectionPositionsForLine(RootInlineBox*, BidiRun*, GlyphOverflowAndFallbackFontsMap&, VerticalPositionCache&);
566     BidiRun* handleTrailingSpaces(BidiRunList<BidiRun>&, BidiContext*);
567     void appendFloatingObjectToLastLine(FloatingObject&);
568     // Helper function for layoutInlineChildren()
569     RootInlineBox* createLineBoxesFromBidiRuns(unsigned bidiLevel, BidiRunList<BidiRun>&, const InlineIterator& end, LineInfo&, VerticalPositionCache&, BidiRun* trailingSpaceRun, WordMeasurements&);
570     void layoutRunsAndFloats(LineLayoutState&, bool hasInlineChild);
571     const InlineIterator& restartLayoutRunsAndFloatsInRange(LayoutUnit oldLogicalHeight, LayoutUnit newLogicalHeight,  FloatingObject* lastFloatFromPreviousLine, InlineBidiResolver&,  const InlineIterator&);
572     void layoutRunsAndFloatsInRange(LineLayoutState&, InlineBidiResolver&, const InlineIterator& cleanLineStart, const BidiStatus& cleanLineBidiStatus, unsigned consecutiveHyphenatedLines);
573     void reattachCleanLineFloats(RootInlineBox& cleanLine, LayoutUnit delta, bool isFirstCleanLine);
574     void linkToEndLineIfNeeded(LineLayoutState&);
575     void checkFloatInCleanLine(RootInlineBox& cleanLine, RenderBox& floatBoxOnCleanLine, FloatWithRect& matchingFloatWithRect,
576         bool& encounteredNewFloat, bool& dirtiedByFloat);
577     RootInlineBox* determineStartPosition(LineLayoutState&, InlineBidiResolver&);
578     void determineEndPosition(LineLayoutState&, RootInlineBox* startBox, InlineIterator& cleanLineStart, BidiStatus& cleanLineBidiStatus);
579     bool checkPaginationAndFloatsAtEndLine(LineLayoutState&);
580     bool matchedEndLine(LineLayoutState&, const InlineBidiResolver&, const InlineIterator& endLineStart, const BidiStatus& endLineStatus);
581     void deleteEllipsisLineBoxes();
582     void checkLinesForTextOverflow();
583     // Positions new floats and also adjust all floats encountered on the line if any of them
584     // have to move to the next page/column.
585     bool positionNewFloatOnLine(const FloatingObject& newFloat, FloatingObject* lastFloatFromPreviousLine, LineInfo&, LineWidth&);
586     // This function is called to test a line box that has moved in the block direction to see if it has ended up in a new
587     // region/page/column that has a different available line width than the old one. Used to know when you have to dirty a
588     // line, i.e., that it can't be re-used.
589     bool lineWidthForPaginatedLineChanged(RootInlineBox*, LayoutUnit lineDelta, RenderFlowThread*) const;
590     void updateLogicalWidthForAlignment(const ETextAlign&, const RootInlineBox*, BidiRun* trailingSpaceRun, float& logicalLeft, float& totalLogicalWidth, float& availableLogicalWidth, int expansionOpportunityCount);
591     void marginCollapseLinesFromStart(LineLayoutState&, RootInlineBox* stopLine);
592 // END METHODS DEFINED IN RenderBlockLineLayout
593
594     bool namedFlowFragmentNeedsUpdate() const;
595     bool canHaveChildren() const override;
596
597     void computeInlinePreferredLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const;
598
599 #if ENABLE(TEXT_AUTOSIZING)
600     int m_widthForTextAutosizing;
601     unsigned m_lineCountForTextAutosizing : 2;
602 #endif
603     void setSelectionState(SelectionState) final;
604
605     void removeInlineBox(BidiRun&, const RootInlineBox&) const;
606
607 public:
608     // FIXME-BLOCKFLOW: These can be made protected again once all callers have been moved here.
609     void adjustLinePositionForPagination(RootInlineBox*, LayoutUnit& deltaOffset, bool& overflowsRegion, RenderFlowThread*); // Computes a deltaOffset value that put a line at the top of the next page if it doesn't fit on the current page.
610     void updateRegionForLine(RootInlineBox*) const;
611     void createRenderNamedFlowFragmentIfNeeded();
612
613     // Pagination routines.
614     bool relayoutForPagination(LayoutStateMaintainer&);
615
616     bool hasRareBlockFlowData() const { return m_rareBlockFlowData.get(); }
617     RenderBlockFlowRareData* rareBlockFlowData() const { ASSERT_WITH_SECURITY_IMPLICATION(hasRareBlockFlowData()); return m_rareBlockFlowData.get(); }
618     RenderBlockFlowRareData& ensureRareBlockFlowData();
619     void materializeRareBlockFlowData();
620
621 #if ENABLE(TEXT_AUTOSIZING)
622     int lineCountForTextAutosizing();
623     void adjustComputedFontSizes(float size, float visibleWidth);
624     void resetComputedFontSize()
625     {
626         m_widthForTextAutosizing = -1;
627         m_lineCountForTextAutosizing = NOT_SET;
628     }
629 #endif
630
631 protected:
632     std::unique_ptr<FloatingObjects> m_floatingObjects;
633     std::unique_ptr<RenderBlockFlowRareData> m_rareBlockFlowData;
634     RenderLineBoxList m_lineBoxes;
635     std::unique_ptr<SimpleLineLayout::Layout> m_simpleLineLayout;
636
637     friend class LineBreaker;
638     friend class LineWidth; // Needs to know FloatingObject
639 };
640
641 inline bool RenderElement::isRenderNamedFlowFragmentContainer() const
642 {
643     return is<RenderBlockFlow>(*this) && downcast<RenderBlockFlow>(*this).renderNamedFlowFragment();
644 }
645
646 inline const SimpleLineLayout::Layout* RenderBlockFlow::simpleLineLayout() const
647 {
648     ASSERT(lineLayoutPath() == SimpleLinesPath || !m_simpleLineLayout);
649     return m_simpleLineLayout.get();
650 }
651
652 } // namespace WebCore
653
654 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderBlockFlow, isRenderBlockFlow())