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