2011-04-07 Geoffrey Garen <ggaren@apple.com>
[WebKit-https.git] / Source / JavaScriptCore / collector / handles / Handle.h
1 /*
2  * Copyright (C) 2011 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 Handle_h
27 #define Handle_h
28
29 #include "WriteBarrier.h"
30
31 #include <wtf/Assertions.h>
32
33 namespace JSC {
34
35 /*
36     A Handle is a smart pointer that updates automatically when the garbage
37     collector moves the object to which it points.
38
39     The base Handle class represents a temporary reference to a pointer whose
40     lifetime is guaranteed by something else.
41 */
42
43 template <class T> class Handle;
44
45 // Creating a JSValue Handle is invalid
46 template <> class Handle<JSValue>;
47
48 class HandleBase {
49     friend class HandleHeap;
50
51 public:
52     bool operator!() const { return !m_slot || !*m_slot; }
53
54     // This conversion operator allows implicit conversion to bool but not to other integer types.
55     typedef JSValue (HandleBase::*UnspecifiedBoolType);
56     operator UnspecifiedBoolType*() const { return (m_slot && *m_slot) ? reinterpret_cast<UnspecifiedBoolType*>(1) : 0; }
57
58 protected:
59     HandleBase(HandleSlot slot)
60         : m_slot(slot)
61     {
62     }
63
64     HandleSlot slot() const { return m_slot; }
65     void setSlot(HandleSlot slot)
66     {
67         m_slot = slot;
68     }
69
70 private:
71     HandleSlot m_slot;
72 };
73
74 template <typename T> struct HandleTypes {
75     typedef T* ExternalType;
76     static ExternalType getFromSlot(HandleSlot slot) { return (slot && *slot) ? reinterpret_cast<ExternalType>(slot->asCell()) : 0; }
77     static JSValue toJSValue(T* cell) { return reinterpret_cast<JSCell*>(cell); }
78     template <typename U> static void validateUpcast() { T* temp; temp = (U*)0; }
79 };
80
81 template <> struct HandleTypes<Unknown> {
82     typedef JSValue ExternalType;
83     static ExternalType getFromSlot(HandleSlot slot) { return slot ? *slot : JSValue(); }
84     static JSValue toJSValue(const JSValue& v) { return v; }
85     template <typename U> static void validateUpcast() {}
86 };
87
88 template <typename Base, typename T> struct HandleConverter {
89     T* operator->()
90     {
91 #if ENABLE(JSC_ZOMBIES)
92         ASSERT(!static_cast<const Base*>(this)->get() || !static_cast<const Base*>(this)->get()->isZombie());
93 #endif
94         return static_cast<Base*>(this)->get();
95     }
96     const T* operator->() const
97     {
98 #if ENABLE(JSC_ZOMBIES)
99         ASSERT(!static_cast<const Base*>(this)->get() || !static_cast<const Base*>(this)->get()->isZombie());
100 #endif
101         return static_cast<const Base*>(this)->get();
102     }
103
104     T* operator*()
105     {
106 #if ENABLE(JSC_ZOMBIES)
107         ASSERT(!static_cast<const Base*>(this)->get() || !static_cast<const Base*>(this)->get()->isZombie());
108 #endif
109         return static_cast<Base*>(this)->get();
110     }
111     const T* operator*() const
112     {
113 #if ENABLE(JSC_ZOMBIES)
114         ASSERT(!static_cast<const Base*>(this)->get() || !static_cast<const Base*>(this)->get()->isZombie());
115 #endif
116         return static_cast<const Base*>(this)->get();
117     }
118 };
119
120 template <typename Base> struct HandleConverter<Base, Unknown> {
121     Handle<JSObject> asObject() const;
122     bool isObject() const { return jsValue().isObject(); }
123     bool getNumber(double number) const { return jsValue().getNumber(number); }
124     UString getString(ExecState*) const;
125     bool isUndefinedOrNull() const { return jsValue().isUndefinedOrNull(); }
126
127 private:
128     JSValue jsValue() const
129     {
130 #if ENABLE(JSC_ZOMBIES)
131         ASSERT(!static_cast<const Base*>(this)->get() || !static_cast<const Base*>(this)->get().isZombie());
132 #endif
133         return static_cast<const Base*>(this)->get();
134     }
135 };
136
137 template <typename T> class Handle : public HandleBase, public HandleConverter<Handle<T>, T> {
138 public:
139     template <typename A, typename B> friend class HandleConverter;
140     typedef typename HandleTypes<T>::ExternalType ExternalType;
141     template <typename U> Handle(Handle<U> o)
142     {
143         typename HandleTypes<T>::template validateUpcast<U>();
144         m_slot = o.slot();
145     }
146
147     ExternalType get() const { return HandleTypes<T>::getFromSlot(this->slot()); }
148
149 protected:
150     Handle(HandleSlot slot = 0)
151         : HandleBase(slot)
152     {
153     }
154     
155 private:
156     friend class HandleHeap;
157
158     static Handle<T> wrapSlot(HandleSlot slot)
159     {
160         return Handle<T>(slot);
161     }
162 };
163
164 template <typename Base> Handle<JSObject> HandleConverter<Base, Unknown>::asObject() const
165 {
166     return Handle<JSObject>::wrapSlot(static_cast<const Base*>(this)->slot());
167 }
168
169 template <typename T, typename U> inline bool operator==(const Handle<T>& a, const Handle<U>& b)
170
171     return a.get() == b.get(); 
172 }
173
174 template <typename T, typename U> inline bool operator==(const Handle<T>& a, U* b)
175
176     return a.get() == b; 
177 }
178
179 template <typename T, typename U> inline bool operator==(T* a, const Handle<U>& b) 
180 {
181     return a == b.get(); 
182 }
183
184 template <typename T, typename U> inline bool operator!=(const Handle<T>& a, const Handle<U>& b)
185
186     return a.get() != b.get(); 
187 }
188
189 template <typename T, typename U> inline bool operator!=(const Handle<T>& a, U* b)
190 {
191     return a.get() != b; 
192 }
193
194 template <typename T, typename U> inline bool operator!=(T* a, const Handle<U>& b)
195
196     return a != b.get(); 
197 }
198
199 template <typename T, typename U> inline bool operator!=(const Handle<T>& a, JSValue b)
200 {
201     return a.get() != b; 
202 }
203
204 template <typename T, typename U> inline bool operator!=(JSValue a, const Handle<U>& b)
205
206     return a != b.get(); 
207 }
208
209 }
210
211 #endif