Make HTMLCollections play nice after their base node is gone.
[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 "CollectionType.h"
27 #include <wtf/RefCounted.h>
28 #include <wtf/Forward.h>
29 #include <wtf/HashMap.h>
30 #include <wtf/Vector.h>
31
32 namespace WebCore {
33
34 class Document;
35 class Element;
36 class Node;
37 class NodeList;
38
39 struct CollectionCache;
40
41 class HTMLCollection : public RefCounted<HTMLCollection> {
42 public:
43     static PassRefPtr<HTMLCollection> create(PassRefPtr<Node> base, CollectionType);
44     static PassRefPtr<HTMLCollection> createForCachingOnDocument(Document*, CollectionType);
45     virtual ~HTMLCollection();
46     
47     unsigned length() const;
48     
49     virtual Node* item(unsigned index) const;
50     virtual Node* nextItem() const;
51
52     virtual Node* namedItem(const AtomicString& name) const;
53
54     Node* firstItem() const;
55
56     bool hasNamedItem(const AtomicString& name) const;
57     void namedItems(const AtomicString& name, Vector<RefPtr<Node> >&) const;
58
59     PassRefPtr<NodeList> tags(const String&);
60
61     Node* base() const { return m_base; }
62     CollectionType type() const { return static_cast<CollectionType>(m_type); }
63
64     void detachFromNode();
65
66 protected:
67     HTMLCollection(Node* base, CollectionType, bool retainBaseNode = true);
68     HTMLCollection(Document*, CollectionType);
69
70     CollectionCache* info() const { return m_info; }
71     void resetCollectionInfo() const;
72
73     virtual void updateNameCache() const;
74     virtual Element* itemAfter(Element*) const;
75
76 private:
77     static bool shouldIncludeChildren(CollectionType);
78     bool checkForNameMatch(Element*, bool checkName, const AtomicString& name) const;
79
80     virtual unsigned calcLength() const;
81
82     bool isAcceptableElement(Element*) const;
83
84     bool m_baseIsRetained : 1;
85     bool m_includeChildren : 1;
86     mutable bool m_ownsInfo : 1;
87     unsigned m_type : 5; // CollectionType
88
89     Node* m_base;
90
91     mutable CollectionCache* m_info;
92 };
93
94 } // namespace
95
96 #endif