Remove some stray uses of OwnPtr and PassOwnPtr in WTF (outside of the template defin...
[WebKit-https.git] / Source / WTF / wtf / HashTraits.h
1 /*
2  * Copyright (C) 2005, 2006, 2007, 2008, 2011, 2012 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_HashTraits_h
22 #define WTF_HashTraits_h
23
24 #include <wtf/HashFunctions.h>
25 #include <wtf/StdLibExtras.h>
26 #include <utility>
27 #include <limits>
28
29 namespace WTF {
30
31 class String;
32
33 template<typename T> class OwnPtr;
34
35 template<typename T> struct HashTraits;
36
37 template<bool isInteger, typename T> struct GenericHashTraitsBase;
38
39 template<typename T> struct GenericHashTraitsBase<false, T> {
40     // The emptyValueIsZero flag is used to optimize allocation of empty hash tables with zeroed memory.
41     static const bool emptyValueIsZero = false;
42     
43     // The hasIsEmptyValueFunction flag allows the hash table to automatically generate code to check
44     // for the empty value when it can be done with the equality operator, but allows custom functions
45     // for cases like String that need them.
46     static const bool hasIsEmptyValueFunction = false;
47
48     // The starting table size. Can be overridden when we know beforehand that
49     // a hash table will have at least N entries.
50     static const unsigned minimumTableSize = 8;
51 };
52
53 // Default integer traits disallow both 0 and -1 as keys (max value instead of -1 for unsigned).
54 template<typename T> struct GenericHashTraitsBase<true, T> : GenericHashTraitsBase<false, T> {
55     static const bool emptyValueIsZero = true;
56     static void constructDeletedValue(T& slot) { slot = static_cast<T>(-1); }
57     static bool isDeletedValue(T value) { return value == static_cast<T>(-1); }
58 };
59
60 template<typename T> struct GenericHashTraits : GenericHashTraitsBase<std::is_integral<T>::value, T> {
61     typedef T TraitType;
62     typedef T EmptyValueType;
63
64     static T emptyValue() { return T(); }
65
66     // Type for return value of functions that do not transfer ownership, such as get.
67     typedef T PeekType;
68     template<typename U> static U&& peek(U&& value) { return std::forward<U>(value); }
69 };
70
71 template<typename T> struct HashTraits : GenericHashTraits<T> { };
72
73 template<typename T> struct FloatHashTraits : GenericHashTraits<T> {
74     static T emptyValue() { return std::numeric_limits<T>::infinity(); }
75     static void constructDeletedValue(T& slot) { slot = -std::numeric_limits<T>::infinity(); }
76     static bool isDeletedValue(T value) { return value == -std::numeric_limits<T>::infinity(); }
77 };
78
79 template<> struct HashTraits<float> : FloatHashTraits<float> { };
80 template<> struct HashTraits<double> : FloatHashTraits<double> { };
81
82 // Default unsigned traits disallow both 0 and max as keys -- use these traits to allow zero and disallow max - 1.
83 template<typename T> struct UnsignedWithZeroKeyHashTraits : GenericHashTraits<T> {
84     static const bool emptyValueIsZero = false;
85     static T emptyValue() { return std::numeric_limits<T>::max(); }
86     static void constructDeletedValue(T& slot) { slot = std::numeric_limits<T>::max() - 1; }
87     static bool isDeletedValue(T value) { return value == std::numeric_limits<T>::max() - 1; }
88 };
89
90 // Can be used with strong enums, allows zero as key.
91 template<typename T> struct StrongEnumHashTraits : GenericHashTraits<T> {
92     using UnderlyingType = typename std::underlying_type<T>::type;
93     static const bool emptyValueIsZero = false;
94     static T emptyValue() { return static_cast<T>(std::numeric_limits<UnderlyingType>::max()); }
95     static void constructDeletedValue(T& slot) { slot = static_cast<T>(std::numeric_limits<UnderlyingType>::max() - 1); }
96     static bool isDeletedValue(T value) { return value == static_cast<T>(std::numeric_limits<UnderlyingType>::max() - 1); }
97 };
98
99 template<typename P> struct HashTraits<P*> : GenericHashTraits<P*> {
100     static const bool emptyValueIsZero = true;
101     static void constructDeletedValue(P*& slot) { slot = reinterpret_cast<P*>(-1); }
102     static bool isDeletedValue(P* value) { return value == reinterpret_cast<P*>(-1); }
103 };
104
105 template<typename T> struct SimpleClassHashTraits : GenericHashTraits<T> {
106     static const bool emptyValueIsZero = true;
107     static void constructDeletedValue(T& slot) { new (NotNull, std::addressof(slot)) T(HashTableDeletedValue); }
108     static bool isDeletedValue(const T& value) { return value.isHashTableDeletedValue(); }
109 };
110
111 template<typename T, typename Deleter> struct HashTraits<std::unique_ptr<T, Deleter>> : SimpleClassHashTraits<std::unique_ptr<T, Deleter>> {
112     typedef std::nullptr_t EmptyValueType;
113     static EmptyValueType emptyValue() { return nullptr; }
114
115     static void constructDeletedValue(std::unique_ptr<T, Deleter>& slot) { new (NotNull, std::addressof(slot)) std::unique_ptr<T, Deleter> { reinterpret_cast<T*>(-1) }; }
116     static bool isDeletedValue(const std::unique_ptr<T, Deleter>& value) { return value.get() == reinterpret_cast<T*>(-1); }
117
118     typedef T* PeekType;
119     static T* peek(const std::unique_ptr<T, Deleter>& value) { return value.get(); }
120     static T* peek(std::nullptr_t) { return nullptr; }
121 };
122
123 template<typename T> struct HashTraits<OwnPtr<T>> : SimpleClassHashTraits<OwnPtr<T>> {
124     typedef std::nullptr_t EmptyValueType;
125     static EmptyValueType emptyValue() { return nullptr; }
126
127     typedef T* PeekType;
128     static T* peek(const OwnPtr<T>& value) { return value.get(); }
129     static T* peek(std::nullptr_t) { return nullptr; }
130 };
131
132 template<typename P> struct HashTraits<RefPtr<P>> : SimpleClassHashTraits<RefPtr<P>> {
133     static P* emptyValue() { return 0; }
134
135     typedef P* PeekType;
136     static PeekType peek(const RefPtr<P>& value) { return value.get(); }
137     static PeekType peek(P* value) { return value; }
138 };
139
140 template<> struct HashTraits<String> : SimpleClassHashTraits<String> {
141     static const bool hasIsEmptyValueFunction = true;
142     static bool isEmptyValue(const String&);
143 };
144
145 // This struct template is an implementation detail of the isHashTraitsEmptyValue function,
146 // which selects either the emptyValue function or the isEmptyValue function to check for empty values.
147 template<typename Traits, bool hasEmptyValueFunction> struct HashTraitsEmptyValueChecker;
148 template<typename Traits> struct HashTraitsEmptyValueChecker<Traits, true> {
149     template<typename T> static bool isEmptyValue(const T& value) { return Traits::isEmptyValue(value); }
150 };
151 template<typename Traits> struct HashTraitsEmptyValueChecker<Traits, false> {
152     template<typename T> static bool isEmptyValue(const T& value) { return value == Traits::emptyValue(); }
153 };
154 template<typename Traits, typename T> inline bool isHashTraitsEmptyValue(const T& value)
155 {
156     return HashTraitsEmptyValueChecker<Traits, Traits::hasIsEmptyValueFunction>::isEmptyValue(value);
157 }
158
159 template<typename FirstTraitsArg, typename SecondTraitsArg>
160 struct PairHashTraits : GenericHashTraits<std::pair<typename FirstTraitsArg::TraitType, typename SecondTraitsArg::TraitType>> {
161     typedef FirstTraitsArg FirstTraits;
162     typedef SecondTraitsArg SecondTraits;
163     typedef std::pair<typename FirstTraits::TraitType, typename SecondTraits::TraitType> TraitType;
164     typedef std::pair<typename FirstTraits::EmptyValueType, typename SecondTraits::EmptyValueType> EmptyValueType;
165
166     static const bool emptyValueIsZero = FirstTraits::emptyValueIsZero && SecondTraits::emptyValueIsZero;
167     static EmptyValueType emptyValue() { return std::make_pair(FirstTraits::emptyValue(), SecondTraits::emptyValue()); }
168
169     static const unsigned minimumTableSize = FirstTraits::minimumTableSize;
170
171     static void constructDeletedValue(TraitType& slot) { FirstTraits::constructDeletedValue(slot.first); }
172     static bool isDeletedValue(const TraitType& value) { return FirstTraits::isDeletedValue(value.first); }
173 };
174
175 template<typename First, typename Second>
176 struct HashTraits<std::pair<First, Second>> : public PairHashTraits<HashTraits<First>, HashTraits<Second>> { };
177
178 template<typename KeyTypeArg, typename ValueTypeArg>
179 struct KeyValuePair {
180     typedef KeyTypeArg KeyType;
181
182     KeyValuePair()
183     {
184     }
185
186     template<typename K, typename V>
187     KeyValuePair(K&& key, V&& value)
188         : key(std::forward<K>(key))
189         , value(std::forward<V>(value))
190     {
191     }
192
193     template <typename OtherKeyType, typename OtherValueType>
194     KeyValuePair(KeyValuePair<OtherKeyType, OtherValueType>&& other)
195         : key(std::forward<OtherKeyType>(other.key))
196         , value(std::forward<OtherValueType>(other.value))
197     {
198     }
199
200     KeyTypeArg key;
201     ValueTypeArg value;
202 };
203
204 template<typename KeyTraitsArg, typename ValueTraitsArg>
205 struct KeyValuePairHashTraits : GenericHashTraits<KeyValuePair<typename KeyTraitsArg::TraitType, typename ValueTraitsArg::TraitType>> {
206     typedef KeyTraitsArg KeyTraits;
207     typedef ValueTraitsArg ValueTraits;
208     typedef KeyValuePair<typename KeyTraits::TraitType, typename ValueTraits::TraitType> TraitType;
209     typedef KeyValuePair<typename KeyTraits::EmptyValueType, typename ValueTraits::EmptyValueType> EmptyValueType;
210
211     static const bool emptyValueIsZero = KeyTraits::emptyValueIsZero && ValueTraits::emptyValueIsZero;
212     static EmptyValueType emptyValue() { return KeyValuePair<typename KeyTraits::EmptyValueType, typename ValueTraits::EmptyValueType>(KeyTraits::emptyValue(), ValueTraits::emptyValue()); }
213
214     static const unsigned minimumTableSize = KeyTraits::minimumTableSize;
215
216     static void constructDeletedValue(TraitType& slot) { KeyTraits::constructDeletedValue(slot.key); }
217     static bool isDeletedValue(const TraitType& value) { return KeyTraits::isDeletedValue(value.key); }
218 };
219
220 template<typename Key, typename Value>
221 struct HashTraits<KeyValuePair<Key, Value>> : public KeyValuePairHashTraits<HashTraits<Key>, HashTraits<Value>> { };
222
223 template<typename T>
224 struct NullableHashTraits : public HashTraits<T> {
225     static const bool emptyValueIsZero = false;
226     static T emptyValue() { return reinterpret_cast<T>(1); }
227 };
228
229 // Useful for classes that want complete control over what is empty and what is deleted,
230 // and how to construct both.
231 template<typename T>
232 struct CustomHashTraits : public GenericHashTraits<T> {
233     static const bool emptyValueIsZero = false;
234     static const bool hasIsEmptyValueFunction = true;
235     
236     static void constructDeletedValue(T& slot)
237     {
238         new (NotNull, std::addressof(slot)) T(T::DeletedValue);
239     }
240     
241     static bool isDeletedValue(const T& value)
242     {
243         return value.isDeletedValue();
244     }
245     
246     static T emptyValue()
247     {
248         return T(T::EmptyValue);
249     }
250     
251     static bool isEmptyValue(const T& value)
252     {
253         return value.isEmptyValue();
254     }
255 };
256
257 } // namespace WTF
258
259 using WTF::HashTraits;
260 using WTF::PairHashTraits;
261 using WTF::NullableHashTraits;
262 using WTF::SimpleClassHashTraits;
263
264 #endif // WTF_HashTraits_h