gtest-port.h 88.2 KB
Newer Older
shiqian's avatar
shiqian committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
// Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
//     * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
//     * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: wan@google.com (Zhanyong Wan)
//
// Low-level types and utilities for porting Google Test to various
33
34
35
36
37
// platforms.  All macros ending with _ and symbols defined in an
// internal namespace are subject to change without notice.  Code
// outside Google Test MUST NOT USE THEM DIRECTLY.  Macros that don't
// end with _ are part of Google Test's public API and can be used by
// code outside Google Test.
38
39
40
41
//
// This file is fundamental to Google Test.  All other Google Test source
// files are expected to #include this.  Therefore, it cannot #include
// any other Google Test header.
shiqian's avatar
shiqian committed
42
43
44
45

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_

46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
// Environment-describing macros
// -----------------------------
//
// Google Test can be used in many different environments.  Macros in
// this section tell Google Test what kind of environment it is being
// used in, such that Google Test can provide environment-specific
// features and implementations.
//
// Google Test tries to automatically detect the properties of its
// environment, so users usually don't need to worry about these
// macros.  However, the automatic detection is not perfect.
// Sometimes it's necessary for a user to define some of the following
// macros in the build script to override Google Test's decisions.
//
// If the user doesn't define a macro in the list, Google Test will
// provide a default definition.  After this header is #included, all
// macros in this list will be defined to either 1 or 0.
//
// Notes to maintainers:
//   - Each macro here is a user-tweakable knob; do not grow the list
//     lightly.
//   - Use #if to key off these macros.  Don't use #ifdef or "#if
//     defined(...)", which will not work as these macros are ALWAYS
//     defined.
shiqian's avatar
shiqian committed
70
//
71
72
//   GTEST_HAS_CLONE          - Define it to 1/0 to indicate that clone(2)
//                              is/isn't available.
73
74
//   GTEST_HAS_EXCEPTIONS     - Define it to 1/0 to indicate that exceptions
//                              are enabled.
shiqian's avatar
shiqian committed
75
76
77
78
79
80
//   GTEST_HAS_GLOBAL_STRING  - Define it to 1/0 to indicate that ::string
//                              is/isn't available (some systems define
//                              ::string, which is different to std::string).
//   GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string
//                              is/isn't available (some systems define
//                              ::wstring, which is different to std::wstring).
81
82
//   GTEST_HAS_POSIX_RE       - Define it to 1/0 to indicate that POSIX regular
//                              expressions are/aren't available.
shiqian's avatar
shiqian committed
83
84
//   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that <pthread.h>
//                              is/isn't available.
85
86
87
88
89
//   GTEST_HAS_RTTI           - Define it to 1/0 to indicate that RTTI is/isn't
//                              enabled.
//   GTEST_HAS_STD_WSTRING    - Define it to 1/0 to indicate that
//                              std::wstring does/doesn't work (Google Test can
//                              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
93
94
//   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
//                              compiler supports Microsoft's "Structured
//                              Exception Handling".
95
96
97
98
//   GTEST_HAS_STREAM_REDIRECTION
//                            - Define it to 1/0 to indicate whether the
//                              platform supports I/O stream redirection using
//                              dup() and dup2().
99
100
101
102
//   GTEST_USE_OWN_TR1_TUPLE  - Define it to 1/0 to indicate whether Google
//                              Test's own tr1 tuple implementation should be
//                              used.  Unused when the user sets
//                              GTEST_HAS_TR1_TUPLE to 0.
103
104
//   GTEST_LANG_CXX11         - Define it to 1/0 to indicate that Google Test
//                              is building in C++11/C++98 mode.
105
106
107
108
109
110
111
//   GTEST_LINKED_AS_SHARED_LIBRARY
//                            - Define to 1 when compiling tests that use
//                              Google Test as a shared library (known as
//                              DLL on Windows).
//   GTEST_CREATE_SHARED_LIBRARY
//                            - Define to 1 when compiling Google Test itself
//                              as a shared library.
shiqian's avatar
shiqian committed
112

113
114
115
116
117
118
119
120
// Platform-indicating macros
// --------------------------
//
// Macros indicating the platform on which Google Test is being used
// (a macro is defined to 1 if compiled on the given platform;
// otherwise UNDEFINED -- it's never defined to 0.).  Google Test
// defines these macros automatically.  Code outside Google Test MUST
// NOT define them.
shiqian's avatar
shiqian committed
121
//
122
//   GTEST_OS_AIX      - IBM AIX
zhanyong.wan's avatar
zhanyong.wan committed
123
//   GTEST_OS_CYGWIN   - Cygwin
kosak's avatar
kosak committed
124
//   GTEST_OS_FREEBSD  - FreeBSD
125
//   GTEST_OS_HPUX     - HP-UX
zhanyong.wan's avatar
zhanyong.wan committed
126
//   GTEST_OS_LINUX    - Linux
127
//     GTEST_OS_LINUX_ANDROID - Google Android
zhanyong.wan's avatar
zhanyong.wan committed
128
//   GTEST_OS_MAC      - Mac OS X
jgm's avatar
jgm committed
129
//     GTEST_OS_IOS    - iOS
130
//   GTEST_OS_NACL     - Google Native Client (NaCl)
131
//   GTEST_OS_OPENBSD  - OpenBSD
132
//   GTEST_OS_QNX      - QNX
zhanyong.wan's avatar
zhanyong.wan committed
133
134
//   GTEST_OS_SOLARIS  - Sun Solaris
//   GTEST_OS_SYMBIAN  - Symbian
135
136
137
//   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
//     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
//     GTEST_OS_WINDOWS_MINGW    - MinGW
138
//     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
billydonahue's avatar
billydonahue committed
139
140
//     GTEST_OS_WINDOWS_PHONE    - Windows Phone
//     GTEST_OS_WINDOWS_RT       - Windows Store App/WinRT
zhanyong.wan's avatar
zhanyong.wan committed
141
//   GTEST_OS_ZOS      - z/OS
142
//
143
144
145
146
147
148
149
// Among the platforms, Cygwin, Linux, Max OS X, and Windows have the
// most stable support.  Since core members of the Google Test project
// don't have access to other platforms, support for them may be less
// stable.  If you notice any problems on your platform, please notify
// googletestframework@googlegroups.com (patches for fixing them are
// even more welcome!).
//
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
// It is possible that none of the GTEST_OS_* macros are defined.

// Feature-indicating macros
// -------------------------
//
// Macros indicating which Google Test features are available (a macro
// is defined to 1 if the corresponding feature is supported;
// otherwise UNDEFINED -- it's never defined to 0.).  Google Test
// defines these macros automatically.  Code outside Google Test MUST
// NOT define them.
//
// These macros are public so that portable tests can be written.
// Such tests typically surround code using a feature with an #if
// which controls that code.  For example:
//
// #if GTEST_HAS_DEATH_TEST
//   EXPECT_DEATH(DoSomethingDeadly());
// #endif
shiqian's avatar
shiqian committed
168
//
zhanyong.wan's avatar
zhanyong.wan committed
169
170
171
172
173
174
//   GTEST_HAS_COMBINE      - the Combine() function (for value-parameterized
//                            tests)
//   GTEST_HAS_DEATH_TEST   - death tests
//   GTEST_HAS_PARAM_TEST   - value-parameterized tests
//   GTEST_HAS_TYPED_TEST   - typed tests
//   GTEST_HAS_TYPED_TEST_P - type-parameterized tests
175
//   GTEST_IS_THREADSAFE    - Google Test is thread-safe.
176
177
178
//   GTEST_USES_POSIX_RE    - enhanced POSIX regex is used. Do not confuse with
//                            GTEST_HAS_POSIX_RE (see above) which users can
//                            define themselves.
zhanyong.wan's avatar
zhanyong.wan committed
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
184
185
186
187
188
189
190
191
192
193

// Misc public macros
// ------------------
//
//   GTEST_FLAG(flag_name)  - references the variable corresponding to
//                            the given Google Test flag.

// Internal utilities
// ------------------
//
// The following macros and utilities are for Google Test's INTERNAL
// use only.  Code outside Google Test MUST NOT USE THEM DIRECTLY.
shiqian's avatar
shiqian committed
194
195
//
// Macros for basic C++ coding:
shiqian's avatar
shiqian committed
196
//   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
197
198
//   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
//                              variable don't have to be used.
199
//   GTEST_DISALLOW_ASSIGN_   - disables operator=.
shiqian's avatar
shiqian committed
200
201
//   GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
//   GTEST_MUST_USE_RESULT_   - declares that a function's result must be used.
202
203
204
205
//   GTEST_INTENTIONAL_CONST_COND_PUSH_ - start code section where MSVC C4127 is
//                                        suppressed (constant conditional).
//   GTEST_INTENTIONAL_CONST_COND_POP_  - finish code section where MSVC C4127
//                                        is suppressed.
shiqian's avatar
shiqian committed
206
//
207
208
// C++11 feature wrappers:
//
209
//   testing::internal::move  - portability wrapper for std::move.
210
//
shiqian's avatar
shiqian committed
211
212
// Synchronization:
//   Mutex, MutexLock, ThreadLocal, GetThreadCount()
213
//                            - synchronization primitives.
shiqian's avatar
shiqian committed
214
215
//
// Template meta programming:
216
//   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
217
218
//   IteratorTraits - partial implementation of std::iterator_traits, which
//                    is not available in libCstd when compiled with Sun C++.
shiqian's avatar
shiqian committed
219
220
221
222
223
224
//
// Smart pointers:
//   scoped_ptr     - as in TR2.
//
// Regular expressions:
//   RE             - a simple regular expression class using the POSIX
225
226
227
//                    Extended Regular Expression syntax on UNIX-like
//                    platforms, or a reduced regular exception syntax on
//                    other platforms, including Windows.
shiqian's avatar
shiqian committed
228
229
//
// Logging:
shiqian's avatar
shiqian committed
230
//   GTEST_LOG_()   - logs messages at the specified severity level.
shiqian's avatar
shiqian committed
231
232
233
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.
//
234
235
236
237
// Stdout and stderr capturing:
//   CaptureStdout()     - starts capturing stdout.
//   GetCapturedStdout() - stops capturing stdout and returns the captured
//                         string.
shiqian's avatar
shiqian committed
238
239
240
241
242
243
244
245
246
247
248
249
250
//   CaptureStderr()     - starts capturing stderr.
//   GetCapturedStderr() - stops capturing stderr and returns the captured
//                         string.
//
// Integer types:
//   TypeWithSize   - maps an integer to a int type.
//   Int32, UInt32, Int64, UInt64, TimeInMillis
//                  - integers of known sizes.
//   BiggestInt     - the biggest signed integer type.
//
// Command-line utilities:
//   GTEST_DECLARE_*()  - declares a flag.
//   GTEST_DEFINE_*()   - defines a flag.
251
//   GetInjectableArgvs() - returns the command line as a vector of strings.
shiqian's avatar
shiqian committed
252
253
254
255
256
257
258
//
// Environment variable utilities:
//   GetEnv()             - gets the value of an environment variable.
//   BoolFromGTestEnv()   - parses a bool environment variable.
//   Int32FromGTestEnv()  - parses an Int32 environment variable.
//   StringFromGTestEnv() - parses a string environment variable.

259
260
#include <ctype.h>   // for isspace, etc
#include <stddef.h>  // for ptrdiff_t
shiqian's avatar
shiqian committed
261
262
#include <stdlib.h>
#include <stdio.h>
263
#include <string.h>
264
#ifndef _WIN32_WCE
265
266
# include <sys/types.h>
# include <sys/stat.h>
267
#endif  // !_WIN32_WCE
268

jgm's avatar
jgm committed
269
270
271
272
273
#if defined __APPLE__
# include <AvailabilityMacros.h>
# include <TargetConditionals.h>
#endif

billydonahue's avatar
billydonahue committed
274
#include <algorithm>  // NOLINT
275
#include <iostream>  // NOLINT
276
277
#include <sstream>  // NOLINT
#include <string>  // NOLINT
278
#include <utility>
279
#include <vector>  // NOLINT
shiqian's avatar
shiqian committed
280

281
282
283
284
285
286
287
288
289
#include "gtest/internal/gtest-port-arch.h"
#include "gtest/internal/custom/gtest-port.h"

#if !defined(GTEST_DEV_EMAIL_)
# define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
# define GTEST_FLAG_PREFIX_ "gtest_"
# define GTEST_FLAG_PREFIX_DASH_ "gtest-"
# define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
# define GTEST_NAME_ "Google Test"
290
# define GTEST_PROJECT_URL_ "https://github.com/google/googletest/"
291
#endif  // !defined(GTEST_DEV_EMAIL_)
shiqian's avatar
shiqian committed
292

293
294
295
296
#if !defined(GTEST_INIT_GOOGLE_TEST_NAME_)
# define GTEST_INIT_GOOGLE_TEST_NAME_ "testing::InitGoogleTest"
#endif  // !defined(GTEST_INIT_GOOGLE_TEST_NAME_)

shiqian's avatar
shiqian committed
297
298
299
// Determines the version of gcc that is used to compile this.
#ifdef __GNUC__
// 40302 means version 4.3.2.
300
# define GTEST_GCC_VER_ \
shiqian's avatar
shiqian committed
301
302
303
    (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
#endif  // __GNUC__

billydonahue's avatar
billydonahue committed
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
// Macros for disabling Microsoft Visual C++ warnings.
//
//   GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 4385)
//   /* code that triggers warnings C4800 and C4385 */
//   GTEST_DISABLE_MSC_WARNINGS_POP_()
#if _MSC_VER >= 1500
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings) \
    __pragma(warning(push))                        \
    __pragma(warning(disable: warnings))
# define GTEST_DISABLE_MSC_WARNINGS_POP_()          \
    __pragma(warning(pop))
#else
// Older versions of MSVC don't have __pragma.
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings)
# define GTEST_DISABLE_MSC_WARNINGS_POP_()
#endif

321
322
323
324
325
326
327
328
329
330
331
332
333
#ifndef GTEST_LANG_CXX11
// gcc and clang define __GXX_EXPERIMENTAL_CXX0X__ when
// -std={c,gnu}++{0x,11} is passed.  The C++11 standard specifies a
// value for __cplusplus, and recent versions of clang, gcc, and
// probably other compilers set that too in C++11 mode.
# if __GXX_EXPERIMENTAL_CXX0X__ || __cplusplus >= 201103L
// Compiling in at least C++11 mode.
#  define GTEST_LANG_CXX11 1
# else
#  define GTEST_LANG_CXX11 0
# endif
#endif

334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
// Distinct from C++11 language support, some environments don't provide
// proper C++11 library support. Notably, it's possible to build in
// C++11 mode when targeting Mac OS X 10.6, which has an old libstdc++
// with no C++11 support.
//
// libstdc++ has sufficient C++11 support as of GCC 4.6.0, __GLIBCXX__
// 20110325, but maintenance releases in the 4.4 and 4.5 series followed
// this date, so check for those versions by their date stamps.
// https://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html#abi.versioning
#if GTEST_LANG_CXX11 && \
    (!defined(__GLIBCXX__) || ( \
        __GLIBCXX__ >= 20110325ul &&  /* GCC >= 4.6.0 */ \
        /* Blacklist of patch releases of older branches: */ \
        __GLIBCXX__ != 20110416ul &&  /* GCC 4.4.6 */ \
        __GLIBCXX__ != 20120313ul &&  /* GCC 4.4.7 */ \
        __GLIBCXX__ != 20110428ul &&  /* GCC 4.5.3 */ \
        __GLIBCXX__ != 20120702ul))   /* GCC 4.5.4 */
# define GTEST_STDLIB_CXX11 1
#endif

// Only use C++11 library features if the library provides them.
#if GTEST_STDLIB_CXX11
# define GTEST_HAS_STD_BEGIN_AND_END_ 1
# define GTEST_HAS_STD_FORWARD_LIST_ 1
# define GTEST_HAS_STD_FUNCTION_ 1
359
# define GTEST_HAS_STD_INITIALIZER_LIST_ 1
360
# define GTEST_HAS_STD_MOVE_ 1
kosak's avatar
kosak committed
361
# define GTEST_HAS_STD_SHARED_PTR_ 1
362
363
# define GTEST_HAS_STD_TYPE_TRAITS_ 1
# define GTEST_HAS_STD_UNIQUE_PTR_ 1
364
365
#endif

366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
// C++11 specifies that <tuple> provides std::tuple.
// Some platforms still might not have it, however.
#if GTEST_LANG_CXX11
# define GTEST_HAS_STD_TUPLE_ 1
# if defined(__clang__)
// Inspired by http://clang.llvm.org/docs/LanguageExtensions.html#__has_include
#  if defined(__has_include) && !__has_include(<tuple>)
#   undef GTEST_HAS_STD_TUPLE_
#  endif
# elif defined(_MSC_VER)
// Inspired by boost/config/stdlib/dinkumware.hpp
#  if defined(_CPPLIB_VER) && _CPPLIB_VER < 520
#   undef GTEST_HAS_STD_TUPLE_
#  endif
# elif defined(__GLIBCXX__)
// Inspired by boost/config/stdlib/libstdcpp3.hpp,
// http://gcc.gnu.org/gcc-4.2/changes.html and
// http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt01ch01.html#manual.intro.status.standard.200x
#  if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 2)
#   undef GTEST_HAS_STD_TUPLE_
#  endif
# endif
#endif

390
391
392
// Brings in definitions for functions used in the testing::internal::posix
// namespace (read, write, close, chdir, isatty, stat). We do not currently
// use them on Windows Mobile.
393
394
395
396
397
398
#if GTEST_OS_WINDOWS
# if !GTEST_OS_WINDOWS_MOBILE
#  include <direct.h>
#  include <io.h>
# endif
// In order to avoid having to include <windows.h>, use forward declaration
Arkadiy Shapkin's avatar
Arkadiy Shapkin committed
399
#if GTEST_OS_WINDOWS_MINGW && !defined(__MINGW64_VERSION_MAJOR)
400
401
402
403
404
// MinGW defined _CRITICAL_SECTION and _RTL_CRITICAL_SECTION as two
// separate (equivalent) structs, instead of using typedef
typedef struct _CRITICAL_SECTION GTEST_CRITICAL_SECTION;
#else
// Assume CRITICAL_SECTION is a typedef of _RTL_CRITICAL_SECTION.
405
406
// This assumption is verified by
// WindowsTypesTest.CRITICAL_SECTIONIs_RTL_CRITICAL_SECTION.
407
408
typedef struct _RTL_CRITICAL_SECTION GTEST_CRITICAL_SECTION;
#endif
409
#else
410
411
412
// This assumes that non-Windows OSes provide unistd.h. For OSes where this
// is not the case, we need to include headers that provide the functions
// mentioned above.
413
# include <unistd.h>
414
# include <strings.h>
415
#endif  // GTEST_OS_WINDOWS
416

417
418
419
420
421
#if GTEST_OS_LINUX_ANDROID
// Used to define __ANDROID_API__ matching the target NDK API level.
#  include <android/api-level.h>  // NOLINT
#endif

422
423
// Defines this to true iff Google Test can use POSIX regular expressions.
#ifndef GTEST_HAS_POSIX_RE
424
425
426
427
428
429
# if GTEST_OS_LINUX_ANDROID
// On Android, <regex.h> is only available starting with Gingerbread.
#  define GTEST_HAS_POSIX_RE (__ANDROID_API__ >= 9)
# else
#  define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS)
# endif
430
431
#endif

432
433
434
435
#if GTEST_USES_PCRE
// The appropriate headers have already been included.

#elif GTEST_HAS_POSIX_RE
436
437
438
439
440

// On some platforms, <regex.h> needs someone to define size_t, and
// won't compile otherwise.  We can #include it here as we already
// included <stdlib.h>, which is guaranteed to define size_t through
// <stddef.h>.
441
# include <regex.h>  // NOLINT
442

443
# define GTEST_USES_POSIX_RE 1
444

445
446
447
448
#elif GTEST_OS_WINDOWS

// <regex.h> is not available on Windows.  Use our own simple regex
// implementation instead.
449
# define GTEST_USES_SIMPLE_RE 1
450

451
452
#else

453
454
// <regex.h> may not be available on this platform.  Use our own
// simple regex implementation instead.
455
# define GTEST_USES_SIMPLE_RE 1
456

457
#endif  // GTEST_USES_PCRE
458

459
460
461
#ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
462
# if defined(_MSC_VER) || defined(__BORLANDC__)
463
464
// MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS
// macro to enable exceptions, so we'll do the same.
shiqian's avatar
shiqian committed
465
// Assumes that exceptions are enabled by default.
466
467
468
469
#  ifndef _HAS_EXCEPTIONS
#   define _HAS_EXCEPTIONS 1
#  endif  // _HAS_EXCEPTIONS
#  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
470
# elif defined(__clang__)
471
472
473
474
475
476
477
// clang defines __EXCEPTIONS iff exceptions are enabled before clang 220714,
// but iff cleanups are enabled after that. In Obj-C++ files, there can be
// cleanups for ObjC exceptions which also need cleanups, even if C++ exceptions
// are disabled. clang has __has_feature(cxx_exceptions) which checks for C++
// exceptions starting at clang r206352, but which checked for cleanups prior to
// that. To reliably check for C++ exception availability with clang, check for
// __EXCEPTIONS && __has_feature(cxx_exceptions).
kosak's avatar
kosak committed
478
#  define GTEST_HAS_EXCEPTIONS (__EXCEPTIONS && __has_feature(cxx_exceptions))
479
# elif defined(__GNUC__) && __EXCEPTIONS
480
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
481
482
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
483
484
485
// Sun Pro CC supports exceptions.  However, there is no compile-time way of
// detecting whether they are enabled or not.  Therefore, we assume that
// they are enabled unless the user tells us otherwise.
486
487
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
488
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
489
#  define GTEST_HAS_EXCEPTIONS 1
490
491
492
493
# elif defined(__HP_aCC)
// Exception handling is in effect by default in HP aCC compiler. It has to
// be turned of by +noeh compiler option if desired.
#  define GTEST_HAS_EXCEPTIONS 1
494
# else
495
496
// For other compilers, we assume exceptions are disabled to be
// conservative.
497
498
#  define GTEST_HAS_EXCEPTIONS 0
# endif  // defined(_MSC_VER) || defined(__BORLANDC__)
499
#endif  // GTEST_HAS_EXCEPTIONS
shiqian's avatar
shiqian committed
500

501
502
503
#if !defined(GTEST_HAS_STD_STRING)
// Even though we don't use this macro any longer, we keep it in case
// some clients still depend on it.
504
# define GTEST_HAS_STD_STRING 1
505
506
#elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
507
# error "Google Test cannot be used where ::std::string isn't available."
508
#endif  // !defined(GTEST_HAS_STD_STRING)
shiqian's avatar
shiqian committed
509
510
511
512
513

#ifndef GTEST_HAS_GLOBAL_STRING
// The user didn't tell us whether ::string is available, so we need
// to figure it out.

514
# define GTEST_HAS_GLOBAL_STRING 0
shiqian's avatar
shiqian committed
515
516
517
518
519
520
521
522
523

#endif  // GTEST_HAS_GLOBAL_STRING

#ifndef GTEST_HAS_STD_WSTRING
// The user didn't tell us whether ::std::wstring is available, so we need
// to figure it out.
// TODO(wan@google.com): uses autoconf to detect whether ::std::wstring
//   is available.

524
// Cygwin 1.7 and below doesn't support ::std::wstring.
525
526
527
528
// Solaris' libc++ doesn't support it either.  Android has
// no support for it at least as recent as Froyo (2.2).
# define GTEST_HAS_STD_WSTRING \
    (!(GTEST_OS_LINUX_ANDROID || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS))
shiqian's avatar
shiqian committed
529
530
531
532
533
534

#endif  // GTEST_HAS_STD_WSTRING

#ifndef GTEST_HAS_GLOBAL_WSTRING
// The user didn't tell us whether ::wstring is available, so we need
// to figure it out.
535
# define GTEST_HAS_GLOBAL_WSTRING \
536
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
shiqian's avatar
shiqian committed
537
538
#endif  // GTEST_HAS_GLOBAL_WSTRING

shiqian's avatar
shiqian committed
539
540
541
542
543
// Determines whether RTTI is available.
#ifndef GTEST_HAS_RTTI
// The user didn't tell us whether RTTI is enabled, so we need to
// figure it out.

544
# ifdef _MSC_VER
shiqian's avatar
shiqian committed
545

546
547
548
549
550
#  ifdef _CPPRTTI  // MSVC defines this macro iff RTTI is enabled.
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
shiqian's avatar
shiqian committed
551
552

// Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled.
553
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302)
554

555
#  ifdef __GXX_RTTI
556
557
558
559
560
561
562
563
564
565
// When building against STLport with the Android NDK and with
// -frtti -fno-exceptions, the build fails at link time with undefined
// references to __cxa_bad_typeid. Note sure if STL or toolchain bug,
// so disable RTTI when detected.
#   if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR) && \
       !defined(__EXCEPTIONS)
#    define GTEST_HAS_RTTI 0
#   else
#    define GTEST_HAS_RTTI 1
#   endif  // GTEST_OS_LINUX_ANDROID && __STLPORT_MAJOR && !__EXCEPTIONS
566
567
568
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI
shiqian's avatar
shiqian committed
569

570
571
572
573
574
575
576
// Clang defines __GXX_RTTI starting with version 3.0, but its manual recommends
// using has_feature instead. has_feature(cxx_rtti) is supported since 2.7, the
// first version with C++ support.
# elif defined(__clang__)

#  define GTEST_HAS_RTTI __has_feature(cxx_rtti)

577
578
// Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if
// both the typeid and dynamic_cast features are present.
579
# elif defined(__IBMCPP__) && (__IBMCPP__ >= 900)
580

581
582
583
584
585
#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
586

587
# else
shiqian's avatar
shiqian committed
588

589
// For all other compilers, we assume RTTI is enabled.
590
#  define GTEST_HAS_RTTI 1
shiqian's avatar
shiqian committed
591

592
# endif  // _MSC_VER
shiqian's avatar
shiqian committed
593
594
595

#endif  // GTEST_HAS_RTTI

596
597
598
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
#if GTEST_HAS_RTTI
599
# include <typeinfo>
600
601
#endif

602
// Determines whether Google Test can use the pthreads library.
shiqian's avatar
shiqian committed
603
#ifndef GTEST_HAS_PTHREAD
604
605
// The user didn't tell us explicitly, so we make reasonable assumptions about
// which platforms have pthreads support.
606
607
608
//
// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
// to your compiler flags.
609
# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \
610
    || GTEST_OS_QNX || GTEST_OS_FREEBSD || GTEST_OS_NACL)
shiqian's avatar
shiqian committed
611
612
#endif  // GTEST_HAS_PTHREAD

613
614
615
#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
616
# include <pthread.h>  // NOLINT
617
618

// For timespec and nanosleep, used below.
619
# include <time.h>  // NOLINT
620
621
#endif

622
623
624
// Determines if hash_map/hash_set are available.
// Only used for testing against those containers.
#if !defined(GTEST_HAS_HASH_MAP_)
625
# if defined(_MSC_VER) && (_MSC_VER < 1900)
626
627
628
629
630
#  define GTEST_HAS_HASH_MAP_ 1  // Indicates that hash_map is available.
#  define GTEST_HAS_HASH_SET_ 1  // Indicates that hash_set is available.
# endif  // _MSC_VER
#endif  // !defined(GTEST_HAS_HASH_MAP_)

631
632
633
// Determines whether Google Test can use tr1/tuple.  You can define
// this macro to 0 to prevent Google Test from using tuple (any
// feature depending on tuple with be disabled in this mode).
634
#ifndef GTEST_HAS_TR1_TUPLE
635
636
637
638
# if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR)
// STLport, provided with the Android NDK, has neither <tr1/tuple> or <tuple>.
#  define GTEST_HAS_TR1_TUPLE 0
# else
639
// The user didn't tell us not to do it, so we assume it's OK.
640
641
#  define GTEST_HAS_TR1_TUPLE 1
# endif
642
643
644
645
646
#endif  // GTEST_HAS_TR1_TUPLE

// Determines whether Google Test's own tr1 tuple implementation
// should be used.
#ifndef GTEST_USE_OWN_TR1_TUPLE
647
648
// The user didn't tell us, so we need to figure it out.

649
// We use our own TR1 tuple if we aren't sure the user has an
650
651
652
653
654
655
656
657
658
// implementation of it already.  At this time, libstdc++ 4.0.0+ and
// MSVC 2010 are the only mainstream standard libraries that come
// with a TR1 tuple implementation.  NVIDIA's CUDA NVCC compiler
// pretends to be GCC by defining __GNUC__ and friends, but cannot
// compile GCC's tuple implementation.  MSVC 2008 (9.0) provides TR1
// tuple in a 323 MB Feature Pack download, which we cannot assume the
// user has.  QNX's QCC compiler is a modified GCC but it doesn't
// support TR1 tuple.  libc++ only provides std::tuple, in C++11 mode,
// and it can be used with some compilers that define __GNUC__.
659
# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \
660
661
662
663
      && !GTEST_OS_QNX && !defined(_LIBCPP_VERSION)) || _MSC_VER >= 1600
#  define GTEST_ENV_HAS_TR1_TUPLE_ 1
# endif

664
665
666
667
// C++11 specifies that <tuple> provides std::tuple. Use that if gtest is used
// in C++11 mode and libstdc++ isn't very old (binaries targeting OS X 10.6
// can build with clang but need to use gcc4.2's libstdc++).
# if GTEST_LANG_CXX11 && (!defined(__GLIBCXX__) || __GLIBCXX__ > 20110325)
668
669
670
671
#  define GTEST_ENV_HAS_STD_TUPLE_ 1
# endif

# if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
672
673
674
675
#  define GTEST_USE_OWN_TR1_TUPLE 0
# else
#  define GTEST_USE_OWN_TR1_TUPLE 1
# endif
676
677

#endif  // GTEST_USE_OWN_TR1_TUPLE
678

679
680
// To avoid conditional compilation everywhere, we make it
// gtest-port.h's responsibility to #include the header implementing
681
// tuple.
billydonahue's avatar
billydonahue committed
682
683
#if GTEST_HAS_STD_TUPLE_
# include <tuple>  // IWYU pragma: export
684
# define GTEST_TUPLE_NAMESPACE_ ::std
billydonahue's avatar
billydonahue committed
685
#endif  // GTEST_HAS_STD_TUPLE_
686

billydonahue's avatar
billydonahue committed
687
688
// We include tr1::tuple even if std::tuple is available to define printers for
// them.
689
#if GTEST_HAS_TR1_TUPLE
690
691
692
# ifndef GTEST_TUPLE_NAMESPACE_
#  define GTEST_TUPLE_NAMESPACE_ ::std::tr1
# endif  // GTEST_TUPLE_NAMESPACE_
zhanyong.wan's avatar
zhanyong.wan committed
693

694
# if GTEST_USE_OWN_TR1_TUPLE
billydonahue's avatar
billydonahue committed
695
#  include "gtest/internal/gtest-tuple.h"  // IWYU pragma: export  // NOLINT
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
# elif GTEST_ENV_HAS_STD_TUPLE_
#  include <tuple>
// C++11 puts its tuple into the ::std namespace rather than
// ::std::tr1.  gtest expects tuple to live in ::std::tr1, so put it there.
// This causes undefined behavior, but supported compilers react in
// the way we intend.
namespace std {
namespace tr1 {
using ::std::get;
using ::std::make_tuple;
using ::std::tuple;
using ::std::tuple_element;
using ::std::tuple_size;
}
}

712
# elif GTEST_OS_SYMBIAN
zhanyong.wan's avatar
zhanyong.wan committed
713
714
715
716
717
718

// On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to
// use STLport's tuple implementation, which unfortunately doesn't
// work as the copy of STLport distributed with Symbian is incomplete.
// By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to
// use its own tuple implementation.
719
720
721
#  ifdef BOOST_HAS_TR1_TUPLE
#   undef BOOST_HAS_TR1_TUPLE
#  endif  // BOOST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
722
723
724

// This prevents <boost/tr1/detail/config.hpp>, which defines
// BOOST_HAS_TR1_TUPLE, from being #included by Boost's <tuple>.
725
#  define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED
billydonahue's avatar
billydonahue committed
726
#  include <tuple>  // IWYU pragma: export  // NOLINT
zhanyong.wan's avatar
zhanyong.wan committed
727

728
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
729
730
// GCC 4.0+ implements tr1/tuple in the <tr1/tuple> header.  This does
// not conform to the TR1 spec, which requires the header to be <tuple>.
731

732
#  if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
733
734
735
736
737
// Until version 4.3.2, gcc has a bug that causes <tr1/functional>,
// which is #included by <tr1/tuple>, to not compile when RTTI is
// disabled.  _TR1_FUNCTIONAL is the header guard for
// <tr1/functional>.  Hence the following #define is a hack to prevent
// <tr1/functional> from being included.
738
739
740
#   define _TR1_FUNCTIONAL 1
#   include <tr1/tuple>
#   undef _TR1_FUNCTIONAL  // Allows the user to #include
741
                        // <tr1/functional> if he chooses to.
742
743
744
#  else
#   include <tr1/tuple>  // NOLINT
#  endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
745

746
# else
747
// If the compiler is not GCC 4.0+, we assume the user is using a
748
// spec-conforming TR1 implementation.
billydonahue's avatar
billydonahue committed
749
#  include <tuple>  // IWYU pragma: export  // NOLINT
750
# endif  // GTEST_USE_OWN_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
751

752
753
#endif  // GTEST_HAS_TR1_TUPLE

754
755
756
757
758
759
760
// Determines whether clone(2) is supported.
// Usually it will only be available on Linux, excluding
// Linux on the Itanium architecture.
// Also see http://linux.die.net/man/2/clone.
#ifndef GTEST_HAS_CLONE
// The user didn't tell us, so we need to figure it out.

761
# if GTEST_OS_LINUX && !defined(__ia64__)
762
#  if GTEST_OS_LINUX_ANDROID
763
764
765
766
767
768
// On Android, clone() became available at different API levels for each 32-bit
// architecture.
#    if defined(__LP64__) || \
        (defined(__arm__) && __ANDROID_API__ >= 9) || \
        (defined(__mips__) && __ANDROID_API__ >= 12) || \
        (defined(__i386__) && __ANDROID_API__ >= 17)
769
770
771
772
773
774
775
#     define GTEST_HAS_CLONE 1
#    else
#     define GTEST_HAS_CLONE 0
#    endif
#  else
#   define GTEST_HAS_CLONE 1
#  endif
776
777
778
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)
779
780
781

#endif  // GTEST_HAS_CLONE

782
783
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
784
785
786
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
billydonahue's avatar
billydonahue committed
787
788
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || \
    GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
789
790
791
792
#  define GTEST_HAS_STREAM_REDIRECTION 0
# else
#  define GTEST_HAS_STREAM_REDIRECTION 1
# endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
793
#endif  // GTEST_HAS_STREAM_REDIRECTION
794

shiqian's avatar
shiqian committed
795
// Determines whether to support death tests.
796
797
798
// Google Test does not support death tests for VC 7.1 and earlier as
// abort() in a VC 7.1 application compiled as GUI in debug config
// pops up a dialog window that cannot be suppressed programmatically.
jgm's avatar
jgm committed
799
#if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
800
     (GTEST_OS_MAC && !GTEST_OS_IOS) || \
801
     (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
802
     GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \
kosak's avatar
kosak committed
803
     GTEST_OS_OPENBSD || GTEST_OS_QNX || GTEST_OS_FREEBSD)
804
# define GTEST_HAS_DEATH_TEST 1
805
#endif
shiqian's avatar
shiqian committed
806

807
808
809
// We don't support MSVC 7.1 with exceptions disabled now.  Therefore
// all the compilers we care about are adequate for supporting
// value-parameterized tests.
zhanyong.wan's avatar
zhanyong.wan committed
810
#define GTEST_HAS_PARAM_TEST 1
811

812
813
// Determines whether to support type-driven tests.

814
// Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
815
// Sun Pro CC, IBM Visual Age, and HP aCC support.
816
#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
817
    defined(__IBMCPP__) || defined(__HP_aCC)
818
819
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
820
#endif
821

822
// Determines whether to support Combine(). This only makes sense when
823
824
825
826
// value-parameterized tests are enabled.  The implementation doesn't
// work on Sun Studio since it doesn't understand templated conversion
// operators.
#if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC)
827
# define GTEST_HAS_COMBINE 1
828
#endif
829

830
// Determines whether the system compiler uses UTF-16 for encoding wide strings.
zhanyong.wan's avatar
zhanyong.wan committed
831
#define GTEST_WIDE_STRING_USES_UTF16_ \
832
    (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || GTEST_OS_AIX)
833

834
835
// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
836
# define GTEST_CAN_STREAM_RESULTS_ 1
837
838
#endif

shiqian's avatar
shiqian committed
839
840
841
842
843
844
845
846
847
848
849
// Defines some utility macros.

// The GNU compiler emits a warning if nested "if" statements are followed by
// an "else" statement and braces are not used to explicitly disambiguate the
// "else" binding.  This leads to problems with code like:
//
//   if (gate)
//     ASSERT_*(condition) << "Some message";
//
// The "switch (0) case 0:" idiom is used to suppress this.
#ifdef __INTEL_COMPILER
850
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
shiqian's avatar
shiqian committed
851
#else
852
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
shiqian's avatar
shiqian committed
853
854
#endif

855
// Use this annotation at the end of a struct/class definition to
shiqian's avatar
shiqian committed
856
857
858
859
860
861
// prevent the compiler from optimizing away instances that are never
// used.  This is useful when all interesting logic happens inside the
// c'tor and / or d'tor.  Example:
//
//   struct Foo {
//     Foo() { ... }
shiqian's avatar
shiqian committed
862
//   } GTEST_ATTRIBUTE_UNUSED_;
863
864
865
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
866
#if defined(__GNUC__) && !defined(COMPILER_ICC)
867
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
868
869
870
871
872
873
#elif defined(__clang__)
# if __has_attribute(unused)
#  define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
# endif
#endif
#ifndef GTEST_ATTRIBUTE_UNUSED_
874
# define GTEST_ATTRIBUTE_UNUSED_
875
#endif
shiqian's avatar
shiqian committed
876

877
878
879
880
881
882
// A macro to disallow operator=
// This should be used in the private: declarations for a class.
#define GTEST_DISALLOW_ASSIGN_(type)\
  void operator=(type const &)

// A macro to disallow copy constructor and operator=
shiqian's avatar
shiqian committed
883
// This should be used in the private: declarations for a class.
shiqian's avatar
shiqian committed
884
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
885
886
  type(type const &);\
  GTEST_DISALLOW_ASSIGN_(type)
shiqian's avatar
shiqian committed
887
888
889
890
891

// Tell the compiler to warn about unused return values for functions declared
// with this macro.  The macro should be used on function declarations
// following the argument list:
//
shiqian's avatar
shiqian committed
892
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
shiqian's avatar
shiqian committed
893
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
894
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
shiqian's avatar
shiqian committed
895
#else
896
# define GTEST_MUST_USE_RESULT_
shiqian's avatar
shiqian committed
897
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
shiqian's avatar
shiqian committed
898

899
900
901
902
// MS C++ compiler emits warning when a conditional expression is compile time
// constant. In some contexts this warning is false positive and needs to be
// suppressed. Use the following two macros in such cases:
//
billydonahue's avatar
billydonahue committed
903
// GTEST_INTENTIONAL_CONST_COND_PUSH_()
904
// while (true) {
billydonahue's avatar
billydonahue committed
905
// GTEST_INTENTIONAL_CONST_COND_POP_()
906
// }
billydonahue's avatar
billydonahue committed
907
908
909
910
# define GTEST_INTENTIONAL_CONST_COND_PUSH_() \
    GTEST_DISABLE_MSC_WARNINGS_PUSH_(4127)
# define GTEST_INTENTIONAL_CONST_COND_POP_() \
    GTEST_DISABLE_MSC_WARNINGS_POP_()
911

912
913
914
915
916
917
// Determine whether the compiler supports Microsoft's Structured Exception
// Handling.  This is supported by several Windows compilers but generally
// does not exist on any other system.
#ifndef GTEST_HAS_SEH
// The user didn't tell us, so we need to figure it out.

918
# if defined(_MSC_VER) || defined(__BORLANDC__)
919
// These two compilers are known to support SEH.
920
921
#  define GTEST_HAS_SEH 1
# else
922
// Assume no SEH.
923
924
#  define GTEST_HAS_SEH 0
# endif
925

926
#define GTEST_IS_THREADSAFE \
927
    (GTEST_HAS_MUTEX_AND_THREAD_LOCAL_ \
928
929
     || (GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT) \
     || GTEST_HAS_PTHREAD)
930

931
932
#endif  // GTEST_HAS_SEH

933
#ifdef _MSC_VER
934
935
936
937
938
# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif
939
940
941
#elif __GNUC__ >= 4 || defined(__clang__)
# define GTEST_API_ __attribute__((visibility ("default")))
#endif // _MSC_VER
942
943

#ifndef GTEST_API_
944
# define GTEST_API_
945
946
#endif

947
#ifdef __GNUC__
948
// Ask the compiler to never inline a given function.
949
# define GTEST_NO_INLINE_ __attribute__((noinline))
950
#else
951
952
# define GTEST_NO_INLINE_
#endif
953

954
955
956
957
958
959
960
// _LIBCPP_VERSION is defined by the libc++ library from the LLVM project.
#if defined(__GLIBCXX__) || defined(_LIBCPP_VERSION)
# define GTEST_HAS_CXXABI_H_ 1
#else
# define GTEST_HAS_CXXABI_H_ 0
#endif

961
962
963
964
965
966
967
968
// A function level attribute to disable checking for use of uninitialized
// memory when built with MemorySanitizer.
#if defined(__clang__)
# if __has_feature(memory_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_ \
       __attribute__((no_sanitize_memory))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
969
# endif  // __has_feature(memory_sanitizer)
970
971
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
972
973
974
975
976
977
978
979
980
981
982
983
984
#endif  // __clang__

// A function level attribute to disable AddressSanitizer instrumentation.
#if defined(__clang__)
# if __has_feature(address_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_ \
       __attribute__((no_sanitize_address))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
# endif  // __has_feature(address_sanitizer)
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
#endif  // __clang__
985

986
987
988
989
990
991
992
993
994
995
996
997
// A function level attribute to disable ThreadSanitizer instrumentation.
#if defined(__clang__)
# if __has_feature(thread_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_ \
       __attribute__((no_sanitize_thread))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
# endif  // __has_feature(thread_sanitizer)
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
#endif  // __clang__

shiqian's avatar
shiqian committed
998
999
1000
1001
namespace testing {

class Message;

billydonahue's avatar
billydonahue committed
1002
#if defined(GTEST_TUPLE_NAMESPACE_)
1003
1004
1005
1006
1007
1008
1009
1010
// Import tuple and friends into the ::testing namespace.
// It is part of our interface, having them in ::testing allows us to change
// their types as needed.
using GTEST_TUPLE_NAMESPACE_::get;
using GTEST_TUPLE_NAMESPACE_::make_tuple;
using GTEST_TUPLE_NAMESPACE_::tuple;
using GTEST_TUPLE_NAMESPACE_::tuple_size;
using GTEST_TUPLE_NAMESPACE_::tuple_element;
billydonahue's avatar
billydonahue committed
1011
#endif  // defined(GTEST_TUPLE_NAMESPACE_)
1012

shiqian's avatar
shiqian committed
1013
1014
namespace internal {

1015
1016
1017
1018
1019
// A secret type that Google Test users don't know about.  It has no
// definition on purpose.  Therefore it's impossible to create a
// Secret object, which is what we want.
class Secret;

1020
1021
1022
1023
// The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time
// expression is true. For example, you could use it to verify the
// size of a static array:
//
1024
1025
//   GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
//                         names_incorrect_size);
1026
1027
1028
1029
1030
1031
1032
1033
1034
//
// or to make sure a struct is smaller than a certain size:
//
//   GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large);
//
// The second argument to the macro is the name of the variable. If
// the expression is false, most compilers will issue a warning/error
// containing the name of the variable.

1035
1036
1037
#if GTEST_LANG_CXX11
# define GTEST_COMPILE_ASSERT_(expr, msg) static_assert(expr, #msg)
#else  // !GTEST_LANG_CXX11
1038
template <bool>
1039
  struct CompileAssert {
1040
1041
};

1042
# define GTEST_COMPILE_ASSERT_(expr, msg) \
1043
1044
  typedef ::testing::internal::CompileAssert<(static_cast<bool>(expr))> \
      msg[static_cast<bool>(expr) ? 1 : -1] GTEST_ATTRIBUTE_UNUSED_
1045
#endif  // !GTEST_LANG_CXX11
1046
1047
1048

// Implementation details of GTEST_COMPILE_ASSERT_:
//
1049
1050
// (In C++11, we simply use static_assert instead of the following)
//
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
// - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1
//   elements (and thus is invalid) when the expression is false.
//
// - The simpler definition
//
//    #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1]
//
//   does not work, as gcc supports variable-length arrays whose sizes
//   are determined at run-time (this is gcc's extension and not part
//   of the C++ standard).  As a result, gcc fails to reject the
//   following code with the simple definition:
//
//     int foo;
//     GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is
//                                      // not a compile-time constant.
//
// - By using the type CompileAssert<(bool(expr))>, we ensures that
//   expr is a compile-time constant.  (Template arguments must be
//   determined at compile-time.)
//
// - The outter parentheses in CompileAssert<(bool(expr))> are necessary
//   to work around a bug in gcc 3.4.4 and 4.0.1.  If we had written
//
//     CompileAssert<bool(expr)>
//
//   instead, these compilers will refuse to compile
//
//     GTEST_COMPILE_ASSERT_(5 > 0, some_message);
//
//   (They seem to think the ">" in "5 > 0" marks the end of the
//   template argument list.)
//
// - The array size is (bool(expr) ? 1 : -1), instead of simply
//
//     ((expr) ? 1 : -1).
//
//   This is to avoid running into a bug in MS VC 7.1, which
//   causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1.

// StaticAssertTypeEqHelper is used by StaticAssertTypeEq defined in gtest.h.
//
// This template is declared, but intentionally undefined.
template <typename T1, typename T2>
struct StaticAssertTypeEqHelper;

template <typename T>
billydonahue's avatar
billydonahue committed
1097
1098
1099
struct StaticAssertTypeEqHelper<T, T> {
  enum { value = true };
};
1100

1101
1102
1103
// Evaluates to the number of elements in 'array'.
#define GTEST_ARRAY_SIZE_(array) (sizeof(array) / sizeof(array[0]))

1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
#if GTEST_HAS_GLOBAL_STRING
typedef ::string string;
#else
typedef ::std::string string;
#endif  // GTEST_HAS_GLOBAL_STRING

#if GTEST_HAS_GLOBAL_WSTRING
typedef ::wstring wstring;
#elif GTEST_HAS_STD_WSTRING
typedef ::std::wstring wstring;
#endif  // GTEST_HAS_GLOBAL_WSTRING

1116
1117
// A helper for suppressing warnings on constant condition.  It just
// returns 'condition'.
1118
GTEST_API_ bool IsTrue(bool condition);
1119

shiqian's avatar
shiqian committed
1120
1121
1122
1123
1124
1125
1126
// Defines scoped_ptr.

// This implementation of scoped_ptr is PARTIAL - it only contains
// enough stuff to satisfy Google Test's need.
template <typename T>
class scoped_ptr {
 public:
1127
1128
  typedef T element_type;

shiqian's avatar
shiqian committed
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
  explicit scoped_ptr(T* p = NULL) : ptr_(p) {}
  ~scoped_ptr() { reset(); }

  T& operator*() const { return *ptr_; }
  T* operator->() const { return ptr_; }
  T* get() const { return ptr_; }

  T* release() {
    T* const ptr = ptr_;
    ptr_ = NULL;
    return ptr;
  }

  void reset(T* p = NULL) {
    if (p != ptr_) {
1144
      if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
shiqian's avatar
shiqian committed
1145
1146
1147
1148
1149
        delete ptr_;
      }
      ptr_ = p;
    }
  }
1150

billydonahue's avatar
billydonahue committed
1151
1152
1153
1154
1155
  friend void swap(scoped_ptr& a, scoped_ptr& b) {
    using std::swap;
    swap(a.ptr_, b.ptr_);
  }

shiqian's avatar
shiqian committed
1156
1157
1158
 private:
  T* ptr_;

shiqian's avatar
shiqian committed
1159
  GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
shiqian's avatar
shiqian committed
1160
1161
};

1162
// Defines RE.
shiqian's avatar
shiqian committed
1163

1164
// A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
shiqian's avatar
shiqian committed
1165
// Regular Expression syntax.
1166
class GTEST_API_ RE {
shiqian's avatar
shiqian committed
1167
 public:
1168
1169
1170
1171
  // A copy constructor is required by the Standard to initialize object
  // references from r-values.
  RE(const RE& other) { Init(other.pattern()); }

shiqian's avatar
shiqian committed
1172
1173
1174
1175
  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

#if GTEST_HAS_GLOBAL_STRING
1176

shiqian's avatar
shiqian committed
1177
  RE(const ::string& regex) { Init(regex.c_str()); }  // NOLINT
1178

shiqian's avatar
shiqian committed
1179
1180
1181
1182
1183
1184
1185
1186
#endif  // GTEST_HAS_GLOBAL_STRING

  RE(const char* regex) { Init(regex); }  // NOLINT
  ~RE();

  // Returns the string representation of the regex.
  const char* pattern() const { return pattern_; }

1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
  // FullMatch(str, re) returns true iff regular expression re matches
  // the entire str.
  // PartialMatch(str, re) returns true iff regular expression re
  // matches a substring of str (including str itself).
  //
  // TODO(wan@google.com): make FullMatch() and PartialMatch() work
  // when str contains NUL characters.
  static bool FullMatch(const ::std::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
1197
1198
1199
1200
1201
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#if GTEST_HAS_GLOBAL_STRING
1202

1203
1204
1205
  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
1206
1207
1208
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }
1209

shiqian's avatar
shiqian committed
1210
1211
#endif  // GTEST_HAS_GLOBAL_STRING

1212
  static bool FullMatch(const char* str, const RE& re);
shiqian's avatar
shiqian committed
1213
1214
1215
1216
1217
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

1218
1219
1220
  // We use a const char* instead of an std::string, as Google Test used to be
  // used where std::string is not available.  TODO(wan@google.com): change to
  // std::string.
shiqian's avatar
shiqian committed
1221
  const char* pattern_;
1222
  bool is_valid_;
1223

1224
#if GTEST_USES_POSIX_RE
1225

1226
1227
  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().
1228

1229
#else  // GTEST_USES_SIMPLE_RE
1230

1231
  const char* full_pattern_;  // For FullMatch();
1232

1233
#endif
shiqian's avatar
shiqian committed
1234

1235
  GTEST_DISALLOW_ASSIGN_(RE);
1236
};
shiqian's avatar
shiqian committed
1237

1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
// Formats a source file path and a line number as they would appear
// in an error message from the compiler used to compile this code.
GTEST_API_ ::std::string FormatFileLocation(const char* file, int line);

// Formats a file location for compiler-independent XML output.
// Although this function is not platform dependent, we put it next to
// FormatFileLocation in order to contrast the two functions.
GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(const char* file,
                                                               int line);

shiqian's avatar
shiqian committed
1248
// Defines logging utilities:
1249
1250
//   GTEST_LOG_(severity) - logs messages at the specified severity level. The
//                          message itself is streamed into the macro.
shiqian's avatar
shiqian committed
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.

enum GTestLogSeverity {
  GTEST_INFO,
  GTEST_WARNING,
  GTEST_ERROR,
  GTEST_FATAL
};

1261
1262
1263
// Formats log entry severity, provides a stream object for streaming the
// log message, and terminates the message with a newline when going out of
// scope.
1264
class GTEST_API_ GTestLog {
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
 public:
  GTestLog(GTestLogSeverity severity, const char* file, int line);

  // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
  ~GTestLog();

  ::std::ostream& GetStream() { return ::std::cerr; }

 private:
  const GTestLogSeverity severity_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestLog);
};
shiqian's avatar
shiqian committed
1278

1279
1280
1281
#if !defined(GTEST_LOG_)

# define GTEST_LOG_(severity) \
1282
1283
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()
shiqian's avatar
shiqian committed
1284
1285
1286
1287

inline void LogToStderr() {}
inline void FlushInfoLog() { fflush(NULL); }

1288
1289
1290
#endif  // !defined(GTEST_LOG_)

#if !defined(GTEST_CHECK_)
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
// INTERNAL IMPLEMENTATION - DO NOT USE.
//
// GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition
// is not satisfied.
//  Synopsys:
//    GTEST_CHECK_(boolean_condition);
//     or
//    GTEST_CHECK_(boolean_condition) << "Additional message";
//
//    This checks the condition and if the condition is not satisfied
//    it prints message about the condition violation, including the
//    condition itself, plus additional message streamed into it, if any,
//    and then it aborts the program. It aborts the program irrespective of
//    whether it is built in the debug mode or not.
1305
# define GTEST_CHECK_(condition) \
1306
1307
1308
1309
1310
    GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
    if (::testing::internal::IsTrue(condition)) \
      ; \
    else \
      GTEST_LOG_(FATAL) << "Condition " #condition " failed. "
1311
#endif  // !defined(GTEST_CHECK_)
1312

1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
// An all-mode assert to verify that the given POSIX-style function
// call returns 0 (indicating success).  Known limitation: this
// doesn't expand to a balanced 'if' statement, so enclose the macro
// in {} if you need to use it as the only statement in an 'if'
// branch.
#define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \
  if (const int gtest_error = (posix_call)) \
    GTEST_LOG_(FATAL) << #posix_call << "failed with error " \
                      << gtest_error

1323
1324
#if GTEST_HAS_STD_MOVE_
using std::move;
1325
#else  // GTEST_HAS_STD_MOVE_
1326
1327
1328
1329
1330
1331
template <typename T>
const T& move(const T& t) {
  return t;
}
#endif  // GTEST_HAS_STD_MOVE_

1332
1333
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
1334
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
1335
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
1336
1337
// const Foo*).  When you use ImplicitCast_, the compiler checks that
// the cast is safe.  Such explicit ImplicitCast_s are necessary in
1338
1339
1340
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
1341
// The syntax for using ImplicitCast_ is the same as for static_cast:
1342
//
1343
//   ImplicitCast_<ToType>(expr)
1344
//
1345
// ImplicitCast_ would have been part of the C++ standard library,
1346
1347
// but the proposal was submitted too late.  It will probably make
// its way into the language in the future.
1348
1349
1350
1351
//
// This relatively ugly name is intentional. It prevents clashes with
// similar functions users may have (e.g., implicit_cast). The internal
// namespace alone is not enough because the function can be found by ADL.
1352
template<typename To>
kosak's avatar
kosak committed
1353
inline To ImplicitCast_(To x) { return x; }
1354
1355

// When you upcast (that is, cast a pointer from type Foo to type
1356
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
// always succeed.  When you downcast (that is, cast a pointer from
// type Foo to type SubclassOfFoo), static_cast<> isn't safe, because
// how do you know the pointer is really of type SubclassOfFoo?  It
// could be a bare Foo, or of type DifferentSubclassOfFoo.  Thus,
// when you downcast, you should use this macro.  In debug mode, we
// use dynamic_cast<> to double-check the downcast is legal (we die
// if it's not).  In normal mode, we do the efficient static_cast<>
// instead.  Thus, it's important to test in debug mode to make sure
// the cast is legal!
//    This is the only place in the code we should use dynamic_cast<>.
// In particular, you SHOULDN'T be using dynamic_cast<> in order to
// do RTTI (eg code like this:
//    if (dynamic_cast<Subclass1>(foo)) HandleASubclass1Object(foo);
//    if (dynamic_cast<Subclass2>(foo)) HandleASubclass2Object(foo);
// You should design the code some other way not to need this.
1372
1373
1374
1375
1376
1377
//
// This relatively ugly name is intentional. It prevents clashes with
// similar functions users may have (e.g., down_cast). The internal
// namespace alone is not enough because the function can be found by ADL.
template<typename To, typename From>  // use like this: DownCast_<T*>(foo);
inline To DownCast_(From* f) {  // so we only accept pointers
1378
1379
1380
1381
  // Ensures that To is a sub-type of From *.  This test is here only
  // for compile-time type checking, and has no overhead in an
  // optimized build at run-time, as it will be optimized away
  // completely.
billydonahue's avatar
billydonahue committed
1382
  GTEST_INTENTIONAL_CONST_COND_PUSH_()
1383
  if (false) {
billydonahue's avatar
billydonahue committed
1384
  GTEST_INTENTIONAL_CONST_COND_POP_()
1385
    const To to = NULL;
1386
    ::testing::internal::ImplicitCast_<From*>(to);
1387
1388
1389
1390
1391
1392
1393
1394
1395
  }

#if GTEST_HAS_RTTI
  // RTTI: debug mode only!
  GTEST_CHECK_(f == NULL || dynamic_cast<To>(f) != NULL);
#endif
  return static_cast<To>(f);
}

1396
1397
1398
1399
1400
1401
1402
1403
1404
// Downcasts the pointer of type Base to Derived.
// Derived must be a subclass of Base. The parameter MUST
// point to a class of type Derived, not any subclass of it.
// When RTTI is available, the function performs a runtime
// check to enforce this.
template <class Derived, class Base>
Derived* CheckedDowncastToActualType(Base* base) {
#if GTEST_HAS_RTTI
  GTEST_CHECK_(typeid(*base) == typeid(Derived));
1405
1406
1407
1408
1409
#endif

#if GTEST_HAS_DOWNCAST_
  return ::down_cast<Derived*>(base);
#elif GTEST_HAS_RTTI
1410
1411
1412
  return dynamic_cast<Derived*>(base);  // NOLINT
#else
  return static_cast<Derived*>(base);  // Poor man's downcast.
1413
#endif
1414
1415
}

1416
#if GTEST_HAS_STREAM_REDIRECTION
1417

shiqian's avatar
shiqian committed
1418
// Defines the stderr capturer:
1419
1420
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
shiqian's avatar
shiqian committed
1421
1422
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
1423
//
zhanyong.wan's avatar
zhanyong.wan committed
1424
GTEST_API_ void CaptureStdout();
1425
GTEST_API_ std::string GetCapturedStdout();
zhanyong.wan's avatar
zhanyong.wan committed
1426
GTEST_API_ void CaptureStderr();
1427
GTEST_API_ std::string GetCapturedStderr();
1428

1429
#endif  // GTEST_HAS_STREAM_REDIRECTION
1430

kosak's avatar
kosak committed
1431
1432
1433
1434
1435
// Returns the size (in bytes) of a file.
GTEST_API_ size_t GetFileSize(FILE* file);

// Reads the entire content of a file as a string.
GTEST_API_ std::string ReadEntireFile(FILE* file);
1436

1437
1438
1439
// All command line arguments.
GTEST_API_ const ::std::vector<testing::internal::string>& GetArgvs();

zhanyong.wan's avatar
zhanyong.wan committed
1440
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
1441

1442
1443
1444
const ::std::vector<testing::internal::string>& GetInjectableArgvs();
void SetInjectableArgvs(const ::std::vector<testing::internal::string>*
                             new_argvs);
shiqian's avatar
shiqian committed
1445
1446
1447
1448
1449


#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.
1450
1451
1452
1453
1454
#if GTEST_IS_THREADSAFE
# if GTEST_HAS_PTHREAD
// Sleeps for (roughly) n milliseconds.  This function is only for testing
// Google Test's own constructs.  Don't use it in user tests, either
// directly or indirectly.
1455
1456
1457
1458
1459
1460
1461
inline void SleepMilliseconds(int n) {
  const timespec time = {
    0,                  // 0 seconds.
    n * 1000L * 1000L,  // And n ms.
  };
  nanosleep(&time, NULL);
}
1462
# endif  // GTEST_HAS_PTHREAD
1463

1464
1465
1466
1467
# if GTEST_HAS_NOTIFICATION_
// Notification has already been imported into the namespace.
// Nothing to do here.

1468
# elif GTEST_HAS_PTHREAD
1469
1470
1471
1472
1473
1474
1475
1476
// Allows a controller thread to pause execution of newly created
// threads until notified.  Instances of this class must be created
// and destroyed in the controller thread.
//
// This class is only for testing Google Test's own constructs. Do not
// use it in user tests, either directly or indirectly.
class Notification {
 public:
jgm's avatar
jgm committed
1477
1478
1479
1480
1481
1482
  Notification() : notified_(false) {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
  }
  ~Notification() {
    pthread_mutex_destroy(&mutex_);
  }
1483
1484
1485

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
jgm's avatar
jgm committed
1486
1487
1488
1489
1490
  void Notify() {
    pthread_mutex_lock(&mutex_);
    notified_ = true;
    pthread_mutex_unlock(&mutex_);
  }
1491
1492
1493
1494

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
jgm's avatar
jgm committed
1495
1496
1497
1498
1499
1500
    for (;;) {
      pthread_mutex_lock(&mutex_);
      const bool notified = notified_;
      pthread_mutex_unlock(&mutex_);
      if (notified)
        break;
1501
1502
1503
1504
1505
      SleepMilliseconds(10);
    }
  }

 private:
jgm's avatar
jgm committed
1506
1507
  pthread_mutex_t mutex_;
  bool notified_;
1508
1509
1510
1511

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

1512
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560

GTEST_API_ void SleepMilliseconds(int n);

// Provides leak-safe Windows kernel handle ownership.
// Used in death tests and in threading support.
class GTEST_API_ AutoHandle {
 public:
  // Assume that Win32 HANDLE type is equivalent to void*. Doing so allows us to
  // avoid including <windows.h> in this header file. Including <windows.h> is
  // undesirable because it defines a lot of symbols and macros that tend to
  // conflict with client code. This assumption is verified by
  // WindowsTypesTest.HANDLEIsVoidStar.
  typedef void* Handle;
  AutoHandle();
  explicit AutoHandle(Handle handle);

  ~AutoHandle();

  Handle Get() const;
  void Reset();
  void Reset(Handle handle);

 private:
  // Returns true iff the handle is a valid handle object that can be closed.
  bool IsCloseable() const;

  Handle handle_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(AutoHandle);
};

// Allows a controller thread to pause execution of newly created
// threads until notified.  Instances of this class must be created
// and destroyed in the controller thread.
//
// This class is only for testing Google Test's own constructs. Do not
// use it in user tests, either directly or indirectly.
class GTEST_API_ Notification {
 public:
  Notification();
  void Notify();
  void WaitForNotification();

 private:
  AutoHandle event_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};
1561
# endif  // GTEST_HAS_NOTIFICATION_
1562
1563
1564
1565
1566
1567

// On MinGW, we can have both GTEST_OS_WINDOWS and GTEST_HAS_PTHREAD
// defined, but we don't want to use MinGW's pthreads implementation, which
// has conformance problems with some versions of the POSIX standard.
# if GTEST_HAS_PTHREAD && !GTEST_OS_WINDOWS_MINGW

1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
// As a C-function, ThreadFuncWithCLinkage cannot be templated itself.
// Consequently, it cannot select a correct instantiation of ThreadWithParam
// in order to call its Run(). Introducing ThreadWithParamBase as a
// non-templated base class for ThreadWithParam allows us to bypass this
// problem.
class ThreadWithParamBase {
 public:
  virtual ~ThreadWithParamBase() {}
  virtual void Run() = 0;
};

// pthread_create() accepts a pointer to a function type with the C linkage.
// According to the Standard (7.5/1), function types with different linkages
// are different even if they are otherwise identical.  Some compilers (for
// example, SunStudio) treat them as different types.  Since class methods
// cannot be defined with C-linkage we need to define a free C-function to
// pass into pthread_create().
extern "C" inline void* ThreadFuncWithCLinkage(void* thread) {
  static_cast<ThreadWithParamBase*>(thread)->Run();
  return NULL;
}

1590
// Helper class for testing Google Test's multi-threading constructs.
zhanyong.wan's avatar
zhanyong.wan committed
1591
// To use it, write:
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
//
//   void ThreadFunc(int param) { /* Do things with param */ }
//   Notification thread_can_start;
//   ...
//   // The thread_can_start parameter is optional; you can supply NULL.
//   ThreadWithParam<int> thread(&ThreadFunc, 5, &thread_can_start);
//   thread_can_start.Notify();
//
// These classes are only for testing Google Test's own constructs. Do
// not use them in user tests, either directly or indirectly.
template <typename T>
1603
class ThreadWithParam : public ThreadWithParamBase {
1604
 public:
1605
  typedef void UserThreadFunc(T);
1606

1607
  ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
1608
1609
1610
      : func_(func),
        param_(param),
        thread_can_start_(thread_can_start),
zhanyong.wan's avatar
zhanyong.wan committed
1611
        finished_(false) {
1612
    ThreadWithParamBase* const base = this;
zhanyong.wan's avatar
zhanyong.wan committed
1613
1614
1615
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
1616
        pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
zhanyong.wan's avatar
zhanyong.wan committed
1617
1618
  }
  ~ThreadWithParam() { Join(); }
1619
1620
1621

  void Join() {
    if (!finished_) {
zhanyong.wan's avatar
zhanyong.wan committed
1622
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
1623
1624
1625
1626
      finished_ = true;
    }
  }

1627
  virtual void Run() {
1628
1629
1630
1631
1632
    if (thread_can_start_ != NULL)
      thread_can_start_->WaitForNotification();
    func_(param_);
  }

1633
 private:
1634
  UserThreadFunc* const func_;  // User-supplied thread function.
1635
1636
1637
1638
1639
  const T param_;  // User-supplied parameter to the thread function.
  // When non-NULL, used to block execution until the controller thread
  // notifies.
  Notification* const thread_can_start_;
  bool finished_;  // true iff we know that the thread function has finished.
zhanyong.wan's avatar
zhanyong.wan committed
1640
1641
1642
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1643
};
1644
1645
1646
1647
1648
1649
# endif  // !GTEST_OS_WINDOWS && GTEST_HAS_PTHREAD ||
         // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_

# if GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
// Mutex and ThreadLocal have already been imported into the namespace.
// Nothing to do here.
1650

1651
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
1652

1653
1654
// Mutex implements mutex on Windows platforms.  It is used in conjunction
// with class MutexLock:
1655
//
1656
1657
//   Mutex mutex;
//   ...
1658
1659
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the
//                            // end of the current scope.
1660
//
1661
1662
// A static Mutex *must* be defined or declared using one of the following
// macros:
1663
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
//
// (A non-static Mutex is defined/declared in the usual way).
class GTEST_API_ Mutex {
 public:
  enum MutexType { kStatic = 0, kDynamic = 1 };
  // We rely on kStaticMutex being 0 as it is to what the linker initializes
  // type_ in static mutexes.  critical_section_ will be initialized lazily
  // in ThreadSafeLazyInit().
  enum StaticConstructorSelector { kStaticMutex = 0 };

  // This constructor intentionally does nothing.  It relies on type_ being
  // statically initialized to 0 (effectively setting it to kStatic) and on
  // ThreadSafeLazyInit() to lazily initialize the rest of the members.
  explicit Mutex(StaticConstructorSelector /*dummy*/) {}

  Mutex();
  ~Mutex();

  void Lock();

  void Unlock();

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
  void AssertHeld();

 private:
  // Initializes owner_thread_id_ and critical_section_ in static mutexes.
  void ThreadSafeLazyInit();

  // Per http://blogs.msdn.com/b/oldnewthing/archive/2004/02/23/78395.aspx,
  // we assume that 0 is an invalid value for thread IDs.
  unsigned int owner_thread_id_;

  // For static mutexes, we rely on these members being initialized to zeros
  // by the linker.
  MutexType type_;
  long critical_section_init_phase_;  // NOLINT
1703
  GTEST_CRITICAL_SECTION* critical_section_;
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
    extern ::testing::internal::Mutex mutex

# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
    ::testing::internal::Mutex mutex(::testing::internal::Mutex::kStaticMutex)

// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex* mutex)
      : mutex_(mutex) { mutex_->Lock(); }

  ~GTestMutexLock() { mutex_->Unlock(); }

 private:
  Mutex* const mutex_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
};

typedef GTestMutexLock MutexLock;

// Base class for ValueHolder<T>.  Allows a caller to hold and delete a value
// without knowing its type.
class ThreadLocalValueHolderBase {
 public:
  virtual ~ThreadLocalValueHolderBase() {}
};

// Provides a way for a thread to send notifications to a ThreadLocal
// regardless of its parameter type.
class ThreadLocalBase {
 public:
  // Creates a new ValueHolder<T> object holding a default value passed to
  // this ThreadLocal<T>'s constructor and returns it.  It is the caller's
  // responsibility not to call this when the ThreadLocal<T> instance already
  // has a value on the current thread.
  virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const = 0;

 protected:
  ThreadLocalBase() {}
  virtual ~ThreadLocalBase() {}

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocalBase);
};

// Maps a thread to a set of ThreadLocals that have values instantiated on that
// thread and notifies them when the thread exits.  A ThreadLocal instance is
// expected to persist until all threads it has values on have terminated.
class GTEST_API_ ThreadLocalRegistry {
 public:
  // Registers thread_local_instance as having value on the current thread.
  // Returns a value that can be used to identify the thread from other threads.
  static ThreadLocalValueHolderBase* GetValueOnCurrentThread(
      const ThreadLocalBase* thread_local_instance);

  // Invoked when a ThreadLocal instance is destroyed.
  static void OnThreadLocalDestroyed(
      const ThreadLocalBase* thread_local_instance);
};

class GTEST_API_ ThreadWithParamBase {
 public:
  void Join();

 protected:
  class Runnable {
   public:
    virtual ~Runnable() {}
    virtual void Run() = 0;
  };

  ThreadWithParamBase(Runnable *runnable, Notification* thread_can_start);
  virtual ~ThreadWithParamBase();

 private:
  AutoHandle thread_;
};

// Helper class for testing Google Test's multi-threading constructs.
template <typename T>
class ThreadWithParam : public ThreadWithParamBase {
 public:
  typedef void UserThreadFunc(T);

  ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
      : ThreadWithParamBase(new RunnableImpl(func, param), thread_can_start) {
  }
  virtual ~ThreadWithParam() {}

 private:
  class RunnableImpl : public Runnable {
   public:
    RunnableImpl(UserThreadFunc* func, T param)
        : func_(func),
          param_(param) {
    }
    virtual ~RunnableImpl() {}
    virtual void Run() {
      func_(param_);
    }

   private:
    UserThreadFunc* const func_;
    const T param_;

    GTEST_DISALLOW_COPY_AND_ASSIGN_(RunnableImpl);
  };

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
};

// Implements thread-local storage on Windows systems.
//
//   // Thread 1
//   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1829
//
1830
1831
1832
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
1833
//
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
//
// The template type argument T must have a public copy constructor.
// In addition, the default ThreadLocal constructor requires T to have
// a public default constructor.
//
// The users of a TheadLocal instance have to make sure that all but one
// threads (including the main one) using that instance have exited before
// destroying it. Otherwise, the per-thread objects managed for them by the
// ThreadLocal instance are not guaranteed to be destroyed on all platforms.
1847
//
1848
1849
1850
1851
1852
1853
1854
// Google Test only uses global ThreadLocal objects.  That means they
// will die after main() has returned.  Therefore, no per-thread
// object managed by Google Test will be leaked as long as all threads
// using Google Test have exited when main() returns.
template <typename T>
class ThreadLocal : public ThreadLocalBase {
 public:
1855
1856
1857
  ThreadLocal() : default_factory_(new DefaultValueHolderFactory()) {}
  explicit ThreadLocal(const T& value)
      : default_factory_(new InstanceValueHolderFactory(value)) {}
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870

  ~ThreadLocal() { ThreadLocalRegistry::OnThreadLocalDestroyed(this); }

  T* pointer() { return GetOrCreateValue(); }
  const T* pointer() const { return GetOrCreateValue(); }
  const T& get() const { return *pointer(); }
  void set(const T& value) { *pointer() = value; }

 private:
  // Holds a value of T.  Can be deleted via its base class without the caller
  // knowing the type of T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
1871
    ValueHolder() : value_() {}
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

   private:
    T value_;
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
  };


  T* GetOrCreateValue() const {
    return static_cast<ValueHolder*>(
        ThreadLocalRegistry::GetValueOnCurrentThread(this))->pointer();
  }

  virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const {
1888
    return default_factory_->MakeNewHolder();
1889
1890
  }

1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
  class ValueHolderFactory {
   public:
    ValueHolderFactory() {}
    virtual ~ValueHolderFactory() {}
    virtual ValueHolder* MakeNewHolder() const = 0;

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolderFactory);
  };

  class DefaultValueHolderFactory : public ValueHolderFactory {
   public:
    DefaultValueHolderFactory() {}
    virtual ValueHolder* MakeNewHolder() const { return new ValueHolder(); }

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultValueHolderFactory);
  };

  class InstanceValueHolderFactory : public ValueHolderFactory {
   public:
    explicit InstanceValueHolderFactory(const T& value) : value_(value) {}
    virtual ValueHolder* MakeNewHolder() const {
      return new ValueHolder(value_);
    }

   private:
    const T value_;  // The value for each thread.

    GTEST_DISALLOW_COPY_AND_ASSIGN_(InstanceValueHolderFactory);
  };

  scoped_ptr<ValueHolderFactory> default_factory_;
1924
1925
1926
1927
1928
1929
1930

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

# elif GTEST_HAS_PTHREAD

// MutexBase and Mutex implement mutex on pthreads-based platforms.
1931
1932
class MutexBase {
 public:
1933
1934
1935
1936
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
1937
    has_owner_ = true;
1938
1939
1940
1941
  }

  // Releases this mutex.
  void Unlock() {
1942
1943
1944
    // Since the lock is being released the owner_ field should no longer be
    // considered valid. We don't protect writing to has_owner_ here, as it's
    // the caller's responsibility to ensure that the current thread holds the
1945
    // mutex when this is called.
1946
    has_owner_ = false;
1947
1948
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }
1949
1950
1951

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
1952
  void AssertHeld() const {
1953
    GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
1954
1955
        << "The current thread is not holding the mutex @" << this;
  }
1956

1957
1958
1959
1960
1961
  // A static mutex may be used before main() is entered.  It may even
  // be used before the dynamic initialization stage.  Therefore we
  // must be able to initialize a static mutex object at link time.
  // This means MutexBase has to be a POD and its member variables
  // have to be public.
1962
 public:
1963
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
1964
1965
1966
1967
1968
1969
1970
1971
  // has_owner_ indicates whether the owner_ field below contains a valid thread
  // ID and is therefore safe to inspect (e.g., to use in pthread_equal()). All
  // accesses to the owner_ field should be protected by a check of this field.
  // An alternative might be to memset() owner_ to all zeros, but there's no
  // guarantee that a zero'd pthread_t is necessarily invalid or even different
  // from pthread_self().
  bool has_owner_;
  pthread_t owner_;  // The thread holding the mutex.
1972
1973
1974
};

// Forward-declares a static mutex.
1975
1976
#  define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
     extern ::testing::internal::MutexBase mutex
1977

1978
// Defines and statically (i.e. at link time) initializes a static mutex.
1979
#  define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1980
     ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false, pthread_t() }
1981

1982
1983
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
1984
1985
class Mutex : public MutexBase {
 public:
1986
1987
  Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
1988
    has_owner_ = false;
1989
1990
1991
1992
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }
1993
1994
1995
1996
1997

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

1998
// We cannot name this class MutexLock because the ctor declaration would
1999
// conflict with a macro named MutexLock, which is defined on some
2000
2001
2002
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
class GTestMutexLock {
 public:
  explicit GTestMutexLock(MutexBase* mutex)
      : mutex_(mutex) { mutex_->Lock(); }

  ~GTestMutexLock() { mutex_->Unlock(); }

 private:
  MutexBase* const mutex_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
};

typedef GTestMutexLock MutexLock;

2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
// Helpers for ThreadLocal.

// pthread_key_create() requires DeleteThreadLocalValue() to have
// C-linkage.  Therefore it cannot be templatized to access
// ThreadLocal<T>.  Hence the need for class
// ThreadLocalValueHolderBase.
class ThreadLocalValueHolderBase {
 public:
  virtual ~ThreadLocalValueHolderBase() {}
};

// Called by pthread to delete thread-local data stored by
// pthread_setspecific().
extern "C" inline void DeleteThreadLocalValue(void* value_holder) {
  delete static_cast<ThreadLocalValueHolderBase*>(value_holder);
}

2035
2036
2037
2038
// Implements thread-local storage on pthreads-based systems.
template <typename T>
class ThreadLocal {
 public:
2039
2040
2041
2042
2043
  ThreadLocal()
      : key_(CreateKey()), default_factory_(new DefaultValueHolderFactory()) {}
  explicit ThreadLocal(const T& value)
      : key_(CreateKey()),
        default_factory_(new InstanceValueHolderFactory(value)) {}
2044
2045

  ~ThreadLocal() {
zhanyong.wan's avatar
zhanyong.wan committed
2046
2047
2048
2049
2050
    // Destroys the managed object for the current thread, if any.
    DeleteThreadLocalValue(pthread_getspecific(key_));

    // Releases resources associated with the key.  This will *not*
    // delete managed objects for other threads.
2051
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
2052
2053
2054
2055
2056
2057
2058
2059
  }

  T* pointer() { return GetOrCreateValue(); }
  const T* pointer() const { return GetOrCreateValue(); }
  const T& get() const { return *pointer(); }
  void set(const T& value) { *pointer() = value; }

 private:
2060
2061
2062
  // Holds a value of type T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
2063
    ValueHolder() : value_() {}
2064
2065
2066
2067
2068
2069
2070
2071
2072
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

   private:
    T value_;
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder);
  };

2073
2074
  static pthread_key_t CreateKey() {
    pthread_key_t key;
zhanyong.wan's avatar
zhanyong.wan committed
2075
2076
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
2077
2078
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
2079
2080
2081
2082
    return key;
  }

  T* GetOrCreateValue() const {
2083
2084
2085
2086
2087
    ThreadLocalValueHolderBase* const holder =
        static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
    if (holder != NULL) {
      return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
    }
2088

2089
    ValueHolder* const new_holder = default_factory_->MakeNewHolder();
2090
2091
2092
    ThreadLocalValueHolderBase* const holder_base = new_holder;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
    return new_holder->pointer();
2093
2094
  }

2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
  class ValueHolderFactory {
   public:
    ValueHolderFactory() {}
    virtual ~ValueHolderFactory() {}
    virtual ValueHolder* MakeNewHolder() const = 0;

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolderFactory);
  };

  class DefaultValueHolderFactory : public ValueHolderFactory {
   public:
    DefaultValueHolderFactory() {}
    virtual ValueHolder* MakeNewHolder() const { return new ValueHolder(); }

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultValueHolderFactory);
  };

  class InstanceValueHolderFactory : public ValueHolderFactory {
   public:
    explicit InstanceValueHolderFactory(const T& value) : value_(value) {}
    virtual ValueHolder* MakeNewHolder() const {
      return new ValueHolder(value_);
    }

   private:
    const T value_;  // The value for each thread.

    GTEST_DISALLOW_COPY_AND_ASSIGN_(InstanceValueHolderFactory);
  };

2127
2128
  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
2129
  scoped_ptr<ValueHolderFactory> default_factory_;
2130
2131
2132
2133

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

2134
# endif  // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
2135

2136
#else  // GTEST_IS_THREADSAFE
2137

shiqian's avatar
shiqian committed
2138
2139
2140
2141
2142
2143
2144
2145
// A dummy implementation of synchronization primitives (mutex, lock,
// and thread-local variable).  Necessary for compiling Google Test where
// mutex is not supported - using Google Test in multiple threads is not
// supported on such platforms.

class Mutex {
 public:
  Mutex() {}
2146
2147
  void Lock() {}
  void Unlock() {}
shiqian's avatar
shiqian committed
2148
2149
2150
  void AssertHeld() const {}
};

2151
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
2152
2153
  extern ::testing::internal::Mutex mutex

2154
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
2155

2156
2157
2158
2159
2160
// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
shiqian's avatar
shiqian committed
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template <typename T>
class ThreadLocal {
 public:
shiqian's avatar
shiqian committed
2171
2172
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
shiqian's avatar
shiqian committed
2173
2174
2175
2176
2177
2178
2179
2180
  T* pointer() { return &value_; }
  const T* pointer() const { return &value_; }
  const T& get() const { return value_; }
  void set(const T& value) { value_ = value; }
 private:
  T value_;
};

2181
#endif  // GTEST_IS_THREADSAFE
2182
2183
2184

// Returns the number of threads running in the process, or 0 to indicate that
// we cannot detect it.
zhanyong.wan's avatar
zhanyong.wan committed
2185
GTEST_API_ size_t GetThreadCount();
2186

2187
// Passing non-POD classes through ellipsis (...) crashes the ARM
2188
2189
2190
2191
2192
2193
// compiler and generates a warning in Sun Studio.  The Nokia Symbian
// and the IBM XL C/C++ compiler try to instantiate a copy constructor
// for objects passed through ellipsis (...), failing for uncopyable
// objects.  We define this to ensure that only POD is passed through
// ellipsis on these systems.
#if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC)
2194
2195
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
2196
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
2197
#else
2198
# define GTEST_CAN_COMPARE_NULL 1
2199
#endif
shiqian's avatar
shiqian committed
2200

2201
2202
2203
2204
// The Nokia Symbian and IBM XL C/C++ compilers cannot decide between
// const T& and const T* in a function template.  These compilers
// _can_ decide between class template specializations for T and T*,
// so a tr1::type_traits-like is_pointer works.
2205
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
2206
# define GTEST_NEEDS_IS_POINTER_ 1
2207
#endif
shiqian's avatar
shiqian committed
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224

template <bool bool_value>
struct bool_constant {
  typedef bool_constant<bool_value> type;
  static const bool value = bool_value;
};
template <bool bool_value> const bool bool_constant<bool_value>::value;

typedef bool_constant<false> false_type;
typedef bool_constant<true> true_type;

template <typename T>
struct is_pointer : public false_type {};

template <typename T>
struct is_pointer<T*> : public true_type {};

2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
template <typename Iterator>
struct IteratorTraits {
  typedef typename Iterator::value_type value_type;
};

template <typename T>
struct IteratorTraits<T*> {
  typedef T value_type;
};

template <typename T>
struct IteratorTraits<const T*> {
  typedef T value_type;
};

2240
#if GTEST_OS_WINDOWS
2241
2242
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
2243
2244
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
2245
#else
2246
2247
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
2248
typedef long long BiggestInt;  // NOLINT
2249
2250
#endif  // GTEST_OS_WINDOWS

2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
// Utilities for char.

// isspace(int ch) and friends accept an unsigned char or EOF.  char
// may be signed, depending on the compiler (or compiler flags).
// Therefore we need to cast a char to unsigned char before calling
// isspace(), etc.

inline bool IsAlpha(char ch) {
  return isalpha(static_cast<unsigned char>(ch)) != 0;
}
inline bool IsAlNum(char ch) {
  return isalnum(static_cast<unsigned char>(ch)) != 0;
}
inline bool IsDigit(char ch) {
  return isdigit(static_cast<unsigned char>(ch)) != 0;
}
inline bool IsLower(char ch) {
  return islower(static_cast<unsigned char>(ch)) != 0;
}
inline bool IsSpace(char ch) {
  return isspace(static_cast<unsigned char>(ch)) != 0;
}
inline bool IsUpper(char ch) {
  return isupper(static_cast<unsigned char>(ch)) != 0;
}
2276
2277
2278
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast<unsigned char>(ch)) != 0;
}
2279
2280
2281
2282
inline bool IsXDigit(wchar_t ch) {
  const unsigned char low_byte = static_cast<unsigned char>(ch);
  return ch == low_byte && isxdigit(low_byte) != 0;
}
2283
2284
2285
2286
2287
2288
2289
2290

inline char ToLower(char ch) {
  return static_cast<char>(tolower(static_cast<unsigned char>(ch)));
}
inline char ToUpper(char ch) {
  return static_cast<char>(toupper(static_cast<unsigned char>(ch)));
}

2291
2292
2293
2294
2295
2296
2297
inline std::string StripTrailingSpaces(std::string str) {
  std::string::iterator it = str.end();
  while (it != str.begin() && IsSpace(*--it))
    it = str.erase(it);
  return str;
}

2298
2299
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
2300
2301
2302
2303
// Windows/MSVC and POSIX systems.  Since some compilers define these
// standard functions as macros, the wrapper cannot have the same name
// as the wrapped function.

2304
2305
2306
2307
namespace posix {

// Functions with a different name on Windows.

zhanyong.wan's avatar
zhanyong.wan committed
2308
#if GTEST_OS_WINDOWS
2309

2310
typedef struct _stat StatStruct;
2311

2312
# ifdef __BORLANDC__
2313
2314
2315
2316
2317
inline int IsATTY(int fd) { return isatty(fd); }
inline int StrCaseCmp(const char* s1, const char* s2) {
  return stricmp(s1, s2);
}
inline char* StrDup(const char* src) { return strdup(src); }
2318
2319
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
2320
inline int IsATTY(int /* fd */) { return 0; }
2321
#  else
2322
inline int IsATTY(int fd) { return _isatty(fd); }
2323
#  endif  // GTEST_OS_WINDOWS_MOBILE
2324
2325
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
2326
}
2327
inline char* StrDup(const char* src) { return _strdup(src); }
2328
# endif  // __BORLANDC__
2329

2330
# if GTEST_OS_WINDOWS_MOBILE
2331
2332
2333
inline int FileNo(FILE* file) { return reinterpret_cast<int>(_fileno(file)); }
// Stat(), RmDir(), and IsDir() are not needed on Windows CE at this
// time and thus not defined there.
2334
# else
2335
2336
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
2337
2338
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
2339
2340
  return (_S_IFDIR & st.st_mode) != 0;
}
2341
# endif  // GTEST_OS_WINDOWS_MOBILE
2342

shiqian's avatar
shiqian committed
2343
#else
2344

2345
typedef struct stat StatStruct;
2346

2347
2348
2349
2350
2351
2352
inline int FileNo(FILE* file) { return fileno(file); }
inline int IsATTY(int fd) { return isatty(fd); }
inline int Stat(const char* path, StatStruct* buf) { return stat(path, buf); }
inline int StrCaseCmp(const char* s1, const char* s2) {
  return strcasecmp(s1, s2);
}
2353
inline char* StrDup(const char* src) { return strdup(src); }
2354
2355
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
2356

shiqian's avatar
shiqian committed
2357
2358
#endif  // GTEST_OS_WINDOWS

2359
2360
// Functions deprecated by MSVC 8.0.

billydonahue's avatar
billydonahue committed
2361
GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996 /* deprecated function */)
2362

2363
2364
inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
2365
}
2366
2367
2368
2369
2370

// ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and
// StrError() aren't needed on Windows CE at this time and thus not
// defined there.

billydonahue's avatar
billydonahue committed
2371
#if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
2372
inline int ChDir(const char* dir) { return chdir(dir); }
2373
#endif
2374
2375
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
2376
}
2377
#if !GTEST_OS_WINDOWS_MOBILE
2378
2379
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
2380
}
2381
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
2382
#endif
2383
inline int FClose(FILE* fp) { return fclose(fp); }
2384
#if !GTEST_OS_WINDOWS_MOBILE
2385
2386
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast<int>(read(fd, buf, count));
2387
}
2388
2389
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast<int>(write(fd, buf, count));
2390
}
2391
2392
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
2393
#endif
2394
inline const char* GetEnv(const char* name) {
billydonahue's avatar
billydonahue committed
2395
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE | GTEST_OS_WINDOWS_RT
2396
  // We are on Windows CE, which has no environment variables.
2397
  static_cast<void>(name);  // To prevent 'unused argument' warning.
2398
  return NULL;
2399
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
2400
2401
2402
2403
  // Environment variables which we programmatically clear will be set to the
  // empty string rather than unset (NULL).  Handle that case.
  const char* const env = getenv(name);
  return (env != NULL && env[0] != '\0') ? env : NULL;
2404
#else
2405
  return getenv(name);
2406
2407
2408
#endif
}

billydonahue's avatar
billydonahue committed
2409
GTEST_DISABLE_MSC_WARNINGS_POP_()
2410

2411
#if GTEST_OS_WINDOWS_MOBILE
2412
2413
2414
// Windows CE has no C library. The abort() function is used in
// several places in Google Test. This implementation provides a reasonable
// imitation of standard behaviour.
2415
void Abort();
2416
#else
2417
inline void Abort() { abort(); }
2418
#endif  // GTEST_OS_WINDOWS_MOBILE
2419
2420
2421

}  // namespace posix

2422
2423
2424
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
// MSVC "deprecates" snprintf and issues warnings wherever it is used.  In
// order to avoid these warnings, we need to use _snprintf or _snprintf_s on
// MSVC-based platforms.  We map the GTEST_SNPRINTF_ macro to the appropriate
// function in order to achieve that.  We use macro definition here because
// snprintf is a variadic function.
#if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
// MSVC 2005 and above support variadic macros.
# define GTEST_SNPRINTF_(buffer, size, format, ...) \
     _snprintf_s(buffer, size, size, format, __VA_ARGS__)
#elif defined(_MSC_VER)
// Windows CE does not define _snprintf_s and MSVC prior to 2005 doesn't
// complain about _snprintf.
# define GTEST_SNPRINTF_ _snprintf
#else
# define GTEST_SNPRINTF_ snprintf
#endif

shiqian's avatar
shiqian committed
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
// The maximum number a BiggestInt can represent.  This definition
// works no matter BiggestInt is represented in one's complement or
// two's complement.
//
// We cannot rely on numeric_limits in STL, as __int64 and long long
// are not part of standard C++ and numeric_limits doesn't need to be
// defined for them.
const BiggestInt kMaxBiggestInt =
    ~(static_cast<BiggestInt>(1) << (8*sizeof(BiggestInt) - 1));

// This template class serves as a compile-time function from size to
// type.  It maps a size in bytes to a primitive type with that
// size. e.g.
//
//   TypeWithSize<4>::UInt
//
// is typedef-ed to be unsigned int (unsigned integer made up of 4
// bytes).
//
// Such functionality should belong to STL, but I cannot find it
// there.
//
// Google Test uses this class in the implementation of floating-point
// comparison.
//
// For now it only handles UInt (unsigned int) as that's all Google Test
// needs.  Other types can be easily added in the future if need
// arises.
template <size_t size>
class TypeWithSize {
 public:
  // This prevents the user from using TypeWithSize<N> with incorrect
  // values of N.
  typedef void UInt;
};

// The specialization for size 4.
template <>
class TypeWithSize<4> {
 public:
  // unsigned int has size 4 in both gcc and MSVC.
  //
  // As base/basictypes.h doesn't compile on Windows, we cannot use
  // uint32, uint64, and etc here.
  typedef int Int;
  typedef unsigned int UInt;
};

// The specialization for size 8.
template <>
class TypeWithSize<8> {
 public:
zhanyong.wan's avatar
zhanyong.wan committed
2491
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
  typedef __int64 Int;
  typedef unsigned __int64 UInt;
#else
  typedef long long Int;  // NOLINT
  typedef unsigned long long UInt;  // NOLINT
#endif  // GTEST_OS_WINDOWS
};

// Integer types of known sizes.
typedef TypeWithSize<4>::Int Int32;
typedef TypeWithSize<4>::UInt UInt32;
typedef TypeWithSize<8>::Int Int64;
typedef TypeWithSize<8>::UInt UInt64;
typedef TypeWithSize<8>::Int TimeInMillis;  // Represents time in milliseconds.

// Utilities for command line flags and environment variables.

// Macro for referencing flags.
2510
2511
2512
#if !defined(GTEST_FLAG)
# define GTEST_FLAG(name) FLAGS_gtest_##name
#endif  // !defined(GTEST_FLAG)
shiqian's avatar
shiqian committed
2513

kosak's avatar
kosak committed
2514
2515
2516
2517
#if !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)
# define GTEST_USE_OWN_FLAGFILE_FLAG_ 1
#endif  // !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)

2518
#if !defined(GTEST_DECLARE_bool_)
2519
2520
# define GTEST_FLAG_SAVER_ ::testing::internal::GTestFlagSaver

shiqian's avatar
shiqian committed
2521
// Macros for declaring flags.
2522
2523
# define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
# define GTEST_DECLARE_int32_(name) \
2524
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
shiqian's avatar
shiqian committed
2525
#define GTEST_DECLARE_string_(name) \
2526
    GTEST_API_ extern ::std::string GTEST_FLAG(name)
shiqian's avatar
shiqian committed
2527
2528

// Macros for defining flags.
shiqian's avatar
shiqian committed
2529
#define GTEST_DEFINE_bool_(name, default_val, doc) \
2530
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
2531
#define GTEST_DEFINE_int32_(name, default_val, doc) \
2532
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
2533
#define GTEST_DEFINE_string_(name, default_val, doc) \
2534
    GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
2535

2536
2537
#endif  // !defined(GTEST_DECLARE_bool_)

2538
// Thread annotations
2539
2540
2541
2542
#if !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
# define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
# define GTEST_LOCK_EXCLUDED_(locks)
#endif  // !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
2543

shiqian's avatar
shiqian committed
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
// Parses 'str' for a 32-bit signed integer.  If successful, writes the result
// to *value and returns true; otherwise leaves *value unchanged and returns
// false.
// TODO(chandlerc): Find a better way to refactor flag and environment parsing
// out of both gtest-port.cc and gtest.cc to avoid exporting this utility
// function.
bool ParseInt32(const Message& src_text, const char* str, Int32* value);

// Parses a bool/Int32/string from the environment variable
// corresponding to the given Google Test flag.
bool BoolFromGTestEnv(const char* flag, bool default_val);
zhanyong.wan's avatar
zhanyong.wan committed
2555
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
2556
std::string StringFromGTestEnv(const char* flag, const char* default_val);
shiqian's avatar
shiqian committed
2557
2558

}  // namespace internal
2559
2560
2561
2562
2563

// Returns a path to temporary directory.
// Tries to determine an appropriate directory for the platform.
GTEST_API_ std::string TempDir();

shiqian's avatar
shiqian committed
2564
2565
2566
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_