Remove CSS_IMAGE_SET feature define
[WebKit-https.git] / Source / WebCore / css / CSSImageSetValue.h
1 /*
2  * Copyright (C) 2012 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. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #ifndef CSSImageSetValue_h
27 #define CSSImageSetValue_h
28
29 #include "CSSValueList.h"
30
31 namespace WebCore {
32
33 class CachedResourceLoader;
34 class Document;
35 class StyleCachedImage;
36 class StyleImage;
37 struct ResourceLoaderOptions;
38
39 class CSSImageSetValue : public CSSValueList {
40 public:
41
42     static Ref<CSSImageSetValue> create()
43     {
44         return adoptRef(*new CSSImageSetValue());
45     }
46     ~CSSImageSetValue();
47
48     StyleCachedImage* bestFitImage(CachedResourceLoader&, const ResourceLoaderOptions&);
49
50     // Returns a StyleCachedImage if the best fit image has been cached already, otherwise a StylePendingImage.
51     StyleImage* cachedOrPendingImageSet(const Document&);
52
53     String customCSSText() const;
54
55     bool isPending() const { return !m_accessedBestFitImage; }
56
57     struct ImageWithScale {
58         String imageURL;
59         float scaleFactor;
60     };
61
62     bool traverseSubresources(const std::function<bool (const CachedResource&)>& handler) const;
63
64     Ref<CSSImageSetValue> cloneForCSSOM() const;
65
66 protected:
67     ImageWithScale bestImageForScaleFactor();
68
69 private:
70     CSSImageSetValue();
71     CSSImageSetValue(const CSSImageSetValue& cloneFrom);
72
73     void detachPendingImage();
74     void fillImageSet();
75     static inline bool compareByScaleFactor(ImageWithScale first, ImageWithScale second) { return first.scaleFactor < second.scaleFactor; }
76
77     RefPtr<StyleImage> m_image;
78     bool m_accessedBestFitImage;
79
80     // This represents the scale factor that we used to find the best fit image. It does not necessarily
81     // correspond to the scale factor of the best fit image.
82     float m_scaleFactor;
83
84     Vector<ImageWithScale> m_imagesInSet;
85 };
86
87 } // namespace WebCore
88
89 SPECIALIZE_TYPE_TRAITS_CSS_VALUE(CSSImageSetValue, isImageSetValue())
90
91 #endif // CSSImageSetValue_h