Only HTMLAllCollection needs stateful named item traversal.
[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 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 Element;
35 class Node;
36 class NodeList;
37
38 struct CollectionCache;
39
40 class HTMLCollection : public RefCounted<HTMLCollection> {
41 public:
42     static PassRefPtr<HTMLCollection> create(PassRefPtr<Node> base, CollectionType);
43     virtual ~HTMLCollection();
44     
45     unsigned length() const;
46     
47     virtual Node* item(unsigned index) const;
48     virtual Node* nextItem() const;
49
50     virtual Node* namedItem(const AtomicString& name) const;
51
52     Node* firstItem() const;
53
54     void namedItems(const AtomicString& name, Vector<RefPtr<Node> >&) const;
55
56     PassRefPtr<NodeList> tags(const String&);
57
58     Node* base() const { return m_base.get(); }
59     CollectionType type() const { return static_cast<CollectionType>(m_type); }
60
61 protected:
62     HTMLCollection(PassRefPtr<Node> base, CollectionType, CollectionCache*);
63     HTMLCollection(PassRefPtr<Node> base, CollectionType);
64
65     CollectionCache* info() const { return m_info; }
66     void resetCollectionInfo() const;
67
68     virtual Element* itemAfter(Element*) const;
69     bool checkForNameMatch(Element*, bool checkName, const AtomicString& name) const;
70
71 private:
72     virtual unsigned calcLength() const;
73     virtual void updateNameCache() const;
74
75     mutable bool m_ownsInfo : 1;
76     unsigned m_type : 5; // CollectionType
77
78     RefPtr<Node> m_base;
79
80     mutable CollectionCache* m_info;
81 };
82
83 } // namespace
84
85 #endif