[Win][Direct2D] Implement basic SVG support
[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 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 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 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 "FloatRect.h"
32 #include "FloatSize.h"
33 #include "GraphicsTypes.h"
34 #include "ImageOrientation.h"
35 #include "NativeImage.h"
36 #include <wtf/Optional.h>
37 #include <wtf/PassRefPtr.h>
38 #include <wtf/RefCounted.h>
39 #include <wtf/RefPtr.h>
40 #include <wtf/RetainPtr.h>
41 #include <wtf/TypeCasts.h>
42 #include <wtf/text/WTFString.h>
43
44 #if USE(APPKIT)
45 OBJC_CLASS NSImage;
46 #endif
47
48 #if USE(CG)
49 struct CGContext;
50 #endif
51
52 #if PLATFORM(WIN)
53 typedef struct tagSIZE SIZE;
54 typedef SIZE* LPSIZE;
55 typedef struct HBITMAP__ *HBITMAP;
56 #endif
57
58 #if PLATFORM(GTK)
59 typedef struct _GdkPixbuf GdkPixbuf;
60 #endif
61
62 namespace WebCore {
63
64 class AffineTransform;
65 class FloatPoint;
66 class FloatSize;
67 class GraphicsContext;
68 class SharedBuffer;
69 struct Length;
70
71 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames.
72 class ImageObserver;
73
74 class Image : public RefCounted<Image> {
75     friend class GraphicsContext;
76 public:
77     virtual ~Image();
78     
79     static PassRefPtr<Image> create(ImageObserver* = nullptr);
80     WEBCORE_EXPORT static PassRefPtr<Image> loadPlatformResource(const char* name);
81     WEBCORE_EXPORT static bool supportsType(const String&);
82
83     virtual bool isBitmapImage() const { return false; }
84     virtual bool isGeneratedImage() const { return false; }
85     virtual bool isCrossfadeGeneratedImage() const { return false; }
86     virtual bool isNamedImageGeneratedImage() const { return false; }
87     virtual bool isGradientImage() const { return false; }
88     virtual bool isSVGImage() const { return false; }
89     virtual bool isPDFDocumentImage() const { return false; }
90
91     virtual bool currentFrameKnownToBeOpaque() const = 0;
92     virtual bool isAnimated() const { return false; }
93
94     // Derived classes should override this if they can assure that 
95     // the image contains only resources from its own security origin.
96     virtual bool hasSingleSecurityOrigin() const { return false; }
97
98     WEBCORE_EXPORT static Image* nullImage();
99     bool isNull() const { return size().isEmpty(); }
100
101     virtual void setContainerSize(const FloatSize&) { }
102     virtual bool usesContainerSize() const { return false; }
103     virtual bool hasRelativeWidth() const { return false; }
104     virtual bool hasRelativeHeight() const { return false; }
105     virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio);
106
107     virtual FloatSize size() const = 0;
108     FloatRect rect() const { return FloatRect(FloatPoint(), size()); }
109     float width() const { return size().width(); }
110     float height() const { return size().height(); }
111     virtual Optional<IntPoint> hotSpot() const { return Nullopt; }
112
113 #if PLATFORM(IOS)
114     virtual FloatSize originalSize() const { return size(); }
115 #endif
116
117     WEBCORE_EXPORT bool setData(RefPtr<SharedBuffer>&& data, bool allDataReceived);
118     virtual bool dataChanged(bool /*allDataReceived*/) { return false; }
119     
120     virtual String filenameExtension() const { return String(); } // null string if unknown
121
122     virtual void destroyDecodedData(bool destroyAll = true) = 0;
123
124     SharedBuffer* data() { return m_encodedImageData.get(); }
125     const SharedBuffer* data() const { return m_encodedImageData.get(); }
126
127     // Animation begins whenever someone draws the image, so startAnimation() is not normally called.
128     // It will automatically pause once all observers no longer want to render the image anywhere.
129     enum CatchUpAnimation { DoNotCatchUp, CatchUp };
130     virtual void startAnimation(CatchUpAnimation = CatchUp) { }
131     virtual void stopAnimation() {}
132     virtual void resetAnimation() {}
133     
134     // Typically the CachedImage that owns us.
135     ImageObserver* imageObserver() const { return m_imageObserver; }
136     void setImageObserver(ImageObserver* observer) { m_imageObserver = observer; }
137
138     enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile };
139
140     virtual NativeImagePtr nativeImage(const GraphicsContext* = nullptr) { return nullptr; }
141     virtual NativeImagePtr nativeImageOfSize(const IntSize&, const GraphicsContext* = nullptr) { return nullptr; }
142     virtual NativeImagePtr nativeImageForCurrentFrame(const GraphicsContext* = nullptr) { return nullptr; }
143     virtual ImageOrientation orientationForCurrentFrame() const { return ImageOrientation(); }
144     virtual Vector<NativeImagePtr> framesNativeImages() { return { }; }
145
146     // Accessors for native image formats.
147
148 #if USE(APPKIT)
149     virtual NSImage *nsImage() { return nullptr; }
150     virtual RetainPtr<NSImage> snapshotNSImage() { return nullptr; }
151 #endif
152
153 #if PLATFORM(COCOA)
154     virtual CFDataRef tiffRepresentation() { return nullptr; }
155 #endif
156
157 #if PLATFORM(WIN)
158     virtual bool getHBITMAP(HBITMAP) { return false; }
159     virtual bool getHBITMAPOfSize(HBITMAP, const IntSize*) { return false; }
160 #endif
161
162 #if PLATFORM(GTK)
163     virtual GdkPixbuf* getGdkPixbuf() { return nullptr; }
164 #endif
165
166 #if PLATFORM(EFL)
167     virtual Evas_Object* getEvasObject(Evas*) { return nullptr; }
168 #endif
169
170     virtual void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform,
171         const FloatPoint& phase, const FloatSize& spacing, CompositeOperator, BlendMode = BlendModeNormal);
172
173 #if ENABLE(IMAGE_DECODER_DOWN_SAMPLING)
174     FloatRect adjustSourceRectForDownSampling(const FloatRect& srcRect, const IntSize& scaledSize) const;
175 #endif
176
177 #if !ASSERT_DISABLED
178     virtual bool notSolidColor() { return true; }
179 #endif
180
181     virtual void dump(TextStream&) const;
182
183 protected:
184     Image(ImageObserver* = nullptr);
185
186     static void fillWithSolidColor(GraphicsContext&, const FloatRect& dstRect, const Color&, CompositeOperator);
187
188 #if PLATFORM(WIN)
189     virtual void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) { }
190 #endif
191     virtual void draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator, BlendMode, ImageOrientationDescription) = 0;
192     void drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, const FloatSize& spacing, CompositeOperator, BlendMode);
193     void drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, CompositeOperator);
194
195     // Supporting tiled drawing
196     virtual Color singlePixelSolidColor() const { return Color(); }
197
198 private:
199     RefPtr<SharedBuffer> m_encodedImageData;
200     ImageObserver* m_imageObserver;
201 };
202
203 TextStream& operator<<(TextStream&, const Image&);
204
205 } // namespace WebCore
206
207 #define SPECIALIZE_TYPE_TRAITS_IMAGE(ToClassName) \
208 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
209     static bool isType(const WebCore::Image& image) { return image.is##ToClassName(); } \
210 SPECIALIZE_TYPE_TRAITS_END()
211
212 #endif // Image_h