CTTE: StaticNodeLists often contain only Elements, we shouldn't store them as Vector...
[WebKit-https.git] / Source / WebCore / html / HTMLCollection.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2003, 2004, 2005, 2006, 2007, 2008, 2011, 2012 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef HTMLCollection_h
24 #define HTMLCollection_h
25
26 #include "CollectionType.h"
27 #include "LiveNodeList.h"
28 #include "ScriptWrappable.h"
29 #include <wtf/Forward.h>
30 #include <wtf/HashMap.h>
31 #include <wtf/Vector.h>
32
33 namespace WebCore {
34
35 class HTMLCollection : public LiveNodeListBase {
36 public:
37     static PassRefPtr<HTMLCollection> create(Node* base, CollectionType);
38     virtual ~HTMLCollection();
39
40     // DOM API
41     virtual Node* namedItem(const AtomicString& name) const;
42     PassRefPtr<NodeList> tags(const String&);
43
44     // Non-DOM API
45     virtual bool hasNamedItem(const AtomicString& name) const;
46     void namedItems(const AtomicString& name, Vector<Ref<Element>>&) const;
47     bool isEmpty() const
48     {
49         if (isLengthCacheValid())
50             return !cachedLength();
51         if (isItemCacheValid())
52             return !cachedItem();
53         return !item(0);
54     }
55     bool hasExactlyOneItem() const
56     {
57         if (isLengthCacheValid())
58             return cachedLength() == 1;
59         if (isItemCacheValid())
60             return cachedItem() && !cachedItemOffset() && !item(1);
61         return item(0) && !item(1);
62     }
63
64     virtual Element* virtualItemAfter(unsigned& offsetInArray, Element*) const;
65
66     Element* traverseFirstElement(unsigned& offsetInArray, ContainerNode* root) const;
67     Element* traverseForwardToOffset(unsigned offset, Element* currentElement, unsigned& currentOffset, unsigned& offsetInArray, ContainerNode* root) const;
68
69 protected:
70     HTMLCollection(Node* base, CollectionType, ItemAfterOverrideType);
71
72     virtual void updateNameCache() const;
73
74     typedef HashMap<AtomicStringImpl*, OwnPtr<Vector<Element*> > > NodeCacheMap;
75     Vector<Element*>* idCache(const AtomicString& name) const { return m_idCache.get(name.impl()); }
76     Vector<Element*>* nameCache(const AtomicString& name) const { return m_nameCache.get(name.impl()); }
77     void appendIdCache(const AtomicString& name, Element* element) const { append(m_idCache, name, element); }
78     void appendNameCache(const AtomicString& name, Element* element) const { append(m_nameCache, name, element); }
79
80 private:
81     Element* traverseNextElement(unsigned& offsetInArray, Element* previous, ContainerNode* root) const;
82
83     virtual bool isLiveNodeList() const OVERRIDE { ASSERT_NOT_REACHED(); return true; }
84
85     static void append(NodeCacheMap&, const AtomicString&, Element*);
86
87     mutable NodeCacheMap m_idCache;
88     mutable NodeCacheMap m_nameCache;
89     mutable unsigned m_cachedElementsArrayOffset;
90
91     friend class LiveNodeListBase;
92 };
93
94 } // namespace
95
96 #endif