Extract named items caches in HTMLCollection as a class
[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 <wtf/Forward.h>
34 #include <wtf/HashMap.h>
35 #include <wtf/Vector.h>
36
37 namespace WebCore {
38
39 class Element;
40
41 class CollectionNamedElementCache {
42 public:
43     const Vector<Element*>* findElementsWithId(const AtomicString& id) const { return find(m_idToElementsMap, id); }
44     const Vector<Element*>* findElementsWithName(const AtomicString& name) const { return find(m_nameToElementsMap, name); }
45
46     void appendIdCache(const AtomicString& id, Element* element) { return append(m_idToElementsMap, id, element); }
47     void appendNameCache(const AtomicString& name, Element* element)  { return append(m_nameToElementsMap, name, element); }
48
49 private:
50     typedef HashMap<AtomicStringImpl*, Vector<Element*>> StringToElementsMap;
51
52     static const Vector<Element*>* find(const StringToElementsMap& map, const AtomicString& key)
53     {
54         auto it = map.find(key.impl());
55         return it != map.end() ? &it->value : nullptr;
56     }
57
58     static void append(StringToElementsMap& map, const AtomicString& key, Element* element)
59     {
60         map.add(key.impl(), Vector<Element*>()).iterator->value.append(element);
61     }
62
63     StringToElementsMap m_idToElementsMap;
64     StringToElementsMap m_nameToElementsMap;
65 };
66
67 class HTMLCollection : public ScriptWrappable, public RefCounted<HTMLCollection> {
68 public:
69     static PassRefPtr<HTMLCollection> create(ContainerNode& base, CollectionType);
70     virtual ~HTMLCollection();
71
72     // DOM API
73     unsigned length() const;
74     Node* item(unsigned offset) const;
75     virtual Node* namedItem(const AtomicString& name) const;
76     PassRefPtr<NodeList> tags(const String&);
77
78     // Non-DOM API
79     bool hasNamedItem(const AtomicString& name) const;
80     void namedItems(const AtomicString& name, Vector<Ref<Element>>&) const;
81
82     bool isRootedAtDocument() const { return m_rootType == NodeListIsRootedAtDocument; }
83     NodeListInvalidationType invalidationType() const { return static_cast<NodeListInvalidationType>(m_invalidationType); }
84     CollectionType type() const { return static_cast<CollectionType>(m_collectionType); }
85     ContainerNode& ownerNode() const { return const_cast<ContainerNode&>(m_ownerNode.get()); }
86     void invalidateCache(const QualifiedName* attrName) const
87     {
88         if (!attrName || shouldInvalidateTypeOnAttributeChange(invalidationType(), *attrName))
89             invalidateCache();
90         else if (hasNamedElementCache() && (*attrName == HTMLNames::idAttr || *attrName == HTMLNames::nameAttr))
91             invalidateNamedElementCache();
92     }
93     virtual void invalidateCache() const;
94
95     // For CollectionIndexCache
96     Element* collectionFirst() const;
97     Element* collectionLast() const;
98     Element* collectionTraverseForward(Element&, unsigned count, unsigned& traversedCount) const;
99     Element* collectionTraverseBackward(Element&, unsigned count) const;
100     bool collectionCanTraverseBackward() const { return !m_usesCustomForwardOnlyTraversal; }
101
102     bool hasNamedElementCache() const { return !!m_namedElementCache; }
103
104 protected:
105     enum ElementTraversalType { NormalTraversal, CustomForwardOnlyTraversal };
106     HTMLCollection(ContainerNode& base, CollectionType, ElementTraversalType = NormalTraversal);
107
108     virtual void updateNamedElementCache() const;
109
110     Document& document() const { return m_ownerNode->document(); }
111     ContainerNode& rootNode() const;
112     bool usesCustomForwardOnlyTraversal() const { return m_usesCustomForwardOnlyTraversal; }
113
114     NodeListRootType rootType() const { return static_cast<NodeListRootType>(m_rootType); }
115
116     CollectionNamedElementCache& createNameItemCache() const
117     {
118         ASSERT(!m_namedElementCache);
119         m_namedElementCache = std::make_unique<CollectionNamedElementCache>();
120         document().collectionCachedIdNameMap(*this);
121         return *m_namedElementCache;
122     }
123
124     const CollectionNamedElementCache& namedItemCaches() const
125     {
126         ASSERT(!!m_namedElementCache);
127         return *m_namedElementCache;
128     }
129
130 private:
131     Element* iterateForPreviousElement(Element* current) const;
132     Element* firstElement(ContainerNode& root) const;
133     Element* traverseForward(Element& current, unsigned count, unsigned& traversedCount, ContainerNode& root) const;
134
135     virtual Element* customElementAfter(Element*) const { ASSERT_NOT_REACHED(); return nullptr; }
136     
137     void invalidateNamedElementCache() const;
138
139     Ref<ContainerNode> m_ownerNode;
140
141     mutable CollectionIndexCache<HTMLCollection, Element> m_indexCache;
142     mutable std::unique_ptr<CollectionNamedElementCache> m_namedElementCache;
143
144     const unsigned m_collectionType : 5;
145     const unsigned m_invalidationType : 4;
146     const unsigned m_rootType : 1;
147     const unsigned m_shouldOnlyIncludeDirectChildren : 1;
148     const unsigned m_usesCustomForwardOnlyTraversal : 1;
149 };
150
151 } // namespace
152
153 #endif