6c920faaeadf3348f6dcbc871007ea69aaab36a1
[WebKit-https.git] / Source / WebCore / css / CSSImageGeneratorValue.h
1 /*
2  * Copyright (C) 2008, 2011, 2012, 2013 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef CSSImageGeneratorValue_h
27 #define CSSImageGeneratorValue_h
28
29 #include "CSSValue.h"
30 #include "IntSizeHash.h"
31 #include "Timer.h"
32 #include <wtf/HashCountedSet.h>
33
34 namespace WebCore {
35
36 class CachedImage;
37 class CachedResourceLoader;
38 class GeneratedImage;
39 class Image;
40 class RenderElement;
41 class StyleResolver;
42
43 class CSSImageGeneratorValue : public CSSValue {
44 public:
45     ~CSSImageGeneratorValue();
46
47     void addClient(RenderElement*);
48     void removeClient(RenderElement*);
49
50     PassRefPtr<Image> image(RenderElement*, const IntSize&);
51
52     bool isFixedSize() const;
53     IntSize fixedSize(const RenderElement*);
54
55     bool isPending() const;
56     bool knownToBeOpaque(const RenderElement*) const;
57
58     void loadSubimages(CachedResourceLoader*);
59
60 protected:
61     CSSImageGeneratorValue(ClassType);
62
63     GeneratedImage* cachedImageForSize(IntSize);
64     void saveCachedImageForSize(IntSize, PassRefPtr<GeneratedImage>);
65     const HashCountedSet<RenderElement*>& clients() const { return m_clients; }
66
67     // Helper functions for Crossfade and Filter.
68     static CachedImage* cachedImageForCSSValue(CSSValue*, CachedResourceLoader*);
69     static bool subimageIsPending(CSSValue*);
70
71 private:
72     class CachedGeneratedImage {
73     public:
74         CachedGeneratedImage(CSSImageGeneratorValue&, IntSize, PassRefPtr<GeneratedImage>);
75         GeneratedImage* image() { return m_image.get(); }
76         void puntEvictionTimer() { m_evictionTimer.restart(); }
77
78     private:
79         void evictionTimerFired(DeferrableOneShotTimer<CachedGeneratedImage>&);
80
81         CSSImageGeneratorValue& m_owner;
82         IntSize m_size;
83         RefPtr<GeneratedImage> m_image;
84         DeferrableOneShotTimer<CachedGeneratedImage> m_evictionTimer;
85     };
86
87     friend class CachedGeneratedImage;
88     void evictCachedGeneratedImage(IntSize);
89
90     HashCountedSet<RenderElement*> m_clients;
91     HashMap<IntSize, std::unique_ptr<CachedGeneratedImage>> m_images;
92 };
93
94 CSS_VALUE_TYPE_CASTS(CSSImageGeneratorValue, isImageGeneratorValue())
95
96 } // namespace WebCore
97
98 #endif // CSSImageGeneratorValue_h