https://bugs.webkit.org/show_bug.cgi?id=46923
[WebKit-https.git] / 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 "DeprecatedPtrList.h"
27 #include "GapRects.h"
28 #include "RenderBox.h"
29 #include "RenderLineBoxList.h"
30 #include "RootInlineBox.h"
31 #include <wtf/ListHashSet.h>
32
33 namespace WebCore {
34
35 class ColumnInfo;
36 class InlineIterator;
37 class LayoutStateMaintainer;
38 class RenderInline;
39
40 struct BidiRun;
41
42 template <class Iterator, class Run> class BidiResolver;
43 template <class Iterator> struct MidpointState;
44 typedef BidiResolver<InlineIterator, BidiRun> InlineBidiResolver;
45 typedef MidpointState<InlineIterator> LineMidpointState;
46
47 enum CaretType { CursorCaret, DragCaret };
48
49 class RenderBlock : public RenderBox {
50 public:
51     RenderBlock(Node*);
52     virtual ~RenderBlock();
53
54     const RenderObjectChildList* children() const { return &m_children; }
55     RenderObjectChildList* children() { return &m_children; }
56
57     virtual void destroy();
58
59     // These two functions are overridden for inline-block.
60     virtual int lineHeight(bool firstLine, bool isRootLineBox = false) const;
61     virtual int baselinePosition(bool firstLine, bool isRootLineBox = false) const;
62
63     RenderLineBoxList* lineBoxes() { return &m_lineBoxes; }
64     const RenderLineBoxList* lineBoxes() const { return &m_lineBoxes; }
65
66     InlineFlowBox* firstLineBox() const { return m_lineBoxes.firstLineBox(); }
67     InlineFlowBox* lastLineBox() const { return m_lineBoxes.lastLineBox(); }
68
69     void deleteLineBoxTree();
70
71     virtual void addChild(RenderObject* newChild, RenderObject* beforeChild = 0);
72     virtual void removeChild(RenderObject*);
73
74     virtual void layoutBlock(bool relayoutChildren, int pageHeight = 0);
75
76     void insertPositionedObject(RenderBox*);
77     void removePositionedObject(RenderBox*);
78     void removePositionedObjects(RenderBlock*);
79
80     typedef ListHashSet<RenderBox*, 4> PositionedObjectsListHashSet;
81     PositionedObjectsListHashSet* positionedObjects() const { return m_positionedObjects; }
82
83     void addPercentHeightDescendant(RenderBox*);
84     static void removePercentHeightDescendant(RenderBox*);
85     HashSet<RenderBox*>* percentHeightDescendants() const;
86
87     RootInlineBox* createAndAppendRootInlineBox();
88
89     bool generatesLineBoxesForInlineChild(RenderObject*, bool isLineEmpty = true, bool previousLineBrokeCleanly = true);
90
91     void markAllDescendantsWithFloatsForLayout(RenderBox* floatToRemove = 0, bool inLayout = true);
92     void markPositionedObjectsForLayout();
93     void markForPaginationRelayout()
94     { 
95         if (isTable())
96             markDescendantBlocksAndLinesForLayout();
97         else
98             setChildNeedsLayout(true, false);
99     }
100     virtual void markDescendantBlocksAndLinesForLayout(bool inLayout = true);
101     
102     bool containsFloats() { return m_floatingObjects && !m_floatingObjects->isEmpty(); }
103     bool containsFloat(RenderObject*);
104
105     int availableLogicalWidthForLine(int position, bool firstLine) const;
106     int logicalRightOffsetForLine(int position, bool firstLine) const { return logicalRightOffsetForLine(position, logicalRightOffsetForContent(), firstLine); }
107     int logicalLeftOffsetForLine(int position, bool firstLine) const { return logicalLeftOffsetForLine(position, logicalLeftOffsetForContent(), firstLine); }
108
109     virtual int lowestPosition(bool includeOverflowInterior = true, bool includeSelf = true) const;
110     virtual int rightmostPosition(bool includeOverflowInterior = true, bool includeSelf = true) const;
111     virtual int leftmostPosition(bool includeOverflowInterior = true, bool includeSelf = true) const;
112     
113     virtual VisiblePosition positionForPoint(const IntPoint&);
114     
115     // Block flows subclass availableWidth to handle multi column layout (shrinking the width available to children when laying out.)
116     virtual int availableLogicalWidth() const;
117
118     RootInlineBox* firstRootBox() const { return static_cast<RootInlineBox*>(firstLineBox()); }
119     RootInlineBox* lastRootBox() const { return static_cast<RootInlineBox*>(lastLineBox()); }
120
121     bool containsNonZeroBidiLevel() const;
122
123     GapRects selectionGapRectsForRepaint(RenderBoxModelObject* repaintContainer);
124     IntRect fillLeftSelectionGap(RenderObject* selObj, int xPos, int yPos, int height, RenderBlock* rootBlock, 
125                                  int blockX, int blockY, int tx, int ty, const PaintInfo*);
126     IntRect fillRightSelectionGap(RenderObject* selObj, int xPos, int yPos, int height, RenderBlock* rootBlock,
127                                   int blockX, int blockY, int tx, int ty, const PaintInfo*);
128     IntRect fillHorizontalSelectionGap(RenderObject* selObj, int xPos, int yPos, int width, int height, const PaintInfo*);
129
130     void getHorizontalSelectionGapInfo(SelectionState, bool& leftGap, bool& rightGap);
131
132     // Helper methods for computing line counts and heights for line counts.
133     RootInlineBox* lineAtIndex(int);
134     int lineCount();
135     int heightForLineCount(int);
136     void clearTruncation();
137
138     void adjustRectForColumns(IntRect&) const;
139     virtual void adjustForColumns(IntSize&, const IntPoint&) const;
140
141     void addContinuationWithOutline(RenderInline*);
142
143     RenderBoxModelObject* continuation() const { return m_continuation; }
144     void setContinuation(RenderBoxModelObject* c) { m_continuation = c; }
145     virtual RenderBoxModelObject* virtualContinuation() const { return continuation(); }
146     bool isAnonymousBlockContinuation() const { return continuation() && isAnonymousBlock(); }
147     RenderInline* inlineElementContinuation() const;
148     RenderBlock* blockElementContinuation() const;
149
150     // This function is a convenience helper for creating an anonymous block that inherits its
151     // style from this RenderBlock.
152     RenderBlock* createAnonymousBlock(bool isFlexibleBox = false) const;
153     RenderBlock* createAnonymousColumnsBlock() const;
154     RenderBlock* createAnonymousColumnSpanBlock() const;
155     RenderBlock* createAnonymousBlockWithSameTypeAs(RenderBlock* otherAnonymousBlock) const;
156     
157     static void appendRunsForObject(int start, int end, RenderObject*, InlineBidiResolver&);    
158     static bool requiresLineBox(const InlineIterator&, bool isLineEmpty = true, bool previousLineBrokeCleanly = true);
159
160     ColumnInfo* columnInfo() const;
161     int columnGap() const;
162     
163     // These two functions take the ColumnInfo* to avoid repeated lookups of the info in the global HashMap.
164     unsigned columnCount(ColumnInfo*) const;
165     IntRect columnRectAt(ColumnInfo*, unsigned) const;
166
167     int paginationStrut() const { return m_rareData ? m_rareData->m_paginationStrut : 0; }
168     int pageY() const { return m_rareData ? m_rareData->m_pageY : 0; }
169     void setPaginationStrut(int strut);
170     void setPageY(int y);
171
172     // Accessors for logical width/height and margins in the containing block's block-flow direction.
173     int logicalWidthForChild(RenderBox* child) { return style()->isVerticalBlockFlow() ? child->width() : child->height(); }
174     int logicalHeightForChild(RenderBox* child) { return style()->isVerticalBlockFlow() ? child->height() : child->width(); }
175     int logicalTopForChild(RenderBox* child) { return style()->isVerticalBlockFlow() ? child->y() : child->x(); }
176     void setLogicalLeftForChild(RenderBox* child, int logicalLeft);
177     void setLogicalTopForChild(RenderBox* child, int logicalTop);
178     int marginBeforeForChild(RenderBoxModelObject* child) const;
179     int marginAfterForChild(RenderBoxModelObject* child) const;
180     int marginStartForChild(RenderBoxModelObject* child) const;
181     int marginEndForChild(RenderBoxModelObject* child) const;
182     void setMarginStartForChild(RenderBox* child, int);
183     void setMarginEndForChild(RenderBox* child, int);
184     void setMarginBeforeForChild(RenderBox* child, int);
185     void setMarginAfterForChild(RenderBox* child, int);
186     int collapsedMarginBeforeForChild(RenderBox* child) const;
187     int collapsedMarginAfterForChild(RenderBox* child) const;
188
189 protected:
190     // These functions are only used internally to manipulate the render tree structure via remove/insert/appendChildNode.
191     // Since they are typically called only to move objects around within anonymous blocks (which only have layers in
192     // the case of column spans), the default for fullRemoveInsert is false rather than true.
193     void moveChildTo(RenderBlock* to, RenderObject* child, bool fullRemoveInsert = false)
194     {
195         return moveChildTo(to, child, 0, fullRemoveInsert);
196     }
197     void moveChildTo(RenderBlock* to, RenderObject* child, RenderObject* beforeChild, bool fullRemoveInsert = false);
198     void moveAllChildrenTo(RenderBlock* to, bool fullRemoveInsert = false)
199     {
200         return moveAllChildrenTo(to, 0, fullRemoveInsert);
201     }
202     void moveAllChildrenTo(RenderBlock* to, RenderObject* beforeChild, bool fullRemoveInsert = false)
203     {
204         return moveChildrenTo(to, firstChild(), 0, beforeChild, fullRemoveInsert);
205     }
206     // Move all of the kids from |startChild| up to but excluding |endChild|.  0 can be passed as the endChild to denote
207     // that all the kids from |startChild| onwards should be added.
208     void moveChildrenTo(RenderBlock* to, RenderObject* startChild, RenderObject* endChild, bool fullRemoveInsert = false)
209     {
210         return moveChildrenTo(to, startChild, endChild, 0, fullRemoveInsert);
211     }
212     void moveChildrenTo(RenderBlock* to, RenderObject* startChild, RenderObject* endChild, RenderObject* beforeChild, bool fullRemoveInsert = false);
213     
214     int maxPosMarginBefore() const { return m_rareData ? m_rareData->m_beforePos : RenderBlockRareData::beforePosDefault(this); }
215     int maxNegMarginBefore() const { return m_rareData ? m_rareData->m_beforeNeg : RenderBlockRareData::beforeNegDefault(this); }
216     int maxPosMarginAfter() const { return m_rareData ? m_rareData->m_afterPos : RenderBlockRareData::afterPosDefault(this); }
217     int maxNegMarginAfter() const { return m_rareData ? m_rareData->m_afterNeg : RenderBlockRareData::afterNegDefault(this); }
218     
219     void setMaxMarginBeforeValues(int pos, int neg);
220     void setMaxMarginAfterValues(int pos, int neg);
221
222     void initMaxMarginValues()
223     {
224         if (m_rareData) {
225             m_rareData->m_beforePos = RenderBlockRareData::beforePosDefault(this);
226             m_rareData->m_beforeNeg = RenderBlockRareData::beforeNegDefault(this);
227             m_rareData->m_afterPos = RenderBlockRareData::afterPosDefault(this);
228             m_rareData->m_afterNeg = RenderBlockRareData::afterNegDefault(this);
229             m_rareData->m_paginationStrut = 0;
230         }
231     }
232
233     virtual void layout();
234
235     void layoutPositionedObjects(bool relayoutChildren);
236
237     virtual void paint(PaintInfo&, int tx, int ty);
238     virtual void paintObject(PaintInfo&, int tx, int ty);
239
240     int logicalRightOffsetForContent() const { return style()->isVerticalBlockFlow() ? borderLeft() + paddingLeft() + availableLogicalWidth() : borderTop() + paddingTop() + availableLogicalWidth(); }
241     int logicalLeftOffsetForContent() const { return style()->isVerticalBlockFlow() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
242     int logicalRightOffsetForLine(int position, int fixedOffset, bool applyTextIndent = true, int* logicalHeightRemaining = 0) const;
243     int logicalLeftOffsetForLine(int position, int fixedOffset, bool applyTextIndent = true, int* logicalHeightRemaining = 0) const;
244
245     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
246
247     virtual void computePreferredLogicalWidths();
248
249     virtual int firstLineBoxBaseline() const;
250     virtual int lastLineBoxBaseline() const;
251
252     virtual void updateFirstLetter();
253
254     virtual void updateHitTestResult(HitTestResult&, const IntPoint&);
255
256     // Delay update scrollbar until finishDelayRepaint() will be
257     // called. This function is used when a flexbox is laying out its
258     // descendant. If multiple calls are made to startDelayRepaint(),
259     // finishDelayRepaint() will do nothing until finishDelayRepaint()
260     // is called the same number of times.
261     static void startDelayUpdateScrollInfo();
262     static void finishDelayUpdateScrollInfo();
263
264     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
265     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
266
267     virtual bool hasLineIfEmpty() const;
268     bool layoutOnlyPositionedObjects();
269
270 #if ENABLE(SVG)
271 protected:
272
273     // Only used by RenderSVGText, which explicitely overrides RenderBlock::layoutBlock(), do NOT use for anything else.
274     void forceLayoutInlineChildren()
275     {
276         int repaintTop = 0;
277         int repaintBottom = 0;
278         layoutInlineChildren(true, repaintTop, repaintBottom);
279     }
280 #endif
281
282 private:
283     virtual RenderObjectChildList* virtualChildren() { return children(); }
284     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
285
286     virtual const char* renderName() const;
287
288     virtual bool isRenderBlock() const { return true; }
289     virtual bool isBlockFlow() const { return (!isInline() || isReplaced()) && !isTable(); }
290     virtual bool isInlineBlockOrInlineTable() const { return isInline() && isReplaced(); }
291
292     void makeChildrenNonInline(RenderObject* insertionPoint = 0);
293     virtual void removeLeftoverAnonymousBlock(RenderBlock* child);
294
295     virtual void dirtyLinesFromChangedChild(RenderObject* child) { m_lineBoxes.dirtyLinesFromChangedChild(this, child); }
296
297     void addChildToContinuation(RenderObject* newChild, RenderObject* beforeChild);
298     void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild);
299     void addChildToAnonymousColumnBlocks(RenderObject* newChild, RenderObject* beforeChild);
300     virtual void addChildIgnoringAnonymousColumnBlocks(RenderObject* newChild, RenderObject* beforeChild = 0);
301     
302     virtual bool isSelfCollapsingBlock() const;
303
304     virtual int maxMarginBefore(MarginSign sign) const
305     { 
306         return (sign == PositiveMargin) ? maxPosMarginBefore() : maxNegMarginBefore();
307     }
308     virtual int maxMarginAfter(MarginSign sign) const
309     {
310         return (sign == PositiveMargin) ? maxPosMarginAfter() : maxNegMarginAfter();
311     }
312
313     virtual void repaintOverhangingFloats(bool paintAllDescendants);
314
315     void layoutBlockChildren(bool relayoutChildren, int& maxFloatBottom);
316     void layoutInlineChildren(bool relayoutChildren, int& repaintTop, int& repaintBottom);
317
318     virtual void positionListMarker() { }
319
320     virtual void borderFitAdjust(int& x, int& w) const; // Shrink the box in which the border paints if border-fit is set.
321
322     virtual void updateBeforeAfterContent(PseudoId);
323
324     virtual RootInlineBox* createRootInlineBox(); // Subclassed by SVG and Ruby.
325
326     // Called to lay out the legend for a fieldset.
327     virtual RenderObject* layoutLegend(bool /*relayoutChildren*/) { return 0; }
328
329     struct FloatWithRect {
330         FloatWithRect(RenderBox* f)
331             : object(f)
332             , rect(IntRect(f->x() - f->marginLeft(), f->y() - f->marginTop(), f->width() + f->marginLeft() + f->marginRight(), f->height() + f->marginTop() + f->marginBottom()))
333             , everHadLayout(f->m_everHadLayout)
334         {
335         }
336
337         RenderBox* object;
338         IntRect rect;
339         bool everHadLayout;
340     };
341
342     struct FloatingObject : Noncopyable {
343         enum Type {
344             FloatLeft,
345             FloatRight
346         };
347
348         FloatingObject(Type type)
349             : m_renderer(0)
350             , m_top(0)
351             , m_bottom(0)
352             , m_left(0)
353             , m_width(0)
354             , m_paginationStrut(0)
355             , m_type(type)
356             , m_shouldPaint(true)
357             , m_isDescendant(false)
358         {
359         }
360
361         Type type() { return static_cast<Type>(m_type); }
362
363         RenderBox* m_renderer;
364         int m_top;
365         int m_bottom;
366         int m_left;
367         int m_width;
368         int m_paginationStrut;
369         unsigned m_type : 1; // Type (left or right aligned)
370         bool m_shouldPaint : 1;
371         bool m_isDescendant : 1;
372     };
373
374     // The following functions' implementations are in RenderBlockLineLayout.cpp.
375     RootInlineBox* determineStartPosition(bool& firstLine, bool& fullLayout, bool& previousLineBrokeCleanly,
376                                           InlineBidiResolver&, Vector<FloatWithRect>& floats, unsigned& numCleanFloats,
377                                           bool& useRepaintBounds, int& repaintTop, int& repaintBottom);
378     RootInlineBox* determineEndPosition(RootInlineBox* startBox, InlineIterator& cleanLineStart,
379                                         BidiStatus& cleanLineBidiStatus,
380                                         int& yPos);
381     bool matchedEndLine(const InlineBidiResolver&, const InlineIterator& endLineStart, const BidiStatus& endLineStatus,
382                         RootInlineBox*& endLine, int& endYPos, int& repaintBottom, int& repaintTop);
383
384     void skipTrailingWhitespace(InlineIterator&, bool isLineEmpty, bool previousLineBrokeCleanly);
385     int skipLeadingWhitespace(InlineBidiResolver&, bool firstLine, bool isLineEmpty, bool previousLineBrokeCleanly, FloatingObject* lastFloatFromPreviousLine);
386     void fitBelowFloats(int widthToFit, bool firstLine, int& availableWidth);
387     InlineIterator findNextLineBreak(InlineBidiResolver&, bool firstLine, bool& isLineEmpty, bool& previousLineBrokeCleanly, bool& hyphenated, EClear*, FloatingObject* lastFloatFromPreviousLine);
388     RootInlineBox* constructLine(unsigned runCount, BidiRun* firstRun, BidiRun* lastRun, bool firstLine, bool lastLine, RenderObject* endObject);
389     InlineFlowBox* createLineBoxes(RenderObject*, bool firstLine);
390     void computeInlineDirectionPositionsForLine(RootInlineBox*, bool firstLine, BidiRun* firstRun, BidiRun* trailingSpaceRun, bool reachedEnd, GlyphOverflowAndFallbackFontsMap&);
391     void computeBlockDirectionPositionsForLine(RootInlineBox*, BidiRun*, GlyphOverflowAndFallbackFontsMap&);
392     void deleteEllipsisLineBoxes();
393     void checkLinesForTextOverflow();
394     void addOverflowFromInlineChildren();
395     // End of functions defined in RenderBlockLineLayout.cpp.
396
397     void addOverflowFromBlockChildren();
398     void addOverflowFromFloats();
399
400     void paintFloats(PaintInfo&, int tx, int ty, bool preservePhase = false);
401     void paintContents(PaintInfo&, int tx, int ty);
402     void paintColumnContents(PaintInfo&, int tx, int ty, bool paintFloats = false);
403     void paintColumnRules(PaintInfo&, int tx, int ty);
404     void paintChildren(PaintInfo&, int tx, int ty);
405     void paintEllipsisBoxes(PaintInfo&, int tx, int ty);
406     void paintSelection(PaintInfo&, int tx, int ty);
407     void paintCaret(PaintInfo&, int tx, int ty, CaretType);
408
409     FloatingObject* insertFloatingObject(RenderBox*);
410     void removeFloatingObject(RenderBox*);
411     void removeFloatingObjectsBelow(FloatingObject*, int y);
412     
413     // Called from lineWidth, to position the floats added in the last line.
414     // Returns true if and only if it has positioned any floats.
415     bool positionNewFloats();
416     
417     // Positions new floats and also adjust all floats encountered on the line if any of them
418     // have to move to the next page/column.
419     bool positionNewFloatOnLine(FloatingObject* newFloat, FloatingObject* lastFloatFromPreviousLine);
420
421     void clearFloats();
422     int getClearDelta(RenderBox* child, int yPos);
423
424     virtual bool avoidsFloats() const;
425
426     bool hasOverhangingFloats() { return parent() && !hasColumns() && floatBottom() > height(); }
427     void addIntrudingFloats(RenderBlock* prev, int xoffset, int yoffset);
428     int addOverhangingFloats(RenderBlock* child, int xoffset, int yoffset, bool makeChildPaintOtherFloats);
429
430     int nextFloatBottomBelow(int) const;
431     int floatBottom() const;
432     inline int leftBottom();
433     inline int rightBottom();
434
435     virtual bool hitTestColumns(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
436     virtual bool hitTestContents(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
437     bool hitTestFloats(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty);
438
439     virtual bool isPointInOverflowControl(HitTestResult&, int x, int y, int tx, int ty);
440
441     void computeInlinePreferredLogicalWidths();
442     void computeBlockPreferredLogicalWidths();
443
444     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
445     // children.
446     virtual RenderBlock* firstLineBlock() const;
447
448     virtual IntRect rectWithOutlineForRepaint(RenderBoxModelObject* repaintContainer, int outlineWidth);
449     virtual RenderStyle* outlineStyleForRepaint() const;
450     
451     virtual RenderObject* hoverAncestor() const;
452     virtual void updateDragState(bool dragOn);
453     virtual void childBecameNonInline(RenderObject* child);
454
455     virtual IntRect selectionRectForRepaint(RenderBoxModelObject* repaintContainer, bool /*clipToVisibleContent*/)
456     {
457         return selectionGapRectsForRepaint(repaintContainer);
458     }
459     virtual bool shouldPaintSelectionGaps() const;
460     bool isSelectionRoot() const;
461     GapRects fillSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
462                                int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* = 0);
463     GapRects fillInlineSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
464                                      int& lastTop, int& lastLeft, int& lastRight, const PaintInfo*);
465     GapRects fillBlockSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
466                                     int& lastTop, int& lastLeft, int& lastRight, const PaintInfo*);
467     IntRect fillVerticalSelectionGap(int lastTop, int lastLeft, int lastRight, int bottomY, RenderBlock* rootBlock,
468                                      int blockX, int blockY, const PaintInfo*);
469     int leftSelectionOffset(RenderBlock* rootBlock, int y);
470     int rightSelectionOffset(RenderBlock* rootBlock, int y);
471
472     virtual void absoluteRects(Vector<IntRect>&, int tx, int ty);
473     virtual void absoluteQuads(Vector<FloatQuad>&);
474
475     int desiredColumnWidth() const;
476     unsigned desiredColumnCount() const;
477     void setDesiredColumnCountAndWidth(int count, int width);
478
479     void paintContinuationOutlines(PaintInfo&, int tx, int ty);
480
481     virtual IntRect localCaretRect(InlineBox*, int caretOffset, int* extraWidthToEndOfLine = 0);
482
483     virtual void addFocusRingRects(Vector<IntRect>&, int tx, int ty);
484
485     void adjustPointToColumnContents(IntPoint&) const;
486     void adjustForBorderFit(int x, int& left, int& right) const; // Helper function for borderFitAdjust
487
488     void markLinesDirtyInVerticalRange(int top, int bottom, RootInlineBox* highest = 0);
489
490     void newLine(EClear);
491
492     Position positionForBox(InlineBox*, bool start = true) const;
493     Position positionForRenderer(RenderObject*, bool start = true) const;
494     VisiblePosition positionForPointWithInlineChildren(const IntPoint&);
495
496     // Adjust tx and ty from painting offsets to the local coords of this renderer
497     void offsetForContents(int& tx, int& ty) const;
498
499     void calcColumnWidth();
500     bool layoutColumns(bool hasSpecifiedPageHeight, int pageHeight, LayoutStateMaintainer&);
501     void makeChildrenAnonymousColumnBlocks(RenderObject* beforeChild, RenderBlock* newBlockBox, RenderObject* newChild);
502
503     bool expandsToEncloseOverhangingFloats() const;
504
505     void updateScrollInfoAfterLayout();
506
507     RenderObject* splitAnonymousBlocksAroundChild(RenderObject* beforeChild);
508     void splitBlocks(RenderBlock* fromBlock, RenderBlock* toBlock, RenderBlock* middleBlock,
509                      RenderObject* beforeChild, RenderBoxModelObject* oldCont);
510     void splitFlow(RenderObject* beforeChild, RenderBlock* newBlockBox,
511                    RenderObject* newChild, RenderBoxModelObject* oldCont);
512     RenderBlock* clone() const;
513     RenderBlock* continuationBefore(RenderObject* beforeChild);
514     RenderBlock* containingColumnsBlock(bool allowAnonymousColumnBlock = true);
515     RenderBlock* columnsBlockForSpanningElement(RenderObject* newChild);
516
517     class MarginInfo {
518         // Collapsing flags for whether we can collapse our margins with our children's margins.
519         bool m_canCollapseWithChildren : 1;
520         bool m_canCollapseMarginBeforeWithChildren : 1;
521         bool m_canCollapseMarginAfterWithChildren : 1;
522
523         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
524         // margins in our container.  Table cells and the body are the common examples. We
525         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
526         bool m_quirkContainer : 1;
527
528         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.  
529         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
530         // always be collapsing with one another.  This variable can remain set to true through multiple iterations 
531         // as long as we keep encountering self-collapsing blocks.
532         bool m_atBeforeSideOfBlock : 1;
533
534         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
535         bool m_atAfterSideOfBlock : 1;
536
537         // These variables are used to detect quirky margins that we need to collapse away (in table cells
538         // and in the body element).
539         bool m_marginBeforeQuirk : 1;
540         bool m_marginAfterQuirk : 1;
541         bool m_determinedMarginBeforeQuirk : 1;
542
543         // These flags track the previous maximal positive and negative margins.
544         int m_posMargin;
545         int m_negMargin;
546
547     public:
548         MarginInfo(RenderBlock* b, int beforeBorderPadding, int afterBorderPadding);
549
550         void setAtBeforeSideOfBlock(bool b) { m_atBeforeSideOfBlock = b; }
551         void setAtAfterSideOfBlock(bool b) { m_atAfterSideOfBlock = b; }
552         void clearMargin() { m_posMargin = m_negMargin = 0; }
553         void setMarginBeforeQuirk(bool b) { m_marginBeforeQuirk = b; }
554         void setMarginAfterQuirk(bool b) { m_marginAfterQuirk = b; }
555         void setDeterminedMarginBeforeQuirk(bool b) { m_determinedMarginBeforeQuirk = b; }
556         void setPosMargin(int p) { m_posMargin = p; }
557         void setNegMargin(int n) { m_negMargin = n; }
558         void setPosMarginIfLarger(int p) { if (p > m_posMargin) m_posMargin = p; }
559         void setNegMarginIfLarger(int n) { if (n > m_negMargin) m_negMargin = n; }
560
561         void setMargin(int p, int n) { m_posMargin = p; m_negMargin = n; }
562
563         bool atBeforeSideOfBlock() const { return m_atBeforeSideOfBlock; }
564         bool canCollapseWithMarginBefore() const { return m_atBeforeSideOfBlock && m_canCollapseMarginBeforeWithChildren; }
565         bool canCollapseWithMarginAfter() const { return m_atAfterSideOfBlock && m_canCollapseMarginAfterWithChildren; }
566         bool canCollapseMarginBeforeWithChildren() const { return m_canCollapseMarginBeforeWithChildren; }
567         bool canCollapseMarginAfterWithChildren() const { return m_canCollapseMarginAfterWithChildren; }
568         bool quirkContainer() const { return m_quirkContainer; }
569         bool determinedMarginBeforeQuirk() const { return m_determinedMarginBeforeQuirk; }
570         bool marginBeforeQuirk() const { return m_marginBeforeQuirk; }
571         bool marginAfterQuirk() const { return m_marginAfterQuirk; }
572         int posMargin() const { return m_posMargin; }
573         int negMargin() const { return m_negMargin; }
574         int margin() const { return m_posMargin - m_negMargin; }
575     };
576
577     void layoutBlockChild(RenderBox* child, MarginInfo&, int& previousFloatBottom, int& maxFloatBottom);
578     void adjustPositionedBlock(RenderBox* child, const MarginInfo&);
579     void adjustFloatingBlock(const MarginInfo&);
580     bool handleSpecialChild(RenderBox* child, const MarginInfo&);
581     bool handleFloatingChild(RenderBox* child, const MarginInfo&);
582     bool handlePositionedChild(RenderBox* child, const MarginInfo&);
583     bool handleRunInChild(RenderBox* child);
584     int collapseMargins(RenderBox* child, MarginInfo&);
585     int clearFloatsIfNeeded(RenderBox* child, MarginInfo&, int oldTopPosMargin, int oldTopNegMargin, int yPos);
586     int estimateLogicalTopPosition(RenderBox* child, const MarginInfo&);
587     void determineLogicalLeftPositionForChild(RenderBox* child);
588     void handleAfterSideOfBlock(int top, int bottom, MarginInfo&);
589     void setCollapsedBottomMargin(const MarginInfo&);
590     // End helper functions and structs used by layoutBlockChildren.
591
592     // Pagination routines.
593     int nextPageTop(int yPos) const; // Returns the top of the next page following yPos.
594     int applyBeforeBreak(RenderBox* child, int yPos); // If the child has a before break, then return a new yPos that shifts to the top of the next page/column.
595     int applyAfterBreak(RenderBox* child, int yPos, MarginInfo& marginInfo); // If the child has an after break, then return a new yPos that shifts to the top of the next page/column.
596     int adjustForUnsplittableChild(RenderBox* child, int yPos, bool includeMargins = false); // If the child is unsplittable and can't fit on the current page, return the top of the next page/column.
597     void adjustLinePositionForPagination(RootInlineBox*, int& deltaY); // Computes a deltaY value that put a line at the top of the next page if it doesn't fit on the current page.
598
599     typedef PositionedObjectsListHashSet::const_iterator Iterator;
600     DeprecatedPtrList<FloatingObject>* m_floatingObjects;
601     
602     PositionedObjectsListHashSet* m_positionedObjects;
603
604     // An inline can be split with blocks occurring in between the inline content.
605     // When this occurs we need a pointer to our next object.  We can basically be
606     // split into a sequence of inlines and blocks.  The continuation will either be
607     // an anonymous block (that houses other blocks) or it will be an inline flow.
608     RenderBoxModelObject* m_continuation;
609
610     // Allocated only when some of these fields have non-default values
611     struct RenderBlockRareData : Noncopyable {
612         RenderBlockRareData(const RenderBlock* block) 
613             : m_beforePos(beforePosDefault(block))
614             , m_beforeNeg(beforeNegDefault(block))
615             , m_afterPos(afterPosDefault(block))
616             , m_afterNeg(afterNegDefault(block))
617             , m_paginationStrut(0)
618             , m_pageY(0)
619         { 
620         }
621
622         static int beforePosDefault(const RenderBlock* block)
623         { 
624             return std::max(block->marginBefore(), 0);
625         }
626         
627         static int beforeNegDefault(const RenderBlock* block)
628         { 
629             return std::max(-block->marginBefore(), 0);
630         }
631         static int afterPosDefault(const RenderBlock* block)
632         {
633             return std::max(block->marginAfter(), 0);
634         }
635         static int afterNegDefault(const RenderBlock* block)
636         {
637             return std::max(-block->marginAfter(), 0);
638         }
639         
640         int m_beforePos;
641         int m_beforeNeg;
642         int m_afterPos;
643         int m_afterNeg;
644         int m_paginationStrut;
645         int m_pageY;
646      };
647
648     OwnPtr<RenderBlockRareData> m_rareData;
649
650     RenderObjectChildList m_children;
651     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>.
652
653     mutable int m_lineHeight;
654
655     // RenderRubyBase objects need to be able to split and merge, moving their children around
656     // (calling moveChildTo, moveAllChildrenTo, and makeChildrenNonInline).
657     friend class RenderRubyBase;
658 };
659
660 inline RenderBlock* toRenderBlock(RenderObject* object)
661
662     ASSERT(!object || object->isRenderBlock());
663     return static_cast<RenderBlock*>(object);
664 }
665
666 inline const RenderBlock* toRenderBlock(const RenderObject* object)
667
668     ASSERT(!object || object->isRenderBlock());
669     return static_cast<const RenderBlock*>(object);
670 }
671
672 // This will catch anyone doing an unnecessary cast.
673 void toRenderBlock(const RenderBlock*);
674
675 } // namespace WebCore
676
677 #endif // RenderBlock_h