c5267d19d5f37a7d55ad4330b6b49c9292faa229
[WebKit-https.git] / Source / WebCore / dom / GCReachableRef.h
1 /*
2  * Copyright (C) 2013-2018 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include <wtf/DumbPtrTraits.h>
29 #include <wtf/HashCountedSet.h>
30 #include <wtf/Ref.h>
31
32 namespace WebCore {
33
34 class Node;
35
36 class GCReachableRefMap {
37 public:
38     static inline bool contains(Node& node) { return map().contains(&node); }
39     static inline void add(Node& node) { map().add(&node); }
40     static inline void remove(Node& node) { map().remove(&node); }
41
42 private:
43     static HashCountedSet<Node*>& map();
44 };
45
46 template <typename T, typename = std::enable_if_t<std::is_same<T, typename std::remove_const<T>::type>::value>>
47 class GCReachableRef {
48     WTF_MAKE_NONCOPYABLE(GCReachableRef);
49 public:
50
51     template<typename = std::enable_if_t<std::is_base_of<Node, T>::value>>
52     GCReachableRef(T& object)
53         : m_ptr(&object)
54     {
55         GCReachableRefMap::add(*m_ptr);
56     }
57
58     ~GCReachableRef()
59     {
60         if (m_ptr)
61             GCReachableRefMap::remove(*m_ptr);
62     }
63
64     GCReachableRef(GCReachableRef&& other)
65         : m_ptr(WTFMove(other.m_ptr))
66     {
67     }
68
69     T* operator->() const { return &get(); }
70     T* ptr() const RETURNS_NONNULL { return &get(); }
71     T& get() const { ASSERT(m_ptr); return *m_ptr; }
72     operator T&() const { ASSERT(m_ptr); return *m_ptr; }
73     bool operator!() const { return !get(); }
74
75 private:
76
77     RefPtr<T> m_ptr;
78 };
79
80 }