Source/WebCore/rendering/svg/SVGRenderingContext.cpp

   1 /*
   2  * Copyright (C) 2007, 2008 Rob Buis <buis@kde.org>
   3  * Copyright (C) 2007 Nikolas Zimmermann <zimmermann@kde.org>
   4  * Copyright (C) 2007 Eric Seidel <eric@webkit.org>
   5  * Copyright (C) 2009 Google, Inc.  All rights reserved.
   6  * Copyright (C) 2009 Dirk Schulze <krit@webkit.org>
   7  * Copyright (C) Research In Motion Limited 2009-2010. All rights reserved.
   8  *
   9  * This library is free software; you can redistribute it and/or
  10  * modify it under the terms of the GNU Library General Public
  11  * License as published by the Free Software Foundation; either
  12  * version 2 of the License, or (at your option) any later version.
  13  *
  14  * This library is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * Library General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU Library General Public License
  20  * along with this library; see the file COPYING.LIB.  If not, write to
  21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  22  * Boston, MA 02110-1301, USA.
  23  */
  24
  25 #include "config.h"
  26
  27 #if ENABLE(SVG)
  28 #include "SVGRenderingContext.h"
  29
  30 #include "BasicShapes.h"
  31 #include "Frame.h"
  32 #include "FrameView.h"
  33 #include "RenderSVGResource.h"
  34 #include "RenderSVGResourceClipper.h"
  35 #include "RenderSVGResourceFilter.h"
  36 #include "RenderSVGResourceMasker.h"
  37 #include "SVGResources.h"
  38 #include "SVGResourcesCache.h"
  39
  40 static int kMaxImageBufferSize = 4096;
  41
  42 namespace WebCore {
  43
  44 static inline bool isRenderingMaskImage(RenderObject* object)
  45 {
  46     if (object->frame() && object->frame()->view())
  47         return object->frame()->view()->paintBehavior() & PaintBehaviorRenderingSVGMask;
  48     return false;
  49 }
  50
  51 SVGRenderingContext::~SVGRenderingContext()
  52 {
  53     // Fast path if we don't need to restore anything.
  54     if (!(m_renderingFlags & ActionsNeeded))
  55         return;
  56
  57     ASSERT(m_object && m_paintInfo);
  58
  59 #if ENABLE(FILTERS)
  60     if (m_renderingFlags & EndFilterLayer) {
  61         ASSERT(m_filter);
  62         m_filter->postApplyResource(static_cast<RenderSVGShape*>(m_object), m_paintInfo->context, ApplyToDefaultMode, 0, 0);
  63         m_paintInfo->context = m_savedContext;
  64         m_paintInfo->rect = m_savedPaintRect;
  65     }
  66 #endif
  67
  68     if (m_renderingFlags & EndOpacityLayer)
  69         m_paintInfo->context->endTransparencyLayer();
  70
  71     if (m_renderingFlags & EndShadowLayer)
  72         m_paintInfo->context->endTransparencyLayer();
  73
  74     if (m_renderingFlags & RestoreGraphicsContext)
  75         m_paintInfo->context->restore();
  76 }
  77
  78 void SVGRenderingContext::prepareToRenderSVGContent(RenderObject* object, PaintInfo& paintInfo, NeedsGraphicsContextSave needsGraphicsContextSave)
  79 {
  80     ASSERT(object);
  81
  82 #ifndef NDEBUG
  83     // This function must not be called twice!
  84     ASSERT(!(m_renderingFlags & PrepareToRenderSVGContentWasCalled));
  85     m_renderingFlags |= PrepareToRenderSVGContentWasCalled;
  86 #endif
  87
  88     m_object = object;
  89     m_paintInfo = &paintInfo;
  90 #if ENABLE(FILTERS)
  91     m_filter = 0;
  92 #endif
  93
  94     // We need to save / restore the context even if the initialization failed.
  95     if (needsGraphicsContextSave == SaveGraphicsContext) {
  96         m_paintInfo->context->save();
  97         m_renderingFlags |= RestoreGraphicsContext;
  98     }
  99
 100     RenderStyle* style = m_object->style();
 101     ASSERT(style);
 102
 103     const SVGRenderStyle* svgStyle = style->svgStyle();
 104     ASSERT(svgStyle);
 105
 106     // Setup transparency layers before setting up SVG resources!
 107     bool isRenderingMask = isRenderingMaskImage(m_object);
 108     float opacity = isRenderingMask ? 1 : style->opacity();
 109     const ShadowData* shadow = svgStyle->shadow();
 110     if (opacity < 1 || shadow) {
 111         FloatRect repaintRect = m_object->repaintRectInLocalCoordinates();
 112
 113         if (opacity < 1) {
 114             m_paintInfo->context->clip(repaintRect);
 115             m_paintInfo->context->beginTransparencyLayer(opacity);
 116             m_renderingFlags |= EndOpacityLayer;
 117         }
 118
 119         if (shadow) {
 120             m_paintInfo->context->clip(repaintRect);
 121             m_paintInfo->context->setShadow(IntSize(roundToInt(shadow->x()), roundToInt(shadow->y())), shadow->blur(), shadow->color(), style->colorSpace());
 122             m_paintInfo->context->beginTransparencyLayer(1);
 123             m_renderingFlags |= EndShadowLayer;
 124         }
 125     }
 126
 127     ClipPathOperation* clipPathOperation = style->clipPath();
 128     if (clipPathOperation && clipPathOperation->getOperationType() == ClipPathOperation::SHAPE) {
 129         ShapeClipPathOperation* clipPath = static_cast<ShapeClipPathOperation*>(clipPathOperation);
 130         m_paintInfo->context->clipPath(clipPath->path(object->objectBoundingBox()), clipPath->windRule());
 131     }
 132
 133     SVGResources* resources = SVGResourcesCache::cachedResourcesForRenderObject(m_object);
 134     if (!resources) {
 135 #if ENABLE(FILTERS)
 136         if (svgStyle->hasFilter())
 137             return;
 138 #endif
 139         m_renderingFlags |= RenderingPrepared;
 140         return;
 141     }
 142
 143     if (!isRenderingMask) {
 144         if (RenderSVGResourceMasker* masker = resources->masker()) {
 145             if (!masker->applyResource(m_object, style, m_paintInfo->context, ApplyToDefaultMode))
 146                 return;
 147         }
 148     }
 149
 150     RenderSVGResourceClipper* clipper = resources->clipper();
 151     if (!clipPathOperation && clipper) {
 152         if (!clipper->applyResource(m_object, style, m_paintInfo->context, ApplyToDefaultMode))
 153             return;
 154     }
 155
 156 #if ENABLE(FILTERS)
 157     if (!isRenderingMask) {
 158         m_filter = resources->filter();
 159         if (m_filter) {
 160             m_savedContext = m_paintInfo->context;
 161             m_savedPaintRect = m_paintInfo->rect;
 162             // Return with false here may mean that we don't need to draw the content
 163             // (because it was either drawn before or empty) but we still need to apply the filter.
 164             m_renderingFlags |= EndFilterLayer;
 165             if (!m_filter->applyResource(m_object, style, m_paintInfo->context, ApplyToDefaultMode))
 166                 return;
 167
 168             // Since we're caching the resulting bitmap and do not invalidate it on repaint rect
 169             // changes, we need to paint the whole filter region. Otherwise, elements not visible
 170             // at the time of the initial paint (due to scrolling, window size, etc.) will never
 171             // be drawn.
 172             m_paintInfo->rect = IntRect(m_filter->drawingRegion(m_object));
 173         }
 174     }
 175 #endif
 176
 177     m_renderingFlags |= RenderingPrepared;
 178 }
 179
 180 static AffineTransform& currentContentTransformation()
 181 {
 182     DEFINE_STATIC_LOCAL(AffineTransform, s_currentContentTransformation, ());
 183     return s_currentContentTransformation;
 184 }
 185
 186 float SVGRenderingContext::calculateScreenFontSizeScalingFactor(const RenderObject* renderer)
 187 {
 188     ASSERT(renderer);
 189
 190     AffineTransform ctm;
 191     calculateTransformationToOutermostSVGCoordinateSystem(renderer, ctm);
 192     return narrowPrecisionToFloat(sqrt((pow(ctm.xScale(), 2) + pow(ctm.yScale(), 2)) / 2));
 193 }
 194
 195 void SVGRenderingContext::calculateTransformationToOutermostSVGCoordinateSystem(const RenderObject* renderer, AffineTransform& absoluteTransform)
 196 {
 197     const RenderObject* current = renderer;
 198     ASSERT(current);
 199
 200     absoluteTransform = currentContentTransformation();
 201     while (current) {
 202         absoluteTransform = current->localToParentTransform() * absoluteTransform;
 203         if (current->isSVGRoot())
 204             break;
 205         current = current->parent();
 206     }
 207 }
 208
 209 bool SVGRenderingContext::createImageBuffer(const FloatRect& targetRect, const AffineTransform& absoluteTransform, OwnPtr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
 210 {
 211     IntRect paintRect = calculateImageBufferRect(targetRect, absoluteTransform);
 212     // Don't create empty ImageBuffers.
 213     if (paintRect.isEmpty())
 214         return false;
 215
 216     IntSize clampedSize = clampedAbsoluteSize(paintRect.size());
 217     OwnPtr<ImageBuffer> image = ImageBuffer::create(clampedSize, 1, colorSpace, renderingMode);
 218     if (!image)
 219         return false;
 220
 221     GraphicsContext* imageContext = image->context();
 222     ASSERT(imageContext);
 223
 224     imageContext->scale(FloatSize(static_cast<float>(clampedSize.width()) / paintRect.width(),
 225                                   static_cast<float>(clampedSize.height()) / paintRect.height()));
 226     imageContext->translate(-paintRect.x(), -paintRect.y());
 227     imageContext->concatCTM(absoluteTransform);
 228
 229     imageBuffer = image.release();
 230     return true;
 231 }
 232
 233 bool SVGRenderingContext::createImageBufferForPattern(const FloatRect& absoluteTargetRect, const FloatRect& clampedAbsoluteTargetRect, OwnPtr<ImageBuffer>& imageBuffer, ColorSpace colorSpace, RenderingMode renderingMode)
 234 {
 235     IntSize imageSize(roundedIntSize(clampedAbsoluteTargetRect.size()));
 236     IntSize unclampedImageSize(roundedIntSize(absoluteTargetRect.size()));
 237
 238     // Don't create empty ImageBuffers.
 239     if (imageSize.isEmpty())
 240         return false;
 241
 242     OwnPtr<ImageBuffer> image = ImageBuffer::create(imageSize, 1, colorSpace, renderingMode);
 243     if (!image)
 244         return false;
 245
 246     GraphicsContext* imageContext = image->context();
 247     ASSERT(imageContext);
 248
 249     // Compensate rounding effects, as the absolute target rect is using floating-point numbers and the image buffer size is integer.
 250     imageContext->scale(FloatSize(unclampedImageSize.width() / absoluteTargetRect.width(), unclampedImageSize.height() / absoluteTargetRect.height()));
 251
 252     imageBuffer = image.release();
 253     return true;
 254 }
 255
 256 void SVGRenderingContext::renderSubtreeToImageBuffer(ImageBuffer* image, RenderObject* item, const AffineTransform& subtreeContentTransformation)
 257 {
 258     ASSERT(item);
 259     ASSERT(image);
 260     ASSERT(image->context());
 261
 262     PaintInfo info(image->context(), PaintInfo::infiniteRect(), PaintPhaseForeground, PaintBehaviorNormal);
 263
 264     AffineTransform& contentTransformation = currentContentTransformation();
 265     AffineTransform savedContentTransformation = contentTransformation;
 266     contentTransformation = subtreeContentTransformation * contentTransformation;
 267
 268     ASSERT(!item->needsLayout());
 269     item->paint(info, IntPoint());
 270
 271     contentTransformation = savedContentTransformation;
 272 }
 273
 274 void SVGRenderingContext::clipToImageBuffer(GraphicsContext* context, const AffineTransform& absoluteTransform, const FloatRect& targetRect, OwnPtr<ImageBuffer>& imageBuffer, bool safeToClear)
 275 {
 276     ASSERT(context);
 277     ASSERT(imageBuffer);
 278
 279     FloatRect absoluteTargetRect = calculateImageBufferRect(targetRect, absoluteTransform);
 280
 281     // The mask image has been created in the absolute coordinate space, as the image should not be scaled.
 282     // So the actual masking process has to be done in the absolute coordinate space as well.
 283     context->concatCTM(absoluteTransform.inverse());
 284     context->clipToImageBuffer(imageBuffer.get(), absoluteTargetRect);
 285     context->concatCTM(absoluteTransform);
 286
 287     // When nesting resources, with objectBoundingBox as content unit types, there's no use in caching the
 288     // resulting image buffer as the parent resource already caches the result.
 289     if (safeToClear && !currentContentTransformation().isIdentity())
 290         imageBuffer.clear();
 291 }
 292
 293 FloatRect SVGRenderingContext::clampedAbsoluteTargetRect(const FloatRect& absoluteTargetRect)
 294 {
 295     const FloatSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
 296     return FloatRect(absoluteTargetRect.location(), absoluteTargetRect.size().shrunkTo(maxImageBufferSize));
 297 }
 298
 299 IntSize SVGRenderingContext::clampedAbsoluteSize(const IntSize& absoluteSize)
 300 {
 301     const IntSize maxImageBufferSize(kMaxImageBufferSize, kMaxImageBufferSize);
 302     return absoluteSize.shrunkTo(maxImageBufferSize);
 303 }
 304
 305 void SVGRenderingContext::clear2DRotation(AffineTransform& transform)
 306 {
 307     AffineTransform::DecomposedType decomposition;
 308     transform.decompose(decomposition);
 309     decomposition.angle = 0;
 310     transform.recompose(decomposition);
 311 }
 312
 313 }
 314
 315 #endif