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
  25 #if ENABLE(SVG)
  26 #include "RenderSVGResourceClipper.h"
  27
  28 #include "AffineTransform.h"
  29 #include "ElementIterator.h"
  30 #include "FloatRect.h"
  31 #include "Frame.h"
  32 #include "FrameView.h"
  33 #include "GraphicsContext.h"
  34 #include "HitTestRequest.h"
  35 #include "HitTestResult.h"
  36 #include "ImageBuffer.h"
  37 #include "IntRect.h"
  38 #include "RenderObject.h"
  39 #include "RenderSVGResource.h"
  40 #include "RenderStyle.h"
  41 #include "RenderView.h"
  42 #include "SVGClipPathElement.h"
  43 #include "SVGElement.h"
  44 #include "SVGGraphicsElement.h"
  45 #include "SVGNames.h"
  46 #include "SVGRenderSupport.h"
  47 #include "SVGRenderingContext.h"
  48 #include "SVGResources.h"
  49 #include "SVGResourcesCache.h"
  50 #include "SVGUnitTypes.h"
  51 #include "SVGUseElement.h"
  52
  53 namespace WebCore {
  54
  55 RenderSVGResourceType RenderSVGResourceClipper::s_resourceType = ClipperResourceType;
  56
  57 RenderSVGResourceClipper::RenderSVGResourceClipper(SVGClipPathElement& element)
  58     : RenderSVGResourceContainer(element)
  59 {
  60 }
  61
  62 RenderSVGResourceClipper::~RenderSVGResourceClipper()
  63 {
  64 }
  65
  66 void RenderSVGResourceClipper::removeAllClientsFromCache(bool markForInvalidation)
  67 {
  68     m_clipBoundaries = FloatRect();
  69     m_clipper.clear();
  70
  71     markAllClientsForInvalidation(markForInvalidation ? LayoutAndBoundariesInvalidation : ParentOnlyInvalidation);
  72 }
  73
  74 void RenderSVGResourceClipper::removeClientFromCache(RenderObject* client, bool markForInvalidation)
  75 {
  76     ASSERT(client);
  77     m_clipper.remove(client);
  78
  79     markClientForInvalidation(client, markForInvalidation ? BoundariesInvalidation : ParentOnlyInvalidation);
  80 }
  81
  82 bool RenderSVGResourceClipper::applyResource(RenderObject* object, RenderStyle*, GraphicsContext*& context, unsigned short resourceMode)
  83 {
  84     ASSERT(object);
  85     ASSERT(context);
  86     ASSERT_UNUSED(resourceMode, resourceMode == ApplyToDefaultMode);
  87
  88     return applyClippingToContext(object, object->objectBoundingBox(), object->repaintRectInLocalCoordinates(), context);
  89 }
  90
  91 bool RenderSVGResourceClipper::pathOnlyClipping(GraphicsContext* context, const AffineTransform& animatedLocalTransform, const FloatRect& objectBoundingBox)
  92 {
  93     // If the current clip-path gets clipped itself, we have to fallback to masking.
  94     if (!style()->svgStyle()->clipperResource().isEmpty())
  95         return false;
  96     WindRule clipRule = RULE_NONZERO;
  97     Path clipPath = Path();
  98
  99     // If clip-path only contains one visible shape or path, we can use path-based clipping. Invisible
 100     // shapes don't affect the clipping and can be ignored. If clip-path contains more than one
 101     // visible shape, the additive clipping may not work, caused by the clipRule. EvenOdd
 102     // as well as NonZero can cause self-clipping of the elements.
 103     // See also http://www.w3.org/TR/SVG/painting.html#FillRuleProperty
 104     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
 105         RenderObject* renderer = childNode->renderer();
 106         if (!renderer)
 107             continue;
 108         // Only shapes or paths are supported for direct clipping. We need to fallback to masking for texts.
 109         if (renderer->isSVGText())
 110             return false;
 111         if (!childNode->isSVGElement() || !toSVGElement(childNode)->isSVGGraphicsElement())
 112             continue;
 113         SVGGraphicsElement* styled = toSVGGraphicsElement(childNode);
 114         RenderStyle* style = renderer->style();
 115         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
 116              continue;
 117         const SVGRenderStyle* svgStyle = style->svgStyle();
 118         // Current shape in clip-path gets clipped too. Fallback to masking.
 119         if (!svgStyle->clipperResource().isEmpty())
 120             return false;
 121         // Fallback to masking, if there is more than one clipping path.
 122         if (clipPath.isEmpty()) {
 123             styled->toClipPath(clipPath);
 124             clipRule = svgStyle->clipRule();
 125         } else
 126             return false;
 127     }
 128     // Only one visible shape/path was found. Directly continue clipping and transform the content to userspace if necessary.
 129     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 130         AffineTransform transform;
 131         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
 132         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 133         clipPath.transform(transform);
 134     }
 135
 136     // Transform path by animatedLocalTransform.
 137     clipPath.transform(animatedLocalTransform);
 138
 139     // The SVG specification wants us to clip everything, if clip-path doesn't have a child.
 140     if (clipPath.isEmpty())
 141         clipPath.addRect(FloatRect());
 142     context->clipPath(clipPath, clipRule);
 143     return true;
 144 }
 145
 146 bool RenderSVGResourceClipper::applyClippingToContext(RenderObject* object, const FloatRect& objectBoundingBox,
 147                                                       const FloatRect& repaintRect, GraphicsContext* context)
 148 {
 149     bool missingClipperData = !m_clipper.contains(object);
 150     if (missingClipperData)
 151         m_clipper.set(object, createOwned<ClipperData>().release());
 152
 153     bool shouldCreateClipData = false;
 154     AffineTransform animatedLocalTransform = clipPathElement().animatedLocalTransform();
 155     ClipperData* clipperData = m_clipper.get(object);
 156     if (!clipperData->clipMaskImage) {
 157         if (pathOnlyClipping(context, animatedLocalTransform, objectBoundingBox))
 158             return true;
 159         shouldCreateClipData = true;
 160     }
 161
 162     AffineTransform absoluteTransform;
 163     SVGRenderingContext::calculateTransformationToOutermostCoordinateSystem(object, absoluteTransform);
 164
 165     if (shouldCreateClipData && !repaintRect.isEmpty()) {
 166         if (!SVGRenderingContext::createImageBuffer(repaintRect, absoluteTransform, clipperData->clipMaskImage, ColorSpaceDeviceRGB, Unaccelerated))
 167             return false;
 168
 169         GraphicsContext* maskContext = clipperData->clipMaskImage->context();
 170         ASSERT(maskContext);
 171
 172         maskContext->concatCTM(animatedLocalTransform);
 173
 174         // clipPath can also be clipped by another clipPath.
 175         SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(this);
 176         RenderSVGResourceClipper* clipper;
 177         bool succeeded;
 178         if (resources && (clipper = resources->clipper())) {
 179             GraphicsContextStateSaver stateSaver(*maskContext);
 180
 181             if (!clipper->applyClippingToContext(this, objectBoundingBox, repaintRect, maskContext))
 182                 return false;
 183
 184             succeeded = drawContentIntoMaskImage(clipperData, objectBoundingBox);
 185             // The context restore applies the clipping on non-CG platforms.
 186         } else
 187             succeeded = drawContentIntoMaskImage(clipperData, objectBoundingBox);
 188
 189         if (!succeeded)
 190             clipperData->clipMaskImage.clear();
 191     }
 192
 193     if (!clipperData->clipMaskImage)
 194         return false;
 195
 196     SVGRenderingContext::clipToImageBuffer(context, absoluteTransform, repaintRect, clipperData->clipMaskImage, missingClipperData);
 197     return true;
 198 }
 199
 200 bool RenderSVGResourceClipper::drawContentIntoMaskImage(ClipperData* clipperData, const FloatRect& objectBoundingBox)
 201 {
 202     ASSERT(clipperData);
 203     ASSERT(clipperData->clipMaskImage);
 204
 205     GraphicsContext* maskContext = clipperData->clipMaskImage->context();
 206     ASSERT(maskContext);
 207
 208     AffineTransform maskContentTransformation;
 209     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 210         maskContentTransformation.translate(objectBoundingBox.x(), objectBoundingBox.y());
 211         maskContentTransformation.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 212         maskContext->concatCTM(maskContentTransformation);
 213     }
 214
 215     // Switch to a paint behavior where all children of this <clipPath> will be rendered using special constraints:
 216     // - fill-opacity/stroke-opacity/opacity set to 1
 217     // - masker/filter not applied when rendering the children
 218     // - fill is set to the initial fill paint server (solid, black)
 219     // - stroke is set to the initial stroke paint server (none)
 220     PaintBehavior oldBehavior = view().frameView().paintBehavior();
 221     view().frameView().setPaintBehavior(oldBehavior | PaintBehaviorRenderingSVGMask);
 222
 223     // Draw all clipPath children into a global mask.
 224     auto children = childrenOfType<SVGElement>(&clipPathElement());
 225     for (auto it = children.begin(), end = children.end(); it != end; ++it) {
 226         SVGElement& child = *it;
 227         auto renderer = child.renderer();
 228         if (!renderer)
 229             continue;
 230         if (renderer->needsLayout()) {
 231             view().frameView().setPaintBehavior(oldBehavior);
 232             return false;
 233         }
 234         RenderStyle* style = renderer->style();
 235         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
 236             continue;
 237
 238         WindRule newClipRule = style->svgStyle()->clipRule();
 239         bool isUseElement = child.hasTagName(SVGNames::useTag);
 240         if (isUseElement) {
 241             SVGUseElement& useElement = toSVGUseElement(child);
 242             renderer = useElement.rendererClipChild();
 243             if (!renderer)
 244                 continue;
 245             if (!useElement.hasAttribute(SVGNames::clip_ruleAttr))
 246                 newClipRule = renderer->style()->svgStyle()->clipRule();
 247         }
 248
 249         // Only shapes, paths and texts are allowed for clipping.
 250         if (!renderer->isSVGShape() && !renderer->isSVGText())
 251             continue;
 252
 253         maskContext->setFillRule(newClipRule);
 254
 255         // In the case of a <use> element, we obtained its renderere above, to retrieve its clipRule.
 256         // We have to pass the <use> renderer itself to renderSubtreeToImageBuffer() to apply it's x/y/transform/etc. values when rendering.
 257         // So if isUseElement is true, refetch the childNode->renderer(), as renderer got overriden above.
 258         SVGRenderingContext::renderSubtreeToImageBuffer(clipperData->clipMaskImage.get(), isUseElement ? *child.renderer() : *renderer, maskContentTransformation);
 259     }
 260
 261     view().frameView().setPaintBehavior(oldBehavior);
 262     return true;
 263 }
 264
 265 void RenderSVGResourceClipper::calculateClipContentRepaintRect()
 266 {
 267     // This is a rough heuristic to appraise the clip size and doesn't consider clip on clip.
 268     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
 269         RenderObject* renderer = childNode->renderer();
 270         if (!childNode->isSVGElement() || !renderer)
 271             continue;
 272         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
 273             continue;
 274         RenderStyle* style = renderer->style();
 275         if (!style || style->display() == NONE || style->visibility() != VISIBLE)
 276              continue;
 277         m_clipBoundaries.unite(renderer->localToParentTransform().mapRect(renderer->repaintRectInLocalCoordinates()));
 278     }
 279     m_clipBoundaries = clipPathElement().animatedLocalTransform().mapRect(m_clipBoundaries);
 280 }
 281
 282 bool RenderSVGResourceClipper::hitTestClipContent(const FloatRect& objectBoundingBox, const FloatPoint& nodeAtPoint)
 283 {
 284     FloatPoint point = nodeAtPoint;
 285     if (!SVGRenderSupport::pointInClippingArea(this, point))
 286         return false;
 287
 288     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 289         AffineTransform transform;
 290         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
 291         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 292         point = transform.inverse().mapPoint(point);
 293     }
 294
 295     point = clipPathElement().animatedLocalTransform().inverse().mapPoint(point);
 296
 297     for (Node* childNode = clipPathElement().firstChild(); childNode; childNode = childNode->nextSibling()) {
 298         RenderObject* renderer = childNode->renderer();
 299         if (!childNode->isSVGElement() || !renderer)
 300             continue;
 301         if (!renderer->isSVGShape() && !renderer->isSVGText() && !childNode->hasTagName(SVGNames::useTag))
 302             continue;
 303         IntPoint hitPoint;
 304         HitTestResult result(hitPoint);
 305         if (renderer->nodeAtFloatPoint(HitTestRequest(HitTestRequest::SVGClipContent | HitTestRequest::DisallowShadowContent), result, point, HitTestForeground))
 306             return true;
 307     }
 308
 309     return false;
 310 }
 311
 312 FloatRect RenderSVGResourceClipper::resourceBoundingBox(RenderObject* object)
 313 {
 314     // Resource was not layouted yet. Give back the boundingBox of the object.
 315     if (selfNeedsLayout())
 316         return object->objectBoundingBox();
 317
 318     if (m_clipBoundaries.isEmpty())
 319         calculateClipContentRepaintRect();
 320
 321     if (clipPathElement().clipPathUnits() == SVGUnitTypes::SVG_UNIT_TYPE_OBJECTBOUNDINGBOX) {
 322         FloatRect objectBoundingBox = object->objectBoundingBox();
 323         AffineTransform transform;
 324         transform.translate(objectBoundingBox.x(), objectBoundingBox.y());
 325         transform.scaleNonUniform(objectBoundingBox.width(), objectBoundingBox.height());
 326         return transform.mapRect(m_clipBoundaries);
 327     }
 328
 329     return m_clipBoundaries;
 330 }
 331
 332 }
 333
 334 #endif // ENABLE(SVG)