When navigating, discard decoded image data that is only live due to page cache.
[WebKit-https.git] / Source / WebCore / loader / cache / CachedImage.h
1 /*
2     Copyright (C) 1998 Lars Knoll (knoll@mpi-hd.mpg.de)
3     Copyright (C) 2001 Dirk Mueller <mueller@kde.org>
4     Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
5     Copyright (C) 2004, 2005, 2006, 2007 Apple Inc. All rights reserved.
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 #ifndef CachedImage_h
24 #define CachedImage_h
25
26 #include "CachedResource.h"
27 #include "Image.h"
28 #include "ImageObserver.h"
29 #include "IntRect.h"
30 #include "IntSizeHash.h"
31 #include "LayoutSize.h"
32 #include "SVGImageCache.h"
33 #include <wtf/HashMap.h>
34 #include <wtf/Vector.h>
35
36 namespace WebCore {
37
38 class CachedImageClient;
39 class CachedResourceLoader;
40 class FloatSize;
41 class MemoryCache;
42 class RenderElement;
43 class RenderObject;
44 class SecurityOrigin;
45
46 struct Length;
47
48 class CachedImage final : public CachedResource, public ImageObserver {
49     friend class MemoryCache;
50
51 public:
52     enum CacheBehaviorType { AutomaticallyCached, ManuallyCached };
53
54     CachedImage(const ResourceRequest&, SessionID);
55     CachedImage(Image*, SessionID);
56     CachedImage(const URL&, Image*, SessionID);
57     CachedImage(const URL&, Image*, CacheBehaviorType, SessionID);
58     virtual ~CachedImage();
59
60     WEBCORE_EXPORT Image* image(); // Returns the nullImage() if the image is not available yet.
61     WEBCORE_EXPORT Image* imageForRenderer(const RenderObject*); // Returns the nullImage() if the image is not available yet.
62     bool hasImage() const { return m_image.get(); }
63     bool currentFrameKnownToBeOpaque(const RenderElement*);
64
65     std::pair<Image*, float> brokenImage(float deviceScaleFactor) const; // Returns an image and the image's resolution scale factor.
66     bool willPaintBrokenImage() const; 
67
68     bool canRender(const RenderObject* renderer, float multiplier) { return !errorOccurred() && !imageSizeForRenderer(renderer, multiplier).isEmpty(); }
69
70     void setContainerSizeForRenderer(const CachedImageClient*, const LayoutSize&, float);
71     bool usesImageContainerSize() const;
72     bool imageHasRelativeWidth() const;
73     bool imageHasRelativeHeight() const;
74
75     void addDataBuffer(SharedBuffer&) override;
76     void finishLoading(SharedBuffer*) override;
77
78     bool areAllClientsInPageCache() const;
79
80     enum SizeType {
81         UsedSize,
82         IntrinsicSize
83     };
84     // This method takes a zoom multiplier that can be used to increase the natural size of the image by the zoom.
85     LayoutSize imageSizeForRenderer(const RenderObject*, float multiplier, SizeType = UsedSize); // returns the size of the complete image.
86     void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio);
87
88     bool isManuallyCached() const { return m_isManuallyCached; }
89     RevalidationDecision makeRevalidationDecision(CachePolicy) const override;
90     void load(CachedResourceLoader&, const ResourceLoaderOptions&) override;
91
92     bool isOriginClean(SecurityOrigin*);
93
94 private:
95     void clear();
96
97     void createImage();
98     void clearImage();
99     // If not null, changeRect is the changed part of the image.
100     void notifyObservers(const IntRect* changeRect = nullptr);
101     void checkShouldPaintBrokenImage();
102
103     void switchClientsToRevalidatedResource() override;
104     bool mayTryReplaceEncodedData() const override { return true; }
105
106     void didAddClient(CachedResourceClient*) override;
107     void didRemoveClient(CachedResourceClient*) override;
108
109     void allClientsRemoved() override;
110     void destroyDecodedData() override;
111
112     void addData(const char* data, unsigned length) override;
113     void error(CachedResource::Status) override;
114     void responseReceived(const ResourceResponse&) override;
115
116     // For compatibility, images keep loading even if there are HTTP errors.
117     bool shouldIgnoreHTTPStatusCodeErrors() const override { return true; }
118
119     bool stillNeedsLoad() const override { return !errorOccurred() && status() == Unknown && !isLoading(); }
120
121     // ImageObserver
122     void decodedSizeChanged(const Image*, int delta) override;
123     void didDraw(const Image*) override;
124
125     void animationAdvanced(const Image*) override;
126     void changedInRect(const Image*, const IntRect&) override;
127
128     void addIncrementalDataBuffer(SharedBuffer&);
129
130     void didReplaceSharedBufferContents() override;
131
132     typedef std::pair<LayoutSize, float> SizeAndZoom;
133     typedef HashMap<const CachedImageClient*, SizeAndZoom> ContainerSizeRequests;
134     ContainerSizeRequests m_pendingContainerSizeRequests;
135
136     RefPtr<Image> m_image;
137     std::unique_ptr<SVGImageCache> m_svgImageCache;
138     unsigned m_isManuallyCached : 1;
139     unsigned m_shouldPaintBrokenImage : 1;
140 };
141
142 } // namespace WebCore
143
144 SPECIALIZE_TYPE_TRAITS_CACHED_RESOURCE(CachedImage, CachedResource::ImageResource)
145
146 #endif // CachedImage_h