ImageBuffer-less SVG masking and clipping.

Source/core/rendering/svg/RenderSVGResourceClipper.cpp

 /*
  * Copyright (C) 2004, 2005, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Rob Buis <buis@kde.org>
  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
  * Copyright (C) 2011 Dirk Schulze <krit@webkit.org>
  *
  * This library is free software; you can redistribute it and/or
  * modify it under the terms of the GNU Library General Public
  * License as published by the Free Software Foundation; either
  * version 2 of the License, or (at your option) any later version.
@@ skipping 10 matching lines @@
  */
 
 #include "config.h"
 
 #include "core/rendering/svg/RenderSVGResourceClipper.h"
 
 #include "RuntimeEnabledFeatures.h"
 #include "SVGNames.h"
 #include "core/page/FrameView.h"
 #include "core/platform/graphics/GraphicsContextStateSaver.h"
+#include "core/platform/graphics/skia/SkiaUtils.h"

[Stephen White, 2013/08/28 14:11:10]

We're calling into skia-specific code from outside platform/ here. :( Would it
help if we changed GraphicsContext::saveLayer() to take Blink types?

[f(malita), 2013/08/28 19:54:38]

Fixed, see other comment.

 #include "core/rendering/HitTestResult.h"
 #include "core/rendering/svg/SVGRenderingContext.h"
 #include "core/rendering/svg/SVGResources.h"
 #include "core/rendering/svg/SVGResourcesCache.h"
 #include "core/svg/SVGUseElement.h"
+#include "wtf/TemporaryChange.h"
 
 namespace WebCore {
 
 RenderSVGResourceType RenderSVGResourceClipper::s_resourceType = ClipperResourceType;
 
 RenderSVGResourceClipper::RenderSVGResourceClipper(SVGClipPathElement* node)
     : RenderSVGResourceContainer(node)
+    , m_inClipExpansion(false)
 {
 }
 
 RenderSVGResourceClipper::~RenderSVGResourceClipper()
 {
-    if (m_clipper.isEmpty())
-        return;
-
-    deleteAllValues(m_clipper);
-    m_clipper.clear();
 }
 
 void RenderSVGResourceClipper::removeAllClientsFromCache(bool markForInvalidation)
 {
     m_clipBoundaries = FloatRect();
-    if (!m_clipper.isEmpty()) {
-        deleteAllValues(m_clipper);
-        m_clipper.clear();
-    }
-
+    m_clipperMap.clear();
     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
 }
 
 void RenderSVGResourceClipper::removeClientFromCache(RenderObject* client, bool markForInvalidation)
 {
     ASSERT(client);
-    if (m_clipper.contains(client))
-        delete m_clipper.take(client);
-
+    m_clipperMap.remove(client);
     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
 }
 
 bool RenderSVGResourceClipper::applyResource(RenderObject* object, RenderStyle*, GraphicsContext*& context, unsigned short resourceMode)
 {
     ASSERT(object);
     ASSERT(context);
     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);

[pdr., 2013/08/28 03:32:36]

Can you add ASSERT_WITH_SECURITY_IMPLICATION(!needsLayout()); here?

 
     return applyClippingToContext(object, object->objectBoundingBox(), object->repaintRectInLocalCoordinates(), context);
 }
 
 bool RenderSVGResourceClipper::pathOnlyClipping(GraphicsContext* context, const AffineTransform& animatedLocalTransform, const FloatRect& objectBoundingBox)
 {
     // If the current clip-path gets clipped itself, we have to fallback to masking.
     if (!style()->svgStyle()->clipperResource().isEmpty())
         return false;
     WindRule clipRule = RULE_NONZERO;
@@ skipping 47 matching lines @@
     // Transform path by animatedLocalTransform.
     clipPath.transform(animatedLocalTransform);
 
     // The SVG specification wants us to clip everything, if clip-path doesn't have a child.
     if (clipPath.isEmpty())
         clipPath.addRect(FloatRect());
     context->clipPath(clipPath, clipRule);
     return true;
 }
 
-bool RenderSVGResourceClipper::applyClippingToContext(RenderObject* object, const FloatRect& objectBoundingBox,
+bool RenderSVGResourceClipper::applyClippingToContext(RenderObject* target, const FloatRect& targetBoundingBox,
                                                       const FloatRect& repaintRect, GraphicsContext* context)
 {
-    bool missingClipperData = !m_clipper.contains(object);
-    if (missingClipperData)
-        m_clipper.set(object, new ClipperData);
+    ASSERT(target);
+    ASSERT(context);
+    ASSERT_WITH_SECURITY_IMPLICATION(!needsLayout());
 
-    bool shouldCreateClipData = false;
+    if (repaintRect.isEmpty() || m_inClipExpansion)
+        return false;
+    TemporaryChange<bool> inClipExpansionChange(m_inClipExpansion, true);
+
+    // add(obj, 0) idiom -> lookup & add if not found.

[pdr., 2013/08/28 03:32:36]

(not for this patch)
We should add HashMap::lookupAndAddIfNotFound so we don't all have to
independently discover this trick.

+    OwnPtr<ClipperData>& clipperData = m_clipperMap.add(target, nullptr).iterator->value;
+    if (!clipperData)
+        clipperData = adoptPtr(new ClipperData);
+
+    // First, try to apply the clip as a clipPath.
     AffineTransform animatedLocalTransform = toSVGClipPathElement(node())->animatedLocalTransform();
-    ClipperData* clipperData = m_clipper.get(object);
-    if (!clipperData->clipMaskImage) {
-        if (pathOnlyClipping(context, animatedLocalTransform, objectBoundingBox))
-            return true;
-        shouldCreateClipData = true;
+    if (pathOnlyClipping(context, animatedLocalTransform, targetBoundingBox)) {

[pdr., 2013/08/28 03:32:36]

Nit: could you rename this tryPathOnlyClipping?

[f(malita), 2013/08/28 19:54:38]

Done.

+        clipperData->pathOnly = true;
+        return true;
     }
 
-    AffineTransform absoluteTransform;
-    SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(object, absoluteTransform);
+    // Fall back to masking.
+    clipperData->pathOnly = false;
+    SkRect layerRect = WebCoreFloatRectToSKRect(repaintRect);
 
-    if (shouldCreateClipData && !repaintRect.isEmpty()) {
-        if (!SVGRenderingContext::createImageBuffer(repaintRect, absoluteTransform, clipperData->clipMaskImage, Unaccelerated))
-            return false;
-
-        GraphicsContext* maskContext = clipperData->clipMaskImage->context();
-        ASSERT(maskContext);
-
-        maskContext->concatCTM(animatedLocalTransform);
+    // Mask layer start
+    context->saveLayer(&layerRect, 0);
+    {
+        GraphicsContextStateSaver maskContentSaver(*context);
+        context->concatCTM(animatedLocalTransform);
 
         // clipPath can also be clipped by another clipPath.
         SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(this);
-        RenderSVGResourceClipper* clipper;
-        bool succeeded;
-        if (resources && (clipper = resources->clipper())) {
-            GraphicsContextStateSaver stateSaver(*maskContext);
+        RenderSVGResourceClipper* selfClipper = 0;

[pdr., 2013/08/28 03:32:36]

Nit: clipPathClipper? or clipOnClip?
I was confused that this isn't the case where we clip ourselves.

[f(malita), 2013/08/28 19:54:38]

Done.

+        if (resources && (selfClipper = resources->clipper())) {
+            if (!selfClipper->applyClippingToContext(this, targetBoundingBox, repaintRect, context)) {
+                // FIXME: Awkward state micro-management. Ideally, GraphicsContextStateSaver should
+                //   a) pop saveLayers also
+                //   b) pop multiple states if needed (similarly to SkCanvas::restoreToCount())
+                // Then we should be able to replace this mess with a single, top-level GCSS.
+                maskContentSaver.restore();
+                context->restoreLayer();
+                return false;
+            }
+        }
 
-            if (!clipper->applyClippingToContext(this, objectBoundingBox, repaintRect, maskContext))
-                return false;
+        drawMaskContent(context, targetBoundingBox);
 
-            succeeded = drawContentIntoMaskImage(clipperData, objectBoundingBox);
-            // The context restore applies the clipping on non-CG platforms.
-        } else
-            succeeded = drawContentIntoMaskImage(clipperData, objectBoundingBox);
-
-        if (!succeeded)
-            clipperData->clipMaskImage.clear();
+        if (selfClipper)
+            selfClipper->postApplyResource(this, context, ApplyToDefaultMode, 0, 0);
     }
 
-    if (!clipperData->clipMaskImage)
-        return false;
+    // Start the content layer in SrcIn mode. This ensures that it gets masked against the current
+    // (mask content) layer on restore.
+    SkPaint contentPaint;
+    contentPaint.setXfermodeMode(SkXfermode::kSrcIn_Mode);
+    context->saveLayer(&layerRect, &contentPaint);
 
-    SVGRenderingContext::clipToImageBuffer(context, absoluteTransform, repaintRect, clipperData->clipMaskImage, missingClipperData);
     return true;
 }
 
-bool RenderSVGResourceClipper::drawContentIntoMaskImage(ClipperData* clipperData, const FloatRect& objectBoundingBox)
+void RenderSVGResourceClipper::postApplyResource(RenderObject* object, GraphicsContext*& context,
+    unsigned short resourceMode, const Path*, const RenderSVGShape*) {
+    ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
+
+    ClipperData* clipperData = m_clipperMap.get(object);
+    ASSERT(clipperData);
+
+    // Path-only clipping, no layers to restore.
+    if (clipperData->pathOnly)
+        return;
+
+    // Transfer content layer -> mask layer (SrcIn)
+    context->restoreLayer();
+    // Transfer mask layer -> bg layer (SrcOver)
+    context->restoreLayer();
+}
+
+void RenderSVGResourceClipper::drawMaskContent(GraphicsContext* context, const FloatRect& targetBoundingBox)
 {
     ASSERT(frame());
-    ASSERT(clipperData);
-    ASSERT(clipperData->clipMaskImage);
+    ASSERT(context);
 
-    GraphicsContext* maskContext = clipperData->clipMaskImage->context();
-    ASSERT(maskContext);
-
+    // Adjust the mask image context according to the target objectBoundingBox.
     AffineTransform maskContentTransformation;
     if (toSVGClipPathElement(node())->clipPathUnitsCurrentValue() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
-        maskContentTransformation.translate(objectBoundingBox.x(), objectBoundingBox.y());
-        maskContentTransformation.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
-        maskContext->concatCTM(maskContentTransformation);
+        maskContentTransformation = makeMapBetweenRects(FloatRect(0, 0, 1, 1), targetBoundingBox);

[pdr., 2013/08/28 03:32:36]

Can you switch this back to the previous method? makeMapBetweenRects is harder
to understand and does unnecessary math.

[f(malita), 2013/08/28 19:54:38]

Done.

+        context->concatCTM(maskContentTransformation);
     }
 
     // Switch to a paint behavior where all children of this <clipPath> will be rendered using special constraints:
     // - fill-opacity/stroke-opacity/opacity set to 1
     // - masker/filter not applied when rendering the children
     // - fill is set to the initial fill paint server (solid, black)
     // - stroke is set to the initial stroke paint server (none)
     PaintBehavior oldBehavior = frame()->view()->paintBehavior();
     frame()->view()->setPaintBehavior(oldBehavior | PaintBehaviorRenderingSVGMask);
 
-    // Draw all clipPath children into a global mask.
     for (Node* childNode = node()->firstChild(); childNode; childNode = childNode->nextSibling()) {
         RenderObject* renderer = childNode->renderer();
         if (!childNode->isSVGElement() || !renderer)
             continue;
-        if (renderer->needsLayout()) {
-            frame()->view()->setPaintBehavior(oldBehavior);
-            return false;
-        }
+
         RenderStyle* style = renderer->style();
         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
             continue;
 
         WindRule newClipRule = style->svgStyle()->clipRule();
         bool isUseElement = childNode->hasTagName(SVGNames::useTag);
         if (isUseElement) {
             SVGUseElement* useElement = toSVGUseElement(childNode);
             renderer = useElement->rendererClipChild();
             if (!renderer)
                 continue;
             if (!useElement->hasAttribute(SVGNames::clip_ruleAttr))
                 newClipRule = renderer->style()->svgStyle()->clipRule();
         }
 
         // Only shapes, paths and texts are allowed for clipping.
         if (!renderer->isSVGShape() && !renderer->isSVGText())
             continue;
 
-        maskContext->setFillRule(newClipRule);
+        context->setFillRule(newClipRule);
 
-        // In the case of a <use> element, we obtained its renderere above, to retrieve its clipRule.
-        // We have to pass the <use> renderer itself to renderSubtreeToImageBuffer() to apply it's x/y/transform/etc. values when rendering.
-        // So if isUseElement is true, refetch the childNode->renderer(), as renderer got overriden above.
-        SVGRenderingContext::renderSubtreeToImageBuffer(clipperData->clipMaskImage.get(), isUseElement ? childNode->renderer() : renderer, maskContentTransformation);
+        if (isUseElement)
+            renderer = childNode->renderer();
+
+        SVGRenderingContext::renderSubtree(context, renderer, maskContentTransformation);
     }
 
     frame()->view()->setPaintBehavior(oldBehavior);
-    return true;
 }
 
 void RenderSVGResourceClipper::calculateClipContentRepaintRect()
 {
     // This is a rough heuristic to appraise the clip size and doesn't consider clip on clip.
     for (Node* childNode = node()->firstChild(); childNode; childNode = childNode->nextSibling()) {
         RenderObject* renderer = childNode->renderer();
         if (!childNode->isSVGElement() || !renderer)
             continue;
         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
@@ skipping 51 matching lines @@
         AffineTransform transform;
         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
         return transform.mapRect(m_clipBoundaries);
     }
 
     return m_clipBoundaries;
 }
 
 }