Regression(r142765) Broke Custom SVG cursors and SVG canvas drawing for Chromium
[WebKit-https.git] / Source / WebCore / svg / graphics / SVGImage.cpp
1 /*
2  * Copyright (C) 2006 Eric Seidel <eric@webkit.org>
3  * Copyright (C) 2008, 2009 Apple Inc. All rights reserved.
4  * Copyright (C) Research In Motion Limited 2011. All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
16  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
18  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
19  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
23  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
25  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
26  */
27
28 #include "config.h"
29
30 #if ENABLE(SVG)
31 #include "SVGImage.h"
32
33 #include "DocumentLoader.h"
34 #include "FrameView.h"
35 #include "ImageBuffer.h"
36 #include "ImageObserver.h"
37 #include "IntRect.h"
38 #include "RenderSVGRoot.h"
39 #include "SVGDocument.h"
40 #include "SVGImageChromeClient.h"
41 #include "SVGSVGElement.h"
42 #include "Settings.h"
43
44 namespace WebCore {
45
46 SVGImage::SVGImage(ImageObserver* observer)
47     : Image(observer)
48 {
49 }
50
51 SVGImage::~SVGImage()
52 {
53     if (m_page) {
54         // Store m_page in a local variable, clearing m_page, so that SVGImageChromeClient knows we're destructed.
55         OwnPtr<Page> currentPage = m_page.release();
56         currentPage->mainFrame()->loader()->frameDetached(); // Break both the loader and view references to the frame
57     }
58
59     // Verify that page teardown destroyed the Chrome
60     ASSERT(!m_chromeClient || !m_chromeClient->image());
61 }
62
63 void SVGImage::setContainerSize(const IntSize& size)
64 {
65     if (!m_page || !usesContainerSize())
66         return;
67
68     Frame* frame = m_page->mainFrame();
69     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
70     if (!rootElement)
71         return;
72     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
73     if (!renderer)
74         return;
75
76     FrameView* view = frameView();
77     view->resize(this->containerSize());
78
79     renderer->setContainerSize(size);
80 }
81
82 IntSize SVGImage::containerSize() const
83 {
84     if (!m_page)
85         return IntSize();
86     Frame* frame = m_page->mainFrame();
87     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
88     if (!rootElement)
89         return IntSize();
90
91     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
92     if (!renderer)
93         return IntSize();
94
95     // If a container size is available it has precedence.
96     IntSize containerSize = renderer->containerSize();
97     if (!containerSize.isEmpty())
98         return containerSize;
99
100     // Assure that a container size is always given for a non-identity zoom level.
101     ASSERT(renderer->style()->effectiveZoom() == 1);
102
103     FloatSize currentSize;
104     if (rootElement->intrinsicWidth().isFixed() && rootElement->intrinsicHeight().isFixed())
105         currentSize = rootElement->currentViewportSize();
106     else
107         currentSize = rootElement->currentViewBoxRect().size();
108
109     if (!currentSize.isEmpty())
110         return IntSize(static_cast<int>(ceilf(currentSize.width())), static_cast<int>(ceilf(currentSize.height())));
111
112     // As last resort, use CSS default intrinsic size.
113     return IntSize(300, 150);
114 }
115
116 void SVGImage::drawForContainer(GraphicsContext* context, const FloatSize containerSize, float zoom, const FloatRect& dstRect,
117     const FloatRect& srcRect, ColorSpace colorSpace, CompositeOperator compositeOp, BlendMode blendMode)
118 {
119     if (!m_page)
120         return;
121
122     ImageObserver* observer = imageObserver();
123     ASSERT(observer);
124
125     // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
126     setImageObserver(0);
127
128     IntSize roundedContainerSize = roundedIntSize(containerSize);
129     setContainerSize(roundedContainerSize);
130
131     FloatRect scaledSrc = srcRect;
132     scaledSrc.scale(1 / zoom);
133
134     // Compensate for the container size rounding by adjusting the source rect.
135     FloatSize adjustedSrcSize = scaledSrc.size();
136     adjustedSrcSize.scale(roundedContainerSize.width() / containerSize.width(), roundedContainerSize.height() / containerSize.height());
137     scaledSrc.setSize(adjustedSrcSize);
138
139     draw(context, dstRect, scaledSrc, colorSpace, compositeOp, blendMode);
140
141     setImageObserver(observer);
142 }
143
144 #if USE(SKIA)
145 // Passes ownership of the native image to the caller so PassNativeImagePtr needs
146 // to be a smart pointer type.
147 PassNativeImagePtr SVGImage::nativeImageForCurrentFrame()
148 {
149     if (!m_page)
150         return 0;
151
152     OwnPtr<ImageBuffer> buffer = ImageBuffer::create(size(), 1);
153     if (!buffer) // failed to allocate image
154         return 0;
155
156     draw(buffer->context(), rect(), rect(), ColorSpaceDeviceRGB, CompositeSourceOver, BlendModeNormal);
157
158     // FIXME: WK(Bug 113657): We should use DontCopyBackingStore here.
159     return buffer->copyImage(CopyBackingStore)->nativeImageForCurrentFrame();
160 }
161 #endif
162
163 void SVGImage::drawPatternForContainer(GraphicsContext* context, const FloatSize containerSize, float zoom, const FloatRect& srcRect,
164     const AffineTransform& patternTransform, const FloatPoint& phase, ColorSpace colorSpace, CompositeOperator compositeOp, const FloatRect& dstRect)
165 {
166     FloatRect zoomedContainerRect = FloatRect(FloatPoint(), containerSize);
167     zoomedContainerRect.scale(zoom);
168
169     // The ImageBuffer size needs to be scaled to match the final resolution.
170     AffineTransform transform = context->getCTM();
171     FloatSize imageBufferScale = FloatSize(transform.xScale(), transform.yScale());
172     ASSERT(imageBufferScale.width());
173     ASSERT(imageBufferScale.height());
174
175     FloatRect imageBufferSize = zoomedContainerRect;
176     imageBufferSize.scale(imageBufferScale.width(), imageBufferScale.height());
177
178     OwnPtr<ImageBuffer> buffer = ImageBuffer::create(expandedIntSize(imageBufferSize.size()), 1);
179     drawForContainer(buffer->context(), containerSize, zoom, imageBufferSize, zoomedContainerRect, ColorSpaceDeviceRGB, CompositeSourceOver, BlendModeNormal);
180     RefPtr<Image> image = buffer->copyImage(DontCopyBackingStore, Unscaled);
181
182     // Adjust the source rect and transform due to the image buffer's scaling.
183     FloatRect scaledSrcRect = srcRect;
184     scaledSrcRect.scale(imageBufferScale.width(), imageBufferScale.height());
185     AffineTransform unscaledPatternTransform(patternTransform);
186     unscaledPatternTransform.scale(1 / imageBufferScale.width(), 1 / imageBufferScale.height());
187
188     image->drawPattern(context, scaledSrcRect, unscaledPatternTransform, phase, colorSpace, compositeOp, dstRect);
189 }
190
191 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp, BlendMode)
192 {
193     if (!m_page)
194         return;
195
196     FrameView* view = frameView();
197
198     GraphicsContextStateSaver stateSaver(*context);
199     context->setCompositeOperation(compositeOp);
200     context->clip(enclosingIntRect(dstRect));
201     if (compositeOp != CompositeSourceOver)
202         context->beginTransparencyLayer(1);
203
204     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
205     
206     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
207     // of the image would be if we were drawing without clipping, and translate accordingly.
208     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
209     FloatPoint destOffset = dstRect.location() - topLeftOffset;
210
211     context->translate(destOffset.x(), destOffset.y());
212     context->scale(scale);
213
214     view->resize(containerSize());
215
216     if (view->needsLayout())
217         view->layout();
218
219     view->paint(context, IntRect(0, 0, view->width(), view->height()));
220
221     if (compositeOp != CompositeSourceOver)
222         context->endTransparencyLayer();
223
224     stateSaver.restore();
225
226     if (imageObserver())
227         imageObserver()->didDraw(this);
228 }
229
230 RenderBox* SVGImage::embeddedContentBox() const
231 {
232     if (!m_page)
233         return 0;
234     Frame* frame = m_page->mainFrame();
235     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
236     if (!rootElement)
237         return 0;
238     return toRenderBox(rootElement->renderer());
239 }
240
241 FrameView* SVGImage::frameView() const
242 {
243     if (!m_page)
244         return 0;
245
246     return m_page->mainFrame()->view();
247 }
248
249 bool SVGImage::hasRelativeWidth() const
250 {
251     if (!m_page)
252         return false;
253     Frame* frame = m_page->mainFrame();
254     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
255     if (!rootElement)
256         return false;
257     return rootElement->intrinsicWidth().isPercent();
258 }
259
260 bool SVGImage::hasRelativeHeight() const
261 {
262     if (!m_page)
263         return false;
264     Frame* frame = m_page->mainFrame();
265     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
266     if (!rootElement)
267         return false;
268     return rootElement->intrinsicHeight().isPercent();
269 }
270
271 void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
272 {
273     if (!m_page)
274         return;
275     Frame* frame = m_page->mainFrame();
276     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
277     if (!rootElement)
278         return;
279
280     intrinsicWidth = rootElement->intrinsicWidth();
281     intrinsicHeight = rootElement->intrinsicHeight();
282     if (rootElement->preserveAspectRatio().align() == SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
283         return;
284
285     intrinsicRatio = rootElement->viewBox().size();
286     if (intrinsicRatio.isEmpty() && intrinsicWidth.isFixed() && intrinsicHeight.isFixed())
287         intrinsicRatio = FloatSize(floatValueForLength(intrinsicWidth, 0), floatValueForLength(intrinsicHeight, 0));
288 }
289
290 // FIXME: support catchUpIfNecessary.
291 void SVGImage::startAnimation(bool /* catchUpIfNecessary */)
292 {
293     if (!m_page)
294         return;
295     Frame* frame = m_page->mainFrame();
296     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
297     if (!rootElement)
298         return;
299     rootElement->unpauseAnimations();
300     rootElement->setCurrentTime(0);
301 }
302
303 void SVGImage::stopAnimation()
304 {
305     if (!m_page)
306         return;
307     Frame* frame = m_page->mainFrame();
308     SVGSVGElement* rootElement = toSVGDocument(frame->document())->rootElement();
309     if (!rootElement)
310         return;
311     rootElement->pauseAnimations();
312 }
313
314 void SVGImage::resetAnimation()
315 {
316     stopAnimation();
317 }
318
319 bool SVGImage::dataChanged(bool allDataReceived)
320 {
321     // Don't do anything if is an empty image.
322     if (!data()->size())
323         return true;
324
325     if (allDataReceived) {
326         static FrameLoaderClient* dummyFrameLoaderClient =  new EmptyFrameLoaderClient;
327
328         Page::PageClients pageClients;
329         fillWithEmptyClients(pageClients);
330         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
331         pageClients.chromeClient = m_chromeClient.get();
332
333         // FIXME: If this SVG ends up loading itself, we might leak the world.
334         // The Cache code does not know about CachedImages holding Frames and
335         // won't know to break the cycle.
336         // This will become an issue when SVGImage will be able to load other
337         // SVGImage objects, but we're safe now, because SVGImage can only be
338         // loaded by a top-level document.
339         m_page = adoptPtr(new Page(pageClients));
340         m_page->settings()->setMediaEnabled(false);
341         m_page->settings()->setScriptEnabled(false);
342         m_page->settings()->setPluginsEnabled(false);
343
344         RefPtr<Frame> frame = Frame::create(m_page.get(), 0, dummyFrameLoaderClient);
345         frame->setView(FrameView::create(frame.get()));
346         frame->init();
347         FrameLoader* loader = frame->loader();
348         loader->forceSandboxFlags(SandboxAll);
349
350         frame->view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
351         frame->view()->setTransparent(true); // SVG Images are transparent.
352
353         ASSERT(loader->activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
354         loader->activeDocumentLoader()->writer()->setMIMEType("image/svg+xml");
355         loader->activeDocumentLoader()->writer()->begin(KURL()); // create the empty document
356         loader->activeDocumentLoader()->writer()->addData(data()->data(), data()->size());
357         loader->activeDocumentLoader()->writer()->end();
358
359         // Set the intrinsic size before a container size is available.
360         m_intrinsicSize = containerSize();
361     }
362
363     return m_page;
364 }
365
366 String SVGImage::filenameExtension() const
367 {
368     return "svg";
369 }
370
371 void SVGImage::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
372 {
373     MemoryClassInfo info(memoryObjectInfo, this, WebCoreMemoryTypes::CachedResourceImage);
374     Image::reportMemoryUsage(memoryObjectInfo);
375     info.addMember(m_chromeClient, "chromeClient");
376     info.addMember(m_page, "page");
377 }
378
379 }
380
381 #endif // ENABLE(SVG)