TestWebKitAPI breaks on Windows due to fast malloc incompatibility.
[WebKit-https.git] / Source / ThirdParty / gtest / include / gtest / internal / gtest-port.h
1 // Copyright 2005, 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 // Authors: wan@google.com (Zhanyong Wan)
31 //
32 // Low-level types and utilities for porting Google Test to various
33 // platforms.  They are subject to change without notice.  DO NOT USE
34 // THEM IN USER CODE.
35
36 #ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
37 #define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
38
39 // The user can define the following macros in the build script to
40 // control Google Test's behavior.  If the user doesn't define a macro
41 // in this list, Google Test will define it.
42 //
43 //   GTEST_HAS_CLONE          - Define it to 1/0 to indicate that clone(2)
44 //                              is/isn't available.
45 //   GTEST_HAS_EXCEPTIONS     - Define it to 1/0 to indicate that exceptions
46 //                              are enabled.
47 //   GTEST_HAS_GLOBAL_STRING  - Define it to 1/0 to indicate that ::string
48 //                              is/isn't available (some systems define
49 //                              ::string, which is different to std::string).
50 //   GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string
51 //                              is/isn't available (some systems define
52 //                              ::wstring, which is different to std::wstring).
53 //   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that <pthread.h>
54 //                              is/isn't available.
55 //   GTEST_HAS_RTTI           - Define it to 1/0 to indicate that RTTI is/isn't
56 //                              enabled.
57 //   GTEST_HAS_STD_WSTRING    - Define it to 1/0 to indicate that
58 //                              std::wstring does/doesn't work (Google Test can
59 //                              be used where std::wstring is unavailable).
60 //   GTEST_HAS_TR1_TUPLE      - Define it to 1/0 to indicate tr1::tuple
61 //                              is/isn't available.
62 //   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
63 //                              compiler supports Microsoft's "Structured
64 //                              Exception Handling".
65 //   GTEST_USE_OWN_TR1_TUPLE  - Define it to 1/0 to indicate whether Google
66 //                              Test's own tr1 tuple implementation should be
67 //                              used.  Unused when the user sets
68 //                              GTEST_HAS_TR1_TUPLE to 0.
69 //   GTEST_LINKED_AS_SHARED_LIBRARY
70 //                            - Define to 1 when compiling tests that use
71 //                              Google Test as a shared library (known as
72 //                              DLL on Windows).
73 //   GTEST_CREATE_SHARED_LIBRARY
74 //                            - Define to 1 when compiling Google Test itself
75 //                              as a shared library.
76
77 // This header defines the following utilities:
78 //
79 // Macros indicating the current platform (defined to 1 if compiled on
80 // the given platform; otherwise undefined):
81 //   GTEST_OS_AIX      - IBM AIX
82 //   GTEST_OS_CYGWIN   - Cygwin
83 //   GTEST_OS_LINUX    - Linux
84 //   GTEST_OS_MAC      - Mac OS X
85 //   GTEST_OS_SOLARIS  - Sun Solaris
86 //   GTEST_OS_SYMBIAN  - Symbian
87 //   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
88 //     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
89 //     GTEST_OS_WINDOWS_MINGW    - MinGW
90 //     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
91 //   GTEST_OS_ZOS      - z/OS
92 //
93 // Among the platforms, Cygwin, Linux, Max OS X, and Windows have the
94 // most stable support.  Since core members of the Google Test project
95 // don't have access to other platforms, support for them may be less
96 // stable.  If you notice any problems on your platform, please notify
97 // googletestframework@googlegroups.com (patches for fixing them are
98 // even more welcome!).
99 //
100 // Note that it is possible that none of the GTEST_OS_* macros are defined.
101 //
102 // Macros indicating available Google Test features (defined to 1 if
103 // the corresponding feature is supported; otherwise undefined):
104 //   GTEST_HAS_COMBINE      - the Combine() function (for value-parameterized
105 //                            tests)
106 //   GTEST_HAS_DEATH_TEST   - death tests
107 //   GTEST_HAS_PARAM_TEST   - value-parameterized tests
108 //   GTEST_HAS_TYPED_TEST   - typed tests
109 //   GTEST_HAS_TYPED_TEST_P - type-parameterized tests
110 //   GTEST_USES_POSIX_RE    - enhanced POSIX regex is used.
111 //   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
112 //                            the above two are mutually exclusive.
113 //   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
114 //
115 // Macros for basic C++ coding:
116 //   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
117 //   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
118 //                              variable don't have to be used.
119 //   GTEST_DISALLOW_ASSIGN_   - disables operator=.
120 //   GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
121 //   GTEST_MUST_USE_RESULT_   - declares that a function's result must be used.
122 //
123 // Synchronization:
124 //   Mutex, MutexLock, ThreadLocal, GetThreadCount()
125 //                  - synchronization primitives.
126 //   GTEST_IS_THREADSAFE - defined to 1 to indicate that the above
127 //                         synchronization primitives have real implementations
128 //                         and Google Test is thread-safe; or 0 otherwise.
129 //
130 // Template meta programming:
131 //   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
132 //
133 // Smart pointers:
134 //   scoped_ptr     - as in TR2.
135 //
136 // Regular expressions:
137 //   RE             - a simple regular expression class using the POSIX
138 //                    Extended Regular Expression syntax.  Not available on
139 //                    Windows.
140 //
141 // Logging:
142 //   GTEST_LOG_()   - logs messages at the specified severity level.
143 //   LogToStderr()  - directs all log messages to stderr.
144 //   FlushInfoLog() - flushes informational log messages.
145 //
146 // Stdout and stderr capturing:
147 //   CaptureStdout()     - starts capturing stdout.
148 //   GetCapturedStdout() - stops capturing stdout and returns the captured
149 //                         string.
150 //   CaptureStderr()     - starts capturing stderr.
151 //   GetCapturedStderr() - stops capturing stderr and returns the captured
152 //                         string.
153 //
154 // Integer types:
155 //   TypeWithSize   - maps an integer to a int type.
156 //   Int32, UInt32, Int64, UInt64, TimeInMillis
157 //                  - integers of known sizes.
158 //   BiggestInt     - the biggest signed integer type.
159 //
160 // Command-line utilities:
161 //   GTEST_FLAG()       - references a flag.
162 //   GTEST_DECLARE_*()  - declares a flag.
163 //   GTEST_DEFINE_*()   - defines a flag.
164 //   GetArgvs()         - returns the command line as a vector of strings.
165 //
166 // Environment variable utilities:
167 //   GetEnv()             - gets the value of an environment variable.
168 //   BoolFromGTestEnv()   - parses a bool environment variable.
169 //   Int32FromGTestEnv()  - parses an Int32 environment variable.
170 //   StringFromGTestEnv() - parses a string environment variable.
171
172 #include <stddef.h>  // For ptrdiff_t
173 #include <stdlib.h>
174 #include <stdio.h>
175 #include <string.h>
176 #ifndef _WIN32_WCE
177 #include <sys/stat.h>
178 #endif  // !_WIN32_WCE
179
180 #include <wtf/Platform.h>
181
182 #if !PLATFORM(CHROMIUM) && OS(WINDOWS) && !defined(BUILDING_WX__) && !COMPILER(GCC)
183 #define JS_EXPORTDATA __declspec(dllimport)
184 #define WEBKIT_EXPORTDATA __declspec(dllimport)
185 #define WTF_EXPORT_PRIVATE
186 #define JS_EXPORT_PRIVATE
187 #define JS_EXPORTCLASS JS_EXPORTDATA
188 #else
189 #define JS_EXPORTDATA
190 #define JS_EXPORTCLASS
191 #define WEBKIT_EXPORTDATA
192 #define WTF_EXPORT_PRIVATE
193 #define JS_EXPORT_PRIVATE
194 #endif
195
196 #include <wtf/FastMalloc.h>
197
198 #include <iostream>  // NOLINT
199 #include <sstream>  // NOLINT
200 #include <string>  // NOLINT
201
202 #define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
203 #define GTEST_FLAG_PREFIX_ "gtest_"
204 #define GTEST_FLAG_PREFIX_DASH_ "gtest-"
205 #define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
206 #define GTEST_NAME_ "Google Test"
207 #define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/"
208
209 // Determines the version of gcc that is used to compile this.
210 #ifdef __GNUC__
211 // 40302 means version 4.3.2.
212 #define GTEST_GCC_VER_ \
213     (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
214 #endif  // __GNUC__
215
216 // Determines the platform on which Google Test is compiled.
217 #ifdef __CYGWIN__
218 #define GTEST_OS_CYGWIN 1
219 #elif defined __SYMBIAN32__
220 #define GTEST_OS_SYMBIAN 1
221 #elif defined _WIN32
222 #define GTEST_OS_WINDOWS 1
223 #ifdef _WIN32_WCE
224 #define GTEST_OS_WINDOWS_MOBILE 1
225 #elif defined(__MINGW__) || defined(__MINGW32__)
226 #define GTEST_OS_WINDOWS_MINGW 1
227 #else
228 #define GTEST_OS_WINDOWS_DESKTOP 1
229 #endif  // _WIN32_WCE
230 #elif defined __APPLE__
231 #define GTEST_OS_MAC 1
232 #elif defined __linux__
233 #define GTEST_OS_LINUX 1
234 #elif defined __MVS__
235 #define GTEST_OS_ZOS 1
236 #elif defined(__sun) && defined(__SVR4)
237 #define GTEST_OS_SOLARIS 1
238 #elif defined(_AIX)
239 #define GTEST_OS_AIX 1
240 #endif  // __CYGWIN__
241
242 #if GTEST_OS_CYGWIN || GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_SYMBIAN || \
243     GTEST_OS_SOLARIS || GTEST_OS_AIX
244
245 // On some platforms, <regex.h> needs someone to define size_t, and
246 // won't compile otherwise.  We can #include it here as we already
247 // included <stdlib.h>, which is guaranteed to define size_t through
248 // <stddef.h>.
249 #include <regex.h>  // NOLINT
250 #include <strings.h>  // NOLINT
251 #include <sys/types.h>  // NOLINT
252 #include <time.h>  // NOLINT
253 #include <unistd.h>  // NOLINT
254
255 #define GTEST_USES_POSIX_RE 1
256
257 #elif GTEST_OS_WINDOWS
258
259 #if !GTEST_OS_WINDOWS_MOBILE
260 #include <direct.h>  // NOLINT
261 #include <io.h>  // NOLINT
262 #endif
263
264 // <regex.h> is not available on Windows.  Use our own simple regex
265 // implementation instead.
266 #define GTEST_USES_SIMPLE_RE 1
267
268 #else
269
270 // <regex.h> may not be available on this platform.  Use our own
271 // simple regex implementation instead.
272 #define GTEST_USES_SIMPLE_RE 1
273
274 #endif  // GTEST_OS_CYGWIN || GTEST_OS_LINUX || GTEST_OS_MAC ||
275         // GTEST_OS_SYMBIAN || GTEST_OS_SOLARIS || GTEST_OS_AIX
276
277 #ifndef GTEST_HAS_EXCEPTIONS
278 // The user didn't tell us whether exceptions are enabled, so we need
279 // to figure it out.
280 #if defined(_MSC_VER) || defined(__BORLANDC__)
281 // MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS
282 // macro to enable exceptions, so we'll do the same.
283 // Assumes that exceptions are enabled by default.
284 #ifndef _HAS_EXCEPTIONS
285 #define _HAS_EXCEPTIONS 1
286 #endif  // _HAS_EXCEPTIONS
287 #define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
288 #elif defined(__GNUC__) && __EXCEPTIONS
289 // gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
290 #define GTEST_HAS_EXCEPTIONS 1
291 #elif defined(__SUNPRO_CC)
292 // Sun Pro CC supports exceptions.  However, there is no compile-time way of
293 // detecting whether they are enabled or not.  Therefore, we assume that
294 // they are enabled unless the user tells us otherwise.
295 #define GTEST_HAS_EXCEPTIONS 1
296 #elif defined(__IBMCPP__) && __EXCEPTIONS
297 // xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
298 #define GTEST_HAS_EXCEPTIONS 1
299 #else
300 // For other compilers, we assume exceptions are disabled to be
301 // conservative.
302 #define GTEST_HAS_EXCEPTIONS 0
303 #endif  // defined(_MSC_VER) || defined(__BORLANDC__)
304 #endif  // GTEST_HAS_EXCEPTIONS
305
306 #if !defined(GTEST_HAS_STD_STRING)
307 // Even though we don't use this macro any longer, we keep it in case
308 // some clients still depend on it.
309 #define GTEST_HAS_STD_STRING 1
310 #elif !GTEST_HAS_STD_STRING
311 // The user told us that ::std::string isn't available.
312 #error "Google Test cannot be used where ::std::string isn't available."
313 #endif  // !defined(GTEST_HAS_STD_STRING)
314
315 #ifndef GTEST_HAS_GLOBAL_STRING
316 // The user didn't tell us whether ::string is available, so we need
317 // to figure it out.
318
319 #define GTEST_HAS_GLOBAL_STRING 0
320
321 #endif  // GTEST_HAS_GLOBAL_STRING
322
323 #ifndef GTEST_HAS_STD_WSTRING
324 // The user didn't tell us whether ::std::wstring is available, so we need
325 // to figure it out.
326 // TODO(wan@google.com): uses autoconf to detect whether ::std::wstring
327 //   is available.
328
329 // Cygwin 1.5 and below doesn't support ::std::wstring.
330 // Cygwin 1.7 might add wstring support; this should be updated when clear.
331 // Solaris' libc++ doesn't support it either.
332 #define GTEST_HAS_STD_WSTRING (!(GTEST_OS_CYGWIN || GTEST_OS_SOLARIS))
333
334 #endif  // GTEST_HAS_STD_WSTRING
335
336 #ifndef GTEST_HAS_GLOBAL_WSTRING
337 // The user didn't tell us whether ::wstring is available, so we need
338 // to figure it out.
339 #define GTEST_HAS_GLOBAL_WSTRING \
340     (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
341 #endif  // GTEST_HAS_GLOBAL_WSTRING
342
343 // Determines whether RTTI is available.
344 #ifndef GTEST_HAS_RTTI
345 // The user didn't tell us whether RTTI is enabled, so we need to
346 // figure it out.
347
348 #ifdef _MSC_VER
349
350 #ifdef _CPPRTTI  // MSVC defines this macro iff RTTI is enabled.
351 #define GTEST_HAS_RTTI 1
352 #else
353 #define GTEST_HAS_RTTI 0
354 #endif
355
356 // Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled.
357 #elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302)
358
359 #ifdef __GXX_RTTI
360 #define GTEST_HAS_RTTI 1
361 #else
362 #define GTEST_HAS_RTTI 0
363 #endif  // __GXX_RTTI
364
365 // Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if
366 // both the typeid and dynamic_cast features are present.
367 #elif defined(__IBMCPP__) && (__IBMCPP__ >= 900)
368
369 #ifdef __RTTI_ALL__
370 #define GTEST_HAS_RTTI 1
371 #else
372 #define GTEST_HAS_RTTI 0
373 #endif
374
375 #else
376
377 // For all other compilers, we assume RTTI is enabled.
378 #define GTEST_HAS_RTTI 1
379
380 #endif  // _MSC_VER
381
382 #endif  // GTEST_HAS_RTTI
383
384 // It's this header's responsibility to #include <typeinfo> when RTTI
385 // is enabled.
386 #if GTEST_HAS_RTTI
387 #include <typeinfo>
388 #endif
389
390 // Determines whether Google Test can use the pthreads library.
391 #ifndef GTEST_HAS_PTHREAD
392 // The user didn't tell us explicitly, so we assume pthreads support is
393 // available on Linux and Mac.
394 //
395 // To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
396 // to your compiler flags.
397 #define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC)
398 #endif  // GTEST_HAS_PTHREAD
399
400 // Determines whether Google Test can use tr1/tuple.  You can define
401 // this macro to 0 to prevent Google Test from using tuple (any
402 // feature depending on tuple with be disabled in this mode).
403 #ifndef GTEST_HAS_TR1_TUPLE
404 // The user didn't tell us not to do it, so we assume it's OK.
405 #define GTEST_HAS_TR1_TUPLE 1
406 #endif  // GTEST_HAS_TR1_TUPLE
407
408 // Determines whether Google Test's own tr1 tuple implementation
409 // should be used.
410 #ifndef GTEST_USE_OWN_TR1_TUPLE
411 // The user didn't tell us, so we need to figure it out.
412
413 // We use our own TR1 tuple if we aren't sure the user has an
414 // implementation of it already.  At this time, GCC 4.0.0+ and MSVC
415 // 2010 are the only mainstream compilers that come with a TR1 tuple
416 // implementation.  NVIDIA's CUDA NVCC compiler pretends to be GCC by
417 // defining __GNUC__ and friends, but cannot compile GCC's tuple
418 // implementation.  MSVC 2008 (9.0) provides TR1 tuple in a 323 MB
419 // Feature Pack download, which we cannot assume the user has.
420 #if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000)) \
421     || _MSC_VER >= 1600
422 #define GTEST_USE_OWN_TR1_TUPLE 0
423 #else
424 #define GTEST_USE_OWN_TR1_TUPLE 1
425 #endif
426
427 #endif  // GTEST_USE_OWN_TR1_TUPLE
428
429 // To avoid conditional compilation everywhere, we make it
430 // gtest-port.h's responsibility to #include the header implementing
431 // tr1/tuple.
432 #if GTEST_HAS_TR1_TUPLE
433
434 #if GTEST_USE_OWN_TR1_TUPLE
435 #include <gtest/internal/gtest-tuple.h>
436 #elif GTEST_OS_SYMBIAN
437
438 // On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to
439 // use STLport's tuple implementation, which unfortunately doesn't
440 // work as the copy of STLport distributed with Symbian is incomplete.
441 // By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to
442 // use its own tuple implementation.
443 #ifdef BOOST_HAS_TR1_TUPLE
444 #undef BOOST_HAS_TR1_TUPLE
445 #endif  // BOOST_HAS_TR1_TUPLE
446
447 // This prevents <boost/tr1/detail/config.hpp>, which defines
448 // BOOST_HAS_TR1_TUPLE, from being #included by Boost's <tuple>.
449 #define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED
450 #include <tuple>
451
452 #elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
453 // GCC 4.0+ implements tr1/tuple in the <tr1/tuple> header.  This does
454 // not conform to the TR1 spec, which requires the header to be <tuple>.
455
456 #if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
457 // Until version 4.3.2, gcc has a bug that causes <tr1/functional>,
458 // which is #included by <tr1/tuple>, to not compile when RTTI is
459 // disabled.  _TR1_FUNCTIONAL is the header guard for
460 // <tr1/functional>.  Hence the following #define is a hack to prevent
461 // <tr1/functional> from being included.
462 #define _TR1_FUNCTIONAL 1
463 #include <tr1/tuple>
464 #undef _TR1_FUNCTIONAL  // Allows the user to #include
465                         // <tr1/functional> if he chooses to.
466 #else
467 #include <tr1/tuple>  // NOLINT
468 #endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
469
470 #else
471 // If the compiler is not GCC 4.0+, we assume the user is using a
472 // spec-conforming TR1 implementation.
473 #include <tuple>  // NOLINT
474 #endif  // GTEST_USE_OWN_TR1_TUPLE
475
476 #endif  // GTEST_HAS_TR1_TUPLE
477
478 // Determines whether clone(2) is supported.
479 // Usually it will only be available on Linux, excluding
480 // Linux on the Itanium architecture.
481 // Also see http://linux.die.net/man/2/clone.
482 #ifndef GTEST_HAS_CLONE
483 // The user didn't tell us, so we need to figure it out.
484
485 #if GTEST_OS_LINUX && !defined(__ia64__)
486 #define GTEST_HAS_CLONE 1
487 #else
488 #define GTEST_HAS_CLONE 0
489 #endif  // GTEST_OS_LINUX && !defined(__ia64__)
490
491 #endif  // GTEST_HAS_CLONE
492
493 // Determines whether to support stream redirection. This is used to test
494 // output correctness and to implement death tests.
495 #if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
496 #define GTEST_HAS_STREAM_REDIRECTION_ 1
497 #endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
498
499 // Determines whether to support death tests.
500 // Google Test does not support death tests for VC 7.1 and earlier as
501 // abort() in a VC 7.1 application compiled as GUI in debug config
502 // pops up a dialog window that cannot be suppressed programmatically.
503 #if (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
504      (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
505      GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX)
506 #define GTEST_HAS_DEATH_TEST 1
507 #include <vector>  // NOLINT
508 #endif
509
510 // We don't support MSVC 7.1 with exceptions disabled now.  Therefore
511 // all the compilers we care about are adequate for supporting
512 // value-parameterized tests.
513 #define GTEST_HAS_PARAM_TEST 1
514
515 // Determines whether to support type-driven tests.
516
517 // Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
518 // Sun Pro CC, and IBM Visual Age support.
519 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
520     defined(__IBMCPP__)
521 #define GTEST_HAS_TYPED_TEST 1
522 #define GTEST_HAS_TYPED_TEST_P 1
523 #endif
524
525 // Determines whether to support Combine(). This only makes sense when
526 // value-parameterized tests are enabled.  The implementation doesn't
527 // work on Sun Studio since it doesn't understand templated conversion
528 // operators.
529 #if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC)
530 #define GTEST_HAS_COMBINE 1
531 #endif
532
533 // Determines whether the system compiler uses UTF-16 for encoding wide strings.
534 #define GTEST_WIDE_STRING_USES_UTF16_ \
535     (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || GTEST_OS_AIX)
536
537 // Defines some utility macros.
538
539 // The GNU compiler emits a warning if nested "if" statements are followed by
540 // an "else" statement and braces are not used to explicitly disambiguate the
541 // "else" binding.  This leads to problems with code like:
542 //
543 //   if (gate)
544 //     ASSERT_*(condition) << "Some message";
545 //
546 // The "switch (0) case 0:" idiom is used to suppress this.
547 #ifdef __INTEL_COMPILER
548 #define GTEST_AMBIGUOUS_ELSE_BLOCKER_
549 #else
550 #define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0:  // NOLINT
551 #endif
552
553 // Use this annotation at the end of a struct/class definition to
554 // prevent the compiler from optimizing away instances that are never
555 // used.  This is useful when all interesting logic happens inside the
556 // c'tor and / or d'tor.  Example:
557 //
558 //   struct Foo {
559 //     Foo() { ... }
560 //   } GTEST_ATTRIBUTE_UNUSED_;
561 //
562 // Also use it after a variable or parameter declaration to tell the
563 // compiler the variable/parameter does not have to be used.
564 #if defined(__GNUC__) && !defined(COMPILER_ICC)
565 #define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
566 #else
567 #define GTEST_ATTRIBUTE_UNUSED_
568 #endif
569
570 // A macro to disallow operator=
571 // This should be used in the private: declarations for a class.
572 #define GTEST_DISALLOW_ASSIGN_(type)\
573   void operator=(type const &)
574
575 // A macro to disallow copy constructor and operator=
576 // This should be used in the private: declarations for a class.
577 #define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
578   type(type const &);\
579   GTEST_DISALLOW_ASSIGN_(type)
580
581 // Tell the compiler to warn about unused return values for functions declared
582 // with this macro.  The macro should be used on function declarations
583 // following the argument list:
584 //
585 //   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
586 #if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
587 #define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
588 #else
589 #define GTEST_MUST_USE_RESULT_
590 #endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
591
592 // Determine whether the compiler supports Microsoft's Structured Exception
593 // Handling.  This is supported by several Windows compilers but generally
594 // does not exist on any other system.
595 #ifndef GTEST_HAS_SEH
596 // The user didn't tell us, so we need to figure it out.
597
598 #if defined(_MSC_VER) || defined(__BORLANDC__)
599 // These two compilers are known to support SEH.
600 #define GTEST_HAS_SEH 1
601 #else
602 // Assume no SEH.
603 #define GTEST_HAS_SEH 0
604 #endif
605
606 #endif  // GTEST_HAS_SEH
607
608 #ifdef _MSC_VER
609
610 #if GTEST_LINKED_AS_SHARED_LIBRARY
611 #define GTEST_API_ __declspec(dllimport)
612 #elif GTEST_CREATE_SHARED_LIBRARY
613 #define GTEST_API_ __declspec(dllexport)
614 #endif
615
616 #endif  // _MSC_VER
617
618 #ifndef GTEST_API_
619 #define GTEST_API_
620 #endif
621
622 namespace testing {
623
624 class Message;
625
626 namespace internal {
627
628 class String;
629
630 class StrStream : public ::std::stringstream {
631  public:
632   void* operator new(size_t, void* p) { return p; }
633   void* operator new[](size_t, void* p) { return p; }
634
635   void* operator new(size_t size) {
636     return malloc(size);
637   }
638
639   void operator delete(void* p) {
640     free(p);
641   }
642
643   void* operator new[](size_t size) {
644     return malloc(size);
645   }
646
647   void operator delete[](void* p) {
648     free(p);
649   }
650 };
651
652
653
654 // A helper for suppressing warnings on constant condition.  It just
655 // returns 'condition'.
656 GTEST_API_ bool IsTrue(bool condition);
657
658 // Defines scoped_ptr.
659
660 // This implementation of scoped_ptr is PARTIAL - it only contains
661 // enough stuff to satisfy Google Test's need.
662 template <typename T>
663 class scoped_ptr {
664  public:
665   typedef T element_type;
666
667   explicit scoped_ptr(T* p = NULL) : ptr_(p) {}
668   ~scoped_ptr() { reset(); }
669
670   T& operator*() const { return *ptr_; }
671   T* operator->() const { return ptr_; }
672   T* get() const { return ptr_; }
673
674   T* release() {
675     T* const ptr = ptr_;
676     ptr_ = NULL;
677     return ptr;
678   }
679
680   void reset(T* p = NULL) {
681     if (p != ptr_) {
682       if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
683         delete ptr_;
684       }
685       ptr_ = p;
686     }
687   }
688  private:
689   T* ptr_;
690
691   GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
692 };
693
694 // Defines RE.
695
696 // A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
697 // Regular Expression syntax.
698 class GTEST_API_ RE {
699  public:
700   // A copy constructor is required by the Standard to initialize object
701   // references from r-values.
702   RE(const RE& other) { Init(other.pattern()); }
703
704   // Constructs an RE from a string.
705   RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT
706
707 #if GTEST_HAS_GLOBAL_STRING
708   RE(const ::string& regex) { Init(regex.c_str()); }  // NOLINT
709 #endif  // GTEST_HAS_GLOBAL_STRING
710
711   RE(const char* regex) { Init(regex); }  // NOLINT
712   ~RE();
713
714   // Returns the string representation of the regex.
715   const char* pattern() const { return pattern_; }
716
717   // FullMatch(str, re) returns true iff regular expression re matches
718   // the entire str.
719   // PartialMatch(str, re) returns true iff regular expression re
720   // matches a substring of str (including str itself).
721   //
722   // TODO(wan@google.com): make FullMatch() and PartialMatch() work
723   // when str contains NUL characters.
724   static bool FullMatch(const ::std::string& str, const RE& re) {
725     return FullMatch(str.c_str(), re);
726   }
727   static bool PartialMatch(const ::std::string& str, const RE& re) {
728     return PartialMatch(str.c_str(), re);
729   }
730
731 #if GTEST_HAS_GLOBAL_STRING
732   static bool FullMatch(const ::string& str, const RE& re) {
733     return FullMatch(str.c_str(), re);
734   }
735   static bool PartialMatch(const ::string& str, const RE& re) {
736     return PartialMatch(str.c_str(), re);
737   }
738 #endif  // GTEST_HAS_GLOBAL_STRING
739
740   static bool FullMatch(const char* str, const RE& re);
741   static bool PartialMatch(const char* str, const RE& re);
742
743  private:
744   void Init(const char* regex);
745
746   // We use a const char* instead of a string, as Google Test may be used
747   // where string is not available.  We also do not use Google Test's own
748   // String type here, in order to simplify dependencies between the
749   // files.
750   const char* pattern_;
751   bool is_valid_;
752 #if GTEST_USES_POSIX_RE
753   regex_t full_regex_;     // For FullMatch().
754   regex_t partial_regex_;  // For PartialMatch().
755 #else  // GTEST_USES_SIMPLE_RE
756   const char* full_pattern_;  // For FullMatch();
757 #endif
758
759   GTEST_DISALLOW_ASSIGN_(RE);
760 };
761
762 // Defines logging utilities:
763 //   GTEST_LOG_(severity) - logs messages at the specified severity level. The
764 //                          message itself is streamed into the macro.
765 //   LogToStderr()  - directs all log messages to stderr.
766 //   FlushInfoLog() - flushes informational log messages.
767
768 enum GTestLogSeverity {
769   GTEST_INFO,
770   GTEST_WARNING,
771   GTEST_ERROR,
772   GTEST_FATAL
773 };
774
775 // Formats log entry severity, provides a stream object for streaming the
776 // log message, and terminates the message with a newline when going out of
777 // scope.
778 class GTEST_API_ GTestLog {
779  public:
780   GTestLog(GTestLogSeverity severity, const char* file, int line);
781
782   // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
783   ~GTestLog();
784
785   ::std::ostream& GetStream() { return ::std::cerr; }
786
787  private:
788   const GTestLogSeverity severity_;
789
790   GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestLog);
791 };
792
793 #define GTEST_LOG_(severity) \
794     ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
795                                   __FILE__, __LINE__).GetStream()
796
797 inline void LogToStderr() {}
798 inline void FlushInfoLog() { fflush(NULL); }
799
800 // INTERNAL IMPLEMENTATION - DO NOT USE.
801 //
802 // GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition
803 // is not satisfied.
804 //  Synopsys:
805 //    GTEST_CHECK_(boolean_condition);
806 //     or
807 //    GTEST_CHECK_(boolean_condition) << "Additional message";
808 //
809 //    This checks the condition and if the condition is not satisfied
810 //    it prints message about the condition violation, including the
811 //    condition itself, plus additional message streamed into it, if any,
812 //    and then it aborts the program. It aborts the program irrespective of
813 //    whether it is built in the debug mode or not.
814 #define GTEST_CHECK_(condition) \
815     GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
816     if (::testing::internal::IsTrue(condition)) \
817       ; \
818     else \
819       GTEST_LOG_(FATAL) << "Condition " #condition " failed. "
820
821 // An all-mode assert to verify that the given POSIX-style function
822 // call returns 0 (indicating success).  Known limitation: this
823 // doesn't expand to a balanced 'if' statement, so enclose the macro
824 // in {} if you need to use it as the only statement in an 'if'
825 // branch.
826 #define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \
827   if (const int gtest_error = (posix_call)) \
828     GTEST_LOG_(FATAL) << #posix_call << "failed with error " \
829                       << gtest_error
830
831 // INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
832 //
833 // Downcasts the pointer of type Base to Derived.
834 // Derived must be a subclass of Base. The parameter MUST
835 // point to a class of type Derived, not any subclass of it.
836 // When RTTI is available, the function performs a runtime
837 // check to enforce this.
838 template <class Derived, class Base>
839 Derived* CheckedDowncastToActualType(Base* base) {
840 #if GTEST_HAS_RTTI
841   GTEST_CHECK_(typeid(*base) == typeid(Derived));
842   return dynamic_cast<Derived*>(base);  // NOLINT
843 #else
844   return static_cast<Derived*>(base);  // Poor man's downcast.
845 #endif
846 }
847
848 #if GTEST_HAS_STREAM_REDIRECTION_
849
850 // Defines the stderr capturer:
851 //   CaptureStdout     - starts capturing stdout.
852 //   GetCapturedStdout - stops capturing stdout and returns the captured string.
853 //   CaptureStderr     - starts capturing stderr.
854 //   GetCapturedStderr - stops capturing stderr and returns the captured string.
855 //
856 GTEST_API_ void CaptureStdout();
857 GTEST_API_ String GetCapturedStdout();
858 GTEST_API_ void CaptureStderr();
859 GTEST_API_ String GetCapturedStderr();
860
861 #endif  // GTEST_HAS_STREAM_REDIRECTION_
862
863
864 #if GTEST_HAS_DEATH_TEST
865
866 // A copy of all command line arguments.  Set by InitGoogleTest().
867 extern ::std::vector<String> g_argvs;
868
869 // GTEST_HAS_DEATH_TEST implies we have ::std::string.
870 const ::std::vector<String>& GetArgvs();
871
872 #endif  // GTEST_HAS_DEATH_TEST
873
874 // Defines synchronization primitives.
875
876 #if GTEST_HAS_PTHREAD
877
878 // Sleeps for (roughly) n milli-seconds.  This function is only for
879 // testing Google Test's own constructs.  Don't use it in user tests,
880 // either directly or indirectly.
881 inline void SleepMilliseconds(int n) {
882   const timespec time = {
883     0,                  // 0 seconds.
884     n * 1000L * 1000L,  // And n ms.
885   };
886   nanosleep(&time, NULL);
887 }
888
889 // Allows a controller thread to pause execution of newly created
890 // threads until notified.  Instances of this class must be created
891 // and destroyed in the controller thread.
892 //
893 // This class is only for testing Google Test's own constructs. Do not
894 // use it in user tests, either directly or indirectly.
895 class Notification {
896  public:
897   Notification() : notified_(false) {}
898
899   // Notifies all threads created with this notification to start. Must
900   // be called from the controller thread.
901   void Notify() { notified_ = true; }
902
903   // Blocks until the controller thread notifies. Must be called from a test
904   // thread.
905   void WaitForNotification() {
906     while(!notified_) {
907       SleepMilliseconds(10);
908     }
909   }
910
911  private:
912   volatile bool notified_;
913
914   GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
915 };
916
917 // As a C-function, ThreadFuncWithCLinkage cannot be templated itself.
918 // Consequently, it cannot select a correct instantiation of ThreadWithParam
919 // in order to call its Run(). Introducing ThreadWithParamBase as a
920 // non-templated base class for ThreadWithParam allows us to bypass this
921 // problem.
922 class ThreadWithParamBase {
923  public:
924   virtual ~ThreadWithParamBase() {}
925   virtual void Run() = 0;
926 };
927
928 // pthread_create() accepts a pointer to a function type with the C linkage.
929 // According to the Standard (7.5/1), function types with different linkages
930 // are different even if they are otherwise identical.  Some compilers (for
931 // example, SunStudio) treat them as different types.  Since class methods
932 // cannot be defined with C-linkage we need to define a free C-function to
933 // pass into pthread_create().
934 extern "C" inline void* ThreadFuncWithCLinkage(void* thread) {
935   static_cast<ThreadWithParamBase*>(thread)->Run();
936   return NULL;
937 }
938
939 // Helper class for testing Google Test's multi-threading constructs.
940 // To use it, write:
941 //
942 //   void ThreadFunc(int param) { /* Do things with param */ }
943 //   Notification thread_can_start;
944 //   ...
945 //   // The thread_can_start parameter is optional; you can supply NULL.
946 //   ThreadWithParam<int> thread(&ThreadFunc, 5, &thread_can_start);
947 //   thread_can_start.Notify();
948 //
949 // These classes are only for testing Google Test's own constructs. Do
950 // not use them in user tests, either directly or indirectly.
951 template <typename T>
952 class ThreadWithParam : public ThreadWithParamBase {
953  public:
954   typedef void (*UserThreadFunc)(T);
955
956   ThreadWithParam(
957       UserThreadFunc func, T param, Notification* thread_can_start)
958       : func_(func),
959         param_(param),
960         thread_can_start_(thread_can_start),
961         finished_(false) {
962     ThreadWithParamBase* const base = this;
963     // The thread can be created only after all fields except thread_
964     // have been initialized.
965     GTEST_CHECK_POSIX_SUCCESS_(
966         pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
967   }
968   ~ThreadWithParam() { Join(); }
969
970   void Join() {
971     if (!finished_) {
972       GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
973       finished_ = true;
974     }
975   }
976
977   virtual void Run() {
978     if (thread_can_start_ != NULL)
979       thread_can_start_->WaitForNotification();
980     func_(param_);
981   }
982
983  private:
984   const UserThreadFunc func_;  // User-supplied thread function.
985   const T param_;  // User-supplied parameter to the thread function.
986   // When non-NULL, used to block execution until the controller thread
987   // notifies.
988   Notification* const thread_can_start_;
989   bool finished_;  // true iff we know that the thread function has finished.
990   pthread_t thread_;  // The native thread object.
991
992   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
993 };
994
995 // gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
996 // true.
997 #include <pthread.h>
998
999 // MutexBase and Mutex implement mutex on pthreads-based platforms. They
1000 // are used in conjunction with class MutexLock:
1001 //
1002 //   Mutex mutex;
1003 //   ...
1004 //   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the end
1005 //                            // of the current scope.
1006 //
1007 // MutexBase implements behavior for both statically and dynamically
1008 // allocated mutexes.  Do not use MutexBase directly.  Instead, write
1009 // the following to define a static mutex:
1010 //
1011 //   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1012 //
1013 // You can forward declare a static mutex like this:
1014 //
1015 //   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
1016 //
1017 // To create a dynamic mutex, just define an object of type Mutex.
1018 class MutexBase {
1019  public:
1020   // Acquires this mutex.
1021   void Lock() {
1022     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
1023     owner_ = pthread_self();
1024   }
1025
1026   // Releases this mutex.
1027   void Unlock() {
1028     // We don't protect writing to owner_ here, as it's the caller's
1029     // responsibility to ensure that the current thread holds the
1030     // mutex when this is called.
1031     owner_ = 0;
1032     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
1033   }
1034
1035   // Does nothing if the current thread holds the mutex. Otherwise, crashes
1036   // with high probability.
1037   void AssertHeld() const {
1038     GTEST_CHECK_(owner_ == pthread_self())
1039         << "The current thread is not holding the mutex @" << this;
1040   }
1041
1042   // A static mutex may be used before main() is entered.  It may even
1043   // be used before the dynamic initialization stage.  Therefore we
1044   // must be able to initialize a static mutex object at link time.
1045   // This means MutexBase has to be a POD and its member variables
1046   // have to be public.
1047  public:
1048   pthread_mutex_t mutex_;  // The underlying pthread mutex.
1049   pthread_t owner_;  // The thread holding the mutex; 0 means no one holds it.
1050 };
1051
1052 // Forward-declares a static mutex.
1053 #define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1054     extern ::testing::internal::MutexBase mutex
1055
1056 // Defines and statically (i.e. at link time) initializes a static mutex.
1057 #define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1058     ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, 0 }
1059
1060 // The Mutex class can only be used for mutexes created at runtime. It
1061 // shares its API with MutexBase otherwise.
1062 class Mutex : public MutexBase {
1063  public:
1064   Mutex() {
1065     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
1066     owner_ = 0;
1067   }
1068   ~Mutex() {
1069     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
1070   }
1071
1072  private:
1073   GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
1074 };
1075
1076 // We cannot name this class MutexLock as the ctor declaration would
1077 // conflict with a macro named MutexLock, which is defined on some
1078 // platforms.  Hence the typedef trick below.
1079 class GTestMutexLock {
1080  public:
1081   explicit GTestMutexLock(MutexBase* mutex)
1082       : mutex_(mutex) { mutex_->Lock(); }
1083
1084   ~GTestMutexLock() { mutex_->Unlock(); }
1085
1086  private:
1087   MutexBase* const mutex_;
1088
1089   GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
1090 };
1091
1092 typedef GTestMutexLock MutexLock;
1093
1094 // Helpers for ThreadLocal.
1095
1096 // pthread_key_create() requires DeleteThreadLocalValue() to have
1097 // C-linkage.  Therefore it cannot be templatized to access
1098 // ThreadLocal<T>.  Hence the need for class
1099 // ThreadLocalValueHolderBase.
1100 class ThreadLocalValueHolderBase {
1101  public:
1102   virtual ~ThreadLocalValueHolderBase() {}
1103 };
1104
1105 // Called by pthread to delete thread-local data stored by
1106 // pthread_setspecific().
1107 extern "C" inline void DeleteThreadLocalValue(void* value_holder) {
1108   delete static_cast<ThreadLocalValueHolderBase*>(value_holder);
1109 }
1110
1111 // Implements thread-local storage on pthreads-based systems.
1112 //
1113 //   // Thread 1
1114 //   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1115 //
1116 //   // Thread 2
1117 //   tl.set(150);  // Changes the value for thread 2 only.
1118 //   EXPECT_EQ(150, tl.get());
1119 //
1120 //   // Thread 1
1121 //   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
1122 //   tl.set(200);
1123 //   EXPECT_EQ(200, tl.get());
1124 //
1125 // The template type argument T must have a public copy constructor.
1126 // In addition, the default ThreadLocal constructor requires T to have
1127 // a public default constructor.
1128 //
1129 // An object managed for a thread by a ThreadLocal instance is deleted
1130 // when the thread exits.  Or, if the ThreadLocal instance dies in
1131 // that thread, when the ThreadLocal dies.  It's the user's
1132 // responsibility to ensure that all other threads using a ThreadLocal
1133 // have exited when it dies, or the per-thread objects for those
1134 // threads will not be deleted.
1135 //
1136 // Google Test only uses global ThreadLocal objects.  That means they
1137 // will die after main() has returned.  Therefore, no per-thread
1138 // object managed by Google Test will be leaked as long as all threads
1139 // using Google Test have exited when main() returns.
1140 template <typename T>
1141 class ThreadLocal {
1142  public:
1143   ThreadLocal() : key_(CreateKey()),
1144                   default_() {}
1145   explicit ThreadLocal(const T& value) : key_(CreateKey()),
1146                                          default_(value) {}
1147
1148   ~ThreadLocal() {
1149     // Destroys the managed object for the current thread, if any.
1150     DeleteThreadLocalValue(pthread_getspecific(key_));
1151
1152     // Releases resources associated with the key.  This will *not*
1153     // delete managed objects for other threads.
1154     GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
1155   }
1156
1157   T* pointer() { return GetOrCreateValue(); }
1158   const T* pointer() const { return GetOrCreateValue(); }
1159   const T& get() const { return *pointer(); }
1160   void set(const T& value) { *pointer() = value; }
1161
1162  private:
1163   // Holds a value of type T.
1164   class ValueHolder : public ThreadLocalValueHolderBase {
1165    public:
1166     explicit ValueHolder(const T& value) : value_(value) {}
1167
1168     T* pointer() { return &value_; }
1169
1170    private:
1171     T value_;
1172     GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
1173   };
1174
1175   static pthread_key_t CreateKey() {
1176     pthread_key_t key;
1177     // When a thread exits, DeleteThreadLocalValue() will be called on
1178     // the object managed for that thread.
1179     GTEST_CHECK_POSIX_SUCCESS_(
1180         pthread_key_create(&key, &DeleteThreadLocalValue));
1181     return key;
1182   }
1183
1184   T* GetOrCreateValue() const {
1185     ThreadLocalValueHolderBase* const holder =
1186         static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
1187     if (holder != NULL) {
1188       return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
1189     }
1190
1191     ValueHolder* const new_holder = new ValueHolder(default_);
1192     ThreadLocalValueHolderBase* const holder_base = new_holder;
1193     GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
1194     return new_holder->pointer();
1195   }
1196
1197   // A key pthreads uses for looking up per-thread values.
1198   const pthread_key_t key_;
1199   const T default_;  // The default value for each thread.
1200
1201   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
1202 };
1203
1204 #define GTEST_IS_THREADSAFE 1
1205
1206 #else  // GTEST_HAS_PTHREAD
1207
1208 // A dummy implementation of synchronization primitives (mutex, lock,
1209 // and thread-local variable).  Necessary for compiling Google Test where
1210 // mutex is not supported - using Google Test in multiple threads is not
1211 // supported on such platforms.
1212
1213 class Mutex {
1214  public:
1215   Mutex() {}
1216   void AssertHeld() const {}
1217 };
1218
1219 #define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1220   extern ::testing::internal::Mutex mutex
1221
1222 #define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
1223
1224 class GTestMutexLock {
1225  public:
1226   explicit GTestMutexLock(Mutex*) {}  // NOLINT
1227 };
1228
1229 typedef GTestMutexLock MutexLock;
1230
1231 template <typename T>
1232 class ThreadLocal {
1233  public:
1234   ThreadLocal() : value_() {}
1235   explicit ThreadLocal(const T& value) : value_(value) {}
1236   T* pointer() { return &value_; }
1237   const T* pointer() const { return &value_; }
1238   const T& get() const { return value_; }
1239   void set(const T& value) { value_ = value; }
1240  private:
1241   T value_;
1242 };
1243
1244 // The above synchronization primitives have dummy implementations.
1245 // Therefore Google Test is not thread-safe.
1246 #define GTEST_IS_THREADSAFE 0
1247
1248 #endif  // GTEST_HAS_PTHREAD
1249
1250 // Returns the number of threads running in the process, or 0 to indicate that
1251 // we cannot detect it.
1252 GTEST_API_ size_t GetThreadCount();
1253
1254 // Passing non-POD classes through ellipsis (...) crashes the ARM
1255 // compiler and generates a warning in Sun Studio.  The Nokia Symbian
1256 // and the IBM XL C/C++ compiler try to instantiate a copy constructor
1257 // for objects passed through ellipsis (...), failing for uncopyable
1258 // objects.  We define this to ensure that only POD is passed through
1259 // ellipsis on these systems.
1260 #if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC)
1261 // We lose support for NULL detection where the compiler doesn't like
1262 // passing non-POD classes through ellipsis (...).
1263 #define GTEST_ELLIPSIS_NEEDS_POD_ 1
1264 #else
1265 #define GTEST_CAN_COMPARE_NULL 1
1266 #endif
1267
1268 // The Nokia Symbian and IBM XL C/C++ compilers cannot decide between
1269 // const T& and const T* in a function template.  These compilers
1270 // _can_ decide between class template specializations for T and T*,
1271 // so a tr1::type_traits-like is_pointer works.
1272 #if defined(__SYMBIAN32__) || defined(__IBMCPP__)
1273 #define GTEST_NEEDS_IS_POINTER_ 1
1274 #endif
1275
1276 template <bool bool_value>
1277 struct bool_constant {
1278   typedef bool_constant<bool_value> type;
1279   static const bool value = bool_value;
1280 };
1281 template <bool bool_value> const bool bool_constant<bool_value>::value;
1282
1283 typedef bool_constant<false> false_type;
1284 typedef bool_constant<true> true_type;
1285
1286 template <typename T>
1287 struct is_pointer : public false_type {};
1288
1289 template <typename T>
1290 struct is_pointer<T*> : public true_type {};
1291
1292 #if GTEST_OS_WINDOWS
1293 #define GTEST_PATH_SEP_ "\\"
1294 #define GTEST_HAS_ALT_PATH_SEP_ 1
1295 // The biggest signed integer type the compiler supports.
1296 typedef __int64 BiggestInt;
1297 #else
1298 #define GTEST_PATH_SEP_ "/"
1299 #define GTEST_HAS_ALT_PATH_SEP_ 0
1300 typedef long long BiggestInt;  // NOLINT
1301 #endif  // GTEST_OS_WINDOWS
1302
1303 // The testing::internal::posix namespace holds wrappers for common
1304 // POSIX functions.  These wrappers hide the differences between
1305 // Windows/MSVC and POSIX systems.  Since some compilers define these
1306 // standard functions as macros, the wrapper cannot have the same name
1307 // as the wrapped function.
1308
1309 namespace posix {
1310
1311 // Functions with a different name on Windows.
1312
1313 #if GTEST_OS_WINDOWS
1314
1315 typedef struct _stat StatStruct;
1316
1317 #ifdef __BORLANDC__
1318 inline int IsATTY(int fd) { return isatty(fd); }
1319 inline int StrCaseCmp(const char* s1, const char* s2) {
1320   return stricmp(s1, s2);
1321 }
1322 inline char* StrDup(const char* src) { return strdup(src); }
1323 #else  // !__BORLANDC__
1324 #if GTEST_OS_WINDOWS_MOBILE
1325 inline int IsATTY(int /* fd */) { return 0; }
1326 #else
1327 inline int IsATTY(int fd) { return _isatty(fd); }
1328 #endif  // GTEST_OS_WINDOWS_MOBILE
1329 inline int StrCaseCmp(const char* s1, const char* s2) {
1330   return _stricmp(s1, s2);
1331 }
1332 inline char* StrDup(const char* src) { return _strdup(src); }
1333 #endif  // __BORLANDC__
1334
1335 #if GTEST_OS_WINDOWS_MOBILE
1336 inline int FileNo(FILE* file) { return reinterpret_cast<int>(_fileno(file)); }
1337 // Stat(), RmDir(), and IsDir() are not needed on Windows CE at this
1338 // time and thus not defined there.
1339 #else
1340 inline int FileNo(FILE* file) { return _fileno(file); }
1341 inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
1342 inline int RmDir(const char* dir) { return _rmdir(dir); }
1343 inline bool IsDir(const StatStruct& st) {
1344   return (_S_IFDIR & st.st_mode) != 0;
1345 }
1346 #endif  // GTEST_OS_WINDOWS_MOBILE
1347
1348 #else
1349
1350 typedef struct stat StatStruct;
1351
1352 inline int FileNo(FILE* file) { return fileno(file); }
1353 inline int IsATTY(int fd) { return isatty(fd); }
1354 inline int Stat(const char* path, StatStruct* buf) { return stat(path, buf); }
1355 inline int StrCaseCmp(const char* s1, const char* s2) {
1356   return strcasecmp(s1, s2);
1357 }
1358 inline char* StrDup(const char* src) { return strdup(src); }
1359 inline int RmDir(const char* dir) { return rmdir(dir); }
1360 inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
1361
1362 #endif  // GTEST_OS_WINDOWS
1363
1364 // Functions deprecated by MSVC 8.0.
1365
1366 #ifdef _MSC_VER
1367 // Temporarily disable warning 4996 (deprecated function).
1368 #pragma warning(push)
1369 #pragma warning(disable:4996)
1370 #endif
1371
1372 inline const char* StrNCpy(char* dest, const char* src, size_t n) {
1373   return strncpy(dest, src, n);
1374 }
1375
1376 // ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and
1377 // StrError() aren't needed on Windows CE at this time and thus not
1378 // defined there.
1379
1380 #if !GTEST_OS_WINDOWS_MOBILE
1381 inline int ChDir(const char* dir) { return chdir(dir); }
1382 #endif
1383 inline FILE* FOpen(const char* path, const char* mode) {
1384   return fopen(path, mode);
1385 }
1386 #if !GTEST_OS_WINDOWS_MOBILE
1387 inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
1388   return freopen(path, mode, stream);
1389 }
1390 inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
1391 #endif
1392 inline int FClose(FILE* fp) { return fclose(fp); }
1393 #if !GTEST_OS_WINDOWS_MOBILE
1394 inline int Read(int fd, void* buf, unsigned int count) {
1395   return static_cast<int>(read(fd, buf, count));
1396 }
1397 inline int Write(int fd, const void* buf, unsigned int count) {
1398   return static_cast<int>(write(fd, buf, count));
1399 }
1400 inline int Close(int fd) { return close(fd); }
1401 inline const char* StrError(int errnum) { return strerror(errnum); }
1402 #endif
1403 inline const char* GetEnv(const char* name) {
1404 #if GTEST_OS_WINDOWS_MOBILE
1405   // We are on Windows CE, which has no environment variables.
1406   return NULL;
1407 #elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
1408   // Environment variables which we programmatically clear will be set to the
1409   // empty string rather than unset (NULL).  Handle that case.
1410   const char* const env = getenv(name);
1411   return (env != NULL && env[0] != '\0') ? env : NULL;
1412 #else
1413   return getenv(name);
1414 #endif
1415 }
1416
1417 #ifdef _MSC_VER
1418 #pragma warning(pop)  // Restores the warning state.
1419 #endif
1420
1421 #if GTEST_OS_WINDOWS_MOBILE
1422 // Windows CE has no C library. The abort() function is used in
1423 // several places in Google Test. This implementation provides a reasonable
1424 // imitation of standard behaviour.
1425 void Abort();
1426 #else
1427 inline void Abort() { abort(); }
1428 #endif  // GTEST_OS_WINDOWS_MOBILE
1429
1430 }  // namespace posix
1431
1432 // The maximum number a BiggestInt can represent.  This definition
1433 // works no matter BiggestInt is represented in one's complement or
1434 // two's complement.
1435 //
1436 // We cannot rely on numeric_limits in STL, as __int64 and long long
1437 // are not part of standard C++ and numeric_limits doesn't need to be
1438 // defined for them.
1439 const BiggestInt kMaxBiggestInt =
1440     ~(static_cast<BiggestInt>(1) << (8*sizeof(BiggestInt) - 1));
1441
1442 // This template class serves as a compile-time function from size to
1443 // type.  It maps a size in bytes to a primitive type with that
1444 // size. e.g.
1445 //
1446 //   TypeWithSize<4>::UInt
1447 //
1448 // is typedef-ed to be unsigned int (unsigned integer made up of 4
1449 // bytes).
1450 //
1451 // Such functionality should belong to STL, but I cannot find it
1452 // there.
1453 //
1454 // Google Test uses this class in the implementation of floating-point
1455 // comparison.
1456 //
1457 // For now it only handles UInt (unsigned int) as that's all Google Test
1458 // needs.  Other types can be easily added in the future if need
1459 // arises.
1460 template <size_t size>
1461 class TypeWithSize {
1462  public:
1463   // This prevents the user from using TypeWithSize<N> with incorrect
1464   // values of N.
1465   typedef void UInt;
1466 };
1467
1468 // The specialization for size 4.
1469 template <>
1470 class TypeWithSize<4> {
1471  public:
1472   // unsigned int has size 4 in both gcc and MSVC.
1473   //
1474   // As base/basictypes.h doesn't compile on Windows, we cannot use
1475   // uint32, uint64, and etc here.
1476   typedef int Int;
1477   typedef unsigned int UInt;
1478 };
1479
1480 // The specialization for size 8.
1481 template <>
1482 class TypeWithSize<8> {
1483  public:
1484 #if GTEST_OS_WINDOWS
1485   typedef __int64 Int;
1486   typedef unsigned __int64 UInt;
1487 #else
1488   typedef long long Int;  // NOLINT
1489   typedef unsigned long long UInt;  // NOLINT
1490 #endif  // GTEST_OS_WINDOWS
1491 };
1492
1493 // Integer types of known sizes.
1494 typedef TypeWithSize<4>::Int Int32;
1495 typedef TypeWithSize<4>::UInt UInt32;
1496 typedef TypeWithSize<8>::Int Int64;
1497 typedef TypeWithSize<8>::UInt UInt64;
1498 typedef TypeWithSize<8>::Int TimeInMillis;  // Represents time in milliseconds.
1499
1500 // Utilities for command line flags and environment variables.
1501
1502 // Macro for referencing flags.
1503 #define GTEST_FLAG(name) FLAGS_gtest_##name
1504
1505 // Macros for declaring flags.
1506 #define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
1507 #define GTEST_DECLARE_int32_(name) \
1508     GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
1509 #define GTEST_DECLARE_string_(name) \
1510     GTEST_API_ extern ::testing::internal::String GTEST_FLAG(name)
1511
1512 // Macros for defining flags.
1513 #define GTEST_DEFINE_bool_(name, default_val, doc) \
1514     GTEST_API_ bool GTEST_FLAG(name) = (default_val)
1515 #define GTEST_DEFINE_int32_(name, default_val, doc) \
1516     GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
1517 #define GTEST_DEFINE_string_(name, default_val, doc) \
1518     GTEST_API_ ::testing::internal::String GTEST_FLAG(name) = (default_val)
1519
1520 // Parses 'str' for a 32-bit signed integer.  If successful, writes the result
1521 // to *value and returns true; otherwise leaves *value unchanged and returns
1522 // false.
1523 // TODO(chandlerc): Find a better way to refactor flag and environment parsing
1524 // out of both gtest-port.cc and gtest.cc to avoid exporting this utility
1525 // function.
1526 bool ParseInt32(const Message& src_text, const char* str, Int32* value);
1527
1528 // Parses a bool/Int32/string from the environment variable
1529 // corresponding to the given Google Test flag.
1530 bool BoolFromGTestEnv(const char* flag, bool default_val);
1531 GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
1532 const char* StringFromGTestEnv(const char* flag, const char* default_val);
1533
1534 }  // namespace internal
1535 }  // namespace testing
1536
1537 #endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_