Web Inspector: Better handling for large arrays and collections in Object Trees
[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/FastMalloc.h>
35 #include <wtf/Noncopyable.h>
36
37 namespace WTF {
38
39 template<typename T> void deleteObject(T);
40
41 template<typename T> class GDIObject {
42     WTF_MAKE_NONCOPYABLE(GDIObject);
43     WTF_MAKE_FAST_ALLOCATED;
44 public:
45     GDIObject() : m_object(0) { }
46     GDIObject(std::nullptr_t) : m_object(0) { }
47     ~GDIObject() { deleteObject<T>(m_object); }
48
49     T get() const { return m_object; }
50
51     void clear();
52     T leak() WARN_UNUSED_RETURN;
53
54     bool operator!() const { return !m_object; }
55
56     // This conversion operator allows implicit conversion to bool but not to other integer types.
57     typedef const void* UnspecifiedBoolType;
58     operator UnspecifiedBoolType() const { return m_object ? reinterpret_cast<UnspecifiedBoolType>(&m_object) : 0; }
59
60     GDIObject<T>& operator=(std::nullptr_t) { clear(); return *this; }
61
62     GDIObject(GDIObject&&);
63     template<typename U> GDIObject(GDIObject<U>&&);
64
65     GDIObject& operator=(GDIObject&&);
66     template<typename U> GDIObject& operator=(GDIObject<U>&&);
67
68     void swap(GDIObject& o) { std::swap(m_object, o.m_object); }
69
70 private:
71     template<typename U> friend GDIObject<U> adoptGDIObject(U);
72     GDIObject(T object) : m_object(object) { }
73
74     GDIObject<T>& operator=(T);
75
76     T m_object;
77 };
78
79 template<typename T> inline void GDIObject<T>::clear()
80 {
81     T object = m_object;
82     m_object = 0;
83     deleteObject(object);
84 }
85
86 template<typename T> inline T GDIObject<T>::leak()
87 {
88     T object = m_object;
89     m_object = 0;
90     return object;
91 }
92
93 template<typename T> inline GDIObject<T>::GDIObject(GDIObject<T>&& other)
94     : m_object(other.leak())
95 {
96 }
97
98 template<typename T> inline GDIObject<T>& GDIObject<T>::operator=(GDIObject<T>&& other)
99 {
100     auto object = WTFMove(other);
101     swap(object);
102     return *this;
103 }
104
105 template<typename T> inline GDIObject<T> adoptGDIObject(T object)
106 {
107     return GDIObject<T>(object);
108 }
109
110 template<typename T> inline void swap(GDIObject<T>& a, GDIObject<T>& b)
111 {
112     a.swap(b);
113 }
114
115 // Nearly all GDI types use the same DeleteObject call.
116 template<typename T> inline void deleteObject(T object)
117 {
118     if (object)
119         ::DeleteObject(object);
120 }
121
122 template<> inline void deleteObject<HDC>(HDC hdc)
123 {
124     if (hdc)
125         ::DeleteDC(hdc);
126 }
127
128 } // namespace WTF
129
130 using WTF::GDIObject;
131 using WTF::adoptGDIObject;
132
133 #endif // GDIObject_h