[JSC] Weak should only accept cell pointees.
[WebKit-https.git] / Source / JavaScriptCore / heap / WeakInlines.h
1 /*
2  * Copyright (C) 2009, 2012, 2013 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 #ifndef WeakInlines_h
27 #define WeakInlines_h
28
29 #include "JSCell.h"
30 #include "WeakSetInlines.h"
31 #include <wtf/Assertions.h>
32 #include <wtf/HashTraits.h>
33
34 namespace JSC {
35
36 template<typename T> inline Weak<T>::Weak(T* cell, WeakHandleOwner* weakOwner, void* context)
37     : m_impl(cell ? WeakSet::allocate(*cell, weakOwner, context) : 0)
38 {
39     static_assert((std::is_convertible<T, JSCell>::value), "JSC::Weak can only be used with cell types.");
40 }
41
42 template<typename T> inline bool Weak<T>::isHashTableDeletedValue() const
43 {
44     return m_impl == hashTableDeletedValue();
45 }
46
47 template<typename T> inline Weak<T>::Weak(typename Weak<T>::HashTableDeletedValueTag)
48     : m_impl(hashTableDeletedValue())
49 {
50 }
51
52 template<typename T> inline Weak<T>::Weak(Weak&& other)
53     : m_impl(other.leakImpl())
54 {
55 }
56
57 template<class T> inline void swap(Weak<T>& a, Weak<T>& b)
58 {
59     a.swap(b);
60 }
61
62 template<typename T> inline void Weak<T>::swap(Weak& other)
63 {
64     std::swap(m_impl, other.m_impl);
65 }
66
67 template<typename T> inline auto Weak<T>::operator=(Weak&& other) -> Weak&
68 {
69     Weak weak = WTF::move(other);
70     swap(weak);
71     return *this;
72 }
73
74 template<typename T> inline T* Weak<T>::operator->() const
75 {
76     ASSERT(m_impl && m_impl->state() == WeakImpl::Live);
77     return jsCast<T*>(m_impl->cell());
78 }
79
80 template<typename T> inline T& Weak<T>::operator*() const
81 {
82     ASSERT(m_impl && m_impl->state() == WeakImpl::Live);
83     return *jsCast<T*>(m_impl->cell());
84 }
85
86 template<typename T> inline T* Weak<T>::get() const
87 {
88     if (!m_impl || m_impl->state() != WeakImpl::Live)
89         return 0;
90     return jsCast<T*>(m_impl->cell());
91 }
92
93 template<typename T> inline bool Weak<T>::was(T* other) const
94 {
95     return static_cast<T*>(m_impl->cell()) == other;
96 }
97
98 template<typename T> inline bool Weak<T>::operator!() const
99 {
100     return !m_impl || !m_impl->cell() || m_impl->state() != WeakImpl::Live;
101 }
102
103 template<typename T> inline Weak<T>::operator bool() const
104 {
105     return !!*this;
106 }
107
108 template<typename T> inline WeakImpl* Weak<T>::leakImpl()
109 {
110     WeakImpl* impl = m_impl;
111     m_impl = nullptr;
112     return impl;
113 }
114
115 template<typename T> inline WeakImpl* Weak<T>::hashTableDeletedValue()
116 {
117     return reinterpret_cast<WeakImpl*>(-1);
118 }
119
120 template <typename T> inline bool operator==(const Weak<T>& lhs, const Weak<T>& rhs)
121 {
122     return lhs.get() == rhs.get();
123 }
124
125 // This function helps avoid modifying a weak table while holding an iterator into it. (Object allocation
126 // can run a finalizer that modifies the table. We avoid that by requiring a pre-constructed object as our value.)
127 template<typename Map, typename Key, typename Value> inline void weakAdd(Map& map, const Key& key, Value&& value)
128 {
129     ASSERT(!map.get(key));
130     map.set(key, std::forward<Value>(value)); // The table may still have a zombie for value.
131 }
132
133 template<typename Map, typename Key, typename Value> inline void weakRemove(Map& map, const Key& key, Value value)
134 {
135     typename Map::iterator it = map.find(key);
136     ASSERT_UNUSED(value, value);
137     ASSERT(it != map.end());
138     ASSERT(it->value.was(value));
139     ASSERT(!it->value);
140     map.remove(it);
141 }
142
143 template<typename T> inline void weakClear(Weak<T>& weak, T* cell)
144 {
145     ASSERT_UNUSED(cell, cell);
146     ASSERT(weak.was(cell));
147     ASSERT(!weak);
148     weak.clear();
149 }
150
151 } // namespace JSC
152
153 namespace WTF {
154
155 template<typename T> struct VectorTraits<JSC::Weak<T>> : SimpleClassVectorTraits {
156     static const bool canCompareWithMemcmp = false;
157 };
158
159 template<typename T> struct HashTraits<JSC::Weak<T>> : SimpleClassHashTraits<JSC::Weak<T>> {
160     typedef JSC::Weak<T> StorageType;
161
162     typedef std::nullptr_t EmptyValueType;
163     static EmptyValueType emptyValue() { return nullptr; }
164
165     typedef T* PeekType;
166     static PeekType peek(const StorageType& value) { return value.get(); }
167     static PeekType peek(EmptyValueType) { return PeekType(); }
168 };
169
170 } // namespace WTF
171
172 #endif // WeakInlines_h