1db5deed8c93b71ebb571829083bf59f9aa0dc1c
[WebKit-https.git] / Source / WebCore / rendering / RenderBlock.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, 2004, 2005, 2006, 2007, 2008, 2009, 2010 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 RenderBlock_h
24 #define RenderBlock_h
25
26 #include "GapRects.h"
27 #include "PODIntervalTree.h"
28 #include "RenderBox.h"
29 #include "RenderLineBoxList.h"
30 #include "RootInlineBox.h"
31 #include "TextRun.h"
32 #include <wtf/OwnPtr.h>
33 #include <wtf/ListHashSet.h>
34
35 namespace WebCore {
36
37 class BidiContext;
38 class ColumnInfo;
39 class InlineIterator;
40 class LayoutStateMaintainer;
41 class LazyLineBreakIterator;
42 class LineLayoutState;
43 class LineWidth;
44 class RenderInline;
45 class RenderText;
46
47 struct BidiRun;
48 struct PaintInfo;
49 class LineInfo;
50 class RenderRubyRun;
51
52 template <class Iterator, class Run> class BidiResolver;
53 template <class Run> class BidiRunList;
54 template <class Iterator> struct MidpointState;
55 typedef BidiResolver<InlineIterator, BidiRun> InlineBidiResolver;
56 typedef MidpointState<InlineIterator> LineMidpointState;
57
58 enum CaretType { CursorCaret, DragCaret };
59
60 enum TextRunFlag {
61     DefaultTextRunFlags = 0,
62     RespectDirection = 1 << 0,
63     RespectDirectionOverride = 1 << 1
64 };
65
66 typedef unsigned TextRunFlags;
67
68 class RenderBlock : public RenderBox {
69 public:
70     friend class LineLayoutState;
71 #ifndef NDEBUG
72     // Used by the PODIntervalTree for debugging the FloatingObject.
73     template <class> friend struct ValueToString;
74 #endif
75
76     RenderBlock(Node*);
77     virtual ~RenderBlock();
78
79     const RenderObjectChildList* children() const { return &m_children; }
80     RenderObjectChildList* children() { return &m_children; }
81
82     bool beingDestroyed() const { return m_beingDestroyed; }
83
84     // These two functions are overridden for inline-block.
85     virtual LayoutUnit lineHeight(bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const;
86     virtual LayoutUnit baselinePosition(FontBaseline, bool firstLine, LineDirectionMode, LinePositionMode = PositionOnContainingLine) const;
87
88     RenderLineBoxList* lineBoxes() { return &m_lineBoxes; }
89     const RenderLineBoxList* lineBoxes() const { return &m_lineBoxes; }
90
91     InlineFlowBox* firstLineBox() const { return m_lineBoxes.firstLineBox(); }
92     InlineFlowBox* lastLineBox() const { return m_lineBoxes.lastLineBox(); }
93
94     void deleteLineBoxTree();
95
96     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
97     virtual void removeChild(RenderObject*);
98
99     enum BlockLayoutPass { NormalLayoutPass, PositionedFloatLayoutPass };
100     virtual void layoutBlock(bool relayoutChildren, LayoutUnit pageLogicalHeight = 0, BlockLayoutPass = NormalLayoutPass);
101
102     void insertPositionedObject(RenderBox*);
103     void removePositionedObject(RenderBox*);
104     void removePositionedObjects(RenderBlock*);
105
106     typedef ListHashSet<RenderBox*, 4> PositionedObjectsListHashSet;
107     PositionedObjectsListHashSet* positionedObjects() const { return m_positionedObjects.get(); }
108
109     void addPercentHeightDescendant(RenderBox*);
110     static void removePercentHeightDescendant(RenderBox*);
111     HashSet<RenderBox*>* percentHeightDescendants() const;
112 #if !ASSERT_DISABLED
113     static bool hasPercentHeightDescendant(RenderBox*);
114 #endif
115
116     RootInlineBox* createAndAppendRootInlineBox();
117
118     bool generatesLineBoxesForInlineChild(RenderObject*);
119
120     void markAllDescendantsWithFloatsForLayout(RenderBox* floatToRemove = 0, bool inLayout = true);
121     void markSiblingsWithFloatsForLayout(RenderBox* floatToRemove = 0);
122     void markPositionedObjectsForLayout();
123     virtual void markForPaginationRelayoutIfNeeded();
124     
125     bool containsFloats() { return m_floatingObjects && !m_floatingObjects->set().isEmpty(); }
126     bool containsFloat(RenderBox*);
127
128     // Versions that can compute line offsets with the region and page offset passed in. Used for speed to avoid having to
129     // compute the region all over again when you already know it.
130     LayoutUnit availableLogicalWidthForLine(LayoutUnit position, bool firstLine, RenderRegion* region, LayoutUnit offsetFromLogicalTopOfFirstPage) const
131     {
132         return max<LayoutUnit>(0, logicalRightOffsetForLine(position, firstLine, region, offsetFromLogicalTopOfFirstPage)
133             - logicalLeftOffsetForLine(position, firstLine, region, offsetFromLogicalTopOfFirstPage));
134     }
135     LayoutUnit logicalRightOffsetForLine(LayoutUnit position, bool firstLine, RenderRegion* region, LayoutUnit offsetFromLogicalTopOfFirstPage) const 
136     {
137         return logicalRightOffsetForLine(position, logicalRightOffsetForContent(region, offsetFromLogicalTopOfFirstPage), firstLine);
138     }
139     LayoutUnit logicalLeftOffsetForLine(LayoutUnit position, bool firstLine, RenderRegion* region, LayoutUnit offsetFromLogicalTopOfFirstPage) const 
140     {
141         return logicalLeftOffsetForLine(position, logicalLeftOffsetForContent(region, offsetFromLogicalTopOfFirstPage), firstLine);
142     }
143     LayoutUnit startOffsetForLine(LayoutUnit position, bool firstLine, RenderRegion* region, LayoutUnit offsetFromLogicalTopOfFirstPage) const
144     {
145         return style()->isLeftToRightDirection() ? logicalLeftOffsetForLine(position, firstLine, region, offsetFromLogicalTopOfFirstPage)
146             : logicalWidth() - logicalRightOffsetForLine(position, firstLine, region, offsetFromLogicalTopOfFirstPage);
147     }
148
149     LayoutUnit availableLogicalWidthForLine(LayoutUnit position, bool firstLine) const
150     {
151         return availableLogicalWidthForLine(position, firstLine, regionAtBlockOffset(position), offsetFromLogicalTopOfFirstPage());
152     }
153     LayoutUnit logicalRightOffsetForLine(LayoutUnit position, bool firstLine) const 
154     {
155         return logicalRightOffsetForLine(position, logicalRightOffsetForContent(position), firstLine, 0);
156     }
157     LayoutUnit logicalLeftOffsetForLine(LayoutUnit position, bool firstLine) const 
158     {
159         return logicalLeftOffsetForLine(position, logicalLeftOffsetForContent(position), firstLine, 0);
160     }
161     LayoutUnit startOffsetForLine(LayoutUnit position, bool firstLine) const
162     {
163         return style()->isLeftToRightDirection() ? logicalLeftOffsetForLine(position, firstLine)
164             : logicalWidth() - logicalRightOffsetForLine(position, firstLine);
165     }
166     
167     LayoutUnit startAlignedOffsetForLine(RenderBox* child, LayoutUnit position, bool firstLine);
168     LayoutUnit textIndentOffset() const;
169
170     virtual VisiblePosition positionForPoint(const LayoutPoint&);
171     
172     // Block flows subclass availableWidth to handle multi column layout (shrinking the width available to children when laying out.)
173     virtual LayoutUnit availableLogicalWidth() const;
174
175     LayoutPoint flipForWritingModeIncludingColumns(const LayoutPoint&) const;
176     void adjustStartEdgeForWritingModeIncludingColumns(LayoutRect&) const;
177
178     RootInlineBox* firstRootBox() const { return static_cast<RootInlineBox*>(firstLineBox()); }
179     RootInlineBox* lastRootBox() const { return static_cast<RootInlineBox*>(lastLineBox()); }
180
181     bool containsNonZeroBidiLevel() const;
182
183     GapRects selectionGapRectsForRepaint(RenderBoxModelObject* repaintContainer);
184     LayoutRect logicalLeftSelectionGap(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
185                                        RenderObject* selObj, LayoutUnit logicalLeft, LayoutUnit logicalTop, LayoutUnit logicalHeight, const PaintInfo*);
186     LayoutRect logicalRightSelectionGap(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
187                                         RenderObject* selObj, LayoutUnit logicalRight, LayoutUnit logicalTop, LayoutUnit logicalHeight, const PaintInfo*);
188     void getSelectionGapInfo(SelectionState, bool& leftGap, bool& rightGap);
189     LayoutRect logicalRectToPhysicalRect(const LayoutPoint& physicalPosition, const LayoutRect& logicalRect);
190         
191     // Helper methods for computing line counts and heights for line counts.
192     RootInlineBox* lineAtIndex(int);
193     int lineCount();
194     int heightForLineCount(int);
195     void clearTruncation();
196
197     void adjustRectForColumns(LayoutRect&) const;
198     virtual void adjustForColumns(LayoutSize&, const LayoutPoint&) const;
199     void adjustForColumnRect(LayoutSize& offset, const LayoutPoint& pointInContainer) const;
200
201     void addContinuationWithOutline(RenderInline*);
202     bool paintsContinuationOutline(RenderInline*);
203
204     virtual RenderBoxModelObject* virtualContinuation() const { return continuation(); }
205     bool isAnonymousBlockContinuation() const { return continuation() && isAnonymousBlock(); }
206     RenderInline* inlineElementContinuation() const;
207     RenderBlock* blockElementContinuation() const;
208
209     using RenderBoxModelObject::continuation;
210     using RenderBoxModelObject::setContinuation;
211
212     // This function is a convenience helper for creating an anonymous block that inherits its
213     // style from this RenderBlock.
214     RenderBlock* createAnonymousBlock(bool isFlexibleBox = false) const;
215     RenderBlock* createAnonymousColumnsBlock() const;
216     RenderBlock* createAnonymousColumnSpanBlock() const;
217     RenderBlock* createAnonymousBlockWithSameTypeAs(RenderBlock* otherAnonymousBlock) const;
218     
219     static void appendRunsForObject(BidiRunList<BidiRun>&, int start, int end, RenderObject*, InlineBidiResolver&);
220
221     static TextRun constructTextRun(RenderObject* context, const Font&, const String&, RenderStyle*,
222                                     TextRun::ExpansionBehavior = TextRun::AllowTrailingExpansion | TextRun::ForbidLeadingExpansion, TextRunFlags = DefaultTextRunFlags);
223
224     static TextRun constructTextRun(RenderObject* context, const Font&, const UChar*, int length, RenderStyle*,
225                                     TextRun::ExpansionBehavior = TextRun::AllowTrailingExpansion | TextRun::ForbidLeadingExpansion, TextRunFlags = DefaultTextRunFlags);
226
227     ColumnInfo* columnInfo() const;
228     int columnGap() const;
229     
230     // These two functions take the ColumnInfo* to avoid repeated lookups of the info in the global HashMap.
231     unsigned columnCount(ColumnInfo*) const;
232     LayoutRect columnRectAt(ColumnInfo*, unsigned) const;
233
234     LayoutUnit paginationStrut() const { return m_rareData ? m_rareData->m_paginationStrut : 0; }
235     void setPaginationStrut(LayoutUnit);
236     
237     // The page logical offset is the object's offset from the top of the page in the page progression
238     // direction (so an x-offset in vertical text and a y-offset for horizontal text).
239     int pageLogicalOffset() const { return m_rareData ? m_rareData->m_pageLogicalOffset : 0; }
240     void setPageLogicalOffset(int);
241
242     RootInlineBox* lineGridBox() const { return m_rareData ? m_rareData->m_lineGridBox : 0; }
243     void setLineGridBox(RootInlineBox* box)
244     {
245         if (!m_rareData)
246             m_rareData = adoptPtr(new RenderBlockRareData(this));
247         if (m_rareData->m_lineGridBox)
248             m_rareData->m_lineGridBox->destroy(renderArena());
249         m_rareData->m_lineGridBox = box;
250     }
251     void layoutLineGridBox();
252
253     // Accessors for logical width/height and margins in the containing block's block-flow direction.
254     enum ApplyLayoutDeltaMode { ApplyLayoutDelta, DoNotApplyLayoutDelta };
255     LayoutUnit logicalWidthForChild(const RenderBox* child) { return isHorizontalWritingMode() ? child->width() : child->height(); }
256     LayoutUnit logicalHeightForChild(const RenderBox* child) { return isHorizontalWritingMode() ? child->height() : child->width(); }
257     LayoutUnit logicalTopForChild(const RenderBox* child) { return isHorizontalWritingMode() ? child->y() : child->x(); }
258     LayoutUnit logicalLeftForChild(const RenderBox* child) { return isHorizontalWritingMode() ? child->x() : child->y(); }
259     void setLogicalLeftForChild(RenderBox* child, LayoutUnit logicalLeft, ApplyLayoutDeltaMode = DoNotApplyLayoutDelta);
260     void setLogicalTopForChild(RenderBox* child, LayoutUnit logicalTop, ApplyLayoutDeltaMode = DoNotApplyLayoutDelta);
261     LayoutUnit marginBeforeForChild(const RenderBoxModelObject* child) const;
262     LayoutUnit marginAfterForChild(const RenderBoxModelObject* child) const;
263     LayoutUnit marginStartForChild(const RenderBoxModelObject* child) const;
264     LayoutUnit marginEndForChild(const RenderBoxModelObject* child) const;
265     LayoutUnit marginLogicalLeftForChild(const RenderBoxModelObject* child) const;
266     LayoutUnit marginLogicalRightForChild(const RenderBoxModelObject* child) const;
267     void setMarginStartForChild(RenderBox* child, LayoutUnit);
268     void setMarginEndForChild(RenderBox* child, LayoutUnit);
269     void setMarginBeforeForChild(RenderBox* child, LayoutUnit);
270     void setMarginAfterForChild(RenderBox* child, LayoutUnit);
271     LayoutUnit collapsedMarginBeforeForChild(const RenderBox* child) const;
272     LayoutUnit collapsedMarginAfterForChild(const RenderBox* child) const;
273
274     void updateLogicalWidthForAlignment(const ETextAlign&, BidiRun* trailingSpaceRun, float& logicalLeft, float& totalLogicalWidth, float& availableLogicalWidth, int expansionOpportunityCount);
275
276     virtual void updateFirstLetter();
277
278     class MarginValues {
279     public:
280         MarginValues(LayoutUnit beforePos, LayoutUnit beforeNeg, LayoutUnit afterPos, LayoutUnit afterNeg)
281             : m_positiveMarginBefore(beforePos)
282             , m_negativeMarginBefore(beforeNeg)
283             , m_positiveMarginAfter(afterPos)
284             , m_negativeMarginAfter(afterNeg)
285         { }
286         
287         LayoutUnit positiveMarginBefore() const { return m_positiveMarginBefore; }
288         LayoutUnit negativeMarginBefore() const { return m_negativeMarginBefore; }
289         LayoutUnit positiveMarginAfter() const { return m_positiveMarginAfter; }
290         LayoutUnit negativeMarginAfter() const { return m_negativeMarginAfter; }
291         
292         void setPositiveMarginBefore(LayoutUnit pos) { m_positiveMarginBefore = pos; }
293         void setNegativeMarginBefore(LayoutUnit neg) { m_negativeMarginBefore = neg; }
294         void setPositiveMarginAfter(LayoutUnit pos) { m_positiveMarginAfter = pos; }
295         void setNegativeMarginAfter(LayoutUnit neg) { m_negativeMarginAfter = neg; }
296     
297     private:
298         LayoutUnit m_positiveMarginBefore;
299         LayoutUnit m_negativeMarginBefore;
300         LayoutUnit m_positiveMarginAfter;
301         LayoutUnit m_negativeMarginAfter;
302     };
303     MarginValues marginValuesForChild(RenderBox* child);
304
305     virtual void scrollbarsChanged(bool /*horizontalScrollbarChanged*/, bool /*verticalScrollbarChanged*/) { };
306
307     LayoutUnit logicalLeftOffsetForContent(RenderRegion*, LayoutUnit offsetFromLogicalTopOfFirstPage) const;
308     LayoutUnit logicalRightOffsetForContent(RenderRegion*, LayoutUnit offsetFromLogicalTopOfFirstPage) const;
309     LayoutUnit availableLogicalWidthForContent(RenderRegion* region, LayoutUnit offsetFromLogicalTopOfFirstPage) const
310     { 
311         return max<LayoutUnit>(0, logicalRightOffsetForContent(region, offsetFromLogicalTopOfFirstPage) -
312             logicalLeftOffsetForContent(region, offsetFromLogicalTopOfFirstPage)); }
313     LayoutUnit startOffsetForContent(RenderRegion* region, LayoutUnit offsetFromLogicalTopOfFirstPage) const
314     {
315         return style()->isLeftToRightDirection() ? logicalLeftOffsetForContent(region, offsetFromLogicalTopOfFirstPage)
316             : logicalWidth() - logicalRightOffsetForContent(region, offsetFromLogicalTopOfFirstPage);
317     }
318     LayoutUnit logicalLeftOffsetForContent(LayoutUnit blockOffset) const
319     {
320         return logicalLeftOffsetForContent(regionAtBlockOffset(blockOffset), offsetFromLogicalTopOfFirstPage());
321     }
322     LayoutUnit logicalRightOffsetForContent(LayoutUnit blockOffset) const
323     {
324         return logicalRightOffsetForContent(regionAtBlockOffset(blockOffset), offsetFromLogicalTopOfFirstPage());
325     }
326     LayoutUnit availableLogicalWidthForContent(LayoutUnit blockOffset) const
327     {
328         return availableLogicalWidthForContent(regionAtBlockOffset(blockOffset), offsetFromLogicalTopOfFirstPage());
329     }
330     LayoutUnit startOffsetForContent(LayoutUnit blockOffset) const
331     {
332         return startOffsetForContent(regionAtBlockOffset(blockOffset), offsetFromLogicalTopOfFirstPage());
333     }
334     LayoutUnit logicalLeftOffsetForContent() const { return isHorizontalWritingMode() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
335     LayoutUnit logicalRightOffsetForContent() const { return logicalLeftOffsetForContent() + availableLogicalWidth(); }
336     LayoutUnit startOffsetForContent() const { return style()->isLeftToRightDirection() ? logicalLeftOffsetForContent() : logicalWidth() - logicalRightOffsetForContent(); }
337     
338     void setStaticInlinePositionForChild(RenderBox*, LayoutUnit blockOffset, LayoutUnit inlinePosition);
339
340     LayoutUnit computeStartPositionDeltaForChildAvoidingFloats(const RenderBox* child, LayoutUnit childMarginStart,
341         LayoutUnit childLogicalWidth, RenderRegion* = 0, LayoutUnit offsetFromLogicalTopOfFirstPage = 0);
342
343 #ifndef NDEBUG
344     void showLineTreeAndMark(const InlineBox* = 0, const char* = 0, const InlineBox* = 0, const char* = 0, const RenderObject* = 0) const;
345 #endif
346
347 protected:
348     virtual void willBeDestroyed();
349
350     // These functions are only used internally to manipulate the render tree structure via remove/insert/appendChildNode.
351     // Since they are typically called only to move objects around within anonymous blocks (which only have layers in
352     // the case of column spans), the default for fullRemoveInsert is false rather than true.
353     void moveChildTo(RenderBlock* to, RenderObject* child, bool fullRemoveInsert = false)
354     {
355         return moveChildTo(to, child, 0, fullRemoveInsert);
356     }
357     void moveChildTo(RenderBlock* to, RenderObject* child, RenderObject* beforeChild, bool fullRemoveInsert = false);
358     void moveAllChildrenTo(RenderBlock* to, bool fullRemoveInsert = false)
359     {
360         return moveAllChildrenTo(to, 0, fullRemoveInsert);
361     }
362     void moveAllChildrenTo(RenderBlock* to, RenderObject* beforeChild, bool fullRemoveInsert = false)
363     {
364         return moveChildrenTo(to, firstChild(), 0, beforeChild, fullRemoveInsert);
365     }
366     // Move all of the kids from |startChild| up to but excluding |endChild|.  0 can be passed as the endChild to denote
367     // that all the kids from |startChild| onwards should be added.
368     void moveChildrenTo(RenderBlock* to, RenderObject* startChild, RenderObject* endChild, bool fullRemoveInsert = false)
369     {
370         return moveChildrenTo(to, startChild, endChild, 0, fullRemoveInsert);
371     }
372     void moveChildrenTo(RenderBlock* to, RenderObject* startChild, RenderObject* endChild, RenderObject* beforeChild, bool fullRemoveInsert = false);
373     
374     LayoutUnit maxPositiveMarginBefore() const { return m_rareData ? m_rareData->m_margins.positiveMarginBefore() : RenderBlockRareData::positiveMarginBeforeDefault(this); }
375     LayoutUnit maxNegativeMarginBefore() const { return m_rareData ? m_rareData->m_margins.negativeMarginBefore() : RenderBlockRareData::negativeMarginBeforeDefault(this); }
376     LayoutUnit maxPositiveMarginAfter() const { return m_rareData ? m_rareData->m_margins.positiveMarginAfter() : RenderBlockRareData::positiveMarginAfterDefault(this); }
377     LayoutUnit maxNegativeMarginAfter() const { return m_rareData ? m_rareData->m_margins.negativeMarginAfter() : RenderBlockRareData::negativeMarginAfterDefault(this); }
378     
379     void setMaxMarginBeforeValues(LayoutUnit pos, LayoutUnit neg);
380     void setMaxMarginAfterValues(LayoutUnit pos, LayoutUnit neg);
381
382     void initMaxMarginValues()
383     {
384         if (m_rareData) {
385             m_rareData->m_margins = MarginValues(RenderBlockRareData::positiveMarginBeforeDefault(this) , RenderBlockRareData::negativeMarginBeforeDefault(this),
386                                                  RenderBlockRareData::positiveMarginAfterDefault(this), RenderBlockRareData::negativeMarginAfterDefault(this));
387             m_rareData->m_paginationStrut = 0;
388         }
389     }
390
391     virtual void layout();
392
393     bool layoutPositionedObjects(bool relayoutChildren);
394
395     virtual void paint(PaintInfo&, const LayoutPoint&);
396     virtual void paintObject(PaintInfo&, const LayoutPoint&);
397    
398     LayoutUnit logicalRightOffsetForLine(LayoutUnit position, LayoutUnit fixedOffset, bool applyTextIndent, LayoutUnit* logicalHeightRemaining = 0) const;
399     LayoutUnit logicalLeftOffsetForLine(LayoutUnit position, LayoutUnit fixedOffset, bool applyTextIndent, LayoutUnit* logicalHeightRemaining = 0) const;
400
401     virtual ETextAlign textAlignmentForLine(bool endsWithSoftBreak) const;
402     virtual void adjustInlineDirectionLineBounds(int /* expansionOpportunityCount */, float& /* logicalLeft */, float& /* logicalWidth */) const { }
403
404     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
405
406     virtual void computePreferredLogicalWidths();
407
408     virtual LayoutUnit firstLineBoxBaseline() const;
409     virtual LayoutUnit lastLineBoxBaseline() const;
410
411     virtual void updateHitTestResult(HitTestResult&, const LayoutPoint&);
412
413     // Delay update scrollbar until finishDelayRepaint() will be
414     // called. This function is used when a flexbox is laying out its
415     // descendant. If multiple calls are made to startDelayRepaint(),
416     // finishDelayRepaint() will do nothing until finishDelayRepaint()
417     // is called the same number of times.
418     static void startDelayUpdateScrollInfo();
419     static void finishDelayUpdateScrollInfo();
420
421     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
422     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
423
424     virtual bool hasLineIfEmpty() const;
425     
426     bool simplifiedLayout();
427     void simplifiedNormalFlowLayout();
428
429     void setDesiredColumnCountAndWidth(int, LayoutUnit);
430
431     void computeOverflow(LayoutUnit oldClientAfterEdge, bool recomputeFloats = false);
432     virtual void addOverflowFromChildren();
433     void addOverflowFromFloats();
434     void addOverflowFromPositionedObjects();
435     void addOverflowFromBlockChildren();
436     void addOverflowFromInlineChildren();
437     void addVisualOverflowFromTheme();
438
439     virtual void addFocusRingRects(Vector<LayoutRect>&, const LayoutPoint&);
440
441 #if ENABLE(SVG)
442     // Only used by RenderSVGText, which explicitely overrides RenderBlock::layoutBlock(), do NOT use for anything else.
443     void forceLayoutInlineChildren()
444     {
445         LayoutUnit repaintLogicalTop = 0;
446         LayoutUnit repaintLogicalBottom = 0;
447         layoutInlineChildren(true, repaintLogicalTop, repaintLogicalBottom);
448     }
449 #endif
450
451 private:
452     virtual RenderObjectChildList* virtualChildren() { return children(); }
453     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
454
455     virtual const char* renderName() const;
456
457     virtual bool isRenderBlock() const { return true; }
458     virtual bool isBlockFlow() const { return (!isInline() || isReplaced()) && !isTable(); }
459     virtual bool isInlineBlockOrInlineTable() const { return isInline() && isReplaced(); }
460
461     void makeChildrenNonInline(RenderObject* insertionPoint = 0);
462     virtual void removeLeftoverAnonymousBlock(RenderBlock* child);
463
464     static void collapseAnonymousBoxChild(RenderBlock* parent, RenderObject* child);
465
466     virtual void dirtyLinesFromChangedChild(RenderObject* child) { m_lineBoxes.dirtyLinesFromChangedChild(this, child); }
467
468     void addChildToContinuation(RenderObject* newChild, RenderObject* beforeChild);
469     void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild);
470     void addChildToAnonymousColumnBlocks(RenderObject* newChild, RenderObject* beforeChild);
471     virtual void addChildIgnoringAnonymousColumnBlocks(RenderObject* newChild, RenderObject* beforeChild = 0);
472     
473     virtual bool isSelfCollapsingBlock() const;
474
475     virtual LayoutUnit collapsedMarginBefore() const { return maxPositiveMarginBefore() - maxNegativeMarginBefore(); }
476     virtual LayoutUnit collapsedMarginAfter() const { return maxPositiveMarginAfter() - maxNegativeMarginAfter(); }
477
478     virtual void repaintOverhangingFloats(bool paintAllDescendants);
479
480     void layoutBlockChildren(bool relayoutChildren, LayoutUnit& maxFloatLogicalBottom);
481     void layoutInlineChildren(bool relayoutChildren, LayoutUnit& repaintLogicalTop, LayoutUnit& repaintLogicalBottom);
482     BidiRun* handleTrailingSpaces(BidiRunList<BidiRun>&, BidiContext*);
483
484     virtual void borderFitAdjust(LayoutRect&) const; // Shrink the box in which the border paints if border-fit is set.
485
486     virtual void updateBeforeAfterContent(PseudoId);
487     
488     virtual RootInlineBox* createRootInlineBox(); // Subclassed by SVG and Ruby.
489
490     // Called to lay out the legend for a fieldset or the ruby text of a ruby run.
491     virtual RenderObject* layoutSpecialExcludedChild(bool /*relayoutChildren*/) { return 0; }
492
493     struct FloatWithRect {
494         FloatWithRect(RenderBox* f)
495             : object(f)
496             , rect(LayoutRect(f->x() - f->marginLeft(), f->y() - f->marginTop(), f->width() + f->marginLeft() + f->marginRight(), f->height() + f->marginTop() + f->marginBottom()))
497             , everHadLayout(f->everHadLayout())
498         {
499         }
500
501         RenderBox* object;
502         LayoutRect rect;
503         bool everHadLayout;
504     };
505
506     struct FloatingObject {
507         WTF_MAKE_NONCOPYABLE(FloatingObject); WTF_MAKE_FAST_ALLOCATED;
508     public:
509         // FloatLeftRight is a mask to query for both left and right but not positioned.
510         // FloatAll is a mask to query for all types of floats.
511         enum Type { FloatLeft = 1, FloatRight = 2, FloatLeftRight = 3, FloatPositioned = 4, FloatAll = 7 };
512
513         FloatingObject(EFloat type)
514             : m_renderer(0)
515             , m_originatingLine(0)
516             , m_paginationStrut(0)
517             , m_shouldPaint(false)
518             , m_isDescendant(false)
519             , m_isPlaced(false)
520 #ifndef NDEBUG
521             , m_isInPlacedTree(false)
522 #endif
523         {
524             ASSERT(type != NoFloat);
525             if (type == LeftFloat)
526                 m_type = FloatLeft;
527             else if (type == RightFloat)
528                 m_type = FloatRight;
529             else if (type == PositionedFloat)
530                 m_type = FloatPositioned;
531         }
532
533         FloatingObject(Type type, const LayoutRect& frameRect)
534             : m_renderer(0)
535             , m_originatingLine(0)
536             , m_frameRect(frameRect)
537             , m_paginationStrut(0)
538             , m_type(type)
539             , m_shouldPaint(type != FloatPositioned)
540             , m_isDescendant(false)
541             , m_isPlaced(true)
542 #ifndef NDEBUG
543             , m_isInPlacedTree(false)
544 #endif
545         {
546         }
547
548         Type type() const { return static_cast<Type>(m_type); }
549         RenderBox* renderer() const { return m_renderer; }
550         
551         bool isPlaced() const { return m_isPlaced; }
552         void setIsPlaced(bool placed = true) { m_isPlaced = placed; }
553
554         LayoutUnit x() const { ASSERT(isPlaced()); return m_frameRect.x(); }
555         LayoutUnit maxX() const { ASSERT(isPlaced()); return m_frameRect.maxX(); }
556         LayoutUnit y() const { ASSERT(isPlaced()); return m_frameRect.y(); }
557         LayoutUnit maxY() const { ASSERT(isPlaced()); return m_frameRect.maxY(); }
558         LayoutUnit width() const { return m_frameRect.width(); }
559         LayoutUnit height() const { return m_frameRect.height(); }
560
561         void setX(LayoutUnit x) { ASSERT(!isInPlacedTree()); m_frameRect.setX(x); }
562         void setY(LayoutUnit y) { ASSERT(!isInPlacedTree()); m_frameRect.setY(y); }
563         void setWidth(LayoutUnit width) { ASSERT(!isInPlacedTree()); m_frameRect.setWidth(width); }
564         void setHeight(LayoutUnit height) { ASSERT(!isInPlacedTree()); m_frameRect.setHeight(height); }
565
566         const LayoutRect& frameRect() const { ASSERT(isPlaced()); return m_frameRect; }
567         void setFrameRect(const LayoutRect& frameRect) { ASSERT(!isInPlacedTree()); m_frameRect = frameRect; }
568
569 #ifndef NDEBUG
570         bool isInPlacedTree() const { return m_isInPlacedTree; }
571         void setIsInPlacedTree(bool value) { m_isInPlacedTree = value; }
572 #endif
573
574         RenderBox* m_renderer;
575         RootInlineBox* m_originatingLine;
576         LayoutRect m_frameRect;
577         int m_paginationStrut;
578         unsigned m_type : 3; // Type (left/right aligned or positioned)
579         bool m_shouldPaint : 1;
580         bool m_isDescendant : 1;
581         bool m_isPlaced : 1;
582 #ifndef NDEBUG
583         bool m_isInPlacedTree : 1;
584 #endif
585     };
586
587     LayoutPoint flipFloatForWritingModeForChild(const FloatingObject*, const LayoutPoint&) const;
588
589     LayoutUnit logicalTopForFloat(const FloatingObject* child) const { return isHorizontalWritingMode() ? child->y() : child->x(); }
590     LayoutUnit logicalBottomForFloat(const FloatingObject* child) const { return isHorizontalWritingMode() ? child->maxY() : child->maxX(); }
591     LayoutUnit logicalLeftForFloat(const FloatingObject* child) const { return isHorizontalWritingMode() ? child->x() : child->y(); }
592     LayoutUnit logicalRightForFloat(const FloatingObject* child) const { return isHorizontalWritingMode() ? child->maxX() : child->maxY(); }
593     LayoutUnit logicalWidthForFloat(const FloatingObject* child) const { return isHorizontalWritingMode() ? child->width() : child->height(); }
594
595     void setLogicalTopForFloat(FloatingObject* child, LayoutUnit logicalTop)
596     {
597         if (isHorizontalWritingMode())
598             child->setY(logicalTop);
599         else
600             child->setX(logicalTop);
601     }
602     void setLogicalLeftForFloat(FloatingObject* child, LayoutUnit logicalLeft)
603     {
604         if (isHorizontalWritingMode())
605             child->setX(logicalLeft);
606         else
607             child->setY(logicalLeft);
608     }
609     void setLogicalHeightForFloat(FloatingObject* child, LayoutUnit logicalHeight)
610     {
611         if (isHorizontalWritingMode())
612             child->setHeight(logicalHeight);
613         else
614             child->setWidth(logicalHeight);
615     }
616     void setLogicalWidthForFloat(FloatingObject* child, LayoutUnit logicalWidth)
617     {
618         if (isHorizontalWritingMode())
619             child->setWidth(logicalWidth);
620         else
621             child->setHeight(logicalWidth);
622     }
623
624     LayoutUnit xPositionForFloatIncludingMargin(const FloatingObject* child) const
625     {
626         if (isHorizontalWritingMode())
627             return child->x() + child->renderer()->marginLeft();
628         else
629             return child->x() + marginBeforeForChild(child->renderer());
630     }
631         
632     LayoutUnit yPositionForFloatIncludingMargin(const FloatingObject* child) const
633     {
634         if (isHorizontalWritingMode())
635             return child->y() + marginBeforeForChild(child->renderer());
636         else
637             return child->y() + child->renderer()->marginTop();
638     }
639
640     LayoutPoint computeLogicalLocationForFloat(const FloatingObject*, LayoutUnit logicalTopOffset) const;
641
642     // The following functions' implementations are in RenderBlockLineLayout.cpp.
643     typedef std::pair<RenderText*, LazyLineBreakIterator> LineBreakIteratorInfo;
644     class LineBreaker {
645     public:
646         LineBreaker(RenderBlock* block)
647             : m_block(block)
648         {
649             reset();
650         }
651
652         InlineIterator nextLineBreak(InlineBidiResolver&, LineInfo&, LineBreakIteratorInfo&, FloatingObject* lastFloatFromPreviousLine, unsigned consecutiveHyphenatedLines);
653
654         bool lineWasHyphenated() { return m_hyphenated; }
655         const Vector<RenderBox*>& positionedObjects() { return m_positionedObjects; }
656         EClear clear() { return m_clear; }
657     private:
658         void reset();
659         
660         void skipTrailingWhitespace(InlineIterator&, const LineInfo&);
661         void skipLeadingWhitespace(InlineBidiResolver&, LineInfo&, FloatingObject* lastFloatFromPreviousLine, LineWidth&);
662         
663         RenderBlock* m_block;
664         bool m_hyphenated;
665         EClear m_clear;
666         Vector<RenderBox*> m_positionedObjects;
667     };
668
669     void checkFloatsInCleanLine(RootInlineBox*, Vector<FloatWithRect>&, size_t& floatIndex, bool& encounteredNewFloat, bool& dirtiedByFloat);
670     RootInlineBox* determineStartPosition(LineLayoutState&, InlineBidiResolver&);
671     void determineEndPosition(LineLayoutState&, RootInlineBox* startBox, InlineIterator& cleanLineStart, BidiStatus& cleanLineBidiStatus);
672     bool matchedEndLine(LineLayoutState&, const InlineBidiResolver&, const InlineIterator& endLineStart, const BidiStatus& endLineStatus);
673     bool checkPaginationAndFloatsAtEndLine(LineLayoutState&);
674     
675     RootInlineBox* constructLine(BidiRunList<BidiRun>&, const LineInfo&);
676     InlineFlowBox* createLineBoxes(RenderObject*, const LineInfo&, InlineBox* childBox);
677
678     void setMarginsForRubyRun(BidiRun*, RenderRubyRun*, RenderObject*, const LineInfo&);
679
680     void computeInlineDirectionPositionsForLine(RootInlineBox*, const LineInfo&, BidiRun* firstRun, BidiRun* trailingSpaceRun, bool reachedEnd, GlyphOverflowAndFallbackFontsMap&, VerticalPositionCache&);
681     void computeBlockDirectionPositionsForLine(RootInlineBox*, BidiRun*, GlyphOverflowAndFallbackFontsMap&, VerticalPositionCache&);
682     void deleteEllipsisLineBoxes();
683     void checkLinesForTextOverflow();
684
685     // Positions new floats and also adjust all floats encountered on the line if any of them
686     // have to move to the next page/column.
687     bool positionNewFloatOnLine(FloatingObject* newFloat, FloatingObject* lastFloatFromPreviousLine, LineInfo&, LineWidth&);
688     void appendFloatingObjectToLastLine(FloatingObject*);
689
690     // End of functions defined in RenderBlockLineLayout.cpp.
691
692     void paintFloats(PaintInfo&, const LayoutPoint&, bool preservePhase = false);
693     void paintContents(PaintInfo&, const LayoutPoint&);
694     void paintColumnContents(PaintInfo&, const LayoutPoint&, bool paintFloats = false);
695     void paintColumnRules(PaintInfo&, const LayoutPoint&);
696     void paintChildren(PaintInfo&, const LayoutPoint&);
697     void paintEllipsisBoxes(PaintInfo&, const LayoutPoint&);
698     void paintSelection(PaintInfo&, const LayoutPoint&);
699     void paintCaret(PaintInfo&, const LayoutPoint&, CaretType);
700
701     FloatingObject* insertFloatingObject(RenderBox*);
702     void removeFloatingObject(RenderBox*);
703     void removeFloatingObjectsBelow(FloatingObject*, int logicalOffset);
704     
705     // Called from lineWidth, to position the floats added in the last line.
706     // Returns true if and only if it has positioned any floats.
707     bool positionNewFloats();
708
709     bool hasPositionedFloats() const { return m_hasPositionedFloats; }
710     void addPositionedFloats();
711     bool positionedFloatsNeedRelayout();
712
713     void clearFloats(BlockLayoutPass);
714     LayoutUnit getClearDelta(RenderBox* child, LayoutUnit yPos);
715
716     virtual bool avoidsFloats() const;
717
718     bool hasOverhangingFloats() { return parent() && !hasColumns() && containsFloats() && lowestFloatLogicalBottomIncludingPositionedFloats() > logicalHeight(); }
719     bool hasOverhangingFloat(RenderBox*);
720     void addIntrudingFloats(RenderBlock* prev, LayoutUnit xoffset, LayoutUnit yoffset);
721     LayoutUnit addOverhangingFloats(RenderBlock* child, bool makeChildPaintOtherFloats);
722
723     LayoutUnit lowestFloatLogicalBottom() const { return lowestFloatLogicalBottom(FloatingObject::FloatLeftRight); }
724     LayoutUnit lowestFloatLogicalBottomIncludingPositionedFloats() const { return lowestFloatLogicalBottom(FloatingObject::FloatAll); }
725     LayoutUnit lowestFloatLogicalBottom(FloatingObject::Type) const;
726     LayoutUnit nextFloatLogicalBottomBelow(LayoutUnit) const;
727     
728     virtual bool hitTestColumns(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
729     virtual bool hitTestContents(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset, HitTestAction);
730     bool hitTestFloats(const HitTestRequest&, HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset);
731
732     virtual bool isPointInOverflowControl(HitTestResult&, const LayoutPoint& pointInContainer, const LayoutPoint& accumulatedOffset);
733
734     void computeInlinePreferredLogicalWidths();
735     void computeBlockPreferredLogicalWidths();
736
737     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
738     // children.
739     virtual RenderBlock* firstLineBlock() const;
740
741     virtual LayoutRect rectWithOutlineForRepaint(RenderBoxModelObject* repaintContainer, LayoutUnit outlineWidth) const;
742     virtual RenderStyle* outlineStyleForRepaint() const;
743     
744     virtual RenderObject* hoverAncestor() const;
745     virtual void updateDragState(bool dragOn);
746     virtual void childBecameNonInline(RenderObject* child);
747
748     virtual LayoutRect selectionRectForRepaint(RenderBoxModelObject* repaintContainer, bool /*clipToVisibleContent*/)
749     {
750         return selectionGapRectsForRepaint(repaintContainer);
751     }
752     virtual bool shouldPaintSelectionGaps() const;
753     bool isSelectionRoot() const;
754     GapRects selectionGaps(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
755                            LayoutUnit& lastLogicalTop, LayoutUnit& lastLogicalLeft, LayoutUnit& lastLogicalRight, const PaintInfo* = 0);
756     GapRects inlineSelectionGaps(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
757                                  LayoutUnit& lastLogicalTop, LayoutUnit& lastLogicalLeft, LayoutUnit& lastLogicalRight, const PaintInfo*);
758     GapRects blockSelectionGaps(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
759                                 LayoutUnit& lastLogicalTop, LayoutUnit& lastLogicalLeft, LayoutUnit& lastLogicalRight, const PaintInfo*);
760     LayoutRect blockSelectionGap(RenderBlock* rootBlock, const LayoutPoint& rootBlockPhysicalPosition, const LayoutSize& offsetFromRootBlock,
761                                  LayoutUnit lastLogicalTop, LayoutUnit lastLogicalLeft, LayoutUnit lastLogicalRight, LayoutUnit logicalBottom, const PaintInfo*);
762     LayoutUnit logicalLeftSelectionOffset(RenderBlock* rootBlock, LayoutUnit position);
763     LayoutUnit logicalRightSelectionOffset(RenderBlock* rootBlock, LayoutUnit position);
764     
765     virtual void absoluteRects(Vector<LayoutRect>&, const LayoutPoint& accumulatedOffset) const;
766     virtual void absoluteQuads(Vector<FloatQuad>&, bool* wasFixed) const;
767
768     LayoutUnit desiredColumnWidth() const;
769     unsigned desiredColumnCount() const;
770
771     void paintContinuationOutlines(PaintInfo&, const LayoutPoint&);
772
773     virtual LayoutRect localCaretRect(InlineBox*, int caretOffset, LayoutUnit* extraWidthToEndOfLine = 0);
774
775     void adjustPointToColumnContents(LayoutPoint&) const;
776     void adjustForBorderFit(LayoutUnit x, LayoutUnit& left, LayoutUnit& right) const; // Helper function for borderFitAdjust
777
778     void markLinesDirtyInBlockRange(LayoutUnit logicalTop, LayoutUnit logicalBottom, RootInlineBox* highest = 0);
779
780     void newLine(EClear);
781
782     Position positionForBox(InlineBox*, bool start = true) const;
783     VisiblePosition positionForPointWithInlineChildren(const LayoutPoint&);
784
785     // Adjust from painting offsets to the local coords of this renderer
786     void offsetForContents(LayoutPoint&) const;
787
788     virtual void calcColumnWidth();
789     bool layoutColumns(bool hasSpecifiedPageLogicalHeight, LayoutUnit pageLogicalHeight, LayoutStateMaintainer&);
790     void makeChildrenAnonymousColumnBlocks(RenderObject* beforeChild, RenderBlock* newBlockBox, RenderObject* newChild);
791
792     bool expandsToEncloseOverhangingFloats() const;
793
794     void updateScrollInfoAfterLayout();
795
796     RenderObject* splitAnonymousBlocksAroundChild(RenderObject* beforeChild);
797     void splitBlocks(RenderBlock* fromBlock, RenderBlock* toBlock, RenderBlock* middleBlock,
798                      RenderObject* beforeChild, RenderBoxModelObject* oldCont);
799     void splitFlow(RenderObject* beforeChild, RenderBlock* newBlockBox,
800                    RenderObject* newChild, RenderBoxModelObject* oldCont);
801     RenderBlock* clone() const;
802     RenderBlock* continuationBefore(RenderObject* beforeChild);
803     RenderBlock* containingColumnsBlock(bool allowAnonymousColumnBlock = true);
804     RenderBlock* columnsBlockForSpanningElement(RenderObject* newChild);
805
806     class MarginInfo {
807         // Collapsing flags for whether we can collapse our margins with our children's margins.
808         bool m_canCollapseWithChildren : 1;
809         bool m_canCollapseMarginBeforeWithChildren : 1;
810         bool m_canCollapseMarginAfterWithChildren : 1;
811
812         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
813         // margins in our container.  Table cells and the body are the common examples. We
814         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
815         bool m_quirkContainer : 1;
816
817         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.  
818         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
819         // always be collapsing with one another.  This variable can remain set to true through multiple iterations 
820         // as long as we keep encountering self-collapsing blocks.
821         bool m_atBeforeSideOfBlock : 1;
822
823         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
824         bool m_atAfterSideOfBlock : 1;
825
826         // These variables are used to detect quirky margins that we need to collapse away (in table cells
827         // and in the body element).
828         bool m_marginBeforeQuirk : 1;
829         bool m_marginAfterQuirk : 1;
830         bool m_determinedMarginBeforeQuirk : 1;
831
832         // These flags track the previous maximal positive and negative margins.
833         LayoutUnit m_positiveMargin;
834         LayoutUnit m_negativeMargin;
835
836     public:
837         MarginInfo(RenderBlock*, LayoutUnit beforeBorderPadding, LayoutUnit afterBorderPadding);
838
839         void setAtBeforeSideOfBlock(bool b) { m_atBeforeSideOfBlock = b; }
840         void setAtAfterSideOfBlock(bool b) { m_atAfterSideOfBlock = b; }
841         void clearMargin() { m_positiveMargin = m_negativeMargin = 0; }
842         void setMarginBeforeQuirk(bool b) { m_marginBeforeQuirk = b; }
843         void setMarginAfterQuirk(bool b) { m_marginAfterQuirk = b; }
844         void setDeterminedMarginBeforeQuirk(bool b) { m_determinedMarginBeforeQuirk = b; }
845         void setPositiveMargin(LayoutUnit p) { m_positiveMargin = p; }
846         void setNegativeMargin(LayoutUnit n) { m_negativeMargin = n; }
847         void setPositiveMarginIfLarger(LayoutUnit p)
848         {
849             if (p > m_positiveMargin)
850                 m_positiveMargin = p;
851         }
852         void setNegativeMarginIfLarger(LayoutUnit n)
853         {
854             if (n > m_negativeMargin)
855                 m_negativeMargin = n;
856         }
857
858         void setMargin(LayoutUnit p, LayoutUnit n) { m_positiveMargin = p; m_negativeMargin = n; }
859
860         bool atBeforeSideOfBlock() const { return m_atBeforeSideOfBlock; }
861         bool canCollapseWithMarginBefore() const { return m_atBeforeSideOfBlock && m_canCollapseMarginBeforeWithChildren; }
862         bool canCollapseWithMarginAfter() const { return m_atAfterSideOfBlock && m_canCollapseMarginAfterWithChildren; }
863         bool canCollapseMarginBeforeWithChildren() const { return m_canCollapseMarginBeforeWithChildren; }
864         bool canCollapseMarginAfterWithChildren() const { return m_canCollapseMarginAfterWithChildren; }
865         bool quirkContainer() const { return m_quirkContainer; }
866         bool determinedMarginBeforeQuirk() const { return m_determinedMarginBeforeQuirk; }
867         bool marginBeforeQuirk() const { return m_marginBeforeQuirk; }
868         bool marginAfterQuirk() const { return m_marginAfterQuirk; }
869         LayoutUnit positiveMargin() const { return m_positiveMargin; }
870         LayoutUnit negativeMargin() const { return m_negativeMargin; }
871         LayoutUnit margin() const { return m_positiveMargin - m_negativeMargin; }
872     };
873
874     void layoutBlockChild(RenderBox* child, MarginInfo&, LayoutUnit& previousFloatLogicalBottom, LayoutUnit& maxFloatLogicalBottom);
875     void adjustPositionedBlock(RenderBox* child, const MarginInfo&);
876     void adjustFloatingBlock(const MarginInfo&);
877     bool handleSpecialChild(RenderBox* child, const MarginInfo&);
878     bool handleFloatingChild(RenderBox* child, const MarginInfo&);
879     bool handlePositionedChild(RenderBox* child, const MarginInfo&);
880     bool handleRunInChild(RenderBox* child);
881     LayoutUnit collapseMargins(RenderBox* child, MarginInfo&);
882     LayoutUnit clearFloatsIfNeeded(RenderBox* child, MarginInfo&, LayoutUnit oldTopPosMargin, LayoutUnit oldTopNegMargin, LayoutUnit yPos);
883     LayoutUnit estimateLogicalTopPosition(RenderBox* child, const MarginInfo&, LayoutUnit& estimateWithoutPagination);
884     void determineLogicalLeftPositionForChild(RenderBox* child);
885     void handleAfterSideOfBlock(LayoutUnit top, LayoutUnit bottom, MarginInfo&);
886     void setCollapsedBottomMargin(const MarginInfo&);
887     // End helper functions and structs used by layoutBlockChildren.
888
889     // Helper function for layoutInlineChildren()
890     RootInlineBox* createLineBoxesFromBidiRuns(BidiRunList<BidiRun>&, const InlineIterator& end, LineInfo&, VerticalPositionCache&, BidiRun* trailingSpaceRun);
891     void layoutRunsAndFloats(LineLayoutState&, bool hasInlineChild);
892     void layoutRunsAndFloatsInRange(LineLayoutState&, InlineBidiResolver&, const InlineIterator& cleanLineStart, const BidiStatus& cleanLineBidiStatus, unsigned consecutiveHyphenatedLines);
893     void linkToEndLineIfNeeded(LineLayoutState&);
894     static void repaintDirtyFloats(Vector<FloatWithRect>& floats);
895
896 protected:
897     // Pagination routines.
898     
899     // Returns the logicalOffset at the top of the next page. If the offset passed in is already at the top of the current page,
900     // then nextPageLogicalTop with ExcludePageBoundary will still move to the top of the next page. nextPageLogicalTop with
901     // IncludePageBoundary set will not.
902     //
903     // 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.
904     enum PageBoundaryRule { ExcludePageBoundary, IncludePageBoundary };
905     LayoutUnit nextPageLogicalTop(LayoutUnit logicalOffset, PageBoundaryRule = ExcludePageBoundary) const;
906     bool hasNextPage(LayoutUnit logicalOffset, PageBoundaryRule = ExcludePageBoundary) const;
907
908     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.
909     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.
910
911 public:
912     LayoutUnit pageLogicalTopForOffset(LayoutUnit offset) const;
913     LayoutUnit pageLogicalHeightForOffset(LayoutUnit offset) const;
914     LayoutUnit pageRemainingLogicalHeightForOffset(LayoutUnit offset, PageBoundaryRule = IncludePageBoundary) const;
915     
916 protected:
917     bool pushToNextPageWithMinimumLogicalHeight(LayoutUnit& adjustment, LayoutUnit logicalOffset, LayoutUnit minimumLogicalHeight) const;
918
919     LayoutUnit adjustForUnsplittableChild(RenderBox* child, LayoutUnit logicalOffset, bool includeMargins = false); // If the child is unsplittable and can't fit on the current page, return the top of the next page/column.
920     void adjustLinePositionForPagination(RootInlineBox*, LayoutUnit& deltaOffset); // Computes a deltaOffset value that put a line at the top of the next page if it doesn't fit on the current page.
921     LayoutUnit adjustBlockChildForPagination(LayoutUnit logicalTopAfterClear, LayoutUnit estimateWithoutPagination, RenderBox* child, bool atBeforeSideOfBlock);
922
923     // 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
924     // region/page/column that has a different available line width than the old one. Used to know when you have to dirty a
925     // line, i.e., that it can't be re-used.
926     bool lineWidthForPaginatedLineChanged(RootInlineBox*, LayoutUnit lineDelta = 0) const;
927
928     bool logicalWidthChangedInRegions() const;
929
930     virtual bool requiresColumns(int desiredColumnCount) const;
931
932 public:
933     LayoutUnit offsetFromLogicalTopOfFirstPage() const;
934     RenderRegion* regionAtBlockOffset(LayoutUnit) const;
935     RenderRegion* clampToStartAndEndRegions(RenderRegion*) const;
936
937 protected:
938     struct FloatingObjectHashFunctions {
939         static unsigned hash(FloatingObject* key) { return DefaultHash<RenderBox*>::Hash::hash(key->m_renderer); }
940         static bool equal(FloatingObject* a, FloatingObject* b) { return a->m_renderer == b->m_renderer; }
941         static const bool safeToCompareToEmptyOrDeleted = true;
942     };
943     struct FloatingObjectHashTranslator {
944         static unsigned hash(RenderBox* key) { return DefaultHash<RenderBox*>::Hash::hash(key); }
945         static bool equal(FloatingObject* a, RenderBox* b) { return a->m_renderer == b; }
946     };
947     typedef ListHashSet<FloatingObject*, 4, FloatingObjectHashFunctions> FloatingObjectSet;
948     typedef FloatingObjectSet::const_iterator FloatingObjectSetIterator;
949     typedef PODInterval<int, FloatingObject*> FloatingObjectInterval;
950     typedef PODIntervalTree<int, FloatingObject*> FloatingObjectTree;
951     typedef PODFreeListArena<PODRedBlackTree<FloatingObjectInterval>::Node> IntervalArena;
952     
953     template <FloatingObject::Type FloatTypeValue>
954     class FloatIntervalSearchAdapter {
955     public:
956         typedef FloatingObjectInterval IntervalType;
957         
958         FloatIntervalSearchAdapter(const RenderBlock* renderer, int value, LayoutUnit& offset, LayoutUnit* heightRemaining)
959             : m_renderer(renderer)
960             , m_value(value)
961             , m_offset(offset)
962             , m_heightRemaining(heightRemaining)
963         {
964         }
965         
966         inline int lowValue() const { return m_value; }
967         inline int highValue() const { return m_value; }
968         void collectIfNeeded(const IntervalType&) const;
969
970     private:
971         const RenderBlock* m_renderer;
972         int m_value;
973         LayoutUnit& m_offset;
974         LayoutUnit* m_heightRemaining;
975     };
976
977     class FloatingObjects {
978     public:
979         FloatingObjects(const RenderBlock* renderer, bool horizontalWritingMode)
980             : m_placedFloatsTree(UninitializedTree)
981             , m_leftObjectsCount(0)
982             , m_rightObjectsCount(0)
983             , m_positionedObjectsCount(0)
984             , m_horizontalWritingMode(horizontalWritingMode)
985             , m_renderer(renderer)
986         {
987         }
988
989         void clear();
990         void add(FloatingObject*);
991         void remove(FloatingObject*);
992         void addPlacedObject(FloatingObject*);
993         void removePlacedObject(FloatingObject*);
994         void setHorizontalWritingMode(bool b = true) { m_horizontalWritingMode = b; }
995
996         bool hasLeftObjects() const { return m_leftObjectsCount > 0; }
997         bool hasRightObjects() const { return m_rightObjectsCount > 0; }
998         bool hasPositionedObjects() const { return m_positionedObjectsCount > 0; }
999         const FloatingObjectSet& set() const { return m_set; }
1000         const FloatingObjectTree& placedFloatsTree()
1001         {
1002             computePlacedFloatsTreeIfNeeded();
1003             return m_placedFloatsTree; 
1004         }
1005     private:
1006         void computePlacedFloatsTree();
1007         inline void computePlacedFloatsTreeIfNeeded()
1008         {
1009             if (!m_placedFloatsTree.isInitialized())
1010                 computePlacedFloatsTree();
1011         }
1012         void increaseObjectsCount(FloatingObject::Type);
1013         void decreaseObjectsCount(FloatingObject::Type);
1014         FloatingObjectInterval intervalForFloatingObject(FloatingObject*);
1015
1016         FloatingObjectSet m_set;
1017         FloatingObjectTree m_placedFloatsTree;
1018         unsigned m_leftObjectsCount;
1019         unsigned m_rightObjectsCount;
1020         unsigned m_positionedObjectsCount;
1021         bool m_horizontalWritingMode;
1022         const RenderBlock* m_renderer;
1023     };
1024     OwnPtr<FloatingObjects> m_floatingObjects;
1025     
1026     typedef PositionedObjectsListHashSet::const_iterator Iterator;
1027     OwnPtr<PositionedObjectsListHashSet> m_positionedObjects;
1028
1029     // Allocated only when some of these fields have non-default values
1030     struct RenderBlockRareData {
1031         WTF_MAKE_NONCOPYABLE(RenderBlockRareData); WTF_MAKE_FAST_ALLOCATED;
1032     public:
1033         RenderBlockRareData(const RenderBlock* block) 
1034             : m_margins(positiveMarginBeforeDefault(block), negativeMarginBeforeDefault(block), positiveMarginAfterDefault(block), negativeMarginAfterDefault(block))
1035             , m_paginationStrut(0)
1036             , m_pageLogicalOffset(0)
1037             , m_lineGridBox(0)
1038         { 
1039         }
1040
1041         static LayoutUnit positiveMarginBeforeDefault(const RenderBlock* block)
1042         { 
1043             return std::max<LayoutUnit>(block->marginBefore(), 0);
1044         }
1045         
1046         static LayoutUnit negativeMarginBeforeDefault(const RenderBlock* block)
1047         { 
1048             return std::max<LayoutUnit>(-block->marginBefore(), 0);
1049         }
1050         static LayoutUnit positiveMarginAfterDefault(const RenderBlock* block)
1051         {
1052             return std::max<LayoutUnit>(block->marginAfter(), 0);
1053         }
1054         static LayoutUnit negativeMarginAfterDefault(const RenderBlock* block)
1055         {
1056             return std::max<LayoutUnit>(-block->marginAfter(), 0);
1057         }
1058         
1059         MarginValues m_margins;
1060         LayoutUnit m_paginationStrut;
1061         LayoutUnit m_pageLogicalOffset;
1062         
1063         RootInlineBox* m_lineGridBox;
1064      };
1065
1066     OwnPtr<RenderBlockRareData> m_rareData;
1067
1068     RenderObjectChildList m_children;
1069     RenderLineBoxList m_lineBoxes;   // All of the root line boxes created for this block flow.  For example, <div>Hello<br>world.</div> will have two total lines for the <div>.
1070
1071     mutable signed m_lineHeight : 30;
1072     bool m_beingDestroyed : 1;
1073     bool m_hasPositionedFloats : 1;
1074
1075     // RenderRubyBase objects need to be able to split and merge, moving their children around
1076     // (calling moveChildTo, moveAllChildrenTo, and makeChildrenNonInline).
1077     friend class RenderRubyBase;
1078     friend class LineWidth; // Needs to know FloatingObject
1079
1080 private:
1081     // Used to store state between styleWillChange and styleDidChange
1082     static bool s_canPropagateFloatIntoSibling;
1083 };
1084
1085 inline RenderBlock* toRenderBlock(RenderObject* object)
1086
1087     ASSERT(!object || object->isRenderBlock());
1088     return static_cast<RenderBlock*>(object);
1089 }
1090
1091 inline const RenderBlock* toRenderBlock(const RenderObject* object)
1092
1093     ASSERT(!object || object->isRenderBlock());
1094     return static_cast<const RenderBlock*>(object);
1095 }
1096
1097 // This will catch anyone doing an unnecessary cast.
1098 void toRenderBlock(const RenderBlock*);
1099
1100 #ifndef NDEBUG
1101 // These structures are used by PODIntervalTree for debugging purposes.
1102 template <> struct ValueToString<int> {
1103     static String string(const int value);
1104 };
1105 template<> struct ValueToString<RenderBlock::FloatingObject*> {
1106     static String string(const RenderBlock::FloatingObject*);
1107 };
1108 #endif
1109
1110 } // namespace WebCore
1111
1112 #endif // RenderBlock_h