Stop using PassRefPtr in platform/graphics
[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 "DecodingOptions.h"
32 #include "FloatRect.h"
33 #include "FloatSize.h"
34 #include "GraphicsTypes.h"
35 #include "ImageOrientation.h"
36 #include "ImageTypes.h"
37 #include "NativeImage.h"
38 #include <wtf/Optional.h>
39 #include <wtf/RefCounted.h>
40 #include <wtf/RefPtr.h>
41 #include <wtf/RetainPtr.h>
42 #include <wtf/TypeCasts.h>
43 #include <wtf/text/WTFString.h>
44
45 #if USE(APPKIT)
46 OBJC_CLASS NSImage;
47 #endif
48
49 #if USE(CG)
50 struct CGContext;
51 #endif
52
53 #if PLATFORM(WIN)
54 typedef struct tagSIZE SIZE;
55 typedef SIZE* LPSIZE;
56 typedef struct HBITMAP__ *HBITMAP;
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 FloatSize;
68 class GraphicsContext;
69 class SharedBuffer;
70 class URL;
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 GraphicsContext;
78 public:
79     virtual ~Image();
80     
81     WEBCORE_EXPORT static Ref<Image> loadPlatformResource(const char* name);
82     WEBCORE_EXPORT static bool supportsType(const String&);
83
84     virtual bool isBitmapImage() const { return false; }
85     virtual bool isGeneratedImage() const { return false; }
86     virtual bool isCrossfadeGeneratedImage() const { return false; }
87     virtual bool isNamedImageGeneratedImage() const { return false; }
88     virtual bool isGradientImage() const { return false; }
89     virtual bool isSVGImage() const { return false; }
90     virtual bool isPDFDocumentImage() const { return false; }
91
92     virtual bool currentFrameKnownToBeOpaque() const = 0;
93     virtual bool isAnimated() 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.
97     virtual bool hasSingleSecurityOrigin() const { return false; }
98
99     WEBCORE_EXPORT static Image& nullImage();
100     bool isNull() const { return size().isEmpty(); }
101
102     virtual void setContainerSize(const FloatSize&) { }
103     virtual bool usesContainerSize() const { return false; }
104     virtual bool hasRelativeWidth() const { return false; }
105     virtual bool hasRelativeHeight() const { return false; }
106     virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio);
107
108     virtual FloatSize size() const = 0;
109     FloatRect rect() const { return FloatRect(FloatPoint(), size()); }
110     float width() const { return size().width(); }
111     float height() const { return size().height(); }
112     virtual std::optional<IntPoint> hotSpot() const { return std::nullopt; }
113
114 #if PLATFORM(IOS)
115     virtual FloatSize originalSize() const { return size(); }
116 #endif
117
118     WEBCORE_EXPORT EncodedDataStatus setData(RefPtr<SharedBuffer>&& data, bool allDataReceived);
119     virtual EncodedDataStatus dataChanged(bool /*allDataReceived*/) { return EncodedDataStatus::Unknown; }
120
121     virtual String uti() const { return String(); } // null string if unknown
122     virtual String filenameExtension() const { return String(); } // null string if unknown
123
124     virtual void destroyDecodedData(bool destroyAll = true) = 0;
125
126     SharedBuffer* data() { return m_encodedImageData.get(); }
127     const SharedBuffer* data() const { return m_encodedImageData.get(); }
128
129     // Animation begins whenever someone draws the image, so startAnimation() is not normally called.
130     // It will automatically pause once all observers no longer want to render the image anywhere.
131     virtual void startAnimation() { }
132     virtual void stopAnimation() {}
133     virtual void resetAnimation() {}
134     virtual void imageFrameAvailableAtIndex(size_t) { }
135     virtual bool isAnimating() const { return false; }
136     
137     // Typically the CachedImage that owns us.
138     ImageObserver* imageObserver() const { return m_imageObserver; }
139     void setImageObserver(ImageObserver* observer) { m_imageObserver = observer; }
140     URL sourceURL() const;
141
142     enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile };
143
144     virtual NativeImagePtr nativeImage(const GraphicsContext* = nullptr) { return nullptr; }
145     virtual NativeImagePtr nativeImageOfSize(const IntSize&, const GraphicsContext* = nullptr) { return nullptr; }
146     virtual NativeImagePtr nativeImageForCurrentFrame(const GraphicsContext* = nullptr) { return nullptr; }
147     virtual ImageOrientation orientationForCurrentFrame() const { return ImageOrientation(); }
148     virtual Vector<NativeImagePtr> framesNativeImages() { return { }; }
149
150     // Accessors for native image formats.
151
152 #if USE(APPKIT)
153     virtual NSImage *nsImage() { return nullptr; }
154     virtual RetainPtr<NSImage> snapshotNSImage() { return nullptr; }
155 #endif
156
157 #if PLATFORM(COCOA)
158     virtual CFDataRef tiffRepresentation() { return nullptr; }
159 #endif
160
161 #if PLATFORM(WIN)
162     virtual bool getHBITMAP(HBITMAP) { return false; }
163     virtual bool getHBITMAPOfSize(HBITMAP, const IntSize*) { return false; }
164 #endif
165
166 #if PLATFORM(GTK)
167     virtual GdkPixbuf* getGdkPixbuf() { 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, DecodingMode, ImageOrientationDescription) = 0;
192     void drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, const FloatSize& spacing, CompositeOperator, BlendMode, DecodingMode);
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