https://bugs.webkit.org/show_bug.cgi?id=47021
[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     class MarginValues {
190     public:
191         MarginValues(int beforePos, int beforeNeg, int afterPos, int afterNeg)
192             : m_positiveMarginBefore(beforePos)
193             , m_negativeMarginBefore(beforeNeg)
194             , m_positiveMarginAfter(afterPos)
195             , m_negativeMarginAfter(afterNeg)
196         { }
197         
198         int positiveMarginBefore() const { return m_positiveMarginBefore; }
199         int negativeMarginBefore() const { return m_negativeMarginBefore; }
200         int positiveMarginAfter() const { return m_positiveMarginAfter; }
201         int negativeMarginAfter() const { return m_negativeMarginAfter; }
202         
203         void setPositiveMarginBefore(int pos) { m_positiveMarginBefore = pos; }
204         void setNegativeMarginBefore(int neg) { m_negativeMarginBefore = neg; }
205         void setPositiveMarginAfter(int pos) { m_positiveMarginAfter = pos; }
206         void setNegativeMarginAfter(int neg) { m_negativeMarginAfter = neg; }
207     
208     private:
209         int m_positiveMarginBefore;
210         int m_negativeMarginBefore;
211         int m_positiveMarginAfter;
212         int m_negativeMarginAfter;
213     };
214     MarginValues marginValuesForChild(RenderBox* child);
215
216 protected:
217     // These functions are only used internally to manipulate the render tree structure via remove/insert/appendChildNode.
218     // Since they are typically called only to move objects around within anonymous blocks (which only have layers in
219     // the case of column spans), the default for fullRemoveInsert is false rather than true.
220     void moveChildTo(RenderBlock* to, RenderObject* child, bool fullRemoveInsert = false)
221     {
222         return moveChildTo(to, child, 0, fullRemoveInsert);
223     }
224     void moveChildTo(RenderBlock* to, RenderObject* child, RenderObject* beforeChild, bool fullRemoveInsert = false);
225     void moveAllChildrenTo(RenderBlock* to, bool fullRemoveInsert = false)
226     {
227         return moveAllChildrenTo(to, 0, fullRemoveInsert);
228     }
229     void moveAllChildrenTo(RenderBlock* to, RenderObject* beforeChild, bool fullRemoveInsert = false)
230     {
231         return moveChildrenTo(to, firstChild(), 0, beforeChild, fullRemoveInsert);
232     }
233     // Move all of the kids from |startChild| up to but excluding |endChild|.  0 can be passed as the endChild to denote
234     // that all the kids from |startChild| onwards should be added.
235     void moveChildrenTo(RenderBlock* to, RenderObject* startChild, RenderObject* endChild, bool fullRemoveInsert = false)
236     {
237         return moveChildrenTo(to, startChild, endChild, 0, fullRemoveInsert);
238     }
239     void moveChildrenTo(RenderBlock* to, RenderObject* startChild, RenderObject* endChild, RenderObject* beforeChild, bool fullRemoveInsert = false);
240     
241     int maxPositiveMarginBefore() const { return m_rareData ? m_rareData->m_margins.positiveMarginBefore() : RenderBlockRareData::positiveMarginBeforeDefault(this); }
242     int maxNegativeMarginBefore() const { return m_rareData ? m_rareData->m_margins.negativeMarginBefore() : RenderBlockRareData::negativeMarginBeforeDefault(this); }
243     int maxPositiveMarginAfter() const { return m_rareData ? m_rareData->m_margins.positiveMarginAfter() : RenderBlockRareData::positiveMarginAfterDefault(this); }
244     int maxNegativeMarginAfter() const { return m_rareData ? m_rareData->m_margins.negativeMarginAfter() : RenderBlockRareData::negativeMarginAfterDefault(this); }
245     
246     void setMaxMarginBeforeValues(int pos, int neg);
247     void setMaxMarginAfterValues(int pos, int neg);
248
249     void initMaxMarginValues()
250     {
251         if (m_rareData) {
252             m_rareData->m_margins = MarginValues(RenderBlockRareData::positiveMarginBeforeDefault(this) , RenderBlockRareData::negativeMarginBeforeDefault(this),
253                                                  RenderBlockRareData::positiveMarginAfterDefault(this), RenderBlockRareData::negativeMarginAfterDefault(this));
254             m_rareData->m_paginationStrut = 0;
255         }
256     }
257
258     virtual void layout();
259
260     void layoutPositionedObjects(bool relayoutChildren);
261
262     virtual void paint(PaintInfo&, int tx, int ty);
263     virtual void paintObject(PaintInfo&, int tx, int ty);
264
265     int logicalRightOffsetForContent() const { return style()->isVerticalBlockFlow() ? borderLeft() + paddingLeft() + availableLogicalWidth() : borderTop() + paddingTop() + availableLogicalWidth(); }
266     int logicalLeftOffsetForContent() const { return style()->isVerticalBlockFlow() ? borderLeft() + paddingLeft() : borderTop() + paddingTop(); }
267     int logicalRightOffsetForLine(int position, int fixedOffset, bool applyTextIndent = true, int* logicalHeightRemaining = 0) const;
268     int logicalLeftOffsetForLine(int position, int fixedOffset, bool applyTextIndent = true, int* logicalHeightRemaining = 0) const;
269
270     virtual bool nodeAtPoint(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
271
272     virtual void computePreferredLogicalWidths();
273
274     virtual int firstLineBoxBaseline() const;
275     virtual int lastLineBoxBaseline() const;
276
277     virtual void updateFirstLetter();
278
279     virtual void updateHitTestResult(HitTestResult&, const IntPoint&);
280
281     // Delay update scrollbar until finishDelayRepaint() will be
282     // called. This function is used when a flexbox is laying out its
283     // descendant. If multiple calls are made to startDelayRepaint(),
284     // finishDelayRepaint() will do nothing until finishDelayRepaint()
285     // is called the same number of times.
286     static void startDelayUpdateScrollInfo();
287     static void finishDelayUpdateScrollInfo();
288
289     virtual void styleWillChange(StyleDifference, const RenderStyle* newStyle);
290     virtual void styleDidChange(StyleDifference, const RenderStyle* oldStyle);
291
292     virtual bool hasLineIfEmpty() const;
293     bool layoutOnlyPositionedObjects();
294
295 #if ENABLE(SVG)
296 protected:
297
298     // Only used by RenderSVGText, which explicitely overrides RenderBlock::layoutBlock(), do NOT use for anything else.
299     void forceLayoutInlineChildren()
300     {
301         int repaintTop = 0;
302         int repaintBottom = 0;
303         layoutInlineChildren(true, repaintTop, repaintBottom);
304     }
305 #endif
306
307 private:
308     virtual RenderObjectChildList* virtualChildren() { return children(); }
309     virtual const RenderObjectChildList* virtualChildren() const { return children(); }
310
311     virtual const char* renderName() const;
312
313     virtual bool isRenderBlock() const { return true; }
314     virtual bool isBlockFlow() const { return (!isInline() || isReplaced()) && !isTable(); }
315     virtual bool isInlineBlockOrInlineTable() const { return isInline() && isReplaced(); }
316
317     void makeChildrenNonInline(RenderObject* insertionPoint = 0);
318     virtual void removeLeftoverAnonymousBlock(RenderBlock* child);
319
320     virtual void dirtyLinesFromChangedChild(RenderObject* child) { m_lineBoxes.dirtyLinesFromChangedChild(this, child); }
321
322     void addChildToContinuation(RenderObject* newChild, RenderObject* beforeChild);
323     void addChildIgnoringContinuation(RenderObject* newChild, RenderObject* beforeChild);
324     void addChildToAnonymousColumnBlocks(RenderObject* newChild, RenderObject* beforeChild);
325     virtual void addChildIgnoringAnonymousColumnBlocks(RenderObject* newChild, RenderObject* beforeChild = 0);
326     
327     virtual bool isSelfCollapsingBlock() const;
328
329     virtual int collapsedMarginBefore() const { return maxPositiveMarginBefore() - maxNegativeMarginBefore(); }
330     virtual int collapsedMarginAfter() const { return maxPositiveMarginAfter() - maxNegativeMarginAfter(); }
331
332     virtual void repaintOverhangingFloats(bool paintAllDescendants);
333
334     void layoutBlockChildren(bool relayoutChildren, int& maxFloatLogicalBottom);
335     void layoutInlineChildren(bool relayoutChildren, int& repaintTop, int& repaintBottom);
336
337     virtual void positionListMarker() { }
338
339     virtual void borderFitAdjust(int& x, int& w) const; // Shrink the box in which the border paints if border-fit is set.
340
341     virtual void updateBeforeAfterContent(PseudoId);
342
343     virtual RootInlineBox* createRootInlineBox(); // Subclassed by SVG and Ruby.
344
345     // Called to lay out the legend for a fieldset.
346     virtual RenderObject* layoutLegend(bool /*relayoutChildren*/) { return 0; }
347
348     struct FloatWithRect {
349         FloatWithRect(RenderBox* f)
350             : object(f)
351             , rect(IntRect(f->x() - f->marginLeft(), f->y() - f->marginTop(), f->width() + f->marginLeft() + f->marginRight(), f->height() + f->marginTop() + f->marginBottom()))
352             , everHadLayout(f->m_everHadLayout)
353         {
354         }
355
356         RenderBox* object;
357         IntRect rect;
358         bool everHadLayout;
359     };
360
361     struct FloatingObject : Noncopyable {
362         // Note that Type uses bits so you can use FloatBoth as a mask to query for both left and right.
363         enum Type { FloatLeft = 1, FloatRight = 2, FloatBoth = 3 };
364     
365         FloatingObject(Type type, const IntRect& frameRect = IntRect())
366             : m_renderer(0)
367             , m_frameRect(frameRect)
368             , m_paginationStrut(0)
369             , m_type(type)
370             , m_shouldPaint(true)
371             , m_isDescendant(false)
372         {
373         }
374
375         Type type() { return static_cast<Type>(m_type); }
376
377         int left() const { return m_frameRect.x(); }
378         int right() const { return m_frameRect.right(); }
379         int top() const { return m_frameRect.y(); }
380         int bottom() const { return m_frameRect.bottom(); }
381         int width() const { return m_frameRect.width(); }
382         int height() const { return m_frameRect.height(); }
383     
384         void setLeft(int left) { m_frameRect.setX(left); }
385         void setTop(int top) { m_frameRect.setY(top); }
386         void setWidth(int width) { m_frameRect.setWidth(width); }
387         void setHeight(int height) { m_frameRect.setHeight(height); }
388
389         const IntRect& frameRect() const { return m_frameRect; }
390         void setFrameRect(const IntRect& frameRect) { m_frameRect = frameRect; }
391
392         RenderBox* m_renderer;
393         IntRect m_frameRect;
394         int m_paginationStrut;
395         unsigned m_type : 2; // Type (left or right aligned)
396         bool m_shouldPaint : 1;
397         bool m_isDescendant : 1;
398     };
399
400     int logicalBottomForFloat(FloatingObject* child) const { return style()->isVerticalBlockFlow() ? child->bottom() : child->right(); }
401     
402     // The following functions' implementations are in RenderBlockLineLayout.cpp.
403     RootInlineBox* determineStartPosition(bool& firstLine, bool& fullLayout, bool& previousLineBrokeCleanly,
404                                           InlineBidiResolver&, Vector<FloatWithRect>& floats, unsigned& numCleanFloats,
405                                           bool& useRepaintBounds, int& repaintTop, int& repaintBottom);
406     RootInlineBox* determineEndPosition(RootInlineBox* startBox, InlineIterator& cleanLineStart,
407                                         BidiStatus& cleanLineBidiStatus,
408                                         int& yPos);
409     bool matchedEndLine(const InlineBidiResolver&, const InlineIterator& endLineStart, const BidiStatus& endLineStatus,
410                         RootInlineBox*& endLine, int& endYPos, int& repaintBottom, int& repaintTop);
411
412     void skipTrailingWhitespace(InlineIterator&, bool isLineEmpty, bool previousLineBrokeCleanly);
413     int skipLeadingWhitespace(InlineBidiResolver&, bool firstLine, bool isLineEmpty, bool previousLineBrokeCleanly, FloatingObject* lastFloatFromPreviousLine);
414     void fitBelowFloats(int widthToFit, bool firstLine, int& availableWidth);
415     InlineIterator findNextLineBreak(InlineBidiResolver&, bool firstLine, bool& isLineEmpty, bool& previousLineBrokeCleanly, bool& hyphenated, EClear*, FloatingObject* lastFloatFromPreviousLine);
416     RootInlineBox* constructLine(unsigned runCount, BidiRun* firstRun, BidiRun* lastRun, bool firstLine, bool lastLine, RenderObject* endObject);
417     InlineFlowBox* createLineBoxes(RenderObject*, bool firstLine);
418     void computeInlineDirectionPositionsForLine(RootInlineBox*, bool firstLine, BidiRun* firstRun, BidiRun* trailingSpaceRun, bool reachedEnd, GlyphOverflowAndFallbackFontsMap&);
419     void computeBlockDirectionPositionsForLine(RootInlineBox*, BidiRun*, GlyphOverflowAndFallbackFontsMap&);
420     void deleteEllipsisLineBoxes();
421     void checkLinesForTextOverflow();
422     void addOverflowFromInlineChildren();
423     // End of functions defined in RenderBlockLineLayout.cpp.
424
425     void addOverflowFromBlockChildren();
426     void addOverflowFromFloats();
427
428     void paintFloats(PaintInfo&, int tx, int ty, bool preservePhase = false);
429     void paintContents(PaintInfo&, int tx, int ty);
430     void paintColumnContents(PaintInfo&, int tx, int ty, bool paintFloats = false);
431     void paintColumnRules(PaintInfo&, int tx, int ty);
432     void paintChildren(PaintInfo&, int tx, int ty);
433     void paintEllipsisBoxes(PaintInfo&, int tx, int ty);
434     void paintSelection(PaintInfo&, int tx, int ty);
435     void paintCaret(PaintInfo&, int tx, int ty, CaretType);
436
437     FloatingObject* insertFloatingObject(RenderBox*);
438     void removeFloatingObject(RenderBox*);
439     void removeFloatingObjectsBelow(FloatingObject*, int y);
440     
441     // Called from lineWidth, to position the floats added in the last line.
442     // Returns true if and only if it has positioned any floats.
443     bool positionNewFloats();
444     
445     // Positions new floats and also adjust all floats encountered on the line if any of them
446     // have to move to the next page/column.
447     bool positionNewFloatOnLine(FloatingObject* newFloat, FloatingObject* lastFloatFromPreviousLine);
448
449     void clearFloats();
450     int getClearDelta(RenderBox* child, int yPos);
451
452     virtual bool avoidsFloats() const;
453
454     bool hasOverhangingFloats() { return parent() && !hasColumns() && lowestFloatLogicalBottom() > logicalHeight(); }
455     void addIntrudingFloats(RenderBlock* prev, int xoffset, int yoffset);
456     int addOverhangingFloats(RenderBlock* child, int xoffset, int yoffset, bool makeChildPaintOtherFloats);
457
458     int lowestFloatLogicalBottom(FloatingObject::Type = FloatingObject::FloatBoth) const;
459     int nextFloatLogicalBottomBelow(int) const;
460     
461     virtual bool hitTestColumns(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
462     virtual bool hitTestContents(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty, HitTestAction);
463     bool hitTestFloats(const HitTestRequest&, HitTestResult&, int x, int y, int tx, int ty);
464
465     virtual bool isPointInOverflowControl(HitTestResult&, int x, int y, int tx, int ty);
466
467     void computeInlinePreferredLogicalWidths();
468     void computeBlockPreferredLogicalWidths();
469
470     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
471     // children.
472     virtual RenderBlock* firstLineBlock() const;
473
474     virtual IntRect rectWithOutlineForRepaint(RenderBoxModelObject* repaintContainer, int outlineWidth);
475     virtual RenderStyle* outlineStyleForRepaint() const;
476     
477     virtual RenderObject* hoverAncestor() const;
478     virtual void updateDragState(bool dragOn);
479     virtual void childBecameNonInline(RenderObject* child);
480
481     virtual IntRect selectionRectForRepaint(RenderBoxModelObject* repaintContainer, bool /*clipToVisibleContent*/)
482     {
483         return selectionGapRectsForRepaint(repaintContainer);
484     }
485     virtual bool shouldPaintSelectionGaps() const;
486     bool isSelectionRoot() const;
487     GapRects fillSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
488                                int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* = 0);
489     GapRects fillInlineSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
490                                      int& lastTop, int& lastLeft, int& lastRight, const PaintInfo*);
491     GapRects fillBlockSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
492                                     int& lastTop, int& lastLeft, int& lastRight, const PaintInfo*);
493     IntRect fillVerticalSelectionGap(int lastTop, int lastLeft, int lastRight, int bottomY, RenderBlock* rootBlock,
494                                      int blockX, int blockY, const PaintInfo*);
495     int leftSelectionOffset(RenderBlock* rootBlock, int y);
496     int rightSelectionOffset(RenderBlock* rootBlock, int y);
497
498     virtual void absoluteRects(Vector<IntRect>&, int tx, int ty);
499     virtual void absoluteQuads(Vector<FloatQuad>&);
500
501     int desiredColumnWidth() const;
502     unsigned desiredColumnCount() const;
503     void setDesiredColumnCountAndWidth(int count, int width);
504
505     void paintContinuationOutlines(PaintInfo&, int tx, int ty);
506
507     virtual IntRect localCaretRect(InlineBox*, int caretOffset, int* extraWidthToEndOfLine = 0);
508
509     virtual void addFocusRingRects(Vector<IntRect>&, int tx, int ty);
510
511     void adjustPointToColumnContents(IntPoint&) const;
512     void adjustForBorderFit(int x, int& left, int& right) const; // Helper function for borderFitAdjust
513
514     void markLinesDirtyInVerticalRange(int top, int bottom, RootInlineBox* highest = 0);
515
516     void newLine(EClear);
517
518     Position positionForBox(InlineBox*, bool start = true) const;
519     Position positionForRenderer(RenderObject*, bool start = true) const;
520     VisiblePosition positionForPointWithInlineChildren(const IntPoint&);
521
522     // Adjust tx and ty from painting offsets to the local coords of this renderer
523     void offsetForContents(int& tx, int& ty) const;
524
525     void calcColumnWidth();
526     bool layoutColumns(bool hasSpecifiedPageHeight, int pageHeight, LayoutStateMaintainer&);
527     void makeChildrenAnonymousColumnBlocks(RenderObject* beforeChild, RenderBlock* newBlockBox, RenderObject* newChild);
528
529     bool expandsToEncloseOverhangingFloats() const;
530
531     void updateScrollInfoAfterLayout();
532
533     RenderObject* splitAnonymousBlocksAroundChild(RenderObject* beforeChild);
534     void splitBlocks(RenderBlock* fromBlock, RenderBlock* toBlock, RenderBlock* middleBlock,
535                      RenderObject* beforeChild, RenderBoxModelObject* oldCont);
536     void splitFlow(RenderObject* beforeChild, RenderBlock* newBlockBox,
537                    RenderObject* newChild, RenderBoxModelObject* oldCont);
538     RenderBlock* clone() const;
539     RenderBlock* continuationBefore(RenderObject* beforeChild);
540     RenderBlock* containingColumnsBlock(bool allowAnonymousColumnBlock = true);
541     RenderBlock* columnsBlockForSpanningElement(RenderObject* newChild);
542
543     class MarginInfo {
544         // Collapsing flags for whether we can collapse our margins with our children's margins.
545         bool m_canCollapseWithChildren : 1;
546         bool m_canCollapseMarginBeforeWithChildren : 1;
547         bool m_canCollapseMarginAfterWithChildren : 1;
548
549         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
550         // margins in our container.  Table cells and the body are the common examples. We
551         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
552         bool m_quirkContainer : 1;
553
554         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.  
555         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
556         // always be collapsing with one another.  This variable can remain set to true through multiple iterations 
557         // as long as we keep encountering self-collapsing blocks.
558         bool m_atBeforeSideOfBlock : 1;
559
560         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
561         bool m_atAfterSideOfBlock : 1;
562
563         // These variables are used to detect quirky margins that we need to collapse away (in table cells
564         // and in the body element).
565         bool m_marginBeforeQuirk : 1;
566         bool m_marginAfterQuirk : 1;
567         bool m_determinedMarginBeforeQuirk : 1;
568
569         // These flags track the previous maximal positive and negative margins.
570         int m_positiveMargin;
571         int m_negativeMargin;
572
573     public:
574         MarginInfo(RenderBlock* b, int beforeBorderPadding, int afterBorderPadding);
575
576         void setAtBeforeSideOfBlock(bool b) { m_atBeforeSideOfBlock = b; }
577         void setAtAfterSideOfBlock(bool b) { m_atAfterSideOfBlock = b; }
578         void clearMargin() { m_positiveMargin = m_negativeMargin = 0; }
579         void setMarginBeforeQuirk(bool b) { m_marginBeforeQuirk = b; }
580         void setMarginAfterQuirk(bool b) { m_marginAfterQuirk = b; }
581         void setDeterminedMarginBeforeQuirk(bool b) { m_determinedMarginBeforeQuirk = b; }
582         void setPositiveMargin(int p) { m_positiveMargin = p; }
583         void setNegativeMargin(int n) { m_negativeMargin = n; }
584         void setPositiveMarginIfLarger(int p) { if (p > m_positiveMargin) m_positiveMargin = p; }
585         void setNegativeMarginIfLarger(int n) { if (n > m_negativeMargin) m_negativeMargin = n; }
586
587         void setMargin(int p, int n) { m_positiveMargin = p; m_negativeMargin = n; }
588
589         bool atBeforeSideOfBlock() const { return m_atBeforeSideOfBlock; }
590         bool canCollapseWithMarginBefore() const { return m_atBeforeSideOfBlock && m_canCollapseMarginBeforeWithChildren; }
591         bool canCollapseWithMarginAfter() const { return m_atAfterSideOfBlock && m_canCollapseMarginAfterWithChildren; }
592         bool canCollapseMarginBeforeWithChildren() const { return m_canCollapseMarginBeforeWithChildren; }
593         bool canCollapseMarginAfterWithChildren() const { return m_canCollapseMarginAfterWithChildren; }
594         bool quirkContainer() const { return m_quirkContainer; }
595         bool determinedMarginBeforeQuirk() const { return m_determinedMarginBeforeQuirk; }
596         bool marginBeforeQuirk() const { return m_marginBeforeQuirk; }
597         bool marginAfterQuirk() const { return m_marginAfterQuirk; }
598         int positiveMargin() const { return m_positiveMargin; }
599         int negativeMargin() const { return m_negativeMargin; }
600         int margin() const { return m_positiveMargin - m_negativeMargin; }
601     };
602
603     void layoutBlockChild(RenderBox* child, MarginInfo&, int& previousFloatLogicalBottom, int& maxFloatLogicalBottom);
604     void adjustPositionedBlock(RenderBox* child, const MarginInfo&);
605     void adjustFloatingBlock(const MarginInfo&);
606     bool handleSpecialChild(RenderBox* child, const MarginInfo&);
607     bool handleFloatingChild(RenderBox* child, const MarginInfo&);
608     bool handlePositionedChild(RenderBox* child, const MarginInfo&);
609     bool handleRunInChild(RenderBox* child);
610     int collapseMargins(RenderBox* child, MarginInfo&);
611     int clearFloatsIfNeeded(RenderBox* child, MarginInfo&, int oldTopPosMargin, int oldTopNegMargin, int yPos);
612     int estimateLogicalTopPosition(RenderBox* child, const MarginInfo&);
613     void determineLogicalLeftPositionForChild(RenderBox* child);
614     void handleAfterSideOfBlock(int top, int bottom, MarginInfo&);
615     void setCollapsedBottomMargin(const MarginInfo&);
616     // End helper functions and structs used by layoutBlockChildren.
617
618     // Pagination routines.
619     int nextPageTop(int yPos) const; // Returns the top of the next page following yPos.
620     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.
621     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.
622     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.
623     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.
624
625     typedef PositionedObjectsListHashSet::const_iterator Iterator;
626     DeprecatedPtrList<FloatingObject>* m_floatingObjects;
627     
628     PositionedObjectsListHashSet* m_positionedObjects;
629
630     // An inline can be split with blocks occurring in between the inline content.
631     // When this occurs we need a pointer to our next object.  We can basically be
632     // split into a sequence of inlines and blocks.  The continuation will either be
633     // an anonymous block (that houses other blocks) or it will be an inline flow.
634     RenderBoxModelObject* m_continuation;
635     
636     // Allocated only when some of these fields have non-default values
637     struct RenderBlockRareData : Noncopyable {
638         RenderBlockRareData(const RenderBlock* block) 
639             : m_margins(positiveMarginBeforeDefault(block), negativeMarginBeforeDefault(block), positiveMarginAfterDefault(block), negativeMarginAfterDefault(block))
640             , m_paginationStrut(0)
641             , m_pageY(0)
642         { 
643         }
644
645         static int positiveMarginBeforeDefault(const RenderBlock* block)
646         { 
647             return std::max(block->marginBefore(), 0);
648         }
649         
650         static int negativeMarginBeforeDefault(const RenderBlock* block)
651         { 
652             return std::max(-block->marginBefore(), 0);
653         }
654         static int positiveMarginAfterDefault(const RenderBlock* block)
655         {
656             return std::max(block->marginAfter(), 0);
657         }
658         static int negativeMarginAfterDefault(const RenderBlock* block)
659         {
660             return std::max(-block->marginAfter(), 0);
661         }
662         
663         MarginValues m_margins;
664         int m_paginationStrut;
665         int m_pageY;
666      };
667
668     OwnPtr<RenderBlockRareData> m_rareData;
669
670     RenderObjectChildList m_children;
671     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>.
672
673     mutable int m_lineHeight;
674
675     // RenderRubyBase objects need to be able to split and merge, moving their children around
676     // (calling moveChildTo, moveAllChildrenTo, and makeChildrenNonInline).
677     friend class RenderRubyBase;
678 };
679
680 inline RenderBlock* toRenderBlock(RenderObject* object)
681
682     ASSERT(!object || object->isRenderBlock());
683     return static_cast<RenderBlock*>(object);
684 }
685
686 inline const RenderBlock* toRenderBlock(const RenderObject* object)
687
688     ASSERT(!object || object->isRenderBlock());
689     return static_cast<const RenderBlock*>(object);
690 }
691
692 // This will catch anyone doing an unnecessary cast.
693 void toRenderBlock(const RenderBlock*);
694
695 } // namespace WebCore
696
697 #endif // RenderBlock_h