Gtests: Re-apply strict compiler fixes
[blender.git] / extern / 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.  All macros ending with _ and symbols defined in an
34 // internal namespace are subject to change without notice.  Code
35 // outside Google Test MUST NOT USE THEM DIRECTLY.  Macros that don't
36 // end with _ are part of Google Test's public API and can be used by
37 // code outside Google Test.
38 //
39 // This file is fundamental to Google Test.  All other Google Test source
40 // files are expected to #include this.  Therefore, it cannot #include
41 // any other Google Test header.
42
43 #ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
44 #define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
45
46 // Environment-describing macros
47 // -----------------------------
48 //
49 // Google Test can be used in many different environments.  Macros in
50 // this section tell Google Test what kind of environment it is being
51 // used in, such that Google Test can provide environment-specific
52 // features and implementations.
53 //
54 // Google Test tries to automatically detect the properties of its
55 // environment, so users usually don't need to worry about these
56 // macros.  However, the automatic detection is not perfect.
57 // Sometimes it's necessary for a user to define some of the following
58 // macros in the build script to override Google Test's decisions.
59 //
60 // If the user doesn't define a macro in the list, Google Test will
61 // provide a default definition.  After this header is #included, all
62 // macros in this list will be defined to either 1 or 0.
63 //
64 // Notes to maintainers:
65 //   - Each macro here is a user-tweakable knob; do not grow the list
66 //     lightly.
67 //   - Use #if to key off these macros.  Don't use #ifdef or "#if
68 //     defined(...)", which will not work as these macros are ALWAYS
69 //     defined.
70 //
71 //   GTEST_HAS_CLONE          - Define it to 1/0 to indicate that clone(2)
72 //                              is/isn't available.
73 //   GTEST_HAS_EXCEPTIONS     - Define it to 1/0 to indicate that exceptions
74 //                              are enabled.
75 //   GTEST_HAS_GLOBAL_STRING  - Define it to 1/0 to indicate that ::string
76 //                              is/isn't available (some systems define
77 //                              ::string, which is different to std::string).
78 //   GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string
79 //                              is/isn't available (some systems define
80 //                              ::wstring, which is different to std::wstring).
81 //   GTEST_HAS_POSIX_RE       - Define it to 1/0 to indicate that POSIX regular
82 //                              expressions are/aren't available.
83 //   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that <pthread.h>
84 //                              is/isn't available.
85 //   GTEST_HAS_RTTI           - Define it to 1/0 to indicate that RTTI is/isn't
86 //                              enabled.
87 //   GTEST_HAS_STD_WSTRING    - Define it to 1/0 to indicate that
88 //                              std::wstring does/doesn't work (Google Test can
89 //                              be used where std::wstring is unavailable).
90 //   GTEST_HAS_TR1_TUPLE      - Define it to 1/0 to indicate tr1::tuple
91 //                              is/isn't available.
92 //   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
93 //                              compiler supports Microsoft's "Structured
94 //                              Exception Handling".
95 //   GTEST_HAS_STREAM_REDIRECTION
96 //                            - Define it to 1/0 to indicate whether the
97 //                              platform supports I/O stream redirection using
98 //                              dup() and dup2().
99 //   GTEST_USE_OWN_TR1_TUPLE  - Define it to 1/0 to indicate whether Google
100 //                              Test's own tr1 tuple implementation should be
101 //                              used.  Unused when the user sets
102 //                              GTEST_HAS_TR1_TUPLE to 0.
103 //   GTEST_LANG_CXX11         - Define it to 1/0 to indicate that Google Test
104 //                              is building in C++11/C++98 mode.
105 //   GTEST_LINKED_AS_SHARED_LIBRARY
106 //                            - Define to 1 when compiling tests that use
107 //                              Google Test as a shared library (known as
108 //                              DLL on Windows).
109 //   GTEST_CREATE_SHARED_LIBRARY
110 //                            - Define to 1 when compiling Google Test itself
111 //                              as a shared library.
112
113 // Platform-indicating macros
114 // --------------------------
115 //
116 // Macros indicating the platform on which Google Test is being used
117 // (a macro is defined to 1 if compiled on the given platform;
118 // otherwise UNDEFINED -- it's never defined to 0.).  Google Test
119 // defines these macros automatically.  Code outside Google Test MUST
120 // NOT define them.
121 //
122 //   GTEST_OS_AIX      - IBM AIX
123 //   GTEST_OS_CYGWIN   - Cygwin
124 //   GTEST_OS_FREEBSD  - FreeBSD
125 //   GTEST_OS_HPUX     - HP-UX
126 //   GTEST_OS_LINUX    - Linux
127 //     GTEST_OS_LINUX_ANDROID - Google Android
128 //   GTEST_OS_MAC      - Mac OS X
129 //     GTEST_OS_IOS    - iOS
130 //   GTEST_OS_NACL     - Google Native Client (NaCl)
131 //   GTEST_OS_OPENBSD  - OpenBSD
132 //   GTEST_OS_QNX      - QNX
133 //   GTEST_OS_SOLARIS  - Sun Solaris
134 //   GTEST_OS_SYMBIAN  - Symbian
135 //   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
136 //     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
137 //     GTEST_OS_WINDOWS_MINGW    - MinGW
138 //     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
139 //     GTEST_OS_WINDOWS_PHONE    - Windows Phone
140 //     GTEST_OS_WINDOWS_RT       - Windows Store App/WinRT
141 //   GTEST_OS_ZOS      - z/OS
142 //
143 // Among the platforms, Cygwin, Linux, Max OS X, and Windows have the
144 // most stable support.  Since core members of the Google Test project
145 // don't have access to other platforms, support for them may be less
146 // stable.  If you notice any problems on your platform, please notify
147 // googletestframework@googlegroups.com (patches for fixing them are
148 // even more welcome!).
149 //
150 // It is possible that none of the GTEST_OS_* macros are defined.
151
152 // Feature-indicating macros
153 // -------------------------
154 //
155 // Macros indicating which Google Test features are available (a macro
156 // is defined to 1 if the corresponding feature is supported;
157 // otherwise UNDEFINED -- it's never defined to 0.).  Google Test
158 // defines these macros automatically.  Code outside Google Test MUST
159 // NOT define them.
160 //
161 // These macros are public so that portable tests can be written.
162 // Such tests typically surround code using a feature with an #if
163 // which controls that code.  For example:
164 //
165 // #if GTEST_HAS_DEATH_TEST
166 //   EXPECT_DEATH(DoSomethingDeadly());
167 // #endif
168 //
169 //   GTEST_HAS_COMBINE      - the Combine() function (for value-parameterized
170 //                            tests)
171 //   GTEST_HAS_DEATH_TEST   - death tests
172 //   GTEST_HAS_PARAM_TEST   - value-parameterized tests
173 //   GTEST_HAS_TYPED_TEST   - typed tests
174 //   GTEST_HAS_TYPED_TEST_P - type-parameterized tests
175 //   GTEST_IS_THREADSAFE    - Google Test is thread-safe.
176 //   GTEST_USES_POSIX_RE    - enhanced POSIX regex is used. Do not confuse with
177 //                            GTEST_HAS_POSIX_RE (see above) which users can
178 //                            define themselves.
179 //   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
180 //                            the above two are mutually exclusive.
181 //   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
182
183 // Misc public macros
184 // ------------------
185 //
186 //   GTEST_FLAG(flag_name)  - references the variable corresponding to
187 //                            the given Google Test flag.
188
189 // Internal utilities
190 // ------------------
191 //
192 // The following macros and utilities are for Google Test's INTERNAL
193 // use only.  Code outside Google Test MUST NOT USE THEM DIRECTLY.
194 //
195 // Macros for basic C++ coding:
196 //   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
197 //   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
198 //                              variable don't have to be used.
199 //   GTEST_DISALLOW_ASSIGN_   - disables operator=.
200 //   GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
201 //   GTEST_MUST_USE_RESULT_   - declares that a function's result must be used.
202 //   GTEST_INTENTIONAL_CONST_COND_PUSH_ - start code section where MSVC C4127 is
203 //                                        suppressed (constant conditional).
204 //   GTEST_INTENTIONAL_CONST_COND_POP_  - finish code section where MSVC C4127
205 //                                        is suppressed.
206 //
207 // C++11 feature wrappers:
208 //
209 //   testing::internal::move  - portability wrapper for std::move.
210 //
211 // Synchronization:
212 //   Mutex, MutexLock, ThreadLocal, GetThreadCount()
213 //                            - synchronization primitives.
214 //
215 // Template meta programming:
216 //   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
217 //   IteratorTraits - partial implementation of std::iterator_traits, which
218 //                    is not available in libCstd when compiled with Sun C++.
219 //
220 // Smart pointers:
221 //   scoped_ptr     - as in TR2.
222 //
223 // Regular expressions:
224 //   RE             - a simple regular expression class using the POSIX
225 //                    Extended Regular Expression syntax on UNIX-like
226 //                    platforms, or a reduced regular exception syntax on
227 //                    other platforms, including Windows.
228 //
229 // Logging:
230 //   GTEST_LOG_()   - logs messages at the specified severity level.
231 //   LogToStderr()  - directs all log messages to stderr.
232 //   FlushInfoLog() - flushes informational log messages.
233 //
234 // Stdout and stderr capturing:
235 //   CaptureStdout()     - starts capturing stdout.
236 //   GetCapturedStdout() - stops capturing stdout and returns the captured
237 //                         string.
238 //   CaptureStderr()     - starts capturing stderr.
239 //   GetCapturedStderr() - stops capturing stderr and returns the captured
240 //                         string.
241 //
242 // Integer types:
243 //   TypeWithSize   - maps an integer to a int type.
244 //   Int32, UInt32, Int64, UInt64, TimeInMillis
245 //                  - integers of known sizes.
246 //   BiggestInt     - the biggest signed integer type.
247 //
248 // Command-line utilities:
249 //   GTEST_DECLARE_*()  - declares a flag.
250 //   GTEST_DEFINE_*()   - defines a flag.
251 //   GetInjectableArgvs() - returns the command line as a vector of strings.
252 //
253 // Environment variable utilities:
254 //   GetEnv()             - gets the value of an environment variable.
255 //   BoolFromGTestEnv()   - parses a bool environment variable.
256 //   Int32FromGTestEnv()  - parses an Int32 environment variable.
257 //   StringFromGTestEnv() - parses a string environment variable.
258
259 #include <ctype.h>   // for isspace, etc
260 #include <stddef.h>  // for ptrdiff_t
261 #include <stdlib.h>
262 #include <stdio.h>
263 #include <string.h>
264 #ifndef _WIN32_WCE
265 # include <sys/types.h>
266 # include <sys/stat.h>
267 #endif  // !_WIN32_WCE
268
269 #if defined __APPLE__
270 # include <AvailabilityMacros.h>
271 # include <TargetConditionals.h>
272 #endif
273
274 #include <algorithm>  // NOLINT
275 #include <iostream>  // NOLINT
276 #include <sstream>  // NOLINT
277 #include <string>  // NOLINT
278 #include <utility>
279 #include <vector>  // NOLINT
280
281 #include "gtest/internal/gtest-port-arch.h"
282 #include "gtest/internal/custom/gtest-port.h"
283
284 #if !defined(GTEST_DEV_EMAIL_)
285 # define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
286 # define GTEST_FLAG_PREFIX_ "gtest_"
287 # define GTEST_FLAG_PREFIX_DASH_ "gtest-"
288 # define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
289 # define GTEST_NAME_ "Google Test"
290 # define GTEST_PROJECT_URL_ "https://github.com/google/googletest/"
291 #endif  // !defined(GTEST_DEV_EMAIL_)
292
293 #if !defined(GTEST_INIT_GOOGLE_TEST_NAME_)
294 # define GTEST_INIT_GOOGLE_TEST_NAME_ "testing::InitGoogleTest"
295 #endif  // !defined(GTEST_INIT_GOOGLE_TEST_NAME_)
296
297 // Determines the version of gcc that is used to compile this.
298 #ifdef __GNUC__
299 // 40302 means version 4.3.2.
300 # define GTEST_GCC_VER_ \
301     (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
302 #endif  // __GNUC__
303
304 // Macros for disabling Microsoft Visual C++ warnings.
305 //
306 //   GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 4385)
307 //   /* code that triggers warnings C4800 and C4385 */
308 //   GTEST_DISABLE_MSC_WARNINGS_POP_()
309 #if defined(_MSC_VER) && _MSC_VER >= 1500
310 # define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings) \
311     __pragma(warning(push))                        \
312     __pragma(warning(disable: warnings))
313 # define GTEST_DISABLE_MSC_WARNINGS_POP_()          \
314     __pragma(warning(pop))
315 #else
316 // Older versions of MSVC don't have __pragma.
317 # define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings)
318 # define GTEST_DISABLE_MSC_WARNINGS_POP_()
319 #endif
320
321 #ifndef GTEST_LANG_CXX11
322 // gcc and clang define __GXX_EXPERIMENTAL_CXX0X__ when
323 // -std={c,gnu}++{0x,11} is passed.  The C++11 standard specifies a
324 // value for __cplusplus, and recent versions of clang, gcc, and
325 // probably other compilers set that too in C++11 mode.
326 # if defined(__GXX_EXPERIMENTAL_CXX0X__) || __cplusplus >= 201103L
327 // Compiling in at least C++11 mode.
328 #  define GTEST_LANG_CXX11 1
329 # else
330 #  define GTEST_LANG_CXX11 0
331 # endif
332 #endif
333
334 // Distinct from C++11 language support, some environments don't provide
335 // proper C++11 library support. Notably, it's possible to build in
336 // C++11 mode when targeting Mac OS X 10.6, which has an old libstdc++
337 // with no C++11 support.
338 //
339 // libstdc++ has sufficient C++11 support as of GCC 4.6.0, __GLIBCXX__
340 // 20110325, but maintenance releases in the 4.4 and 4.5 series followed
341 // this date, so check for those versions by their date stamps.
342 // https://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html#abi.versioning
343 #if GTEST_LANG_CXX11 && \
344     (!defined(__GLIBCXX__) || ( \
345         __GLIBCXX__ >= 20110325ul &&  /* GCC >= 4.6.0 */ \
346         /* Blacklist of patch releases of older branches: */ \
347         __GLIBCXX__ != 20110416ul &&  /* GCC 4.4.6 */ \
348         __GLIBCXX__ != 20120313ul &&  /* GCC 4.4.7 */ \
349         __GLIBCXX__ != 20110428ul &&  /* GCC 4.5.3 */ \
350         __GLIBCXX__ != 20120702ul))   /* GCC 4.5.4 */
351 # define GTEST_STDLIB_CXX11 1
352 #endif
353
354 // Only use C++11 library features if the library provides them.
355 #if defined(GTEST_STDLIB_CXX11) && GTEST_STDLIB_CXX11
356 # define GTEST_HAS_STD_BEGIN_AND_END_ 1
357 # define GTEST_HAS_STD_FORWARD_LIST_ 1
358 # define GTEST_HAS_STD_FUNCTION_ 1
359 # define GTEST_HAS_STD_INITIALIZER_LIST_ 1
360 # define GTEST_HAS_STD_MOVE_ 1
361 # define GTEST_HAS_STD_SHARED_PTR_ 1
362 # define GTEST_HAS_STD_TYPE_TRAITS_ 1
363 # define GTEST_HAS_STD_UNIQUE_PTR_ 1
364 #endif
365
366 // C++11 specifies that <tuple> provides std::tuple.
367 // Some platforms still might not have it, however.
368 #if GTEST_LANG_CXX11
369 # define GTEST_HAS_STD_TUPLE_ 1
370 # if defined(__clang__)
371 // Inspired by http://clang.llvm.org/docs/LanguageExtensions.html#__has_include
372 #  if defined(__has_include) && !__has_include(<tuple>)
373 #   undef GTEST_HAS_STD_TUPLE_
374 #  endif
375 # elif defined(_MSC_VER)
376 // Inspired by boost/config/stdlib/dinkumware.hpp
377 #  if defined(_CPPLIB_VER) && _CPPLIB_VER < 520
378 #   undef GTEST_HAS_STD_TUPLE_
379 #  endif
380 # elif defined(__GLIBCXX__)
381 // Inspired by boost/config/stdlib/libstdcpp3.hpp,
382 // http://gcc.gnu.org/gcc-4.2/changes.html and
383 // http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt01ch01.html#manual.intro.status.standard.200x
384 #  if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 2)
385 #   undef GTEST_HAS_STD_TUPLE_
386 #  endif
387 # endif
388 #endif
389
390 #ifndef GTEST_OS_WINDOWS
391 #  define GTEST_OS_WINDOWS 0
392 #endif
393 #ifndef GTEST_OS_WINDOWS_MINGW
394 #  define GTEST_OS_WINDOWS_MINGW 0
395 #endif
396 #ifndef GTEST_OS_WINDOWS_PHONE
397 #  define GTEST_OS_WINDOWS_PHONE 0
398 #endif
399 #ifndef GTEST_OS_WINDOWS_MOBILE
400 #  define GTEST_OS_WINDOWS_MOBILE 0
401 #endif
402 #ifndef GTEST_OS_WINDOWS_RT
403 #  define GTEST_OS_WINDOWS_RT 0
404 #endif
405 #ifndef GTEST_OS_LINUX_ANDROID
406 #  define GTEST_OS_LINUX_ANDROID 0
407 #endif
408 #ifndef GTEST_OS_QNX
409 #  define GTEST_OS_QNX 0
410 #endif
411 #ifndef GTEST_OS_SYMBIAN
412 #  define GTEST_OS_SYMBIAN 0
413 #endif
414 #ifndef GTEST_OS_CYGWIN
415 #  define GTEST_OS_CYGWIN 0
416 #endif
417 #ifndef GTEST_OS_SOLARIS
418 #  define GTEST_OS_SOLARIS 0
419 #endif
420
421 // Brings in definitions for functions used in the testing::internal::posix
422 // namespace (read, write, close, chdir, isatty, stat). We do not currently
423 // use them on Windows Mobile.
424 #if GTEST_OS_WINDOWS
425 # if !GTEST_OS_WINDOWS_MOBILE
426 #  include <direct.h>
427 #  include <io.h>
428 # endif
429 // In order to avoid having to include <windows.h>, use forward declaration
430 // assuming CRITICAL_SECTION is a typedef of _RTL_CRITICAL_SECTION.
431 // This assumption is verified by
432 // WindowsTypesTest.CRITICAL_SECTIONIs_RTL_CRITICAL_SECTION.
433 struct _RTL_CRITICAL_SECTION;
434 #else
435 // This assumes that non-Windows OSes provide unistd.h. For OSes where this
436 // is not the case, we need to include headers that provide the functions
437 // mentioned above.
438 # include <unistd.h>
439 # include <strings.h>
440 #endif  // GTEST_OS_WINDOWS
441
442 #if GTEST_OS_LINUX_ANDROID
443 // Used to define __ANDROID_API__ matching the target NDK API level.
444 #  include <android/api-level.h>  // NOLINT
445 #endif
446
447 // Defines this to true iff Google Test can use POSIX regular expressions.
448 #ifndef GTEST_HAS_POSIX_RE
449 # if GTEST_OS_LINUX_ANDROID
450 // On Android, <regex.h> is only available starting with Gingerbread.
451 #  define GTEST_HAS_POSIX_RE (__ANDROID_API__ >= 9)
452 # else
453 #  define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS)
454 # endif
455 #endif
456
457 #if defined(GTEST_USES_PCRE) && GTEST_USES_PCRE
458 // The appropriate headers have already been included.
459
460 #elif GTEST_HAS_POSIX_RE
461
462 // On some platforms, <regex.h> needs someone to define size_t, and
463 // won't compile otherwise.  We can #include it here as we already
464 // included <stdlib.h>, which is guaranteed to define size_t through
465 // <stddef.h>.
466 # include <regex.h>  // NOLINT
467
468 # define GTEST_USES_POSIX_RE 1
469
470 #elif GTEST_OS_WINDOWS
471
472 // <regex.h> is not available on Windows.  Use our own simple regex
473 // implementation instead.
474 # define GTEST_USES_SIMPLE_RE 1
475
476 #else
477
478 // <regex.h> may not be available on this platform.  Use our own
479 // simple regex implementation instead.
480 # define GTEST_USES_SIMPLE_RE 1
481
482 #endif  // GTEST_USES_PCRE
483
484 #ifndef GTEST_HAS_EXCEPTIONS
485 // The user didn't tell us whether exceptions are enabled, so we need
486 // to figure it out.
487 # if defined(_MSC_VER) || defined(__BORLANDC__)
488 // MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS
489 // macro to enable exceptions, so we'll do the same.
490 // Assumes that exceptions are enabled by default.
491 #  ifndef _HAS_EXCEPTIONS
492 #   define _HAS_EXCEPTIONS 1
493 #  endif  // _HAS_EXCEPTIONS
494 #  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
495 # elif defined(__clang__)
496 // clang defines __EXCEPTIONS iff exceptions are enabled before clang 220714,
497 // but iff cleanups are enabled after that. In Obj-C++ files, there can be
498 // cleanups for ObjC exceptions which also need cleanups, even if C++ exceptions
499 // are disabled. clang has __has_feature(cxx_exceptions) which checks for C++
500 // exceptions starting at clang r206352, but which checked for cleanups prior to
501 // that. To reliably check for C++ exception availability with clang, check for
502 // __EXCEPTIONS && __has_feature(cxx_exceptions).
503 #  define GTEST_HAS_EXCEPTIONS (__EXCEPTIONS && __has_feature(cxx_exceptions))
504 # elif defined(__GNUC__) && __EXCEPTIONS
505 // gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
506 #  define GTEST_HAS_EXCEPTIONS 1
507 # elif defined(__SUNPRO_CC)
508 // Sun Pro CC supports exceptions.  However, there is no compile-time way of
509 // detecting whether they are enabled or not.  Therefore, we assume that
510 // they are enabled unless the user tells us otherwise.
511 #  define GTEST_HAS_EXCEPTIONS 1
512 # elif defined(__IBMCPP__) && __EXCEPTIONS
513 // xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
514 #  define GTEST_HAS_EXCEPTIONS 1
515 # elif defined(__HP_aCC)
516 // Exception handling is in effect by default in HP aCC compiler. It has to
517 // be turned of by +noeh compiler option if desired.
518 #  define GTEST_HAS_EXCEPTIONS 1
519 # else
520 // For other compilers, we assume exceptions are disabled to be
521 // conservative.
522 #  define GTEST_HAS_EXCEPTIONS 0
523 # endif  // defined(_MSC_VER) || defined(__BORLANDC__)
524 #endif  // GTEST_HAS_EXCEPTIONS
525
526 #if !defined(GTEST_HAS_STD_STRING)
527 // Even though we don't use this macro any longer, we keep it in case
528 // some clients still depend on it.
529 # define GTEST_HAS_STD_STRING 1
530 #elif !GTEST_HAS_STD_STRING
531 // The user told us that ::std::string isn't available.
532 # error "Google Test cannot be used where ::std::string isn't available."
533 #endif  // !defined(GTEST_HAS_STD_STRING)
534
535 #ifndef GTEST_HAS_GLOBAL_STRING
536 // The user didn't tell us whether ::string is available, so we need
537 // to figure it out.
538
539 # define GTEST_HAS_GLOBAL_STRING 0
540
541 #endif  // GTEST_HAS_GLOBAL_STRING
542
543 #ifndef GTEST_HAS_STD_WSTRING
544 // The user didn't tell us whether ::std::wstring is available, so we need
545 // to figure it out.
546 // TODO(wan@google.com): uses autoconf to detect whether ::std::wstring
547 //   is available.
548
549 // Cygwin 1.7 and below doesn't support ::std::wstring.
550 // Solaris' libc++ doesn't support it either.  Android has
551 // no support for it at least as recent as Froyo (2.2).
552 # define GTEST_HAS_STD_WSTRING \
553     (!(GTEST_OS_LINUX_ANDROID || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS))
554
555 #endif  // GTEST_HAS_STD_WSTRING
556
557 #ifndef GTEST_HAS_GLOBAL_WSTRING
558 // The user didn't tell us whether ::wstring is available, so we need
559 // to figure it out.
560 # define GTEST_HAS_GLOBAL_WSTRING \
561     (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
562 #endif  // GTEST_HAS_GLOBAL_WSTRING
563
564 // Determines whether RTTI is available.
565 #ifndef GTEST_HAS_RTTI
566 // The user didn't tell us whether RTTI is enabled, so we need to
567 // figure it out.
568
569 # ifdef _MSC_VER
570
571 #  ifdef _CPPRTTI  // MSVC defines this macro iff RTTI is enabled.
572 #   define GTEST_HAS_RTTI 1
573 #  else
574 #   define GTEST_HAS_RTTI 0
575 #  endif
576
577 // Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled.
578 # elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302)
579
580 #  ifdef __GXX_RTTI
581 // When building against STLport with the Android NDK and with
582 // -frtti -fno-exceptions, the build fails at link time with undefined
583 // references to __cxa_bad_typeid. Note sure if STL or toolchain bug,
584 // so disable RTTI when detected.
585 #   if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR) && \
586        !defined(__EXCEPTIONS)
587 #    define GTEST_HAS_RTTI 0
588 #   else
589 #    define GTEST_HAS_RTTI 1
590 #   endif  // GTEST_OS_LINUX_ANDROID && __STLPORT_MAJOR && !__EXCEPTIONS
591 #  else
592 #   define GTEST_HAS_RTTI 0
593 #  endif  // __GXX_RTTI
594
595 // Clang defines __GXX_RTTI starting with version 3.0, but its manual recommends
596 // using has_feature instead. has_feature(cxx_rtti) is supported since 2.7, the
597 // first version with C++ support.
598 # elif defined(__clang__)
599
600 #  define GTEST_HAS_RTTI __has_feature(cxx_rtti)
601
602 // Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if
603 // both the typeid and dynamic_cast features are present.
604 # elif defined(__IBMCPP__) && (__IBMCPP__ >= 900)
605
606 #  ifdef __RTTI_ALL__
607 #   define GTEST_HAS_RTTI 1
608 #  else
609 #   define GTEST_HAS_RTTI 0
610 #  endif
611
612 # else
613
614 // For all other compilers, we assume RTTI is enabled.
615 #  define GTEST_HAS_RTTI 1
616
617 # endif  // _MSC_VER
618
619 #endif  // GTEST_HAS_RTTI
620
621 // It's this header's responsibility to #include <typeinfo> when RTTI
622 // is enabled.
623 #if GTEST_HAS_RTTI
624 # include <typeinfo>
625 #endif
626
627 // Determines whether Google Test can use the pthreads library.
628 #ifndef GTEST_HAS_PTHREAD
629 // The user didn't tell us explicitly, so we make reasonable assumptions about
630 // which platforms have pthreads support.
631 //
632 // To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
633 // to your compiler flags.
634 # define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \
635     || GTEST_OS_QNX || GTEST_OS_FREEBSD || GTEST_OS_NACL)
636 #endif  // GTEST_HAS_PTHREAD
637
638 #if GTEST_HAS_PTHREAD
639 // gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
640 // true.
641 # include <pthread.h>  // NOLINT
642
643 // For timespec and nanosleep, used below.
644 # include <time.h>  // NOLINT
645 #endif
646
647 // Determines if hash_map/hash_set are available.
648 // Only used for testing against those containers.
649 #if !defined(GTEST_HAS_HASH_MAP_)
650 # if defined(_MSC_VER)
651 #  define GTEST_HAS_HASH_MAP_ 1  // Indicates that hash_map is available.
652 #  define GTEST_HAS_HASH_SET_ 1  // Indicates that hash_set is available.
653 # endif  // _MSC_VER
654 #endif  // !defined(GTEST_HAS_HASH_MAP_)
655
656 // Determines whether Google Test can use tr1/tuple.  You can define
657 // this macro to 0 to prevent Google Test from using tuple (any
658 // feature depending on tuple with be disabled in this mode).
659 #ifndef GTEST_HAS_TR1_TUPLE
660 # if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR)
661 // STLport, provided with the Android NDK, has neither <tr1/tuple> or <tuple>.
662 #  define GTEST_HAS_TR1_TUPLE 0
663 # else
664 // The user didn't tell us not to do it, so we assume it's OK.
665 #  define GTEST_HAS_TR1_TUPLE 1
666 # endif
667 #endif  // GTEST_HAS_TR1_TUPLE
668
669 // Determines whether Google Test's own tr1 tuple implementation
670 // should be used.
671 #ifndef GTEST_USE_OWN_TR1_TUPLE
672 // The user didn't tell us, so we need to figure it out.
673
674 // We use our own TR1 tuple if we aren't sure the user has an
675 // implementation of it already.  At this time, libstdc++ 4.0.0+ and
676 // MSVC 2010 are the only mainstream standard libraries that come
677 // with a TR1 tuple implementation.  NVIDIA's CUDA NVCC compiler
678 // pretends to be GCC by defining __GNUC__ and friends, but cannot
679 // compile GCC's tuple implementation.  MSVC 2008 (9.0) provides TR1
680 // tuple in a 323 MB Feature Pack download, which we cannot assume the
681 // user has.  QNX's QCC compiler is a modified GCC but it doesn't
682 // support TR1 tuple.  libc++ only provides std::tuple, in C++11 mode,
683 // and it can be used with some compilers that define __GNUC__.
684 # if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \
685       && !GTEST_OS_QNX && !defined(_LIBCPP_VERSION)) || _MSC_VER >= 1600
686 #  define GTEST_ENV_HAS_TR1_TUPLE_ 1
687 # endif
688
689 // C++11 specifies that <tuple> provides std::tuple. Use that if gtest is used
690 // in C++11 mode and libstdc++ isn't very old (binaries targeting OS X 10.6
691 // can build with clang but need to use gcc4.2's libstdc++).
692 # if GTEST_LANG_CXX11 && (!defined(__GLIBCXX__) || __GLIBCXX__ > 20110325)
693 #  define GTEST_ENV_HAS_STD_TUPLE_ 1
694 # else
695 #  define GTEST_ENV_HAS_STD_TUPLE_ 0
696 # endif
697
698 # if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
699 #  define GTEST_USE_OWN_TR1_TUPLE 0
700 # else
701 #  define GTEST_USE_OWN_TR1_TUPLE 1
702 # endif
703
704 #endif  // GTEST_USE_OWN_TR1_TUPLE
705
706 // To avoid conditional compilation everywhere, we make it
707 // gtest-port.h's responsibility to #include the header implementing
708 // tuple.
709 #if defined(GTEST_HAS_STD_TUPLE_) && GTEST_HAS_STD_TUPLE_
710 # include <tuple>  // IWYU pragma: export
711 # define GTEST_TUPLE_NAMESPACE_ ::std
712 #endif  // GTEST_HAS_STD_TUPLE_
713
714 // We include tr1::tuple even if std::tuple is available to define printers for
715 // them.
716 #if GTEST_HAS_TR1_TUPLE
717 # ifndef GTEST_TUPLE_NAMESPACE_
718 #  define GTEST_TUPLE_NAMESPACE_ ::std::tr1
719 # endif  // GTEST_TUPLE_NAMESPACE_
720
721 # if GTEST_USE_OWN_TR1_TUPLE
722 #  include "gtest/internal/gtest-tuple.h"  // IWYU pragma: export  // NOLINT
723 # elif GTEST_ENV_HAS_STD_TUPLE_
724 #  include <tuple>
725 // C++11 puts its tuple into the ::std namespace rather than
726 // ::std::tr1.  gtest expects tuple to live in ::std::tr1, so put it there.
727 // This causes undefined behavior, but supported compilers react in
728 // the way we intend.
729 namespace std {
730 namespace tr1 {
731 using ::std::get;
732 using ::std::make_tuple;
733 using ::std::tuple;
734 using ::std::tuple_element;
735 using ::std::tuple_size;
736 }
737 }
738
739 # elif GTEST_OS_SYMBIAN
740
741 // On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to
742 // use STLport's tuple implementation, which unfortunately doesn't
743 // work as the copy of STLport distributed with Symbian is incomplete.
744 // By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to
745 // use its own tuple implementation.
746 #  ifdef BOOST_HAS_TR1_TUPLE
747 #   undef BOOST_HAS_TR1_TUPLE
748 #  endif  // BOOST_HAS_TR1_TUPLE
749
750 // This prevents <boost/tr1/detail/config.hpp>, which defines
751 // BOOST_HAS_TR1_TUPLE, from being #included by Boost's <tuple>.
752 #  define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED
753 #  include <tuple>  // IWYU pragma: export  // NOLINT
754
755 # elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
756 // GCC 4.0+ implements tr1/tuple in the <tr1/tuple> header.  This does
757 // not conform to the TR1 spec, which requires the header to be <tuple>.
758
759 #  if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
760 // Until version 4.3.2, gcc has a bug that causes <tr1/functional>,
761 // which is #included by <tr1/tuple>, to not compile when RTTI is
762 // disabled.  _TR1_FUNCTIONAL is the header guard for
763 // <tr1/functional>.  Hence the following #define is a hack to prevent
764 // <tr1/functional> from being included.
765 #   define _TR1_FUNCTIONAL 1
766 #   include <tr1/tuple>
767 #   undef _TR1_FUNCTIONAL  // Allows the user to #include
768                         // <tr1/functional> if he chooses to.
769 #  else
770 #   include <tr1/tuple>  // NOLINT
771 #  endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
772
773 # else
774 // If the compiler is not GCC 4.0+, we assume the user is using a
775 // spec-conforming TR1 implementation.
776 #  include <tuple>  // IWYU pragma: export  // NOLINT
777 # endif  // GTEST_USE_OWN_TR1_TUPLE
778
779 #endif  // GTEST_HAS_TR1_TUPLE
780
781 // Determines whether clone(2) is supported.
782 // Usually it will only be available on Linux, excluding
783 // Linux on the Itanium architecture.
784 // Also see http://linux.die.net/man/2/clone.
785 #ifndef GTEST_HAS_CLONE
786 // The user didn't tell us, so we need to figure it out.
787
788 # if GTEST_OS_LINUX && !defined(__ia64__)
789 #  if GTEST_OS_LINUX_ANDROID
790 // On Android, clone() is only available on ARM starting with Gingerbread.
791 #    if defined(__arm__) && __ANDROID_API__ >= 9
792 #     define GTEST_HAS_CLONE 1
793 #    else
794 #     define GTEST_HAS_CLONE 0
795 #    endif
796 #  else
797 #   define GTEST_HAS_CLONE 1
798 #  endif
799 # else
800 #  define GTEST_HAS_CLONE 0
801 # endif  // GTEST_OS_LINUX && !defined(__ia64__)
802
803 #endif  // GTEST_HAS_CLONE
804
805 // Determines whether to support stream redirection. This is used to test
806 // output correctness and to implement death tests.
807 #ifndef GTEST_HAS_STREAM_REDIRECTION
808 // By default, we assume that stream redirection is supported on all
809 // platforms except known mobile ones.
810 # if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || \
811     GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
812 #  define GTEST_HAS_STREAM_REDIRECTION 0
813 # else
814 #  define GTEST_HAS_STREAM_REDIRECTION 1
815 # endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
816 #endif  // GTEST_HAS_STREAM_REDIRECTION
817
818 // Determines whether to support death tests.
819 // Google Test does not support death tests for VC 7.1 and earlier as
820 // abort() in a VC 7.1 application compiled as GUI in debug config
821 // pops up a dialog window that cannot be suppressed programmatically.
822 #if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
823      (GTEST_OS_MAC && !GTEST_OS_IOS) || \
824      (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
825      GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \
826      GTEST_OS_OPENBSD || GTEST_OS_QNX || GTEST_OS_FREEBSD)
827 # define GTEST_HAS_DEATH_TEST 1
828 #endif
829
830 // We don't support MSVC 7.1 with exceptions disabled now.  Therefore
831 // all the compilers we care about are adequate for supporting
832 // value-parameterized tests.
833 #define GTEST_HAS_PARAM_TEST 1
834
835 // Determines whether to support type-driven tests.
836
837 // Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
838 // Sun Pro CC, IBM Visual Age, and HP aCC support.
839 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
840     defined(__IBMCPP__) || defined(__HP_aCC)
841 # define GTEST_HAS_TYPED_TEST 1
842 # define GTEST_HAS_TYPED_TEST_P 1
843 #endif
844
845 // Determines whether to support Combine(). This only makes sense when
846 // value-parameterized tests are enabled.  The implementation doesn't
847 // work on Sun Studio since it doesn't understand templated conversion
848 // operators.
849 #if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC)
850 # define GTEST_HAS_COMBINE 1
851 #endif
852
853 // Determines whether the system compiler uses UTF-16 for encoding wide strings.
854 #define GTEST_WIDE_STRING_USES_UTF16_ \
855     (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || GTEST_OS_AIX)
856
857 // Determines whether test results can be streamed to a socket.
858 #if GTEST_OS_LINUX
859 # define GTEST_CAN_STREAM_RESULTS_ 1
860 #endif
861
862 // Defines some utility macros.
863
864 // The GNU compiler emits a warning if nested "if" statements are followed by
865 // an "else" statement and braces are not used to explicitly disambiguate the
866 // "else" binding.  This leads to problems with code like:
867 //
868 //   if (gate)
869 //     ASSERT_*(condition) << "Some message";
870 //
871 // The "switch (0) case 0:" idiom is used to suppress this.
872 #ifdef __INTEL_COMPILER
873 # define GTEST_AMBIGUOUS_ELSE_BLOCKER_
874 #else
875 # define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
876 #endif
877
878 // Use this annotation at the end of a struct/class definition to
879 // prevent the compiler from optimizing away instances that are never
880 // used.  This is useful when all interesting logic happens inside the
881 // c'tor and / or d'tor.  Example:
882 //
883 //   struct Foo {
884 //     Foo() { ... }
885 //   } GTEST_ATTRIBUTE_UNUSED_;
886 //
887 // Also use it after a variable or parameter declaration to tell the
888 // compiler the variable/parameter does not have to be used.
889 #if defined(__GNUC__) && !defined(COMPILER_ICC)
890 # define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
891 #elif defined(__clang__)
892 # if __has_attribute(unused)
893 #  define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
894 # endif
895 #endif
896 #ifndef GTEST_ATTRIBUTE_UNUSED_
897 # define GTEST_ATTRIBUTE_UNUSED_
898 #endif
899
900 // A macro to disallow operator=
901 // This should be used in the private: declarations for a class.
902 #define GTEST_DISALLOW_ASSIGN_(type)\
903   void operator=(type const &)
904
905 // A macro to disallow copy constructor and operator=
906 // This should be used in the private: declarations for a class.
907 #define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
908   type(type const &);\
909   GTEST_DISALLOW_ASSIGN_(type)
910
911 // Tell the compiler to warn about unused return values for functions declared
912 // with this macro.  The macro should be used on function declarations
913 // following the argument list:
914 //
915 //   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
916 #if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
917 # define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
918 #else
919 # define GTEST_MUST_USE_RESULT_
920 #endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
921
922 // MS C++ compiler emits warning when a conditional expression is compile time
923 // constant. In some contexts this warning is false positive and needs to be
924 // suppressed. Use the following two macros in such cases:
925 //
926 // GTEST_INTENTIONAL_CONST_COND_PUSH_()
927 // while (true) {
928 // GTEST_INTENTIONAL_CONST_COND_POP_()
929 // }
930 # define GTEST_INTENTIONAL_CONST_COND_PUSH_() \
931     GTEST_DISABLE_MSC_WARNINGS_PUSH_(4127)
932 # define GTEST_INTENTIONAL_CONST_COND_POP_() \
933     GTEST_DISABLE_MSC_WARNINGS_POP_()
934
935 // Determine whether the compiler supports Microsoft's Structured Exception
936 // Handling.  This is supported by several Windows compilers but generally
937 // does not exist on any other system.
938 #ifndef GTEST_HAS_SEH
939 // The user didn't tell us, so we need to figure it out.
940
941 # if defined(_MSC_VER) || defined(__BORLANDC__)
942 // These two compilers are known to support SEH.
943 #  define GTEST_HAS_SEH 1
944 # else
945 // Assume no SEH.
946 #  define GTEST_HAS_SEH 0
947 # endif
948
949 #define GTEST_IS_THREADSAFE \
950     ((defined(GTEST_HAS_MUTEX_AND_THREAD_LOCAL_) && GTEST_HAS_MUTEX_AND_THREAD_LOCAL_) \
951      || (GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT) \
952      || GTEST_HAS_PTHREAD)
953
954 #endif  // GTEST_HAS_SEH
955
956 #ifdef _MSC_VER
957 # if GTEST_LINKED_AS_SHARED_LIBRARY
958 #  define GTEST_API_ __declspec(dllimport)
959 # elif GTEST_CREATE_SHARED_LIBRARY
960 #  define GTEST_API_ __declspec(dllexport)
961 # endif
962 #elif __GNUC__ >= 4 || defined(__clang__)
963 # define GTEST_API_ __attribute__((visibility ("default")))
964 #endif // _MSC_VER
965
966 #ifndef GTEST_API_
967 # define GTEST_API_
968 #endif
969
970 #ifdef __GNUC__
971 // Ask the compiler to never inline a given function.
972 # define GTEST_NO_INLINE_ __attribute__((noinline))
973 #else
974 # define GTEST_NO_INLINE_
975 #endif
976
977 // _LIBCPP_VERSION is defined by the libc++ library from the LLVM project.
978 #if defined(__GLIBCXX__) || defined(_LIBCPP_VERSION)
979 # define GTEST_HAS_CXXABI_H_ 1
980 #else
981 # define GTEST_HAS_CXXABI_H_ 0
982 #endif
983
984 // A function level attribute to disable checking for use of uninitialized
985 // memory when built with MemorySanitizer.
986 #if defined(__clang__)
987 # if __has_feature(memory_sanitizer)
988 #  define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_ \
989        __attribute__((no_sanitize_memory))
990 # else
991 #  define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
992 # endif  // __has_feature(memory_sanitizer)
993 #else
994 # define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
995 #endif  // __clang__
996
997 // A function level attribute to disable AddressSanitizer instrumentation.
998 #if defined(__clang__)
999 # if __has_feature(address_sanitizer)
1000 #  define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_ \
1001        __attribute__((no_sanitize_address))
1002 # else
1003 #  define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
1004 # endif  // __has_feature(address_sanitizer)
1005 #else
1006 # define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
1007 #endif  // __clang__
1008
1009 // A function level attribute to disable ThreadSanitizer instrumentation.
1010 #if defined(__clang__)
1011 # if __has_feature(thread_sanitizer)
1012 #  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_ \
1013        __attribute__((no_sanitize_thread))
1014 # else
1015 #  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
1016 # endif  // __has_feature(thread_sanitizer)
1017 #else
1018 # define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
1019 #endif  // __clang__
1020
1021 namespace testing {
1022
1023 class Message;
1024
1025 #if defined(GTEST_TUPLE_NAMESPACE_)
1026 // Import tuple and friends into the ::testing namespace.
1027 // It is part of our interface, having them in ::testing allows us to change
1028 // their types as needed.
1029 using GTEST_TUPLE_NAMESPACE_::get;
1030 using GTEST_TUPLE_NAMESPACE_::make_tuple;
1031 using GTEST_TUPLE_NAMESPACE_::tuple;
1032 using GTEST_TUPLE_NAMESPACE_::tuple_size;
1033 using GTEST_TUPLE_NAMESPACE_::tuple_element;
1034 #endif  // defined(GTEST_TUPLE_NAMESPACE_)
1035
1036 namespace internal {
1037
1038 // A secret type that Google Test users don't know about.  It has no
1039 // definition on purpose.  Therefore it's impossible to create a
1040 // Secret object, which is what we want.
1041 class Secret;
1042
1043 // The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time
1044 // expression is true. For example, you could use it to verify the
1045 // size of a static array:
1046 //
1047 //   GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
1048 //                         names_incorrect_size);
1049 //
1050 // or to make sure a struct is smaller than a certain size:
1051 //
1052 //   GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large);
1053 //
1054 // The second argument to the macro is the name of the variable. If
1055 // the expression is false, most compilers will issue a warning/error
1056 // containing the name of the variable.
1057
1058 #if GTEST_LANG_CXX11
1059 # define GTEST_COMPILE_ASSERT_(expr, msg) static_assert(expr, #msg)
1060 #else  // !GTEST_LANG_CXX11
1061 template <bool>
1062   struct CompileAssert {
1063 };
1064
1065 # define GTEST_COMPILE_ASSERT_(expr, msg) \
1066   typedef ::testing::internal::CompileAssert<(static_cast<bool>(expr))> \
1067       msg[static_cast<bool>(expr) ? 1 : -1] GTEST_ATTRIBUTE_UNUSED_
1068 #endif  // !GTEST_LANG_CXX11
1069
1070 // Implementation details of GTEST_COMPILE_ASSERT_:
1071 //
1072 // (In C++11, we simply use static_assert instead of the following)
1073 //
1074 // - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1
1075 //   elements (and thus is invalid) when the expression is false.
1076 //
1077 // - The simpler definition
1078 //
1079 //    #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1]
1080 //
1081 //   does not work, as gcc supports variable-length arrays whose sizes
1082 //   are determined at run-time (this is gcc's extension and not part
1083 //   of the C++ standard).  As a result, gcc fails to reject the
1084 //   following code with the simple definition:
1085 //
1086 //     int foo;
1087 //     GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is
1088 //                                      // not a compile-time constant.
1089 //
1090 // - By using the type CompileAssert<(bool(expr))>, we ensures that
1091 //   expr is a compile-time constant.  (Template arguments must be
1092 //   determined at compile-time.)
1093 //
1094 // - The outter parentheses in CompileAssert<(bool(expr))> are necessary
1095 //   to work around a bug in gcc 3.4.4 and 4.0.1.  If we had written
1096 //
1097 //     CompileAssert<bool(expr)>
1098 //
1099 //   instead, these compilers will refuse to compile
1100 //
1101 //     GTEST_COMPILE_ASSERT_(5 > 0, some_message);
1102 //
1103 //   (They seem to think the ">" in "5 > 0" marks the end of the
1104 //   template argument list.)
1105 //
1106 // - The array size is (bool(expr) ? 1 : -1), instead of simply
1107 //
1108 //     ((expr) ? 1 : -1).
1109 //
1110 //   This is to avoid running into a bug in MS VC 7.1, which
1111 //   causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1.
1112
1113 // StaticAssertTypeEqHelper is used by StaticAssertTypeEq defined in gtest.h.
1114 //
1115 // This template is declared, but intentionally undefined.
1116 template <typename T1, typename T2>
1117 struct StaticAssertTypeEqHelper;
1118
1119 template <typename T>
1120 struct StaticAssertTypeEqHelper<T, T> {
1121   enum { value = true };
1122 };
1123
1124 // Evaluates to the number of elements in 'array'.
1125 #define GTEST_ARRAY_SIZE_(array) (sizeof(array) / sizeof(array[0]))
1126
1127 #if GTEST_HAS_GLOBAL_STRING
1128 typedef ::string string;
1129 #else
1130 typedef ::std::string string;
1131 #endif  // GTEST_HAS_GLOBAL_STRING
1132
1133 #if GTEST_HAS_GLOBAL_WSTRING
1134 typedef ::wstring wstring;
1135 #elif GTEST_HAS_STD_WSTRING
1136 typedef ::std::wstring wstring;
1137 #endif  // GTEST_HAS_GLOBAL_WSTRING
1138
1139 // A helper for suppressing warnings on constant condition.  It just
1140 // returns 'condition'.
1141 GTEST_API_ bool IsTrue(bool condition);
1142
1143 // Defines scoped_ptr.
1144
1145 // This implementation of scoped_ptr is PARTIAL - it only contains
1146 // enough stuff to satisfy Google Test's need.
1147 template <typename T>
1148 class scoped_ptr {
1149  public:
1150   typedef T element_type;
1151
1152   explicit scoped_ptr(T* p = NULL) : ptr_(p) {}
1153   ~scoped_ptr() { reset(); }
1154
1155   T& operator*() const { return *ptr_; }
1156   T* operator->() const { return ptr_; }
1157   T* get() const { return ptr_; }
1158
1159   T* release() {
1160     T* const ptr = ptr_;
1161     ptr_ = NULL;
1162     return ptr;
1163   }
1164
1165   void reset(T* p = NULL) {
1166     if (p != ptr_) {
1167       if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
1168         delete ptr_;
1169       }
1170       ptr_ = p;
1171     }
1172   }
1173
1174   friend void swap(scoped_ptr& a, scoped_ptr& b) {
1175     using std::swap;
1176     swap(a.ptr_, b.ptr_);
1177   }
1178
1179  private:
1180   T* ptr_;
1181
1182   GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
1183 };
1184
1185 // Defines RE.
1186
1187 // A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
1188 // Regular Expression syntax.
1189 class GTEST_API_ RE {
1190  public:
1191   // A copy constructor is required by the Standard to initialize object
1192   // references from r-values.
1193   RE(const RE& other) { Init(other.pattern()); }
1194
1195   // Constructs an RE from a string.
1196   RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT
1197
1198 #if GTEST_HAS_GLOBAL_STRING
1199
1200   RE(const ::string& regex) { Init(regex.c_str()); }  // NOLINT
1201
1202 #endif  // GTEST_HAS_GLOBAL_STRING
1203
1204   RE(const char* regex) { Init(regex); }  // NOLINT
1205   ~RE();
1206
1207   // Returns the string representation of the regex.
1208   const char* pattern() const { return pattern_; }
1209
1210   // FullMatch(str, re) returns true iff regular expression re matches
1211   // the entire str.
1212   // PartialMatch(str, re) returns true iff regular expression re
1213   // matches a substring of str (including str itself).
1214   //
1215   // TODO(wan@google.com): make FullMatch() and PartialMatch() work
1216   // when str contains NUL characters.
1217   static bool FullMatch(const ::std::string& str, const RE& re) {
1218     return FullMatch(str.c_str(), re);
1219   }
1220   static bool PartialMatch(const ::std::string& str, const RE& re) {
1221     return PartialMatch(str.c_str(), re);
1222   }
1223
1224 #if GTEST_HAS_GLOBAL_STRING
1225
1226   static bool FullMatch(const ::string& str, const RE& re) {
1227     return FullMatch(str.c_str(), re);
1228   }
1229   static bool PartialMatch(const ::string& str, const RE& re) {
1230     return PartialMatch(str.c_str(), re);
1231   }
1232
1233 #endif  // GTEST_HAS_GLOBAL_STRING
1234
1235   static bool FullMatch(const char* str, const RE& re);
1236   static bool PartialMatch(const char* str, const RE& re);
1237
1238  private:
1239   void Init(const char* regex);
1240
1241   // We use a const char* instead of an std::string, as Google Test used to be
1242   // used where std::string is not available.  TODO(wan@google.com): change to
1243   // std::string.
1244   const char* pattern_;
1245   bool is_valid_;
1246
1247 #if GTEST_USES_POSIX_RE
1248
1249   regex_t full_regex_;     // For FullMatch().
1250   regex_t partial_regex_;  // For PartialMatch().
1251
1252 #else  // GTEST_USES_SIMPLE_RE
1253
1254   const char* full_pattern_;  // For FullMatch();
1255
1256 #endif
1257
1258   GTEST_DISALLOW_ASSIGN_(RE);
1259 };
1260
1261 // Formats a source file path and a line number as they would appear
1262 // in an error message from the compiler used to compile this code.
1263 GTEST_API_ ::std::string FormatFileLocation(const char* file, int line);
1264
1265 // Formats a file location for compiler-independent XML output.
1266 // Although this function is not platform dependent, we put it next to
1267 // FormatFileLocation in order to contrast the two functions.
1268 GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(const char* file,
1269                                                                int line);
1270
1271 // Defines logging utilities:
1272 //   GTEST_LOG_(severity) - logs messages at the specified severity level. The
1273 //                          message itself is streamed into the macro.
1274 //   LogToStderr()  - directs all log messages to stderr.
1275 //   FlushInfoLog() - flushes informational log messages.
1276
1277 enum GTestLogSeverity {
1278   GTEST_INFO,
1279   GTEST_WARNING,
1280   GTEST_ERROR,
1281   GTEST_FATAL
1282 };
1283
1284 // Formats log entry severity, provides a stream object for streaming the
1285 // log message, and terminates the message with a newline when going out of
1286 // scope.
1287 class GTEST_API_ GTestLog {
1288  public:
1289   GTestLog(GTestLogSeverity severity, const char* file, int line);
1290
1291   // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
1292   ~GTestLog();
1293
1294   ::std::ostream& GetStream() { return ::std::cerr; }
1295
1296  private:
1297   const GTestLogSeverity severity_;
1298
1299   GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestLog);
1300 };
1301
1302 #if !defined(GTEST_LOG_)
1303
1304 # define GTEST_LOG_(severity) \
1305     ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
1306                                   __FILE__, __LINE__).GetStream()
1307
1308 inline void LogToStderr() {}
1309 inline void FlushInfoLog() { fflush(NULL); }
1310
1311 #endif  // !defined(GTEST_LOG_)
1312
1313 #if !defined(GTEST_CHECK_)
1314 // INTERNAL IMPLEMENTATION - DO NOT USE.
1315 //
1316 // GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition
1317 // is not satisfied.
1318 //  Synopsys:
1319 //    GTEST_CHECK_(boolean_condition);
1320 //     or
1321 //    GTEST_CHECK_(boolean_condition) << "Additional message";
1322 //
1323 //    This checks the condition and if the condition is not satisfied
1324 //    it prints message about the condition violation, including the
1325 //    condition itself, plus additional message streamed into it, if any,
1326 //    and then it aborts the program. It aborts the program irrespective of
1327 //    whether it is built in the debug mode or not.
1328 # define GTEST_CHECK_(condition) \
1329     GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
1330     if (::testing::internal::IsTrue(condition)) \
1331       ; \
1332     else \
1333       GTEST_LOG_(FATAL) << "Condition " #condition " failed. "
1334 #endif  // !defined(GTEST_CHECK_)
1335
1336 // An all-mode assert to verify that the given POSIX-style function
1337 // call returns 0 (indicating success).  Known limitation: this
1338 // doesn't expand to a balanced 'if' statement, so enclose the macro
1339 // in {} if you need to use it as the only statement in an 'if'
1340 // branch.
1341 #define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \
1342   if (const int gtest_error = (posix_call)) \
1343     GTEST_LOG_(FATAL) << #posix_call << "failed with error " \
1344                       << gtest_error
1345
1346 #if defined(GTEST_HAS_STD_MOVE_) && GTEST_HAS_STD_MOVE_
1347 using std::move;
1348 #else  // GTEST_HAS_STD_MOVE_
1349 template <typename T>
1350 const T& move(const T& t) {
1351   return t;
1352 }
1353 #endif  // GTEST_HAS_STD_MOVE_
1354
1355 // INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
1356 //
1357 // Use ImplicitCast_ as a safe version of static_cast for upcasting in
1358 // the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
1359 // const Foo*).  When you use ImplicitCast_, the compiler checks that
1360 // the cast is safe.  Such explicit ImplicitCast_s are necessary in
1361 // surprisingly many situations where C++ demands an exact type match
1362 // instead of an argument type convertable to a target type.
1363 //
1364 // The syntax for using ImplicitCast_ is the same as for static_cast:
1365 //
1366 //   ImplicitCast_<ToType>(expr)
1367 //
1368 // ImplicitCast_ would have been part of the C++ standard library,
1369 // but the proposal was submitted too late.  It will probably make
1370 // its way into the language in the future.
1371 //
1372 // This relatively ugly name is intentional. It prevents clashes with
1373 // similar functions users may have (e.g., implicit_cast). The internal
1374 // namespace alone is not enough because the function can be found by ADL.
1375 template<typename To>
1376 inline To ImplicitCast_(To x) { return x; }
1377
1378 // When you upcast (that is, cast a pointer from type Foo to type
1379 // SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
1380 // always succeed.  When you downcast (that is, cast a pointer from
1381 // type Foo to type SubclassOfFoo), static_cast<> isn't safe, because
1382 // how do you know the pointer is really of type SubclassOfFoo?  It
1383 // could be a bare Foo, or of type DifferentSubclassOfFoo.  Thus,
1384 // when you downcast, you should use this macro.  In debug mode, we
1385 // use dynamic_cast<> to double-check the downcast is legal (we die
1386 // if it's not).  In normal mode, we do the efficient static_cast<>
1387 // instead.  Thus, it's important to test in debug mode to make sure
1388 // the cast is legal!
1389 //    This is the only place in the code we should use dynamic_cast<>.
1390 // In particular, you SHOULDN'T be using dynamic_cast<> in order to
1391 // do RTTI (eg code like this:
1392 //    if (dynamic_cast<Subclass1>(foo)) HandleASubclass1Object(foo);
1393 //    if (dynamic_cast<Subclass2>(foo)) HandleASubclass2Object(foo);
1394 // You should design the code some other way not to need this.
1395 //
1396 // This relatively ugly name is intentional. It prevents clashes with
1397 // similar functions users may have (e.g., down_cast). The internal
1398 // namespace alone is not enough because the function can be found by ADL.
1399 template<typename To, typename From>  // use like this: DownCast_<T*>(foo);
1400 inline To DownCast_(From* f) {  // so we only accept pointers
1401   // Ensures that To is a sub-type of From *.  This test is here only
1402   // for compile-time type checking, and has no overhead in an
1403   // optimized build at run-time, as it will be optimized away
1404   // completely.
1405   GTEST_INTENTIONAL_CONST_COND_PUSH_()
1406   if (false) {
1407   GTEST_INTENTIONAL_CONST_COND_POP_()
1408     const To to = NULL;
1409     ::testing::internal::ImplicitCast_<From*>(to);
1410   }
1411
1412 #if GTEST_HAS_RTTI
1413   // RTTI: debug mode only!
1414   GTEST_CHECK_(f == NULL || dynamic_cast<To>(f) != NULL);
1415 #endif
1416   return static_cast<To>(f);
1417 }
1418
1419 // Downcasts the pointer of type Base to Derived.
1420 // Derived must be a subclass of Base. The parameter MUST
1421 // point to a class of type Derived, not any subclass of it.
1422 // When RTTI is available, the function performs a runtime
1423 // check to enforce this.
1424 template <class Derived, class Base>
1425 Derived* CheckedDowncastToActualType(Base* base) {
1426 #if GTEST_HAS_RTTI
1427   GTEST_CHECK_(typeid(*base) == typeid(Derived));
1428 #endif
1429
1430 #if defined(GTEST_HAS_DOWNCAST_) && GTEST_HAS_DOWNCAST_
1431   return ::down_cast<Derived*>(base);
1432 #elif GTEST_HAS_RTTI
1433   return dynamic_cast<Derived*>(base);  // NOLINT
1434 #else
1435   return static_cast<Derived*>(base);  // Poor man's downcast.
1436 #endif
1437 }
1438
1439 #if GTEST_HAS_STREAM_REDIRECTION
1440
1441 // Defines the stderr capturer:
1442 //   CaptureStdout     - starts capturing stdout.
1443 //   GetCapturedStdout - stops capturing stdout and returns the captured string.
1444 //   CaptureStderr     - starts capturing stderr.
1445 //   GetCapturedStderr - stops capturing stderr and returns the captured string.
1446 //
1447 GTEST_API_ void CaptureStdout();
1448 GTEST_API_ std::string GetCapturedStdout();
1449 GTEST_API_ void CaptureStderr();
1450 GTEST_API_ std::string GetCapturedStderr();
1451
1452 #endif  // GTEST_HAS_STREAM_REDIRECTION
1453
1454 // Returns a path to temporary directory.
1455 GTEST_API_ std::string TempDir();
1456
1457 // Returns the size (in bytes) of a file.
1458 GTEST_API_ size_t GetFileSize(FILE* file);
1459
1460 // Reads the entire content of a file as a string.
1461 GTEST_API_ std::string ReadEntireFile(FILE* file);
1462
1463 // All command line arguments.
1464 GTEST_API_ const ::std::vector<testing::internal::string>& GetArgvs();
1465
1466 #if GTEST_HAS_DEATH_TEST
1467
1468 const ::std::vector<testing::internal::string>& GetInjectableArgvs();
1469 void SetInjectableArgvs(const ::std::vector<testing::internal::string>*
1470                              new_argvs);
1471
1472
1473 #endif  // GTEST_HAS_DEATH_TEST
1474
1475 // Defines synchronization primitives.
1476 #if GTEST_IS_THREADSAFE
1477 # if GTEST_HAS_PTHREAD
1478 // Sleeps for (roughly) n milliseconds.  This function is only for testing
1479 // Google Test's own constructs.  Don't use it in user tests, either
1480 // directly or indirectly.
1481 inline void SleepMilliseconds(int n) {
1482   const timespec time = {
1483     0,                  // 0 seconds.
1484     n * 1000L * 1000L,  // And n ms.
1485   };
1486   nanosleep(&time, NULL);
1487 }
1488 # endif  // GTEST_HAS_PTHREAD
1489
1490 # if defined(GTEST_HAS_NOTIFICATION_) && GTEST_HAS_NOTIFICATION_
1491 // Notification has already been imported into the namespace.
1492 // Nothing to do here.
1493
1494 # elif GTEST_HAS_PTHREAD
1495 // Allows a controller thread to pause execution of newly created
1496 // threads until notified.  Instances of this class must be created
1497 // and destroyed in the controller thread.
1498 //
1499 // This class is only for testing Google Test's own constructs. Do not
1500 // use it in user tests, either directly or indirectly.
1501 class Notification {
1502  public:
1503   Notification() : notified_(false) {
1504     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
1505   }
1506   ~Notification() {
1507     pthread_mutex_destroy(&mutex_);
1508   }
1509
1510   // Notifies all threads created with this notification to start. Must
1511   // be called from the controller thread.
1512   void Notify() {
1513     pthread_mutex_lock(&mutex_);
1514     notified_ = true;
1515     pthread_mutex_unlock(&mutex_);
1516   }
1517
1518   // Blocks until the controller thread notifies. Must be called from a test
1519   // thread.
1520   void WaitForNotification() {
1521     for (;;) {
1522       pthread_mutex_lock(&mutex_);
1523       const bool notified = notified_;
1524       pthread_mutex_unlock(&mutex_);
1525       if (notified)
1526         break;
1527       SleepMilliseconds(10);
1528     }
1529   }
1530
1531  private:
1532   pthread_mutex_t mutex_;
1533   bool notified_;
1534
1535   GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
1536 };
1537
1538 # elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
1539
1540 GTEST_API_ void SleepMilliseconds(int n);
1541
1542 // Provides leak-safe Windows kernel handle ownership.
1543 // Used in death tests and in threading support.
1544 class GTEST_API_ AutoHandle {
1545  public:
1546   // Assume that Win32 HANDLE type is equivalent to void*. Doing so allows us to
1547   // avoid including <windows.h> in this header file. Including <windows.h> is
1548   // undesirable because it defines a lot of symbols and macros that tend to
1549   // conflict with client code. This assumption is verified by
1550   // WindowsTypesTest.HANDLEIsVoidStar.
1551   typedef void* Handle;
1552   AutoHandle();
1553   explicit AutoHandle(Handle handle);
1554
1555   ~AutoHandle();
1556
1557   Handle Get() const;
1558   void Reset();
1559   void Reset(Handle handle);
1560
1561  private:
1562   // Returns true iff the handle is a valid handle object that can be closed.
1563   bool IsCloseable() const;
1564
1565   Handle handle_;
1566
1567   GTEST_DISALLOW_COPY_AND_ASSIGN_(AutoHandle);
1568 };
1569
1570 // Allows a controller thread to pause execution of newly created
1571 // threads until notified.  Instances of this class must be created
1572 // and destroyed in the controller thread.
1573 //
1574 // This class is only for testing Google Test's own constructs. Do not
1575 // use it in user tests, either directly or indirectly.
1576 class GTEST_API_ Notification {
1577  public:
1578   Notification();
1579   void Notify();
1580   void WaitForNotification();
1581
1582  private:
1583   AutoHandle event_;
1584
1585   GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
1586 };
1587 # endif  // GTEST_HAS_NOTIFICATION_
1588
1589 // On MinGW, we can have both GTEST_OS_WINDOWS and GTEST_HAS_PTHREAD
1590 // defined, but we don't want to use MinGW's pthreads implementation, which
1591 // has conformance problems with some versions of the POSIX standard.
1592 # if GTEST_HAS_PTHREAD && !GTEST_OS_WINDOWS_MINGW
1593
1594 // As a C-function, ThreadFuncWithCLinkage cannot be templated itself.
1595 // Consequently, it cannot select a correct instantiation of ThreadWithParam
1596 // in order to call its Run(). Introducing ThreadWithParamBase as a
1597 // non-templated base class for ThreadWithParam allows us to bypass this
1598 // problem.
1599 class ThreadWithParamBase {
1600  public:
1601   virtual ~ThreadWithParamBase() {}
1602   virtual void Run() = 0;
1603 };
1604
1605 // pthread_create() accepts a pointer to a function type with the C linkage.
1606 // According to the Standard (7.5/1), function types with different linkages
1607 // are different even if they are otherwise identical.  Some compilers (for
1608 // example, SunStudio) treat them as different types.  Since class methods
1609 // cannot be defined with C-linkage we need to define a free C-function to
1610 // pass into pthread_create().
1611 extern "C" inline void* ThreadFuncWithCLinkage(void* thread) {
1612   static_cast<ThreadWithParamBase*>(thread)->Run();
1613   return NULL;
1614 }
1615
1616 // Helper class for testing Google Test's multi-threading constructs.
1617 // To use it, write:
1618 //
1619 //   void ThreadFunc(int param) { /* Do things with param */ }
1620 //   Notification thread_can_start;
1621 //   ...
1622 //   // The thread_can_start parameter is optional; you can supply NULL.
1623 //   ThreadWithParam<int> thread(&ThreadFunc, 5, &thread_can_start);
1624 //   thread_can_start.Notify();
1625 //
1626 // These classes are only for testing Google Test's own constructs. Do
1627 // not use them in user tests, either directly or indirectly.
1628 template <typename T>
1629 class ThreadWithParam : public ThreadWithParamBase {
1630  public:
1631   typedef void UserThreadFunc(T);
1632
1633   ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
1634       : func_(func),
1635         param_(param),
1636         thread_can_start_(thread_can_start),
1637         finished_(false) {
1638     ThreadWithParamBase* const base = this;
1639     // The thread can be created only after all fields except thread_
1640     // have been initialized.
1641     GTEST_CHECK_POSIX_SUCCESS_(
1642         pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
1643   }
1644   ~ThreadWithParam() { Join(); }
1645
1646   void Join() {
1647     if (!finished_) {
1648       GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
1649       finished_ = true;
1650     }
1651   }
1652
1653   virtual void Run() {
1654     if (thread_can_start_ != NULL)
1655       thread_can_start_->WaitForNotification();
1656     func_(param_);
1657   }
1658
1659  private:
1660   UserThreadFunc* const func_;  // User-supplied thread function.
1661   const T param_;  // User-supplied parameter to the thread function.
1662   // When non-NULL, used to block execution until the controller thread
1663   // notifies.
1664   Notification* const thread_can_start_;
1665   bool finished_;  // true iff we know that the thread function has finished.
1666   pthread_t thread_;  // The native thread object.
1667
1668   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1669 };
1670 # endif  // !GTEST_OS_WINDOWS && GTEST_HAS_PTHREAD ||
1671          // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
1672
1673 # if defined(GTEST_HAS_MUTEX_AND_THREAD_LOCAL_) && GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
1674 // Mutex and ThreadLocal have already been imported into the namespace.
1675 // Nothing to do here.
1676
1677 # elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
1678
1679 // Mutex implements mutex on Windows platforms.  It is used in conjunction
1680 // with class MutexLock:
1681 //
1682 //   Mutex mutex;
1683 //   ...
1684 //   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the
1685 //                            // end of the current scope.
1686 //
1687 // A static Mutex *must* be defined or declared using one of the following
1688 // macros:
1689 //   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1690 //   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
1691 //
1692 // (A non-static Mutex is defined/declared in the usual way).
1693 class GTEST_API_ Mutex {
1694  public:
1695   enum MutexType { kStatic = 0, kDynamic = 1 };
1696   // We rely on kStaticMutex being 0 as it is to what the linker initializes
1697   // type_ in static mutexes.  critical_section_ will be initialized lazily
1698   // in ThreadSafeLazyInit().
1699   enum StaticConstructorSelector { kStaticMutex = 0 };
1700
1701   // This constructor intentionally does nothing.  It relies on type_ being
1702   // statically initialized to 0 (effectively setting it to kStatic) and on
1703   // ThreadSafeLazyInit() to lazily initialize the rest of the members.
1704   explicit Mutex(StaticConstructorSelector /*dummy*/) {}
1705
1706   Mutex();
1707   ~Mutex();
1708
1709   void Lock();
1710
1711   void Unlock();
1712
1713   // Does nothing if the current thread holds the mutex. Otherwise, crashes
1714   // with high probability.
1715   void AssertHeld();
1716
1717  private:
1718   // Initializes owner_thread_id_ and critical_section_ in static mutexes.
1719   void ThreadSafeLazyInit();
1720
1721   // Per http://blogs.msdn.com/b/oldnewthing/archive/2004/02/23/78395.aspx,
1722   // we assume that 0 is an invalid value for thread IDs.
1723   unsigned int owner_thread_id_;
1724
1725   // For static mutexes, we rely on these members being initialized to zeros
1726   // by the linker.
1727   MutexType type_;
1728   long critical_section_init_phase_;  // NOLINT
1729   _RTL_CRITICAL_SECTION* critical_section_;
1730
1731   GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
1732 };
1733
1734 # define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1735     extern ::testing::internal::Mutex mutex
1736
1737 # define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1738     ::testing::internal::Mutex mutex(::testing::internal::Mutex::kStaticMutex)
1739
1740 // We cannot name this class MutexLock because the ctor declaration would
1741 // conflict with a macro named MutexLock, which is defined on some
1742 // platforms. That macro is used as a defensive measure to prevent against
1743 // inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
1744 // "MutexLock l(&mu)".  Hence the typedef trick below.
1745 class GTestMutexLock {
1746  public:
1747   explicit GTestMutexLock(Mutex* mutex)
1748       : mutex_(mutex) { mutex_->Lock(); }
1749
1750   ~GTestMutexLock() { mutex_->Unlock(); }
1751
1752  private:
1753   Mutex* const mutex_;
1754
1755   GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
1756 };
1757
1758 typedef GTestMutexLock MutexLock;
1759
1760 // Base class for ValueHolder<T>.  Allows a caller to hold and delete a value
1761 // without knowing its type.
1762 class ThreadLocalValueHolderBase {
1763  public:
1764   virtual ~ThreadLocalValueHolderBase() {}
1765 };
1766
1767 // Provides a way for a thread to send notifications to a ThreadLocal
1768 // regardless of its parameter type.
1769 class ThreadLocalBase {
1770  public:
1771   // Creates a new ValueHolder<T> object holding a default value passed to
1772   // this ThreadLocal<T>'s constructor and returns it.  It is the caller's
1773   // responsibility not to call this when the ThreadLocal<T> instance already
1774   // has a value on the current thread.
1775   virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const = 0;
1776
1777  protected:
1778   ThreadLocalBase() {}
1779   virtual ~ThreadLocalBase() {}
1780
1781  private:
1782   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocalBase);
1783 };
1784
1785 // Maps a thread to a set of ThreadLocals that have values instantiated on that
1786 // thread and notifies them when the thread exits.  A ThreadLocal instance is
1787 // expected to persist until all threads it has values on have terminated.
1788 class GTEST_API_ ThreadLocalRegistry {
1789  public:
1790   // Registers thread_local_instance as having value on the current thread.
1791   // Returns a value that can be used to identify the thread from other threads.
1792   static ThreadLocalValueHolderBase* GetValueOnCurrentThread(
1793       const ThreadLocalBase* thread_local_instance);
1794
1795   // Invoked when a ThreadLocal instance is destroyed.
1796   static void OnThreadLocalDestroyed(
1797       const ThreadLocalBase* thread_local_instance);
1798 };
1799
1800 class GTEST_API_ ThreadWithParamBase {
1801  public:
1802   void Join();
1803
1804  protected:
1805   class Runnable {
1806    public:
1807     virtual ~Runnable() {}
1808     virtual void Run() = 0;
1809   };
1810
1811   ThreadWithParamBase(Runnable *runnable, Notification* thread_can_start);
1812   virtual ~ThreadWithParamBase();
1813
1814  private:
1815   AutoHandle thread_;
1816 };
1817
1818 // Helper class for testing Google Test's multi-threading constructs.
1819 template <typename T>
1820 class ThreadWithParam : public ThreadWithParamBase {
1821  public:
1822   typedef void UserThreadFunc(T);
1823
1824   ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
1825       : ThreadWithParamBase(new RunnableImpl(func, param), thread_can_start) {
1826   }
1827   virtual ~ThreadWithParam() {}
1828
1829  private:
1830   class RunnableImpl : public Runnable {
1831    public:
1832     RunnableImpl(UserThreadFunc* func, T param)
1833         : func_(func),
1834           param_(param) {
1835     }
1836     virtual ~RunnableImpl() {}
1837     virtual void Run() {
1838       func_(param_);
1839     }
1840
1841    private:
1842     UserThreadFunc* const func_;
1843     const T param_;
1844
1845     GTEST_DISALLOW_COPY_AND_ASSIGN_(RunnableImpl);
1846   };
1847
1848   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1849 };
1850
1851 // Implements thread-local storage on Windows systems.
1852 //
1853 //   // Thread 1
1854 //   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1855 //
1856 //   // Thread 2
1857 //   tl.set(150);  // Changes the value for thread 2 only.
1858 //   EXPECT_EQ(150, tl.get());
1859 //
1860 //   // Thread 1
1861 //   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
1862 //   tl.set(200);
1863 //   EXPECT_EQ(200, tl.get());
1864 //
1865 // The template type argument T must have a public copy constructor.
1866 // In addition, the default ThreadLocal constructor requires T to have
1867 // a public default constructor.
1868 //
1869 // The users of a TheadLocal instance have to make sure that all but one
1870 // threads (including the main one) using that instance have exited before
1871 // destroying it. Otherwise, the per-thread objects managed for them by the
1872 // ThreadLocal instance are not guaranteed to be destroyed on all platforms.
1873 //
1874 // Google Test only uses global ThreadLocal objects.  That means they
1875 // will die after main() has returned.  Therefore, no per-thread
1876 // object managed by Google Test will be leaked as long as all threads
1877 // using Google Test have exited when main() returns.
1878 template <typename T>
1879 class ThreadLocal : public ThreadLocalBase {
1880  public:
1881   ThreadLocal() : default_factory_(new DefaultValueHolderFactory()) {}
1882   explicit ThreadLocal(const T& value)
1883       : default_factory_(new InstanceValueHolderFactory(value)) {}
1884
1885   ~ThreadLocal() { ThreadLocalRegistry::OnThreadLocalDestroyed(this); }
1886
1887   T* pointer() { return GetOrCreateValue(); }
1888   const T* pointer() const { return GetOrCreateValue(); }
1889   const T& get() const { return *pointer(); }
1890   void set(const T& value) { *pointer() = value; }
1891
1892  private:
1893   // Holds a value of T.  Can be deleted via its base class without the caller
1894   // knowing the type of T.
1895   class ValueHolder : public ThreadLocalValueHolderBase {
1896    public:
1897     ValueHolder() : value_() {}
1898     explicit ValueHolder(const T& value) : value_(value) {}
1899
1900     T* pointer() { return &value_; }
1901
1902    private:
1903     T value_;
1904     GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
1905   };
1906
1907
1908   T* GetOrCreateValue() const {
1909     return static_cast<ValueHolder*>(
1910         ThreadLocalRegistry::GetValueOnCurrentThread(this))->pointer();
1911   }
1912
1913   virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const {
1914     return default_factory_->MakeNewHolder();
1915   }
1916
1917   class ValueHolderFactory {
1918    public:
1919     ValueHolderFactory() {}
1920     virtual ~ValueHolderFactory() {}
1921     virtual ValueHolder* MakeNewHolder() const = 0;
1922
1923    private:
1924     GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolderFactory);
1925   };
1926
1927   class DefaultValueHolderFactory : public ValueHolderFactory {
1928    public:
1929     DefaultValueHolderFactory() {}
1930     virtual ValueHolder* MakeNewHolder() const { return new ValueHolder(); }
1931
1932    private:
1933     GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultValueHolderFactory);
1934   };
1935
1936   class InstanceValueHolderFactory : public ValueHolderFactory {
1937    public:
1938     explicit InstanceValueHolderFactory(const T& value) : value_(value) {}
1939     virtual ValueHolder* MakeNewHolder() const {
1940       return new ValueHolder(value_);
1941     }
1942
1943    private:
1944     const T value_;  // The value for each thread.
1945
1946     GTEST_DISALLOW_COPY_AND_ASSIGN_(InstanceValueHolderFactory);
1947   };
1948
1949   scoped_ptr<ValueHolderFactory> default_factory_;
1950
1951   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
1952 };
1953
1954 # elif GTEST_HAS_PTHREAD
1955
1956 // MutexBase and Mutex implement mutex on pthreads-based platforms.
1957 class MutexBase {
1958  public:
1959   // Acquires this mutex.
1960   void Lock() {
1961     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
1962     owner_ = pthread_self();
1963     has_owner_ = true;
1964   }
1965
1966   // Releases this mutex.
1967   void Unlock() {
1968     // Since the lock is being released the owner_ field should no longer be
1969     // considered valid. We don't protect writing to has_owner_ here, as it's
1970     // the caller's responsibility to ensure that the current thread holds the
1971     // mutex when this is called.
1972     has_owner_ = false;
1973     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
1974   }
1975
1976   // Does nothing if the current thread holds the mutex. Otherwise, crashes
1977   // with high probability.
1978   void AssertHeld() const {
1979     GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
1980         << "The current thread is not holding the mutex @" << this;
1981   }
1982
1983   // A static mutex may be used before main() is entered.  It may even
1984   // be used before the dynamic initialization stage.  Therefore we
1985   // must be able to initialize a static mutex object at link time.
1986   // This means MutexBase has to be a POD and its member variables
1987   // have to be public.
1988  public:
1989   pthread_mutex_t mutex_;  // The underlying pthread mutex.
1990   // has_owner_ indicates whether the owner_ field below contains a valid thread
1991   // ID and is therefore safe to inspect (e.g., to use in pthread_equal()). All
1992   // accesses to the owner_ field should be protected by a check of this field.
1993   // An alternative might be to memset() owner_ to all zeros, but there's no
1994   // guarantee that a zero'd pthread_t is necessarily invalid or even different
1995   // from pthread_self().
1996   bool has_owner_;
1997   pthread_t owner_;  // The thread holding the mutex.
1998 };
1999
2000 // Forward-declares a static mutex.
2001 #  define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
2002      extern ::testing::internal::MutexBase mutex
2003
2004 // Defines and statically (i.e. at link time) initializes a static mutex.
2005 #  define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
2006      ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false, pthread_t() }
2007
2008 // The Mutex class can only be used for mutexes created at runtime. It
2009 // shares its API with MutexBase otherwise.
2010 class Mutex : public MutexBase {
2011  public:
2012   Mutex() {
2013     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
2014     has_owner_ = false;
2015   }
2016   ~Mutex() {
2017     GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
2018   }
2019
2020  private:
2021   GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
2022 };
2023
2024 // We cannot name this class MutexLock because the ctor declaration would
2025 // conflict with a macro named MutexLock, which is defined on some
2026 // platforms. That macro is used as a defensive measure to prevent against
2027 // inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
2028 // "MutexLock l(&mu)".  Hence the typedef trick below.
2029 class GTestMutexLock {
2030  public:
2031   explicit GTestMutexLock(MutexBase* mutex)
2032       : mutex_(mutex) { mutex_->Lock(); }
2033
2034   ~GTestMutexLock() { mutex_->Unlock(); }
2035
2036  private:
2037   MutexBase* const mutex_;
2038
2039   GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
2040 };
2041
2042 typedef GTestMutexLock MutexLock;
2043
2044 // Helpers for ThreadLocal.
2045
2046 // pthread_key_create() requires DeleteThreadLocalValue() to have
2047 // C-linkage.  Therefore it cannot be templatized to access
2048 // ThreadLocal<T>.  Hence the need for class
2049 // ThreadLocalValueHolderBase.
2050 class ThreadLocalValueHolderBase {
2051  public:
2052   virtual ~ThreadLocalValueHolderBase() {}
2053 };
2054
2055 // Called by pthread to delete thread-local data stored by
2056 // pthread_setspecific().
2057 extern "C" inline void DeleteThreadLocalValue(void* value_holder) {
2058   delete static_cast<ThreadLocalValueHolderBase*>(value_holder);
2059 }
2060
2061 // Implements thread-local storage on pthreads-based systems.
2062 template <typename T>
2063 class ThreadLocal {
2064  public:
2065   ThreadLocal()
2066       : key_(CreateKey()), default_factory_(new DefaultValueHolderFactory()) {}
2067   explicit ThreadLocal(const T& value)
2068       : key_(CreateKey()),
2069         default_factory_(new InstanceValueHolderFactory(value)) {}
2070
2071   ~ThreadLocal() {
2072     // Destroys the managed object for the current thread, if any.
2073     DeleteThreadLocalValue(pthread_getspecific(key_));
2074
2075     // Releases resources associated with the key.  This will *not*
2076     // delete managed objects for other threads.
2077     GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
2078   }
2079
2080   T* pointer() { return GetOrCreateValue(); }
2081   const T* pointer() const { return GetOrCreateValue(); }
2082   const T& get() const { return *pointer(); }
2083   void set(const T& value) { *pointer() = value; }
2084
2085  private:
2086   // Holds a value of type T.
2087   class ValueHolder : public ThreadLocalValueHolderBase {
2088    public:
2089     ValueHolder() : value_() {}
2090     explicit ValueHolder(const T& value) : value_(value) {}
2091
2092     T* pointer() { return &value_; }
2093
2094    private:
2095     T value_;
2096     GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
2097   };
2098
2099   static pthread_key_t CreateKey() {
2100     pthread_key_t key;
2101     // When a thread exits, DeleteThreadLocalValue() will be called on
2102     // the object managed for that thread.
2103     GTEST_CHECK_POSIX_SUCCESS_(
2104         pthread_key_create(&key, &DeleteThreadLocalValue));
2105     return key;
2106   }
2107
2108   T* GetOrCreateValue() const {
2109     ThreadLocalValueHolderBase* const holder =
2110         static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
2111     if (holder != NULL) {
2112       return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
2113     }
2114
2115     ValueHolder* const new_holder = default_factory_->MakeNewHolder();
2116     ThreadLocalValueHolderBase* const holder_base = new_holder;
2117     GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
2118     return new_holder->pointer();
2119   }
2120
2121   class ValueHolderFactory {
2122    public:
2123     ValueHolderFactory() {}
2124     virtual ~ValueHolderFactory() {}
2125     virtual ValueHolder* MakeNewHolder() const = 0;
2126
2127    private:
2128     GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolderFactory);
2129   };
2130
2131   class DefaultValueHolderFactory : public ValueHolderFactory {
2132    public:
2133     DefaultValueHolderFactory() {}
2134     virtual ValueHolder* MakeNewHolder() const { return new ValueHolder(); }
2135
2136    private:
2137     GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultValueHolderFactory);
2138   };
2139
2140   class InstanceValueHolderFactory : public ValueHolderFactory {
2141    public:
2142     explicit InstanceValueHolderFactory(const T& value) : value_(value) {}
2143     virtual ValueHolder* MakeNewHolder() const {
2144       return new ValueHolder(value_);
2145     }
2146
2147    private:
2148     const T value_;  // The value for each thread.
2149
2150     GTEST_DISALLOW_COPY_AND_ASSIGN_(InstanceValueHolderFactory);
2151   };
2152
2153   // A key pthreads uses for looking up per-thread values.
2154   const pthread_key_t key_;
2155   scoped_ptr<ValueHolderFactory> default_factory_;
2156
2157   GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
2158 };
2159
2160 # endif  // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
2161
2162 #else  // GTEST_IS_THREADSAFE
2163
2164 // A dummy implementation of synchronization primitives (mutex, lock,
2165 // and thread-local variable).  Necessary for compiling Google Test where
2166 // mutex is not supported - using Google Test in multiple threads is not
2167 // supported on such platforms.
2168
2169 class Mutex {
2170  public:
2171   Mutex() {}
2172   void Lock() {}
2173   void Unlock() {}
2174   void AssertHeld() const {}
2175 };
2176
2177 # define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
2178   extern ::testing::internal::Mutex mutex
2179
2180 # define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
2181
2182 // We cannot name this class MutexLock because the ctor declaration would
2183 // conflict with a macro named MutexLock, which is defined on some
2184 // platforms. That macro is used as a defensive measure to prevent against
2185 // inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
2186 // "MutexLock l(&mu)".  Hence the typedef trick below.
2187 class GTestMutexLock {
2188  public:
2189   explicit GTestMutexLock(Mutex*) {}  // NOLINT
2190 };
2191
2192 typedef GTestMutexLock MutexLock;
2193
2194 template <typename T>
2195 class ThreadLocal {
2196  public:
2197   ThreadLocal() : value_() {}
2198   explicit ThreadLocal(const T& value) : value_(value) {}
2199   T* pointer() { return &value_; }
2200   const T* pointer() const { return &value_; }
2201   const T& get() const { return value_; }
2202   void set(const T& value) { value_ = value; }
2203  private:
2204   T value_;
2205 };
2206
2207 #endif  // GTEST_IS_THREADSAFE
2208
2209 // Returns the number of threads running in the process, or 0 to indicate that
2210 // we cannot detect it.
2211 GTEST_API_ size_t GetThreadCount();
2212
2213 // Passing non-POD classes through ellipsis (...) crashes the ARM
2214 // compiler and generates a warning in Sun Studio.  The Nokia Symbian
2215 // and the IBM XL C/C++ compiler try to instantiate a copy constructor
2216 // for objects passed through ellipsis (...), failing for uncopyable
2217 // objects.  We define this to ensure that only POD is passed through
2218 // ellipsis on these systems.
2219 #if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC)
2220 // We lose support for NULL detection where the compiler doesn't like
2221 // passing non-POD classes through ellipsis (...).
2222 # define GTEST_ELLIPSIS_NEEDS_POD_ 1
2223 #else
2224 # define GTEST_CAN_COMPARE_NULL 1
2225 #endif
2226
2227 // The Nokia Symbian and IBM XL C/C++ compilers cannot decide between
2228 // const T& and const T* in a function template.  These compilers
2229 // _can_ decide between class template specializations for T and T*,
2230 // so a tr1::type_traits-like is_pointer works.
2231 #if defined(__SYMBIAN32__) || defined(__IBMCPP__)
2232 # define GTEST_NEEDS_IS_POINTER_ 1
2233 #endif
2234
2235 template <bool bool_value>
2236 struct bool_constant {
2237   typedef bool_constant<bool_value> type;
2238   static const bool value = bool_value;
2239 };
2240 template <bool bool_value> const bool bool_constant<bool_value>::value;
2241
2242 typedef bool_constant<false> false_type;
2243 typedef bool_constant<true> true_type;
2244
2245 template <typename T>
2246 struct is_pointer : public false_type {};
2247
2248 template <typename T>
2249 struct is_pointer<T*> : public true_type {};
2250
2251 template <typename Iterator>
2252 struct IteratorTraits {
2253   typedef typename Iterator::value_type value_type;
2254 };
2255
2256 template <typename T>
2257 struct IteratorTraits<T*> {
2258   typedef T value_type;
2259 };
2260
2261 template <typename T>
2262 struct IteratorTraits<const T*> {
2263   typedef T value_type;
2264 };
2265
2266 #if GTEST_OS_WINDOWS
2267 # define GTEST_PATH_SEP_ "\\"
2268 # define GTEST_HAS_ALT_PATH_SEP_ 1
2269 // The biggest signed integer type the compiler supports.
2270 typedef __int64 BiggestInt;
2271 #else
2272 # define GTEST_PATH_SEP_ "/"
2273 # define GTEST_HAS_ALT_PATH_SEP_ 0
2274 typedef long long BiggestInt;  // NOLINT
2275 #endif  // GTEST_OS_WINDOWS
2276
2277 // Utilities for char.
2278
2279 // isspace(int ch) and friends accept an unsigned char or EOF.  char
2280 // may be signed, depending on the compiler (or compiler flags).
2281 // Therefore we need to cast a char to unsigned char before calling
2282 // isspace(), etc.
2283
2284 inline bool IsAlpha(char ch) {
2285   return isalpha(static_cast<unsigned char>(ch)) != 0;
2286 }
2287 inline bool IsAlNum(char ch) {
2288   return isalnum(static_cast<unsigned char>(ch)) != 0;
2289 }
2290 inline bool IsDigit(char ch) {
2291   return isdigit(static_cast<unsigned char>(ch)) != 0;
2292 }
2293 inline bool IsLower(char ch) {
2294   return islower(static_cast<unsigned char>(ch)) != 0;
2295 }
2296 inline bool IsSpace(char ch) {
2297   return isspace(static_cast<unsigned char>(ch)) != 0;
2298 }
2299 inline bool IsUpper(char ch) {
2300   return isupper(static_cast<unsigned char>(ch)) != 0;
2301 }
2302 inline bool IsXDigit(char ch) {
2303   return isxdigit(static_cast<unsigned char>(ch)) != 0;
2304 }
2305 inline bool IsXDigit(wchar_t ch) {
2306   const unsigned char low_byte = static_cast<unsigned char>(ch);
2307   return ch == low_byte && isxdigit(low_byte) != 0;
2308 }
2309
2310 inline char ToLower(char ch) {
2311   return static_cast<char>(tolower(static_cast<unsigned char>(ch)));
2312 }
2313 inline char ToUpper(char ch) {
2314   return static_cast<char>(toupper(static_cast<unsigned char>(ch)));
2315 }
2316
2317 inline std::string StripTrailingSpaces(std::string str) {
2318   std::string::iterator it = str.end();
2319   while (it != str.begin() && IsSpace(*--it))
2320     it = str.erase(it);
2321   return str;
2322 }
2323
2324 // The testing::internal::posix namespace holds wrappers for common
2325 // POSIX functions.  These wrappers hide the differences between
2326 // Windows/MSVC and POSIX systems.  Since some compilers define these
2327 // standard functions as macros, the wrapper cannot have the same name
2328 // as the wrapped function.
2329
2330 namespace posix {
2331
2332 // Functions with a different name on Windows.
2333
2334 #if GTEST_OS_WINDOWS
2335
2336 typedef struct _stat StatStruct;
2337
2338 # ifdef __BORLANDC__
2339 inline int IsATTY(int fd) { return isatty(fd); }
2340 inline int StrCaseCmp(const char* s1, const char* s2) {
2341   return stricmp(s1, s2);
2342 }
2343 inline char* StrDup(const char* src) { return strdup(src); }
2344 # else  // !__BORLANDC__
2345 #  if GTEST_OS_WINDOWS_MOBILE
2346 inline int IsATTY(int /* fd */) { return 0; }
2347 #  else
2348 inline int IsATTY(int fd) { return _isatty(fd); }
2349 #  endif  // GTEST_OS_WINDOWS_MOBILE
2350 inline int StrCaseCmp(const char* s1, const char* s2) {
2351   return _stricmp(s1, s2);
2352 }
2353 inline char* StrDup(const char* src) { return _strdup(src); }
2354 # endif  // __BORLANDC__
2355
2356 # if GTEST_OS_WINDOWS_MOBILE
2357 inline int FileNo(FILE* file) { return reinterpret_cast<int>(_fileno(file)); }
2358 // Stat(), RmDir(), and IsDir() are not needed on Windows CE at this
2359 // time and thus not defined there.
2360 # else
2361 inline int FileNo(FILE* file) { return _fileno(file); }
2362 inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
2363 inline int RmDir(const char* dir) { return _rmdir(dir); }
2364 inline bool IsDir(const StatStruct& st) {
2365   return (_S_IFDIR & st.st_mode) != 0;
2366 }
2367 # endif  // GTEST_OS_WINDOWS_MOBILE
2368
2369 #else
2370
2371 typedef struct stat StatStruct;
2372
2373 inline int FileNo(FILE* file) { return fileno(file); }
2374 inline int IsATTY(int fd) { return isatty(fd); }
2375 inline int Stat(const char* path, StatStruct* buf) { return stat(path, buf); }
2376 inline int StrCaseCmp(const char* s1, const char* s2) {
2377   return strcasecmp(s1, s2);
2378 }
2379 inline char* StrDup(const char* src) { return strdup(src); }
2380 inline int RmDir(const char* dir) { return rmdir(dir); }
2381 inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
2382
2383 #endif  // GTEST_OS_WINDOWS
2384
2385 // Functions deprecated by MSVC 8.0.
2386
2387 GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996 /* deprecated function */)
2388
2389 inline const char* StrNCpy(char* dest, const char* src, size_t n) {
2390   return strncpy(dest, src, n);
2391 }
2392
2393 // ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and
2394 // StrError() aren't needed on Windows CE at this time and thus not
2395 // defined there.
2396
2397 #if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
2398 inline int ChDir(const char* dir) { return chdir(dir); }
2399 #endif
2400 inline FILE* FOpen(const char* path, const char* mode) {
2401   return fopen(path, mode);
2402 }
2403 #if !GTEST_OS_WINDOWS_MOBILE
2404 inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
2405   return freopen(path, mode, stream);
2406 }
2407 inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
2408 #endif
2409 inline int FClose(FILE* fp) { return fclose(fp); }
2410 #if !GTEST_OS_WINDOWS_MOBILE
2411 inline int Read(int fd, void* buf, unsigned int count) {
2412   return static_cast<int>(read(fd, buf, count));
2413 }
2414 inline int Write(int fd, const void* buf, unsigned int count) {
2415   return static_cast<int>(write(fd, buf, count));
2416 }
2417 inline int Close(int fd) { return close(fd); }
2418 inline const char* StrError(int errnum) { return strerror(errnum); }
2419 #endif
2420 inline const char* GetEnv(const char* name) {
2421 #if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE | GTEST_OS_WINDOWS_RT
2422   // We are on Windows CE, which has no environment variables.
2423   static_cast<void>(name);  // To prevent 'unused argument' warning.
2424   return NULL;
2425 #elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
2426   // Environment variables which we programmatically clear will be set to the
2427   // empty string rather than unset (NULL).  Handle that case.
2428   const char* const env = getenv(name);
2429   return (env != NULL && env[0] != '\0') ? env : NULL;
2430 #else
2431   return getenv(name);
2432 #endif
2433 }
2434
2435 GTEST_DISABLE_MSC_WARNINGS_POP_()
2436
2437 #if GTEST_OS_WINDOWS_MOBILE
2438 // Windows CE has no C library. The abort() function is used in
2439 // several places in Google Test. This implementation provides a reasonable
2440 // imitation of standard behaviour.
2441 void Abort();
2442 #else
2443 inline void Abort() { abort(); }
2444 #endif  // GTEST_OS_WINDOWS_MOBILE
2445
2446 }  // namespace posix
2447
2448 // MSVC "deprecates" snprintf and issues warnings wherever it is used.  In
2449 // order to avoid these warnings, we need to use _snprintf or _snprintf_s on
2450 // MSVC-based platforms.  We map the GTEST_SNPRINTF_ macro to the appropriate
2451 // function in order to achieve that.  We use macro definition here because
2452 // snprintf is a variadic function.
2453 #if defined(_MSC_VER) && _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
2454 // MSVC 2005 and above support variadic macros.
2455 # define GTEST_SNPRINTF_(buffer, size, format, ...) \
2456      _snprintf_s(buffer, size, size, format, __VA_ARGS__)
2457 #elif defined(_MSC_VER)
2458 // Windows CE does not define _snprintf_s and MSVC prior to 2005 doesn't
2459 // complain about _snprintf.
2460 # define GTEST_SNPRINTF_ _snprintf
2461 #else
2462 # define GTEST_SNPRINTF_ snprintf
2463 #endif
2464
2465 // The maximum number a BiggestInt can represent.  This definition
2466 // works no matter BiggestInt is represented in one's complement or
2467 // two's complement.
2468 //
2469 // We cannot rely on numeric_limits in STL, as __int64 and long long
2470 // are not part of standard C++ and numeric_limits doesn't need to be
2471 // defined for them.
2472 const BiggestInt kMaxBiggestInt =
2473     ~(static_cast<BiggestInt>(1) << (8*sizeof(BiggestInt) - 1));
2474
2475 // This template class serves as a compile-time function from size to
2476 // type.  It maps a size in bytes to a primitive type with that
2477 // size. e.g.
2478 //
2479 //   TypeWithSize<4>::UInt
2480 //
2481 // is typedef-ed to be unsigned int (unsigned integer made up of 4
2482 // bytes).
2483 //
2484 // Such functionality should belong to STL, but I cannot find it
2485 // there.
2486 //
2487 // Google Test uses this class in the implementation of floating-point
2488 // comparison.
2489 //
2490 // For now it only handles UInt (unsigned int) as that's all Google Test
2491 // needs.  Other types can be easily added in the future if need
2492 // arises.
2493 template <size_t size>
2494 class TypeWithSize {
2495  public:
2496   // This prevents the user from using TypeWithSize<N> with incorrect
2497   // values of N.
2498   typedef void UInt;
2499 };
2500
2501 // The specialization for size 4.
2502 template <>
2503 class TypeWithSize<4> {
2504  public:
2505   // unsigned int has size 4 in both gcc and MSVC.
2506   //
2507   // As base/basictypes.h doesn't compile on Windows, we cannot use
2508   // uint32, uint64, and etc here.
2509   typedef int Int;
2510   typedef unsigned int UInt;
2511 };
2512
2513 // The specialization for size 8.
2514 template <>
2515 class TypeWithSize<8> {
2516  public:
2517 #if GTEST_OS_WINDOWS
2518   typedef __int64 Int;
2519   typedef unsigned __int64 UInt;
2520 #else
2521   typedef long long Int;  // NOLINT
2522   typedef unsigned long long UInt;  // NOLINT
2523 #endif  // GTEST_OS_WINDOWS
2524 };
2525
2526 // Integer types of known sizes.
2527 typedef TypeWithSize<4>::Int Int32;
2528 typedef TypeWithSize<4>::UInt UInt32;
2529 typedef TypeWithSize<8>::Int Int64;
2530 typedef TypeWithSize<8>::UInt UInt64;
2531 typedef TypeWithSize<8>::Int TimeInMillis;  // Represents time in milliseconds.
2532
2533 // Utilities for command line flags and environment variables.
2534
2535 // Macro for referencing flags.
2536 #if !defined(GTEST_FLAG)
2537 # define GTEST_FLAG(name) FLAGS_gtest_##name
2538 #endif  // !defined(GTEST_FLAG)
2539
2540 #if !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)
2541 # define GTEST_USE_OWN_FLAGFILE_FLAG_ 1
2542 #endif  // !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)
2543
2544 #if !defined(GTEST_DECLARE_bool_)
2545 # define GTEST_FLAG_SAVER_ ::testing::internal::GTestFlagSaver
2546
2547 // Macros for declaring flags.
2548 # define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
2549 # define GTEST_DECLARE_int32_(name) \
2550     GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
2551 #define GTEST_DECLARE_string_(name) \
2552     GTEST_API_ extern ::std::string GTEST_FLAG(name)
2553
2554 // Macros for defining flags.
2555 #define GTEST_DEFINE_bool_(name, default_val, doc) \
2556     GTEST_API_ bool GTEST_FLAG(name) = (default_val)
2557 #define GTEST_DEFINE_int32_(name, default_val, doc) \
2558     GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
2559 #define GTEST_DEFINE_string_(name, default_val, doc) \
2560     GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)
2561
2562 #endif  // !defined(GTEST_DECLARE_bool_)
2563
2564 // Thread annotations
2565 #if !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
2566 # define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
2567 # define GTEST_LOCK_EXCLUDED_(locks)
2568 #endif  // !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
2569
2570 // Parses 'str' for a 32-bit signed integer.  If successful, writes the result
2571 // to *value and returns true; otherwise leaves *value unchanged and returns
2572 // false.
2573 // TODO(chandlerc): Find a better way to refactor flag and environment parsing
2574 // out of both gtest-port.cc and gtest.cc to avoid exporting this utility
2575 // function.
2576 bool ParseInt32(const Message& src_text, const char* str, Int32* value);
2577
2578 // Parses a bool/Int32/string from the environment variable
2579 // corresponding to the given Google Test flag.
2580 bool BoolFromGTestEnv(const char* flag, bool default_val);
2581 GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
2582 std::string StringFromGTestEnv(const char* flag, const char* default_val);
2583
2584 }  // namespace internal
2585 }  // namespace testing
2586
2587 #endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_