2007-12-23 Alp Toker <alp@atoker.com>
[WebKit-https.git] / 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 "GraphicsTypes.h"
32 #include "ImageSource.h"
33 #include <wtf/RefPtr.h>
34 #include <wtf/PassRefPtr.h>
35 #include "SharedBuffer.h"
36
37 #if PLATFORM(MAC)
38 #ifdef __OBJC__
39 @class NSImage;
40 #else
41 class NSImage;
42 #endif
43 #endif
44
45 #if PLATFORM(CG)
46 struct CGContext;
47 #endif
48
49 #if PLATFORM(WIN)
50 typedef struct HBITMAP__ *HBITMAP;
51 #endif
52
53 #if PLATFORM(QT)
54 #include <QPixmap>
55 #endif
56
57 namespace WebCore {
58
59 class AffineTransform;
60 class FloatPoint;
61 class FloatRect;
62 class FloatSize;
63 class GraphicsContext;
64 class IntRect;
65 class IntSize;
66 class SharedBuffer;
67 class String;
68
69 // This class gets notified when an image creates or destroys decoded frames and when it advances animation frames.
70 class ImageObserver;
71
72 class Image : Noncopyable {
73     friend class GraphicsContext;
74 public:
75     Image(ImageObserver* = 0);
76     virtual ~Image();
77     
78     static Image* loadPlatformResource(const char* name);
79     static bool supportsType(const String&); 
80
81     bool isNull() const;
82
83     // These are only used for SVGImage right now
84     virtual void setContainerSize(const IntSize&) { }
85     virtual bool usesContainerSize() const { return false; }
86     virtual bool hasRelativeWidth() const { return false; }
87     virtual bool hasRelativeHeight() const { return false; }
88
89     virtual IntSize size() const = 0;
90     IntRect rect() const;
91     int width() const;
92     int height() const;
93
94     bool setData(PassRefPtr<SharedBuffer> data, bool allDataReceived);
95     virtual bool dataChanged(bool allDataReceived) { return false; }
96     
97     // FIXME: PDF/SVG will be underreporting decoded sizes and will be unable to prune because these functions are not
98     // implemented yet for those image types.
99     virtual void destroyDecodedData(bool incremental = false) {};
100     virtual unsigned decodedSize() const { return 0; }
101
102     SharedBuffer* data() { return m_data.get(); }
103
104     // It may look unusual that there is no start animation call as public API.  This is because
105     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
106     // automatically pause once all observers no longer want to render the image anywhere.
107     virtual void stopAnimation() {}
108     virtual void resetAnimation() {}
109     
110     // Typically the CachedImage that owns us.
111     ImageObserver* imageObserver() const { return m_imageObserver; }
112
113     enum TileRule { StretchTile, RoundTile, RepeatTile };
114
115     virtual NativeImagePtr nativeImageForCurrentFrame() { return 0; }
116     
117 #if PLATFORM(MAC)
118     // Accessors for native image formats.
119     virtual NSImage* getNSImage() { return 0; }
120     virtual CFDataRef getTIFFRepresentation() { return 0; }
121 #endif
122
123 #if PLATFORM(CG)
124     virtual CGImageRef getCGImageRef() { return 0; }
125 #endif
126
127 #if PLATFORM(QT)
128     virtual QPixmap* getPixmap() const { return 0; }
129 #endif
130
131 #if PLATFORM(WIN)
132     virtual bool getHBITMAP(HBITMAP) { return false; }
133     virtual bool getHBITMAPOfSize(HBITMAP, LPSIZE) { return false; }
134 #endif
135
136 protected:
137     static void fillWithSolidColor(GraphicsContext* ctxt, const FloatRect& dstRect, const Color& color, CompositeOperator op);
138
139 private:
140 #if PLATFORM(WIN)
141     virtual void drawFrameMatchingSourceSize(GraphicsContext*, const FloatRect& dstRect, const IntSize& srcSize, CompositeOperator) { }
142 #endif
143     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator) = 0;
144     void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, CompositeOperator);
145     void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, TileRule hRule, TileRule vRule, CompositeOperator);
146
147     // Supporting tiled drawing
148     virtual bool mayFillWithSolidColor() const { return false; }
149     virtual Color solidColor() const { return Color(); }
150     
151     virtual void startAnimation() { }
152     
153     virtual void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
154                              const FloatPoint& phase, CompositeOperator, const FloatRect& destRect);
155 #if PLATFORM(CG)
156     // These are private to CG.  Ideally they would be only in the .cpp file, but the callback requires access
157     // to the private function nativeImageForCurrentFrame()
158     static void drawPatternCallback(void* info, CGContext*);
159 #endif
160     
161 protected:
162     RefPtr<SharedBuffer> m_data; // The encoded raw data for the image. 
163     ImageObserver* m_imageObserver;
164 };
165
166 }
167
168 #endif