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