Unify HTMLCollection and DynamicNodeList
[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 "Node.h"
27 #include "CollectionType.h"
28 #include "DynamicNodeList.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 Document;
37 class Element;
38 class NodeList;
39
40 class HTMLCollectionCacheBase : public DynamicNodeListCacheBase {
41 public:
42     HTMLCollectionCacheBase(Node* ownerNode, NodeListRootType rootType, NodeListInvalidationType invalidationType,
43         bool shouldOnlyIncludeDirectChildren, CollectionType collectionType, ItemAfterOverrideType itemAfterOverrideType)
44         : DynamicNodeListCacheBase(ownerNode, rootType, invalidationType, shouldOnlyIncludeDirectChildren, collectionType, itemAfterOverrideType)
45     {
46     }
47
48 protected:
49     typedef HashMap<AtomicStringImpl*, OwnPtr<Vector<Element*> > > NodeCacheMap;
50     Vector<Element*>* idCache(const AtomicString& name) const { return m_idCache.get(name.impl()); }
51     Vector<Element*>* nameCache(const AtomicString& name) const { return m_nameCache.get(name.impl()); }
52     void appendIdCache(const AtomicString& name, Element* element) const { append(m_idCache, name, element); }
53     void appendNameCache(const AtomicString& name, Element* element) const { append(m_nameCache, name, element); }
54
55     static void append(NodeCacheMap&, const AtomicString&, Element*);
56
57 private:
58     using DynamicNodeListCacheBase::isRootedAtDocument;
59
60     mutable NodeCacheMap m_idCache;
61     mutable NodeCacheMap m_nameCache;
62     mutable unsigned m_cachedElementsArrayOffset;
63
64     friend class DynamicNodeListCacheBase;
65 };
66
67 class HTMLCollection : public RefCounted<HTMLCollection>, public HTMLCollectionCacheBase {
68 public:
69     static PassRefPtr<HTMLCollection> create(Node* base, CollectionType);
70     virtual ~HTMLCollection();
71
72     // DOM API
73     unsigned length() const { return lengthCommon(); }
74     Node* item(unsigned offset) const { return itemCommon(offset); }
75     virtual Node* namedItem(const AtomicString& name) const;
76     PassRefPtr<NodeList> tags(const String&);
77
78     // Non-DOM API
79     virtual bool hasNamedItem(const AtomicString& name) const;
80     void namedItems(const AtomicString& name, Vector<RefPtr<Node> >&) const;
81     bool isEmpty() const
82     {
83         if (isLengthCacheValid())
84             return !cachedLength();
85         if (isItemCacheValid())
86             return !cachedItem();
87         return !item(0);
88     }
89     bool hasExactlyOneItem() const
90     {
91         if (isLengthCacheValid())
92             return cachedLength() == 1;
93         if (isItemCacheValid())
94             return cachedItem() && !cachedItemOffset() && !item(1);
95         return item(0) && !item(1);
96     }
97
98     Node* base() const { return ownerNode(); }
99     virtual Element* virtualItemAfter(unsigned& offsetInArray, Element*) const;
100
101 protected:
102     HTMLCollection(Node* base, CollectionType, ItemAfterOverrideType);
103
104     virtual void updateNameCache() const;
105
106 private:
107     bool checkForNameMatch(Element*, bool checkName, const AtomicString& name) const;
108 };
109
110 } // namespace
111
112 #endif