2009-01-30 David Levin <levin@chromium.org>
[WebKit-https.git] / JavaScriptCore / wtf / TypeTraits.h
1  /*
2  * Copyright (C) 2006, 2007, 2008 Apple Inc. All rights reserved.
3  * Copyright (C) 2009 Google Inc. All rights reserved.
4  *
5  * This library is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Library General Public
7  * License as published by the Free Software Foundation; either
8  * version 2 of the License, or (at your option) any later version.
9  *
10  * This library is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
13  * Library General Public License for more details.
14  *
15  * You should have received a copy of the GNU Library General Public License
16  * along with this library; see the file COPYING.LIB.  If not, write to
17  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
18  * Boston, MA 02110-1301, USA.
19  *
20  */
21
22 #ifndef TypeTraits_h
23 #define TypeTraits_h
24
25 #include "Assertions.h"
26
27 namespace WTF {
28
29     // The following are provided in this file:
30     //
31     //   IsInteger<T>::value
32     //   IsPod<T>::value, see the definition for a note about its limitations
33     //   IsConvertibleToInteger<T>::value
34     //
35     //   IsSameType<T, U>::value
36     //
37     //   RemovePointer<T>::Type
38     //   RemoveConst<T>::Type
39     //   RemoveVolatile<T>::Type
40     //   RemoveConstVolatile<T>::Type
41     //
42     //   Each is followed by COMPILE_ASSERT's which illustrate their usage and what they do.
43
44     template<typename T> struct IsInteger           { static const bool value = false; };
45     template<> struct IsInteger<bool>               { static const bool value = true; };
46     template<> struct IsInteger<char>               { static const bool value = true; };
47     template<> struct IsInteger<signed char>        { static const bool value = true; };
48     template<> struct IsInteger<unsigned char>      { static const bool value = true; };
49     template<> struct IsInteger<short>              { static const bool value = true; };
50     template<> struct IsInteger<unsigned short>     { static const bool value = true; };
51     template<> struct IsInteger<int>                { static const bool value = true; };
52     template<> struct IsInteger<unsigned int>       { static const bool value = true; };
53     template<> struct IsInteger<long>               { static const bool value = true; };
54     template<> struct IsInteger<unsigned long>      { static const bool value = true; };
55     template<> struct IsInteger<long long>          { static const bool value = true; };
56     template<> struct IsInteger<unsigned long long> { static const bool value = true; };
57 #if !COMPILER(MSVC) || defined(_NATIVE_WCHAR_T_DEFINED)
58     template<> struct IsInteger<wchar_t>            { static const bool value = true; };
59 #endif
60
61     COMPILE_ASSERT(IsInteger<bool>::value, WTF_IsInteger_bool_true);
62     COMPILE_ASSERT(IsInteger<char>::value, WTF_IsInteger_char_true);
63     COMPILE_ASSERT(IsInteger<signed char>::value, WTF_IsInteger_signed_char_true);
64     COMPILE_ASSERT(IsInteger<unsigned char>::value, WTF_IsInteger_unsigned_char_true);
65     COMPILE_ASSERT(IsInteger<short>::value, WTF_IsInteger_short_true);
66     COMPILE_ASSERT(IsInteger<unsigned short>::value, WTF_IsInteger_unsigned_short_true);
67     COMPILE_ASSERT(IsInteger<int>::value, WTF_IsInteger_int_true);
68     COMPILE_ASSERT(IsInteger<unsigned int>::value, WTF_IsInteger_unsigned_int_true);
69     COMPILE_ASSERT(IsInteger<long>::value, WTF_IsInteger_long_true);
70     COMPILE_ASSERT(IsInteger<unsigned long>::value, WTF_IsInteger_unsigned_long_true);
71     COMPILE_ASSERT(IsInteger<long long>::value, WTF_IsInteger_long_long_true);
72     COMPILE_ASSERT(IsInteger<unsigned long long>::value, WTF_IsInteger_unsigned_long_long_true);
73 #if !COMPILER(MSVC) || defined(_NATIVE_WCHAR_T_DEFINED)
74     COMPILE_ASSERT(IsInteger<wchar_t>::value, WTF_IsInteger_wchar_t_true);
75 #endif
76     COMPILE_ASSERT(!IsInteger<char*>::value, WTF_IsInteger_char_pointer_false);
77     COMPILE_ASSERT(!IsInteger<const char*>::value, WTF_IsInteger_const_char_pointer_false);
78     COMPILE_ASSERT(!IsInteger<volatile char*>::value, WTF_IsInteger_volatile_char_pointer_false);
79     COMPILE_ASSERT(!IsInteger<double>::value, WTF_IsInteger_double_false);
80     COMPILE_ASSERT(!IsInteger<float>::value, WTF_IsInteger_float_false);
81
82     // IsPod is misnamed as it doesn't cover all plain old data (pod) types.
83     // Specifically, it doesn't allow for enums or for structs.
84     template <typename T> struct IsPod           { static const bool value = IsInteger<T>::value; };
85     template <> struct IsPod<float>              { static const bool value = true; };
86     template <> struct IsPod<double>             { static const bool value = true; };
87     template <> struct IsPod<long double>        { static const bool value = true; };
88     template <typename P> struct IsPod<P*>       { static const bool value = true; };
89
90     COMPILE_ASSERT(IsPod<bool>::value, WTF_IsPod_bool_true);
91     COMPILE_ASSERT(IsPod<char>::value, WTF_IsPod_char_true);
92     COMPILE_ASSERT(IsPod<signed char>::value, WTF_IsPod_signed_char_true);
93     COMPILE_ASSERT(IsPod<unsigned char>::value, WTF_IsPod_unsigned_char_true);
94     COMPILE_ASSERT(IsPod<short>::value, WTF_IsPod_short_true);
95     COMPILE_ASSERT(IsPod<unsigned short>::value, WTF_IsPod_unsigned_short_true);
96     COMPILE_ASSERT(IsPod<int>::value, WTF_IsPod_int_true);
97     COMPILE_ASSERT(IsPod<unsigned int>::value, WTF_IsPod_unsigned_int_true);
98     COMPILE_ASSERT(IsPod<long>::value, WTF_IsPod_long_true);
99     COMPILE_ASSERT(IsPod<unsigned long>::value, WTF_IsPod_unsigned_long_true);
100     COMPILE_ASSERT(IsPod<long long>::value, WTF_IsPod_long_long_true);
101     COMPILE_ASSERT(IsPod<unsigned long long>::value, WTF_IsPod_unsigned_long_long_true);
102 #if !COMPILER(MSVC) || defined(_NATIVE_WCHAR_T_DEFINED)
103     COMPILE_ASSERT(IsPod<wchar_t>::value, WTF_IsPod_wchar_t_true);
104 #endif
105     COMPILE_ASSERT(IsPod<char*>::value, WTF_IsPod_char_pointer_true);
106     COMPILE_ASSERT(IsPod<const char*>::value, WTF_IsPod_const_char_pointer_true);
107     COMPILE_ASSERT(IsPod<volatile char*>::value, WTF_IsPod_volatile_char_pointer_true);
108     COMPILE_ASSERT(IsPod<double>::value, WTF_IsPod_double_true);
109     COMPILE_ASSERT(IsPod<long double>::value, WTF_IsPod_long_double_true);
110     COMPILE_ASSERT(IsPod<float>::value, WTF_IsPod_float_true);
111     COMPILE_ASSERT(!IsPod<IsPod<bool> >::value, WTF_IsPod_struct_false);
112
113     template<typename T> class IsConvertibleToInteger {
114         // Avoid "possible loss of data" warning when using Microsoft's C++ compiler
115         // by not converting int's to doubles.
116         template<bool performCheck, typename U> class IsConvertibleToDouble;
117         template<typename U> class IsConvertibleToDouble<false, U> {
118         public:
119             static const bool value = false;
120         };
121
122         template<typename U> class IsConvertibleToDouble<true, U> {
123             typedef char YesType;
124             struct NoType {
125                 char padding[8];
126             };
127
128             static YesType floatCheck(long double);
129             static NoType floatCheck(...);
130             static T& t;
131         public:
132             static const bool value = sizeof(floatCheck(t)) == sizeof(YesType);
133         };
134
135     public:
136         static const bool value = IsInteger<T>::value || IsConvertibleToDouble<!IsInteger<T>::value, T>::value;
137     };
138
139     enum IsConvertibleToIntegerCheck { };
140     COMPILE_ASSERT(IsConvertibleToInteger<IsConvertibleToIntegerCheck>::value, WTF_IsConvertibleToInteger_enum_true);
141     COMPILE_ASSERT(IsConvertibleToInteger<bool>::value, WTF_IsConvertibleToInteger_bool_true);
142     COMPILE_ASSERT(IsConvertibleToInteger<char>::value, WTF_IsConvertibleToInteger_char_true);
143     COMPILE_ASSERT(IsConvertibleToInteger<signed char>::value, WTF_IsConvertibleToInteger_signed_char_true);
144     COMPILE_ASSERT(IsConvertibleToInteger<unsigned char>::value, WTF_IsConvertibleToInteger_unsigned_char_true);
145     COMPILE_ASSERT(IsConvertibleToInteger<short>::value, WTF_IsConvertibleToInteger_short_true);
146     COMPILE_ASSERT(IsConvertibleToInteger<unsigned short>::value, WTF_IsConvertibleToInteger_unsigned_short_true);
147     COMPILE_ASSERT(IsConvertibleToInteger<int>::value, WTF_IsConvertibleToInteger_int_true);
148     COMPILE_ASSERT(IsConvertibleToInteger<unsigned int>::value, WTF_IsConvertibleToInteger_unsigned_int_true);
149     COMPILE_ASSERT(IsConvertibleToInteger<long>::value, WTF_IsConvertibleToInteger_long_true);
150     COMPILE_ASSERT(IsConvertibleToInteger<unsigned long>::value, WTF_IsConvertibleToInteger_unsigned_long_true);
151     COMPILE_ASSERT(IsConvertibleToInteger<long long>::value, WTF_IsConvertibleToInteger_long_long_true);
152     COMPILE_ASSERT(IsConvertibleToInteger<unsigned long long>::value, WTF_IsConvertibleToInteger_unsigned_long_long_true);
153 #if !COMPILER(MSVC) || defined(_NATIVE_WCHAR_T_DEFINED)
154     COMPILE_ASSERT(IsConvertibleToInteger<wchar_t>::value, WTF_IsConvertibleToInteger_wchar_t_true);
155 #endif
156     COMPILE_ASSERT(IsConvertibleToInteger<double>::value, WTF_IsConvertibleToInteger_double_true);
157     COMPILE_ASSERT(IsConvertibleToInteger<long double>::value, WTF_IsConvertibleToInteger_long_double_true);
158     COMPILE_ASSERT(IsConvertibleToInteger<float>::value, WTF_IsConvertibleToInteger_float_true);
159     COMPILE_ASSERT(!IsConvertibleToInteger<char*>::value, WTF_IsConvertibleToInteger_char_pointer_false);
160     COMPILE_ASSERT(!IsConvertibleToInteger<const char*>::value, WTF_IsConvertibleToInteger_const_char_pointer_false);
161     COMPILE_ASSERT(!IsConvertibleToInteger<volatile char*>::value, WTF_IsConvertibleToInteger_volatile_char_pointer_false);
162     COMPILE_ASSERT(!IsConvertibleToInteger<IsConvertibleToInteger<bool> >::value, WTF_IsConvertibleToInteger_struct_false);
163
164     template <typename T, typename U> struct IsSameType {
165         static const bool value = false;
166     };
167
168     template <typename T> struct IsSameType<T, T> {
169         static const bool value = true;
170     };
171
172     COMPILE_ASSERT((IsSameType<bool, bool>::value), WTF_IsSameType_bool_true);
173     COMPILE_ASSERT((IsSameType<int*, int*>::value), WTF_IsSameType_int_pointer_true);
174     COMPILE_ASSERT((!IsSameType<int, int*>::value), WTF_IsSameType_int_int_pointer_false);
175     COMPILE_ASSERT((!IsSameType<bool, const bool>::value), WTF_IsSameType_const_change_false);
176     COMPILE_ASSERT((!IsSameType<bool, volatile bool>::value), WTF_IsSameType_volatile_change_false);
177
178     template <typename T> struct RemoveConst {
179         typedef T Type;
180     };
181
182     template <typename T> struct RemoveConst<const T> {
183         typedef T Type;
184     };
185
186     COMPILE_ASSERT((IsSameType<bool, RemoveConst<const bool>::Type>::value), WTF_test_RemoveConst_const_bool);
187     COMPILE_ASSERT((!IsSameType<bool, RemoveConst<volatile bool>::Type>::value), WTF_test_RemoveConst_volatile_bool);
188
189     template <typename T> struct RemoveVolatile {
190         typedef T Type;
191     };
192
193     template <typename T> struct RemoveVolatile<volatile T> {
194         typedef T Type;
195     };
196
197     COMPILE_ASSERT((IsSameType<bool, RemoveVolatile<bool>::Type>::value), WTF_test_RemoveVolatile_bool);
198     COMPILE_ASSERT((!IsSameType<bool, RemoveVolatile<const bool>::Type>::value), WTF_test_RemoveVolatile_const_bool);
199     COMPILE_ASSERT((IsSameType<bool, RemoveVolatile<volatile bool>::Type>::value), WTF_test_RemoveVolatile_volatile_bool);
200
201     template <typename T> struct RemoveConstVolatile {
202         typedef typename RemoveVolatile<typename RemoveConst<T>::Type>::Type Type;
203     };
204
205     COMPILE_ASSERT((IsSameType<bool, RemoveConstVolatile<bool>::Type>::value), WTF_test_RemoveConstVolatile_bool);
206     COMPILE_ASSERT((IsSameType<bool, RemoveConstVolatile<const bool>::Type>::value), WTF_test_RemoveConstVolatile_const_bool);
207     COMPILE_ASSERT((IsSameType<bool, RemoveConstVolatile<volatile bool>::Type>::value), WTF_test_RemoveConstVolatile_volatile_bool);
208     COMPILE_ASSERT((IsSameType<bool, RemoveConstVolatile<const volatile bool>::Type>::value), WTF_test_RemoveConstVolatile_const_volatile_bool);
209
210     template <typename T> struct RemovePointer {
211         typedef T Type;
212     };
213
214     template <typename T> struct RemovePointer<T*> {
215         typedef T Type;
216     };
217
218     COMPILE_ASSERT((IsSameType<int, RemovePointer<int>::Type>::value), WTF_Test_RemovePointer_int);
219     COMPILE_ASSERT((IsSameType<int, RemovePointer<int*>::Type>::value), WTF_Test_RemovePointer_int_pointer);
220     COMPILE_ASSERT((!IsSameType<int, RemovePointer<int**>::Type>::value), WTF_Test_RemovePointer_int_pointer_pointer);
221
222 } // namespace WTF
223
224 #endif // TypeTraits_h