02ff26c37ceaa402b78a77ce0008c010d16b56e0
[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 #if ENABLE(CSS_IMAGE_SET)
30
31 #include "CSSValueList.h"
32
33 namespace WebCore {
34
35 class CachedResourceLoader;
36 class Document;
37 class StyleCachedImageSet;
38 class StyleImage;
39
40 class CSSImageSetValue : public CSSValueList {
41 public:
42
43     static PassRefPtr<CSSImageSetValue> create()
44     {
45         return adoptRef(new CSSImageSetValue());
46     }
47     ~CSSImageSetValue();
48
49     StyleCachedImageSet* cachedImageSet(CachedResourceLoader*);
50
51     // Returns a StyleCachedImageSet if the best fit image has been cached already, otherwise a StylePendingImage.
52     StyleImage* cachedOrPendingImageSet(Document*);
53
54     String customCSSText() const;
55
56     bool isPending() const { return !m_accessedBestFitImage; }
57
58     struct ImageWithScale {
59         String imageURL;
60         float scaleFactor;
61     };
62
63     bool hasFailedOrCanceledSubresources() const;
64
65     PassRefPtr<CSSImageSetValue> cloneForCSSOM() const;
66
67 protected:
68     ImageWithScale bestImageForScaleFactor();
69
70 private:
71     CSSImageSetValue();
72     CSSImageSetValue(const CSSImageSetValue& cloneFrom);
73
74     void fillImageSet();
75     static inline bool compareByScaleFactor(ImageWithScale first, ImageWithScale second) { return first.scaleFactor < second.scaleFactor; }
76
77     RefPtr<StyleImage> m_imageSet;
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 CSS_VALUE_TYPE_CASTS(ImageSetValue)
88
89 } // namespace WebCore
90
91 #endif // ENABLE(CSS_IMAGE_SET)
92
93 #endif // CSSImageSetValue_h