4714e908ddb5d9b889c3b6ce657a140d7a3c59e2
[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, 2013, 2014 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 "CollectionIndexCache.h"
27 #include "HTMLNames.h"
28 #include "LiveNodeList.h"
29 #include "ScriptWrappable.h"
30 #include <wtf/HashMap.h>
31
32 namespace WebCore {
33
34 class Element;
35
36 class CollectionNamedElementCache {
37 public:
38     const Vector<Element*>* findElementsWithId(const AtomicString& id) const;
39     const Vector<Element*>* findElementsWithName(const AtomicString& name) const;
40
41     void appendToIdCache(const AtomicString& id, Element&);
42     void appendToNameCache(const AtomicString& name, Element&);
43     void didPopulate();
44
45     size_t memoryCost() const;
46
47 private:
48     typedef HashMap<AtomicStringImpl*, Vector<Element*>> StringToElementsMap;
49
50     const Vector<Element*>* find(const StringToElementsMap&, const AtomicString& key) const;
51     static void append(StringToElementsMap&, const AtomicString& key, Element&);
52
53     StringToElementsMap m_idMap;
54     StringToElementsMap m_nameMap;
55
56 #if !ASSERT_DISABLED
57     bool m_didPopulate { false };
58 #endif
59 };
60
61 class HTMLCollection : public ScriptWrappable, public RefCounted<HTMLCollection> {
62 public:
63     static Ref<HTMLCollection> create(ContainerNode& base, CollectionType);
64     virtual ~HTMLCollection();
65
66     // DOM API
67     unsigned length() const;
68     Element* item(unsigned offset) const;
69     virtual Element* namedItem(const AtomicString& name) const;
70     PassRefPtr<NodeList> tags(const String&);
71
72     // Non-DOM API
73     bool hasNamedItem(const AtomicString& name) const;
74     Vector<Ref<Element>> namedItems(const AtomicString& name) const;
75     size_t memoryCost() const;
76
77     bool isRootedAtDocument() const;
78     NodeListInvalidationType invalidationType() const;
79     CollectionType type() const;
80     ContainerNode& ownerNode() const;
81     void invalidateCache(const QualifiedName* attributeName) const;
82     virtual void invalidateCache(Document&) const;
83
84     // For CollectionIndexCache; do not use elsewhere.
85     Element* collectionBegin() const;
86     Element* collectionLast() const;
87     Element* collectionEnd() const;
88     void collectionTraverseForward(Element*&, unsigned count, unsigned& traversedCount) const;
89     void collectionTraverseBackward(Element*&, unsigned count) const;
90     bool collectionCanTraverseBackward() const;
91     void willValidateIndexCache() const;
92
93     bool hasNamedElementCache() const;
94
95 protected:
96     enum ElementTraversalType { NormalTraversal, CustomForwardOnlyTraversal };
97     HTMLCollection(ContainerNode& base, CollectionType, ElementTraversalType = NormalTraversal);
98
99     virtual void updateNamedElementCache() const;
100
101     void setNamedItemCache(std::unique_ptr<CollectionNamedElementCache>) const;
102     const CollectionNamedElementCache& namedItemCaches() const;
103
104 private:
105     Document& document() const;
106     ContainerNode& rootNode() const;
107     bool usesCustomForwardOnlyTraversal() const;
108
109     Element* iterateForPreviousElement(Element*) const;
110     Element* firstElement(ContainerNode& root) const;
111     Element* traverseForward(Element&, unsigned count, unsigned& traversedCount, ContainerNode& root) const;
112
113     virtual Element* customElementAfter(Element*) const;
114
115     void invalidateNamedElementCache(Document&) const;
116
117     enum RootType { IsRootedAtNode, IsRootedAtDocument };
118     static RootType rootTypeFromCollectionType(CollectionType);
119
120     Ref<ContainerNode> m_ownerNode;
121
122     mutable CollectionIndexCache<HTMLCollection, Element*> m_indexCache;
123     mutable std::unique_ptr<CollectionNamedElementCache> m_namedElementCache;
124
125     const unsigned m_collectionType : 5;
126     const unsigned m_invalidationType : 4;
127     const unsigned m_rootType : 1;
128     const unsigned m_shouldOnlyIncludeDirectChildren : 1;
129     const unsigned m_usesCustomForwardOnlyTraversal : 1;
130 };
131
132 inline const Vector<Element*>* CollectionNamedElementCache::findElementsWithId(const AtomicString& id) const
133 {
134     return find(m_idMap, id);
135 }
136
137 inline const Vector<Element*>* CollectionNamedElementCache::findElementsWithName(const AtomicString& name) const
138 {
139     return find(m_nameMap, name);
140 }
141
142 inline void CollectionNamedElementCache::appendToIdCache(const AtomicString& id, Element& element)
143 {
144     return append(m_idMap, id, element);
145 }
146
147 inline void CollectionNamedElementCache::appendToNameCache(const AtomicString& name, Element& element)
148 {
149     return append(m_nameMap, name, element);
150 }
151
152 inline size_t CollectionNamedElementCache::memoryCost() const
153 {
154     return (m_idMap.size() + m_nameMap.size()) * sizeof(Element*);
155 }
156
157 inline void CollectionNamedElementCache::didPopulate()
158 {
159 #if !ASSERT_DISABLED
160     m_didPopulate = true;
161 #endif
162     if (size_t cost = memoryCost())
163         reportExtraMemoryAllocatedForCollectionIndexCache(cost);
164 }
165
166 inline const Vector<Element*>* CollectionNamedElementCache::find(const StringToElementsMap& map, const AtomicString& key) const
167 {
168     ASSERT(m_didPopulate);
169     auto it = map.find(key.impl());
170     return it != map.end() ? &it->value : nullptr;
171 }
172
173 inline void CollectionNamedElementCache::append(StringToElementsMap& map, const AtomicString& key, Element& element)
174 {
175     map.add(key.impl(), Vector<Element*>()).iterator->value.append(&element);
176 }
177
178 inline size_t HTMLCollection::memoryCost() const
179 {
180     return m_indexCache.memoryCost() + (m_namedElementCache ? m_namedElementCache->memoryCost() : 0);
181 }
182
183 inline bool HTMLCollection::isRootedAtDocument() const
184 {
185     return m_rootType == IsRootedAtDocument;
186 }
187
188 inline NodeListInvalidationType HTMLCollection::invalidationType() const
189 {
190     return static_cast<NodeListInvalidationType>(m_invalidationType);
191 }
192
193 inline CollectionType HTMLCollection::type() const
194 {
195     return static_cast<CollectionType>(m_collectionType);
196 }
197
198 inline ContainerNode& HTMLCollection::ownerNode() const
199 {
200     return const_cast<ContainerNode&>(m_ownerNode.get());
201 }
202
203 inline Document& HTMLCollection::document() const
204 {
205     return m_ownerNode->document();
206 }
207
208 inline void HTMLCollection::invalidateCache(const QualifiedName* attributeName) const
209 {
210     if (!attributeName || shouldInvalidateTypeOnAttributeChange(invalidationType(), *attributeName))
211         invalidateCache(document());
212     else if (hasNamedElementCache() && (*attributeName == HTMLNames::idAttr || *attributeName == HTMLNames::nameAttr))
213         invalidateNamedElementCache(document());
214 }
215
216 inline Element* HTMLCollection::collectionEnd() const
217 {
218     return nullptr;
219 }
220
221 inline bool HTMLCollection::collectionCanTraverseBackward() const
222 {
223     return !m_usesCustomForwardOnlyTraversal;
224 }
225
226 inline void HTMLCollection::willValidateIndexCache() const
227 {
228     document().registerCollection(const_cast<HTMLCollection&>(*this));
229 }
230
231 inline bool HTMLCollection::hasNamedElementCache() const
232 {
233     return !!m_namedElementCache;
234 }
235
236 inline void HTMLCollection::setNamedItemCache(std::unique_ptr<CollectionNamedElementCache> cache) const
237 {
238     ASSERT(cache);
239     ASSERT(!m_namedElementCache);
240     cache->didPopulate();
241     m_namedElementCache = WTF::move(cache);
242     document().collectionCachedIdNameMap(*this);
243 }
244
245 inline const CollectionNamedElementCache& HTMLCollection::namedItemCaches() const
246 {
247     ASSERT(!!m_namedElementCache);
248     return *m_namedElementCache;
249 }
250
251 } // namespace WebCore
252
253 #define SPECIALIZE_TYPE_TRAITS_HTMLCOLLECTION(ClassName, Type) \
254 SPECIALIZE_TYPE_TRAITS_BEGIN(WebCore::ClassName) \
255     static bool isType(const WebCore::HTMLCollection& collection) { return collection.type() == WebCore::Type; } \
256 SPECIALIZE_TYPE_TRAITS_END()
257
258 #endif // HTMLCollection_h