Move m_type and m_hasNameCache from HTMLCollectionCacheBase to DynamicNodeListCacheBa...
[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(CollectionType type)
43         : DynamicNodeListCacheBase(type)
44         , m_cachedElementsArrayOffset(0)
45         , m_cacheTreeVersion(0)
46     {
47     }
48
49 protected:
50     void clearCache(uint64_t currentDomTreeVersion) const
51     {
52         DynamicNodeListCacheBase::clearCache();
53         m_idCache.clear();
54         m_nameCache.clear();
55         m_cachedElementsArrayOffset = 0;
56         m_cacheTreeVersion = currentDomTreeVersion;
57     }
58
59     void setItemCache(Node* item, unsigned offset, unsigned elementsArrayOffset) const
60     {
61         setItemCache(item, offset);
62         m_cachedElementsArrayOffset = elementsArrayOffset;
63     }
64     unsigned cachedElementsArrayOffset() const { return m_cachedElementsArrayOffset; }
65
66     uint64_t cacheTreeVersion() const { return m_cacheTreeVersion; }
67
68     typedef HashMap<AtomicStringImpl*, OwnPtr<Vector<Element*> > > NodeCacheMap;
69     Vector<Element*>* idCache(const AtomicString& name) const { return m_idCache.get(name.impl()); }
70     Vector<Element*>* nameCache(const AtomicString& name) const { return m_nameCache.get(name.impl()); }
71     void appendIdCache(const AtomicString& name, Element* element) const { append(m_idCache, name, element); }
72     void appendNameCache(const AtomicString& name, Element* element) const { append(m_nameCache, name, element); }
73
74     static void append(NodeCacheMap&, const AtomicString&, Element*);
75
76 private:
77     using DynamicNodeListCacheBase::isRootedAtDocument;
78     using DynamicNodeListCacheBase::shouldInvalidateOnAttributeChange;
79     using DynamicNodeListCacheBase::clearCache;
80     using DynamicNodeListCacheBase::setItemCache;
81
82     mutable NodeCacheMap m_idCache;
83     mutable NodeCacheMap m_nameCache;
84     mutable unsigned m_cachedElementsArrayOffset;
85     mutable uint64_t m_cacheTreeVersion;
86 };
87
88 class HTMLCollection : public RefCounted<HTMLCollection>, public HTMLCollectionCacheBase {
89 public:
90     static PassRefPtr<HTMLCollection> create(Node* base, CollectionType);
91     virtual ~HTMLCollection();
92
93     // DOM API
94     unsigned length() const;
95     Node* item(unsigned index) const;
96     virtual Node* namedItem(const AtomicString& name) const;
97     PassRefPtr<NodeList> tags(const String&);
98
99     // Non-DOM API
100     virtual bool hasNamedItem(const AtomicString& name) const;
101     void namedItems(const AtomicString& name, Vector<RefPtr<Node> >&) const;
102     bool isEmpty() const
103     {
104         invalidateCacheIfNeeded();
105         if (isLengthCacheValid())
106             return !cachedLength();
107         if (isItemCacheValid())
108             return !cachedItem();
109         return !item(0);
110     }
111     bool hasExactlyOneItem() const
112     {
113         invalidateCacheIfNeeded();
114         if (isLengthCacheValid())
115             return cachedLength() == 1;
116         if (isItemCacheValid())
117             return cachedItem() && !cachedItemOffset() && !item(1);
118         return item(0) && !item(1);
119     }
120
121     Node* base() const { return m_base.get(); }
122
123     void invalidateCache() const;
124     void invalidateCacheIfNeeded() const;
125
126 protected:
127     HTMLCollection(Node* base, CollectionType);
128
129     virtual void updateNameCache() const;
130     virtual Element* itemAfter(unsigned& offsetInArray, Element*) const;
131
132 private:
133     bool checkForNameMatch(Element*, bool checkName, const AtomicString& name) const;
134
135     Element* itemAfterCachedItem(unsigned) const;
136     bool isAcceptableElement(Element*) const;
137
138     RefPtr<Node> m_base;
139 };
140
141 } // namespace
142
143 #endif