gtest-port.h 69.9 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
124
//   GTEST_OS_HPUX     - HP-UX
zhanyong.wan's avatar
zhanyong.wan committed
125
//   GTEST_OS_LINUX    - Linux
126
//     GTEST_OS_LINUX_ANDROID - Google Android
zhanyong.wan's avatar
zhanyong.wan committed
127
//   GTEST_OS_MAC      - Mac OS X
jgm's avatar
jgm committed
128
//     GTEST_OS_IOS    - iOS
129
//       GTEST_OS_IOS_SIMULATOR - iOS simulator
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
zhanyong.wan's avatar
zhanyong.wan committed
139
//   GTEST_OS_ZOS      - z/OS
140
//
141
142
143
144
145
146
147
// 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!).
//
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
// 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
166
//
zhanyong.wan's avatar
zhanyong.wan committed
167
168
169
170
171
172
//   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
173
//   GTEST_IS_THREADSAFE    - Google Test is thread-safe.
174
175
176
//   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
177
//   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
178
//                            the above two are mutually exclusive.
179
//   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
180
181
182
183
184
185
186
187
188
189
190
191

// 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
192
193
//
// Macros for basic C++ coding:
shiqian's avatar
shiqian committed
194
//   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
195
196
//   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
//                              variable don't have to be used.
197
//   GTEST_DISALLOW_ASSIGN_   - disables operator=.
shiqian's avatar
shiqian committed
198
199
//   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
200
201
202
//
// Synchronization:
//   Mutex, MutexLock, ThreadLocal, GetThreadCount()
203
//                            - synchronization primitives.
shiqian's avatar
shiqian committed
204
205
//
// Template meta programming:
206
//   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
207
208
//   IteratorTraits - partial implementation of std::iterator_traits, which
//                    is not available in libCstd when compiled with Sun C++.
shiqian's avatar
shiqian committed
209
210
211
212
213
214
//
// Smart pointers:
//   scoped_ptr     - as in TR2.
//
// Regular expressions:
//   RE             - a simple regular expression class using the POSIX
215
216
217
//                    Extended Regular Expression syntax on UNIX-like
//                    platforms, or a reduced regular exception syntax on
//                    other platforms, including Windows.
shiqian's avatar
shiqian committed
218
219
//
// Logging:
shiqian's avatar
shiqian committed
220
//   GTEST_LOG_()   - logs messages at the specified severity level.
shiqian's avatar
shiqian committed
221
222
223
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.
//
224
225
226
227
// Stdout and stderr capturing:
//   CaptureStdout()     - starts capturing stdout.
//   GetCapturedStdout() - stops capturing stdout and returns the captured
//                         string.
shiqian's avatar
shiqian committed
228
229
230
231
232
233
234
235
236
237
238
239
240
//   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.
241
//   GetInjectableArgvs() - returns the command line as a vector of strings.
shiqian's avatar
shiqian committed
242
243
244
245
246
247
248
//
// 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.

249
250
#include <ctype.h>   // for isspace, etc
#include <stddef.h>  // for ptrdiff_t
shiqian's avatar
shiqian committed
251
252
#include <stdlib.h>
#include <stdio.h>
253
#include <string.h>
254
#ifndef _WIN32_WCE
255
256
# include <sys/types.h>
# include <sys/stat.h>
257
#endif  // !_WIN32_WCE
258

jgm's avatar
jgm committed
259
260
261
262
263
#if defined __APPLE__
# include <AvailabilityMacros.h>
# include <TargetConditionals.h>
#endif

264
#include <iostream>  // NOLINT
265
266
#include <sstream>  // NOLINT
#include <string>  // NOLINT
shiqian's avatar
shiqian committed
267

268
#define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
zhanyong.wan's avatar
zhanyong.wan committed
269
#define GTEST_FLAG_PREFIX_ "gtest_"
270
#define GTEST_FLAG_PREFIX_DASH_ "gtest-"
zhanyong.wan's avatar
zhanyong.wan committed
271
#define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
272
273
#define GTEST_NAME_ "Google Test"
#define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/"
shiqian's avatar
shiqian committed
274

shiqian's avatar
shiqian committed
275
276
277
// Determines the version of gcc that is used to compile this.
#ifdef __GNUC__
// 40302 means version 4.3.2.
278
# define GTEST_GCC_VER_ \
shiqian's avatar
shiqian committed
279
280
281
    (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
#endif  // __GNUC__

shiqian's avatar
shiqian committed
282
// Determines the platform on which Google Test is compiled.
283
#ifdef __CYGWIN__
284
# define GTEST_OS_CYGWIN 1
285
#elif defined __SYMBIAN32__
286
# define GTEST_OS_SYMBIAN 1
287
#elif defined _WIN32
288
289
290
291
292
293
294
295
# 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
296
#elif defined __APPLE__
297
# define GTEST_OS_MAC 1
jgm's avatar
jgm committed
298
299
# if TARGET_OS_IPHONE
#  define GTEST_OS_IOS 1
300
#  if TARGET_IPHONE_SIMULATOR
301
#   define GTEST_OS_IOS_SIMULATOR 1
302
#  endif
jgm's avatar
jgm committed
303
# endif
shiqian's avatar
shiqian committed
304
#elif defined __linux__
305
# define GTEST_OS_LINUX 1
306
# if defined __ANDROID__
307
#  define GTEST_OS_LINUX_ANDROID 1
308
# endif
309
#elif defined __MVS__
310
# define GTEST_OS_ZOS 1
311
#elif defined(__sun) && defined(__SVR4)
312
# define GTEST_OS_SOLARIS 1
313
#elif defined(_AIX)
314
# define GTEST_OS_AIX 1
315
316
#elif defined(__hpux)
# define GTEST_OS_HPUX 1
317
#elif defined __native_client__
318
# define GTEST_OS_NACL 1
319
320
#elif defined __OpenBSD__
# define GTEST_OS_OPENBSD 1
321
322
#elif defined __QNX__
# define GTEST_OS_QNX 1
323
#endif  // __CYGWIN__
shiqian's avatar
shiqian committed
324

325
326
327
328
329
330
331
332
333
334
335
336
337
#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

338
339
340
341
342
343
344
345
// C++11 specifies that <initializer_list> provides std::initializer_list. 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)
# define GTEST_HAS_STD_INITIALIZER_LIST_ 1
#endif

346
347
348
349
350
351
352
// 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.
353
# include <unistd.h>
354
# include <strings.h>
355
#elif !GTEST_OS_WINDOWS_MOBILE
356
357
# include <direct.h>
# include <io.h>
358
359
#endif

360
361
362
363
364
#if GTEST_OS_LINUX_ANDROID
// Used to define __ANDROID_API__ matching the target NDK API level.
#  include <android/api-level.h>  // NOLINT
#endif

365
366
// Defines this to true iff Google Test can use POSIX regular expressions.
#ifndef GTEST_HAS_POSIX_RE
367
368
369
370
371
372
# 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
373
374
375
#endif

#if GTEST_HAS_POSIX_RE
376
377
378
379
380

// 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>.
381
# include <regex.h>  // NOLINT
382

383
# define GTEST_USES_POSIX_RE 1
384

385
386
387
388
#elif GTEST_OS_WINDOWS

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

391
392
#else

393
394
// <regex.h> may not be available on this platform.  Use our own
// simple regex implementation instead.
395
# define GTEST_USES_SIMPLE_RE 1
396

397
#endif  // GTEST_HAS_POSIX_RE
398

399
400
401
#ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
402
# if defined(_MSC_VER) || defined(__BORLANDC__)
403
404
// 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
405
// Assumes that exceptions are enabled by default.
406
407
408
409
410
#  ifndef _HAS_EXCEPTIONS
#   define _HAS_EXCEPTIONS 1
#  endif  // _HAS_EXCEPTIONS
#  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
# elif defined(__GNUC__) && __EXCEPTIONS
411
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
412
413
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
414
415
416
// 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.
417
418
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
419
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
420
#  define GTEST_HAS_EXCEPTIONS 1
421
422
423
424
# 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
425
# else
426
427
// For other compilers, we assume exceptions are disabled to be
// conservative.
428
429
#  define GTEST_HAS_EXCEPTIONS 0
# endif  // defined(_MSC_VER) || defined(__BORLANDC__)
430
#endif  // GTEST_HAS_EXCEPTIONS
shiqian's avatar
shiqian committed
431

432
433
434
#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.
435
# define GTEST_HAS_STD_STRING 1
436
437
#elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
438
# error "Google Test cannot be used where ::std::string isn't available."
439
#endif  // !defined(GTEST_HAS_STD_STRING)
shiqian's avatar
shiqian committed
440
441
442
443
444

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

445
# define GTEST_HAS_GLOBAL_STRING 0
shiqian's avatar
shiqian committed
446
447
448
449
450
451
452
453
454

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

455
// Cygwin 1.7 and below doesn't support ::std::wstring.
456
457
458
459
// 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
460
461
462
463
464
465

#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.
466
# define GTEST_HAS_GLOBAL_WSTRING \
467
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
shiqian's avatar
shiqian committed
468
469
#endif  // GTEST_HAS_GLOBAL_WSTRING

shiqian's avatar
shiqian committed
470
471
472
473
474
// 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.

475
# ifdef _MSC_VER
shiqian's avatar
shiqian committed
476

477
478
479
480
481
#  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
482
483

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

486
#  ifdef __GXX_RTTI
487
488
489
490
491
492
493
494
495
496
// 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
497
498
499
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI
shiqian's avatar
shiqian committed
500

501
502
503
504
505
506
507
// 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)

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

512
513
514
515
516
#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
517

518
# else
shiqian's avatar
shiqian committed
519

520
// For all other compilers, we assume RTTI is enabled.
521
#  define GTEST_HAS_RTTI 1
shiqian's avatar
shiqian committed
522

523
# endif  // _MSC_VER
shiqian's avatar
shiqian committed
524
525
526

#endif  // GTEST_HAS_RTTI

527
528
529
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
#if GTEST_HAS_RTTI
530
# include <typeinfo>
531
532
#endif

533
// Determines whether Google Test can use the pthreads library.
shiqian's avatar
shiqian committed
534
#ifndef GTEST_HAS_PTHREAD
535
536
537
538
539
// 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.
540
541
# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \
    || GTEST_OS_QNX)
shiqian's avatar
shiqian committed
542
543
#endif  // GTEST_HAS_PTHREAD

544
545
546
#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
547
# include <pthread.h>  // NOLINT
548
549

// For timespec and nanosleep, used below.
550
# include <time.h>  // NOLINT
551
552
#endif

553
554
555
// 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).
556
#ifndef GTEST_HAS_TR1_TUPLE
557
558
559
560
# 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
561
// The user didn't tell us not to do it, so we assume it's OK.
562
563
#  define GTEST_HAS_TR1_TUPLE 1
# endif
564
565
566
567
568
#endif  // GTEST_HAS_TR1_TUPLE

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

571
// We use our own TR1 tuple if we aren't sure the user has an
572
573
574
575
576
577
578
579
580
// 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__.
581
# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \
582
583
584
585
      && !GTEST_OS_QNX && !defined(_LIBCPP_VERSION)) || _MSC_VER >= 1600
#  define GTEST_ENV_HAS_TR1_TUPLE_ 1
# endif

586
587
588
589
// 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)
590
591
592
593
#  define GTEST_ENV_HAS_STD_TUPLE_ 1
# endif

# if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
594
595
596
597
#  define GTEST_USE_OWN_TR1_TUPLE 0
# else
#  define GTEST_USE_OWN_TR1_TUPLE 1
# endif
598
599

#endif  // GTEST_USE_OWN_TR1_TUPLE
600

601
602
603
604
// 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
605

606
607
# if GTEST_USE_OWN_TR1_TUPLE
#  include "gtest/internal/gtest-tuple.h"
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
# 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;
}
}

624
# elif GTEST_OS_SYMBIAN
zhanyong.wan's avatar
zhanyong.wan committed
625
626
627
628
629
630

// 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.
631
632
633
#  ifdef BOOST_HAS_TR1_TUPLE
#   undef BOOST_HAS_TR1_TUPLE
#  endif  // BOOST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
634
635
636

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

640
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
641
642
// 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>.
643

644
#  if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
645
646
647
648
649
// 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.
650
651
652
#   define _TR1_FUNCTIONAL 1
#   include <tr1/tuple>
#   undef _TR1_FUNCTIONAL  // Allows the user to #include
653
                        // <tr1/functional> if he chooses to.
654
655
656
#  else
#   include <tr1/tuple>  // NOLINT
#  endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
657

658
# else
659
// If the compiler is not GCC 4.0+, we assume the user is using a
660
// spec-conforming TR1 implementation.
661
662
#  include <tuple>  // NOLINT
# endif  // GTEST_USE_OWN_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
663

664
665
#endif  // GTEST_HAS_TR1_TUPLE

666
667
668
669
670
671
672
// 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.

673
# if GTEST_OS_LINUX && !defined(__ia64__)
674
675
676
677
678
679
680
681
682
683
#  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
684
685
686
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)
687
688
689

#endif  // GTEST_HAS_CLONE

690
691
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
692
693
694
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
695
696
697
698
699
# 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
700
#endif  // GTEST_HAS_STREAM_REDIRECTION
701

shiqian's avatar
shiqian committed
702
// Determines whether to support death tests.
703
704
705
// 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
706
#if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
707
     (GTEST_OS_MAC && !GTEST_OS_IOS) || GTEST_OS_IOS_SIMULATOR || \
708
     (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
709
     GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \
710
     GTEST_OS_OPENBSD || GTEST_OS_QNX)
711
712
# define GTEST_HAS_DEATH_TEST 1
# include <vector>  // NOLINT
713
#endif
shiqian's avatar
shiqian committed
714

715
716
717
// 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
718
#define GTEST_HAS_PARAM_TEST 1
719

720
721
// Determines whether to support type-driven tests.

722
// Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
723
// Sun Pro CC, IBM Visual Age, and HP aCC support.
724
#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
725
    defined(__IBMCPP__) || defined(__HP_aCC)
726
727
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
728
#endif
729

730
// Determines whether to support Combine(). This only makes sense when
731
732
733
734
// 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)
735
# define GTEST_HAS_COMBINE 1
736
#endif
737

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

742
743
// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
744
# define GTEST_CAN_STREAM_RESULTS_ 1
745
746
#endif

shiqian's avatar
shiqian committed
747
748
749
750
751
752
753
754
755
756
757
// 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
758
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
shiqian's avatar
shiqian committed
759
#else
760
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
shiqian's avatar
shiqian committed
761
762
#endif

763
// Use this annotation at the end of a struct/class definition to
shiqian's avatar
shiqian committed
764
765
766
767
768
769
// 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
770
//   } GTEST_ATTRIBUTE_UNUSED_;
771
772
773
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
774
#if defined(__GNUC__) && !defined(COMPILER_ICC)
775
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
776
#else
777
# define GTEST_ATTRIBUTE_UNUSED_
778
#endif
shiqian's avatar
shiqian committed
779

780
781
782
783
784
785
// 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
786
// This should be used in the private: declarations for a class.
shiqian's avatar
shiqian committed
787
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
788
789
  type(type const &);\
  GTEST_DISALLOW_ASSIGN_(type)
shiqian's avatar
shiqian committed
790
791
792
793
794

// 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
795
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
shiqian's avatar
shiqian committed
796
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
797
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
shiqian's avatar
shiqian committed
798
#else
799
# define GTEST_MUST_USE_RESULT_
shiqian's avatar
shiqian committed
800
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
shiqian's avatar
shiqian committed
801

802
803
804
805
806
807
// 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.

808
# if defined(_MSC_VER) || defined(__BORLANDC__)
809
// These two compilers are known to support SEH.
810
811
#  define GTEST_HAS_SEH 1
# else
812
// Assume no SEH.
813
814
#  define GTEST_HAS_SEH 0
# endif
815
816
817

#endif  // GTEST_HAS_SEH

818
819
#ifdef _MSC_VER

820
821
822
823
824
# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif
825
826
827
828

#endif  // _MSC_VER

#ifndef GTEST_API_
829
# define GTEST_API_
830
831
#endif

832
#ifdef __GNUC__
833
// Ask the compiler to never inline a given function.
834
# define GTEST_NO_INLINE_ __attribute__((noinline))
835
#else
836
837
# define GTEST_NO_INLINE_
#endif
838

839
840
841
842
843
844
845
// _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

846
847
848
849
850
851
852
853
854
855
856
857
858
// 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
859
860
861
862
863
864
namespace testing {

class Message;

namespace internal {

865
866
867
868
869
// 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;

870
871
872
873
// 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:
//
874
875
//   GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
//                         names_incorrect_size);
876
877
878
879
880
881
882
883
884
885
886
887
888
889
//
// 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) \
890
891
  typedef ::testing::internal::CompileAssert<(static_cast<bool>(expr))> \
      msg[static_cast<bool>(expr) ? 1 : -1] GTEST_ATTRIBUTE_UNUSED_
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942

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

943
944
945
// Evaluates to the number of elements in 'array'.
#define GTEST_ARRAY_SIZE_(array) (sizeof(array) / sizeof(array[0]))

946
947
948
949
950
951
952
953
954
955
956
957
#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

958
959
// A helper for suppressing warnings on constant condition.  It just
// returns 'condition'.
960
GTEST_API_ bool IsTrue(bool condition);
961

shiqian's avatar
shiqian committed
962
963
964
965
966
967
968
// 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:
969
970
  typedef T element_type;

shiqian's avatar
shiqian committed
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
  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_) {
986
      if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
shiqian's avatar
shiqian committed
987
988
989
990
991
        delete ptr_;
      }
      ptr_ = p;
    }
  }
992

shiqian's avatar
shiqian committed
993
994
995
 private:
  T* ptr_;

shiqian's avatar
shiqian committed
996
  GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
shiqian's avatar
shiqian committed
997
998
};

999
// Defines RE.
shiqian's avatar
shiqian committed
1000

1001
// A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
shiqian's avatar
shiqian committed
1002
// Regular Expression syntax.
1003
class GTEST_API_ RE {
shiqian's avatar
shiqian committed
1004
 public:
1005
1006
1007
1008
  // 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
1009
1010
1011
1012
  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

#if GTEST_HAS_GLOBAL_STRING
1013

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

shiqian's avatar
shiqian committed
1016
1017
1018
1019
1020
1021
1022
1023
#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_; }

1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
  // 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
1034
1035
1036
1037
1038
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#if GTEST_HAS_GLOBAL_STRING
1039

1040
1041
1042
  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
1043
1044
1045
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }
1046

shiqian's avatar
shiqian committed
1047
1048
#endif  // GTEST_HAS_GLOBAL_STRING

1049
  static bool FullMatch(const char* str, const RE& re);
shiqian's avatar
shiqian committed
1050
1051
1052
1053
1054
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

1055
1056
1057
  // 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
1058
  const char* pattern_;
1059
  bool is_valid_;
1060

1061
#if GTEST_USES_POSIX_RE
1062

1063
1064
  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().
1065

1066
#else  // GTEST_USES_SIMPLE_RE
1067

1068
  const char* full_pattern_;  // For FullMatch();
1069

1070
#endif
shiqian's avatar
shiqian committed
1071

1072
  GTEST_DISALLOW_ASSIGN_(RE);
1073
};
shiqian's avatar
shiqian committed
1074

1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
// 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
1085
// Defines logging utilities:
1086
1087
//   GTEST_LOG_(severity) - logs messages at the specified severity level. The
//                          message itself is streamed into the macro.
shiqian's avatar
shiqian committed
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.

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

1098
1099
1100
// 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.
1101
class GTEST_API_ GTestLog {
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
 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
1115

1116
1117
1118
#define GTEST_LOG_(severity) \
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()
shiqian's avatar
shiqian committed
1119
1120
1121
1122

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

1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
// 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. "

1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
// 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

1154
1155
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
1156
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
1157
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
1158
1159
// const Foo*).  When you use ImplicitCast_, the compiler checks that
// the cast is safe.  Such explicit ImplicitCast_s are necessary in
1160
1161
1162
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
1163
// The syntax for using ImplicitCast_ is the same as for static_cast:
1164
//
1165
//   ImplicitCast_<ToType>(expr)
1166
//
1167
// ImplicitCast_ would have been part of the C++ standard library,
1168
1169
// but the proposal was submitted too late.  It will probably make
// its way into the language in the future.
1170
1171
1172
1173
//
// 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.
1174
template<typename To>
1175
inline To ImplicitCast_(To x) { return x; }
1176
1177

// When you upcast (that is, cast a pointer from type Foo to type
1178
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
// 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.
1194
1195
1196
1197
1198
1199
//
// 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
1200
1201
1202
1203
1204
1205
  // 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;
1206
    ::testing::internal::ImplicitCast_<From*>(to);
1207
1208
1209
1210
1211
1212
1213
1214
1215
  }

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

1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
// 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.
1228
#endif
1229
1230
}

1231
#if GTEST_HAS_STREAM_REDIRECTION
1232

shiqian's avatar
shiqian committed
1233
// Defines the stderr capturer:
1234
1235
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
shiqian's avatar
shiqian committed
1236
1237
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
1238
//
zhanyong.wan's avatar
zhanyong.wan committed
1239
GTEST_API_ void CaptureStdout();
1240
GTEST_API_ std::string GetCapturedStdout();
zhanyong.wan's avatar
zhanyong.wan committed
1241
GTEST_API_ void CaptureStderr();
1242
GTEST_API_ std::string GetCapturedStderr();
1243

1244
#endif  // GTEST_HAS_STREAM_REDIRECTION
1245
1246


zhanyong.wan's avatar
zhanyong.wan committed
1247
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
1248

1249
1250
1251
const ::std::vector<testing::internal::string>& GetInjectableArgvs();
void SetInjectableArgvs(const ::std::vector<testing::internal::string>*
                             new_argvs);
shiqian's avatar
shiqian committed
1252

1253
1254
// A copy of all command line arguments.  Set by InitGoogleTest().
extern ::std::vector<testing::internal::string> g_argvs;
shiqian's avatar
shiqian committed
1255
1256
1257
1258
1259

#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.

1260
1261
#if GTEST_HAS_PTHREAD

1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
// 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
1281
1282
1283
1284
1285
1286
  Notification() : notified_(false) {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
  }
  ~Notification() {
    pthread_mutex_destroy(&mutex_);
  }
1287
1288
1289

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
jgm's avatar
jgm committed
1290
1291
1292
1293
1294
  void Notify() {
    pthread_mutex_lock(&mutex_);
    notified_ = true;
    pthread_mutex_unlock(&mutex_);
  }
1295
1296
1297
1298

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
jgm's avatar
jgm committed
1299
1300
1301
1302
1303
1304
    for (;;) {
      pthread_mutex_lock(&mutex_);
      const bool notified = notified_;
      pthread_mutex_unlock(&mutex_);
      if (notified)
        break;
1305
1306
1307
1308
1309
      SleepMilliseconds(10);
    }
  }

 private:
jgm's avatar
jgm committed
1310
1311
  pthread_mutex_t mutex_;
  bool notified_;
1312
1313
1314
1315

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
// 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;
}

1338
// Helper class for testing Google Test's multi-threading constructs.
zhanyong.wan's avatar
zhanyong.wan committed
1339
// To use it, write:
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
//
//   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>
1351
class ThreadWithParam : public ThreadWithParamBase {
1352
1353
1354
 public:
  typedef void (*UserThreadFunc)(T);

zhanyong.wan's avatar
zhanyong.wan committed
1355
  ThreadWithParam(
1356
1357
1358
1359
      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
1360
        finished_(false) {
1361
    ThreadWithParamBase* const base = this;
zhanyong.wan's avatar
zhanyong.wan committed
1362
1363
1364
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
1365
        pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
zhanyong.wan's avatar
zhanyong.wan committed
1366
1367
  }
  ~ThreadWithParam() { Join(); }
1368
1369
1370

  void Join() {
    if (!finished_) {
zhanyong.wan's avatar
zhanyong.wan committed
1371
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
1372
1373
1374
1375
      finished_ = true;
    }
  }

1376
  virtual void Run() {
1377
1378
1379
1380
1381
    if (thread_can_start_ != NULL)
      thread_can_start_->WaitForNotification();
    func_(param_);
  }

1382
 private:
1383
1384
1385
1386
1387
1388
  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
1389
1390
1391
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1392
1393
};

1394
1395
1396
// MutexBase and Mutex implement mutex on pthreads-based platforms. They
// are used in conjunction with class MutexLock:
//
1397
1398
1399
1400
//   Mutex mutex;
//   ...
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the end
//                            // of the current scope.
1401
1402
//
// MutexBase implements behavior for both statically and dynamically
1403
1404
// allocated mutexes.  Do not use MutexBase directly.  Instead, write
// the following to define a static mutex:
1405
//
1406
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1407
//
1408
// You can forward declare a static mutex like this:
1409
//
1410
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
1411
//
1412
// To create a dynamic mutex, just define an object of type Mutex.
1413
1414
class MutexBase {
 public:
1415
1416
1417
1418
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
1419
    has_owner_ = true;
1420
1421
1422
1423
  }

  // Releases this mutex.
  void Unlock() {
1424
1425
1426
    // 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
1427
    // mutex when this is called.
1428
    has_owner_ = false;
1429
1430
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }
1431
1432
1433

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
1434
  void AssertHeld() const {
1435
    GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
1436
1437
        << "The current thread is not holding the mutex @" << this;
  }
1438

1439
1440
1441
1442
1443
  // 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.
1444
 public:
1445
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
1446
1447
1448
1449
1450
1451
1452
1453
  // 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.
1454
1455
1456
};

// Forward-declares a static mutex.
1457
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1458
1459
    extern ::testing::internal::MutexBase mutex

1460
// Defines and statically (i.e. at link time) initializes a static mutex.
1461
1462
1463
1464
1465
// 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.
1466
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1467
    ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false }
1468

1469
1470
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
1471
1472
class Mutex : public MutexBase {
 public:
1473
1474
  Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
1475
    has_owner_ = false;
1476
1477
1478
1479
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }
1480
1481
1482
1483
1484

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

1485
// We cannot name this class MutexLock as the ctor declaration would
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
// 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;

1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
// 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);
}

1520
1521
// Implements thread-local storage on pthreads-based systems.
//
1522
1523
//   // Thread 1
//   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1524
//
1525
1526
1527
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
1528
//
1529
1530
1531
1532
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
1533
//
1534
1535
// 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
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
// 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.
1549
1550
1551
template <typename T>
class ThreadLocal {
 public:
1552
1553
1554
1555
  ThreadLocal() : key_(CreateKey()),
                  default_() {}
  explicit ThreadLocal(const T& value) : key_(CreateKey()),
                                         default_(value) {}
1556
1557

  ~ThreadLocal() {
zhanyong.wan's avatar
zhanyong.wan committed
1558
1559
1560
1561
1562
    // 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.
1563
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
1564
1565
1566
1567
1568
1569
1570
1571
  }

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

 private:
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
  // 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);
  };

1584
1585
  static pthread_key_t CreateKey() {
    pthread_key_t key;
zhanyong.wan's avatar
zhanyong.wan committed
1586
1587
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
1588
1589
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
1590
1591
1592
1593
    return key;
  }

  T* GetOrCreateValue() const {
1594
1595
1596
1597
1598
    ThreadLocalValueHolderBase* const holder =
        static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
    if (holder != NULL) {
      return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
    }
1599

1600
1601
1602
1603
    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();
1604
1605
1606
1607
  }

  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
1608
  const T default_;  // The default value for each thread.
1609
1610
1611
1612

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

1613
# define GTEST_IS_THREADSAFE 1
1614
1615
1616

#else  // GTEST_HAS_PTHREAD

shiqian's avatar
shiqian committed
1617
1618
1619
1620
1621
1622
1623
1624
// 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() {}
1625
1626
  void Lock() {}
  void Unlock() {}
shiqian's avatar
shiqian committed
1627
1628
1629
  void AssertHeld() const {}
};

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

1633
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
1634

shiqian's avatar
shiqian committed
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template <typename T>
class ThreadLocal {
 public:
shiqian's avatar
shiqian committed
1645
1646
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
shiqian's avatar
shiqian committed
1647
1648
1649
1650
1651
1652
1653
1654
  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
1655
1656
// The above synchronization primitives have dummy implementations.
// Therefore Google Test is not thread-safe.
1657
# define GTEST_IS_THREADSAFE 0
shiqian's avatar
shiqian committed
1658

1659
1660
1661
1662
#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
1663
GTEST_API_ size_t GetThreadCount();
1664

1665
// Passing non-POD classes through ellipsis (...) crashes the ARM
1666
1667
1668
1669
1670
1671
// 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)
1672
1673
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
1674
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
1675
#else
1676
# define GTEST_CAN_COMPARE_NULL 1
1677
#endif
shiqian's avatar
shiqian committed
1678

1679
1680
1681
1682
// 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.
1683
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
1684
# define GTEST_NEEDS_IS_POINTER_ 1
1685
#endif
shiqian's avatar
shiqian committed
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702

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

1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
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;
};

1718
#if GTEST_OS_WINDOWS
1719
1720
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
1721
1722
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
1723
#else
1724
1725
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
1726
typedef long long BiggestInt;  // NOLINT
1727
1728
#endif  // GTEST_OS_WINDOWS

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
// 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;
}
1754
1755
1756
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast<unsigned char>(ch)) != 0;
}
1757
1758
1759
1760
inline bool IsXDigit(wchar_t ch) {
  const unsigned char low_byte = static_cast<unsigned char>(ch);
  return ch == low_byte && isxdigit(low_byte) != 0;
}
1761
1762
1763
1764
1765
1766
1767
1768

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

1769
1770
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
1771
1772
1773
1774
// 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.

1775
1776
1777
1778
namespace posix {

// Functions with a different name on Windows.

zhanyong.wan's avatar
zhanyong.wan committed
1779
#if GTEST_OS_WINDOWS
1780

1781
typedef struct _stat StatStruct;
1782

1783
# ifdef __BORLANDC__
1784
1785
1786
1787
1788
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); }
1789
1790
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
1791
inline int IsATTY(int /* fd */) { return 0; }
1792
#  else
1793
inline int IsATTY(int fd) { return _isatty(fd); }
1794
#  endif  // GTEST_OS_WINDOWS_MOBILE
1795
1796
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
1797
}
1798
inline char* StrDup(const char* src) { return _strdup(src); }
1799
# endif  // __BORLANDC__
1800

1801
# if GTEST_OS_WINDOWS_MOBILE
1802
1803
1804
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.
1805
# else
1806
1807
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
1808
1809
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
1810
1811
  return (_S_IFDIR & st.st_mode) != 0;
}
1812
# endif  // GTEST_OS_WINDOWS_MOBILE
1813

shiqian's avatar
shiqian committed
1814
#else
1815

1816
typedef struct stat StatStruct;
1817

1818
1819
1820
1821
1822
1823
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);
}
1824
inline char* StrDup(const char* src) { return strdup(src); }
1825
1826
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
1827

shiqian's avatar
shiqian committed
1828
1829
#endif  // GTEST_OS_WINDOWS

1830
1831
1832
1833
// Functions deprecated by MSVC 8.0.

#ifdef _MSC_VER
// Temporarily disable warning 4996 (deprecated function).
1834
1835
# pragma warning(push)
# pragma warning(disable:4996)
1836
1837
#endif

1838
1839
inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
1840
}
1841
1842
1843
1844
1845

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

1846
#if !GTEST_OS_WINDOWS_MOBILE
1847
inline int ChDir(const char* dir) { return chdir(dir); }
1848
#endif
1849
1850
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
1851
}
1852
#if !GTEST_OS_WINDOWS_MOBILE
1853
1854
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
1855
}
1856
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
1857
#endif
1858
inline int FClose(FILE* fp) { return fclose(fp); }
1859
#if !GTEST_OS_WINDOWS_MOBILE
1860
1861
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast<int>(read(fd, buf, count));
1862
}
1863
1864
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast<int>(write(fd, buf, count));
1865
}
1866
1867
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
1868
#endif
1869
inline const char* GetEnv(const char* name) {
1870
1871
#if GTEST_OS_WINDOWS_MOBILE
  // We are on Windows CE, which has no environment variables.
1872
  return NULL;
1873
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
1874
1875
1876
1877
  // 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;
1878
#else
1879
  return getenv(name);
1880
1881
1882
1883
#endif
}

#ifdef _MSC_VER
1884
# pragma warning(pop)  // Restores the warning state.
1885
1886
#endif

1887
#if GTEST_OS_WINDOWS_MOBILE
1888
1889
1890
// 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.
1891
void Abort();
1892
#else
1893
inline void Abort() { abort(); }
1894
#endif  // GTEST_OS_WINDOWS_MOBILE
1895
1896
1897

}  // namespace posix

1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
// 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
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
// 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
1967
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
  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.
1989
#define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1990
#define GTEST_DECLARE_int32_(name) \
1991
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1992
#define GTEST_DECLARE_string_(name) \
1993
    GTEST_API_ extern ::std::string GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1994
1995

// Macros for defining flags.
shiqian's avatar
shiqian committed
1996
#define GTEST_DEFINE_bool_(name, default_val, doc) \
1997
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1998
#define GTEST_DEFINE_int32_(name, default_val, doc) \
1999
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
2000
#define GTEST_DEFINE_string_(name, default_val, doc) \
2001
    GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
2002

2003
2004
2005
2006
// Thread annotations
#define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
#define GTEST_LOCK_EXCLUDED_(locks)

shiqian's avatar
shiqian committed
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
// 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
2018
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
shiqian's avatar
shiqian committed
2019
2020
2021
2022
2023
2024
const char* StringFromGTestEnv(const char* flag, const char* default_val);

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_