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 "ImageObserver.h" 28 #include "IntRect.h" 29 #include "Timer.h" 30 #include <wtf/Vector.h> 31 32 namespace WebCore { 33 34 class CachedResourceLoader; 35 class MemoryCache; 36 37 class CachedImage : public CachedResource, public ImageObserver { 38 friend class MemoryCache; 39 40 public: 41 CachedImage(const String& url); 42 CachedImage(Image*); 43 virtual ~CachedImage(); 44 45 virtual void load(CachedResourceLoader* cachedResourceLoader); 46 47 Image* image() const; // Returns the nullImage() if the image is not available yet. hasImage()48 bool hasImage() const { return m_image.get(); } 49 canRender(float multiplier)50 bool canRender(float multiplier) const { return !errorOccurred() && !imageSize(multiplier).isEmpty(); } 51 52 // These are only used for SVGImage right now 53 void setImageContainerSize(const IntSize&); 54 bool usesImageContainerSize() const; 55 bool imageHasRelativeWidth() const; 56 bool imageHasRelativeHeight() const; 57 58 // Both of these methods take a zoom multiplier that can be used to increase the natural size of the image by the 59 // zoom. 60 IntSize imageSize(float multiplier) const; // returns the size of the complete image. 61 IntRect imageRect(float multiplier) const; // The size of the currently decoded portion of the image. 62 63 virtual void didAddClient(CachedResourceClient*); 64 65 virtual void allClientsRemoved(); 66 virtual void destroyDecodedData(); 67 68 virtual void data(PassRefPtr<SharedBuffer> data, bool allDataReceived); 69 virtual void error(CachedResource::Status); 70 71 // For compatibility, images keep loading even if there are HTTP errors. shouldIgnoreHTTPStatusCodeErrors()72 virtual bool shouldIgnoreHTTPStatusCodeErrors() const { return true; } 73 isImage()74 virtual bool isImage() const { return true; } 75 76 void clear(); 77 stillNeedsLoad()78 bool stillNeedsLoad() const { return (!errorOccurred() && status() == Unknown && !isLoading()) || (m_autoLoadWasPreventedBySettings && !inCache()); } 79 void load(); 80 81 // ImageObserver 82 virtual void decodedSizeChanged(const Image* image, int delta); 83 virtual void didDraw(const Image*); 84 85 virtual bool shouldPauseAnimation(const Image*); 86 virtual void animationAdvanced(const Image*); 87 virtual void changedInRect(const Image*, const IntRect&); 88 setAutoLoadWasPreventedBySettings(bool prevented)89 void setAutoLoadWasPreventedBySettings(bool prevented) { m_autoLoadWasPreventedBySettings = prevented; } 90 91 private: 92 void createImage(); 93 size_t maximumDecodedImageSize(); 94 // If not null, changeRect is the changed part of the image. 95 void notifyObservers(const IntRect* changeRect = 0); 96 void decodedDataDeletionTimerFired(Timer<CachedImage>*); purgePriority()97 virtual PurgePriority purgePriority() const { return PurgeFirst; } 98 void checkShouldPaintBrokenImage(); 99 100 RefPtr<Image> m_image; 101 Timer<CachedImage> m_decodedDataDeletionTimer; 102 bool m_shouldPaintBrokenImage; 103 bool m_autoLoadWasPreventedBySettings; 104 }; 105 106 } 107 108 #endif 109