7e627a3e68727eafd3300678f5f9d08f8416007c
[WebKit-https.git] / Source / WebCore / css / CSSValueList.h
1 /*
2  * (C) 1999-2003 Lars Knoll (knoll@kde.org)
3  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  */
20
21 #ifndef CSSValueList_h
22 #define CSSValueList_h
23
24 #include "CSSValue.h"
25 #include <wtf/PassRefPtr.h>
26 #include <wtf/Vector.h>
27
28 namespace WebCore {
29
30 class CSSParserValueList;
31
32 class CSSValueList : public CSSValue {
33 public:
34     static PassRefPtr<CSSValueList> createCommaSeparated()
35     {
36         return adoptRef(new CSSValueList(CommaSeparator));
37     }
38     static PassRefPtr<CSSValueList> createSpaceSeparated()
39     {
40         return adoptRef(new CSSValueList(SpaceSeparator));
41     }
42     static PassRefPtr<CSSValueList> createSlashSeparated()
43     {
44         return adoptRef(new CSSValueList(SlashSeparator));
45     }
46     static PassRefPtr<CSSValueList> createFromParserValueList(CSSParserValueList* list)
47     {
48         return adoptRef(new CSSValueList(list));
49     }
50
51     size_t length() const { return m_values.size(); }
52     CSSValue* item(size_t index) { return index < m_values.size() ? m_values[index].get() : 0; }
53     const CSSValue* item(size_t index) const { return index < m_values.size() ? m_values[index].get() : 0; }
54     CSSValue* itemWithoutBoundsCheck(size_t index) { return m_values[index].get(); }
55
56     void append(PassRefPtr<CSSValue> value) { m_values.append(value); }
57     void prepend(PassRefPtr<CSSValue> value) { m_values.insert(0, value); }
58     bool removeAll(CSSValue*);
59     bool hasValue(CSSValue*) const;
60     PassRefPtr<CSSValueList> copy();
61
62     String customCSSText() const;
63     bool equals(const CSSValueList&) const;
64     bool equals(const CSSValue&) const;
65 #if ENABLE(CSS_VARIABLES)
66     String customSerializeResolvingVariables(const HashMap<AtomicString, String>&) const;
67 #endif
68
69     void addSubresourceStyleURLs(ListHashSet<KURL>&, const StyleSheetContents*) const;
70
71     bool hasFailedOrCanceledSubresources() const;
72     
73     PassRefPtr<CSSValueList> cloneForCSSOM() const;
74
75 protected:
76     CSSValueList(ClassType, ValueListSeparator);
77     CSSValueList(const CSSValueList& cloneFrom);
78
79 private:
80     explicit CSSValueList(ValueListSeparator);
81     explicit CSSValueList(CSSParserValueList*);
82
83     Vector<RefPtr<CSSValue>, 4> m_values;
84 };
85
86 // Objects of this class are intended to be stack-allocated and scoped to a single function.
87 // Please take care not to pass these around as they do hold onto a raw pointer.
88 class CSSValueListInspector {
89 public:
90     CSSValueListInspector(CSSValue* value) : m_list((value && value->isValueList()) ? static_cast<CSSValueList*>(value) : 0) { }
91     CSSValue* item(size_t index) const { ASSERT_WITH_SECURITY_IMPLICATION(index < length()); return m_list->itemWithoutBoundsCheck(index); }
92     CSSValue* first() const { return item(0); }
93     CSSValue* second() const { return item(1); }
94     size_t length() const { return m_list ? m_list->length() : 0; }
95 private:
96     CSSValueList* m_list;
97 };
98
99 CSS_VALUE_TYPE_CASTS(ValueList)
100
101 // Wrapper that can be used to iterate over any CSSValue. Non-list values and 0 behave as zero-length lists.
102 // Objects of this class are intended to be stack-allocated and scoped to a single function.
103 // Please take care not to pass these around as they do hold onto a raw pointer.
104 class CSSValueListIterator {
105 public:
106     CSSValueListIterator(CSSValue* value) : m_inspector(value), m_position(0) { }
107     bool hasMore() const { return m_position < m_inspector.length(); }
108     CSSValue* value() const { return m_inspector.item(m_position); }
109     bool isPrimitiveValue() const { return value()->isPrimitiveValue(); }
110     void advance() { m_position++; ASSERT(m_position <= m_inspector.length());}
111     size_t index() const { return m_position; }
112 private:
113     CSSValueListInspector m_inspector;
114     size_t m_position;
115 };
116
117 } // namespace WebCore
118
119 #endif // CSSValueList_h