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