OLD | NEW |
| (Empty) |
1 // Copyright 2008, Google Inc. | |
2 // 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 are | |
6 // met: | |
7 // | |
8 // * Redistributions of source code must retain the above copyright | |
9 // notice, this list of conditions and the following disclaimer. | |
10 // * Redistributions in binary form must reproduce the above | |
11 // copyright notice, this list of conditions and the following disclaimer | |
12 // in the documentation and/or other materials provided with the | |
13 // distribution. | |
14 // * Neither the name of Google Inc. nor the names of its | |
15 // contributors may be used to endorse or promote products derived from | |
16 // this software without specific prior written permission. | |
17 // | |
18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | |
21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | |
23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | |
24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | |
25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | |
26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | |
27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | |
28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | |
29 // | |
30 // Author: vadimb@google.com (Vadim Berman) | |
31 // | |
32 // Low-level types and utilities for porting Google Mock to various | |
33 // platforms. They are subject to change without notice. DO NOT USE | |
34 // THEM IN USER CODE. | |
35 | |
36 #ifndef GMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_PORT_H_ | |
37 #define GMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_PORT_H_ | |
38 | |
39 #include <assert.h> | |
40 #include <stdlib.h> | |
41 #include <iostream> | |
42 | |
43 // Most of the types needed for porting Google Mock are also required | |
44 // for Google Test and are defined in gtest-port.h. | |
45 #include <gtest/internal/gtest-linked_ptr.h> | |
46 #include <gtest/internal/gtest-port.h> | |
47 | |
48 // To avoid conditional compilation everywhere, we make it | |
49 // gmock-port.h's responsibility to #include the header implementing | |
50 // tr1/tuple. gmock-port.h does this via gtest-port.h, which is | |
51 // guaranteed to pull in the tuple header. | |
52 | |
53 #if GTEST_OS_LINUX | |
54 | |
55 // On some platforms, <regex.h> needs someone to define size_t, and | |
56 // won't compile otherwise. We can #include it here as we already | |
57 // included <stdlib.h>, which is guaranteed to define size_t through | |
58 // <stddef.h>. | |
59 #include <regex.h> // NOLINT | |
60 | |
61 // Defines this iff Google Mock uses the enhanced POSIX regular | |
62 // expression syntax. This is public as it affects how a user uses | |
63 // regular expression matchers. | |
64 #define GMOCK_USES_POSIX_RE 1 | |
65 | |
66 #endif // GTEST_OS_LINUX | |
67 | |
68 #if defined(GMOCK_USES_PCRE) || defined(GMOCK_USES_POSIX_RE) | |
69 // Defines this iff regular expression matchers are supported. This | |
70 // is public as it tells a user whether he can use regular expression | |
71 // matchers. | |
72 #define GMOCK_HAS_REGEX 1 | |
73 #endif // defined(GMOCK_USES_PCRE) || defined(GMOCK_USES_POSIX_RE) | |
74 | |
75 namespace testing { | |
76 namespace internal { | |
77 | |
78 // For MS Visual C++, check the compiler version. At least VS 2003 is | |
79 // required to compile Google Mock. | |
80 #if defined(_MSC_VER) && _MSC_VER < 1310 | |
81 #error "At least Visual C++ 2003 (7.1) is required to compile Google Mock." | |
82 #endif | |
83 | |
84 // Use implicit_cast as a safe version of static_cast for upcasting in | |
85 // the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a | |
86 // const Foo*). When you use implicit_cast, the compiler checks that | |
87 // the cast is safe. Such explicit implicit_casts are necessary in | |
88 // surprisingly many situations where C++ demands an exact type match | |
89 // instead of an argument type convertable to a target type. | |
90 // | |
91 // The syntax for using implicit_cast is the same as for static_cast: | |
92 // | |
93 // implicit_cast<ToType>(expr) | |
94 // | |
95 // implicit_cast would have been part of the C++ standard library, | |
96 // but the proposal was submitted too late. It will probably make | |
97 // its way into the language in the future. | |
98 template<typename To> | |
99 inline To implicit_cast(To x) { return x; } | |
100 | |
101 // When you upcast (that is, cast a pointer from type Foo to type | |
102 // SuperclassOfFoo), it's fine to use implicit_cast<>, since upcasts | |
103 // always succeed. When you downcast (that is, cast a pointer from | |
104 // type Foo to type SubclassOfFoo), static_cast<> isn't safe, because | |
105 // how do you know the pointer is really of type SubclassOfFoo? It | |
106 // could be a bare Foo, or of type DifferentSubclassOfFoo. Thus, | |
107 // when you downcast, you should use this macro. In debug mode, we | |
108 // use dynamic_cast<> to double-check the downcast is legal (we die | |
109 // if it's not). In normal mode, we do the efficient static_cast<> | |
110 // instead. Thus, it's important to test in debug mode to make sure | |
111 // the cast is legal! | |
112 // This is the only place in the code we should use dynamic_cast<>. | |
113 // In particular, you SHOULDN'T be using dynamic_cast<> in order to | |
114 // do RTTI (eg code like this: | |
115 // if (dynamic_cast<Subclass1>(foo)) HandleASubclass1Object(foo); | |
116 // if (dynamic_cast<Subclass2>(foo)) HandleASubclass2Object(foo); | |
117 // You should design the code some other way not to need this. | |
118 template<typename To, typename From> // use like this: down_cast<T*>(foo); | |
119 inline To down_cast(From* f) { // so we only accept pointers | |
120 // Ensures that To is a sub-type of From *. This test is here only | |
121 // for compile-time type checking, and has no overhead in an | |
122 // optimized build at run-time, as it will be optimized away | |
123 // completely. | |
124 if (false) { | |
125 const To to = NULL; | |
126 ::testing::internal::implicit_cast<From*>(to); | |
127 } | |
128 | |
129 #if GTEST_HAS_RTTI | |
130 assert(f == NULL || dynamic_cast<To>(f) != NULL); // RTTI: debug mode only! | |
131 #endif | |
132 return static_cast<To>(f); | |
133 } | |
134 | |
135 // The GMOCK_COMPILE_ASSERT_ macro can be used to verify that a compile time | |
136 // expression is true. For example, you could use it to verify the | |
137 // size of a static array: | |
138 // | |
139 // GMOCK_COMPILE_ASSERT_(ARRAYSIZE(content_type_names) == CONTENT_NUM_TYPES, | |
140 // content_type_names_incorrect_size); | |
141 // | |
142 // or to make sure a struct is smaller than a certain size: | |
143 // | |
144 // GMOCK_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large); | |
145 // | |
146 // The second argument to the macro is the name of the variable. If | |
147 // the expression is false, most compilers will issue a warning/error | |
148 // containing the name of the variable. | |
149 | |
150 template <bool> | |
151 struct CompileAssert { | |
152 }; | |
153 | |
154 #define GMOCK_COMPILE_ASSERT_(expr, msg) \ | |
155 typedef ::testing::internal::CompileAssert<(bool(expr))> \ | |
156 msg[bool(expr) ? 1 : -1] | |
157 | |
158 // Implementation details of GMOCK_COMPILE_ASSERT_: | |
159 // | |
160 // - GMOCK_COMPILE_ASSERT_ works by defining an array type that has -1 | |
161 // elements (and thus is invalid) when the expression is false. | |
162 // | |
163 // - The simpler definition | |
164 // | |
165 // #define GMOCK_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1] | |
166 // | |
167 // does not work, as gcc supports variable-length arrays whose sizes | |
168 // are determined at run-time (this is gcc's extension and not part | |
169 // of the C++ standard). As a result, gcc fails to reject the | |
170 // following code with the simple definition: | |
171 // | |
172 // int foo; | |
173 // GMOCK_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is | |
174 // // not a compile-time constant. | |
175 // | |
176 // - By using the type CompileAssert<(bool(expr))>, we ensures that | |
177 // expr is a compile-time constant. (Template arguments must be | |
178 // determined at compile-time.) | |
179 // | |
180 // - The outter parentheses in CompileAssert<(bool(expr))> are necessary | |
181 // to work around a bug in gcc 3.4.4 and 4.0.1. If we had written | |
182 // | |
183 // CompileAssert<bool(expr)> | |
184 // | |
185 // instead, these compilers will refuse to compile | |
186 // | |
187 // GMOCK_COMPILE_ASSERT_(5 > 0, some_message); | |
188 // | |
189 // (They seem to think the ">" in "5 > 0" marks the end of the | |
190 // template argument list.) | |
191 // | |
192 // - The array size is (bool(expr) ? 1 : -1), instead of simply | |
193 // | |
194 // ((expr) ? 1 : -1). | |
195 // | |
196 // This is to avoid running into a bug in MS VC 7.1, which | |
197 // causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1. | |
198 | |
199 #if GTEST_HAS_GLOBAL_STRING | |
200 typedef ::string string; | |
201 #elif GTEST_HAS_STD_STRING | |
202 typedef ::std::string string; | |
203 #else | |
204 #error "Google Mock requires ::std::string to compile." | |
205 #endif // GTEST_HAS_GLOBAL_STRING | |
206 | |
207 #if GTEST_HAS_GLOBAL_WSTRING | |
208 typedef ::wstring wstring; | |
209 #elif GTEST_HAS_STD_WSTRING | |
210 typedef ::std::wstring wstring; | |
211 #endif // GTEST_HAS_GLOBAL_WSTRING | |
212 | |
213 } // namespace internal | |
214 } // namespace testing | |
215 | |
216 // Macro for referencing flags. This is public as we want the user to | |
217 // use this syntax to reference Google Mock flags. | |
218 #define GMOCK_FLAG(name) FLAGS_gmock_##name | |
219 | |
220 // Macros for declaring flags. | |
221 #define GMOCK_DECLARE_bool_(name) extern bool GMOCK_FLAG(name) | |
222 #define GMOCK_DECLARE_int32_(name) \ | |
223 extern ::testing::internal::Int32 GMOCK_FLAG(name) | |
224 #define GMOCK_DECLARE_string_(name) \ | |
225 extern ::testing::internal::String GMOCK_FLAG(name) | |
226 | |
227 // Macros for defining flags. | |
228 #define GMOCK_DEFINE_bool_(name, default_val, doc) \ | |
229 bool GMOCK_FLAG(name) = (default_val) | |
230 #define GMOCK_DEFINE_int32_(name, default_val, doc) \ | |
231 ::testing::internal::Int32 GMOCK_FLAG(name) = (default_val) | |
232 #define GMOCK_DEFINE_string_(name, default_val, doc) \ | |
233 ::testing::internal::String GMOCK_FLAG(name) = (default_val) | |
234 | |
235 #endif // GMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_PORT_H_ | |
OLD | NEW |