gtest-port.h 80.7 KB
Newer Older
shiqian's avatar
shiqian committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
// 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.
//
// Low-level types and utilities for porting Google Test to various
31
32
33
34
35
// 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.
36
37
38
39
//
// 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
40

Gennadiy Civil's avatar
 
Gennadiy Civil committed
41
42
// GOOGLETEST_CM0001 DO NOT DELETE

shiqian's avatar
shiqian committed
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
//   GTEST_HAS_GLOBAL_STRING  - Define it to 1/0 to indicate that ::string
Gennadiy Civil's avatar
merges  
Gennadiy Civil committed
76
77
78
//                              is/isn't available
//   GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::wstring
//                              is/isn't available
79
80
//   GTEST_HAS_POSIX_RE       - Define it to 1/0 to indicate that POSIX regular
//                              expressions are/aren't available.
shiqian's avatar
shiqian committed
81
82
//   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that <pthread.h>
//                              is/isn't available.
83
84
85
86
87
//   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).
88
89
90
//   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
//                              compiler supports Microsoft's "Structured
//                              Exception Handling".
91
92
93
94
//   GTEST_HAS_STREAM_REDIRECTION
//                            - Define it to 1/0 to indicate whether the
//                              platform supports I/O stream redirection using
//                              dup() and dup2().
95
96
97
98
99
100
101
//   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.
102
103
104
105
106
107
//   GTEST_DEFAULT_DEATH_TEST_STYLE
//                            - The default value of --gtest_death_test_style.
//                              The legacy default has been "fast" in the open
//                              source version since 2008. The recommended value
//                              is "threadsafe", and can be set in
//                              custom/gtest-port.h.
shiqian's avatar
shiqian committed
108

109
110
111
112
113
114
115
116
// 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
117
//
118
//   GTEST_OS_AIX      - IBM AIX
zhanyong.wan's avatar
zhanyong.wan committed
119
//   GTEST_OS_CYGWIN   - Cygwin
kosak's avatar
kosak committed
120
//   GTEST_OS_FREEBSD  - FreeBSD
121
//   GTEST_OS_FUCHSIA  - Fuchsia
122
//   GTEST_OS_HPUX     - HP-UX
zhanyong.wan's avatar
zhanyong.wan committed
123
//   GTEST_OS_LINUX    - Linux
124
//     GTEST_OS_LINUX_ANDROID - Google Android
zhanyong.wan's avatar
zhanyong.wan committed
125
//   GTEST_OS_MAC      - Mac OS X
jgm's avatar
jgm committed
126
//     GTEST_OS_IOS    - iOS
127
//   GTEST_OS_NACL     - Google Native Client (NaCl)
Kamil Rytarowski's avatar
Kamil Rytarowski committed
128
//   GTEST_OS_NETBSD   - NetBSD
129
//   GTEST_OS_OPENBSD  - OpenBSD
130
//   GTEST_OS_OS2      - OS/2
131
//   GTEST_OS_QNX      - QNX
zhanyong.wan's avatar
zhanyong.wan committed
132
133
//   GTEST_OS_SOLARIS  - Sun Solaris
//   GTEST_OS_SYMBIAN  - Symbian
134
135
136
//   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
//     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
//     GTEST_OS_WINDOWS_MINGW    - MinGW
137
//     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
billydonahue's avatar
billydonahue committed
138
139
//     GTEST_OS_WINDOWS_PHONE    - Windows Phone
//     GTEST_OS_WINDOWS_RT       - Windows Store App/WinRT
zhanyong.wan's avatar
zhanyong.wan committed
140
//   GTEST_OS_ZOS      - z/OS
141
//
142
143
144
145
146
147
148
// 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!).
//
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
// 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
167
//
zhanyong.wan's avatar
zhanyong.wan committed
168
169
170
//   GTEST_HAS_DEATH_TEST   - death tests
//   GTEST_HAS_TYPED_TEST   - typed tests
//   GTEST_HAS_TYPED_TEST_P - type-parameterized tests
171
//   GTEST_IS_THREADSAFE    - Google Test is thread-safe.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
172
//   GOOGLETEST_CM0007 DO NOT DELETE
173
174
175
//   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
176
//   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
Gennadiy Civil's avatar
 
Gennadiy Civil committed
177
//                            the above RE\b(s) are mutually exclusive.
178
//   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
179
180
181
182
183
184
185
186
187
188
189
190

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

250
251
#include <ctype.h>   // for isspace, etc
#include <stddef.h>  // for ptrdiff_t
shiqian's avatar
shiqian committed
252
#include <stdio.h>
misterg's avatar
misterg committed
253
#include <stdlib.h>
254
#include <string.h>
misterg's avatar
misterg committed
255
256
#include <memory>

257
#ifndef _WIN32_WCE
258
259
# include <sys/types.h>
# include <sys/stat.h>
260
#endif  // !_WIN32_WCE
261

jgm's avatar
jgm committed
262
263
264
265
266
#if defined __APPLE__
# include <AvailabilityMacros.h>
# include <TargetConditionals.h>
#endif

Gennadiy Civil's avatar
merges  
Gennadiy Civil committed
267
268
// Brings in the definition of HAS_GLOBAL_STRING.  This must be done
// BEFORE we test HAS_GLOBAL_STRING.
Abseil Team's avatar
Abseil Team committed
269
#include <string>     // NOLINT
billydonahue's avatar
billydonahue committed
270
#include <algorithm>  // NOLINT
Abseil Team's avatar
Abseil Team committed
271
272
273
#include <iostream>   // NOLINT
#include <sstream>    // NOLINT
#include <tuple>
274
#include <utility>
275
#include <vector>  // NOLINT
shiqian's avatar
shiqian committed
276

277
278
279
280
281
282
283
284
285
#include "gtest/internal/gtest-port-arch.h"
#include "gtest/internal/custom/gtest-port.h"

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

289
290
291
292
#if !defined(GTEST_INIT_GOOGLE_TEST_NAME_)
# define GTEST_INIT_GOOGLE_TEST_NAME_ "testing::InitGoogleTest"
#endif  // !defined(GTEST_INIT_GOOGLE_TEST_NAME_)

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

billydonahue's avatar
billydonahue committed
300
301
302
303
304
// Macros for disabling Microsoft Visual C++ warnings.
//
//   GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 4385)
//   /* code that triggers warnings C4800 and C4385 */
//   GTEST_DISABLE_MSC_WARNINGS_POP_()
305
#if defined(_MSC_VER)
billydonahue's avatar
billydonahue committed
306
307
308
309
310
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings) \
    __pragma(warning(push))                        \
    __pragma(warning(disable: warnings))
# define GTEST_DISABLE_MSC_WARNINGS_POP_()          \
    __pragma(warning(pop))
311
312
313
314
#else
// Not all compilers are MSVC
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings)
# define GTEST_DISABLE_MSC_WARNINGS_POP_()
billydonahue's avatar
billydonahue committed
315
316
#endif

317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
// Clang on Windows does not understand MSVC's pragma warning.
// We need clang-specific way to disable function deprecation warning.
#ifdef __clang__
# define GTEST_DISABLE_MSC_DEPRECATED_PUSH_()                         \
    _Pragma("clang diagnostic push")                                  \
    _Pragma("clang diagnostic ignored \"-Wdeprecated-declarations\"") \
    _Pragma("clang diagnostic ignored \"-Wdeprecated-implementations\"")
#define GTEST_DISABLE_MSC_DEPRECATED_POP_() \
    _Pragma("clang diagnostic pop")
#else
# define GTEST_DISABLE_MSC_DEPRECATED_PUSH_() \
    GTEST_DISABLE_MSC_WARNINGS_PUSH_(4996)
# define GTEST_DISABLE_MSC_DEPRECATED_POP_() \
    GTEST_DISABLE_MSC_WARNINGS_POP_()
#endif

333
334
335
// 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.
336
337
338
339
340
341
#if GTEST_OS_WINDOWS
# if !GTEST_OS_WINDOWS_MOBILE
#  include <direct.h>
#  include <io.h>
# endif
// In order to avoid having to include <windows.h>, use forward declaration
Arkadiy Shapkin's avatar
Arkadiy Shapkin committed
342
#if GTEST_OS_WINDOWS_MINGW && !defined(__MINGW64_VERSION_MAJOR)
343
344
345
346
347
// MinGW defined _CRITICAL_SECTION and _RTL_CRITICAL_SECTION as two
// separate (equivalent) structs, instead of using typedef
typedef struct _CRITICAL_SECTION GTEST_CRITICAL_SECTION;
#else
// Assume CRITICAL_SECTION is a typedef of _RTL_CRITICAL_SECTION.
348
349
// This assumption is verified by
// WindowsTypesTest.CRITICAL_SECTIONIs_RTL_CRITICAL_SECTION.
350
351
typedef struct _RTL_CRITICAL_SECTION GTEST_CRITICAL_SECTION;
#endif
352
#else
353
354
355
// 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.
356
# include <unistd.h>
357
# include <strings.h>
358
#endif  // GTEST_OS_WINDOWS
359

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

375
376
377
378
#if GTEST_USES_PCRE
// The appropriate headers have already been included.

#elif GTEST_HAS_POSIX_RE
379
380
381
382
383

// 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>.
384
# include <regex.h>  // NOLINT
385

386
# define GTEST_USES_POSIX_RE 1
387

388
389
390
391
#elif GTEST_OS_WINDOWS

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

394
395
#else

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

400
#endif  // GTEST_USES_PCRE
401

402
403
404
#ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
405
406
407
408
409
# if defined(_MSC_VER) && defined(_CPPUNWIND)
// MSVC defines _CPPUNWIND to 1 iff exceptions are enabled.
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__BORLANDC__)
// C++Builder's implementation of the STL uses the _HAS_EXCEPTIONS
410
// macro to enable exceptions, so we'll do the same.
shiqian's avatar
shiqian committed
411
// Assumes that exceptions are enabled by default.
412
413
414
415
#  ifndef _HAS_EXCEPTIONS
#   define _HAS_EXCEPTIONS 1
#  endif  // _HAS_EXCEPTIONS
#  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
416
# elif defined(__clang__)
417
418
419
420
421
422
423
// clang defines __EXCEPTIONS iff exceptions are enabled before clang 220714,
// but iff cleanups are enabled after that. In Obj-C++ files, there can be
// cleanups for ObjC exceptions which also need cleanups, even if C++ exceptions
// are disabled. clang has __has_feature(cxx_exceptions) which checks for C++
// exceptions starting at clang r206352, but which checked for cleanups prior to
// that. To reliably check for C++ exception availability with clang, check for
// __EXCEPTIONS && __has_feature(cxx_exceptions).
kosak's avatar
kosak committed
424
#  define GTEST_HAS_EXCEPTIONS (__EXCEPTIONS && __has_feature(cxx_exceptions))
425
# elif defined(__GNUC__) && __EXCEPTIONS
426
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
427
428
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
429
430
431
// 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.
432
433
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
434
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
435
#  define GTEST_HAS_EXCEPTIONS 1
436
437
438
439
# 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
440
# else
441
442
// For other compilers, we assume exceptions are disabled to be
// conservative.
443
444
#  define GTEST_HAS_EXCEPTIONS 0
# endif  // defined(_MSC_VER) || defined(__BORLANDC__)
445
#endif  // GTEST_HAS_EXCEPTIONS
shiqian's avatar
shiqian committed
446

447
448
449
#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.
450
# define GTEST_HAS_STD_STRING 1
451
452
#elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
453
# error "::std::string isn't available."
454
#endif  // !defined(GTEST_HAS_STD_STRING)
shiqian's avatar
shiqian committed
455
456

#ifndef GTEST_HAS_GLOBAL_STRING
457
# define GTEST_HAS_GLOBAL_STRING 0
shiqian's avatar
shiqian committed
458
459
460
461
462
#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.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
463
// FIXME: uses autoconf to detect whether ::std::wstring
shiqian's avatar
shiqian committed
464
465
//   is available.

466
// Cygwin 1.7 and below doesn't support ::std::wstring.
467
468
469
470
// 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
471
472
473
474
475
476

#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.
477
# define GTEST_HAS_GLOBAL_WSTRING \
478
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
shiqian's avatar
shiqian committed
479
480
#endif  // GTEST_HAS_GLOBAL_WSTRING

shiqian's avatar
shiqian committed
481
482
483
484
485
// 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.

486
# ifdef _MSC_VER
shiqian's avatar
shiqian committed
487

488
489
490
491
492
#  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
493
494

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

497
#  ifdef __GXX_RTTI
498
499
500
501
502
503
504
505
506
507
// 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
508
509
510
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI
shiqian's avatar
shiqian committed
511

512
513
514
515
516
517
518
// 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)

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

523
524
525
526
527
#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
528

529
# else
shiqian's avatar
shiqian committed
530

531
// For all other compilers, we assume RTTI is enabled.
532
#  define GTEST_HAS_RTTI 1
shiqian's avatar
shiqian committed
533

534
# endif  // _MSC_VER
shiqian's avatar
shiqian committed
535
536
537

#endif  // GTEST_HAS_RTTI

538
539
540
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
#if GTEST_HAS_RTTI
541
# include <typeinfo>
542
543
#endif

544
// Determines whether Google Test can use the pthreads library.
shiqian's avatar
shiqian committed
545
#ifndef GTEST_HAS_PTHREAD
546
547
// The user didn't tell us explicitly, so we make reasonable assumptions about
// which platforms have pthreads support.
548
549
550
//
// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
// to your compiler flags.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
551
552
#define GTEST_HAS_PTHREAD                                             \
  (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX || GTEST_OS_QNX || \
553
   GTEST_OS_FREEBSD || GTEST_OS_NACL || GTEST_OS_NETBSD || GTEST_OS_FUCHSIA)
shiqian's avatar
shiqian committed
554
555
#endif  // GTEST_HAS_PTHREAD

556
557
558
#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
559
# include <pthread.h>  // NOLINT
560
561

// For timespec and nanosleep, used below.
562
# include <time.h>  // NOLINT
563
564
#endif

565
566
567
568
569
570
571
// 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.

572
# if GTEST_OS_LINUX && !defined(__ia64__)
573
#  if GTEST_OS_LINUX_ANDROID
574
575
576
577
578
579
// On Android, clone() became available at different API levels for each 32-bit
// architecture.
#    if defined(__LP64__) || \
        (defined(__arm__) && __ANDROID_API__ >= 9) || \
        (defined(__mips__) && __ANDROID_API__ >= 12) || \
        (defined(__i386__) && __ANDROID_API__ >= 17)
580
581
582
583
584
585
586
#     define GTEST_HAS_CLONE 1
#    else
#     define GTEST_HAS_CLONE 0
#    endif
#  else
#   define GTEST_HAS_CLONE 1
#  endif
587
588
589
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)
590
591
592

#endif  // GTEST_HAS_CLONE

593
594
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
595
596
597
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
billydonahue's avatar
billydonahue committed
598
599
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || \
    GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
600
601
602
603
#  define GTEST_HAS_STREAM_REDIRECTION 0
# else
#  define GTEST_HAS_STREAM_REDIRECTION 1
# endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
604
#endif  // GTEST_HAS_STREAM_REDIRECTION
605

shiqian's avatar
shiqian committed
606
// Determines whether to support death tests.
607
// pops up a dialog window that cannot be suppressed programmatically.
Gennadiy Civil's avatar
merges  
Gennadiy Civil committed
608
609
#if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS ||   \
     (GTEST_OS_MAC && !GTEST_OS_IOS) ||                         \
610
     (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER) ||                  \
611
     GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \
Gennadiy Civil's avatar
Gennadiy Civil committed
612
     GTEST_OS_OPENBSD || GTEST_OS_QNX || GTEST_OS_FREEBSD || \
613
     GTEST_OS_NETBSD || GTEST_OS_FUCHSIA)
614
# define GTEST_HAS_DEATH_TEST 1
615
#endif
shiqian's avatar
shiqian committed
616

617
618
// Determines whether to support type-driven tests.

619
// Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
620
// Sun Pro CC, IBM Visual Age, and HP aCC support.
621
#if defined(__GNUC__) || defined(_MSC_VER) || defined(__SUNPRO_CC) || \
622
    defined(__IBMCPP__) || defined(__HP_aCC)
623
624
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
625
#endif
626

627
// Determines whether the system compiler uses UTF-16 for encoding wide strings.
zhanyong.wan's avatar
zhanyong.wan committed
628
#define GTEST_WIDE_STRING_USES_UTF16_ \
629
630
    (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || \
     GTEST_OS_AIX || GTEST_OS_OS2)
631

632
633
// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
634
# define GTEST_CAN_STREAM_RESULTS_ 1
635
636
#endif

shiqian's avatar
shiqian committed
637
638
639
640
641
642
643
644
645
646
647
// 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
648
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
shiqian's avatar
shiqian committed
649
#else
650
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
shiqian's avatar
shiqian committed
651
652
#endif

653
// Use this annotation at the end of a struct/class definition to
shiqian's avatar
shiqian committed
654
655
656
657
658
659
// 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
660
//   } GTEST_ATTRIBUTE_UNUSED_;
661
662
663
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
664
#if defined(__GNUC__) && !defined(COMPILER_ICC)
665
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
666
667
668
669
670
671
#elif defined(__clang__)
# if __has_attribute(unused)
#  define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
# endif
#endif
#ifndef GTEST_ATTRIBUTE_UNUSED_
672
# define GTEST_ATTRIBUTE_UNUSED_
673
#endif
shiqian's avatar
shiqian committed
674

675
// Use this annotation before a function that takes a printf format string.
676
#if (defined(__GNUC__) || defined(__clang__)) && !defined(COMPILER_ICC)
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
# if defined(__MINGW_PRINTF_FORMAT)
// MinGW has two different printf implementations. Ensure the format macro
// matches the selected implementation. See
// https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/.
#  define GTEST_ATTRIBUTE_PRINTF_(string_index, first_to_check) \
       __attribute__((__format__(__MINGW_PRINTF_FORMAT, string_index, \
                                 first_to_check)))
# else
#  define GTEST_ATTRIBUTE_PRINTF_(string_index, first_to_check) \
       __attribute__((__format__(__printf__, string_index, first_to_check)))
# endif
#else
# define GTEST_ATTRIBUTE_PRINTF_(string_index, first_to_check)
#endif

Gennadiy Civil's avatar
 
Gennadiy Civil committed
692

693
694
// A macro to disallow operator=
// This should be used in the private: declarations for a class.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
695
#define GTEST_DISALLOW_ASSIGN_(type) \
Abseil Team's avatar
Abseil Team committed
696
  void operator=(type const &) = delete
697
698

// A macro to disallow copy constructor and operator=
shiqian's avatar
shiqian committed
699
// This should be used in the private: declarations for a class.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
700
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type) \
Abseil Team's avatar
Abseil Team committed
701
  type(type const &) = delete; \
702
  GTEST_DISALLOW_ASSIGN_(type)
shiqian's avatar
shiqian committed
703
704
705
706
707

// 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
708
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
shiqian's avatar
shiqian committed
709
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
710
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
shiqian's avatar
shiqian committed
711
#else
712
# define GTEST_MUST_USE_RESULT_
shiqian's avatar
shiqian committed
713
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
shiqian's avatar
shiqian committed
714

715
716
717
718
// MS C++ compiler emits warning when a conditional expression is compile time
// constant. In some contexts this warning is false positive and needs to be
// suppressed. Use the following two macros in such cases:
//
billydonahue's avatar
billydonahue committed
719
// GTEST_INTENTIONAL_CONST_COND_PUSH_()
720
// while (true) {
billydonahue's avatar
billydonahue committed
721
// GTEST_INTENTIONAL_CONST_COND_POP_()
722
// }
billydonahue's avatar
billydonahue committed
723
724
725
726
# define GTEST_INTENTIONAL_CONST_COND_PUSH_() \
    GTEST_DISABLE_MSC_WARNINGS_PUSH_(4127)
# define GTEST_INTENTIONAL_CONST_COND_POP_() \
    GTEST_DISABLE_MSC_WARNINGS_POP_()
727

728
729
730
731
732
733
// 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.

734
# if defined(_MSC_VER) || defined(__BORLANDC__)
735
// These two compilers are known to support SEH.
736
737
#  define GTEST_HAS_SEH 1
# else
738
// Assume no SEH.
739
740
#  define GTEST_HAS_SEH 0
# endif
741
742
743

#endif  // GTEST_HAS_SEH

744
745
#ifndef GTEST_IS_THREADSAFE

746
747
748
749
#define GTEST_IS_THREADSAFE                                                 \
  (GTEST_HAS_MUTEX_AND_THREAD_LOCAL_ ||                                     \
   (GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT) || \
   GTEST_HAS_PTHREAD)
750

751
#endif  // GTEST_IS_THREADSAFE
752

753
754
755
756
757
// GTEST_API_ qualifies all symbols that must be exported. The definitions below
// are guarded by #ifndef to give embedders a chance to define GTEST_API_ in
// gtest/internal/custom/gtest-port.h
#ifndef GTEST_API_

758
#ifdef _MSC_VER
759
760
761
762
763
# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif
764
765
#elif __GNUC__ >= 4 || defined(__clang__)
# define GTEST_API_ __attribute__((visibility ("default")))
766
#endif  // _MSC_VER
767

768
#endif  // GTEST_API_
769

770
#ifndef GTEST_API_
771
# define GTEST_API_
772
#endif  // GTEST_API_
773

774
775
776
777
#ifndef GTEST_DEFAULT_DEATH_TEST_STYLE
# define GTEST_DEFAULT_DEATH_TEST_STYLE  "fast"
#endif  // GTEST_DEFAULT_DEATH_TEST_STYLE

778
#ifdef __GNUC__
779
// Ask the compiler to never inline a given function.
780
# define GTEST_NO_INLINE_ __attribute__((noinline))
781
#else
782
783
# define GTEST_NO_INLINE_
#endif
784

785
// _LIBCPP_VERSION is defined by the libc++ library from the LLVM project.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
786
787
788
789
790
791
#if !defined(GTEST_HAS_CXXABI_H_)
# if defined(__GLIBCXX__) || (defined(_LIBCPP_VERSION) && !defined(_MSC_VER))
#  define GTEST_HAS_CXXABI_H_ 1
# else
#  define GTEST_HAS_CXXABI_H_ 0
# endif
792
793
#endif

794
795
796
797
798
799
800
801
// 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_
802
# endif  // __has_feature(memory_sanitizer)
803
804
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
805
806
807
808
809
810
811
812
813
814
815
816
817
#endif  // __clang__

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

819
820
821
822
823
824
825
826
827
828
829
830
// A function level attribute to disable ThreadSanitizer instrumentation.
#if defined(__clang__)
# if __has_feature(thread_sanitizer)
#  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_ \
       __attribute__((no_sanitize_thread))
# else
#  define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
# endif  // __has_feature(thread_sanitizer)
#else
# define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
#endif  // __clang__

shiqian's avatar
shiqian committed
831
832
833
834
namespace testing {

class Message;

Abseil Team's avatar
Abseil Team committed
835
836
837
838
839
840
841
// Legacy imports for backwards compatibility.
// New code should use std:: names directly.
using std::get;
using std::make_tuple;
using std::tuple;
using std::tuple_element;
using std::tuple_size;
842

shiqian's avatar
shiqian committed
843
844
namespace internal {

845
846
847
848
849
// 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;

Abseil Team's avatar
Abseil Team committed
850
851
852
// The GTEST_COMPILE_ASSERT_ is a legacy macro used to verify that a compile
// time expression is true (in new code, use static_assert instead). For
// example, you could use it to verify the size of a static array:
853
//
854
855
//   GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
//                         names_incorrect_size);
856
//
Abseil Team's avatar
Abseil Team committed
857
858
859
// The second argument to the macro must be a valid C++ identifier. If the
// expression is false, compiler will issue an error containing this identifier.
#define GTEST_COMPILE_ASSERT_(expr, msg) static_assert(expr, #msg)
860
861
862
863
864
865
866
867

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

template <typename T>
billydonahue's avatar
billydonahue committed
868
869
870
struct StaticAssertTypeEqHelper<T, T> {
  enum { value = true };
};
871

Gennadiy Civil's avatar
 
Gennadiy Civil committed
872
873
874
875
876
877
878
879
880
881
// Same as std::is_same<>.
template <typename T, typename U>
struct IsSame {
  enum { value = false };
};
template <typename T>
struct IsSame<T, T> {
  enum { value = true };
};

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

885
886
887
888
889
890
891
892
893
894
895
896
#if GTEST_HAS_GLOBAL_STRING
typedef ::string string;
#else
typedef ::std::string string;
#endif  // GTEST_HAS_GLOBAL_STRING

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

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

901
// Defines RE.
shiqian's avatar
shiqian committed
902

Gennadiy Civil's avatar
 
Gennadiy Civil committed
903
#if GTEST_USES_PCRE
Gennadiy Civil's avatar
 
Gennadiy Civil committed
904
// if used, PCRE is injected by custom/gtest-port.h
Gennadiy Civil's avatar
 
Gennadiy Civil committed
905
906
#elif GTEST_USES_POSIX_RE || GTEST_USES_SIMPLE_RE

907
// A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
shiqian's avatar
shiqian committed
908
// Regular Expression syntax.
909
class GTEST_API_ RE {
shiqian's avatar
shiqian committed
910
 public:
911
912
913
914
  // 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
915
916
917
  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

Gennadiy Civil's avatar
 
Gennadiy Civil committed
918
# if GTEST_HAS_GLOBAL_STRING
919

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

Gennadiy Civil's avatar
 
Gennadiy Civil committed
922
# endif  // GTEST_HAS_GLOBAL_STRING
shiqian's avatar
shiqian committed
923
924
925
926
927
928
929

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

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

930
931
932
933
934
  // 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).
  //
Gennadiy Civil's avatar
 
Gennadiy Civil committed
935
  // FIXME: make FullMatch() and PartialMatch() work
936
937
938
939
  // 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
940
941
942
943
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

Gennadiy Civil's avatar
 
Gennadiy Civil committed
944
# if GTEST_HAS_GLOBAL_STRING
945

946
947
948
  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
949
950
951
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }
952

Gennadiy Civil's avatar
 
Gennadiy Civil committed
953
# endif  // GTEST_HAS_GLOBAL_STRING
shiqian's avatar
shiqian committed
954

955
  static bool FullMatch(const char* str, const RE& re);
shiqian's avatar
shiqian committed
956
957
958
959
960
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

961
  // We use a const char* instead of an std::string, as Google Test used to be
Gennadiy Civil's avatar
 
Gennadiy Civil committed
962
  // used where std::string is not available.  FIXME: change to
963
  // std::string.
shiqian's avatar
shiqian committed
964
  const char* pattern_;
965
  bool is_valid_;
966

Gennadiy Civil's avatar
 
Gennadiy Civil committed
967
# if GTEST_USES_POSIX_RE
968

969
970
  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().
971

Gennadiy Civil's avatar
 
Gennadiy Civil committed
972
# else  // GTEST_USES_SIMPLE_RE
973

974
  const char* full_pattern_;  // For FullMatch();
975

Gennadiy Civil's avatar
 
Gennadiy Civil committed
976
# endif
shiqian's avatar
shiqian committed
977

978
  GTEST_DISALLOW_ASSIGN_(RE);
979
};
shiqian's avatar
shiqian committed
980

Gennadiy Civil's avatar
 
Gennadiy Civil committed
981
982
#endif  // GTEST_USES_PCRE

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

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

1006
1007
1008
// 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.
1009
class GTEST_API_ GTestLog {
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
 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
1023

1024
1025
1026
#if !defined(GTEST_LOG_)

# define GTEST_LOG_(severity) \
1027
1028
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()
shiqian's avatar
shiqian committed
1029
1030

inline void LogToStderr() {}
1031
inline void FlushInfoLog() { fflush(nullptr); }
shiqian's avatar
shiqian committed
1032

1033
1034
1035
#endif  // !defined(GTEST_LOG_)

#if !defined(GTEST_CHECK_)
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
// 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.
1050
# define GTEST_CHECK_(condition) \
1051
1052
1053
1054
1055
    GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
    if (::testing::internal::IsTrue(condition)) \
      ; \
    else \
      GTEST_LOG_(FATAL) << "Condition " #condition " failed. "
1056
#endif  // !defined(GTEST_CHECK_)
1057

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

Gennadiy Civil's avatar
Gennadiy Civil committed
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
// Adds reference to a type if it is not a reference type,
// otherwise leaves it unchanged.  This is the same as
// tr1::add_reference, which is not widely available yet.
template <typename T>
struct AddReference { typedef T& type; };  // NOLINT
template <typename T>
struct AddReference<T&> { typedef T& type; };  // NOLINT

// A handy wrapper around AddReference that works when the argument T
// depends on template parameters.
#define GTEST_ADD_REFERENCE_(T) \
    typename ::testing::internal::AddReference<T>::type

// Transforms "T" into "const T&" according to standard reference collapsing
// rules (this is only needed as a backport for C++98 compilers that do not
// support reference collapsing). Specifically, it transforms:
//
//   char         ==> const char&
//   const char   ==> const char&
//   char&        ==> char&
//   const char&  ==> const char&
//
// Note that the non-const reference will not have "const" added. This is
// standard, and necessary so that "T" can always bind to "const T&".
template <typename T>
struct ConstRef { typedef const T& type; };
template <typename T>
struct ConstRef<T&> { typedef T& type; };

// The argument T must depend on some template parameters.
#define GTEST_REFERENCE_TO_CONST_(T) \
  typename ::testing::internal::ConstRef<T>::type

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

// When you upcast (that is, cast a pointer from type Foo to type
1125
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
// 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.
1141
1142
1143
1144
1145
1146
//
// 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
1147
1148
1149
1150
  // Ensures that To is a sub-type of From *.  This test is here only
  // for compile-time type checking, and has no overhead in an
  // optimized build at run-time, as it will be optimized away
  // completely.
billydonahue's avatar
billydonahue committed
1151
  GTEST_INTENTIONAL_CONST_COND_PUSH_()
1152
  if (false) {
billydonahue's avatar
billydonahue committed
1153
  GTEST_INTENTIONAL_CONST_COND_POP_()
1154
1155
  const To to = nullptr;
  ::testing::internal::ImplicitCast_<From*>(to);
1156
1157
1158
1159
  }

#if GTEST_HAS_RTTI
  // RTTI: debug mode only!
1160
  GTEST_CHECK_(f == nullptr || dynamic_cast<To>(f) != nullptr);
1161
1162
1163
1164
#endif
  return static_cast<To>(f);
}

1165
1166
1167
1168
1169
1170
1171
1172
1173
// 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));
1174
1175
1176
1177
1178
#endif

#if GTEST_HAS_DOWNCAST_
  return ::down_cast<Derived*>(base);
#elif GTEST_HAS_RTTI
1179
1180
1181
  return dynamic_cast<Derived*>(base);  // NOLINT
#else
  return static_cast<Derived*>(base);  // Poor man's downcast.
1182
#endif
1183
1184
}

1185
#if GTEST_HAS_STREAM_REDIRECTION
1186

shiqian's avatar
shiqian committed
1187
// Defines the stderr capturer:
1188
1189
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
shiqian's avatar
shiqian committed
1190
1191
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
1192
//
zhanyong.wan's avatar
zhanyong.wan committed
1193
GTEST_API_ void CaptureStdout();
1194
GTEST_API_ std::string GetCapturedStdout();
zhanyong.wan's avatar
zhanyong.wan committed
1195
GTEST_API_ void CaptureStderr();
1196
GTEST_API_ std::string GetCapturedStderr();
1197

1198
#endif  // GTEST_HAS_STREAM_REDIRECTION
kosak's avatar
kosak committed
1199
1200
1201
1202
1203
// Returns the size (in bytes) of a file.
GTEST_API_ size_t GetFileSize(FILE* file);

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

1205
// All command line arguments.
Gennadiy Civil's avatar
Gennadiy Civil committed
1206
GTEST_API_ std::vector<std::string> GetArgvs();
1207

zhanyong.wan's avatar
zhanyong.wan committed
1208
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
1209

Gennadiy Civil's avatar
Gennadiy Civil committed
1210
1211
1212
1213
1214
1215
1216
1217
std::vector<std::string> GetInjectableArgvs();
// Deprecated: pass the args vector by value instead.
void SetInjectableArgvs(const std::vector<std::string>* new_argvs);
void SetInjectableArgvs(const std::vector<std::string>& new_argvs);
#if GTEST_HAS_GLOBAL_STRING
void SetInjectableArgvs(const std::vector< ::string>& new_argvs);
#endif  // GTEST_HAS_GLOBAL_STRING
void ClearInjectableArgvs();
shiqian's avatar
shiqian committed
1218
1219
1220
1221

#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.
1222
1223
1224
1225
1226
#if GTEST_IS_THREADSAFE
# if GTEST_HAS_PTHREAD
// Sleeps for (roughly) n milliseconds.  This function is only for testing
// Google Test's own constructs.  Don't use it in user tests, either
// directly or indirectly.
1227
1228
1229
1230
1231
inline void SleepMilliseconds(int n) {
  const timespec time = {
    0,                  // 0 seconds.
    n * 1000L * 1000L,  // And n ms.
  };
1232
  nanosleep(&time, nullptr);
1233
}
1234
# endif  // GTEST_HAS_PTHREAD
1235

1236
1237
1238
1239
# if GTEST_HAS_NOTIFICATION_
// Notification has already been imported into the namespace.
// Nothing to do here.

1240
# elif GTEST_HAS_PTHREAD
1241
1242
1243
1244
1245
1246
1247
1248
// 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
1249
  Notification() : notified_(false) {
1250
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, nullptr));
jgm's avatar
jgm committed
1251
1252
1253
1254
  }
  ~Notification() {
    pthread_mutex_destroy(&mutex_);
  }
1255
1256
1257

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
jgm's avatar
jgm committed
1258
1259
1260
1261
1262
  void Notify() {
    pthread_mutex_lock(&mutex_);
    notified_ = true;
    pthread_mutex_unlock(&mutex_);
  }
1263
1264
1265
1266

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
jgm's avatar
jgm committed
1267
1268
1269
1270
1271
1272
    for (;;) {
      pthread_mutex_lock(&mutex_);
      const bool notified = notified_;
      pthread_mutex_unlock(&mutex_);
      if (notified)
        break;
1273
1274
1275
1276
1277
      SleepMilliseconds(10);
    }
  }

 private:
jgm's avatar
jgm committed
1278
1279
  pthread_mutex_t mutex_;
  bool notified_;
1280
1281
1282
1283

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

1284
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332

GTEST_API_ void SleepMilliseconds(int n);

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

  ~AutoHandle();

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

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

  Handle handle_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(AutoHandle);
};

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

 private:
  AutoHandle event_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};
1333
# endif  // GTEST_HAS_NOTIFICATION_
1334
1335
1336
1337
1338
1339

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

1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
// 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();
1359
  return nullptr;
1360
1361
}

1362
// Helper class for testing Google Test's multi-threading constructs.
zhanyong.wan's avatar
zhanyong.wan committed
1363
// To use it, write:
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
//
//   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>
1375
class ThreadWithParam : public ThreadWithParamBase {
1376
 public:
1377
  typedef void UserThreadFunc(T);
1378

1379
  ThreadWithParam(UserThreadFunc* func, T param, Notification* thread_can_start)
1380
1381
1382
      : func_(func),
        param_(param),
        thread_can_start_(thread_can_start),
zhanyong.wan's avatar
zhanyong.wan committed
1383
        finished_(false) {
1384
    ThreadWithParamBase* const base = this;
zhanyong.wan's avatar
zhanyong.wan committed
1385
1386
1387
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
1388
        pthread_create(&thread_, nullptr, &ThreadFuncWithCLinkage, base));
zhanyong.wan's avatar
zhanyong.wan committed
1389
  }
Abseil Team's avatar
Abseil Team committed
1390
  ~ThreadWithParam() override { Join(); }
1391
1392
1393

  void Join() {
    if (!finished_) {
1394
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, nullptr));
1395
1396
1397
1398
      finished_ = true;
    }
  }

Abseil Team's avatar
Abseil Team committed
1399
  void Run() override {
1400
    if (thread_can_start_ != nullptr) thread_can_start_->WaitForNotification();
1401
1402
1403
    func_(param_);
  }

1404
 private:
1405
  UserThreadFunc* const func_;  // User-supplied thread function.
1406
1407
1408
1409
1410
  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
1411
1412
1413
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1414
};
1415
1416
1417
1418
1419
1420
# endif  // !GTEST_OS_WINDOWS && GTEST_HAS_PTHREAD ||
         // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_

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

1422
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
1423

1424
1425
// Mutex implements mutex on Windows platforms.  It is used in conjunction
// with class MutexLock:
1426
//
1427
1428
//   Mutex mutex;
//   ...
1429
1430
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the
//                            // end of the current scope.
1431
//
1432
1433
// A static Mutex *must* be defined or declared using one of the following
// macros:
1434
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
//
// (A non-static Mutex is defined/declared in the usual way).
class GTEST_API_ Mutex {
 public:
  enum MutexType { kStatic = 0, kDynamic = 1 };
  // We rely on kStaticMutex being 0 as it is to what the linker initializes
  // type_ in static mutexes.  critical_section_ will be initialized lazily
  // in ThreadSafeLazyInit().
  enum StaticConstructorSelector { kStaticMutex = 0 };

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

  Mutex();
  ~Mutex();

  void Lock();

  void Unlock();

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

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

1466
  // Per https://blogs.msdn.microsoft.com/oldnewthing/20040223-00/?p=40503,
1467
1468
1469
1470
1471
1472
1473
  // we assume that 0 is an invalid value for thread IDs.
  unsigned int owner_thread_id_;

  // For static mutexes, we rely on these members being initialized to zeros
  // by the linker.
  MutexType type_;
  long critical_section_init_phase_;  // NOLINT
1474
  GTEST_CRITICAL_SECTION* critical_section_;
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

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

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

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

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

 private:
  Mutex* const mutex_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
};

typedef GTestMutexLock MutexLock;

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

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

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

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocalBase);
};

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

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

class GTEST_API_ ThreadWithParamBase {
 public:
  void Join();

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

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

 private:
  AutoHandle thread_;
};

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

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

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

   private:
    UserThreadFunc* const func_;
    const T param_;

    GTEST_DISALLOW_COPY_AND_ASSIGN_(RunnableImpl);
  };

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
};

// Implements thread-local storage on Windows systems.
//
//   // Thread 1
//   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1600
//
1601
1602
1603
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
1604
//
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
//
// The template type argument T must have a public copy constructor.
// In addition, the default ThreadLocal constructor requires T to have
// a public default constructor.
//
// The users of a TheadLocal instance have to make sure that all but one
// threads (including the main one) using that instance have exited before
// destroying it. Otherwise, the per-thread objects managed for them by the
// ThreadLocal instance are not guaranteed to be destroyed on all platforms.
1618
//
1619
1620
1621
1622
1623
1624
1625
// Google Test only uses global ThreadLocal objects.  That means they
// will die after main() has returned.  Therefore, no per-thread
// object managed by Google Test will be leaked as long as all threads
// using Google Test have exited when main() returns.
template <typename T>
class ThreadLocal : public ThreadLocalBase {
 public:
1626
1627
1628
  ThreadLocal() : default_factory_(new DefaultValueHolderFactory()) {}
  explicit ThreadLocal(const T& value)
      : default_factory_(new InstanceValueHolderFactory(value)) {}
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641

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

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

 private:
  // Holds a value of T.  Can be deleted via its base class without the caller
  // knowing the type of T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
1642
    ValueHolder() : value_() {}
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

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


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

  virtual ThreadLocalValueHolderBase* NewValueForCurrentThread() const {
1659
    return default_factory_->MakeNewHolder();
1660
1661
  }

1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
  class ValueHolderFactory {
   public:
    ValueHolderFactory() {}
    virtual ~ValueHolderFactory() {}
    virtual ValueHolder* MakeNewHolder() const = 0;

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolderFactory);
  };

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

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultValueHolderFactory);
  };

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

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

    GTEST_DISALLOW_COPY_AND_ASSIGN_(InstanceValueHolderFactory);
  };

misterg's avatar
misterg committed
1694
  std::unique_ptr<ValueHolderFactory> default_factory_;
1695
1696
1697
1698
1699
1700
1701

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

# elif GTEST_HAS_PTHREAD

// MutexBase and Mutex implement mutex on pthreads-based platforms.
1702
1703
class MutexBase {
 public:
1704
1705
1706
1707
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
1708
    has_owner_ = true;
1709
1710
1711
1712
  }

  // Releases this mutex.
  void Unlock() {
1713
1714
1715
    // 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
1716
    // mutex when this is called.
1717
    has_owner_ = false;
1718
1719
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }
1720
1721
1722

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
1723
  void AssertHeld() const {
1724
    GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self()))
1725
1726
        << "The current thread is not holding the mutex @" << this;
  }
1727

1728
1729
1730
1731
1732
  // 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.
1733
 public:
1734
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
1735
1736
1737
1738
1739
1740
1741
1742
  // 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.
1743
1744
1745
};

// Forward-declares a static mutex.
1746
1747
#  define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
     extern ::testing::internal::MutexBase mutex
1748

1749
// Defines and statically (i.e. at link time) initializes a static mutex.
1750
1751
1752
1753
1754
// 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.
Gennadiy Civil's avatar
Gennadiy Civil committed
1755
1756
#define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
  ::testing::internal::MutexBase mutex = {PTHREAD_MUTEX_INITIALIZER, false, 0}
1757

1758
1759
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
1760
1761
class Mutex : public MutexBase {
 public:
1762
  Mutex() {
1763
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, nullptr));
1764
    has_owner_ = false;
1765
1766
1767
1768
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }
1769
1770
1771
1772
1773

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

1774
// We cannot name this class MutexLock because the ctor declaration would
1775
// conflict with a macro named MutexLock, which is defined on some
1776
1777
1778
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
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;

1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
// 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);
}

1811
1812
// Implements thread-local storage on pthreads-based systems.
template <typename T>
1813
class GTEST_API_ ThreadLocal {
1814
 public:
1815
1816
1817
1818
1819
  ThreadLocal()
      : key_(CreateKey()), default_factory_(new DefaultValueHolderFactory()) {}
  explicit ThreadLocal(const T& value)
      : key_(CreateKey()),
        default_factory_(new InstanceValueHolderFactory(value)) {}
1820
1821

  ~ThreadLocal() {
zhanyong.wan's avatar
zhanyong.wan committed
1822
1823
1824
1825
1826
    // 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.
1827
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
1828
1829
1830
1831
1832
1833
1834
1835
  }

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

 private:
1836
1837
1838
  // Holds a value of type T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
1839
    ValueHolder() : value_() {}
1840
1841
1842
1843
1844
1845
1846
1847
1848
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

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

1849
1850
  static pthread_key_t CreateKey() {
    pthread_key_t key;
zhanyong.wan's avatar
zhanyong.wan committed
1851
1852
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
1853
1854
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
1855
1856
1857
1858
    return key;
  }

  T* GetOrCreateValue() const {
1859
1860
    ThreadLocalValueHolderBase* const holder =
        static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
1861
    if (holder != nullptr) {
1862
1863
      return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
    }
1864

1865
    ValueHolder* const new_holder = default_factory_->MakeNewHolder();
1866
1867
1868
    ThreadLocalValueHolderBase* const holder_base = new_holder;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
    return new_holder->pointer();
1869
1870
  }

1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
  class ValueHolderFactory {
   public:
    ValueHolderFactory() {}
    virtual ~ValueHolderFactory() {}
    virtual ValueHolder* MakeNewHolder() const = 0;

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolderFactory);
  };

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

   private:
    GTEST_DISALLOW_COPY_AND_ASSIGN_(DefaultValueHolderFactory);
  };

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

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

    GTEST_DISALLOW_COPY_AND_ASSIGN_(InstanceValueHolderFactory);
  };

1903
1904
  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
misterg's avatar
misterg committed
1905
  std::unique_ptr<ValueHolderFactory> default_factory_;
1906
1907
1908
1909

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

1910
# endif  // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
1911

1912
#else  // GTEST_IS_THREADSAFE
1913

shiqian's avatar
shiqian committed
1914
1915
1916
1917
1918
1919
1920
1921
// 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() {}
1922
1923
  void Lock() {}
  void Unlock() {}
shiqian's avatar
shiqian committed
1924
1925
1926
  void AssertHeld() const {}
};

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

1930
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
1931

1932
1933
1934
1935
1936
// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)".  Hence the typedef trick below.
shiqian's avatar
shiqian committed
1937
1938
1939
1940
1941
1942
1943
1944
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template <typename T>
1945
class GTEST_API_ ThreadLocal {
shiqian's avatar
shiqian committed
1946
 public:
shiqian's avatar
shiqian committed
1947
1948
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
shiqian's avatar
shiqian committed
1949
1950
1951
1952
1953
1954
1955
1956
  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_;
};

1957
#endif  // GTEST_IS_THREADSAFE
1958
1959
1960

// 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
1961
GTEST_API_ size_t GetThreadCount();
1962

1963
// Passing non-POD classes through ellipsis (...) crashes the ARM
1964
// compiler and generates a warning in Sun Studio before 12u4. The Nokia Symbian
1965
1966
1967
1968
// 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.
1969
1970
#if defined(__SYMBIAN32__) || defined(__IBMCPP__) || \
     (defined(__SUNPRO_CC) && __SUNPRO_CC < 0x5130)
1971
1972
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
1973
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
1974
#else
1975
# define GTEST_CAN_COMPARE_NULL 1
1976
#endif
shiqian's avatar
shiqian committed
1977

1978
1979
1980
1981
// 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.
1982
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
1983
# define GTEST_NEEDS_IS_POINTER_ 1
1984
#endif
shiqian's avatar
shiqian committed
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995

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;

1996
1997
1998
1999
2000
2001
template <typename T, typename U>
struct is_same : public false_type {};

template <typename T>
struct is_same<T, T> : public true_type {};

Gennadiy Civil's avatar
Gennadiy Civil committed
2002

shiqian's avatar
shiqian committed
2003
2004
2005
2006
2007
2008
template <typename T>
struct is_pointer : public false_type {};

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

2009
2010
2011
2012
2013
template <typename Iterator>
struct IteratorTraits {
  typedef typename Iterator::value_type value_type;
};

Gennadiy Civil's avatar
Gennadiy Civil committed
2014

2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
template <typename T>
struct IteratorTraits<T*> {
  typedef T value_type;
};

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

2025
#if GTEST_OS_WINDOWS
2026
2027
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
2028
2029
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
2030
#else
2031
2032
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
2033
typedef long long BiggestInt;  // NOLINT
2034
2035
#endif  // GTEST_OS_WINDOWS

2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
// 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;
}
2061
2062
2063
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast<unsigned char>(ch)) != 0;
}
2064
2065
2066
2067
inline bool IsXDigit(wchar_t ch) {
  const unsigned char low_byte = static_cast<unsigned char>(ch);
  return ch == low_byte && isxdigit(low_byte) != 0;
}
2068
2069
2070
2071
2072
2073
2074
2075

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

2076
2077
2078
2079
2080
2081
2082
inline std::string StripTrailingSpaces(std::string str) {
  std::string::iterator it = str.end();
  while (it != str.begin() && IsSpace(*--it))
    it = str.erase(it);
  return str;
}

2083
2084
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
2085
2086
2087
2088
// 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.

2089
2090
2091
2092
namespace posix {

// Functions with a different name on Windows.

zhanyong.wan's avatar
zhanyong.wan committed
2093
#if GTEST_OS_WINDOWS
2094

2095
typedef struct _stat StatStruct;
2096

2097
# ifdef __BORLANDC__
2098
2099
2100
2101
2102
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); }
2103
2104
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
2105
inline int IsATTY(int /* fd */) { return 0; }
2106
#  else
2107
inline int IsATTY(int fd) { return _isatty(fd); }
2108
#  endif  // GTEST_OS_WINDOWS_MOBILE
2109
2110
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
2111
}
2112
inline char* StrDup(const char* src) { return _strdup(src); }
2113
# endif  // __BORLANDC__
2114

2115
# if GTEST_OS_WINDOWS_MOBILE
2116
2117
2118
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.
2119
# else
2120
2121
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
2122
2123
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
2124
2125
  return (_S_IFDIR & st.st_mode) != 0;
}
2126
# endif  // GTEST_OS_WINDOWS_MOBILE
2127

shiqian's avatar
shiqian committed
2128
#else
2129

2130
typedef struct stat StatStruct;
2131

2132
2133
2134
2135
2136
2137
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);
}
2138
inline char* StrDup(const char* src) { return strdup(src); }
2139
2140
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
2141

shiqian's avatar
shiqian committed
2142
2143
#endif  // GTEST_OS_WINDOWS

2144
2145
// Functions deprecated by MSVC 8.0.

2146
GTEST_DISABLE_MSC_DEPRECATED_PUSH_()
2147

2148
2149
inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
2150
}
2151
2152
2153
2154
2155

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

billydonahue's avatar
billydonahue committed
2156
#if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
2157
inline int ChDir(const char* dir) { return chdir(dir); }
2158
#endif
2159
2160
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
2161
}
2162
#if !GTEST_OS_WINDOWS_MOBILE
2163
2164
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
2165
}
2166
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
2167
#endif
2168
inline int FClose(FILE* fp) { return fclose(fp); }
2169
#if !GTEST_OS_WINDOWS_MOBILE
2170
2171
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast<int>(read(fd, buf, count));
2172
}
2173
2174
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast<int>(write(fd, buf, count));
2175
}
2176
2177
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
2178
#endif
2179
inline const char* GetEnv(const char* name) {
2180
#if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
2181
  // We are on Windows CE, which has no environment variables.
2182
  static_cast<void>(name);  // To prevent 'unused argument' warning.
2183
  return nullptr;
2184
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
2185
2186
2187
  // 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);
2188
  return (env != nullptr && env[0] != '\0') ? env : nullptr;
2189
#else
2190
  return getenv(name);
2191
2192
2193
#endif
}

2194
GTEST_DISABLE_MSC_DEPRECATED_POP_()
2195

2196
#if GTEST_OS_WINDOWS_MOBILE
2197
2198
2199
// 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.
Abseil Team's avatar
Abseil Team committed
2200
[[noreturn]] void Abort();
2201
#else
Abseil Team's avatar
Abseil Team committed
2202
[[noreturn]] inline void Abort() { abort(); }
2203
#endif  // GTEST_OS_WINDOWS_MOBILE
2204
2205
2206

}  // namespace posix

2207
2208
2209
2210
2211
// 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.
2212
#if _MSC_VER && !GTEST_OS_WINDOWS_MOBILE
2213
2214
2215
2216
// 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)
2217
// Windows CE does not define _snprintf_s
2218
2219
2220
2221
2222
# define GTEST_SNPRINTF_ _snprintf
#else
# define GTEST_SNPRINTF_ snprintf
#endif

shiqian's avatar
shiqian committed
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
// 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
2275
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
  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.
2294
2295
2296
#if !defined(GTEST_FLAG)
# define GTEST_FLAG(name) FLAGS_gtest_##name
#endif  // !defined(GTEST_FLAG)
shiqian's avatar
shiqian committed
2297

kosak's avatar
kosak committed
2298
2299
2300
2301
#if !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)
# define GTEST_USE_OWN_FLAGFILE_FLAG_ 1
#endif  // !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)

2302
#if !defined(GTEST_DECLARE_bool_)
2303
2304
# define GTEST_FLAG_SAVER_ ::testing::internal::GTestFlagSaver

shiqian's avatar
shiqian committed
2305
// Macros for declaring flags.
2306
2307
# define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
# define GTEST_DECLARE_int32_(name) \
2308
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
Gennadiy Civil's avatar
 
Gennadiy Civil committed
2309
# define GTEST_DECLARE_string_(name) \
2310
    GTEST_API_ extern ::std::string GTEST_FLAG(name)
shiqian's avatar
shiqian committed
2311
2312

// Macros for defining flags.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
2313
# define GTEST_DEFINE_bool_(name, default_val, doc) \
2314
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
Gennadiy Civil's avatar
 
Gennadiy Civil committed
2315
# define GTEST_DEFINE_int32_(name, default_val, doc) \
2316
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
Gennadiy Civil's avatar
 
Gennadiy Civil committed
2317
# define GTEST_DEFINE_string_(name, default_val, doc) \
2318
    GTEST_API_ ::std::string GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
2319

2320
2321
#endif  // !defined(GTEST_DECLARE_bool_)

2322
// Thread annotations
2323
2324
2325
2326
#if !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
# define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
# define GTEST_LOCK_EXCLUDED_(locks)
#endif  // !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
2327

shiqian's avatar
shiqian committed
2328
2329
2330
// 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.
Gennadiy Civil's avatar
 
Gennadiy Civil committed
2331
// FIXME: Find a better way to refactor flag and environment parsing
shiqian's avatar
shiqian committed
2332
2333
2334
2335
2336
2337
2338
// 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
2339
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
Gennadiy Civil's avatar
Gennadiy Civil committed
2340
std::string OutputFlagAlsoCheckEnvVar();
Gennadiy Civil's avatar
Gennadiy Civil committed
2341
const char* StringFromGTestEnv(const char* flag, const char* default_val);
shiqian's avatar
shiqian committed
2342
2343
2344
2345
2346

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_