gtest-port.h 66.6 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
35
36
37
38
39
// 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.

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

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

191
192
#include <ctype.h>   // for isspace, etc
#include <stddef.h>  // for ptrdiff_t
shiqian's avatar
shiqian committed
193
194
#include <stdlib.h>
#include <stdio.h>
195
#include <string.h>
196
#ifndef _WIN32_WCE
197
198
# include <sys/types.h>
# include <sys/stat.h>
199
#endif  // !_WIN32_WCE
200

jgm's avatar
jgm committed
201
202
203
204
205
#if defined __APPLE__
# include <AvailabilityMacros.h>
# include <TargetConditionals.h>
#endif

206
#include <iostream>  // NOLINT
207
208
#include <sstream>  // NOLINT
#include <string>  // NOLINT
shiqian's avatar
shiqian committed
209

210
#define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
zhanyong.wan's avatar
zhanyong.wan committed
211
#define GTEST_FLAG_PREFIX_ "gtest_"
212
#define GTEST_FLAG_PREFIX_DASH_ "gtest-"
zhanyong.wan's avatar
zhanyong.wan committed
213
#define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
214
215
#define GTEST_NAME_ "Google Test"
#define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/"
shiqian's avatar
shiqian committed
216

shiqian's avatar
shiqian committed
217
218
219
// Determines the version of gcc that is used to compile this.
#ifdef __GNUC__
// 40302 means version 4.3.2.
220
# define GTEST_GCC_VER_ \
shiqian's avatar
shiqian committed
221
222
223
    (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
#endif  // __GNUC__

shiqian's avatar
shiqian committed
224
// Determines the platform on which Google Test is compiled.
225
#ifdef __CYGWIN__
226
# define GTEST_OS_CYGWIN 1
227
#elif defined __SYMBIAN32__
228
# define GTEST_OS_SYMBIAN 1
229
#elif defined _WIN32
230
231
232
233
234
235
236
237
# 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
238
#elif defined __APPLE__
239
# define GTEST_OS_MAC 1
jgm's avatar
jgm committed
240
241
# if TARGET_OS_IPHONE
#  define GTEST_OS_IOS 1
242
243
244
#  if TARGET_IPHONE_SIMULATOR
#   define GEST_OS_IOS_SIMULATOR 1
#  endif
jgm's avatar
jgm committed
245
# endif
shiqian's avatar
shiqian committed
246
#elif defined __linux__
247
# define GTEST_OS_LINUX 1
248
# if defined __ANDROID__
249
#  define GTEST_OS_LINUX_ANDROID 1
250
# endif
251
#elif defined __MVS__
252
# define GTEST_OS_ZOS 1
253
#elif defined(__sun) && defined(__SVR4)
254
# define GTEST_OS_SOLARIS 1
255
#elif defined(_AIX)
256
# define GTEST_OS_AIX 1
257
258
#elif defined(__hpux)
# define GTEST_OS_HPUX 1
259
#elif defined __native_client__
260
# define GTEST_OS_NACL 1
261
262
#elif defined __OpenBSD__
# define GTEST_OS_OPENBSD 1
263
264
#elif defined __QNX__
# define GTEST_OS_QNX 1
265
#endif  // __CYGWIN__
shiqian's avatar
shiqian committed
266

267
268
269
270
271
272
273
274
275
276
277
278
279
#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

280
281
282
283
284
285
286
// 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.
287
# include <unistd.h>
288
# include <strings.h>
289
#elif !GTEST_OS_WINDOWS_MOBILE
290
291
# include <direct.h>
# include <io.h>
292
293
#endif

294
295
296
297
298
#if GTEST_OS_LINUX_ANDROID
// Used to define __ANDROID_API__ matching the target NDK API level.
#  include <android/api-level.h>  // NOLINT
#endif

299
300
// Defines this to true iff Google Test can use POSIX regular expressions.
#ifndef GTEST_HAS_POSIX_RE
301
302
303
304
305
306
# 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
307
308
309
#endif

#if GTEST_HAS_POSIX_RE
310
311
312
313
314

// 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>.
315
# include <regex.h>  // NOLINT
316

317
# define GTEST_USES_POSIX_RE 1
318

319
320
321
322
#elif GTEST_OS_WINDOWS

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

325
326
#else

327
328
// <regex.h> may not be available on this platform.  Use our own
// simple regex implementation instead.
329
# define GTEST_USES_SIMPLE_RE 1
330

331
#endif  // GTEST_HAS_POSIX_RE
332

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

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

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

379
# define GTEST_HAS_GLOBAL_STRING 0
shiqian's avatar
shiqian committed
380
381
382
383
384
385
386
387
388

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

389
// Cygwin 1.7 and below doesn't support ::std::wstring.
390
391
392
393
// 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
394
395
396
397
398
399

#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.
400
# define GTEST_HAS_GLOBAL_WSTRING \
401
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
shiqian's avatar
shiqian committed
402
403
#endif  // GTEST_HAS_GLOBAL_WSTRING

shiqian's avatar
shiqian committed
404
405
406
407
408
// 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.

409
# ifdef _MSC_VER
shiqian's avatar
shiqian committed
410

411
412
413
414
415
#  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
416
417

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

420
#  ifdef __GXX_RTTI
421
422
423
424
425
426
427
428
429
430
// 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
431
432
433
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI
shiqian's avatar
shiqian committed
434

435
436
437
438
439
440
441
// 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)

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

446
447
448
449
450
#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
451

452
# else
shiqian's avatar
shiqian committed
453

454
// For all other compilers, we assume RTTI is enabled.
455
#  define GTEST_HAS_RTTI 1
shiqian's avatar
shiqian committed
456

457
# endif  // _MSC_VER
shiqian's avatar
shiqian committed
458
459
460

#endif  // GTEST_HAS_RTTI

461
462
463
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
#if GTEST_HAS_RTTI
464
# include <typeinfo>
465
466
#endif

467
// Determines whether Google Test can use the pthreads library.
shiqian's avatar
shiqian committed
468
#ifndef GTEST_HAS_PTHREAD
469
470
471
472
473
// 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.
474
475
# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \
    || GTEST_OS_QNX)
shiqian's avatar
shiqian committed
476
477
#endif  // GTEST_HAS_PTHREAD

478
479
480
#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
481
# include <pthread.h>  // NOLINT
482
483

// For timespec and nanosleep, used below.
484
# include <time.h>  // NOLINT
485
486
#endif

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

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

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

// C++11 specifies that <tuple> provides std::tuple. Users can't use
// gtest in C++11 mode until their standard library is at least that
// compliant.
# if GTEST_LANG_CXX11
#  define GTEST_ENV_HAS_STD_TUPLE_ 1
# endif

# if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
528
529
530
531
#  define GTEST_USE_OWN_TR1_TUPLE 0
# else
#  define GTEST_USE_OWN_TR1_TUPLE 1
# endif
532
533

#endif  // GTEST_USE_OWN_TR1_TUPLE
534

535
536
537
538
// 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
539

540
541
# if GTEST_USE_OWN_TR1_TUPLE
#  include "gtest/internal/gtest-tuple.h"
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
# 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;
}
}

558
# elif GTEST_OS_SYMBIAN
zhanyong.wan's avatar
zhanyong.wan committed
559
560
561
562
563
564

// 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.
565
566
567
#  ifdef BOOST_HAS_TR1_TUPLE
#   undef BOOST_HAS_TR1_TUPLE
#  endif  // BOOST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
568
569
570

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

574
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
575
576
// 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>.
577

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

592
# else
593
// If the compiler is not GCC 4.0+, we assume the user is using a
594
// spec-conforming TR1 implementation.
595
596
#  include <tuple>  // NOLINT
# endif  // GTEST_USE_OWN_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
597

598
599
#endif  // GTEST_HAS_TR1_TUPLE

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

607
# if GTEST_OS_LINUX && !defined(__ia64__)
608
609
610
611
612
613
614
615
616
617
#  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
618
619
620
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)
621
622
623

#endif  // GTEST_HAS_CLONE

624
625
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
626
627
628
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
629
630
631
632
633
# 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
634
#endif  // GTEST_HAS_STREAM_REDIRECTION
635

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

649
650
651
// 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
652
#define GTEST_HAS_PARAM_TEST 1
653

654
655
// Determines whether to support type-driven tests.

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

664
// Determines whether to support Combine(). This only makes sense when
665
666
667
668
// 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)
669
# define GTEST_HAS_COMBINE 1
670
#endif
671

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

676
677
// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
678
# define GTEST_CAN_STREAM_RESULTS_ 1
679
680
#endif

shiqian's avatar
shiqian committed
681
682
683
684
685
686
687
688
689
690
691
// 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
692
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
shiqian's avatar
shiqian committed
693
#else
694
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
shiqian's avatar
shiqian committed
695
696
#endif

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

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

// 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
729
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
shiqian's avatar
shiqian committed
730
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
731
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
shiqian's avatar
shiqian committed
732
#else
733
# define GTEST_MUST_USE_RESULT_
shiqian's avatar
shiqian committed
734
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
shiqian's avatar
shiqian committed
735

736
737
738
739
740
741
// 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.

742
# if defined(_MSC_VER) || defined(__BORLANDC__)
743
// These two compilers are known to support SEH.
744
745
#  define GTEST_HAS_SEH 1
# else
746
// Assume no SEH.
747
748
#  define GTEST_HAS_SEH 0
# endif
749
750
751

#endif  // GTEST_HAS_SEH

752
753
#ifdef _MSC_VER

754
755
756
757
758
# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif
759
760
761
762

#endif  // _MSC_VER

#ifndef GTEST_API_
763
# define GTEST_API_
764
765
#endif

766
#ifdef __GNUC__
767
// Ask the compiler to never inline a given function.
768
# define GTEST_NO_INLINE_ __attribute__((noinline))
769
#else
770
771
# define GTEST_NO_INLINE_
#endif
772

773
774
775
776
777
778
779
// _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

shiqian's avatar
shiqian committed
780
781
782
783
784
785
namespace testing {

class Message;

namespace internal {

786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
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
// 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:
//
//   GTEST_COMPILE_ASSERT_(ARRAYSIZE(content_type_names) == CONTENT_NUM_TYPES,
//                         content_type_names_incorrect_size);
//
// 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) \
  typedef ::testing::internal::CompileAssert<(bool(expr))> \
      msg[bool(expr) ? 1 : -1]

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

#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

871
872
// A helper for suppressing warnings on constant condition.  It just
// returns 'condition'.
873
GTEST_API_ bool IsTrue(bool condition);
874

shiqian's avatar
shiqian committed
875
876
877
878
879
880
881
// 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:
882
883
  typedef T element_type;

shiqian's avatar
shiqian committed
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
  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_) {
899
      if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
shiqian's avatar
shiqian committed
900
901
902
903
904
        delete ptr_;
      }
      ptr_ = p;
    }
  }
905

shiqian's avatar
shiqian committed
906
907
908
 private:
  T* ptr_;

shiqian's avatar
shiqian committed
909
  GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
shiqian's avatar
shiqian committed
910
911
};

912
// Defines RE.
shiqian's avatar
shiqian committed
913

914
// A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
shiqian's avatar
shiqian committed
915
// Regular Expression syntax.
916
class GTEST_API_ RE {
shiqian's avatar
shiqian committed
917
 public:
918
919
920
921
  // 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
922
923
924
925
  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

#if GTEST_HAS_GLOBAL_STRING
926

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

shiqian's avatar
shiqian committed
929
930
931
932
933
934
935
936
#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_; }

937
938
939
940
941
942
943
944
945
946
  // 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
947
948
949
950
951
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#if GTEST_HAS_GLOBAL_STRING
952

953
954
955
  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
956
957
958
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }
959

shiqian's avatar
shiqian committed
960
961
#endif  // GTEST_HAS_GLOBAL_STRING

962
  static bool FullMatch(const char* str, const RE& re);
shiqian's avatar
shiqian committed
963
964
965
966
967
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

968
969
970
  // 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
971
  const char* pattern_;
972
  bool is_valid_;
973

974
#if GTEST_USES_POSIX_RE
975

976
977
  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().
978

979
#else  // GTEST_USES_SIMPLE_RE
980

981
  const char* full_pattern_;  // For FullMatch();
982

983
#endif
shiqian's avatar
shiqian committed
984

985
  GTEST_DISALLOW_ASSIGN_(RE);
986
};
shiqian's avatar
shiqian committed
987

988
989
990
991
992
993
994
995
996
997
// 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
998
// Defines logging utilities:
999
1000
//   GTEST_LOG_(severity) - logs messages at the specified severity level. The
//                          message itself is streamed into the macro.
shiqian's avatar
shiqian committed
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.

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

1011
1012
1013
// 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.
1014
class GTEST_API_ GTestLog {
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
 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
1028

1029
1030
1031
#define GTEST_LOG_(severity) \
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()
shiqian's avatar
shiqian committed
1032
1033
1034
1035

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

1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
// 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. "

1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
// 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

1067
1068
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
1069
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
1070
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
1071
1072
// const Foo*).  When you use ImplicitCast_, the compiler checks that
// the cast is safe.  Such explicit ImplicitCast_s are necessary in
1073
1074
1075
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
1076
// The syntax for using ImplicitCast_ is the same as for static_cast:
1077
//
1078
//   ImplicitCast_<ToType>(expr)
1079
//
1080
// ImplicitCast_ would have been part of the C++ standard library,
1081
1082
// but the proposal was submitted too late.  It will probably make
// its way into the language in the future.
1083
1084
1085
1086
//
// 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.
1087
template<typename To>
1088
inline To ImplicitCast_(To x) { return x; }
1089
1090

// When you upcast (that is, cast a pointer from type Foo to type
1091
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
// 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.
1107
1108
1109
1110
1111
1112
//
// 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
1113
1114
1115
1116
1117
1118
  // 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;
1119
    ::testing::internal::ImplicitCast_<From*>(to);
1120
1121
1122
1123
1124
1125
1126
1127
1128
  }

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

1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
// 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.
1141
#endif
1142
1143
}

1144
#if GTEST_HAS_STREAM_REDIRECTION
1145

shiqian's avatar
shiqian committed
1146
// Defines the stderr capturer:
1147
1148
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
shiqian's avatar
shiqian committed
1149
1150
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
1151
//
zhanyong.wan's avatar
zhanyong.wan committed
1152
GTEST_API_ void CaptureStdout();
1153
GTEST_API_ std::string GetCapturedStdout();
zhanyong.wan's avatar
zhanyong.wan committed
1154
GTEST_API_ void CaptureStderr();
1155
GTEST_API_ std::string GetCapturedStderr();
1156

1157
#endif  // GTEST_HAS_STREAM_REDIRECTION
1158
1159


zhanyong.wan's avatar
zhanyong.wan committed
1160
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
1161

1162
1163
1164
const ::std::vector<testing::internal::string>& GetInjectableArgvs();
void SetInjectableArgvs(const ::std::vector<testing::internal::string>*
                             new_argvs);
shiqian's avatar
shiqian committed
1165

1166
1167
// A copy of all command line arguments.  Set by InitGoogleTest().
extern ::std::vector<testing::internal::string> g_argvs;
shiqian's avatar
shiqian committed
1168
1169
1170
1171
1172

#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.

1173
1174
#if GTEST_HAS_PTHREAD

1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
// 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
1194
1195
1196
1197
1198
1199
  Notification() : notified_(false) {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
  }
  ~Notification() {
    pthread_mutex_destroy(&mutex_);
  }
1200
1201
1202

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
jgm's avatar
jgm committed
1203
1204
1205
1206
1207
  void Notify() {
    pthread_mutex_lock(&mutex_);
    notified_ = true;
    pthread_mutex_unlock(&mutex_);
  }
1208
1209
1210
1211

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
jgm's avatar
jgm committed
1212
1213
1214
1215
1216
1217
    for (;;) {
      pthread_mutex_lock(&mutex_);
      const bool notified = notified_;
      pthread_mutex_unlock(&mutex_);
      if (notified)
        break;
1218
1219
1220
1221
1222
      SleepMilliseconds(10);
    }
  }

 private:
jgm's avatar
jgm committed
1223
1224
  pthread_mutex_t mutex_;
  bool notified_;
1225
1226
1227
1228

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
// 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;
}

1251
// Helper class for testing Google Test's multi-threading constructs.
zhanyong.wan's avatar
zhanyong.wan committed
1252
// To use it, write:
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
//
//   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>
1264
class ThreadWithParam : public ThreadWithParamBase {
1265
1266
1267
 public:
  typedef void (*UserThreadFunc)(T);

zhanyong.wan's avatar
zhanyong.wan committed
1268
  ThreadWithParam(
1269
1270
1271
1272
      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
1273
        finished_(false) {
1274
    ThreadWithParamBase* const base = this;
zhanyong.wan's avatar
zhanyong.wan committed
1275
1276
1277
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
1278
        pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
zhanyong.wan's avatar
zhanyong.wan committed
1279
1280
  }
  ~ThreadWithParam() { Join(); }
1281
1282
1283

  void Join() {
    if (!finished_) {
zhanyong.wan's avatar
zhanyong.wan committed
1284
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
1285
1286
1287
1288
      finished_ = true;
    }
  }

1289
  virtual void Run() {
1290
1291
1292
1293
1294
    if (thread_can_start_ != NULL)
      thread_can_start_->WaitForNotification();
    func_(param_);
  }

1295
 private:
1296
1297
1298
1299
1300
1301
  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
1302
1303
1304
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1305
1306
};

1307
1308
1309
// MutexBase and Mutex implement mutex on pthreads-based platforms. They
// are used in conjunction with class MutexLock:
//
1310
1311
1312
1313
//   Mutex mutex;
//   ...
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the end
//                            // of the current scope.
1314
1315
//
// MutexBase implements behavior for both statically and dynamically
1316
1317
// allocated mutexes.  Do not use MutexBase directly.  Instead, write
// the following to define a static mutex:
1318
//
1319
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1320
//
1321
// You can forward declare a static mutex like this:
1322
//
1323
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
1324
//
1325
// To create a dynamic mutex, just define an object of type Mutex.
1326
1327
class MutexBase {
 public:
1328
1329
1330
1331
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
1332
    has_owner_ = true;
1333
1334
1335
1336
  }

  // Releases this mutex.
  void Unlock() {
1337
1338
1339
    // 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
1340
    // mutex when this is called.
1341
    has_owner_ = false;
1342
1343
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }
1344
1345
1346

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
1347
  void AssertHeld() const {
1348
    GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
1349
1350
        << "The current thread is not holding the mutex @" << this;
  }
1351

1352
1353
1354
1355
1356
  // 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.
1357
 public:
1358
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
1359
1360
1361
1362
1363
1364
1365
1366
  // 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.
1367
1368
1369
};

// Forward-declares a static mutex.
1370
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1371
1372
    extern ::testing::internal::MutexBase mutex

1373
// Defines and statically (i.e. at link time) initializes a static mutex.
1374
1375
1376
1377
1378
// 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.
1379
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1380
    ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false }
1381

1382
1383
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
1384
1385
class Mutex : public MutexBase {
 public:
1386
1387
  Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
1388
    has_owner_ = false;
1389
1390
1391
1392
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }
1393
1394
1395
1396
1397

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

1398
// We cannot name this class MutexLock as the ctor declaration would
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
// 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;

1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
// 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);
}

1433
1434
// Implements thread-local storage on pthreads-based systems.
//
1435
1436
//   // Thread 1
//   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1437
//
1438
1439
1440
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
1441
//
1442
1443
1444
1445
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
1446
//
1447
1448
// 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
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
// 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.
1462
1463
1464
template <typename T>
class ThreadLocal {
 public:
1465
1466
1467
1468
  ThreadLocal() : key_(CreateKey()),
                  default_() {}
  explicit ThreadLocal(const T& value) : key_(CreateKey()),
                                         default_(value) {}
1469
1470

  ~ThreadLocal() {
zhanyong.wan's avatar
zhanyong.wan committed
1471
1472
1473
1474
1475
    // 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.
1476
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
1477
1478
1479
1480
1481
1482
1483
1484
  }

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

 private:
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
  // 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);
  };

1497
1498
  static pthread_key_t CreateKey() {
    pthread_key_t key;
zhanyong.wan's avatar
zhanyong.wan committed
1499
1500
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
1501
1502
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
1503
1504
1505
1506
    return key;
  }

  T* GetOrCreateValue() const {
1507
1508
1509
1510
1511
    ThreadLocalValueHolderBase* const holder =
        static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
    if (holder != NULL) {
      return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
    }
1512

1513
1514
1515
1516
    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();
1517
1518
1519
1520
  }

  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
1521
  const T default_;  // The default value for each thread.
1522
1523
1524
1525

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

1526
# define GTEST_IS_THREADSAFE 1
1527
1528
1529

#else  // GTEST_HAS_PTHREAD

shiqian's avatar
shiqian committed
1530
1531
1532
1533
1534
1535
1536
1537
// 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() {}
1538
1539
  void Lock() {}
  void Unlock() {}
shiqian's avatar
shiqian committed
1540
1541
1542
  void AssertHeld() const {}
};

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

1546
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
1547

shiqian's avatar
shiqian committed
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template <typename T>
class ThreadLocal {
 public:
shiqian's avatar
shiqian committed
1558
1559
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
shiqian's avatar
shiqian committed
1560
1561
1562
1563
1564
1565
1566
1567
  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
1568
1569
// The above synchronization primitives have dummy implementations.
// Therefore Google Test is not thread-safe.
1570
# define GTEST_IS_THREADSAFE 0
shiqian's avatar
shiqian committed
1571

1572
1573
1574
1575
#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
1576
GTEST_API_ size_t GetThreadCount();
1577

1578
// Passing non-POD classes through ellipsis (...) crashes the ARM
1579
1580
1581
1582
1583
1584
// 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)
1585
1586
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
1587
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
1588
#else
1589
# define GTEST_CAN_COMPARE_NULL 1
1590
#endif
shiqian's avatar
shiqian committed
1591

1592
1593
1594
1595
// 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.
1596
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
1597
# define GTEST_NEEDS_IS_POINTER_ 1
1598
#endif
shiqian's avatar
shiqian committed
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615

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

1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
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;
};

1631
#if GTEST_OS_WINDOWS
1632
1633
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
1634
1635
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
1636
#else
1637
1638
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
1639
typedef long long BiggestInt;  // NOLINT
1640
1641
#endif  // GTEST_OS_WINDOWS

1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
// 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;
}
1667
1668
1669
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast<unsigned char>(ch)) != 0;
}
1670
1671
1672
1673
inline bool IsXDigit(wchar_t ch) {
  const unsigned char low_byte = static_cast<unsigned char>(ch);
  return ch == low_byte && isxdigit(low_byte) != 0;
}
1674
1675
1676
1677
1678
1679
1680
1681

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

1682
1683
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
1684
1685
1686
1687
// 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.

1688
1689
1690
1691
namespace posix {

// Functions with a different name on Windows.

zhanyong.wan's avatar
zhanyong.wan committed
1692
#if GTEST_OS_WINDOWS
1693

1694
typedef struct _stat StatStruct;
1695

1696
# ifdef __BORLANDC__
1697
1698
1699
1700
1701
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); }
1702
1703
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
1704
inline int IsATTY(int /* fd */) { return 0; }
1705
#  else
1706
inline int IsATTY(int fd) { return _isatty(fd); }
1707
#  endif  // GTEST_OS_WINDOWS_MOBILE
1708
1709
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
1710
}
1711
inline char* StrDup(const char* src) { return _strdup(src); }
1712
# endif  // __BORLANDC__
1713

1714
# if GTEST_OS_WINDOWS_MOBILE
1715
1716
1717
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.
1718
# else
1719
1720
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
1721
1722
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
1723
1724
  return (_S_IFDIR & st.st_mode) != 0;
}
1725
# endif  // GTEST_OS_WINDOWS_MOBILE
1726

shiqian's avatar
shiqian committed
1727
#else
1728

1729
typedef struct stat StatStruct;
1730

1731
1732
1733
1734
1735
1736
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);
}
1737
inline char* StrDup(const char* src) { return strdup(src); }
1738
1739
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
1740

shiqian's avatar
shiqian committed
1741
1742
#endif  // GTEST_OS_WINDOWS

1743
1744
1745
1746
// Functions deprecated by MSVC 8.0.

#ifdef _MSC_VER
// Temporarily disable warning 4996 (deprecated function).
1747
1748
# pragma warning(push)
# pragma warning(disable:4996)
1749
1750
#endif

1751
1752
inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
1753
}
1754
1755
1756
1757
1758

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

1759
#if !GTEST_OS_WINDOWS_MOBILE
1760
inline int ChDir(const char* dir) { return chdir(dir); }
1761
#endif
1762
1763
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
1764
}
1765
#if !GTEST_OS_WINDOWS_MOBILE
1766
1767
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
1768
}
1769
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
1770
#endif
1771
inline int FClose(FILE* fp) { return fclose(fp); }
1772
#if !GTEST_OS_WINDOWS_MOBILE
1773
1774
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast<int>(read(fd, buf, count));
1775
}
1776
1777
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast<int>(write(fd, buf, count));
1778
}
1779
1780
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
1781
#endif
1782
inline const char* GetEnv(const char* name) {
1783
1784
#if GTEST_OS_WINDOWS_MOBILE
  // We are on Windows CE, which has no environment variables.
1785
  return NULL;
1786
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
1787
1788
1789
1790
  // 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;
1791
#else
1792
  return getenv(name);
1793
1794
1795
1796
#endif
}

#ifdef _MSC_VER
1797
# pragma warning(pop)  // Restores the warning state.
1798
1799
#endif

1800
#if GTEST_OS_WINDOWS_MOBILE
1801
1802
1803
// 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.
1804
void Abort();
1805
#else
1806
inline void Abort() { abort(); }
1807
#endif  // GTEST_OS_WINDOWS_MOBILE
1808
1809
1810

}  // namespace posix

1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
// 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
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
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
// 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
1880
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
  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.
1902
#define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1903
#define GTEST_DECLARE_int32_(name) \
1904
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1905
#define GTEST_DECLARE_string_(name) \
1906
    GTEST_API_ extern ::std::string GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1907
1908

// Macros for defining flags.
shiqian's avatar
shiqian committed
1909
#define GTEST_DEFINE_bool_(name, default_val, doc) \
1910
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1911
#define GTEST_DEFINE_int32_(name, default_val, doc) \
1912
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1913
#define GTEST_DEFINE_string_(name, default_val, doc) \
1914
    GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1915

1916
1917
1918
1919
// Thread annotations
#define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
#define GTEST_LOCK_EXCLUDED_(locks)

shiqian's avatar
shiqian committed
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
// 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
1931
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
shiqian's avatar
shiqian committed
1932
1933
1934
1935
1936
1937
const char* StringFromGTestEnv(const char* flag, const char* default_val);

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_