Implementors of memoryCost() need to be thread-safe.
[WebKit-https.git] / Source / WebCore / dom / ChildNodeList.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-2017 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 #pragma once
25
26 #include "CollectionIndexCache.h"
27 #include "NodeList.h"
28 #include <wtf/Ref.h>
29
30 namespace WebCore {
31
32 class ContainerNode;
33
34 class EmptyNodeList final : public NodeList {
35 public:
36     static Ref<EmptyNodeList> create(Node& owner)
37     {
38         return adoptRef(*new EmptyNodeList(owner));
39     }
40     virtual ~EmptyNodeList();
41
42     Node& ownerNode() { return m_owner; }
43
44 private:
45     explicit EmptyNodeList(Node& owner) : m_owner(owner) { }
46
47     unsigned length() const override { return 0; }
48     Node* item(unsigned) const override { return nullptr; }
49     size_t memoryCost() const override { return 0; }
50
51     bool isEmptyNodeList() const override { return true; }
52
53     Ref<Node> m_owner;
54 };
55
56 class ChildNodeList final : public NodeList {
57 public:
58     static Ref<ChildNodeList> create(ContainerNode& parent)
59     {
60         return adoptRef(*new ChildNodeList(parent));
61     }
62
63     virtual ~ChildNodeList();
64
65     ContainerNode& ownerNode() { return m_parent; }
66
67     void invalidateCache();
68
69     // For CollectionIndexCache
70     Node* collectionBegin() const;
71     Node* collectionLast() const;
72     Node* collectionEnd() const { return nullptr; }
73     void collectionTraverseForward(Node*&, unsigned count, unsigned& traversedCount) const;
74     void collectionTraverseBackward(Node*&, unsigned count) const;
75     bool collectionCanTraverseBackward() const { return true; }
76     void willValidateIndexCache() const { }
77
78 private:
79     explicit ChildNodeList(ContainerNode& parent);
80
81     unsigned length() const override;
82     Node* item(unsigned index) const override;
83     size_t memoryCost() const override
84     {
85         // memoryCost() may be invoked concurrently from a GC thread, and we need to be careful
86         // about what data we access here and how. Accessing m_indexCache is safe because
87         // because it doesn't involve any pointer chasing.
88         return m_indexCache.memoryCost();
89     }
90
91     bool isChildNodeList() const override { return true; }
92
93     Ref<ContainerNode> m_parent;
94     mutable CollectionIndexCache<ChildNodeList, Node*> m_indexCache;
95 };
96
97 } // namespace WebCore