Use SVGImage instead of cached image when drawing without a render tree.
[WebKit-https.git] / Source / WebCore / svg / graphics / SVGImageCache.cpp
1 /*
2  * Copyright (C) 2011 Research In Motion Limited. All rights reserved.
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Library General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  * Library General Public License for more details.
13  *
14  * You should have received a copy of the GNU Library General Public License
15  * along with this library; see the file COPYING.LIB.  If not, write to
16  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  * Boston, MA 02110-1301, USA.
18  */
19
20 #include "config.h"
21 #include "SVGImageCache.h"
22
23 #if ENABLE(SVG)
24 #include "CachedImage.h"
25 #include "FrameView.h"
26 #include "GraphicsContext.h"
27 #include "ImageBuffer.h"
28 #include "Page.h"
29 #include "RenderSVGRoot.h"
30 #include "SVGImage.h"
31
32 namespace WebCore {
33
34 SVGImageCache::SVGImageCache(SVGImage* svgImage)
35     : m_svgImage(svgImage)
36     , m_redrawTimer(this, &SVGImageCache::redrawTimerFired)
37 {
38     ASSERT(m_svgImage);
39 }
40
41 SVGImageCache::~SVGImageCache()
42 {
43     m_sizeAndScalesMap.clear();
44
45     ImageDataMap::iterator end = m_imageDataMap.end();
46     for (ImageDataMap::iterator it = m_imageDataMap.begin(); it != end; ++it) {
47         // Checks if the client (it->first) is still valid. The client should remove itself from this
48         // cache before its end of life, otherwise the following ASSERT will crash on pure virtual
49         // function call or a general crash.
50         ASSERT(it->first->resourceClientType() == CachedImageClient::expectedType());
51         delete it->second.buffer;
52     }
53
54     m_imageDataMap.clear();
55 }
56
57 void SVGImageCache::removeClientFromCache(const CachedImageClient* client)
58 {
59     ASSERT(client);
60     m_sizeAndScalesMap.remove(client);
61
62     ImageDataMap::iterator it = m_imageDataMap.find(client);
63     if (it == m_imageDataMap.end())
64         return;
65
66     delete it->second.buffer;
67     m_imageDataMap.remove(it);
68 }
69
70 void SVGImageCache::setRequestedSizeAndScales(const CachedImageClient* client, const SizeAndScales& sizeAndScales)
71 {
72     ASSERT(client);
73     ASSERT(!sizeAndScales.size.isEmpty());
74     m_sizeAndScalesMap.set(client, sizeAndScales);
75 }
76
77 SVGImageCache::SizeAndScales SVGImageCache::requestedSizeAndScales(const CachedImageClient* client) const
78 {
79     if (!client)
80         return SizeAndScales();
81     SizeAndScalesMap::const_iterator it = m_sizeAndScalesMap.find(client);
82     if (it == m_sizeAndScalesMap.end())
83         return SizeAndScales();
84     return it->second;
85 }
86
87 void SVGImageCache::imageContentChanged()
88 {
89     ImageDataMap::iterator end = m_imageDataMap.end();
90     for (ImageDataMap::iterator it = m_imageDataMap.begin(); it != end; ++it)
91         it->second.imageNeedsUpdate = true;
92
93     // If we're in the middle of layout, start redrawing dirty
94     // images on a timer; otherwise it's safe to draw immediately.
95     FrameView* frameView = m_svgImage->frameView();
96     if (frameView && (frameView->needsLayout() || frameView->isInLayout())) {
97         if (!m_redrawTimer.isActive())
98             m_redrawTimer.startOneShot(0);
99     } else
100        redraw();
101 }
102
103 void SVGImageCache::redraw()
104 {
105     ImageDataMap::iterator end = m_imageDataMap.end();
106     for (ImageDataMap::iterator it = m_imageDataMap.begin(); it != end; ++it) {
107         ImageData& data = it->second;
108         if (!data.imageNeedsUpdate)
109             continue;
110         // If the content changed we redraw using our existing ImageBuffer.
111         ASSERT(data.buffer);
112         ASSERT(data.image);
113         m_svgImage->drawSVGToImageBuffer(data.buffer, data.sizeAndScales.size, data.sizeAndScales.zoom, data.sizeAndScales.scale, SVGImage::ClearImageBuffer);
114         data.image = data.buffer->copyImage(CopyBackingStore);
115         data.imageNeedsUpdate = false;
116     }
117     ASSERT(m_svgImage->imageObserver());
118     m_svgImage->imageObserver()->animationAdvanced(m_svgImage);
119 }
120
121 void SVGImageCache::redrawTimerFired(Timer<SVGImageCache>*)
122 {
123     // We have no guarantee that the frame does not require layout when the timer fired.
124     // So be sure to check again in case it is still not safe to run redraw.
125     FrameView* frameView = m_svgImage->frameView();
126     if (frameView && (frameView->needsLayout() || frameView->isInLayout())) {
127         if (!m_redrawTimer.isActive())
128             m_redrawTimer.startOneShot(0);
129     } else
130        redraw();
131 }
132
133 Image* SVGImageCache::lookupOrCreateBitmapImageForRenderer(const RenderObject* renderer)
134 {
135     if (!renderer)
136         return Image::nullImage();
137
138     const CachedImageClient* client = renderer;
139
140     // The cache needs to know the size of the renderer before querying an image for it.
141     SizeAndScalesMap::iterator sizeIt = m_sizeAndScalesMap.find(renderer);
142     if (sizeIt == m_sizeAndScalesMap.end())
143         return Image::nullImage();
144
145     IntSize size = sizeIt->second.size;
146     float zoom = sizeIt->second.zoom;
147     float scale = sizeIt->second.scale;
148
149     // FIXME (85335): This needs to take CSS transform scale into account as well.
150     Page* page = renderer->document()->page();
151     if (!scale)
152         scale = page->deviceScaleFactor() * page->pageScaleFactor();
153
154     ASSERT(!size.isEmpty());
155
156     // Lookup image for client in cache and eventually update it.
157     ImageDataMap::iterator it = m_imageDataMap.find(client);
158     if (it != m_imageDataMap.end()) {
159         ImageData& data = it->second;
160
161         // Common case: image size & zoom remained the same.
162         if (data.sizeAndScales.size == size && data.sizeAndScales.zoom == zoom && data.sizeAndScales.scale == scale)
163             return data.image.get();
164
165         // If the image size for the client changed, we have to delete the buffer, remove the item from the cache and recreate it.
166         delete data.buffer;
167         m_imageDataMap.remove(it);
168     }
169
170     FloatSize scaledSize(size);
171     scaledSize.scale(scale);
172
173     // Create and cache new image and image buffer at requested size.
174     OwnPtr<ImageBuffer> newBuffer = ImageBuffer::create(expandedIntSize(scaledSize), 1);
175     if (!newBuffer)
176         return Image::nullImage();
177
178     m_svgImage->drawSVGToImageBuffer(newBuffer.get(), size, zoom, scale, SVGImage::DontClearImageBuffer);
179
180     RefPtr<Image> newImage = newBuffer->copyImage(CopyBackingStore);
181     Image* newImagePtr = newImage.get();
182     ASSERT(newImagePtr);
183
184     m_imageDataMap.add(client, ImageData(newBuffer.leakPtr(), newImage.release(), SizeAndScales(size, zoom, scale)));
185     return newImagePtr;
186 }
187
188 } // namespace WebCore
189
190 #endif // ENABLE(SVG)