HTMLCollection.h revision cad810f21b803229eb11403f9209855525a25d57 
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
32namespace WebCore {
33
34class Element;
35class Node;
36class NodeList;
37
38struct CollectionCache;
39
40class HTMLCollection : public RefCounted<HTMLCollection> {
41public:
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    virtual Node* nextNamedItem(const AtomicString& name) const; // In case of multiple items named the same way
52
53    Node* firstItem() const;
54
55    void namedItems(const AtomicString& name, Vector<RefPtr<Node> >&) const;
56
57    PassRefPtr<NodeList> tags(const String&);
58
59    Node* base() const { return m_base.get(); }
60    CollectionType type() const { return m_type; }
61
62protected:
63    HTMLCollection(PassRefPtr<Node> base, CollectionType, CollectionCache*);
64    HTMLCollection(PassRefPtr<Node> base, CollectionType);
65
66    CollectionCache* info() const { return m_info; }
67    void resetCollectionInfo() const;
68
69    mutable bool m_idsDone; // for nextNamedItem()
70
71private:
72    virtual Element* itemAfter(Element*) const;
73    virtual unsigned calcLength() const;
74    virtual void updateNameCache() const;
75
76    bool checkForNameMatch(Element*, bool checkName, const AtomicString& name) const;
77
78    RefPtr<Node> m_base;
79    CollectionType m_type;
80
81    mutable CollectionCache* m_info;
82    mutable bool m_ownsInfo;
83};
84
85} // namespace
86
87#endif
88