b78a1c7145be802725aab5d7e06f74ad2a4be063
[WebKit-https.git] / Source / WTF / wtf / win / GDIObject.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. ``AS IS'' AND ANY
14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
24  */
25
26 #ifndef GDIObject_h
27 #define GDIObject_h
28
29 #include <algorithm>
30 #include <cstddef>
31 #include <memory>
32 #include <windows.h>
33 #include <wtf/Assertions.h>
34 #include <wtf/Noncopyable.h>
35
36 namespace WTF {
37
38 template<typename T> void deleteObject(T);
39
40 template<typename T> class GDIObject {
41     WTF_MAKE_NONCOPYABLE(GDIObject);
42     WTF_MAKE_FAST_ALLOCATED;
43 public:
44     GDIObject() : m_object(0) { }
45     GDIObject(std::nullptr_t) : m_object(0) { }
46     ~GDIObject() { deleteObject<T>(m_object); }
47
48     T get() const { return m_object; }
49
50     void clear();
51     T leak() WARN_UNUSED_RETURN;
52
53     bool operator!() const { return !m_object; }
54
55     // This conversion operator allows implicit conversion to bool but not to other integer types.
56     typedef const void* UnspecifiedBoolType;
57     operator UnspecifiedBoolType() const { return m_object ? reinterpret_cast<UnspecifiedBoolType>(&m_object) : 0; }
58
59     GDIObject<T>& operator=(std::nullptr_t) { clear(); return *this; }
60
61     GDIObject(GDIObject&&);
62     template<typename U> GDIObject(GDIObject<U>&&);
63
64     GDIObject& operator=(GDIObject&&);
65     template<typename U> GDIObject& operator=(GDIObject<U>&&);
66
67     void swap(GDIObject& o) { std::swap(m_object, o.m_object); }
68
69 private:
70     template<typename U> friend GDIObject<U> adoptGDIObject(U);
71     GDIObject(T object) : m_object(object) { }
72
73     GDIObject<T>& operator=(T);
74
75     T m_object;
76 };
77
78 template<typename T> inline void GDIObject<T>::clear()
79 {
80     T object = m_object;
81     m_object = 0;
82     deleteObject(object);
83 }
84
85 template<typename T> inline T GDIObject<T>::leak()
86 {
87     T object = m_object;
88     m_object = 0;
89     return object;
90 }
91
92 template<typename T> inline GDIObject<T>::GDIObject(GDIObject<T>&& other)
93     : m_object(other.leak())
94 {
95 }
96
97 template<typename T> inline GDIObject<T>& GDIObject<T>::operator=(GDIObject<T>&& other)
98 {
99     auto object = WTFMove(other);
100     swap(object);
101     return *this;
102 }
103
104 template<typename T> inline GDIObject<T> adoptGDIObject(T object)
105 {
106     return GDIObject<T>(object);
107 }
108
109 template<typename T> inline void swap(GDIObject<T>& a, GDIObject<T>& b)
110 {
111     a.swap(b);
112 }
113
114 // Nearly all GDI types use the same DeleteObject call.
115 template<typename T> inline void deleteObject(T object)
116 {
117     if (object)
118         ::DeleteObject(object);
119 }
120
121 template<> inline void deleteObject<HDC>(HDC hdc)
122 {
123     if (hdc)
124         ::DeleteDC(hdc);
125 }
126
127 } // namespace WTF
128
129 using WTF::GDIObject;
130 using WTF::adoptGDIObject;
131
132 #endif // GDIObject_h