af939e769158fd32976ef39cbd577e074624703e
[WebKit-https.git] / JavaScriptCore / wtf / OwnPtr.h
1 /*
2  *  Copyright (C) 2006, 2007 Apple Inc. All rights reserved.
3  *
4  *  This library is free software; you can redistribute it and/or
5  *  modify it under the terms of the GNU Library General Public
6  *  License as published by the Free Software Foundation; either
7  *  version 2 of the License, or (at your option) any later version.
8  *
9  *  This library is distributed in the hope that it will be useful,
10  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12  *  Library General Public License for more details.
13  *
14  *  You should have received a copy of the GNU Library General Public License
15  *  along with this library; see the file COPYING.LIB.  If not, write to
16  *  the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
17  *  Boston, MA 02110-1301, USA.
18  *
19  */
20
21 #ifndef WTF_OwnPtr_h
22 #define WTF_OwnPtr_h
23
24 #include "Assertions.h"
25 #include "Noncopyable.h"
26 #include "TypeTraits.h"
27 #include <algorithm>
28 #include <memory>
29
30 #if PLATFORM(WIN)
31
32 typedef struct HBITMAP__* HBITMAP;
33 typedef struct HBRUSH__* HBRUSH;
34 typedef struct HFONT__* HFONT;
35 typedef struct HPALETTE__* HPALETTE;
36 typedef struct HPEN__* HPEN;
37 typedef struct HRGN__* HRGN;
38
39 #endif
40
41 namespace WTF {
42
43     // Unlike most of our smart pointers, OwnPtr can take either the pointer type or the pointed-to type.
44
45     template <typename T> inline void deleteOwnedPtr(T* ptr)
46     {
47         typedef char known[sizeof(T) ? 1 : -1];
48         if (sizeof(known))
49             delete ptr;
50     }
51
52 #if PLATFORM(WIN)
53     void deleteOwnedPtr(HBITMAP);
54     void deleteOwnedPtr(HBRUSH);
55     void deleteOwnedPtr(HFONT);
56     void deleteOwnedPtr(HPALETTE);
57     void deleteOwnedPtr(HPEN);
58     void deleteOwnedPtr(HRGN);
59 #endif
60
61     template <typename T> class OwnPtr : Noncopyable {
62     public:
63         typedef typename RemovePointer<T>::Type ValueType;
64         typedef ValueType* PtrType;
65
66         explicit OwnPtr(PtrType ptr = 0) : m_ptr(ptr) { }
67         OwnPtr(std::auto_ptr<ValueType> autoPtr) : m_ptr(autoPtr.release()) { }
68         ~OwnPtr() { deleteOwnedPtr(m_ptr); }
69
70         PtrType get() const { return m_ptr; }
71         PtrType release() { PtrType ptr = m_ptr; m_ptr = 0; return ptr; }
72
73         // FIXME: This should be renamed to adopt. 
74         void set(PtrType ptr) { ASSERT(!ptr || m_ptr != ptr); deleteOwnedPtr(m_ptr); m_ptr = ptr; }
75
76         void adopt(std::auto_ptr<ValueType> autoPtr) { ASSERT(!autoPtr.get() || m_ptr != autoPtr.get()); deleteOwnedPtr(m_ptr); m_ptr = autoPtr.release(); }
77
78         void clear() { deleteOwnedPtr(m_ptr); m_ptr = 0; }
79
80         ValueType& operator*() const { ASSERT(m_ptr); return *m_ptr; }
81         PtrType operator->() const { ASSERT(m_ptr); return m_ptr; }
82
83         bool operator!() const { return !m_ptr; }
84
85         // This conversion operator allows implicit conversion to bool but not to other integer types.
86         typedef PtrType OwnPtr::*UnspecifiedBoolType;
87         operator UnspecifiedBoolType() const { return m_ptr ? &OwnPtr::m_ptr : 0; }
88
89         void swap(OwnPtr& o) { std::swap(m_ptr, o.m_ptr); }
90
91     private:
92         PtrType m_ptr;
93     };
94     
95     template <typename T> inline void swap(OwnPtr<T>& a, OwnPtr<T>& b) { a.swap(b); }
96
97     template <typename T, typename U> inline bool operator==(const OwnPtr<T>& a, U* b)
98     { 
99         return a.get() == b; 
100     }
101     
102     template <typename T, typename U> inline bool operator==(T* a, const OwnPtr<U>& b) 
103     {
104         return a == b.get(); 
105     }
106
107     template <typename T, typename U> inline bool operator!=(const OwnPtr<T>& a, U* b)
108     {
109         return a.get() != b; 
110     }
111
112     template <typename T, typename U> inline bool operator!=(T* a, const OwnPtr<U>& b)
113     { 
114         return a != b.get(); 
115     }
116     
117     template <typename T> inline typename OwnPtr<T>::PtrType getPtr(const OwnPtr<T>& p)
118     {
119         return p.get();
120     }
121
122 } // namespace WTF
123
124 using WTF::OwnPtr;
125
126 #endif // WTF_OwnPtr_h