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