b78fc7d8164b3ad8280a393b432cb69f64e46bfe
[WebKit-https.git] / Source / WebCore / platform / graphics / Image.h
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 <wtf/PassRefPtr.h>
36 #include <wtf/RefCounted.h>
37 #include <wtf/RefPtr.h>
38 #include <wtf/RetainPtr.h>
39 #include <wtf/text/WTFString.h>
40
41 #if PLATFORM(MAC)
42 OBJC_CLASS NSImage;
43 #endif
44
45 #if USE(CG)
46 struct CGContext;
47 #endif
48
49 #if PLATFORM(WIN)
50 typedef struct tagSIZE SIZE;
51 typedef SIZE* LPSIZE;
52 typedef struct HBITMAP__ *HBITMAP;
53 #endif
54
55 #if PLATFORM(QT)
56 #include <QPixmap>
57 #endif
58
59 #if PLATFORM(GTK)
60 typedef struct _GdkPixbuf GdkPixbuf;
61 #endif
62
63 namespace WebCore {
64
65 class AffineTransform;
66 class FloatPoint;
67 class FloatRect;
68 class FloatSize;
69 class GraphicsContext;
70 class SharedBuffer;
71 struct Length;
72
73 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames.
74 class ImageObserver;
75
76 class Image : public RefCounted<Image> {
77     friend class GeneratedImage;
78     friend class CrossfadeGeneratedImage;
79     friend class GeneratorGeneratedImage;
80     friend class GraphicsContext;
81
82 public:
83     virtual ~Image();
84     
85     static PassRefPtr<Image> create(ImageObserver* = 0);
86     static PassRefPtr<Image> loadPlatformResource(const char* name);
87     static bool supportsType(const String&); 
88
89     virtual bool isSVGImage() const { return false; }
90     virtual bool isBitmapImage() const { return false; }
91     virtual bool currentFrameHasAlpha() { return false; }
92
93     // Derived classes should override this if they can assure that 
94     // the image contains only resources from its own security origin.
95     virtual bool hasSingleSecurityOrigin() const { return false; }
96
97     static Image* nullImage();
98     bool isNull() const { return size().isEmpty(); }
99
100     virtual void setContainerSize(const IntSize&) { }
101     virtual bool usesContainerSize() const { return false; }
102     virtual bool hasRelativeWidth() const { return false; }
103     virtual bool hasRelativeHeight() const { return false; }
104     virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio);
105
106     virtual IntSize size() const = 0;
107     IntRect rect() const { return IntRect(IntPoint(), size()); }
108     int width() const { return size().width(); }
109     int height() const { return size().height(); }
110     virtual bool getHotSpot(IntPoint&) const { return false; }
111
112     bool setData(PassRefPtr<SharedBuffer> data, bool allDataReceived);
113     virtual bool dataChanged(bool /*allDataReceived*/) { return false; }
114     
115     virtual String filenameExtension() const { return String(); } // null string if unknown
116
117     virtual void destroyDecodedData(bool destroyAll = true) = 0;
118     virtual unsigned decodedSize() const = 0;
119
120     SharedBuffer* data() { return m_data.get(); }
121
122     // Animation begins whenever someone draws the image, so startAnimation() is not normally called.
123     // It will automatically pause once all observers no longer want to render the image anywhere.
124     virtual void startAnimation(bool /*catchUpIfNecessary*/ = true) { }
125     virtual void stopAnimation() {}
126     virtual void resetAnimation() {}
127     
128     // Typically the CachedImage that owns us.
129     ImageObserver* imageObserver() const { return m_imageObserver; }
130     void setImageObserver(ImageObserver* observer) { m_imageObserver = observer; }
131
132     enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile };
133
134     virtual NativeImagePtr nativeImageForCurrentFrame() { return 0; }
135     
136 #if PLATFORM(MAC)
137     // Accessors for native image formats.
138     virtual NSImage* getNSImage() { return 0; }
139     virtual CFDataRef getTIFFRepresentation() { return 0; }
140 #endif
141
142 #if USE(CG)
143     virtual CGImageRef getCGImageRef() { return 0; }
144     virtual CGImageRef getFirstCGImageRefOfSize(const IntSize&) { return 0; }
145     virtual RetainPtr<CFArrayRef> getCGImageArray() { return 0; }
146     static RetainPtr<CGImageRef> imageWithColorSpace(CGImageRef originalImage, ColorSpace);
147 #endif
148
149 #if PLATFORM(WIN)
150     virtual bool getHBITMAP(HBITMAP) { return false; }
151     virtual bool getHBITMAPOfSize(HBITMAP, LPSIZE) { return false; }
152 #endif
153
154 #if PLATFORM(GTK)
155     virtual GdkPixbuf* getGdkPixbuf() { return 0; }
156     static PassRefPtr<Image> loadPlatformThemeIcon(const char* name, int size);
157 #endif
158
159 #if PLATFORM(QT)
160     static void setPlatformResource(const char* name, const QPixmap&);
161 #endif
162
163     virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
164                              const FloatPoint& phase, ColorSpace styleColorSpace, CompositeOperator, const FloatRect& destRect);
165
166 #if !ASSERT_DISABLED
167     virtual bool notSolidColor() { return true; }
168 #endif
169
170 protected:
171     Image(ImageObserver* = 0);
172
173     static void fillWithSolidColor(GraphicsContext*, const FloatRect& dstRect, const Color&, ColorSpace styleColorSpace, CompositeOperator);
174
175     // The ColorSpace parameter will only be used for untagged images.
176 #if PLATFORM(WIN)
177     virtual void drawFrameMatchingSourceSize(GraphicsContext*, const FloatRect& dstRect, const IntSize& srcSize, ColorSpace styleColorSpace, CompositeOperator) { }
178 #endif
179     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, ColorSpace styleColorSpace, CompositeOperator) = 0;
180     void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, ColorSpace styleColorSpace, CompositeOperator);
181     void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, ColorSpace styleColorSpace, CompositeOperator);
182
183     // Supporting tiled drawing
184     virtual bool mayFillWithSolidColor() { return false; }
185     virtual Color solidColor() const { return Color(); }
186     
187 private:
188     RefPtr<SharedBuffer> m_data; // The encoded raw data for the image. 
189     ImageObserver* m_imageObserver;
190 };
191
192 }
193
194 #endif