1eeb981d6739d8cb8fcb798e5ea32cca5b7779a5
[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(WIN)
43 typedef struct HBITMAP__ *HBITMAP;
44 #endif
45
46 namespace WebCore {
47
48 class FloatPoint;
49 class FloatRect;
50 class FloatSize;
51 class GraphicsContext;
52 class IntRect;
53 class IntSize;
54 class String;
55
56 // This class gets notified when an image advances animation frames.
57 class ImageAnimationObserver;
58
59 class Image : Noncopyable {
60     friend class GraphicsContext;
61 public:
62     Image(ImageAnimationObserver* observer = 0);
63     virtual ~Image();
64     
65     static Image* loadPlatformResource(const char *name);
66     static bool supportsType(const String&); 
67
68     bool isNull() const;
69
70     virtual IntSize size() const = 0;
71     IntRect rect() const;
72     int width() const;
73     int height() const;
74
75     virtual bool setData(bool allDataReceived);
76     virtual bool setNativeData(NativeBytePtr, bool allDataReceived) { return false; }
77     
78     Vector<char>& dataBuffer() { return m_data; }
79
80     // It may look unusual that there is no start animation call as public API.  This is because
81     // we start and stop animating lazily.  Animation begins whenever someone draws the image.  It will
82     // automatically pause once all observers no longer want to render the image anywhere.
83     virtual void stopAnimation() {}
84     virtual void resetAnimation() {}
85     
86     // Typically the CachedImage that owns us.
87     ImageAnimationObserver* animationObserver() const { return m_animationObserver; }
88
89     enum TileRule { StretchTile, RepeatTile };
90     
91 #if PLATFORM(MAC)
92     // Accessors for native image formats.
93     virtual NSImage* getNSImage() { return 0; }
94     virtual CFDataRef getTIFFRepresentation() { return 0; }
95 #endif
96
97 #if PLATFORM(CG)
98     virtual CGImageRef getCGImageRef() { return 0; }
99 #endif
100
101 #if PLATFORM(WIN)
102     virtual bool getHBITMAP(HBITMAP) { return false; }
103 #endif
104
105 private:
106     virtual void draw(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, CompositeOperator) = 0;
107     virtual void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatPoint& srcPoint, const FloatSize& tileSize, CompositeOperator) = 0;
108     virtual void drawTiled(GraphicsContext*, const FloatRect& dstRect, const FloatRect& srcRect, TileRule hRule, TileRule vRule, CompositeOperator) = 0;
109     
110     Vector<char> m_data; // The encoded raw data for the image. 
111     ImageAnimationObserver* m_animationObserver;
112 };
113
114 }
115
116 #endif