Web Inspector: NMI: extract MemoryObjectType constants from MemoryInstrumentation.
[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 "EmptyClients.h"
35 #include "FrameView.h"
36 #include "ImageBuffer.h"
37 #include "ImageObserver.h"
38 #include "RenderSVGRoot.h"
39 #include "SVGDocument.h"
40 #include "SVGSVGElement.h"
41 #include "Settings.h"
42
43 namespace WebCore {
44
45 class SVGImageChromeClient : public EmptyChromeClient {
46     WTF_MAKE_NONCOPYABLE(SVGImageChromeClient); WTF_MAKE_FAST_ALLOCATED;
47 public:
48     SVGImageChromeClient(SVGImage* image)
49         : m_image(image)
50     {
51     }
52
53     virtual bool isSVGImageChromeClient() const { return true; }
54     SVGImage* image() const { return m_image; }
55
56 private:
57     virtual void chromeDestroyed()
58     {
59         m_image = 0;
60     }
61
62     virtual void invalidateContentsAndRootView(const IntRect& r, bool)
63     {
64         // If m_image->m_page is null, we're being destructed, don't fire changedInRect() in that case.
65         if (m_image && m_image->imageObserver() && m_image->m_page)
66             m_image->imageObserver()->changedInRect(m_image, r);
67     }
68
69     SVGImage* m_image;
70 };
71
72 SVGImage::SVGImage(ImageObserver* observer)
73     : Image(observer)
74 {
75 }
76
77 SVGImage::~SVGImage()
78 {
79     if (m_page) {
80         // Store m_page in a local variable, clearing m_page, so that SVGImageChromeClient knows we're destructed.
81         OwnPtr<Page> currentPage = m_page.release();
82         currentPage->mainFrame()->loader()->frameDetached(); // Break both the loader and view references to the frame
83     }
84
85     // Verify that page teardown destroyed the Chrome
86     ASSERT(!m_chromeClient || !m_chromeClient->image());
87 }
88
89 void SVGImage::setContainerSize(const IntSize&)
90 {
91     // SVGImageCache already intercepted this call, as it stores & caches the desired container sizes & zoom levels.
92     ASSERT_NOT_REACHED();
93 }
94
95 IntSize SVGImage::size() const
96 {
97     if (!m_page)
98         return IntSize();
99     Frame* frame = m_page->mainFrame();
100     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
101     if (!rootElement)
102         return IntSize();
103
104     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
105     if (!renderer)
106         return IntSize();
107
108     // If a container size is available it has precedence.
109     IntSize containerSize = renderer->containerSize();
110     if (!containerSize.isEmpty())
111         return containerSize;
112
113     // Assure that a container size is always given for a non-identity zoom level.
114     ASSERT(renderer->style()->effectiveZoom() == 1);
115
116     FloatSize currentSize;
117     if (rootElement->intrinsicWidth().isFixed() && rootElement->intrinsicHeight().isFixed())
118         currentSize = rootElement->currentViewportSize();
119     else
120         currentSize = rootElement->currentViewBoxRect().size();
121
122     if (!currentSize.isEmpty())
123         return IntSize(static_cast<int>(ceilf(currentSize.width())), static_cast<int>(ceilf(currentSize.height())));
124
125     // As last resort, use CSS default intrinsic size.
126     return IntSize(300, 150);
127 }
128
129 void SVGImage::drawSVGToImageBuffer(ImageBuffer* buffer, const IntSize& size, float zoom, float scale, ShouldClearBuffer shouldClear)
130 {
131     // FIXME: This doesn't work correctly with animations. If an image contains animations, that say run for 2 seconds,
132     // and we currently have one <img> that displays us. If we open another document referencing the same SVGImage it
133     // will display the document at a time where animations already ran - even though it has its own ImageBuffer.
134     // We currently don't implement SVGSVGElement::setCurrentTime, and can NOT go back in time, once animations started.
135     // There's no way to fix this besides avoiding style/attribute mutations from SVGAnimationElement.
136     ASSERT(buffer);
137     ASSERT(!size.isEmpty());
138
139     if (!m_page)
140         return;
141
142     Frame* frame = m_page->mainFrame();
143     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
144     if (!rootElement)
145         return;
146     RenderSVGRoot* renderer = toRenderSVGRoot(rootElement->renderer());
147     if (!renderer)
148         return;
149
150     // Draw image at requested size.
151     ImageObserver* observer = imageObserver();
152     ASSERT(observer);
153
154     // Temporarily reset image observer, we don't want to receive any changeInRect() calls due to this relayout.
155     setImageObserver(0);
156
157     // Disable repainting; we don't want deferred repaints to schedule any timers due to this relayout.
158     frame->view()->beginDisableRepaints();
159
160     renderer->setContainerSize(size);
161     frame->view()->resize(this->size());
162
163     if (zoom != 1)
164         frame->setPageZoomFactor(zoom);
165
166     // Eventually clear image buffer.
167     IntRect rect(IntPoint(), size);
168
169     FloatRect scaledRect(rect);
170     scaledRect.scale(scale);
171
172     if (shouldClear == ClearImageBuffer)
173         buffer->context()->clearRect(enclosingIntRect(scaledRect));
174
175     // Draw SVG on top of ImageBuffer.
176     draw(buffer->context(), enclosingIntRect(scaledRect), rect, ColorSpaceDeviceRGB, CompositeSourceOver);
177
178     // Reset container size & zoom to initial state. Otherwhise the size() of this
179     // image would return whatever last size was set by drawSVGToImageBuffer().
180     if (zoom != 1)
181         frame->setPageZoomFactor(1);
182
183     renderer->setContainerSize(IntSize());
184     frame->view()->resize(this->size());
185     if (frame->view()->needsLayout())
186         frame->view()->layout();
187
188     setImageObserver(observer);
189
190     frame->view()->endDisableRepaints();
191 }
192
193 void SVGImage::draw(GraphicsContext* context, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace, CompositeOperator compositeOp)
194 {
195     if (!m_page)
196         return;
197
198     FrameView* view = frameView();
199
200     GraphicsContextStateSaver stateSaver(*context);
201     context->setCompositeOperation(compositeOp);
202     context->clip(enclosingIntRect(dstRect));
203     if (compositeOp != CompositeSourceOver)
204         context->beginTransparencyLayer(1);
205
206     FloatSize scale(dstRect.width() / srcRect.width(), dstRect.height() / srcRect.height());
207     
208     // We can only draw the entire frame, clipped to the rect we want. So compute where the top left
209     // of the image would be if we were drawing without clipping, and translate accordingly.
210     FloatSize topLeftOffset(srcRect.location().x() * scale.width(), srcRect.location().y() * scale.height());
211     FloatPoint destOffset = dstRect.location() - topLeftOffset;
212
213     context->translate(destOffset.x(), destOffset.y());
214     context->scale(scale);
215
216     view->resize(size());
217
218     if (view->needsLayout())
219         view->layout();
220
221     view->paint(context, IntRect(0, 0, view->width(), view->height()));
222
223     if (compositeOp != CompositeSourceOver)
224         context->endTransparencyLayer();
225
226     stateSaver.restore();
227
228     if (imageObserver())
229         imageObserver()->didDraw(this);
230 }
231
232 RenderBox* SVGImage::embeddedContentBox() const
233 {
234     if (!m_page)
235         return 0;
236     Frame* frame = m_page->mainFrame();
237     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
238     if (!rootElement)
239         return 0;
240     return toRenderBox(rootElement->renderer());
241 }
242
243 FrameView* SVGImage::frameView() const
244 {
245     if (!m_page)
246         return 0;
247
248     return m_page->mainFrame()->view();
249 }
250
251 bool SVGImage::hasRelativeWidth() const
252 {
253     if (!m_page)
254         return false;
255     Frame* frame = m_page->mainFrame();
256     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
257     if (!rootElement)
258         return false;
259     return rootElement->intrinsicWidth().isPercent();
260 }
261
262 bool SVGImage::hasRelativeHeight() const
263 {
264     if (!m_page)
265         return false;
266     Frame* frame = m_page->mainFrame();
267     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
268     if (!rootElement)
269         return false;
270     return rootElement->intrinsicHeight().isPercent();
271 }
272
273 void SVGImage::computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio)
274 {
275     if (!m_page)
276         return;
277     Frame* frame = m_page->mainFrame();
278     SVGSVGElement* rootElement = static_cast<SVGDocument*>(frame->document())->rootElement();
279     if (!rootElement)
280         return;
281
282     intrinsicWidth = rootElement->intrinsicWidth();
283     intrinsicHeight = rootElement->intrinsicHeight();
284     if (rootElement->preserveAspectRatio().align() == SVGPreserveAspectRatio::SVG_PRESERVEASPECTRATIO_NONE)
285         return;
286
287     intrinsicRatio = rootElement->viewBox().size();
288     if (intrinsicRatio.isEmpty() && intrinsicWidth.isFixed() && intrinsicHeight.isFixed())
289         intrinsicRatio = FloatSize(floatValueForLength(intrinsicWidth, 0), floatValueForLength(intrinsicHeight, 0));
290 }
291
292 NativeImagePtr SVGImage::nativeImageForCurrentFrame()
293 {
294     // FIXME: In order to support dynamic SVGs we need to have a way to invalidate this
295     // frame cache, or better yet, not use a cache for tiled drawing at all, instead
296     // having a tiled drawing callback (hopefully non-virtual).
297     if (!m_frameCache) {
298         if (!m_page)
299             return 0;
300         OwnPtr<ImageBuffer> buffer = ImageBuffer::create(size(), 1);
301         if (!buffer) // failed to allocate image
302             return 0;
303         draw(buffer->context(), rect(), rect(), ColorSpaceDeviceRGB, CompositeSourceOver);
304         m_frameCache = buffer->copyImage(CopyBackingStore);
305     }
306     return m_frameCache->nativeImageForCurrentFrame();
307 }
308
309 bool SVGImage::dataChanged(bool allDataReceived)
310 {
311     // Don't do anything if is an empty image.
312     if (!data()->size())
313         return true;
314
315     if (allDataReceived) {
316         static FrameLoaderClient* dummyFrameLoaderClient =  new EmptyFrameLoaderClient;
317
318         Page::PageClients pageClients;
319         fillWithEmptyClients(pageClients);
320         m_chromeClient = adoptPtr(new SVGImageChromeClient(this));
321         pageClients.chromeClient = m_chromeClient.get();
322
323         // FIXME: If this SVG ends up loading itself, we might leak the world.
324         // The Cache code does not know about CachedImages holding Frames and
325         // won't know to break the cycle.
326         // This will become an issue when SVGImage will be able to load other
327         // SVGImage objects, but we're safe now, because SVGImage can only be
328         // loaded by a top-level document.
329         m_page = adoptPtr(new Page(pageClients));
330         m_page->settings()->setMediaEnabled(false);
331         m_page->settings()->setScriptEnabled(false);
332         m_page->settings()->setPluginsEnabled(false);
333
334         RefPtr<Frame> frame = Frame::create(m_page.get(), 0, dummyFrameLoaderClient);
335         frame->setView(FrameView::create(frame.get()));
336         frame->init();
337         FrameLoader* loader = frame->loader();
338         loader->forceSandboxFlags(SandboxAll);
339
340         frame->view()->setCanHaveScrollbars(false); // SVG Images will always synthesize a viewBox, if it's not available, and thus never see scrollbars.
341         frame->view()->setTransparent(true); // SVG Images are transparent.
342
343         ASSERT(loader->activeDocumentLoader()); // DocumentLoader should have been created by frame->init().
344         loader->activeDocumentLoader()->writer()->setMIMEType("image/svg+xml");
345         loader->activeDocumentLoader()->writer()->begin(KURL()); // create the empty document
346         loader->activeDocumentLoader()->writer()->addData(data()->data(), data()->size());
347         loader->activeDocumentLoader()->writer()->end();
348     }
349
350     return m_page;
351 }
352
353 String SVGImage::filenameExtension() const
354 {
355     return "svg";
356 }
357
358 void SVGImage::reportMemoryUsage(MemoryObjectInfo* memoryObjectInfo) const
359 {
360     MemoryClassInfo info(memoryObjectInfo, this, WebCoreMemoryTypes::CachedResourceImage);
361     Image::reportMemoryUsage(memoryObjectInfo);
362     info.addMember(m_chromeClient);
363     info.addMember(m_page);
364     info.addInstrumentedMember(m_frameCache);
365 }
366
367 }
368
369 #endif // ENABLE(SVG)