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