Source/WebCore/rendering/svg/RenderSVGResourceClipper.cpp

   1 /*
   2  * Copyright (C) 2004, 2005, 2007, 2008 Nikolas Zimmermann <zimmermann@kde.org>
   3  * Copyright (C) 2004, 2005, 2006, 2007, 2008 Rob Buis <buis@kde.org>
   4  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
   5  * Copyright (C) 2011 Dirk Schulze <krit@webkit.org>
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public License
  18  * along with this library; see the file COPYING.LIB.  If not, write to
  19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  20  * Boston, MA 02110-1301, USA.
  21  */
  22
  23 #include "config.h"
  24 #include "RenderSVGResourceClipper.h"
  25
  26 #include "ElementIterator.h"
  27 #include "Frame.h"
  28 #include "FrameView.h"
  29 #include "HitTestRequest.h"
  30 #include "HitTestResult.h"
  31 #include "IntRect.h"
  32 #include "RenderObject.h"
  33 #include "RenderStyle.h"
  34 #include "RenderView.h"
  35 #include "SVGNames.h"
  36 #include "SVGRenderingContext.h"
  37 #include "SVGResources.h"
  38 #include "SVGResourcesCache.h"
  39 #include "SVGUseElement.h"
  40
  41 namespace WebCore {
  42
  43 RenderSVGResourceClipper::RenderSVGResourceClipper(SVGClipPathElement& element, Ref<RenderStyle>&& style)
  44     : RenderSVGResourceContainer(element, WTF::move(style))
  45 {
  46 }
  47
  48 RenderSVGResourceClipper::~RenderSVGResourceClipper()
  49 {
  50 }
  51
  52 void RenderSVGResourceClipper::removeAllClientsFromCache(bool markForInvalidation)
  53 {
  54     m_clipBoundaries = FloatRect();
  55     m_clipper.clear();
  56
  57     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
  58 }
  59
  60 void RenderSVGResourceClipper::removeClientFromCache(RenderElement& client, bool markForInvalidation)
  61 {
  62     m_clipper.remove(&client);
  63
  64     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
  65 }
  66
  67 bool RenderSVGResourceClipper::applyResource(RenderElement& renderer, const RenderStyle&, GraphicsContext*& context, unsigned short resourceMode)
  68 {
  69     ASSERT(context);
  70     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
  71
  72     return applyClippingToContext(renderer, renderer.objectBoundingBox(), renderer.repaintRectInLocalCoordinates(), context);
  73 }
  74
  75 bool RenderSVGResourceClipper::pathOnlyClipping(GraphicsContext* context, const AffineTransform& animatedLocalTransform, const FloatRect& objectBoundingBox)
  76 {
  77     // If the current clip-path gets clipped itself, we have to fallback to masking.
  78     if (!style().svgStyle().clipperResource().isEmpty())
  79         return false;
  80     WindRule clipRule = RULE_NONZERO;
  81     Path clipPath = Path();
  82
  83     // If clip-path only contains one visible shape or path, we can use path-based clipping. Invisible
  84     // shapes don't affect the clipping and can be ignored. If clip-path contains more than one
  85     // visible shape, the additive clipping may not work, caused by the clipRule. EvenOdd
  86     // as well as NonZero can cause self-clipping of the elements.
  87     // See also http://www.w3.org/TR/SVG/painting.html#FillRuleProperty
  88     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
  89         RenderObject* renderer = childNode->renderer();
  90         if (!renderer)
  91             continue;
  92         // Only shapes or paths are supported for direct clipping. We need to fallback to masking for texts.
  93         if (renderer->isSVGText())
  94             return false;
  95         if (!childNode->isSVGElement() || !downcast<SVGElement>(*childNode).isSVGGraphicsElement())
  96             continue;
  97         SVGGraphicsElement& styled = downcast<SVGGraphicsElement>(*childNode);
  98         const RenderStyle& style = renderer->style();
  99         if (style.display() == NONE || style.visibility() != VISIBLE)
 100              continue;
 101         const SVGRenderStyle& svgStyle = style.svgStyle();
 102         // Current shape in clip-path gets clipped too. Fallback to masking.
 103         if (!svgStyle.clipperResource().isEmpty())
 104             return false;
 105         // Fallback to masking, if there is more than one clipping path.
 106         if (clipPath.isEmpty()) {
 107             styled.toClipPath(clipPath);
 108             clipRule = svgStyle.clipRule();
 109         } else
 110             return false;
 111     }
 112     // Only one visible shape/path was found. Directly continue clipping and transform the content to userspace if necessary.
 113     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 114         AffineTransform transform;
 115         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
 116         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 117         clipPath.transform(transform);
 118     }
 119
 120     // Transform path by animatedLocalTransform.
 121     clipPath.transform(animatedLocalTransform);
 122
 123     // The SVG specification wants us to clip everything, if clip-path doesn't have a child.
 124     if (clipPath.isEmpty())
 125         clipPath.addRect(FloatRect());
 126     context->clipPath(clipPath, clipRule);
 127     return true;
 128 }
 129
 130 bool RenderSVGResourceClipper::applyClippingToContext(RenderElement& renderer, const FloatRect& objectBoundingBox,
 131                                                       const FloatRect& repaintRect, GraphicsContext* context)
 132 {
 133     ClipperMaskImage& clipperMaskImage = addRendererToClipper(renderer);
 134     bool shouldCreateClipperMaskImage = !clipperMaskImage;
 135
 136     AffineTransform animatedLocalTransform = clipPathElement().animatedLocalTransform();
 137
 138     if (shouldCreateClipperMaskImage && pathOnlyClipping(context, animatedLocalTransform, objectBoundingBox))
 139         return true;
 140
 141     AffineTransform absoluteTransform = SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(renderer);
 142
 143     if (shouldCreateClipperMaskImage && !repaintRect.isEmpty()) {
 144         clipperMaskImage = SVGRenderingContext::createImageBuffer(repaintRect, absoluteTransform, ColorSpaceDeviceRGB, Unaccelerated);
 145         if (!clipperMaskImage)
 146             return false;
 147
 148         GraphicsContext* maskContext = clipperMaskImage->context();
 149         ASSERT(maskContext);
 150
 151         maskContext->concatCTM(animatedLocalTransform);
 152
 153         // clipPath can also be clipped by another clipPath.
 154         auto* resources = SVGResourcesCache::cachedResourcesForRenderer(*this);
 155         RenderSVGResourceClipper* clipper;
 156         bool succeeded;
 157         if (resources && (clipper = resources->clipper())) {
 158             GraphicsContextStateSaver stateSaver(*maskContext);
 159
 160             if (!clipper->applyClippingToContext(*this, objectBoundingBox, repaintRect, maskContext))
 161                 return false;
 162
 163             succeeded = drawContentIntoMaskImage(clipperMaskImage, objectBoundingBox);
 164             // The context restore applies the clipping on non-CG platforms.
 165         } else
 166             succeeded = drawContentIntoMaskImage(clipperMaskImage, objectBoundingBox);
 167
 168         if (!succeeded)
 169             clipperMaskImage.reset();
 170     }
 171
 172     if (!clipperMaskImage)
 173         return false;
 174
 175     SVGRenderingContext::clipToImageBuffer(context, absoluteTransform, repaintRect, clipperMaskImage, shouldCreateClipperMaskImage);
 176     return true;
 177 }
 178
 179 bool RenderSVGResourceClipper::drawContentIntoMaskImage(const ClipperMaskImage& clipperMaskImage, const FloatRect& objectBoundingBox)
 180 {
 181     ASSERT(clipperMaskImage);
 182
 183     GraphicsContext* maskContext = clipperMaskImage->context();
 184     ASSERT(maskContext);
 185
 186     AffineTransform maskContentTransformation;
 187     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 188         maskContentTransformation.translate(objectBoundingBox.x(), objectBoundingBox.y());
 189         maskContentTransformation.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 190         maskContext->concatCTM(maskContentTransformation);
 191     }
 192
 193     // Switch to a paint behavior where all children of this <clipPath> will be rendered using special constraints:
 194     // - fill-opacity/stroke-opacity/opacity set to 1
 195     // - masker/filter not applied when rendering the children
 196     // - fill is set to the initial fill paint server (solid, black)
 197     // - stroke is set to the initial stroke paint server (none)
 198     PaintBehavior oldBehavior = view().frameView().paintBehavior();
 199     view().frameView().setPaintBehavior(oldBehavior | PaintBehaviorRenderingSVGMask);
 200
 201     // Draw all clipPath children into a global mask.
 202     for (auto& child : childrenOfType<SVGElement>(clipPathElement())) {
 203         auto renderer = child.renderer();
 204         if (!renderer)
 205             continue;
 206         if (renderer->needsLayout()) {
 207             view().frameView().setPaintBehavior(oldBehavior);
 208             return false;
 209         }
 210         const RenderStyle& style = renderer->style();
 211         if (style.display() == NONE || style.visibility() != VISIBLE)
 212             continue;
 213
 214         WindRule newClipRule = style.svgStyle().clipRule();
 215         bool isUseElement = child.hasTagName(SVGNames::useTag);
 216         if (isUseElement) {
 217             SVGUseElement& useElement = downcast<SVGUseElement>(child);
 218             renderer = useElement.rendererClipChild();
 219             if (!renderer)
 220                 continue;
 221             if (!useElement.fastHasAttribute(SVGNames::clip_ruleAttr))
 222                 newClipRule = renderer->style().svgStyle().clipRule();
 223         }
 224
 225         // Only shapes, paths and texts are allowed for clipping.
 226         if (!renderer->isSVGShape() && !renderer->isSVGText())
 227             continue;
 228
 229         maskContext->setFillRule(newClipRule);
 230
 231         // In the case of a <use> element, we obtained its renderere above, to retrieve its clipRule.
 232         // We have to pass the <use> renderer itself to renderSubtreeToImageBuffer() to apply it's x/y/transform/etc. values when rendering.
 233         // So if isUseElement is true, refetch the childNode->renderer(), as renderer got overriden above.
 234         SVGRenderingContext::renderSubtreeToImageBuffer(clipperMaskImage.get(), isUseElement ? *child.renderer() : *renderer, maskContentTransformation);
 235     }
 236
 237     view().frameView().setPaintBehavior(oldBehavior);
 238     return true;
 239 }
 240
 241 void RenderSVGResourceClipper::calculateClipContentRepaintRect()
 242 {
 243     // This is a rough heuristic to appraise the clip size and doesn't consider clip on clip.
 244     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
 245         RenderObject* renderer = childNode->renderer();
 246         if (!childNode->isSVGElement() || !renderer)
 247             continue;
 248         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
 249             continue;
 250         const RenderStyle& style = renderer->style();
 251         if (style.display() == NONE || style.visibility() != VISIBLE)
 252              continue;
 253         m_clipBoundaries.unite(renderer->localToParentTransform().mapRect(renderer->repaintRectInLocalCoordinates()));
 254     }
 255     m_clipBoundaries = clipPathElement().animatedLocalTransform().mapRect(m_clipBoundaries);
 256 }
 257
 258 ClipperMaskImage& RenderSVGResourceClipper::addRendererToClipper(const RenderObject& object)
 259 {
 260     return m_clipper.add(&object, ClipperMaskImage()).iterator->value;
 261 }
 262
 263 bool RenderSVGResourceClipper::hitTestClipContent(const FloatRect& objectBoundingBox, const FloatPoint& nodeAtPoint)
 264 {
 265     FloatPoint point = nodeAtPoint;
 266     if (!SVGRenderSupport::pointInClippingArea(*this, point))
 267         return false;
 268
 269     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 270         AffineTransform transform;
 271         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
 272         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 273         point = transform.inverse().mapPoint(point);
 274     }
 275
 276     point = clipPathElement().animatedLocalTransform().inverse().mapPoint(point);
 277
 278     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
 279         RenderObject* renderer = childNode->renderer();
 280         if (!childNode->isSVGElement() || !renderer)
 281             continue;
 282         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
 283             continue;
 284         IntPoint hitPoint;
 285         HitTestResult result(hitPoint);
 286         if (renderer->nodeAtFloatPoint(HitTestRequest(HitTestRequest::SVGClipContent | HitTestRequest::DisallowShadowContent), result, point, HitTestForeground))
 287             return true;
 288     }
 289
 290     return false;
 291 }
 292
 293 FloatRect RenderSVGResourceClipper::resourceBoundingBox(const RenderObject& object)
 294 {
 295     // Resource was not layouted yet. Give back the boundingBox of the object.
 296     if (selfNeedsLayout()) {
 297         addRendererToClipper(object);
 298         return object.objectBoundingBox();
 299     }
 300
 301     if (m_clipBoundaries.isEmpty())
 302         calculateClipContentRepaintRect();
 303
 304     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 305         FloatRect objectBoundingBox = object.objectBoundingBox();
 306         AffineTransform transform;
 307         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
 308         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 309         return transform.mapRect(m_clipBoundaries);
 310     }
 311
 312     return m_clipBoundaries;
 313 }
 314
 315 }