Allow implicit conversion from Ref<T> to T&
[WebKit-https.git] / Source / WTF / wtf / Ref.h
1 /*
2  * Copyright (C) 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 WTF_Ref_h
27 #define WTF_Ref_h
28
29 #include <wtf/GetPtr.h>
30 #include <wtf/Noncopyable.h>
31
32 namespace WTF {
33
34 template<typename T> class PassRef;
35
36 template<typename T> class Ref {
37     WTF_MAKE_NONCOPYABLE(Ref)
38 public:
39     Ref(T& object) : m_ptr(&object) { m_ptr->ref(); }
40     template<typename U> Ref(PassRef<U> reference) : m_ptr(&reference.leakRef()) { }
41
42     ~Ref() { m_ptr->deref(); }
43
44     Ref& operator=(T& object)
45     {
46         object.ref();
47         m_ptr->deref();
48         m_ptr = &object;
49         return *this;
50     }
51     template<typename U> Ref& operator=(PassRef<U> reference)
52     {
53         m_ptr->deref();
54         m_ptr = &reference.leakRef();
55         return *this;
56     }
57
58     const T* operator->() const { return m_ptr; }
59     T* operator->() { return m_ptr; }
60
61     const T& get() const { return *m_ptr; }
62     T& get() { return *m_ptr; }
63
64     operator T&() { return *m_ptr; }
65     operator const T&() const { return *m_ptr; }
66
67     template<typename U> PassRef<T> replace(PassRef<U>) WARN_UNUSED_RETURN;
68
69 private:
70     T* m_ptr;
71 };
72
73 template<typename T> template<typename U> inline PassRef<T> Ref<T>::replace(PassRef<U> reference)
74 {
75     auto oldReference = adoptRef(*m_ptr);
76     m_ptr = &reference.leakRef();
77     return oldReference;
78 }
79
80 template <typename T>
81 struct GetPtrHelper<Ref<T>> {
82     typedef T* PtrType;
83     static T* getPtr(const Ref<T>& p) { return const_cast<T*>(&p.get()); }
84 };
85
86 } // namespace WTF
87
88 using WTF::Ref;
89
90 #endif // WTF_Ref_h