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
28namespace WebCore {
29
30class CSSParserValueList;
31
32class CSSValueList : public CSSValue {
33public:
34    static PassRef<CSSValueList> createCommaSeparated()
35    {
36        return adoptRef(*new CSSValueList(CommaSeparator));
37    }
38    static PassRef<CSSValueList> createSpaceSeparated()
39    {
40        return adoptRef(*new CSSValueList(SpaceSeparator));
41    }
42    static PassRef<CSSValueList> createSlashSeparated()
43    {
44        return adoptRef(*new CSSValueList(SlashSeparator));
45    }
46    static PassRef<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    const CSSValue* itemWithoutBoundsCheck(size_t index) const { ASSERT(index < m_values.size()); return m_values[index].get(); }
56
57    void append(PassRefPtr<CSSValue>);
58    void prepend(PassRefPtr<CSSValue>);
59    bool removeAll(CSSValue*);
60    bool hasValue(CSSValue*) const;
61    PassRefPtr<CSSValueList> copy();
62
63    String customCSSText() const;
64    bool equals(const CSSValueList&) const;
65    bool equals(const CSSValue&) const;
66
67    void addSubresourceStyleURLs(ListHashSet<URL>&, const StyleSheetContents*) const;
68
69    bool hasFailedOrCanceledSubresources() const;
70
71    PassRefPtr<CSSValueList> cloneForCSSOM() const;
72
73protected:
74    CSSValueList(ClassType, ValueListSeparator);
75    CSSValueList(const CSSValueList& cloneFrom);
76
77private:
78    explicit CSSValueList(ValueListSeparator);
79    explicit CSSValueList(CSSParserValueList&);
80
81    Vector<RefPtr<CSSValue>, 4> m_values;
82};
83
84CSS_VALUE_TYPE_CASTS(CSSValueList, isValueList())
85
86inline void CSSValueList::append(PassRefPtr<CSSValue> value)
87{
88    ASSERT(value);
89    m_values.append(value);
90}
91
92inline void CSSValueList::prepend(PassRefPtr<CSSValue> value)
93{
94    ASSERT(value);
95    m_values.insert(0, value);
96}
97
98// Objects of this class are intended to be stack-allocated and scoped to a single function.
99// Please take care not to pass these around as they do hold onto a raw pointer.
100class CSSValueListInspector {
101public:
102    CSSValueListInspector(CSSValue* value) : m_list((value && value->isValueList()) ? toCSSValueList(value) : 0) { }
103    CSSValue* item(size_t index) const { ASSERT_WITH_SECURITY_IMPLICATION(index < length()); return m_list->itemWithoutBoundsCheck(index); }
104    CSSValue* first() const { return item(0); }
105    CSSValue* second() const { return item(1); }
106    size_t length() const { return m_list ? m_list->length() : 0; }
107private:
108    CSSValueList* m_list;
109};
110
111// Wrapper that can be used to iterate over any CSSValue. Non-list values and 0 behave as zero-length lists.
112// Objects of this class are intended to be stack-allocated and scoped to a single function.
113// Please take care not to pass these around as they do hold onto a raw pointer.
114class CSSValueListIterator {
115public:
116    CSSValueListIterator(CSSValue* value) : m_inspector(value), m_position(0) { }
117    bool hasMore() const { return m_position < m_inspector.length(); }
118    CSSValue* value() const { return m_inspector.item(m_position); }
119    bool isPrimitiveValue() const { return value()->isPrimitiveValue(); }
120    void advance() { m_position++; ASSERT(m_position <= m_inspector.length());}
121    size_t index() const { return m_position; }
122private:
123    CSSValueListInspector m_inspector;
124    size_t m_position;
125};
126} // namespace WebCore
127
128#endif // CSSValueList_h
129