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