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 blink {
29
30class CSSValueList : public CSSValue {
31public:
32    static PassRefPtrWillBeRawPtr<CSSValueList> createCommaSeparated()
33    {
34        return adoptRefWillBeNoop(new CSSValueList(CommaSeparator));
35    }
36    static PassRefPtrWillBeRawPtr<CSSValueList> createSpaceSeparated()
37    {
38        return adoptRefWillBeNoop(new CSSValueList(SpaceSeparator));
39    }
40    static PassRefPtrWillBeRawPtr<CSSValueList> createSlashSeparated()
41    {
42        return adoptRefWillBeNoop(new CSSValueList(SlashSeparator));
43    }
44
45    size_t length() const { return m_values.size(); }
46    CSSValue* item(size_t index) { return m_values[index].get(); }
47    const CSSValue* item(size_t index) const { return m_values[index].get(); }
48    CSSValue* itemWithBoundsCheck(size_t index) { return index < m_values.size() ? m_values[index].get() : 0; }
49
50    void append(PassRefPtrWillBeRawPtr<CSSValue> value) { m_values.append(value); }
51    void prepend(PassRefPtrWillBeRawPtr<CSSValue> value) { m_values.prepend(value); }
52    bool removeAll(CSSValue*);
53    bool hasValue(CSSValue*) const;
54    PassRefPtrWillBeRawPtr<CSSValueList> copy();
55
56    String customCSSText(CSSTextFormattingFlags = QuoteCSSStringIfNeeded) const;
57    bool equals(const CSSValueList&) const;
58    bool equals(const CSSValue&) const;
59
60    bool hasFailedOrCanceledSubresources() const;
61
62    PassRefPtrWillBeRawPtr<CSSValueList> cloneForCSSOM() const;
63
64    void traceAfterDispatch(Visitor*);
65
66protected:
67    CSSValueList(ClassType, ValueListSeparator);
68    CSSValueList(const CSSValueList& cloneFrom);
69
70private:
71    explicit CSSValueList(ValueListSeparator);
72
73    WillBeHeapVector<RefPtrWillBeMember<CSSValue>, 4> m_values;
74};
75
76DEFINE_CSS_VALUE_TYPE_CASTS(CSSValueList, isValueList());
77
78// Objects of this class are intended to be stack-allocated and scoped to a single function.
79// Please take care not to pass these around as they do hold onto a raw pointer.
80class CSSValueListInspector {
81    STACK_ALLOCATED();
82public:
83    CSSValueListInspector(CSSValue* value) : m_list((value && value->isValueList()) ? toCSSValueList(value) : 0) { }
84    CSSValue* item(size_t index) const { ASSERT_WITH_SECURITY_IMPLICATION(index < length()); return m_list->item(index); }
85    CSSValue* first() const { return item(0); }
86    CSSValue* second() const { return item(1); }
87    size_t length() const { return m_list ? m_list->length() : 0; }
88private:
89    RawPtrWillBeMember<CSSValueList> m_list;
90};
91
92// Wrapper that can be used to iterate over any CSSValue. Non-list values and 0 behave as zero-length lists.
93// Objects of this class are intended to be stack-allocated and scoped to a single function.
94// Please take care not to pass these around as they do hold onto a raw pointer.
95class CSSValueListIterator {
96    STACK_ALLOCATED();
97public:
98    CSSValueListIterator(CSSValue* value) : m_inspector(value), m_position(0) { }
99    bool hasMore() const { return m_position < m_inspector.length(); }
100    CSSValue* value() const { return m_inspector.item(m_position); }
101    bool isPrimitiveValue() const { return value()->isPrimitiveValue(); }
102    void advance() { m_position++; ASSERT(m_position <= m_inspector.length());}
103    size_t index() const { return m_position; }
104private:
105    CSSValueListInspector m_inspector;
106    size_t m_position;
107};
108
109} // namespace blink
110
111#endif // CSSValueList_h
112