2007-01-17 Eric Seidel <eric@webkit.org>
[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
34 #if PLATFORM(MAC)
35 #ifdef __OBJC__
36 @class NSImage;
37 #else
38 class NSImage;
39 #endif
40 #endif
41
42 #if PLATFORM(CG)
43 struct CGContext;
44 #endif
45
46 #if PLATFORM(WIN)
47 typedef struct HBITMAP__ *HBITMAP;
48 #endif
49
50 namespace WebCore {
51
52 class AffineTransform;
53 class FloatPoint;
54 class FloatRect;
55 class FloatSize;
56 class GraphicsContext;
57 class IntRect;
58 class IntSize;
59 class String;
60
61 // This class gets notified when an image advances animation frames.
62 class ImageAnimationObserver;
63
64 class Image : Noncopyable {
65     friend class GraphicsContext;
66 public:
67     Image(ImageAnimationObserver* observer = 0);
68     virtual ~Image();
69     
70     static Image* loadPlatformResource(const char *name);
71     static bool supportsType(const String&); 
72
73     bool isNull() const;
74
75     virtual IntSize size() const = 0;
76     IntRect rect() const;
77     int width() const;
78     int height() const;
79
80     virtual bool setData(bool allDataReceived);
81     virtual bool setNativeData(NativeBytePtr, bool allDataReceived) { return false; }
82     
83     Vector<char>& dataBuffer() { return m_data; }
84
85     // It may look unusual that there is no start animation call as public API.  This is because
86     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
87     // automatically pause once all observers no longer want to render the image anywhere.
88     virtual void stopAnimation() {}
89     virtual void resetAnimation() {}
90     
91     // Typically the CachedImage that owns us.
92     ImageAnimationObserver* animationObserver() const { return m_animationObserver; }
93
94     enum TileRule { StretchTile, RepeatTile };
95     
96 #if PLATFORM(MAC)
97     // Accessors for native image formats.
98     virtual NSImage* getNSImage() { return 0; }
99     virtual CFDataRef getTIFFRepresentation() { return 0; }
100 #endif
101
102 #if PLATFORM(CG)
103     virtual CGImageRef getCGImageRef() { return 0; }
104 #endif
105
106 #if PLATFORM(WIN)
107     virtual bool getHBITMAP(HBITMAP) { return false; }
108 #endif
109
110 private:
111     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator) = 0;
112     void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, CompositeOperator);
113     void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, TileRule hRule, TileRule vRule, CompositeOperator);
114     
115     // Supporting tiled drawing
116     virtual bool mayFillWithSolidColor() const { return false; }
117     virtual Color solidColor() const { return Color(); }
118     
119     virtual NativeImagePtr nativeImageForCurrentFrame() { return 0; }
120     
121     virtual void startAnimation() { }
122     
123 #if PLATFORM(CG)
124     // These are private to CG.  Ideally they would be only in the .cpp file, but the callback requires access
125     // to the private function nativeImageForCurrentFrame()
126     void drawPattern(GraphicsContext*, const FloatRect& srcRect, const AffineTransform& patternTransform,
127                      const FloatPoint& phase, CompositeOperator, const FloatRect& destRect);
128     static void drawPatternCallback(void* info, CGContext*);
129 #endif
130     
131     Vector<char> m_data; // The encoded raw data for the image. 
132     ImageAnimationObserver* m_animationObserver;
133 };
134
135 }
136
137 #endif