Replace WTF::move with WTFMove
[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 #ifndef RenderBlockFlow_h
24 #define RenderBlockFlow_h
25
26 #include "FloatingObjects.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 LayoutStateMaintainer;
36 class LineBreaker;
37 class LineInfo;
38 class LineWidth;
39 class RenderMultiColumnFlowThread;
40 class RenderNamedFlowFragment;
41 class RenderRubyRun;
42
43 struct FloatWithRect;
44 struct WordMeasurement;
45
46 template <class Run> class BidiRunList;
47 typedef Vector<WordMeasurement, 64> WordMeasurements;
48
49 #if ENABLE(IOS_TEXT_AUTOSIZING)
50 enum LineCount {
51     NOT_SET = 0, NO_LINE = 1, ONE_LINE = 2, MULTI_LINE = 3
52 };
53 #endif
54
55 class RenderBlockFlow : public RenderBlock {
56 public:
57     RenderBlockFlow(Element&, Ref<RenderStyle>&&);
58     RenderBlockFlow(Document&, Ref<RenderStyle>&&);
59     virtual ~RenderBlockFlow();
60         
61     virtual void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0) override;
62
63 protected:
64     virtual void insertedIntoTree() override;
65     virtual void willBeDestroyed() override;
66     
67     // This method is called at the start of layout to wipe away all of the floats in our floating objects list. It also
68     // repopulates the list with any floats that intrude from previous siblings or parents. Floats that were added by
69     // descendants are gone when this call completes and will get added back later on after the children have gotten
70     // a relayout.
71     void rebuildFloatingObjectSetFromIntrudingFloats();
72
73     // RenderBlockFlow always contains either lines or paragraphs. When the children are all blocks (e.g. paragraphs), we call layoutBlockChildren.
74     // When the children are are all inline (e.g., lines), we call layoutInlineChildren.
75     void layoutBlockChildren(bool relayoutChildren, LayoutUnit& maxFloatLogicalBottom);
76     void layoutInlineChildren(bool relayoutChildren, LayoutUnit& repaintLogicalTop, LayoutUnit& repaintLogicalBottom);
77
78     // RenderBlockFlows override these methods, since they are the only class that supports margin collapsing.
79     virtual LayoutUnit collapsedMarginBefore() const override final { return maxPositiveMarginBefore() - maxNegativeMarginBefore(); }
80     virtual LayoutUnit collapsedMarginAfter() const override final { return maxPositiveMarginAfter() - maxNegativeMarginAfter(); }
81
82     virtual void dirtyLinesFromChangedChild(RenderObject& child) override final { lineBoxes().dirtyLinesFromChangedChild(*this, child); }
83     virtual void updateLogicalHeight() override;
84
85     virtual void paintColumnRules(PaintInfo&, const LayoutPoint&) override;
86
87 public:
88     class MarginValues {
89     public:
90         MarginValues(LayoutUnit beforePos, LayoutUnit beforeNeg, LayoutUnit afterPos, LayoutUnit afterNeg)
91             : m_positiveMarginBefore(beforePos)
92             , m_negativeMarginBefore(beforeNeg)
93             , m_positiveMarginAfter(afterPos)
94             , m_negativeMarginAfter(afterNeg)
95         {
96         }
97         
98         LayoutUnit positiveMarginBefore() const { return m_positiveMarginBefore; }
99         LayoutUnit negativeMarginBefore() const { return m_negativeMarginBefore; }
100         LayoutUnit positiveMarginAfter() const { return m_positiveMarginAfter; }
101         LayoutUnit negativeMarginAfter() const { return m_negativeMarginAfter; }
102         
103         void setPositiveMarginBefore(LayoutUnit pos) { m_positiveMarginBefore = pos; }
104         void setNegativeMarginBefore(LayoutUnit neg) { m_negativeMarginBefore = neg; }
105         void setPositiveMarginAfter(LayoutUnit pos) { m_positiveMarginAfter = pos; }
106         void setNegativeMarginAfter(LayoutUnit neg) { m_negativeMarginAfter = neg; }
107     
108     private:
109         LayoutUnit m_positiveMarginBefore;
110         LayoutUnit m_negativeMarginBefore;
111         LayoutUnit m_positiveMarginAfter;
112         LayoutUnit m_negativeMarginAfter;
113     };
114     MarginValues marginValuesForChild(RenderBox& child) const;
115
116     // Allocated only when some of these fields have non-default values
117     struct RenderBlockFlowRareData {
118         WTF_MAKE_NONCOPYABLE(RenderBlockFlowRareData); WTF_MAKE_FAST_ALLOCATED;
119     public:
120         RenderBlockFlowRareData(const RenderBlockFlow& block)
121             : m_margins(positiveMarginBeforeDefault(block), negativeMarginBeforeDefault(block), positiveMarginAfterDefault(block), negativeMarginAfterDefault(block))
122             , m_lineBreakToAvoidWidow(-1)
123             , m_renderNamedFlowFragment(nullptr)
124             , m_multiColumnFlowThread(nullptr)
125             , m_discardMarginBefore(false)
126             , m_discardMarginAfter(false)
127             , m_didBreakAtLineToAvoidWidow(false)
128         { 
129         }
130
131         ~RenderBlockFlowRareData()
132         {
133         }
134
135         static LayoutUnit positiveMarginBeforeDefault(const RenderBlock& block)
136         { 
137             return std::max<LayoutUnit>(block.marginBefore(), 0);
138         }
139         static LayoutUnit negativeMarginBeforeDefault(const RenderBlock& block)
140         { 
141             return std::max<LayoutUnit>(-block.marginBefore(), 0);
142         }
143         static LayoutUnit positiveMarginAfterDefault(const RenderBlock& block)
144         {
145             return std::max<LayoutUnit>(block.marginAfter(), 0);
146         }
147         static LayoutUnit negativeMarginAfterDefault(const RenderBlock& block)
148         {
149             return std::max<LayoutUnit>(-block.marginAfter(), 0);
150         }
151         
152         MarginValues m_margins;
153         int m_lineBreakToAvoidWidow;
154         std::unique_ptr<RootInlineBox> m_lineGridBox;
155         RenderNamedFlowFragment* m_renderNamedFlowFragment;
156
157         RenderMultiColumnFlowThread* m_multiColumnFlowThread;
158         
159         bool m_discardMarginBefore : 1;
160         bool m_discardMarginAfter : 1;
161         bool m_didBreakAtLineToAvoidWidow : 1;
162     };
163
164     class MarginInfo {
165         // Collapsing flags for whether we can collapse our margins with our children's margins.
166         bool m_canCollapseWithChildren : 1;
167         bool m_canCollapseMarginBeforeWithChildren : 1;
168         bool m_canCollapseMarginAfterWithChildren : 1;
169
170         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
171         // margins in our container. Table cells and the body are the common examples. We
172         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
173         bool m_quirkContainer : 1;
174
175         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.  
176         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
177         // always be collapsing with one another. This variable can remain set to true through multiple iterations 
178         // as long as we keep encountering self-collapsing blocks.
179         bool m_atBeforeSideOfBlock : 1;
180
181         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
182         bool m_atAfterSideOfBlock : 1;
183
184         // These variables are used to detect quirky margins that we need to collapse away (in table cells
185         // and in the body element).
186         bool m_hasMarginBeforeQuirk : 1;
187         bool m_hasMarginAfterQuirk : 1;
188         bool m_determinedMarginBeforeQuirk : 1;
189
190         bool m_discardMargin : 1;
191
192         // These flags track the previous maximal positive and negative margins.
193         LayoutUnit m_positiveMargin;
194         LayoutUnit m_negativeMargin;
195
196     public:
197         MarginInfo(const RenderBlockFlow&, LayoutUnit beforeBorderPadding, LayoutUnit afterBorderPadding);
198
199         void setAtBeforeSideOfBlock(bool b) { m_atBeforeSideOfBlock = b; }
200         void setAtAfterSideOfBlock(bool b) { m_atAfterSideOfBlock = b; }
201         void clearMargin()
202         {
203             m_positiveMargin = 0;
204             m_negativeMargin = 0;
205         }
206         void setHasMarginBeforeQuirk(bool b) { m_hasMarginBeforeQuirk = b; }
207         void setHasMarginAfterQuirk(bool b) { m_hasMarginAfterQuirk = b; }
208         void setDeterminedMarginBeforeQuirk(bool b) { m_determinedMarginBeforeQuirk = b; }
209         void setPositiveMargin(LayoutUnit p) { ASSERT(!m_discardMargin); m_positiveMargin = p; }
210         void setNegativeMargin(LayoutUnit n) { ASSERT(!m_discardMargin); m_negativeMargin = n; }
211         void setPositiveMarginIfLarger(LayoutUnit p)
212         {
213             ASSERT(!m_discardMargin);
214             if (p > m_positiveMargin)
215                 m_positiveMargin = p;
216         }
217         void setNegativeMarginIfLarger(LayoutUnit n)
218         {
219             ASSERT(!m_discardMargin);
220             if (n > m_negativeMargin)
221                 m_negativeMargin = n;
222         }
223
224         void setMargin(LayoutUnit p, LayoutUnit n) { ASSERT(!m_discardMargin); m_positiveMargin = p; m_negativeMargin = n; }
225         void setCanCollapseMarginAfterWithChildren(bool collapse) { m_canCollapseMarginAfterWithChildren = collapse; }
226         void setDiscardMargin(bool value) { m_discardMargin = value; }
227
228         bool atBeforeSideOfBlock() const { return m_atBeforeSideOfBlock; }
229         bool canCollapseWithMarginBefore() const { return m_atBeforeSideOfBlock && m_canCollapseMarginBeforeWithChildren; }
230         bool canCollapseWithMarginAfter() const { return m_atAfterSideOfBlock && m_canCollapseMarginAfterWithChildren; }
231         bool canCollapseMarginBeforeWithChildren() const { return m_canCollapseMarginBeforeWithChildren; }
232         bool canCollapseMarginAfterWithChildren() const { return m_canCollapseMarginAfterWithChildren; }
233         bool quirkContainer() const { return m_quirkContainer; }
234         bool determinedMarginBeforeQuirk() const { return m_determinedMarginBeforeQuirk; }
235         bool hasMarginBeforeQuirk() const { return m_hasMarginBeforeQuirk; }
236         bool hasMarginAfterQuirk() const { return m_hasMarginAfterQuirk; }
237         LayoutUnit positiveMargin() const { return m_positiveMargin; }
238         LayoutUnit negativeMargin() const { return m_negativeMargin; }
239         bool discardMargin() const { return m_discardMargin; }
240         LayoutUnit margin() const { return m_positiveMargin - m_negativeMargin; }
241     };
242     LayoutUnit marginOffsetForSelfCollapsingBlock();
243
244     void layoutBlockChild(RenderBox& child, MarginInfo&, LayoutUnit& previousFloatLogicalBottom, LayoutUnit& maxFloatLogicalBottom);
245     void adjustPositionedBlock(RenderBox& child, const MarginInfo&);
246     void adjustFloatingBlock(const MarginInfo&);
247
248     void setStaticInlinePositionForChild(RenderBox& child, LayoutUnit blockOffset, LayoutUnit inlinePosition);
249     void updateStaticInlinePositionForChild(RenderBox& child, LayoutUnit logicalTop);
250
251     LayoutUnit collapseMargins(RenderBox& child, MarginInfo&);
252     LayoutUnit collapseMarginsWithChildInfo(RenderBox* child, RenderObject* prevSibling, MarginInfo&);
253
254     LayoutUnit clearFloatsIfNeeded(RenderBox& child, MarginInfo&, LayoutUnit oldTopPosMargin, LayoutUnit oldTopNegMargin, LayoutUnit yPos);
255     LayoutUnit estimateLogicalTopPosition(RenderBox& child, const MarginInfo&, LayoutUnit& estimateWithoutPagination);
256     void marginBeforeEstimateForChild(RenderBox&, LayoutUnit&, LayoutUnit&, bool&) const;
257     void handleAfterSideOfBlock(LayoutUnit top, LayoutUnit bottom, MarginInfo&);
258     void setCollapsedBottomMargin(const MarginInfo&);
259
260     virtual bool childrenPreventSelfCollapsing() const override final;
261
262     bool shouldBreakAtLineToAvoidWidow() const { return hasRareBlockFlowData() && rareBlockFlowData()->m_lineBreakToAvoidWidow >= 0; }
263     void clearShouldBreakAtLineToAvoidWidow() const;
264     int lineBreakToAvoidWidow() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_lineBreakToAvoidWidow : -1; }
265     void setBreakAtLineToAvoidWidow(int);
266     void clearDidBreakAtLineToAvoidWidow();
267     void setDidBreakAtLineToAvoidWidow();
268     bool didBreakAtLineToAvoidWidow() const { return hasRareBlockFlowData() && rareBlockFlowData()->m_didBreakAtLineToAvoidWidow; }
269     bool relayoutToAvoidWidows(LayoutStateMaintainer&);
270
271     virtual bool canHaveGeneratedChildren() const override;
272
273     RootInlineBox* lineGridBox() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_lineGridBox.get() : nullptr; }
274     void setLineGridBox(std::unique_ptr<RootInlineBox> box)
275     {
276         ensureRareBlockFlowData().m_lineGridBox = WTFMove(box);
277     }
278     void layoutLineGridBox();
279
280     virtual bool canDropAnonymousBlockChild() const override { return !renderNamedFlowFragment(); }
281     RenderNamedFlowFragment* renderNamedFlowFragment() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_renderNamedFlowFragment : nullptr; }
282     void setRenderNamedFlowFragment(RenderNamedFlowFragment*);
283
284     RenderMultiColumnFlowThread* multiColumnFlowThread() const { return hasRareBlockFlowData() ? rareBlockFlowData()->m_multiColumnFlowThread : nullptr; }
285     void setMultiColumnFlowThread(RenderMultiColumnFlowThread*);
286     
287     virtual bool containsFloats() const override { return m_floatingObjects && !m_floatingObjects->set().isEmpty(); }
288     bool containsFloat(RenderBox&) const;
289
290     virtual void deleteLines() override;
291     virtual void computeOverflow(LayoutUnit oldClientAfterEdge, bool recomputeFloats = false) override;
292     virtual VisiblePosition positionForPoint(const LayoutPoint&, const RenderRegion*) override;
293
294     void removeFloatingObjects();
295     void markAllDescendantsWithFloatsForLayout(RenderBox* floatToRemove = nullptr, bool inLayout = true);
296     void markSiblingsWithFloatsForLayout(RenderBox* floatToRemove = nullptr);
297
298     const FloatingObjectSet* floatingObjectSet() const { return m_floatingObjects ? &m_floatingObjects->set() : nullptr; }
299
300     LayoutUnit logicalTopForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.y() : floatingObject.x(); }
301     LayoutUnit logicalBottomForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.maxY() : floatingObject.maxX(); }
302     LayoutUnit logicalLeftForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.x() : floatingObject.y(); }
303     LayoutUnit logicalRightForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.maxX() : floatingObject.maxY(); }
304     LayoutUnit logicalWidthForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.width() : floatingObject.height(); }
305     LayoutUnit logicalHeightForFloat(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.height() : floatingObject.width(); }
306
307     void setLogicalTopForFloat(FloatingObject& floatingObject, LayoutUnit logicalTop)
308     {
309         if (isHorizontalWritingMode())
310             floatingObject.setY(logicalTop);
311         else
312             floatingObject.setX(logicalTop);
313     }
314     void setLogicalLeftForFloat(FloatingObject& floatingObject, LayoutUnit logicalLeft)
315     {
316         if (isHorizontalWritingMode())
317             floatingObject.setX(logicalLeft);
318         else
319             floatingObject.setY(logicalLeft);
320     }
321     void setLogicalHeightForFloat(FloatingObject& floatingObject, LayoutUnit logicalHeight)
322     {
323         if (isHorizontalWritingMode())
324             floatingObject.setHeight(logicalHeight);
325         else
326             floatingObject.setWidth(logicalHeight);
327     }
328     void setLogicalWidthForFloat(FloatingObject& floatingObject, LayoutUnit logicalWidth)
329     {
330         if (isHorizontalWritingMode())
331             floatingObject.setWidth(logicalWidth);
332         else
333             floatingObject.setHeight(logicalWidth);
334     }
335
336     LayoutUnit xPositionForFloatIncludingMargin(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.x() + floatingObject.renderer().marginLeft() : floatingObject.x() + marginBeforeForChild(floatingObject.renderer()); }
337     LayoutUnit yPositionForFloatIncludingMargin(const FloatingObject& floatingObject) const { return isHorizontalWritingMode() ? floatingObject.y() + marginBeforeForChild(floatingObject.renderer()) : floatingObject.y() + floatingObject.renderer().marginTop(); }
338
339     LayoutPoint flipFloatForWritingModeForChild(const FloatingObject&, const LayoutPoint&) const;
340
341     RenderLineBoxList& lineBoxes() { return m_lineBoxes; }
342     const RenderLineBoxList& lineBoxes() const { return m_lineBoxes; }
343
344     RootInlineBox* firstRootBox() const { return downcast<RootInlineBox>(m_lineBoxes.firstLineBox()); }
345     RootInlineBox* lastRootBox() const { return downcast<RootInlineBox>(m_lineBoxes.lastLineBox()); }
346
347     virtual bool hasLines() const override final;
348     virtual void invalidateLineLayoutPath() override final;
349
350     enum LineLayoutPath { UndeterminedPath = 0, SimpleLinesPath, LineBoxesPath, ForceLineBoxesPath };
351     LineLayoutPath lineLayoutPath() const { return static_cast<LineLayoutPath>(renderBlockFlowLineLayoutPath()); }
352     void setLineLayoutPath(LineLayoutPath path) { setRenderBlockFlowLineLayoutPath(path); }
353
354     // Helper methods for computing line counts and heights for line counts.
355     RootInlineBox* lineAtIndex(int) const;
356     int lineCount(const RootInlineBox* = nullptr, bool* = nullptr) const;
357     int heightForLineCount(int);
358     void clearTruncation();
359
360     void setHasMarkupTruncation(bool b) { setRenderBlockFlowHasMarkupTruncation(b); }
361     bool hasMarkupTruncation() const { return renderBlockFlowHasMarkupTruncation(); }
362
363     bool containsNonZeroBidiLevel() const;
364
365     const SimpleLineLayout::Layout* simpleLineLayout() const;
366     void deleteLineBoxesBeforeSimpleLineLayout();
367     void ensureLineBoxes();
368
369 #if ENABLE(TREE_DEBUGGING)
370     void showLineTreeAndMark(const InlineBox* markedBox, int depth) const;
371 #endif
372
373     // Returns the logicalOffset at the top of the next page. If the offset passed in is already at the top of the current page,
374     // then nextPageLogicalTop with ExcludePageBoundary will still move to the top of the next page. nextPageLogicalTop with
375     // IncludePageBoundary set will not.
376     //
377     // 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.
378     enum PageBoundaryRule { ExcludePageBoundary, IncludePageBoundary };
379     LayoutUnit nextPageLogicalTop(LayoutUnit logicalOffset, PageBoundaryRule = ExcludePageBoundary) const;
380     LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const;
381     LayoutUnit pageLogicalHeightForOffset(LayoutUnit offset) const;
382     LayoutUnit pageRemainingLogicalHeightForOffset(LayoutUnit offset, PageBoundaryRule = IncludePageBoundary) const;
383     LayoutUnit logicalHeightForChildForFragmentation(const RenderBox& child) const;
384     bool hasNextPage(LayoutUnit logicalOffset, PageBoundaryRule = ExcludePageBoundary) const;
385
386     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0) override;
387     virtual void removeChild(RenderObject&) override;
388
389     void createMultiColumnFlowThread();
390     void destroyMultiColumnFlowThread();
391
392     void updateColumnProgressionFromStyle(RenderStyle&);
393     void updateStylesForColumnChildren();
394
395     virtual bool needsLayoutAfterRegionRangeChange() const override;
396
397 protected:
398     virtual 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     virtual void styleWillChange(StyleDifference, const RenderStyle& newStyle) override;
446     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle) override;
447
448     void createFloatingObjects();
449
450     virtual Optional<int> firstLineBaseline() const override;
451     virtual Optional<int> inlineBlockBaseline(LineDirectionMode) const override;
452
453     virtual bool isMultiColumnBlockFlow() const override { return multiColumnFlowThread(); }
454     
455     void setComputedColumnCountAndWidth(int, LayoutUnit);
456
457     LayoutUnit computedColumnWidth() const;
458     unsigned computedColumnCount() const;
459     
460     virtual bool isTopLayoutOverflowAllowed() const override;
461     virtual 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     virtual void paintInlineChildren(PaintInfo&, const LayoutPoint&) override;
483     virtual void paintFloats(PaintInfo&, const LayoutPoint&, bool preservePhase = false) override;
484
485     virtual void moveAllChildrenIncludingFloatsTo(RenderBlock& toBlock, bool fullRemoveInsert) override;
486     virtual void repaintOverhangingFloats(bool paintAllDescendants) override final;
487     virtual 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     virtual LayoutUnit logicalRightFloatOffsetForLine(LayoutUnit logicalTop, LayoutUnit fixedOffset, LayoutUnit logicalHeight) const override;
501     virtual 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     virtual bool hitTestFloats(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset) override;
521     virtual bool hitTestInlineChildren(const HitTestRequest&, HitTestResult&, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction) override;
522
523     void addOverflowFromFloats();
524     virtual 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     virtual 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     virtual VisiblePosition positionForPointWithInlineChildren(const LayoutPoint& pointInLogicalContents, const RenderRegion*) override;
536     virtual void addFocusRingRectsForInlineChildren(Vector<IntRect>& 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, bool 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 linkToEndLineIfNeeded(LineLayoutState&);
574     static void repaintDirtyFloats(Vector<FloatWithRect>& floats);
575     void checkFloatsInCleanLine(RootInlineBox*, Vector<FloatWithRect>&, size_t& floatIndex, bool& encounteredNewFloat, bool& dirtiedByFloat);
576     RootInlineBox* determineStartPosition(LineLayoutState&, InlineBidiResolver&);
577     void determineEndPosition(LineLayoutState&, RootInlineBox* startBox, InlineIterator& cleanLineStart, BidiStatus& cleanLineBidiStatus);
578     bool checkPaginationAndFloatsAtEndLine(LineLayoutState&);
579     bool matchedEndLine(LineLayoutState&, const InlineBidiResolver&, const InlineIterator& endLineStart, const BidiStatus& endLineStatus);
580     void deleteEllipsisLineBoxes();
581     void checkLinesForTextOverflow();
582     // Positions new floats and also adjust all floats encountered on the line if any of them
583     // have to move to the next page/column.
584     bool positionNewFloatOnLine(const FloatingObject& newFloat, FloatingObject* lastFloatFromPreviousLine, LineInfo&, LineWidth&);
585     // 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
586     // region/page/column that has a different available line width than the old one. Used to know when you have to dirty a
587     // line, i.e., that it can't be re-used.
588     bool lineWidthForPaginatedLineChanged(RootInlineBox*, LayoutUnit lineDelta, RenderFlowThread*) const;
589     void updateLogicalWidthForAlignment(const ETextAlign&, const RootInlineBox*, BidiRun* trailingSpaceRun, float& logicalLeft, float& totalLogicalWidth, float& availableLogicalWidth, int expansionOpportunityCount);
590     void marginCollapseLinesFromStart(LineLayoutState&, RootInlineBox* stopLine);
591 // END METHODS DEFINED IN RenderBlockLineLayout
592
593     bool namedFlowFragmentNeedsUpdate() const;
594     virtual bool canHaveChildren() const override;
595
596     void computeInlinePreferredLogicalWidths(LayoutUnit& minLogicalWidth, LayoutUnit& maxLogicalWidth) const;
597
598 #if ENABLE(IOS_TEXT_AUTOSIZING)
599     int m_widthForTextAutosizing;
600     unsigned m_lineCountForTextAutosizing : 2;
601 #endif
602     virtual void setSelectionState(SelectionState) override final;
603
604 public:
605     // FIXME-BLOCKFLOW: These can be made protected again once all callers have been moved here.
606     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.
607     void updateRegionForLine(RootInlineBox*) const;
608     void createRenderNamedFlowFragmentIfNeeded();
609
610     // Pagination routines.
611     bool relayoutForPagination(LayoutStateMaintainer&);
612
613     bool hasRareBlockFlowData() const { return m_rareBlockFlowData.get(); }
614     RenderBlockFlowRareData* rareBlockFlowData() const { ASSERT_WITH_SECURITY_IMPLICATION(hasRareBlockFlowData()); return m_rareBlockFlowData.get(); }
615     RenderBlockFlowRareData& ensureRareBlockFlowData();
616     void materializeRareBlockFlowData();
617
618 #if ENABLE(IOS_TEXT_AUTOSIZING)
619     int lineCountForTextAutosizing();
620     void adjustComputedFontSizes(float size, float visibleWidth);
621     void resetComputedFontSize()
622     {
623         m_widthForTextAutosizing = -1;
624         m_lineCountForTextAutosizing = NOT_SET;
625     }
626 #endif
627
628 protected:
629     std::unique_ptr<FloatingObjects> m_floatingObjects;
630     std::unique_ptr<RenderBlockFlowRareData> m_rareBlockFlowData;
631     RenderLineBoxList m_lineBoxes;
632     std::unique_ptr<SimpleLineLayout::Layout> m_simpleLineLayout;
633
634     friend class LineBreaker;
635     friend class LineWidth; // Needs to know FloatingObject
636 };
637
638 inline bool RenderElement::isRenderNamedFlowFragmentContainer() const
639 {
640     return is<RenderBlockFlow>(*this) && downcast<RenderBlockFlow>(*this).renderNamedFlowFragment();
641 }
642
643 inline const SimpleLineLayout::Layout* RenderBlockFlow::simpleLineLayout() const
644 {
645     ASSERT(lineLayoutPath() == SimpleLinesPath || !m_simpleLineLayout);
646     return m_simpleLineLayout.get();
647 }
648
649 } // namespace WebCore
650
651 SPECIALIZE_TYPE_TRAITS_RENDER_OBJECT(RenderBlockFlow, isRenderBlockFlow())
652
653 #endif // RenderBlockFlow_h