1 /* 2 * Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com) 3 * Copyright (C) 2004, 2005, 2006 Apple Computer, Inc. All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY 15 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 17 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR 18 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 19 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 20 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 21 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 22 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 23 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 24 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 25 */ 26 27 #ifndef Image_h 28 #define Image_h 29 30 #include "Color.h" 31 #include "ColorSpace.h" 32 #include "GraphicsTypes.h" 33 #include "ImageSource.h" 34 #include "IntRect.h" 35 #include "SharedBuffer.h" 36 #include <wtf/PassRefPtr.h> 37 #include <wtf/RefPtr.h> 38 39 #if PLATFORM(MAC) 40 #ifdef __OBJC__ 41 @class NSImage; 42 #else 43 class NSImage; 44 #endif 45 #endif 46 47 #if PLATFORM(CG) 48 struct CGContext; 49 #endif 50 51 #if PLATFORM(WIN) 52 typedef struct tagSIZE SIZE; 53 typedef SIZE* LPSIZE; 54 typedef struct HBITMAP__ *HBITMAP; 55 #endif 56 57 #if PLATFORM(SKIA) 58 class NativeImageSkia; 59 #endif 60 61 #if PLATFORM(QT) 62 #include <QPixmap> 63 #endif 64 65 #if PLATFORM(GTK) 66 typedef struct _GdkPixbuf GdkPixbuf; 67 #endif 68 69 namespace WebCore { 70 71 class FloatPoint; 72 class FloatRect; 73 class FloatSize; 74 class GraphicsContext; 75 class SharedBuffer; 76 class String; 77 class AffineTransform; 78 79 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames. 80 class ImageObserver; 81 82 class Image : public RefCounted<Image> { 83 friend class GeneratedImage; 84 friend class GraphicsContext; 85 86 public: 87 virtual ~Image(); 88 89 static PassRefPtr<Image> create(ImageObserver* = 0); 90 static PassRefPtr<Image> loadPlatformResource(const char* name); 91 static bool supportsType(const String&); 92 isBitmapImage()93 virtual bool isBitmapImage() const { return false; } 94 95 // Derived classes should override this if they can assure that 96 // the image contains only resources from its own security origin. hasSingleSecurityOrigin()97 virtual bool hasSingleSecurityOrigin() const { return false; } 98 99 static Image* nullImage(); isNull()100 bool isNull() const { return size().isEmpty(); } 101 102 // These are only used for SVGImage right now setContainerSize(const IntSize &)103 virtual void setContainerSize(const IntSize&) { } usesContainerSize()104 virtual bool usesContainerSize() const { return false; } hasRelativeWidth()105 virtual bool hasRelativeWidth() const { return false; } hasRelativeHeight()106 virtual bool hasRelativeHeight() const { return false; } 107 108 virtual IntSize size() const = 0; rect()109 IntRect rect() const { return IntRect(IntPoint(), size()); } width()110 int width() const { return size().width(); } height()111 int height() const { return size().height(); } 112 113 bool setData(PassRefPtr<SharedBuffer> data, bool allDataReceived); dataChanged(bool)114 virtual bool dataChanged(bool /*allDataReceived*/) { return false; } 115 filenameExtension()116 virtual String filenameExtension() const { return String(); } // null string if unknown 117 118 virtual void destroyDecodedData(bool destroyAll = true) = 0; 119 virtual unsigned decodedSize() const = 0; 120 data()121 SharedBuffer* data() { return m_data.get(); } 122 123 // Animation begins whenever someone draws the image, so startAnimation() is not normally called. 124 // It will automatically pause once all observers no longer want to render the image anywhere. 125 virtual void startAnimation(bool /*catchUpIfNecessary*/ = true) { } stopAnimation()126 virtual void stopAnimation() {} resetAnimation()127 virtual void resetAnimation() {} 128 129 // Typically the CachedImage that owns us. imageObserver()130 ImageObserver* imageObserver() const { return m_imageObserver; } 131 132 enum TileRule { StretchTile, RoundTile, RepeatTile }; 133 nativeImageForCurrentFrame()134 virtual NativeImagePtr nativeImageForCurrentFrame() { return 0; } 135 136 #if PLATFORM(MAC) 137 // Accessors for native image formats. getNSImage()138 virtual NSImage* getNSImage() { return 0; } getTIFFRepresentation()139 virtual CFDataRef getTIFFRepresentation() { return 0; } 140 #endif 141 142 #if PLATFORM(CG) getCGImageRef()143 virtual CGImageRef getCGImageRef() { return 0; } 144 #endif 145 146 #if PLATFORM(WIN) getHBITMAP(HBITMAP)147 virtual bool getHBITMAP(HBITMAP) { return false; } getHBITMAPOfSize(HBITMAP,LPSIZE)148 virtual bool getHBITMAPOfSize(HBITMAP, LPSIZE) { return false; } 149 #endif 150 151 #if PLATFORM(ANDROID) setURL(const String & str)152 virtual void setURL(const String& str) {} 153 #endif 154 155 #if PLATFORM(GTK) getGdkPixbuf()156 virtual GdkPixbuf* getGdkPixbuf() { return 0; } 157 static PassRefPtr<Image> loadPlatformThemeIcon(const char* name, int size); 158 #endif 159 160 protected: 161 Image(ImageObserver* = 0); 162 163 static void fillWithSolidColor(GraphicsContext*, const FloatRect& dstRect, const Color&, ColorSpace styleColorSpace, CompositeOperator); 164 165 // The ColorSpace parameter will only be used for untagged images. 166 #if PLATFORM(WIN) drawFrameMatchingSourceSize(GraphicsContext *,const FloatRect & dstRect,const IntSize & srcSize,ColorSpace styleColorSpace,CompositeOperator)167 virtual void drawFrameMatchingSourceSize(GraphicsContext*, const FloatRect& dstRect, const IntSize& srcSize, ColorSpace styleColorSpace, CompositeOperator) { } 168 #endif 169 virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator) = 0; 170 void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, ColorSpace styleColorSpace, CompositeOperator); 171 void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, TileRule hRule, TileRule vRule, ColorSpace styleColorSpace, CompositeOperator); 172 173 // Supporting tiled drawing mayFillWithSolidColor()174 virtual bool mayFillWithSolidColor() { return false; } solidColor()175 virtual Color solidColor() const { return Color(); } 176 177 virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform, 178 const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect); 179 180 private: 181 RefPtr<SharedBuffer> m_data; // The encoded raw data for the image. 182 ImageObserver* m_imageObserver; 183 }; 184 185 } 186 187 #endif 188