Add WTF::move()
[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 "CollectionType.h"
28 #include "ContainerNode.h"
29 #include "Document.h"
30 #include "HTMLNames.h"
31 #include "LiveNodeList.h"
32 #include "ScriptWrappable.h"
33 #include <memory>
34 #include <wtf/Forward.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/Vector.h>
37
38 namespace WebCore {
39
40 class Element;
41
42 class CollectionNamedElementCache {
43 public:
44 #ifndef ASSERT_DISABLED
45     CollectionNamedElementCache : m_didPopulateCalled(false) { }
46 #endif
47
48     const Vector<Element*>* findElementsWithId(const AtomicString& id) const { return find(m_idToElementsMap, id); }
49     const Vector<Element*>* findElementsWithName(const AtomicString& name) const { return find(m_nameToElementsMap, name); }
50
51     void appendIdCache(const AtomicString& id, Element* element) { return append(m_idToElementsMap, id, element); }
52     void appendNameCache(const AtomicString& name, Element* element)  { return append(m_nameToElementsMap, name, element); }
53
54     void didPopulate()
55     {
56 #ifndef ASSERT_DISABLED
57         m_didPopulateCalled = true;
58 #endif
59         if (size_t cost = memoryCost())
60             reportExtraMemoryCostForCollectionIndexCache(cost);
61     }
62     size_t memoryCost() const { return (m_idToElementsMap.size() + m_nameToElementsMap.size()) * sizeof(Element*); }
63
64 private:
65     typedef HashMap<AtomicStringImpl*, Vector<Element*>> StringToElementsMap;
66
67     const Vector<Element*>* find(const StringToElementsMap& map, const AtomicString& key) const
68     {
69 #ifndef ASSERT_DISABLED
70         ASSERT(m_didPopulateCalled);
71 #endif
72         auto it = map.find(key.impl());
73         return it != map.end() ? &it->value : nullptr;
74     }
75
76     static void append(StringToElementsMap& map, const AtomicString& key, Element* element)
77     {
78         map.add(key.impl(), Vector<Element*>()).iterator->value.append(element);
79     }
80
81     StringToElementsMap m_idToElementsMap;
82     StringToElementsMap m_nameToElementsMap;
83 #ifndef ASSERT_DISABLED
84     bool m_didPopulateCalled;
85 #endif
86 };
87
88 class HTMLCollection : public ScriptWrappable, public RefCounted<HTMLCollection> {
89 public:
90     static PassRef<HTMLCollection> create(ContainerNode& base, CollectionType);
91     virtual ~HTMLCollection();
92
93     // DOM API
94     unsigned length() const;
95     Node* item(unsigned offset) const;
96     virtual Node* namedItem(const AtomicString& name) const;
97     PassRefPtr<NodeList> tags(const String&);
98
99     // Non-DOM API
100     bool hasNamedItem(const AtomicString& name) const;
101     void namedItems(const AtomicString& name, Vector<Ref<Element>>&) const;
102     size_t memoryCost() const { return m_indexCache.memoryCost() + (m_namedElementCache ? m_namedElementCache->memoryCost() : 0); }
103
104     enum RootType {
105         IsRootedAtNode,
106         IsRootedAtDocument
107     };
108     bool isRootedAtDocument() const { return m_rootType == IsRootedAtDocument; }
109     NodeListInvalidationType invalidationType() const { return static_cast<NodeListInvalidationType>(m_invalidationType); }
110     CollectionType type() const { return static_cast<CollectionType>(m_collectionType); }
111     ContainerNode& ownerNode() const { return const_cast<ContainerNode&>(m_ownerNode.get()); }
112     void invalidateCache(const QualifiedName* attrName) const
113     {
114         if (!attrName || shouldInvalidateTypeOnAttributeChange(invalidationType(), *attrName))
115             invalidateCache(document());
116         else if (hasNamedElementCache() && (*attrName == HTMLNames::idAttr || *attrName == HTMLNames::nameAttr))
117             invalidateNamedElementCache(document());
118     }
119     virtual void invalidateCache(Document&) const;
120
121     // For CollectionIndexCache
122     Element* collectionBegin() const;
123     Element* collectionLast() const;
124     Element* collectionEnd() const { return nullptr; }
125     void collectionTraverseForward(Element*&, unsigned count, unsigned& traversedCount) const;
126     void collectionTraverseBackward(Element*&, unsigned count) const;
127     bool collectionCanTraverseBackward() const { return !m_usesCustomForwardOnlyTraversal; }
128     void willValidateIndexCache() const { document().registerCollection(const_cast<HTMLCollection&>(*this)); }
129
130     bool hasNamedElementCache() const { return !!m_namedElementCache; }
131
132 protected:
133     enum ElementTraversalType { NormalTraversal, CustomForwardOnlyTraversal };
134     HTMLCollection(ContainerNode& base, CollectionType, ElementTraversalType = NormalTraversal);
135
136     virtual void updateNamedElementCache() const;
137
138     Document& document() const { return m_ownerNode->document(); }
139     ContainerNode& rootNode() const;
140     bool usesCustomForwardOnlyTraversal() const { return m_usesCustomForwardOnlyTraversal; }
141
142     RootType rootType() const { return static_cast<RootType>(m_rootType); }
143
144     void setNameItemCache(std::unique_ptr<CollectionNamedElementCache> cache) const
145     {
146         ASSERT(!m_namedElementCache);
147         m_namedElementCache = WTF::move(cache);
148         document().collectionCachedIdNameMap(*this);
149     }
150
151     const CollectionNamedElementCache& namedItemCaches() const
152     {
153         ASSERT(!!m_namedElementCache);
154         return *m_namedElementCache;
155     }
156
157 private:
158     Element* iterateForPreviousElement(Element* current) const;
159     Element* firstElement(ContainerNode& root) const;
160     Element* traverseForward(Element& current, unsigned count, unsigned& traversedCount, ContainerNode& root) const;
161
162     virtual Element* customElementAfter(Element*) const { ASSERT_NOT_REACHED(); return nullptr; }
163     
164     void invalidateNamedElementCache(Document&) const;
165
166     Ref<ContainerNode> m_ownerNode;
167
168     mutable CollectionIndexCache<HTMLCollection, Element*> m_indexCache;
169     mutable std::unique_ptr<CollectionNamedElementCache> m_namedElementCache;
170
171     const unsigned m_collectionType : 5;
172     const unsigned m_invalidationType : 4;
173     const unsigned m_rootType : 1;
174     const unsigned m_shouldOnlyIncludeDirectChildren : 1;
175     const unsigned m_usesCustomForwardOnlyTraversal : 1;
176 };
177
178 } // namespace
179
180 #endif