Rename DynamicNodeList to LiveNodeList
[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/PassOwnPtr.h>
32 #include <wtf/Vector.h>
33
34 namespace WebCore {
35
36 class HTMLCollection : public LiveNodeListBase {
37 public:
38     static PassRefPtr<HTMLCollection> create(Node* base, CollectionType);
39     virtual ~HTMLCollection();
40
41     // DOM API
42     virtual Node* namedItem(const AtomicString& name) const;
43     PassRefPtr<NodeList> tags(const String&);
44
45     // Non-DOM API
46     virtual bool hasNamedItem(const AtomicString& name) const;
47     void namedItems(const AtomicString& name, Vector<RefPtr<Node> >&) const;
48     bool isEmpty() const
49     {
50         if (isLengthCacheValid())
51             return !cachedLength();
52         if (isItemCacheValid())
53             return !cachedItem();
54         return !item(0);
55     }
56     bool hasExactlyOneItem() const
57     {
58         if (isLengthCacheValid())
59             return cachedLength() == 1;
60         if (isItemCacheValid())
61             return cachedItem() && !cachedItemOffset() && !item(1);
62         return item(0) && !item(1);
63     }
64
65     Node* base() const { return ownerNode(); }
66     virtual Element* virtualItemAfter(unsigned& offsetInArray, Element*) const;
67
68 protected:
69     HTMLCollection(Node* base, CollectionType, ItemAfterOverrideType);
70
71     virtual void updateNameCache() const;
72
73     typedef HashMap<AtomicStringImpl*, OwnPtr<Vector<Element*> > > NodeCacheMap;
74     Vector<Element*>* idCache(const AtomicString& name) const { return m_idCache.get(name.impl()); }
75     Vector<Element*>* nameCache(const AtomicString& name) const { return m_nameCache.get(name.impl()); }
76     void appendIdCache(const AtomicString& name, Element* element) const { append(m_idCache, name, element); }
77     void appendNameCache(const AtomicString& name, Element* element) const { append(m_nameCache, name, element); }
78
79 private:
80     bool checkForNameMatch(Element*, bool checkName, const AtomicString& name) const;
81
82     virtual bool isLiveNodeList() const OVERRIDE { ASSERT_NOT_REACHED(); return true; }
83
84     static void append(NodeCacheMap&, const AtomicString&, Element*);
85
86     mutable NodeCacheMap m_idCache;
87     mutable NodeCacheMap m_nameCache;
88     mutable unsigned m_cachedElementsArrayOffset;
89
90     friend class LiveNodeListBase;
91 };
92
93 } // namespace
94
95 #endif