1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/*
* Copyright (C) 2006 Samuel Weinig (sam.weinig@gmail.com)
* Copyright (C) 2004-2023 Apple Inc. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
* EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
* PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
* OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
#pragma once
#include "Color.h"
#include "DecodingOptions.h"
#include "FloatRect.h"
#include "FloatSize.h"
#include "GraphicsTypes.h"
#include "ImageOrientation.h"
#include "ImagePaintingOptions.h"
#include "ImageTypes.h"
#include "NativeImage.h"
#include "Timer.h"
#include <wtf/EnumTraits.h>
#include <wtf/RefCounted.h>
#include <wtf/RefPtr.h>
#include <wtf/RetainPtr.h>
#include <wtf/TypeCasts.h>
#include <wtf/text/WTFString.h>
#if USE(APPKIT)
OBJC_CLASS NSImage;
#endif
#if USE(CG)
struct CGContext;
#endif
#if PLATFORM(WIN)
typedef struct tagSIZE SIZE;
typedef SIZE* LPSIZE;
typedef struct HBITMAP__ *HBITMAP;
#endif
#if PLATFORM(GTK)
#include <wtf/glib/GRefPtr.h>
typedef struct _GdkPixbuf GdkPixbuf;
#if USE(GTK4)
typedef struct _GdkTexture GdkTexture;
#endif
#endif
namespace WebCore {
class AffineTransform;
class FloatPoint;
class FloatSize;
class GraphicsContext;
class FragmentedSharedBuffer;
struct Length;
// This class gets notified when an image creates or destroys decoded frames and when it advances animation frames.
class ImageObserver;
class Image : public RefCounted<Image>, public CanMakeWeakPtr<Image> {
friend class CachedSubimage;
friend class GraphicsContext;
public:
virtual ~Image();
WEBCORE_EXPORT static Ref<Image> loadPlatformResource(const char* name);
WEBCORE_EXPORT static RefPtr<Image> create(ImageObserver&);
WEBCORE_EXPORT static bool supportsType(const String&);
static bool isPDFResource(const String& mimeType, const URL&);
static bool isPostScriptResource(const String& mimeType, const URL&);
virtual bool isBitmapImage() const { return false; }
virtual bool isGeneratedImage() const { return false; }
virtual bool isCrossfadeGeneratedImage() const { return false; }
virtual bool isNamedImageGeneratedImage() const { return false; }
virtual bool isGradientImage() const { return false; }
virtual bool isSVGImage() const { return false; }
virtual bool isSVGImageForContainer() const { return false; }
virtual bool isPDFDocumentImage() const { return false; }
virtual bool isCustomPaintImage() const { return false; }
bool drawsSVGImage() const { return isSVGImage() || isSVGImageForContainer(); }
virtual bool currentFrameKnownToBeOpaque() const = 0;
virtual bool isAnimated() const { return false; }
// Derived classes should override this if their rendering could leak
// cross-origin data (outside of the resource itself, which undergoes
// a CORS cross-origin check).
virtual bool renderingTaintsOrigin() const { return false; }
WEBCORE_EXPORT static Image& nullImage();
bool isNull() const { return size().isEmpty(); }
virtual void setContainerSize(const FloatSize&) { }
virtual bool usesContainerSize() const { return false; }
virtual bool hasRelativeWidth() const { return false; }
virtual bool hasRelativeHeight() const { return false; }
virtual void computeIntrinsicDimensions(Length& intrinsicWidth, Length& intrinsicHeight, FloatSize& intrinsicRatio);
virtual FloatSize size(ImageOrientation = ImageOrientation::Orientation::FromImage) const = 0;
virtual FloatSize sourceSize(ImageOrientation orientation = ImageOrientation::Orientation::FromImage) const { return size(orientation); }
virtual bool hasDensityCorrectedSize() const { return false; }
FloatRect rect() const { return FloatRect(FloatPoint(), size()); }
float width() const { return size().width(); }
float height() const { return size().height(); }
virtual std::optional<IntPoint> hotSpot() const { return std::nullopt; }
virtual ImageOrientation orientation() const { return ImageOrientation::Orientation::FromImage; }
WEBCORE_EXPORT EncodedDataStatus setData(RefPtr<FragmentedSharedBuffer>&& data, bool allDataReceived);
virtual EncodedDataStatus dataChanged(bool /*allDataReceived*/) { return EncodedDataStatus::Unknown; }
virtual String uti() const { return String(); } // null string if unknown
virtual String filenameExtension() const { return String(); } // null string if unknown
virtual String accessibilityDescription() const { return String(); } // null string if unknown
virtual void destroyDecodedData(bool /*destroyAll*/ = true) { }
FragmentedSharedBuffer* data() { return m_encodedImageData.get(); }
const FragmentedSharedBuffer* data() const { return m_encodedImageData.get(); }
virtual DestinationColorSpace colorSpace();
// Animation begins whenever someone draws the image, so startAnimation() is not normally called.
// It will automatically pause once all observers no longer want to render the image anywhere.
virtual void startAnimation() { }
void startAnimationAsynchronously();
virtual void stopAnimation() {}
virtual void resetAnimation() {}
virtual bool isAnimating() const { return false; }
bool animationPending() const { return m_animationStartTimer && m_animationStartTimer->isActive(); }
std::optional<bool> allowsAnimation() const { return m_allowsAnimation; }
void setAllowsAnimation(std::optional<bool> allowsAnimation) { m_allowsAnimation = allowsAnimation; }
// Typically the CachedImage that owns us.
RefPtr<ImageObserver> imageObserver() const;
void setImageObserver(RefPtr<ImageObserver>&&);
URL sourceURL() const;
WEBCORE_EXPORT String mimeType() const;
long long expectedContentLength() const;
enum TileRule { StretchTile, RoundTile, SpaceTile, RepeatTile };
virtual RefPtr<NativeImage> nativeImage(const DestinationColorSpace& = DestinationColorSpace::SRGB()) { return nullptr; }
virtual RefPtr<NativeImage> nativeImageForCurrentFrame() { return nativeImage(); }
virtual RefPtr<NativeImage> preTransformedNativeImageForCurrentFrame(bool = true) { return nativeImageForCurrentFrame(); }
virtual RefPtr<NativeImage> nativeImageOfSize(const IntSize&) { return nullptr; }
// Accessors for native image formats.
#if USE(APPKIT)
virtual NSImage *nsImage() { return nullptr; }
virtual RetainPtr<NSImage> snapshotNSImage() { return nullptr; }
#endif
#if PLATFORM(COCOA)
virtual CFDataRef tiffRepresentation() { return nullptr; }
#endif
#if PLATFORM(WIN)
virtual bool getHBITMAP(HBITMAP) { return false; }
virtual bool getHBITMAPOfSize(HBITMAP, const IntSize*) { return false; }
#endif
#if PLATFORM(GTK)
virtual GRefPtr<GdkPixbuf> gdkPixbuf() { return nullptr; }
#if USE(GTK4)
virtual GRefPtr<GdkTexture> gdkTexture() { return nullptr; }
#endif
#endif
virtual void drawPattern(GraphicsContext&, const FloatRect& destRect, const FloatRect& srcRect, const AffineTransform& patternTransform, const FloatPoint& phase, const FloatSize& spacing, const ImagePaintingOptions& = { });
#if ASSERT_ENABLED
virtual bool notSolidColor() { return true; }
#endif
virtual void dump(WTF::TextStream&) const;
protected:
WEBCORE_EXPORT Image(ImageObserver* = nullptr);
static void fillWithSolidColor(GraphicsContext&, const FloatRect& dstRect, const Color&, CompositeOperator);
#if PLATFORM(WIN)
virtual void drawFrameMatchingSourceSize(GraphicsContext&, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) { }
#endif
virtual bool shouldDrawFromCachedSubimage(GraphicsContext&) const { return false; }
virtual bool mustDrawFromCachedSubimage(GraphicsContext&) const { return false; }
virtual ImageDrawResult draw(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, const ImagePaintingOptions& = { }) = 0;
ImageDrawResult drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, const FloatSize& spacing, const ImagePaintingOptions& = { });
ImageDrawResult drawTiled(GraphicsContext&, const FloatRect& dstRect, const FloatRect& srcRect, const FloatSize& tileScaleFactor, TileRule hRule, TileRule vRule, const ImagePaintingOptions& = { });
// Supporting tiled drawing
virtual Color singlePixelSolidColor() const { return Color(); }
private:
RefPtr<FragmentedSharedBuffer> m_encodedImageData;
WeakPtr<ImageObserver> m_imageObserver;
// A value of true or false will override the default Page::imageAnimationEnabled state.
std::optional<bool> m_allowsAnimation { std::nullopt };
std::unique_ptr<Timer> m_animationStartTimer;
};
WTF::TextStream& operator<<(WTF::TextStream&, const Image&);
} // namespace WebCore
#define SPECIALIZE_TYPE_TRAITS_IMAGE(ToClassName) \
SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ToClassName) \
static bool isType(const WebCore::Image& image) { return image.is##ToClassName(); } \
SPECIALIZE_TYPE_TRAITS_END()
namespace WTF {
template<> struct EnumTraits<WebCore::Image::TileRule> {
using values = EnumValues<
WebCore::Image::TileRule,
WebCore::Image::TileRule::StretchTile,
WebCore::Image::TileRule::RoundTile,
WebCore::Image::TileRule::SpaceTile,
WebCore::Image::TileRule::RepeatTile
>;
};
} // namespace WTF
|
