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 "core/css/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 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.prepend(value); }
58    bool removeAll(CSSValue*);
59    bool hasValue(CSSValue*) const;
60    PassRefPtr<CSSValueList> copy();
61
62    String customCssText(CssTextFormattingFlags = QuoteCSSStringIfNeeded) const;
63    bool equals(const CSSValueList&) const;
64    bool equals(const CSSValue&) const;
65    String customSerializeResolvingVariables(const HashMap<AtomicString, String>&) const;
66
67    void addSubresourceStyleURLs(ListHashSet<KURL>&, 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
84inline CSSValueList* toCSSValueList(CSSValue* value)
85{
86    ASSERT_WITH_SECURITY_IMPLICATION(!value || value->isValueList());
87    return static_cast<CSSValueList*>(value);
88}
89
90inline const CSSValueList* toCSSValueList(const CSSValue* value)
91{
92    ASSERT_WITH_SECURITY_IMPLICATION(!value || value->isValueList());
93    return static_cast<const CSSValueList*>(value);
94}
95
96// Catch unneeded cast.
97void toCSSValueList(const CSSValueList*);
98
99// Objects of this class are intended to be stack-allocated and scoped to a single function.
100// Please take care not to pass these around as they do hold onto a raw pointer.
101class CSSValueListInspector {
102public:
103    CSSValueListInspector(CSSValue* value) : m_list((value && value->isValueList()) ? toCSSValueList(value) : 0) { }
104    CSSValue* item(size_t index) const { ASSERT_WITH_SECURITY_IMPLICATION(index < length()); return m_list->itemWithoutBoundsCheck(index); }
105    CSSValue* first() const { return item(0); }
106    CSSValue* second() const { return item(1); }
107    size_t length() const { return m_list ? m_list->length() : 0; }
108private:
109    CSSValueList* m_list;
110};
111
112// Wrapper that can be used to iterate over any CSSValue. Non-list values and 0 behave as zero-length lists.
113// Objects of this class are intended to be stack-allocated and scoped to a single function.
114// Please take care not to pass these around as they do hold onto a raw pointer.
115class CSSValueListIterator {
116public:
117    CSSValueListIterator(CSSValue* value) : m_inspector(value), m_position(0) { }
118    bool hasMore() const { return m_position < m_inspector.length(); }
119    CSSValue* value() const { return m_inspector.item(m_position); }
120    bool isPrimitiveValue() const { return value()->isPrimitiveValue(); }
121    void advance() { m_position++; ASSERT(m_position <= m_inspector.length());}
122    size_t index() const { return m_position; }
123private:
124    CSSValueListInspector m_inspector;
125    size_t m_position;
126};
127
128} // namespace WebCore
129
130#endif // CSSValueList_h
131