Reviewed by Maciej.
[WebKit-https.git] / WebCore / dom / NodeList.h
1 /*
2  * This file is part of the DOM implementation for KDE.
3  *
4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
6  *           (C) 2001 Dirk Mueller (mueller@kde.org)
7  * Copyright (C) 2004, 2006 Apple Computer, Inc.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
22  * Boston, MA 02110-1301, USA.
23  *
24  */
25
26 #ifndef NodeList_h
27 #define NodeList_h
28
29 #include <wtf/RefCounted.h>
30 #include <wtf/Forward.h>
31 #include <wtf/RefPtr.h>
32
33 namespace WebCore {
34
35 class AtomicString;
36 class Node;
37
38 class NodeList : public RefCounted<NodeList> {
39 public:
40
41     struct Caches {
42         Caches();
43         void reset();
44         
45         unsigned cachedLength;
46         Node* lastItem;
47         unsigned lastItemOffset;
48         bool isLengthCacheValid : 1;
49         bool isItemCacheValid : 1;
50     };
51
52     NodeList(PassRefPtr<Node> rootNode);
53     NodeList(PassRefPtr<Node> rootNode, Caches*);
54     virtual ~NodeList();
55
56     bool needsNotifications() const { return m_ownsCaches; }
57
58     // DOM methods & attributes for NodeList
59     virtual unsigned length() const = 0;
60     virtual Node* item(unsigned index) const = 0;
61     Node* itemWithName(const AtomicString&) const;
62
63     // Other methods (not part of DOM)
64     virtual void rootNodeChildrenChanged();
65     virtual void rootNodeAttributeChanged() {}
66
67 protected:
68     // helper functions for searching all ElementImpls in a tree
69     unsigned recursiveLength(Node* start = 0) const;
70     Node* recursiveItem (unsigned offset, Node* start = 0) const;
71     virtual bool nodeMatches(Node* testNode) const = 0;
72
73     RefPtr<Node> m_rootNode;
74     mutable Caches* m_caches;
75     bool m_ownsCaches;
76
77  private:
78     Node* itemForwardsFromCurrent(Node* start, unsigned offset, int remainingOffset) const;
79     Node* itemBackwardsFromCurrent(Node* start, unsigned offset, int remainingOffset) const;
80 };
81
82 } //namespace
83
84 #endif