fd91366df067aa3a3f6847528736b350959ddb53
[WebKit-https.git] / Source / WebCore / dom / DynamicNodeList.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  *           (C) 2001 Dirk Mueller (mueller@kde.org)
5  * Copyright (C) 2004, 2006, 2007 Apple Inc. All rights reserved.
6  *
7  * This library is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU Library General Public
9  * License as published by the Free Software Foundation; either
10  * version 2 of the License, or (at your option) any later version.
11  *
12  * This library is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
15  * Library General Public License for more details.
16  *
17  * You should have received a copy of the GNU Library General Public License
18  * along with this library; see the file COPYING.LIB.  If not, write to
19  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20  * Boston, MA 02110-1301, USA.
21  *
22  */
23
24 #ifndef DynamicNodeList_h
25 #define DynamicNodeList_h
26
27 #include "Document.h"
28 #include "NodeList.h"
29 #include <wtf/Forward.h>
30 #include <wtf/RefPtr.h>
31
32 namespace WebCore {
33
34 class Element;
35 class Node;
36
37 class DynamicNodeList : public NodeList {
38 public:
39     enum RootType {
40         RootedAtNode,
41         RootedAtDocument,
42     };
43
44     DynamicNodeList(PassRefPtr<Node> node, RootType rootType = RootedAtNode)
45         : m_node(node)
46         , m_caches(rootType)
47     { }
48     virtual ~DynamicNodeList() { }
49
50     // DOM methods & attributes for NodeList
51     virtual unsigned length() const = 0;
52     virtual Node* item(unsigned index) const = 0;
53     virtual Node* itemWithName(const AtomicString&) const;
54
55     // Other methods (not part of DOM)
56     Node* node() const
57     {
58         if (m_caches.rootedAtDocument && m_node->inDocument())
59             return m_node->document();
60         return m_node.get();
61     }
62
63     void invalidateCache() { m_caches.reset(); }
64
65 protected:
66     virtual bool nodeMatches(Element*) const = 0;
67
68     struct Caches {
69         Caches(RootType rootType)
70             : rootedAtDocument(rootType == RootedAtDocument)
71         {
72             reset();
73         }
74
75         void reset()
76         {
77             lastItem = 0;
78             isLengthCacheValid = false;
79             isItemCacheValid = false;
80         }
81
82         Node* lastItem;
83         unsigned cachedLength;
84         unsigned lastItemOffset : 29; // Borrow 3-bits for bit fields
85         unsigned isLengthCacheValid : 1;
86         unsigned isItemCacheValid : 1;
87         unsigned rootedAtDocument : 1;
88     };
89
90     RefPtr<Node> m_node;
91     mutable Caches m_caches;
92
93 private:
94     virtual bool isDynamicNodeList() const OVERRIDE { return true; }
95 };
96
97 class DynamicSubtreeNodeList : public DynamicNodeList {
98 public:
99     virtual ~DynamicSubtreeNodeList();
100     virtual unsigned length() const OVERRIDE;
101     virtual Node* item(unsigned index) const OVERRIDE;
102
103 protected:
104     DynamicSubtreeNodeList(PassRefPtr<Node>, RootType = RootedAtNode);
105
106 private:
107     Node* itemForwardsFromCurrent(Node* start, unsigned offset, int remainingOffset) const;
108     Node* itemBackwardsFromCurrent(Node* start, unsigned offset, int remainingOffset) const;
109 };
110
111 } // namespace WebCore
112
113 #endif // DynamicNodeList_h