src/third_party/WebKit/Source/core/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 "core/css/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 PassRefPtrWillBeRawPtr<CSSValueList> createCommaSeparated()
  35     {
  36         return adoptRefCountedWillBeRefCountedGarbageCollected(new CSSValueList(CommaSeparator));
  37     }
  38     static PassRefPtrWillBeRawPtr<CSSValueList> createSpaceSeparated()
  39     {
  40         return adoptRefCountedWillBeRefCountedGarbageCollected(new CSSValueList(SpaceSeparator));
  41     }
  42     static PassRefPtrWillBeRawPtr<CSSValueList> createSlashSeparated()
  43     {
  44         return adoptRefCountedWillBeRefCountedGarbageCollected(new CSSValueList(SlashSeparator));
  45     }
  46     static PassRefPtrWillBeRawPtr<CSSValueList> createFromParserValueList(CSSParserValueList* list)
  47     {
  48         return adoptRefCountedWillBeRefCountedGarbageCollected(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     PassRefPtrWillBeRawPtr<CSSValueList> copy();
  61
  62     String customCSSText(CSSTextFormattingFlags = QuoteCSSStringIfNeeded) const;
  63     bool equals(const CSSValueList&) const;
  64     bool equals(const CSSValue&) const;
  65
  66     bool hasFailedOrCanceledSubresources() const;
  67
  68     PassRefPtrWillBeRawPtr<CSSValueList> cloneForCSSOM() const;
  69
  70     void traceAfterDispatch(Visitor*);
  71
  72 protected:
  73     CSSValueList(ClassType, ValueListSeparator);
  74     CSSValueList(const CSSValueList& cloneFrom);
  75
  76 private:
  77     explicit CSSValueList(ValueListSeparator);
  78     explicit CSSValueList(CSSParserValueList*);
  79
  80     Vector<RefPtr<CSSValue>, 4> m_values;
  81 };
  82
  83 DEFINE_CSS_VALUE_TYPE_CASTS(CSSValueList, isValueList());
  84
  85 // Objects of this class are intended to be stack-allocated and scoped to a single function.
  86 // Please take care not to pass these around as they do hold onto a raw pointer.
  87 class CSSValueListInspector {
  88 public:
  89     CSSValueListInspector(CSSValue* value) : m_list((value && value->isValueList()) ? toCSSValueList(value) : 0) { }
  90     CSSValue* item(size_t index) const { ASSERT_WITH_SECURITY_IMPLICATION(index < length()); return m_list->itemWithoutBoundsCheck(index); }
  91     CSSValue* first() const { return item(0); }
  92     CSSValue* second() const { return item(1); }
  93     size_t length() const { return m_list ? m_list->length() : 0; }
  94 private:
  95     CSSValueList* m_list;
  96 };
  97
  98 // Wrapper that can be used to iterate over any CSSValue. Non-list values and 0 behave as zero-length lists.
  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.
 101 class CSSValueListIterator {
 102 public:
 103     CSSValueListIterator(CSSValue* value) : m_inspector(value), m_position(0) { }
 104     bool hasMore() const { return m_position < m_inspector.length(); }
 105     CSSValue* value() const { return m_inspector.item(m_position); }
 106     bool isPrimitiveValue() const { return value()->isPrimitiveValue(); }
 107     void advance() { m_position++; ASSERT(m_position <= m_inspector.length());}
 108     size_t index() const { return m_position; }
 109 private:
 110     CSSValueListInspector m_inspector;
 111     size_t m_position;
 112 };
 113
 114 } // namespace WebCore
 115
 116 #endif // CSSValueList_h