Home | History | Annotate | Download | only in rendering
      1 /*
      2  * Copyright (C) 2008 Apple Inc. All rights reserved.
      3  *
      4  * Redistribution and use in source and binary forms, with or without
      5  * modification, are permitted provided that the following conditions
      6  * are met:
      7  *
      8  * 1.  Redistributions of source code must retain the above copyright
      9  *     notice, this list of conditions and the following disclaimer.
     10  * 2.  Redistributions in binary form must reproduce the above copyright
     11  *     notice, this list of conditions and the following disclaimer in the
     12  *     documentation and/or other materials provided with the distribution.
     13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
     14  *     its contributors may be used to endorse or promote products derived
     15  *     from this software without specific prior written permission.
     16  *
     17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
     18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     27  */
     28 
     29 #include "config.h"
     30 #include "core/rendering/RenderLineBoxList.h"
     31 
     32 #include "core/rendering/HitTestResult.h"
     33 #include "core/rendering/InlineTextBox.h"
     34 #include "core/rendering/PaintInfo.h"
     35 #include "core/rendering/RenderInline.h"
     36 #include "core/rendering/RenderView.h"
     37 #include "core/rendering/RootInlineBox.h"
     38 
     39 using namespace std;
     40 
     41 namespace WebCore {
     42 
     43 #ifndef NDEBUG
     44 RenderLineBoxList::~RenderLineBoxList()
     45 {
     46     ASSERT(!m_firstLineBox);
     47     ASSERT(!m_lastLineBox);
     48 }
     49 #endif
     50 
     51 void RenderLineBoxList::appendLineBox(InlineFlowBox* box)
     52 {
     53     checkConsistency();
     54 
     55     if (!m_firstLineBox)
     56         m_firstLineBox = m_lastLineBox = box;
     57     else {
     58         m_lastLineBox->setNextLineBox(box);
     59         box->setPreviousLineBox(m_lastLineBox);
     60         m_lastLineBox = box;
     61     }
     62 
     63     checkConsistency();
     64 }
     65 
     66 void RenderLineBoxList::deleteLineBoxTree()
     67 {
     68     InlineFlowBox* line = m_firstLineBox;
     69     InlineFlowBox* nextLine;
     70     while (line) {
     71         nextLine = line->nextLineBox();
     72         line->deleteLine();
     73         line = nextLine;
     74     }
     75     m_firstLineBox = m_lastLineBox = 0;
     76 }
     77 
     78 void RenderLineBoxList::extractLineBox(InlineFlowBox* box)
     79 {
     80     checkConsistency();
     81 
     82     m_lastLineBox = box->prevLineBox();
     83     if (box == m_firstLineBox)
     84         m_firstLineBox = 0;
     85     if (box->prevLineBox())
     86         box->prevLineBox()->setNextLineBox(0);
     87     box->setPreviousLineBox(0);
     88     for (InlineFlowBox* curr = box; curr; curr = curr->nextLineBox())
     89         curr->setExtracted();
     90 
     91     checkConsistency();
     92 }
     93 
     94 void RenderLineBoxList::attachLineBox(InlineFlowBox* box)
     95 {
     96     checkConsistency();
     97 
     98     if (m_lastLineBox) {
     99         m_lastLineBox->setNextLineBox(box);
    100         box->setPreviousLineBox(m_lastLineBox);
    101     } else
    102         m_firstLineBox = box;
    103     InlineFlowBox* last = box;
    104     for (InlineFlowBox* curr = box; curr; curr = curr->nextLineBox()) {
    105         curr->setExtracted(false);
    106         last = curr;
    107     }
    108     m_lastLineBox = last;
    109 
    110     checkConsistency();
    111 }
    112 
    113 void RenderLineBoxList::removeLineBox(InlineFlowBox* box)
    114 {
    115     checkConsistency();
    116 
    117     if (box == m_firstLineBox)
    118         m_firstLineBox = box->nextLineBox();
    119     if (box == m_lastLineBox)
    120         m_lastLineBox = box->prevLineBox();
    121     if (box->nextLineBox())
    122         box->nextLineBox()->setPreviousLineBox(box->prevLineBox());
    123     if (box->prevLineBox())
    124         box->prevLineBox()->setNextLineBox(box->nextLineBox());
    125 
    126     checkConsistency();
    127 }
    128 
    129 void RenderLineBoxList::deleteLineBoxes()
    130 {
    131     if (m_firstLineBox) {
    132         InlineFlowBox* next;
    133         for (InlineFlowBox* curr = m_firstLineBox; curr; curr = next) {
    134             next = curr->nextLineBox();
    135             curr->destroy();
    136         }
    137         m_firstLineBox = 0;
    138         m_lastLineBox = 0;
    139     }
    140 }
    141 
    142 void RenderLineBoxList::dirtyLineBoxes()
    143 {
    144     for (InlineFlowBox* curr = firstLineBox(); curr; curr = curr->nextLineBox())
    145         curr->dirtyLineBoxes();
    146 }
    147 
    148 bool RenderLineBoxList::rangeIntersectsRect(RenderBoxModelObject* renderer, LayoutUnit logicalTop, LayoutUnit logicalBottom, const LayoutRect& rect, const LayoutPoint& offset) const
    149 {
    150     RenderBox* block;
    151     if (renderer->isBox())
    152         block = toRenderBox(renderer);
    153     else
    154         block = renderer->containingBlock();
    155     LayoutUnit physicalStart = block->flipForWritingMode(logicalTop);
    156     LayoutUnit physicalEnd = block->flipForWritingMode(logicalBottom);
    157     LayoutUnit physicalExtent = absoluteValue(physicalEnd - physicalStart);
    158     physicalStart = min(physicalStart, physicalEnd);
    159 
    160     if (renderer->style()->isHorizontalWritingMode()) {
    161         physicalStart += offset.y();
    162         if (physicalStart >= rect.maxY() || physicalStart + physicalExtent <= rect.y())
    163             return false;
    164     } else {
    165         physicalStart += offset.x();
    166         if (physicalStart >= rect.maxX() || physicalStart + physicalExtent <= rect.x())
    167             return false;
    168     }
    169 
    170     return true;
    171 }
    172 
    173 bool RenderLineBoxList::anyLineIntersectsRect(RenderBoxModelObject* renderer, const LayoutRect& rect, const LayoutPoint& offset) const
    174 {
    175     // We can check the first box and last box and avoid painting/hit testing if we don't
    176     // intersect.  This is a quick short-circuit that we can take to avoid walking any lines.
    177     // FIXME: This check is flawed in the following extremely obscure way:
    178     // if some line in the middle has a huge overflow, it might actually extend below the last line.
    179     RootInlineBox& firstRootBox = firstLineBox()->root();
    180     RootInlineBox& lastRootBox = lastLineBox()->root();
    181     LayoutUnit firstLineTop = firstLineBox()->logicalTopVisualOverflow(firstRootBox.lineTop());
    182     LayoutUnit lastLineBottom = lastLineBox()->logicalBottomVisualOverflow(lastRootBox.lineBottom());
    183 
    184     return rangeIntersectsRect(renderer, firstLineTop, lastLineBottom, rect, offset);
    185 }
    186 
    187 bool RenderLineBoxList::lineIntersectsDirtyRect(RenderBoxModelObject* renderer, InlineFlowBox* box, const PaintInfo& paintInfo, const LayoutPoint& offset) const
    188 {
    189     RootInlineBox& root = box->root();
    190     LayoutUnit logicalTop = min<LayoutUnit>(box->logicalTopVisualOverflow(root.lineTop()), root.selectionTop());
    191     LayoutUnit logicalBottom = box->logicalBottomVisualOverflow(root.lineBottom());
    192 
    193     return rangeIntersectsRect(renderer, logicalTop, logicalBottom, paintInfo.rect, offset);
    194 }
    195 
    196 void RenderLineBoxList::paint(RenderBoxModelObject* renderer, PaintInfo& paintInfo, const LayoutPoint& paintOffset) const
    197 {
    198     // Only paint during the foreground/selection phases.
    199     if (paintInfo.phase != PaintPhaseForeground && paintInfo.phase != PaintPhaseSelection && paintInfo.phase != PaintPhaseOutline
    200         && paintInfo.phase != PaintPhaseSelfOutline && paintInfo.phase != PaintPhaseChildOutlines && paintInfo.phase != PaintPhaseTextClip
    201         && paintInfo.phase != PaintPhaseMask)
    202         return;
    203 
    204     ASSERT(renderer->isRenderBlock() || (renderer->isRenderInline() && renderer->hasLayer())); // The only way an inline could paint like this is if it has a layer.
    205 
    206     // If we have no lines then we have no work to do.
    207     if (!firstLineBox())
    208         return;
    209 
    210     if (!anyLineIntersectsRect(renderer, paintInfo.rect, paintOffset))
    211         return;
    212 
    213     PaintInfo info(paintInfo);
    214     ListHashSet<RenderInline*> outlineObjects;
    215     info.setOutlineObjects(&outlineObjects);
    216 
    217     // See if our root lines intersect with the dirty rect.  If so, then we paint
    218     // them.  Note that boxes can easily overlap, so we can't make any assumptions
    219     // based off positions of our first line box or our last line box.
    220     for (InlineFlowBox* curr = firstLineBox(); curr; curr = curr->nextLineBox()) {
    221         if (lineIntersectsDirtyRect(renderer, curr, info, paintOffset)) {
    222             RootInlineBox& root = curr->root();
    223             curr->paint(info, paintOffset, root.lineTop(), root.lineBottom());
    224         }
    225     }
    226 
    227     if (info.phase == PaintPhaseOutline || info.phase == PaintPhaseSelfOutline || info.phase == PaintPhaseChildOutlines) {
    228         ListHashSet<RenderInline*>::iterator end = info.outlineObjects()->end();
    229         for (ListHashSet<RenderInline*>::iterator it = info.outlineObjects()->begin(); it != end; ++it) {
    230             RenderInline* flow = *it;
    231             flow->paintOutline(info, paintOffset);
    232         }
    233         info.outlineObjects()->clear();
    234     }
    235 }
    236 
    237 bool RenderLineBoxList::hitTest(RenderBoxModelObject* renderer, const HitTestRequest& request, HitTestResult& result, const HitTestLocation& locationInContainer, const LayoutPoint& accumulatedOffset, HitTestAction hitTestAction) const
    238 {
    239     if (hitTestAction != HitTestForeground)
    240         return false;
    241 
    242     ASSERT(renderer->isRenderBlock() || (renderer->isRenderInline() && renderer->hasLayer())); // The only way an inline could hit test like this is if it has a layer.
    243 
    244     // If we have no lines then we have no work to do.
    245     if (!firstLineBox())
    246         return false;
    247 
    248     LayoutPoint point = locationInContainer.point();
    249     LayoutRect rect = firstLineBox()->isHorizontal() ?
    250         IntRect(point.x(), point.y() - locationInContainer.topPadding(), 1, locationInContainer.topPadding() + locationInContainer.bottomPadding() + 1) :
    251         IntRect(point.x() - locationInContainer.leftPadding(), point.y(), locationInContainer.rightPadding() + locationInContainer.leftPadding() + 1, 1);
    252 
    253     if (!anyLineIntersectsRect(renderer, rect, accumulatedOffset))
    254         return false;
    255 
    256     // See if our root lines contain the point.  If so, then we hit test
    257     // them further.  Note that boxes can easily overlap, so we can't make any assumptions
    258     // based off positions of our first line box or our last line box.
    259     for (InlineFlowBox* curr = lastLineBox(); curr; curr = curr->prevLineBox()) {
    260         RootInlineBox& root = curr->root();
    261         if (rangeIntersectsRect(renderer, curr->logicalTopVisualOverflow(root.lineTop()), curr->logicalBottomVisualOverflow(root.lineBottom()), rect, accumulatedOffset)) {
    262             bool inside = curr->nodeAtPoint(request, result, locationInContainer, accumulatedOffset, root.lineTop(), root.lineBottom());
    263             if (inside) {
    264                 renderer->updateHitTestResult(result, locationInContainer.point() - toLayoutSize(accumulatedOffset));
    265                 return true;
    266             }
    267         }
    268     }
    269 
    270     return false;
    271 }
    272 
    273 void RenderLineBoxList::dirtyLinesFromChangedChild(RenderObject* container, RenderObject* child)
    274 {
    275     if (!container->parent() || (container->isRenderBlock() && (container->selfNeedsLayout() || !container->isRenderBlockFlow())))
    276         return;
    277 
    278     RenderInline* inlineContainer = container->isRenderInline() ? toRenderInline(container) : 0;
    279     InlineBox* firstBox = inlineContainer ? inlineContainer->firstLineBoxIncludingCulling() : firstLineBox();
    280 
    281     // If we have no first line box, then just bail early.
    282     if (!firstBox) {
    283         // For an empty inline, go ahead and propagate the check up to our parent, unless the parent
    284         // is already dirty.
    285         if (container->isInline() && !container->ancestorLineBoxDirty()) {
    286             container->parent()->dirtyLinesFromChangedChild(container);
    287             container->setAncestorLineBoxDirty(); // Mark the container to avoid dirtying the same lines again across multiple destroy() calls of the same subtree.
    288         }
    289         return;
    290     }
    291 
    292     // Try to figure out which line box we belong in.  First try to find a previous
    293     // line box by examining our siblings.  If we didn't find a line box, then use our
    294     // parent's first line box.
    295     RootInlineBox* box = 0;
    296     RenderObject* curr = 0;
    297     for (curr = child->previousSibling(); curr; curr = curr->previousSibling()) {
    298         if (curr->isFloatingOrOutOfFlowPositioned())
    299             continue;
    300 
    301         if (curr->isReplaced()) {
    302             InlineBox* wrapper = toRenderBox(curr)->inlineBoxWrapper();
    303             if (wrapper)
    304                 box = &wrapper->root();
    305         } else if (curr->isText()) {
    306             InlineTextBox* textBox = toRenderText(curr)->lastTextBox();
    307             if (textBox)
    308                 box = &textBox->root();
    309         } else if (curr->isRenderInline()) {
    310             InlineBox* lastSiblingBox = toRenderInline(curr)->lastLineBoxIncludingCulling();
    311             if (lastSiblingBox)
    312                 box = &lastSiblingBox->root();
    313         }
    314 
    315         if (box)
    316             break;
    317     }
    318     if (!box) {
    319         if (inlineContainer && !inlineContainer->alwaysCreateLineBoxes()) {
    320             // https://bugs.webkit.org/show_bug.cgi?id=60778
    321             // We may have just removed a <br> with no line box that was our first child. In this case
    322             // we won't find a previous sibling, but firstBox can be pointing to a following sibling.
    323             // This isn't good enough, since we won't locate the root line box that encloses the removed
    324             // <br>. We have to just over-invalidate a bit and go up to our parent.
    325             if (!inlineContainer->ancestorLineBoxDirty()) {
    326                 inlineContainer->parent()->dirtyLinesFromChangedChild(inlineContainer);
    327                 inlineContainer->setAncestorLineBoxDirty(); // Mark the container to avoid dirtying the same lines again across multiple destroy() calls of the same subtree.
    328             }
    329             return;
    330         }
    331         box = &firstBox->root();
    332     }
    333 
    334     // If we found a line box, then dirty it.
    335     if (box) {
    336         RootInlineBox* adjacentBox;
    337         box->markDirty();
    338 
    339         // dirty the adjacent lines that might be affected
    340         // NOTE: we dirty the previous line because RootInlineBox objects cache
    341         // the address of the first object on the next line after a BR, which we may be
    342         // invalidating here.  For more info, see how RenderBlock::layoutInlineChildren
    343         // calls setLineBreakInfo with the result of findNextLineBreak.  findNextLineBreak,
    344         // despite the name, actually returns the first RenderObject after the BR.
    345         // <rdar://problem/3849947> "Typing after pasting line does not appear until after window resize."
    346         adjacentBox = box->prevRootBox();
    347         if (adjacentBox)
    348             adjacentBox->markDirty();
    349         adjacentBox = box->nextRootBox();
    350         // If |child| has been inserted before the first element in the linebox, but after collapsed leading
    351         // space, the search for |child|'s linebox will go past the leading space to the previous linebox and select that
    352         // one as |box|. If we hit that situation here, dirty the |box| actually containing the child too.
    353         bool insertedAfterLeadingSpace = box->lineBreakObj() == child->previousSibling();
    354         if (adjacentBox && (adjacentBox->lineBreakObj() == child || child->isBR() || (curr && curr->isBR())
    355             || insertedAfterLeadingSpace || isIsolated(container->style()->unicodeBidi()))) {
    356             adjacentBox->markDirty();
    357         }
    358     }
    359 }
    360 
    361 #ifndef NDEBUG
    362 
    363 void RenderLineBoxList::checkConsistency() const
    364 {
    365 #ifdef CHECK_CONSISTENCY
    366     const InlineFlowBox* prev = 0;
    367     for (const InlineFlowBox* child = m_firstLineBox; child != 0; child = child->nextLineBox()) {
    368         ASSERT(child->prevLineBox() == prev);
    369         prev = child;
    370     }
    371     ASSERT(prev == m_lastLineBox);
    372 #endif
    373 }
    374 
    375 #endif
    376 
    377 }
    378