Home | History | Annotate | Download | only in web 
      1 /*
      2  * Copyright (C) 2012 Google 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  *
     14  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
     15  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
     16  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     17  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
     18  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     19  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
     20  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
     21  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     23  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #include "config.h"
     27 
     28 #include "LinkHighlight.h"
     29 
     30 #include "SkMatrix44.h"
     31 #include "WebFrameImpl.h"
     32 #include "WebKit.h"
     33 #include "WebViewImpl.h"
     34 #include "core/dom/Node.h"
     35 #include "core/page/Frame.h"
     36 #include "core/page/FrameView.h"
     37 #include "core/platform/graphics/Color.h"
     38 #include "core/rendering/RenderLayer.h"
     39 #include "core/rendering/RenderLayerBacking.h"
     40 #include "core/rendering/RenderLayerModelObject.h"
     41 #include "core/rendering/RenderObject.h"
     42 #include "core/rendering/RenderView.h"
     43 #include "core/rendering/style/ShadowData.h"
     44 #include "public/platform/Platform.h"
     45 #include "public/platform/WebAnimationCurve.h"
     46 #include "public/platform/WebCompositorSupport.h"
     47 #include "public/platform/WebFloatAnimationCurve.h"
     48 #include "public/platform/WebFloatPoint.h"
     49 #include "public/platform/WebRect.h"
     50 #include "public/platform/WebSize.h"
     51 #include "wtf/CurrentTime.h"
     52 
     53 using namespace WebCore;
     54 
     55 namespace WebKit {
     56 
     57 class WebViewImpl;
     58 
     59 PassOwnPtr<LinkHighlight> LinkHighlight::create(Node* node, WebViewImpl* owningWebViewImpl)
     60 {
     61     return adoptPtr(new LinkHighlight(node, owningWebViewImpl));
     62 }
     63 
     64 LinkHighlight::LinkHighlight(Node* node, WebViewImpl* owningWebViewImpl)
     65     : m_node(node)
     66     , m_owningWebViewImpl(owningWebViewImpl)
     67     , m_currentGraphicsLayer(0)
     68     , m_geometryNeedsUpdate(false)
     69     , m_isAnimating(false)
     70     , m_startTime(monotonicallyIncreasingTime())
     71 {
     72     ASSERT(m_node);
     73     ASSERT(owningWebViewImpl);
     74     WebCompositorSupport* compositorSupport = Platform::current()->compositorSupport();
     75     m_contentLayer = adoptPtr(compositorSupport->createContentLayer(this));
     76     m_clipLayer = adoptPtr(compositorSupport->createLayer());
     77     m_clipLayer->setAnchorPoint(WebFloatPoint());
     78     m_clipLayer->addChild(m_contentLayer->layer());
     79     m_contentLayer->layer()->setAnimationDelegate(this);
     80     m_contentLayer->layer()->setDrawsContent(true);
     81     m_contentLayer->layer()->setOpacity(1);
     82     m_geometryNeedsUpdate = true;
     83     updateGeometry();
     84 }
     85 
     86 LinkHighlight::~LinkHighlight()
     87 {
     88     clearGraphicsLayerLinkHighlightPointer();
     89     releaseResources();
     90 }
     91 
     92 WebContentLayer* LinkHighlight::contentLayer()
     93 {
     94     return m_contentLayer.get();
     95 }
     96 
     97 WebLayer* LinkHighlight::clipLayer()
     98 {
     99     return m_clipLayer.get();
    100 }
    101 
    102 void LinkHighlight::releaseResources()
    103 {
    104     m_node.clear();
    105 }
    106 
    107 RenderLayer* LinkHighlight::computeEnclosingCompositingLayer()
    108 {
    109     if (!m_node || !m_node->renderer())
    110         return 0;
    111 
    112     // FIXME: There's no need for renderer to be cast to a RLMO.
    113     // Find the nearest enclosing composited layer and attach to it. We may need to cross frame boundaries
    114     // to find a suitable layer.
    115     RenderLayerModelObject* renderer = toRenderLayerModelObject(m_node->renderer());
    116     RenderLayerModelObject* repaintContainer;
    117     do {
    118         repaintContainer = renderer->containerForRepaint();
    119         if (!repaintContainer) {
    120             renderer = renderer->frame()->ownerRenderer();
    121             if (!renderer)
    122                 return 0;
    123         }
    124     } while (!repaintContainer);
    125     RenderLayer* renderLayer = repaintContainer->layer();
    126 
    127     if (!renderLayer || !renderLayer->isComposited())
    128         return 0;
    129 
    130     GraphicsLayer* newGraphicsLayer = renderLayer->backing()->graphicsLayer();
    131     m_clipLayer->setSublayerTransform(SkMatrix44());
    132 
    133     if (!newGraphicsLayer->drawsContent()) {
    134         if (renderLayer->usesCompositedScrolling()) {
    135             ASSERT(renderLayer->backing() && renderLayer->backing()->scrollingContentsLayer());
    136             newGraphicsLayer = renderLayer->backing()->scrollingContentsLayer();
    137         } else
    138             ASSERT_NOT_REACHED();
    139     }
    140 
    141     if (m_currentGraphicsLayer != newGraphicsLayer) {
    142         if (m_currentGraphicsLayer)
    143             clearGraphicsLayerLinkHighlightPointer();
    144 
    145         m_currentGraphicsLayer = newGraphicsLayer;
    146         m_currentGraphicsLayer->setLinkHighlight(this);
    147     }
    148 
    149     return renderLayer;
    150 }
    151 
    152 static void convertTargetSpaceQuadToCompositedLayer(const FloatQuad& targetSpaceQuad, RenderObject* targetRenderer, RenderObject* compositedRenderer, FloatQuad& compositedSpaceQuad)
    153 {
    154     ASSERT(targetRenderer);
    155     ASSERT(compositedRenderer);
    156 
    157     for (unsigned i = 0; i < 4; ++i) {
    158         IntPoint point;
    159         switch (i) {
    160         case 0: point = roundedIntPoint(targetSpaceQuad.p1()); break;
    161         case 1: point = roundedIntPoint(targetSpaceQuad.p2()); break;
    162         case 2: point = roundedIntPoint(targetSpaceQuad.p3()); break;
    163         case 3: point = roundedIntPoint(targetSpaceQuad.p4()); break;
    164         }
    165 
    166         point = targetRenderer->frame()->view()->contentsToWindow(point);
    167         point = compositedRenderer->frame()->view()->windowToContents(point);
    168         FloatPoint floatPoint = compositedRenderer->absoluteToLocal(point, UseTransforms);
    169 
    170         switch (i) {
    171         case 0: compositedSpaceQuad.setP1(floatPoint); break;
    172         case 1: compositedSpaceQuad.setP2(floatPoint); break;
    173         case 2: compositedSpaceQuad.setP3(floatPoint); break;
    174         case 3: compositedSpaceQuad.setP4(floatPoint); break;
    175         }
    176     }
    177 }
    178 
    179 static void addQuadToPath(const FloatQuad& quad, Path& path)
    180 {
    181     // FIXME: Make this create rounded quad-paths, just like the axis-aligned case.
    182     path.moveTo(quad.p1());
    183     path.addLineTo(quad.p2());
    184     path.addLineTo(quad.p3());
    185     path.addLineTo(quad.p4());
    186     path.closeSubpath();
    187 }
    188 
    189 bool LinkHighlight::computeHighlightLayerPathAndPosition(RenderLayer* compositingLayer)
    190 {
    191     if (!m_node || !m_node->renderer())
    192         return false;
    193 
    194     ASSERT(compositingLayer);
    195 
    196     // Get quads for node in absolute coordinates.
    197     Vector<FloatQuad> quads;
    198     m_node->renderer()->absoluteQuads(quads);
    199     ASSERT(quads.size());
    200 
    201     // Adjust for offset between target graphics layer and the node's renderer.
    202     FloatPoint positionAdjust = IntPoint(m_currentGraphicsLayer->offsetFromRenderer());
    203 
    204     Path newPath;
    205     for (unsigned quadIndex = 0; quadIndex < quads.size(); ++quadIndex) {
    206         FloatQuad absoluteQuad = quads[quadIndex];
    207         absoluteQuad.move(-positionAdjust.x(), -positionAdjust.y());
    208 
    209         // Transform node quads in target absolute coords to local coordinates in the compositor layer.
    210         FloatQuad transformedQuad;
    211         convertTargetSpaceQuadToCompositedLayer(absoluteQuad, m_node->renderer(), compositingLayer->renderer(), transformedQuad);
    212 
    213         // FIXME: for now, we'll only use rounded paths if we have a single node quad. The reason for this is that
    214         // we may sometimes get a chain of adjacent boxes (e.g. for text nodes) which end up looking like sausage
    215         // links: these should ideally be merged into a single rect before creating the path, but that's
    216         // another CL.
    217         if (quads.size() == 1 && transformedQuad.isRectilinear()) {
    218             FloatSize rectRoundingRadii(3, 3);
    219             newPath.addRoundedRect(transformedQuad.boundingBox(), rectRoundingRadii);
    220         } else
    221             addQuadToPath(transformedQuad, newPath);
    222     }
    223 
    224     FloatRect boundingRect = newPath.boundingRect();
    225     newPath.translate(-toFloatSize(boundingRect.location()));
    226 
    227     bool pathHasChanged = !(newPath == m_path);
    228     if (pathHasChanged) {
    229         m_path = newPath;
    230         m_contentLayer->layer()->setBounds(enclosingIntRect(boundingRect).size());
    231     }
    232 
    233     m_contentLayer->layer()->setPosition(boundingRect.location());
    234 
    235     return pathHasChanged;
    236 }
    237 
    238 void LinkHighlight::paintContents(WebCanvas* canvas, const WebRect& webClipRect, bool, WebFloatRect&)
    239 {
    240     if (!m_node || !m_node->renderer())
    241         return;
    242 
    243     GraphicsContext gc(canvas);
    244     IntRect clipRect(IntPoint(webClipRect.x, webClipRect.y), IntSize(webClipRect.width, webClipRect.height));
    245     gc.clip(clipRect);
    246     gc.setFillColor(m_node->renderer()->resolveColor(CSSPropertyWebkitTapHighlightColor));
    247     gc.fillPath(m_path);
    248 }
    249 
    250 void LinkHighlight::startHighlightAnimationIfNeeded()
    251 {
    252     if (m_isAnimating)
    253         return;
    254 
    255     m_isAnimating = true;
    256     const float startOpacity = 1;
    257     // FIXME: Should duration be configurable?
    258     const float fadeDuration = 0.1f;
    259     const float minPreFadeDuration = 0.1f;
    260 
    261     m_contentLayer->layer()->setOpacity(startOpacity);
    262 
    263     WebCompositorSupport* compositorSupport = Platform::current()->compositorSupport();
    264 
    265     OwnPtr<WebFloatAnimationCurve> curve = adoptPtr(compositorSupport->createFloatAnimationCurve());
    266 
    267     curve->add(WebFloatKeyframe(0, startOpacity));
    268     // Make sure we have displayed for at least minPreFadeDuration before starting to fade out.
    269     float extraDurationRequired = std::max(0.f, minPreFadeDuration - static_cast<float>(monotonicallyIncreasingTime() - m_startTime));
    270     if (extraDurationRequired)
    271         curve->add(WebFloatKeyframe(extraDurationRequired, startOpacity));
    272     // For layout tests we don't fade out.
    273     curve->add(WebFloatKeyframe(fadeDuration + extraDurationRequired, WebKit::layoutTestMode() ? startOpacity : 0));
    274 
    275     m_animation = adoptPtr(compositorSupport->createAnimation(*curve, WebAnimation::TargetPropertyOpacity));
    276 
    277     m_contentLayer->layer()->setDrawsContent(true);
    278     m_contentLayer->layer()->addAnimation(m_animation.get());
    279 
    280     invalidate();
    281     m_owningWebViewImpl->scheduleAnimation();
    282 }
    283 
    284 void LinkHighlight::clearGraphicsLayerLinkHighlightPointer()
    285 {
    286     if (m_currentGraphicsLayer) {
    287         m_currentGraphicsLayer->setLinkHighlight(0);
    288         m_currentGraphicsLayer = 0;
    289     }
    290 }
    291 
    292 void LinkHighlight::notifyAnimationStarted(double)
    293 {
    294 }
    295 
    296 void LinkHighlight::notifyAnimationFinished(double)
    297 {
    298     // Since WebViewImpl may hang on to us for a while, make sure we
    299     // release resources as soon as possible.
    300     clearGraphicsLayerLinkHighlightPointer();
    301     releaseResources();
    302 }
    303 
    304 void LinkHighlight::updateGeometry()
    305 {
    306     // To avoid unnecessary updates (e.g. other entities have requested animations from our WebViewImpl),
    307     // only proceed if we actually requested an update.
    308     if (!m_geometryNeedsUpdate)
    309         return;
    310 
    311     m_geometryNeedsUpdate = false;
    312 
    313     RenderLayer* compositingLayer = computeEnclosingCompositingLayer();
    314     if (compositingLayer && computeHighlightLayerPathAndPosition(compositingLayer)) {
    315         // We only need to invalidate the layer if the highlight size has changed, otherwise
    316         // we can just re-position the layer without needing to repaint.
    317         m_contentLayer->layer()->invalidate();
    318 
    319         if (m_currentGraphicsLayer)
    320             m_currentGraphicsLayer->addRepaintRect(FloatRect(layer()->position().x, layer()->position().y, layer()->bounds().width, layer()->bounds().height));
    321     } else if (!m_node || !m_node->renderer()) {
    322         clearGraphicsLayerLinkHighlightPointer();
    323         releaseResources();
    324     }
    325 }
    326 
    327 void LinkHighlight::clearCurrentGraphicsLayer()
    328 {
    329     m_currentGraphicsLayer = 0;
    330     m_geometryNeedsUpdate = true;
    331 }
    332 
    333 void LinkHighlight::invalidate()
    334 {
    335     // Make sure we update geometry on the next callback from WebViewImpl::layout().
    336     m_geometryNeedsUpdate = true;
    337 }
    338 
    339 WebLayer* LinkHighlight::layer()
    340 {
    341     return clipLayer();
    342 }
    343 
    344 } // namespace WeKit
    345