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