Fix by Mitz Pettel, reviewed by Hyatt.
[WebKit-https.git] / WebCore / rendering / RenderBlock.h
1 /*
2  * This file is part of the render object implementation for KHTML.
3  *
4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
6  * Copyright (C) 2003, 2004, 2005, 2006 Apple Computer, Inc.
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public License
19  * along with this library; see the file COPYING.LIB.  If not, write to
20  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #ifndef RenderBlock_H
25 #define RenderBlock_H
26
27 #include "GapRects.h"
28 #include "RenderFlow.h"
29 #include "RootInlineBox.h"
30
31 namespace WebCore {
32
33 class Position;
34 class RootInlineBox;
35
36 enum CaretType {
37     CursorCaret,
38     DragCaret,
39 };
40
41 class RenderBlock : public RenderFlow {
42 public:
43     RenderBlock(Node*);
44     virtual ~RenderBlock();
45
46     virtual const char *renderName() const;
47
48     // These two functions are overridden for inline-block.
49     virtual short lineHeight(bool b, bool isRootLineBox=false) const;
50     virtual short baselinePosition(bool b, bool isRootLineBox=false) const;
51     
52     virtual bool isRenderBlock() const { return true; }
53     virtual bool isBlockFlow() const { return (!isInline() || isReplaced()) && !isTable(); }
54     virtual bool isInlineFlow() const { return isInline() && !isReplaced(); }
55     virtual bool isInlineBlockOrInlineTable() const { return isInline() && isReplaced(); }
56     
57     virtual bool childrenInline() const { return m_childrenInline; }
58     virtual void setChildrenInline(bool b) { m_childrenInline = b; }
59     void makeChildrenNonInline(RenderObject* insertionPoint = 0);
60
61     // The height (and width) of a block when you include overflow spillage out of the bottom
62     // of the block (e.g., a <div style="height:25px"> that has a 100px tall image inside
63     // it would have an overflow height of borderTop() + paddingTop() + 100px.
64     virtual int overflowHeight(bool includeInterior=true) const;
65     virtual int overflowWidth(bool includeInterior=true) const;
66     virtual int overflowLeft(bool includeInterior=true) const;
67     virtual int overflowTop(bool includeInterior=true) const;
68     virtual IntRect overflowRect(bool includeInterior=true) const;
69     virtual void setOverflowHeight(int h) { m_overflowHeight = h; }
70     virtual void setOverflowWidth(int w) { m_overflowWidth = w; }
71     
72     virtual bool isSelfCollapsingBlock() const;
73     virtual bool isTopMarginQuirk() const { return m_topMarginQuirk; }
74     virtual bool isBottomMarginQuirk() const { return m_bottomMarginQuirk; }
75
76     virtual int maxTopMargin(bool positive) const {
77         if (positive)
78             return m_maxTopPosMargin;
79         else
80             return m_maxTopNegMargin;
81     }
82     virtual int maxBottomMargin(bool positive) const {
83         if (positive)
84             return m_maxBottomPosMargin;
85         else
86             return m_maxBottomNegMargin;
87     }
88
89     void initMaxMarginValues() {
90         if (m_marginTop >= 0) {
91             m_maxTopPosMargin = m_marginTop;
92             m_maxTopNegMargin = 0;
93         } else {
94             m_maxTopNegMargin = -m_marginTop;
95             m_maxTopPosMargin = 0;
96         }
97         if (m_marginBottom >= 0) {
98             m_maxBottomPosMargin = m_marginBottom;
99             m_maxBottomNegMargin = 0;
100         } else {
101             m_maxBottomNegMargin = -m_marginBottom;
102             m_maxBottomPosMargin = 0;
103         }
104     }
105
106     virtual void addChildToFlow(RenderObject* newChild, RenderObject* beforeChild);
107     virtual void removeChild(RenderObject*);
108
109     virtual void repaintObjectsBeforeLayout();
110     virtual void repaintOverhangingFloats(bool paintAllDescendants);
111     virtual void getAbsoluteRepaintRectIncludingFloats(IntRect& bounds, IntRect& fullBounds);
112
113     virtual void setStyle(RenderStyle*);
114
115     virtual void layout();
116     virtual void layoutBlock(bool relayoutChildren);
117     void layoutBlockChildren(bool relayoutChildren);
118     IntRect layoutInlineChildren(bool relayoutChildren);
119
120     void layoutPositionedObjects( bool relayoutChildren );
121     void insertPositionedObject(RenderObject *o);
122     void removePositionedObject(RenderObject *o);
123     virtual void removePositionedObjects(RenderBlock*);
124
125     virtual void positionListMarker() { }
126
127     // Called to lay out the legend for a fieldset.
128     virtual RenderObject* layoutLegend(bool relayoutChildren) { return 0; };
129     
130     // the implementation of the following functions is in bidi.cpp
131     void bidiReorderLine(const BidiIterator& start, const BidiIterator& end, BidiState &bidi );
132     RootInlineBox* determineStartPosition(bool fullLayout, BidiIterator& start, BidiState &bidi);
133     RootInlineBox* determineEndPosition(RootInlineBox* startBox, BidiIterator& cleanLineStart,
134                                         BidiStatus& cleanLineBidiStatus, BidiContext*& cleanLineBidiContext,
135                                         int& yPos);
136     bool matchedEndLine(const BidiIterator& start, const BidiStatus& status, BidiContext* context,
137                         const BidiIterator& endLineStart, const BidiStatus& endLineStatus, BidiContext* endLineContext,
138                         RootInlineBox*& endLine, int& endYPos, int& repaintBottom, int& repaintTop);
139     int skipWhitespace(BidiIterator& , BidiState &);
140     BidiIterator findNextLineBreak(BidiIterator& start, BidiState &info );
141     RootInlineBox* constructLine(const BidiIterator& start, const BidiIterator& end);
142     InlineFlowBox* createLineBoxes(RenderObject* obj);
143     int tabWidth(bool isWhitespacePre);
144     void computeHorizontalPositionsForLine(RootInlineBox* lineBox, BidiState &bidi);
145     void computeVerticalPositionsForLine(RootInlineBox* lineBox);
146     void checkLinesForOverflow();
147     void deleteEllipsisLineBoxes();
148     void checkLinesForTextOverflow();
149     // end bidi.cpp functions
150     
151     virtual void paint(PaintInfo& i, int tx, int ty);
152     virtual void paintObject(PaintInfo& i, int tx, int ty);
153     void paintFloats(PaintInfo& i, int _tx, int _ty, bool paintSelection = false);
154     void paintChildren(PaintInfo& i, int _tx, int _ty);
155     void paintEllipsisBoxes(PaintInfo& i, int _tx, int _ty);
156     void paintSelection(PaintInfo& i, int _tx, int _ty);
157     void paintCaret(PaintInfo& i, CaretType);
158     
159     void insertFloatingObject(RenderObject *o);
160     void removeFloatingObject(RenderObject *o);
161     void setPaintsFloatingObject(RenderObject*, bool);
162
163     // called from lineWidth, to position the floats added in the last line.
164     void positionNewFloats();
165     void clearFloats();
166     int getClearDelta(RenderObject *child);
167     virtual void markAllDescendantsWithFloatsForLayout(RenderObject* floatToRemove = 0);
168     void markPositionedObjectsForLayout();
169
170     // FIXME: containsFloats() should not return true if the floating objects list
171     // is empty. However, layoutInlineChildren() relies on the current behavior.
172     // http://bugzilla.opendarwin.org/show_bug.cgi?id=7395#c3
173     virtual bool containsFloats() { return m_floatingObjects!=0; }
174     virtual bool containsFloat(RenderObject* o);
175
176     virtual bool hasOverhangingFloats() { return floatBottom() > m_height; }
177     void addIntrudingFloats(RenderBlock* prev, int xoffset, int yoffset);
178     void addOverhangingFloats(RenderBlock* child, int xoffset, int yoffset);
179
180     int nearestFloatBottom(int height) const;
181     int floatBottom() const;
182     inline int leftBottom();
183     inline int rightBottom();
184     virtual IntRect floatRect() const;
185
186     virtual int lineWidth(int y) const;
187     virtual int lowestPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
188     virtual int rightmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
189     virtual int leftmostPosition(bool includeOverflowInterior=true, bool includeSelf=true) const;
190
191     int rightOffset() const;
192     int rightRelOffset(int y, int fixedOffset, bool applyTextIndent = true,
193                        int *heightRemaining = 0) const;
194     int rightOffset(int y) const { return rightRelOffset(y, rightOffset(), true); }
195
196     int leftOffset() const;
197     int leftRelOffset(int y, int fixedOffset, bool applyTextIndent = true,
198                       int *heightRemaining = 0) const;
199     int leftOffset(int y) const { return leftRelOffset(y, leftOffset(), true); }
200
201     virtual bool nodeAtPoint(NodeInfo& info, int x, int y, int tx, int ty,
202                              HitTestAction hitTestAction);
203
204     bool isPointInScrollbar(int x, int y, int tx, int ty);
205
206     virtual VisiblePosition positionForCoordinates(int x, int y);
207     
208     virtual void calcMinMaxWidth();
209     void calcInlineMinMaxWidth();
210     void calcBlocminMaxWidth();
211
212     virtual int getBaselineOfFirstLineBox() const;
213     virtual int getBaselineOfLastLineBox() const;
214
215     RootInlineBox* firstRootBox() const { return static_cast<RootInlineBox*>(m_firstLineBox); }
216     RootInlineBox* lastRootBox() const { return static_cast<RootInlineBox*>(m_lastLineBox); }
217
218     // Obtains the nearest enclosing block (including this block) that contributes a first-line style to our inline
219     // children.
220     virtual RenderBlock* firstLineBlock() const;
221     virtual void updateFirstLetter();
222     
223     bool inRootBlockContext() const;
224
225     void setHasMarkupTruncation(bool b=true) { m_hasMarkupTruncation = b; }
226     bool hasMarkupTruncation() const { return m_hasMarkupTruncation; }
227
228     virtual bool hasSelectedChildren() const { return m_selectionState != SelectionNone; }
229     virtual SelectionState selectionState() const { return static_cast<SelectionState>(m_selectionState); }
230     virtual void setSelectionState(SelectionState s);
231
232     struct BlockSelectionInfo {
233         RenderBlock* m_block;
234         GapRects m_rects;
235         SelectionState m_state;
236
237         BlockSelectionInfo() { m_block = 0; m_state = SelectionNone; }
238         BlockSelectionInfo(RenderBlock* b) { 
239             m_block = b;
240             m_state = m_block->selectionState();
241             m_rects = m_block->selectionGapRects();
242         }
243         
244         GapRects rects() const { return m_rects; }
245         SelectionState state() const { return m_state; }
246         RenderBlock* block() const { return m_block; }
247     };
248     
249     virtual IntRect selectionRect() { return selectionGapRects(); }
250     GapRects selectionGapRects();
251     virtual bool shouldPaintSelectionGaps() const;
252     bool isSelectionRoot() const;
253     GapRects fillSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty, 
254                                int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* i = 0);
255     GapRects fillInlineSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
256                                      int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* i);
257     GapRects fillBlockSelectionGaps(RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty,
258                                     int& lastTop, int& lastLeft, int& lastRight, const PaintInfo* i);
259     IntRect fillVerticalSelectionGap(int lastTop, int lastLeft, int lastRight,
260                                    int bottomY, RenderBlock* rootBlock, int blockX, int blockY, const PaintInfo* i);
261     IntRect fillLeftSelectionGap(RenderObject* selObj, int xPos, int yPos, int height, RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty, const PaintInfo* i);
262     IntRect fillRightSelectionGap(RenderObject* selObj, int xPos, int yPos, int height, RenderBlock* rootBlock, int blockX, int blockY, int tx, int ty, const PaintInfo* i);
263     IntRect fillHorizontalSelectionGap(RenderObject* selObj, int xPos, int yPos, int width, int height, const PaintInfo* i);
264
265     void getHorizontalSelectionGapInfo(SelectionState state, bool& leftGap, bool& rightGap);
266     int leftSelectionOffset(RenderBlock* rootBlock, int y);
267     int rightSelectionOffset(RenderBlock* rootBlock, int y);
268
269 #if !NDEBUG
270     virtual void dump(TextStream *stream, DeprecatedString ind = "") const;
271 #endif
272
273     // Helper methods for computing line counts and heights for line counts.
274     RootInlineBox* lineAtIndex(int i);
275     int lineCount();
276     int heightForLineCount(int l);
277     void clearTruncation();
278
279 protected:
280     void newLine();
281
282 private:
283     Position positionForBox(InlineBox *box, bool start=true) const;
284     Position positionForRenderer(RenderObject *renderer, bool start=true) const;
285     
286     bool hasLineIfEmpty() const;
287     
288 protected:
289     struct FloatingObject {
290         enum Type {
291             FloatLeft,
292             FloatRight
293         };
294
295         FloatingObject(Type type) {
296             node = 0;
297             startY = 0;
298             endY = 0;
299             m_type = type;
300             left = 0;
301             width = 0;
302             noPaint = false;
303         }
304         
305         Type type() { return static_cast<Type>(m_type); }
306
307         RenderObject* node;
308         int startY;
309         int endY;
310         int left;
311         int width;
312         unsigned m_type : 1; // Type (left or right aligned)
313         bool noPaint : 1;
314     };
315     
316     // The following helper functions and structs are used by layoutBlockChildren.
317     class CompactInfo {
318         // A compact child that needs to be collapsed into the margin of the following block.
319         RenderObject* m_compact;
320         
321         // The block with the open margin that the compact child is going to place itself within.
322         RenderObject* m_block;
323
324     public:
325         RenderObject* compact() const { return m_compact; }
326         RenderObject* block() const { return m_block; }
327         bool matches(RenderObject* child) const { return m_compact && m_block == child; }
328         
329         void clear() { set(0, 0);  }
330         void set(RenderObject* c, RenderObject* b) { m_compact = c; m_block = b; }
331         
332         CompactInfo() { clear(); }
333     };
334
335     class MarginInfo {
336         // Collapsing flags for whether we can collapse our margins with our children's margins.
337         bool m_canCollapseWithChildren : 1;
338         bool m_canCollapseTopWithChildren : 1;
339         bool m_canCollapseBottomWithChildren : 1;
340         
341         // Whether or not we are a quirky container, i.e., do we collapse away top and bottom
342         // margins in our container.  Table cells and the body are the common examples. We
343         // also have a custom style property for Safari RSS to deal with TypePad blog articles.
344         bool m_quirkContainer : 1;
345
346         // This flag tracks whether we are still looking at child margins that can all collapse together at the beginning of a block.  
347         // They may or may not collapse with the top margin of the block (|m_canCollapseTopWithChildren| tells us that), but they will
348         // always be collapsing with one another.  This variable can remain set to true through multiple iterations 
349         // as long as we keep encountering self-collapsing blocks.
350         bool m_atTopOfBlock : 1;
351
352         // This flag is set when we know we're examining bottom margins and we know we're at the bottom of the block.
353         bool m_atBottomOfBlock : 1;
354
355         // If our last normal flow child was a self-collapsing block that cleared a float,
356         // we track it in this variable.
357         bool m_selfCollapsingBlockClearedFloat : 1;
358     
359         // These variables are used to detect quirky margins that we need to collapse away (in table cells
360         // and in the body element).
361         bool m_topQuirk : 1;
362         bool m_bottomQuirk : 1;
363         bool m_determinedTopQuirk : 1;
364
365         // These flags track the previous maximal positive and negative margins.
366         int m_posMargin;
367         int m_negMargin;
368
369     public:
370         MarginInfo(RenderBlock* b, int top, int bottom);
371         
372         void setAtTopOfBlock(bool b) { m_atTopOfBlock = b; }
373         void setAtBottomOfBlock(bool b) { m_atBottomOfBlock = b; }
374         void clearMargin() { m_posMargin = m_negMargin = 0; }
375         void setSelfCollapsingBlockClearedFloat(bool b) { m_selfCollapsingBlockClearedFloat = b; }
376         void setTopQuirk(bool b) { m_topQuirk = b; }
377         void setBottomQuirk(bool b) { m_bottomQuirk = b; }
378         void setDeterminedTopQuirk(bool b) { m_determinedTopQuirk = b; }
379         void setPosMargin(int p) { m_posMargin = p; }
380         void setNegMargin(int n) { m_negMargin = n; }
381         void setPosMarginIfLarger(int p) { if (p > m_posMargin) m_posMargin = p; }
382         void setNegMarginIfLarger(int n) { if (n > m_negMargin) m_negMargin = n; }
383
384         void setMargin(int p, int n) { m_posMargin = p; m_negMargin = n; }
385
386         bool atTopOfBlock() const { return m_atTopOfBlock; }
387         bool canCollapseWithTop() const { return m_atTopOfBlock && m_canCollapseTopWithChildren; }
388         bool canCollapseWithBottom() const { return m_atBottomOfBlock && m_canCollapseBottomWithChildren; }
389         bool canCollapseTopWithChildren() const { return m_canCollapseTopWithChildren; }
390         bool canCollapseBottomWithChildren() const { return m_canCollapseBottomWithChildren; }
391         bool selfCollapsingBlockClearedFloat() const { return m_selfCollapsingBlockClearedFloat; }
392         bool quirkContainer() const { return m_quirkContainer; }
393         bool determinedTopQuirk() const { return m_determinedTopQuirk; }
394         bool topQuirk() const { return m_topQuirk; }
395         bool bottomQuirk() const { return m_bottomQuirk; }
396         int posMargin() const { return m_posMargin; }
397         int negMargin() const { return m_negMargin; }
398         int margin() const { return m_posMargin - m_negMargin; }
399     };
400     
401     void adjustPositionedBlock(RenderObject* child, const MarginInfo& marginInfo);
402     void adjustFloatingBlock(const MarginInfo& marginInfo);
403     RenderObject* handleSpecialChild(RenderObject* child, const MarginInfo& marginInfo, CompactInfo& compactInfo, bool& handled);
404     RenderObject* handleFloatingChild(RenderObject* child, const MarginInfo& marginInfo, bool& handled);
405     RenderObject* handlePositionedChild(RenderObject* child, const MarginInfo& marginInfo, bool& handled);
406     RenderObject* handleCompactChild(RenderObject* child, CompactInfo& compactInfo, bool& handled);
407     RenderObject* handleRunInChild(RenderObject* child, bool& handled);
408     void collapseMargins(RenderObject* child, MarginInfo& marginInfo, int yPosEstimate);
409     void clearFloatsIfNeeded(RenderObject* child, MarginInfo& marginInfo, int oldTopPosMargin, int oldTopNegMargin);
410     void insertCompactIfNeeded(RenderObject* child, CompactInfo& compactInfo);
411     int estimateVerticalPosition(RenderObject* child, const MarginInfo& info);
412     void determineHorizontalPosition(RenderObject* child);
413     void handleBottomOfBlock(int top, int bottom, MarginInfo& marginInfo);
414     void setCollapsedBottomMargin(const MarginInfo& marginInfo);
415     // End helper functions and structs used by layoutBlockChildren.
416
417 protected:
418     DeprecatedPtrList<FloatingObject>* m_floatingObjects;
419     DeprecatedPtrList<RenderObject>* m_positionedObjects;
420     
421     bool m_childrenInline : 1;
422     bool m_firstLine : 1;
423     unsigned m_clearStatus  : 2; // EClear
424     bool m_topMarginQuirk : 1;
425     bool m_bottomMarginQuirk : 1;
426     bool m_hasMarkupTruncation : 1;
427     unsigned m_selectionState : 3; // SelectionState
428
429     int m_maxTopPosMargin;
430     int m_maxTopNegMargin;
431     int m_maxBottomPosMargin;
432     int m_maxBottomNegMargin;
433
434     // How much content overflows out of our block vertically or horizontally (all we support
435     // for now is spillage out of the bottom and the right, which are the common cases).
436     // XXX Generalize to work with top and left as well.
437     int m_overflowHeight;
438     int m_overflowWidth;
439     
440     // Left and top overflow.  Does not affect scrolling dimensions, but we do at least use it
441     // when dirty rect checking and hit testing.
442     int m_overflowLeft;
443     int m_overflowTop;
444     
445     // full width of a tab character
446     int m_tabWidth;
447 };
448
449 } // namespace
450
451 #endif // RENDER_BLOCK_H