317466e83b42af678c4632c966e88fbb00809aec
[WebKit-https.git] / WebCore / khtml / rendering / render_flow.cpp
1 /**
2  * This file is part of the html renderer for KDE.
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 #include <kdebug.h>
26 #include <assert.h>
27 #include <qpainter.h>
28 #include <kglobal.h>
29
30 #include "rendering/render_flow.h"
31 #include "rendering/render_text.h"
32 #include "rendering/render_table.h"
33 #include "rendering/render_canvas.h"
34 #include "xml/dom_nodeimpl.h"
35 #include "xml/dom_docimpl.h"
36 #include "html/html_formimpl.h"
37 #include "render_inline.h"
38 #include "render_block.h"
39 #include "render_arena.h"
40 #include "render_line.h"
41
42 #include "khtmlview.h"
43 #include "htmltags.h"
44
45 using namespace DOM;
46 using namespace khtml;
47
48 RenderFlow* RenderFlow::createAnonymousFlow(DOM::DocumentImpl* doc, RenderStyle* style)
49 {
50     RenderFlow* result;
51     if (style->display() == INLINE)
52         result = new (doc->renderArena()) RenderInline(doc);
53     else
54         result = new (doc->renderArena()) RenderBlock(doc);
55     result->setStyle(style);
56     return result;
57 }
58
59 RenderFlow* RenderFlow::continuationBefore(RenderObject* beforeChild)
60 {
61     if (beforeChild && beforeChild->parent() == this)
62         return this;
63     
64     RenderFlow* curr = continuation();
65     RenderFlow* nextToLast = this;
66     RenderFlow* last = this;
67     while (curr) {
68         if (beforeChild && beforeChild->parent() == curr) {
69             if (curr->firstChild() == beforeChild)
70                 return last;
71             return curr;
72         }
73         
74         nextToLast = last;
75         last = curr;
76         curr = curr->continuation();
77     }
78     
79     if (!beforeChild && !last->firstChild())
80         return nextToLast;
81     return last;
82 }
83
84 void RenderFlow::addChildWithContinuation(RenderObject* newChild, RenderObject* beforeChild)
85 {
86     RenderFlow* flow = continuationBefore(beforeChild);
87     KHTMLAssert(!beforeChild || beforeChild->parent()->isRenderBlock() ||
88                 beforeChild->parent()->isRenderInline());
89     RenderFlow* beforeChildParent = beforeChild ? static_cast<RenderFlow*>(beforeChild->parent()) : 
90                                     (flow->continuation() ? flow->continuation() : flow);
91     
92     if (newChild->isFloatingOrPositioned())
93         return beforeChildParent->addChildToFlow(newChild, beforeChild);
94     
95     // A continuation always consists of two potential candidates: an inline or an anonymous
96     // block box holding block children.
97     bool childInline = newChild->isInline();
98     bool bcpInline = beforeChildParent->isInline();
99     bool flowInline = flow->isInline();
100     
101     if (flow == beforeChildParent)
102         return flow->addChildToFlow(newChild, beforeChild);
103     else {
104         // The goal here is to match up if we can, so that we can coalesce and create the
105         // minimal # of continuations needed for the inline.
106         if (childInline == bcpInline)
107             return beforeChildParent->addChildToFlow(newChild, beforeChild);
108         else if (flowInline == childInline)
109             return flow->addChildToFlow(newChild, 0); // Just treat like an append.
110         else 
111             return beforeChildParent->addChildToFlow(newChild, beforeChild);
112     }
113 }
114
115 void RenderFlow::addChild(RenderObject *newChild, RenderObject *beforeChild)
116 {
117 #ifdef DEBUG_LAYOUT
118     kdDebug( 6040 ) << renderName() << "(RenderFlow)::addChild( " << newChild->renderName() <<
119                        ", " << (beforeChild ? beforeChild->renderName() : "0") << " )" << endl;
120     kdDebug( 6040 ) << "current height = " << m_height << endl;
121 #endif
122
123     if (continuation())
124         return addChildWithContinuation(newChild, beforeChild);
125     return addChildToFlow(newChild, beforeChild);
126 }
127
128 void RenderFlow::extractLineBox(InlineFlowBox* box)
129 {
130     m_lastLineBox = box->prevFlowBox();
131     if (box == m_firstLineBox)
132         m_firstLineBox = 0;
133     if (box->prevLineBox())
134         box->prevLineBox()->setNextLineBox(0);
135     box->setPreviousLineBox(0);
136     for (InlineRunBox* curr = box; curr; curr = curr->nextLineBox())
137         curr->setExtracted();
138 }
139
140 void RenderFlow::attachLineBox(InlineFlowBox* box)
141 {
142     if (m_lastLineBox) {
143         m_lastLineBox->setNextLineBox(box);
144         box->setPreviousLineBox(m_lastLineBox);
145     }
146     else
147         m_firstLineBox = box;
148     InlineFlowBox* last = box;
149     for (InlineFlowBox* curr = box; curr; curr = curr->nextFlowBox()) {
150         curr->setExtracted(false);
151         last = curr;
152     }
153     m_lastLineBox = last;
154 }
155
156 void RenderFlow::removeLineBox(InlineFlowBox* box)
157 {
158     if (box == m_firstLineBox)
159         m_firstLineBox = box->nextFlowBox();
160     if (box == m_lastLineBox)
161         m_lastLineBox = box->prevFlowBox();
162     if (box->nextLineBox())
163         box->nextLineBox()->setPreviousLineBox(box->prevLineBox());
164     if (box->prevLineBox())
165         box->prevLineBox()->setNextLineBox(box->nextLineBox());
166 }
167
168 void RenderFlow::deleteLineBoxes()
169 {
170     if (m_firstLineBox) {
171         RenderArena* arena = renderArena();
172         InlineRunBox *curr=m_firstLineBox, *next=0;
173         while (curr) {
174             next = curr->nextLineBox();
175             curr->detach(arena);
176             curr = next;
177         }
178         m_firstLineBox = 0;
179         m_lastLineBox = 0;
180     }
181 }
182
183 void RenderFlow::detach()
184 {
185     if (!documentBeingDestroyed() && m_firstLineBox && m_firstLineBox->parent()) {
186         for (InlineRunBox* box = m_firstLineBox; box; box = box->nextLineBox())
187             box->parent()->removeChild(box);
188     }
189
190     deleteLineBoxes();
191     RenderBox::detach();
192 }
193
194 void RenderFlow::dirtyLinesFromChangedChild(RenderObject* child)
195 {
196     if (!parent() || selfNeedsLayout() || isTable())
197         return;
198     
199     if (!isInline() && (!child->nextSibling() || !firstLineBox())) {
200         // An append onto the end of a block or we don't have any lines anyway.  
201         // In this case we don't have to dirty any specific lines.
202         static_cast<RenderBlock*>(this)->setLinesAppended();
203         return;
204     }
205     
206     // For an empty inline, go ahead and propagate the check up to our parent.
207     if (isInline() && !firstLineBox())
208         return parent()->dirtyLinesFromChangedChild(this);
209     
210     // Try to figure out which line box we belong in.  First try to find a previous
211     // line box by examining our siblings.  If we didn't find a line box, then use our 
212     // parent's first line box.
213     RootInlineBox* box = 0;
214     for (RenderObject* curr = child->previousSibling(); curr; curr = curr->previousSibling()) {
215         if (curr->isFloatingOrPositioned())
216             continue;
217         
218         if (curr->isReplaced()) {
219             InlineBox* wrapper = curr->inlineBoxWrapper();
220             if (wrapper)
221                 box = wrapper->root();
222         }
223         else if (curr->isText()) {
224             InlineTextBox* textBox = static_cast<RenderText*>(curr)->lastTextBox();
225             if (textBox)
226                 box = textBox->root();
227         }
228         else if (curr->isInlineFlow()) {
229             InlineRunBox* runBox = static_cast<RenderFlow*>(curr)->lastLineBox();
230             if (runBox)
231                 box = runBox->root();
232         }
233         
234         if (box)
235             break;
236     }
237     if (!box)
238         box = lastLineBox()->root();
239
240     // If we found a line box, then dirty it.
241     if (box) {
242         box->markDirty();
243         if (child->isBR()) {
244             RootInlineBox* next = box->nextRootBox();
245             if (next)
246                 next->markDirty();
247         }
248     }
249 }
250
251 short RenderFlow::lineHeight(bool firstLine, bool isRootLineBox) const
252 {
253     if (firstLine) {
254         RenderStyle* s = style(firstLine);
255         Length lh = s->lineHeight();
256         if (lh.value < 0) {
257             if (s == style()) {
258                 if (m_lineHeight == -1)
259                     m_lineHeight = RenderObject::lineHeight(false);
260                 return m_lineHeight;
261             }
262             return s->fontMetrics().lineSpacing();
263         }
264         if (lh.isPercent())
265             return lh.minWidth(s->font().pixelSize());
266         return lh.value;
267     }
268
269     if (m_lineHeight == -1)
270         m_lineHeight = RenderObject::lineHeight(false);
271     return m_lineHeight;
272 }
273
274 void RenderFlow::dirtyLineBoxes(bool fullLayout, bool isRootLineBox)
275 {
276     if (!isRootLineBox && isReplaced())
277         return RenderBox::dirtyLineBoxes(isRootLineBox);
278     
279     if (fullLayout)
280         deleteLineBoxes();
281     else {
282         for (InlineRunBox* curr = firstLineBox(); curr; curr = curr->nextLineBox())
283             curr->dirtyLineBoxes();
284     }
285 }
286
287 InlineBox* RenderFlow::createInlineBox(bool makePlaceHolderBox, bool isRootLineBox, bool isOnlyRun)
288 {
289     if (!isRootLineBox &&
290         (isReplaced() || makePlaceHolderBox))                     // Inline tables and inline blocks
291         return RenderBox::createInlineBox(false, isRootLineBox);  // (or positioned element placeholders).
292
293     InlineFlowBox* flowBox = 0;
294     if (isInlineFlow())
295         flowBox = new (renderArena()) InlineFlowBox(this);
296     else
297         flowBox = new (renderArena()) RootInlineBox(this);
298     
299     if (!m_firstLineBox)
300         m_firstLineBox = m_lastLineBox = flowBox;
301     else {
302         m_lastLineBox->setNextLineBox(flowBox);
303         flowBox->setPreviousLineBox(m_lastLineBox);
304         m_lastLineBox = flowBox;
305     }
306
307     return flowBox;
308 }
309
310 void RenderFlow::paintLineBoxBackgroundBorder(PaintInfo& i, int _tx, int _ty)
311 {
312     if (!firstLineBox())
313         return;
314  
315     if (style()->visibility() == VISIBLE && i.phase == PaintActionForeground) {
316         // We can check the first box and last box and avoid painting if we don't
317         // intersect.
318         int yPos = _ty + firstLineBox()->yPos();
319         int h = lastLineBox()->yPos() + lastLineBox()->height() - firstLineBox()->yPos();
320         if( (yPos >= i.r.y() + i.r.height()) || (yPos + h <= i.r.y()))
321             return;
322
323         // See if our boxes intersect with the dirty rect.  If so, then we paint
324         // them.  Note that boxes can easily overlap, so we can't make any assumptions
325         // based off positions of our first line box or our last line box.
326         int xOffsetWithinLineBoxes = 0;
327         for (InlineRunBox* curr = firstLineBox(); curr; curr = curr->nextLineBox()) {
328             yPos = _ty + curr->yPos();
329             h = curr->height();
330             if ((yPos < i.r.y() + i.r.height()) && (yPos + h > i.r.y()))
331                 curr->paintBackgroundAndBorder(i, _tx, _ty, xOffsetWithinLineBoxes);
332             xOffsetWithinLineBoxes += curr->width();
333         }
334     }
335 }
336
337 void RenderFlow::paintLineBoxDecorations(PaintInfo& i, int _tx, int _ty, bool paintedChildren)
338 {
339     // We only paint line box decorations in strict or almost strict mode.
340     // Otherwise we let the InlineTextBoxes paint their own decorations.
341     if (style()->htmlHacks() || !firstLineBox())
342         return;
343
344     if (style()->visibility() == VISIBLE && i.phase == PaintActionForeground) {
345         // We can check the first box and last box and avoid painting if we don't
346         // intersect.
347         int yPos = _ty + firstLineBox()->yPos();;
348         int h = lastLineBox()->yPos() + lastLineBox()->height() - firstLineBox()->yPos();
349         if( (yPos >= i.r.y() + i.r.height()) || (yPos + h <= i.r.y()))
350             return;
351
352         // See if our boxes intersect with the dirty rect.  If so, then we paint
353         // them.  Note that boxes can easily overlap, so we can't make any assumptions
354         // based off positions of our first line box or our last line box.
355         for (InlineRunBox* curr = firstLineBox(); curr; curr = curr->nextLineBox()) {
356             yPos = _ty + curr->yPos();
357             h = curr->height();
358             if ((yPos < i.r.y() + i.r.height()) && (yPos + h > i.r.y()))
359                 curr->paintDecorations(i, _tx, _ty, paintedChildren);
360         }
361     }
362 }
363
364 QRect RenderFlow::getAbsoluteRepaintRect()
365 {
366     if (isInlineFlow()) {
367         // Find our leftmost position.
368         int left = 0;
369         int top = firstLineBox() ? firstLineBox()->yPos() : 0;
370         for (InlineRunBox* curr = firstLineBox(); curr; curr = curr->nextLineBox())
371             if (curr == firstLineBox() || curr->xPos() < left)
372                 left = curr->xPos();
373
374         // Now invalidate a rectangle.
375         int ow = style() ? style()->outlineSize() : 0;
376         if (isCompact())
377             left -= m_x;
378         if (style()->position() == RELATIVE && m_layer)
379             m_layer->relativePositionOffset(left, top);
380
381         QRect r(-ow+left, -ow+top, width()+ow*2, height()+ow*2);
382         containingBlock()->computeAbsoluteRepaintRect(r);
383         if (ow) {
384             for (RenderObject* curr = firstChild(); curr; curr = curr->nextSibling()) {
385                 if (!curr->isText()) {
386                     QRect childRect = curr->getAbsoluteRepaintRectWithOutline(ow);
387                     r = r.unite(childRect);
388                 }
389             }
390             
391             if (continuation() && !continuation()->isInline()) {
392                 QRect contRect = continuation()->getAbsoluteRepaintRectWithOutline(ow);
393                 r = r.unite(contRect);
394             }
395         }
396
397         return r;
398     }
399     else {
400         if (firstLineBox() && firstLineBox()->topOverflow() < 0) {
401             int ow = style() ? style()->outlineSize() : 0;
402             QRect r(-ow, -ow+firstLineBox()->topOverflow(),
403                     overflowWidth(false)+ow*2,
404                     overflowHeight(false)+ow*2-firstLineBox()->topOverflow());
405             computeAbsoluteRepaintRect(r);
406             return r;
407         }
408     }
409
410     return RenderBox::getAbsoluteRepaintRect();
411 }
412
413 int
414 RenderFlow::lowestPosition(bool includeOverflowInterior, bool includeSelf) const
415 {
416     int bottom = RenderBox::lowestPosition(includeOverflowInterior, includeSelf);
417     if (!includeOverflowInterior && hasOverflowClip())
418         return bottom;
419
420     // FIXME: Come up with a way to use the layer tree to avoid visiting all the kids.
421     // For now, we have to descend into all the children, since we may have a huge abs div inside
422     // a tiny rel div buried somewhere deep in our child tree.  In this case we have to get to
423     // the abs div.
424     for (RenderObject *c = firstChild(); c; c = c->nextSibling()) {
425         if (!c->isFloatingOrPositioned() && !c->isText()) {
426             int lp = c->yPos() + c->lowestPosition(false);
427             bottom = kMax(bottom, lp);
428         }
429     }
430     
431     return bottom;
432 }
433
434 int RenderFlow::rightmostPosition(bool includeOverflowInterior, bool includeSelf) const
435 {
436     int right = RenderBox::rightmostPosition(includeOverflowInterior, includeSelf);
437     if (!includeOverflowInterior && hasOverflowClip())
438         return right;
439
440     // FIXME: Come up with a way to use the layer tree to avoid visiting all the kids.
441     // For now, we have to descend into all the children, since we may have a huge abs div inside
442     // a tiny rel div buried somewhere deep in our child tree.  In this case we have to get to
443     // the abs div.
444     for (RenderObject *c = firstChild(); c; c = c->nextSibling()) {
445         if (!c->isFloatingOrPositioned() && !c->isText()) {
446             int rp = c->xPos() + c->rightmostPosition(false);
447             right = kMax(right, rp);
448         }
449     }
450     
451     return right;
452 }
453
454 int RenderFlow::leftmostPosition(bool includeOverflowInterior, bool includeSelf) const
455 {
456     int left = RenderBox::leftmostPosition(includeOverflowInterior, includeSelf);
457     if (!includeOverflowInterior && hasOverflowClip())
458         return left;
459     
460     // FIXME: Come up with a way to use the layer tree to avoid visiting all the kids.
461     // For now, we have to descend into all the children, since we may have a huge abs div inside
462     // a tiny rel div buried somewhere deep in our child tree.  In this case we have to get to
463     // the abs div.
464     for (RenderObject *c = firstChild(); c; c = c->nextSibling()) {
465         if (!c->isFloatingOrPositioned() && !c->isText()) {
466             int lp = c->xPos() + c->leftmostPosition(false);
467             left = kMin(left, lp);
468         }
469     }
470     
471     return left;
472 }
473
474 void RenderFlow::caretPos(int offset, bool override, int &_x, int &_y, int &width, int &height)
475 {
476     if (firstChild() || style()->display() == INLINE) {
477         // Do the normal calculation
478         RenderBox::caretPos(offset, override, _x, _y, width, height);
479         return;
480     }
481
482     // This is a special case:
483     // The element is not an inline element, and it's empty. So we have to
484     // calculate a fake position to indicate where objects are to be inserted.
485     
486     // EDIT FIXME: this does neither take into regard :first-line nor :first-letter
487     // However, as soon as some content is entered, the line boxes will be
488     // constructed properly and this kludge is not called any more. So only
489     // the caret size of an empty :first-line'd block is wrong, but I think we
490     // can live with that.
491     RenderStyle *currentStyle = style(true);
492     //height = currentStyle->fontMetrics().height();
493     height = lineHeight(true);
494     width = 1;
495
496     // EDIT FIXME: This needs to account for text direction
497     int w = this->width();
498     switch (currentStyle->textAlign()) {
499         case LEFT:
500         case KHTML_LEFT:
501         case TAAUTO:
502         case JUSTIFY:
503             _x = 0;
504             break;
505         case CENTER:
506         case KHTML_CENTER:
507             _x = w / 2;
508         break;
509         case RIGHT:
510         case KHTML_RIGHT:
511             _x = w;
512         break;
513     }
514     
515     _y = 0;
516     
517     int absx, absy;
518     absolutePosition(absx, absy, false);
519     _x += absx + paddingLeft() + borderLeft();
520     _y += absy + paddingTop() + borderTop();
521 }