gtest-port.h 67.7 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
33
34
// 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
// platforms.  They are subject to change without notice.  DO NOT USE
// THEM IN USER CODE.
35
36
37
38
//
// 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
39
40
41
42
43

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_

// The user can define the following macros in the build script to
shiqian's avatar
shiqian committed
44
45
// control Google Test's behavior.  If the user doesn't define a macro
// in this list, Google Test will define it.
shiqian's avatar
shiqian committed
46
//
47
48
//   GTEST_HAS_CLONE          - Define it to 1/0 to indicate that clone(2)
//                              is/isn't available.
49
50
//   GTEST_HAS_EXCEPTIONS     - Define it to 1/0 to indicate that exceptions
//                              are enabled.
shiqian's avatar
shiqian committed
51
52
53
54
55
56
//   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).
57
58
//   GTEST_HAS_POSIX_RE       - Define it to 1/0 to indicate that POSIX regular
//                              expressions are/aren't available.
shiqian's avatar
shiqian committed
59
60
//   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that <pthread.h>
//                              is/isn't available.
61
62
63
64
65
//   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).
66
//   GTEST_HAS_TR1_TUPLE      - Define it to 1/0 to indicate tr1::tuple
67
//                              is/isn't available.
68
69
70
//   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
//                              compiler supports Microsoft's "Structured
//                              Exception Handling".
71
72
73
74
//   GTEST_HAS_STREAM_REDIRECTION
//                            - Define it to 1/0 to indicate whether the
//                              platform supports I/O stream redirection using
//                              dup() and dup2().
75
76
77
78
//   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.
79
80
//   GTEST_LANG_CXX11         - Define it to 1/0 to indicate that Google Test
//                              is building in C++11/C++98 mode.
81
82
83
84
85
86
87
//   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
88
89
90

// This header defines the following utilities:
//
zhanyong.wan's avatar
zhanyong.wan committed
91
92
// Macros indicating the current platform (defined to 1 if compiled on
// the given platform; otherwise undefined):
93
//   GTEST_OS_AIX      - IBM AIX
zhanyong.wan's avatar
zhanyong.wan committed
94
//   GTEST_OS_CYGWIN   - Cygwin
95
//   GTEST_OS_HPUX     - HP-UX
zhanyong.wan's avatar
zhanyong.wan committed
96
//   GTEST_OS_LINUX    - Linux
97
//     GTEST_OS_LINUX_ANDROID - Google Android
zhanyong.wan's avatar
zhanyong.wan committed
98
//   GTEST_OS_MAC      - Mac OS X
jgm's avatar
jgm committed
99
//     GTEST_OS_IOS    - iOS
100
//       GTEST_OS_IOS_SIMULATOR - iOS simulator
101
//   GTEST_OS_NACL     - Google Native Client (NaCl)
102
//   GTEST_OS_OPENBSD  - OpenBSD
103
//   GTEST_OS_QNX      - QNX
zhanyong.wan's avatar
zhanyong.wan committed
104
105
//   GTEST_OS_SOLARIS  - Sun Solaris
//   GTEST_OS_SYMBIAN  - Symbian
106
107
108
//   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
//     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
//     GTEST_OS_WINDOWS_MINGW    - MinGW
109
//     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
zhanyong.wan's avatar
zhanyong.wan committed
110
//   GTEST_OS_ZOS      - z/OS
111
//
112
113
114
115
116
117
118
// 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!).
//
zhanyong.wan's avatar
zhanyong.wan committed
119
// Note that it is possible that none of the GTEST_OS_* macros are defined.
shiqian's avatar
shiqian committed
120
//
zhanyong.wan's avatar
zhanyong.wan committed
121
122
123
124
125
126
127
128
// Macros indicating available Google Test features (defined to 1 if
// the corresponding feature is supported; otherwise undefined):
//   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
129
130
131
//   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
132
//   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
133
//                            the above two are mutually exclusive.
134
//   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
shiqian's avatar
shiqian committed
135
136
//
// Macros for basic C++ coding:
shiqian's avatar
shiqian committed
137
//   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
138
139
//   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
//                              variable don't have to be used.
140
//   GTEST_DISALLOW_ASSIGN_   - disables operator=.
shiqian's avatar
shiqian committed
141
142
//   GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
//   GTEST_MUST_USE_RESULT_   - declares that a function's result must be used.
shiqian's avatar
shiqian committed
143
144
145
146
//
// Synchronization:
//   Mutex, MutexLock, ThreadLocal, GetThreadCount()
//                  - synchronization primitives.
shiqian's avatar
shiqian committed
147
148
149
//   GTEST_IS_THREADSAFE - defined to 1 to indicate that the above
//                         synchronization primitives have real implementations
//                         and Google Test is thread-safe; or 0 otherwise.
shiqian's avatar
shiqian committed
150
151
//
// Template meta programming:
152
//   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
153
154
//   IteratorTraits - partial implementation of std::iterator_traits, which
//                    is not available in libCstd when compiled with Sun C++.
shiqian's avatar
shiqian committed
155
156
157
158
159
160
//
// Smart pointers:
//   scoped_ptr     - as in TR2.
//
// Regular expressions:
//   RE             - a simple regular expression class using the POSIX
161
162
163
//                    Extended Regular Expression syntax on UNIX-like
//                    platforms, or a reduced regular exception syntax on
//                    other platforms, including Windows.
shiqian's avatar
shiqian committed
164
165
//
// Logging:
shiqian's avatar
shiqian committed
166
//   GTEST_LOG_()   - logs messages at the specified severity level.
shiqian's avatar
shiqian committed
167
168
169
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.
//
170
171
172
173
// Stdout and stderr capturing:
//   CaptureStdout()     - starts capturing stdout.
//   GetCapturedStdout() - stops capturing stdout and returns the captured
//                         string.
shiqian's avatar
shiqian committed
174
175
176
177
178
179
180
181
182
183
184
185
186
187
//   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_FLAG()       - references a flag.
//   GTEST_DECLARE_*()  - declares a flag.
//   GTEST_DEFINE_*()   - defines a flag.
188
//   GetInjectableArgvs() - returns the command line as a vector of strings.
shiqian's avatar
shiqian committed
189
190
191
192
193
194
195
//
// 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.

196
197
#include <ctype.h>   // for isspace, etc
#include <stddef.h>  // for ptrdiff_t
shiqian's avatar
shiqian committed
198
199
#include <stdlib.h>
#include <stdio.h>
200
#include <string.h>
201
#ifndef _WIN32_WCE
202
203
# include <sys/types.h>
# include <sys/stat.h>
204
#endif  // !_WIN32_WCE
205

jgm's avatar
jgm committed
206
207
208
209
210
#if defined __APPLE__
# include <AvailabilityMacros.h>
# include <TargetConditionals.h>
#endif

211
#include <iostream>  // NOLINT
212
213
#include <sstream>  // NOLINT
#include <string>  // NOLINT
shiqian's avatar
shiqian committed
214

215
#define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
zhanyong.wan's avatar
zhanyong.wan committed
216
#define GTEST_FLAG_PREFIX_ "gtest_"
217
#define GTEST_FLAG_PREFIX_DASH_ "gtest-"
zhanyong.wan's avatar
zhanyong.wan committed
218
#define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
219
220
#define GTEST_NAME_ "Google Test"
#define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/"
shiqian's avatar
shiqian committed
221

shiqian's avatar
shiqian committed
222
223
224
// Determines the version of gcc that is used to compile this.
#ifdef __GNUC__
// 40302 means version 4.3.2.
225
# define GTEST_GCC_VER_ \
shiqian's avatar
shiqian committed
226
227
228
    (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
#endif  // __GNUC__

shiqian's avatar
shiqian committed
229
// Determines the platform on which Google Test is compiled.
230
#ifdef __CYGWIN__
231
# define GTEST_OS_CYGWIN 1
232
#elif defined __SYMBIAN32__
233
# define GTEST_OS_SYMBIAN 1
234
#elif defined _WIN32
235
236
237
238
239
240
241
242
# define GTEST_OS_WINDOWS 1
# ifdef _WIN32_WCE
#  define GTEST_OS_WINDOWS_MOBILE 1
# elif defined(__MINGW__) || defined(__MINGW32__)
#  define GTEST_OS_WINDOWS_MINGW 1
# else
#  define GTEST_OS_WINDOWS_DESKTOP 1
# endif  // _WIN32_WCE
shiqian's avatar
shiqian committed
243
#elif defined __APPLE__
244
# define GTEST_OS_MAC 1
jgm's avatar
jgm committed
245
246
# if TARGET_OS_IPHONE
#  define GTEST_OS_IOS 1
247
#  if TARGET_IPHONE_SIMULATOR
248
#   define GTEST_OS_IOS_SIMULATOR 1
249
#  endif
jgm's avatar
jgm committed
250
# endif
shiqian's avatar
shiqian committed
251
#elif defined __linux__
252
# define GTEST_OS_LINUX 1
253
# if defined __ANDROID__
254
#  define GTEST_OS_LINUX_ANDROID 1
255
# endif
256
#elif defined __MVS__
257
# define GTEST_OS_ZOS 1
258
#elif defined(__sun) && defined(__SVR4)
259
# define GTEST_OS_SOLARIS 1
260
#elif defined(_AIX)
261
# define GTEST_OS_AIX 1
262
263
#elif defined(__hpux)
# define GTEST_OS_HPUX 1
264
#elif defined __native_client__
265
# define GTEST_OS_NACL 1
266
267
#elif defined __OpenBSD__
# define GTEST_OS_OPENBSD 1
268
269
#elif defined __QNX__
# define GTEST_OS_QNX 1
270
#endif  // __CYGWIN__
shiqian's avatar
shiqian committed
271

272
273
274
275
276
277
278
279
280
281
282
283
284
#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

285
286
287
288
289
290
291
// 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.
#if !GTEST_OS_WINDOWS
// 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.
292
# include <unistd.h>
293
# include <strings.h>
294
#elif !GTEST_OS_WINDOWS_MOBILE
295
296
# include <direct.h>
# include <io.h>
297
298
#endif

299
300
301
302
303
#if GTEST_OS_LINUX_ANDROID
// Used to define __ANDROID_API__ matching the target NDK API level.
#  include <android/api-level.h>  // NOLINT
#endif

304
305
// Defines this to true iff Google Test can use POSIX regular expressions.
#ifndef GTEST_HAS_POSIX_RE
306
307
308
309
310
311
# 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
312
313
314
#endif

#if GTEST_HAS_POSIX_RE
315
316
317
318
319

// 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>.
320
# include <regex.h>  // NOLINT
321

322
# define GTEST_USES_POSIX_RE 1
323

324
325
326
327
#elif GTEST_OS_WINDOWS

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

330
331
#else

332
333
// <regex.h> may not be available on this platform.  Use our own
// simple regex implementation instead.
334
# define GTEST_USES_SIMPLE_RE 1
335

336
#endif  // GTEST_HAS_POSIX_RE
337

338
339
340
#ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
341
# if defined(_MSC_VER) || defined(__BORLANDC__)
342
343
// 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
344
// Assumes that exceptions are enabled by default.
345
346
347
348
349
#  ifndef _HAS_EXCEPTIONS
#   define _HAS_EXCEPTIONS 1
#  endif  // _HAS_EXCEPTIONS
#  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
# elif defined(__GNUC__) && __EXCEPTIONS
350
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
351
352
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
353
354
355
// 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.
356
357
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
358
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
359
#  define GTEST_HAS_EXCEPTIONS 1
360
361
362
363
# 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
364
# else
365
366
// For other compilers, we assume exceptions are disabled to be
// conservative.
367
368
#  define GTEST_HAS_EXCEPTIONS 0
# endif  // defined(_MSC_VER) || defined(__BORLANDC__)
369
#endif  // GTEST_HAS_EXCEPTIONS
shiqian's avatar
shiqian committed
370

371
372
373
#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.
374
# define GTEST_HAS_STD_STRING 1
375
376
#elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
377
# error "Google Test cannot be used where ::std::string isn't available."
378
#endif  // !defined(GTEST_HAS_STD_STRING)
shiqian's avatar
shiqian committed
379
380
381
382
383

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

384
# define GTEST_HAS_GLOBAL_STRING 0
shiqian's avatar
shiqian committed
385
386
387
388
389
390
391
392
393

#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.

394
// Cygwin 1.7 and below doesn't support ::std::wstring.
395
396
397
398
// 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
399
400
401
402
403
404

#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.
405
# define GTEST_HAS_GLOBAL_WSTRING \
406
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
shiqian's avatar
shiqian committed
407
408
#endif  // GTEST_HAS_GLOBAL_WSTRING

shiqian's avatar
shiqian committed
409
410
411
412
413
// 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.

414
# ifdef _MSC_VER
shiqian's avatar
shiqian committed
415

416
417
418
419
420
#  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
421
422

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

425
#  ifdef __GXX_RTTI
426
427
428
429
430
431
432
433
434
435
// 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
436
437
438
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI
shiqian's avatar
shiqian committed
439

440
441
442
443
444
445
446
// 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)

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

451
452
453
454
455
#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
456

457
# else
shiqian's avatar
shiqian committed
458

459
// For all other compilers, we assume RTTI is enabled.
460
#  define GTEST_HAS_RTTI 1
shiqian's avatar
shiqian committed
461

462
# endif  // _MSC_VER
shiqian's avatar
shiqian committed
463
464
465

#endif  // GTEST_HAS_RTTI

466
467
468
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
#if GTEST_HAS_RTTI
469
# include <typeinfo>
470
471
#endif

472
// Determines whether Google Test can use the pthreads library.
shiqian's avatar
shiqian committed
473
#ifndef GTEST_HAS_PTHREAD
474
475
476
477
478
// The user didn't tell us explicitly, so we assume pthreads support is
// available on Linux and Mac.
//
// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
// to your compiler flags.
479
480
# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \
    || GTEST_OS_QNX)
shiqian's avatar
shiqian committed
481
482
#endif  // GTEST_HAS_PTHREAD

483
484
485
#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
486
# include <pthread.h>  // NOLINT
487
488

// For timespec and nanosleep, used below.
489
# include <time.h>  // NOLINT
490
491
#endif

492
493
494
// 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).
495
#ifndef GTEST_HAS_TR1_TUPLE
496
497
498
499
# 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
500
// The user didn't tell us not to do it, so we assume it's OK.
501
502
#  define GTEST_HAS_TR1_TUPLE 1
# endif
503
504
505
506
507
#endif  // GTEST_HAS_TR1_TUPLE

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

510
// We use our own TR1 tuple if we aren't sure the user has an
511
512
513
514
515
516
517
518
519
// 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__.
520
# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \
521
522
523
524
      && !GTEST_OS_QNX && !defined(_LIBCPP_VERSION)) || _MSC_VER >= 1600
#  define GTEST_ENV_HAS_TR1_TUPLE_ 1
# endif

525
526
527
528
// 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)
529
530
531
532
#  define GTEST_ENV_HAS_STD_TUPLE_ 1
# endif

# if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
533
534
535
536
#  define GTEST_USE_OWN_TR1_TUPLE 0
# else
#  define GTEST_USE_OWN_TR1_TUPLE 1
# endif
537
538

#endif  // GTEST_USE_OWN_TR1_TUPLE
539

540
541
542
543
// To avoid conditional compilation everywhere, we make it
// gtest-port.h's responsibility to #include the header implementing
// tr1/tuple.
#if GTEST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
544

545
546
# if GTEST_USE_OWN_TR1_TUPLE
#  include "gtest/internal/gtest-tuple.h"
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
# 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;
}
}

563
# elif GTEST_OS_SYMBIAN
zhanyong.wan's avatar
zhanyong.wan committed
564
565
566
567
568
569

// 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.
570
571
572
#  ifdef BOOST_HAS_TR1_TUPLE
#   undef BOOST_HAS_TR1_TUPLE
#  endif  // BOOST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
573
574
575

// This prevents <boost/tr1/detail/config.hpp>, which defines
// BOOST_HAS_TR1_TUPLE, from being #included by Boost's <tuple>.
576
577
#  define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED
#  include <tuple>
zhanyong.wan's avatar
zhanyong.wan committed
578

579
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
580
581
// 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>.
582

583
#  if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
584
585
586
587
588
// 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.
589
590
591
#   define _TR1_FUNCTIONAL 1
#   include <tr1/tuple>
#   undef _TR1_FUNCTIONAL  // Allows the user to #include
592
                        // <tr1/functional> if he chooses to.
593
594
595
#  else
#   include <tr1/tuple>  // NOLINT
#  endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
596

597
# else
598
// If the compiler is not GCC 4.0+, we assume the user is using a
599
// spec-conforming TR1 implementation.
600
601
#  include <tuple>  // NOLINT
# endif  // GTEST_USE_OWN_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
602

603
604
#endif  // GTEST_HAS_TR1_TUPLE

605
606
607
608
609
610
611
// 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.

612
# if GTEST_OS_LINUX && !defined(__ia64__)
613
614
615
616
617
618
619
620
621
622
#  if GTEST_OS_LINUX_ANDROID
// On Android, clone() is only available on ARM starting with Gingerbread.
#    if defined(__arm__) && __ANDROID_API__ >= 9
#     define GTEST_HAS_CLONE 1
#    else
#     define GTEST_HAS_CLONE 0
#    endif
#  else
#   define GTEST_HAS_CLONE 1
#  endif
623
624
625
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)
626
627
628

#endif  // GTEST_HAS_CLONE

629
630
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
631
632
633
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
634
635
636
637
638
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN
#  define GTEST_HAS_STREAM_REDIRECTION 0
# else
#  define GTEST_HAS_STREAM_REDIRECTION 1
# endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
639
#endif  // GTEST_HAS_STREAM_REDIRECTION
640

shiqian's avatar
shiqian committed
641
// Determines whether to support death tests.
642
643
644
// 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
645
#if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
646
     (GTEST_OS_MAC && !GTEST_OS_IOS) || GTEST_OS_IOS_SIMULATOR || \
647
     (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
648
     GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \
649
     GTEST_OS_OPENBSD || GTEST_OS_QNX)
650
651
# define GTEST_HAS_DEATH_TEST 1
# include <vector>  // NOLINT
652
#endif
shiqian's avatar
shiqian committed
653

654
655
656
// 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
657
#define GTEST_HAS_PARAM_TEST 1
658

659
660
// Determines whether to support type-driven tests.

661
// Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
662
// Sun Pro CC, IBM Visual Age, and HP aCC support.
663
#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
664
    defined(__IBMCPP__) || defined(__HP_aCC)
665
666
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
667
#endif
668

669
// Determines whether to support Combine(). This only makes sense when
670
671
672
673
// 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)
674
# define GTEST_HAS_COMBINE 1
675
#endif
676

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

681
682
// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
683
# define GTEST_CAN_STREAM_RESULTS_ 1
684
685
#endif

shiqian's avatar
shiqian committed
686
687
688
689
690
691
692
693
694
695
696
// 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
697
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
shiqian's avatar
shiqian committed
698
#else
699
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
shiqian's avatar
shiqian committed
700
701
#endif

702
// Use this annotation at the end of a struct/class definition to
shiqian's avatar
shiqian committed
703
704
705
706
707
708
// 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
709
//   } GTEST_ATTRIBUTE_UNUSED_;
710
711
712
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
713
#if defined(__GNUC__) && !defined(COMPILER_ICC)
714
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
715
#else
716
# define GTEST_ATTRIBUTE_UNUSED_
717
#endif
shiqian's avatar
shiqian committed
718

719
720
721
722
723
724
// 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
725
// This should be used in the private: declarations for a class.
shiqian's avatar
shiqian committed
726
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
727
728
  type(type const &);\
  GTEST_DISALLOW_ASSIGN_(type)
shiqian's avatar
shiqian committed
729
730
731
732
733

// 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
734
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
shiqian's avatar
shiqian committed
735
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
736
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
shiqian's avatar
shiqian committed
737
#else
738
# define GTEST_MUST_USE_RESULT_
shiqian's avatar
shiqian committed
739
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
shiqian's avatar
shiqian committed
740

741
742
743
744
745
746
// 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.

747
# if defined(_MSC_VER) || defined(__BORLANDC__)
748
// These two compilers are known to support SEH.
749
750
#  define GTEST_HAS_SEH 1
# else
751
// Assume no SEH.
752
753
#  define GTEST_HAS_SEH 0
# endif
754
755
756

#endif  // GTEST_HAS_SEH

757
758
#ifdef _MSC_VER

759
760
761
762
763
# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif
764
765
766
767

#endif  // _MSC_VER

#ifndef GTEST_API_
768
# define GTEST_API_
769
770
#endif

771
#ifdef __GNUC__
772
// Ask the compiler to never inline a given function.
773
# define GTEST_NO_INLINE_ __attribute__((noinline))
774
#else
775
776
# define GTEST_NO_INLINE_
#endif
777

778
779
780
781
782
783
784
// _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

785
786
787
788
789
790
791
792
793
794
795
796
797
// 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_
# endif
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
#endif

shiqian's avatar
shiqian committed
798
799
800
801
802
803
namespace testing {

class Message;

namespace internal {

804
805
806
807
808
// 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;

809
810
811
812
// 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:
//
813
814
//   GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
//                         names_incorrect_size);
815
816
817
818
819
820
821
822
823
824
825
826
827
828
//
// 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.

template <bool>
struct CompileAssert {
};

#define GTEST_COMPILE_ASSERT_(expr, msg) \
829
830
  typedef ::testing::internal::CompileAssert<(static_cast<bool>(expr))> \
      msg[static_cast<bool>(expr) ? 1 : -1] GTEST_ATTRIBUTE_UNUSED_
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881

// Implementation details of GTEST_COMPILE_ASSERT_:
//
// - 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>
struct StaticAssertTypeEqHelper<T, T> {};

882
883
884
// Evaluates to the number of elements in 'array'.
#define GTEST_ARRAY_SIZE_(array) (sizeof(array) / sizeof(array[0]))

885
886
887
888
889
890
891
892
893
894
895
896
#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

897
898
// A helper for suppressing warnings on constant condition.  It just
// returns 'condition'.
899
GTEST_API_ bool IsTrue(bool condition);
900

shiqian's avatar
shiqian committed
901
902
903
904
905
906
907
// 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:
908
909
  typedef T element_type;

shiqian's avatar
shiqian committed
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
  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_) {
925
      if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
shiqian's avatar
shiqian committed
926
927
928
929
930
        delete ptr_;
      }
      ptr_ = p;
    }
  }
931

shiqian's avatar
shiqian committed
932
933
934
 private:
  T* ptr_;

shiqian's avatar
shiqian committed
935
  GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
shiqian's avatar
shiqian committed
936
937
};

938
// Defines RE.
shiqian's avatar
shiqian committed
939

940
// A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
shiqian's avatar
shiqian committed
941
// Regular Expression syntax.
942
class GTEST_API_ RE {
shiqian's avatar
shiqian committed
943
 public:
944
945
946
947
  // 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
948
949
950
951
  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

#if GTEST_HAS_GLOBAL_STRING
952

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

shiqian's avatar
shiqian committed
955
956
957
958
959
960
961
962
#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_; }

963
964
965
966
967
968
969
970
971
972
  // 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
973
974
975
976
977
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#if GTEST_HAS_GLOBAL_STRING
978

979
980
981
  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
982
983
984
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }
985

shiqian's avatar
shiqian committed
986
987
#endif  // GTEST_HAS_GLOBAL_STRING

988
  static bool FullMatch(const char* str, const RE& re);
shiqian's avatar
shiqian committed
989
990
991
992
993
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

994
995
996
  // 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
997
  const char* pattern_;
998
  bool is_valid_;
999

1000
#if GTEST_USES_POSIX_RE
1001

1002
1003
  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().
1004

1005
#else  // GTEST_USES_SIMPLE_RE
1006

1007
  const char* full_pattern_;  // For FullMatch();
1008

1009
#endif
shiqian's avatar
shiqian committed
1010

1011
  GTEST_DISALLOW_ASSIGN_(RE);
1012
};
shiqian's avatar
shiqian committed
1013

1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
// 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
1024
// Defines logging utilities:
1025
1026
//   GTEST_LOG_(severity) - logs messages at the specified severity level. The
//                          message itself is streamed into the macro.
shiqian's avatar
shiqian committed
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.

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

1037
1038
1039
// 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.
1040
class GTEST_API_ GTestLog {
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
 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
1054

1055
1056
1057
#define GTEST_LOG_(severity) \
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()
shiqian's avatar
shiqian committed
1058
1059
1060
1061

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

1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
// 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.
#define GTEST_CHECK_(condition) \
    GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
    if (::testing::internal::IsTrue(condition)) \
      ; \
    else \
      GTEST_LOG_(FATAL) << "Condition " #condition " failed. "

1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
// 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

1093
1094
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
1095
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
1096
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
1097
1098
// const Foo*).  When you use ImplicitCast_, the compiler checks that
// the cast is safe.  Such explicit ImplicitCast_s are necessary in
1099
1100
1101
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
1102
// The syntax for using ImplicitCast_ is the same as for static_cast:
1103
//
1104
//   ImplicitCast_<ToType>(expr)
1105
//
1106
// ImplicitCast_ would have been part of the C++ standard library,
1107
1108
// but the proposal was submitted too late.  It will probably make
// its way into the language in the future.
1109
1110
1111
1112
//
// 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.
1113
template<typename To>
1114
inline To ImplicitCast_(To x) { return x; }
1115
1116

// When you upcast (that is, cast a pointer from type Foo to type
1117
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
// 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.
1133
1134
1135
1136
1137
1138
//
// 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
1139
1140
1141
1142
1143
1144
  // 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.
  if (false) {
    const To to = NULL;
1145
    ::testing::internal::ImplicitCast_<From*>(to);
1146
1147
1148
1149
1150
1151
1152
1153
1154
  }

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

1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
// 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));
  return dynamic_cast<Derived*>(base);  // NOLINT
#else
  return static_cast<Derived*>(base);  // Poor man's downcast.
1167
#endif
1168
1169
}

1170
#if GTEST_HAS_STREAM_REDIRECTION
1171

shiqian's avatar
shiqian committed
1172
// Defines the stderr capturer:
1173
1174
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
shiqian's avatar
shiqian committed
1175
1176
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
1177
//
zhanyong.wan's avatar
zhanyong.wan committed
1178
GTEST_API_ void CaptureStdout();
1179
GTEST_API_ std::string GetCapturedStdout();
zhanyong.wan's avatar
zhanyong.wan committed
1180
GTEST_API_ void CaptureStderr();
1181
GTEST_API_ std::string GetCapturedStderr();
1182

1183
#endif  // GTEST_HAS_STREAM_REDIRECTION
1184
1185


zhanyong.wan's avatar
zhanyong.wan committed
1186
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
1187

1188
1189
1190
const ::std::vector<testing::internal::string>& GetInjectableArgvs();
void SetInjectableArgvs(const ::std::vector<testing::internal::string>*
                             new_argvs);
shiqian's avatar
shiqian committed
1191

1192
1193
// A copy of all command line arguments.  Set by InitGoogleTest().
extern ::std::vector<testing::internal::string> g_argvs;
shiqian's avatar
shiqian committed
1194
1195
1196
1197
1198

#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.

1199
1200
#if GTEST_HAS_PTHREAD

1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
// Sleeps for (roughly) n milli-seconds.  This function is only for
// testing Google Test's own constructs.  Don't use it in user tests,
// either directly or indirectly.
inline void SleepMilliseconds(int n) {
  const timespec time = {
    0,                  // 0 seconds.
    n * 1000L * 1000L,  // And n ms.
  };
  nanosleep(&time, NULL);
}

// 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
1220
1221
1222
1223
1224
1225
  Notification() : notified_(false) {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
  }
  ~Notification() {
    pthread_mutex_destroy(&mutex_);
  }
1226
1227
1228

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
jgm's avatar
jgm committed
1229
1230
1231
1232
1233
  void Notify() {
    pthread_mutex_lock(&mutex_);
    notified_ = true;
    pthread_mutex_unlock(&mutex_);
  }
1234
1235
1236
1237

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
jgm's avatar
jgm committed
1238
1239
1240
1241
1242
1243
    for (;;) {
      pthread_mutex_lock(&mutex_);
      const bool notified = notified_;
      pthread_mutex_unlock(&mutex_);
      if (notified)
        break;
1244
1245
1246
1247
1248
      SleepMilliseconds(10);
    }
  }

 private:
jgm's avatar
jgm committed
1249
1250
  pthread_mutex_t mutex_;
  bool notified_;
1251
1252
1253
1254

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
// 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;
}

1277
// Helper class for testing Google Test's multi-threading constructs.
zhanyong.wan's avatar
zhanyong.wan committed
1278
// To use it, write:
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
//
//   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>
1290
class ThreadWithParam : public ThreadWithParamBase {
1291
1292
1293
 public:
  typedef void (*UserThreadFunc)(T);

zhanyong.wan's avatar
zhanyong.wan committed
1294
  ThreadWithParam(
1295
1296
1297
1298
      UserThreadFunc func, T param, Notification* thread_can_start)
      : func_(func),
        param_(param),
        thread_can_start_(thread_can_start),
zhanyong.wan's avatar
zhanyong.wan committed
1299
        finished_(false) {
1300
    ThreadWithParamBase* const base = this;
zhanyong.wan's avatar
zhanyong.wan committed
1301
1302
1303
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
1304
        pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
zhanyong.wan's avatar
zhanyong.wan committed
1305
1306
  }
  ~ThreadWithParam() { Join(); }
1307
1308
1309

  void Join() {
    if (!finished_) {
zhanyong.wan's avatar
zhanyong.wan committed
1310
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
1311
1312
1313
1314
      finished_ = true;
    }
  }

1315
  virtual void Run() {
1316
1317
1318
1319
1320
    if (thread_can_start_ != NULL)
      thread_can_start_->WaitForNotification();
    func_(param_);
  }

1321
 private:
1322
1323
1324
1325
1326
1327
  const UserThreadFunc func_;  // User-supplied thread function.
  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
1328
1329
1330
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1331
1332
};

1333
1334
1335
// MutexBase and Mutex implement mutex on pthreads-based platforms. They
// are used in conjunction with class MutexLock:
//
1336
1337
1338
1339
//   Mutex mutex;
//   ...
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the end
//                            // of the current scope.
1340
1341
//
// MutexBase implements behavior for both statically and dynamically
1342
1343
// allocated mutexes.  Do not use MutexBase directly.  Instead, write
// the following to define a static mutex:
1344
//
1345
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1346
//
1347
// You can forward declare a static mutex like this:
1348
//
1349
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
1350
//
1351
// To create a dynamic mutex, just define an object of type Mutex.
1352
1353
class MutexBase {
 public:
1354
1355
1356
1357
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
1358
    has_owner_ = true;
1359
1360
1361
1362
  }

  // Releases this mutex.
  void Unlock() {
1363
1364
1365
    // 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
1366
    // mutex when this is called.
1367
    has_owner_ = false;
1368
1369
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }
1370
1371
1372

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
1373
  void AssertHeld() const {
1374
    GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
1375
1376
        << "The current thread is not holding the mutex @" << this;
  }
1377

1378
1379
1380
1381
1382
  // 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.
1383
 public:
1384
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
1385
1386
1387
1388
1389
1390
1391
1392
  // 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.
1393
1394
1395
};

// Forward-declares a static mutex.
1396
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1397
1398
    extern ::testing::internal::MutexBase mutex

1399
// Defines and statically (i.e. at link time) initializes a static mutex.
1400
1401
1402
1403
1404
// The initialization list here does not explicitly initialize each field,
// instead relying on default initialization for the unspecified fields. In
// particular, the owner_ field (a pthread_t) is not explicitly initialized.
// This allows initialization to work whether pthread_t is a scalar or struct.
// The flag -Wmissing-field-initializers must not be specified for this to work.
1405
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1406
    ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false }
1407

1408
1409
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
1410
1411
class Mutex : public MutexBase {
 public:
1412
1413
  Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
1414
    has_owner_ = false;
1415
1416
1417
1418
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }
1419
1420
1421
1422
1423

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

1424
// We cannot name this class MutexLock as the ctor declaration would
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
// conflict with a macro named MutexLock, which is defined on some
// platforms.  Hence the typedef trick below.
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;

1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
// 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);
}

1459
1460
// Implements thread-local storage on pthreads-based systems.
//
1461
1462
//   // Thread 1
//   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1463
//
1464
1465
1466
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
1467
//
1468
1469
1470
1471
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
1472
//
1473
1474
// The template type argument T must have a public copy constructor.
// In addition, the default ThreadLocal constructor requires T to have
zhanyong.wan's avatar
zhanyong.wan committed
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
// a public default constructor.
//
// An object managed for a thread by a ThreadLocal instance is deleted
// when the thread exits.  Or, if the ThreadLocal instance dies in
// that thread, when the ThreadLocal dies.  It's the user's
// responsibility to ensure that all other threads using a ThreadLocal
// have exited when it dies, or the per-thread objects for those
// threads will not be deleted.
//
// 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.
1488
1489
1490
template <typename T>
class ThreadLocal {
 public:
1491
1492
1493
1494
  ThreadLocal() : key_(CreateKey()),
                  default_() {}
  explicit ThreadLocal(const T& value) : key_(CreateKey()),
                                         default_(value) {}
1495
1496

  ~ThreadLocal() {
zhanyong.wan's avatar
zhanyong.wan committed
1497
1498
1499
1500
1501
    // 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.
1502
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
1503
1504
1505
1506
1507
1508
1509
1510
  }

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

 private:
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
  // Holds a value of type T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

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

1523
1524
  static pthread_key_t CreateKey() {
    pthread_key_t key;
zhanyong.wan's avatar
zhanyong.wan committed
1525
1526
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
1527
1528
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
1529
1530
1531
1532
    return key;
  }

  T* GetOrCreateValue() const {
1533
1534
1535
1536
1537
    ThreadLocalValueHolderBase* const holder =
        static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
    if (holder != NULL) {
      return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
    }
1538

1539
1540
1541
1542
    ValueHolder* const new_holder = new ValueHolder(default_);
    ThreadLocalValueHolderBase* const holder_base = new_holder;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
    return new_holder->pointer();
1543
1544
1545
1546
  }

  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
1547
  const T default_;  // The default value for each thread.
1548
1549
1550
1551

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

1552
# define GTEST_IS_THREADSAFE 1
1553
1554
1555

#else  // GTEST_HAS_PTHREAD

shiqian's avatar
shiqian committed
1556
1557
1558
1559
1560
1561
1562
1563
// 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() {}
1564
1565
  void Lock() {}
  void Unlock() {}
shiqian's avatar
shiqian committed
1566
1567
1568
  void AssertHeld() const {}
};

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

1572
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
1573

shiqian's avatar
shiqian committed
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template <typename T>
class ThreadLocal {
 public:
shiqian's avatar
shiqian committed
1584
1585
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
shiqian's avatar
shiqian committed
1586
1587
1588
1589
1590
1591
1592
1593
  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_;
};

shiqian's avatar
shiqian committed
1594
1595
// The above synchronization primitives have dummy implementations.
// Therefore Google Test is not thread-safe.
1596
# define GTEST_IS_THREADSAFE 0
shiqian's avatar
shiqian committed
1597

1598
1599
1600
1601
#endif  // GTEST_HAS_PTHREAD

// 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
1602
GTEST_API_ size_t GetThreadCount();
1603

1604
// Passing non-POD classes through ellipsis (...) crashes the ARM
1605
1606
1607
1608
1609
1610
// 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)
1611
1612
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
1613
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
1614
#else
1615
# define GTEST_CAN_COMPARE_NULL 1
1616
#endif
shiqian's avatar
shiqian committed
1617

1618
1619
1620
1621
// 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.
1622
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
1623
# define GTEST_NEEDS_IS_POINTER_ 1
1624
#endif
shiqian's avatar
shiqian committed
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641

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 {};

1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
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;
};

1657
#if GTEST_OS_WINDOWS
1658
1659
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
1660
1661
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
1662
#else
1663
1664
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
1665
typedef long long BiggestInt;  // NOLINT
1666
1667
#endif  // GTEST_OS_WINDOWS

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
// 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;
}
1693
1694
1695
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast<unsigned char>(ch)) != 0;
}
1696
1697
1698
1699
inline bool IsXDigit(wchar_t ch) {
  const unsigned char low_byte = static_cast<unsigned char>(ch);
  return ch == low_byte && isxdigit(low_byte) != 0;
}
1700
1701
1702
1703
1704
1705
1706
1707

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)));
}

1708
1709
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
1710
1711
1712
1713
// 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.

1714
1715
1716
1717
namespace posix {

// Functions with a different name on Windows.

zhanyong.wan's avatar
zhanyong.wan committed
1718
#if GTEST_OS_WINDOWS
1719

1720
typedef struct _stat StatStruct;
1721

1722
# ifdef __BORLANDC__
1723
1724
1725
1726
1727
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); }
1728
1729
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
1730
inline int IsATTY(int /* fd */) { return 0; }
1731
#  else
1732
inline int IsATTY(int fd) { return _isatty(fd); }
1733
#  endif  // GTEST_OS_WINDOWS_MOBILE
1734
1735
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
1736
}
1737
inline char* StrDup(const char* src) { return _strdup(src); }
1738
# endif  // __BORLANDC__
1739

1740
# if GTEST_OS_WINDOWS_MOBILE
1741
1742
1743
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.
1744
# else
1745
1746
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
1747
1748
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
1749
1750
  return (_S_IFDIR & st.st_mode) != 0;
}
1751
# endif  // GTEST_OS_WINDOWS_MOBILE
1752

shiqian's avatar
shiqian committed
1753
#else
1754

1755
typedef struct stat StatStruct;
1756

1757
1758
1759
1760
1761
1762
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);
}
1763
inline char* StrDup(const char* src) { return strdup(src); }
1764
1765
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
1766

shiqian's avatar
shiqian committed
1767
1768
#endif  // GTEST_OS_WINDOWS

1769
1770
1771
1772
// Functions deprecated by MSVC 8.0.

#ifdef _MSC_VER
// Temporarily disable warning 4996 (deprecated function).
1773
1774
# pragma warning(push)
# pragma warning(disable:4996)
1775
1776
#endif

1777
1778
inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
1779
}
1780
1781
1782
1783
1784

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

1785
#if !GTEST_OS_WINDOWS_MOBILE
1786
inline int ChDir(const char* dir) { return chdir(dir); }
1787
#endif
1788
1789
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
1790
}
1791
#if !GTEST_OS_WINDOWS_MOBILE
1792
1793
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
1794
}
1795
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
1796
#endif
1797
inline int FClose(FILE* fp) { return fclose(fp); }
1798
#if !GTEST_OS_WINDOWS_MOBILE
1799
1800
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast<int>(read(fd, buf, count));
1801
}
1802
1803
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast<int>(write(fd, buf, count));
1804
}
1805
1806
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
1807
#endif
1808
inline const char* GetEnv(const char* name) {
1809
1810
#if GTEST_OS_WINDOWS_MOBILE
  // We are on Windows CE, which has no environment variables.
1811
  return NULL;
1812
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
1813
1814
1815
1816
  // 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;
1817
#else
1818
  return getenv(name);
1819
1820
1821
1822
#endif
}

#ifdef _MSC_VER
1823
# pragma warning(pop)  // Restores the warning state.
1824
1825
#endif

1826
#if GTEST_OS_WINDOWS_MOBILE
1827
1828
1829
// 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.
1830
void Abort();
1831
#else
1832
inline void Abort() { abort(); }
1833
#endif  // GTEST_OS_WINDOWS_MOBILE
1834
1835
1836

}  // namespace posix

1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
// 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
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
// 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
1906
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
  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.
#define GTEST_FLAG(name) FLAGS_gtest_##name

// Macros for declaring flags.
1928
#define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1929
#define GTEST_DECLARE_int32_(name) \
1930
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1931
#define GTEST_DECLARE_string_(name) \
1932
    GTEST_API_ extern ::std::string GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1933
1934

// Macros for defining flags.
shiqian's avatar
shiqian committed
1935
#define GTEST_DEFINE_bool_(name, default_val, doc) \
1936
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1937
#define GTEST_DEFINE_int32_(name, default_val, doc) \
1938
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1939
#define GTEST_DEFINE_string_(name, default_val, doc) \
1940
    GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1941

1942
1943
1944
1945
// Thread annotations
#define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
#define GTEST_LOCK_EXCLUDED_(locks)

shiqian's avatar
shiqian committed
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
// 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
1957
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
shiqian's avatar
shiqian committed
1958
1959
1960
1961
1962
1963
const char* StringFromGTestEnv(const char* flag, const char* default_val);

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_