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

#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_

// The user can define the following macros in the build script to
shiqian's avatar
shiqian committed
40
41
// control Google Test's behavior.  If the user doesn't define a macro
// in this list, Google Test will define it.
shiqian's avatar
shiqian committed
42
//
43
44
//   GTEST_HAS_CLONE          - Define it to 1/0 to indicate that clone(2)
//                              is/isn't available.
45
46
//   GTEST_HAS_EXCEPTIONS     - Define it to 1/0 to indicate that exceptions
//                              are enabled.
shiqian's avatar
shiqian committed
47
48
49
50
51
52
//   GTEST_HAS_GLOBAL_STRING  - Define it to 1/0 to indicate that ::string
//                              is/isn't available (some systems define
//                              ::string, which is different to std::string).
//   GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string
//                              is/isn't available (some systems define
//                              ::wstring, which is different to std::wstring).
53
54
//   GTEST_HAS_POSIX_RE       - Define it to 1/0 to indicate that POSIX regular
//                              expressions are/aren't available.
shiqian's avatar
shiqian committed
55
56
//   GTEST_HAS_PTHREAD        - Define it to 1/0 to indicate that <pthread.h>
//                              is/isn't available.
57
58
59
60
61
//   GTEST_HAS_RTTI           - Define it to 1/0 to indicate that RTTI is/isn't
//                              enabled.
//   GTEST_HAS_STD_WSTRING    - Define it to 1/0 to indicate that
//                              std::wstring does/doesn't work (Google Test can
//                              be used where std::wstring is unavailable).
62
//   GTEST_HAS_TR1_TUPLE      - Define it to 1/0 to indicate tr1::tuple
63
//                              is/isn't available.
64
65
66
//   GTEST_HAS_SEH            - Define it to 1/0 to indicate whether the
//                              compiler supports Microsoft's "Structured
//                              Exception Handling".
67
68
69
70
//   GTEST_HAS_STREAM_REDIRECTION
//                            - Define it to 1/0 to indicate whether the
//                              platform supports I/O stream redirection using
//                              dup() and dup2().
71
72
73
74
//   GTEST_USE_OWN_TR1_TUPLE  - Define it to 1/0 to indicate whether Google
//                              Test's own tr1 tuple implementation should be
//                              used.  Unused when the user sets
//                              GTEST_HAS_TR1_TUPLE to 0.
75
76
77
78
79
80
81
//   GTEST_LINKED_AS_SHARED_LIBRARY
//                            - Define to 1 when compiling tests that use
//                              Google Test as a shared library (known as
//                              DLL on Windows).
//   GTEST_CREATE_SHARED_LIBRARY
//                            - Define to 1 when compiling Google Test itself
//                              as a shared library.
shiqian's avatar
shiqian committed
82
83
84

// This header defines the following utilities:
//
zhanyong.wan's avatar
zhanyong.wan committed
85
86
// Macros indicating the current platform (defined to 1 if compiled on
// the given platform; otherwise undefined):
87
//   GTEST_OS_AIX      - IBM AIX
zhanyong.wan's avatar
zhanyong.wan committed
88
89
//   GTEST_OS_CYGWIN   - Cygwin
//   GTEST_OS_LINUX    - Linux
90
//     GTEST_OS_LINUX_ANDROID - Google Android
zhanyong.wan's avatar
zhanyong.wan committed
91
//   GTEST_OS_MAC      - Mac OS X
92
//   GTEST_OS_NACL     - Google Native Client (NaCl)
zhanyong.wan's avatar
zhanyong.wan committed
93
94
//   GTEST_OS_SOLARIS  - Sun Solaris
//   GTEST_OS_SYMBIAN  - Symbian
95
96
97
//   GTEST_OS_WINDOWS  - Windows (Desktop, MinGW, or Mobile)
//     GTEST_OS_WINDOWS_DESKTOP  - Windows Desktop
//     GTEST_OS_WINDOWS_MINGW    - MinGW
98
//     GTEST_OS_WINDOWS_MOBILE   - Windows Mobile
zhanyong.wan's avatar
zhanyong.wan committed
99
//   GTEST_OS_ZOS      - z/OS
100
//
101
102
103
104
105
106
107
// Among the platforms, Cygwin, Linux, Max OS X, and Windows have the
// most stable support.  Since core members of the Google Test project
// don't have access to other platforms, support for them may be less
// stable.  If you notice any problems on your platform, please notify
// googletestframework@googlegroups.com (patches for fixing them are
// even more welcome!).
//
zhanyong.wan's avatar
zhanyong.wan committed
108
// Note that it is possible that none of the GTEST_OS_* macros are defined.
shiqian's avatar
shiqian committed
109
//
zhanyong.wan's avatar
zhanyong.wan committed
110
111
112
113
114
115
116
117
// Macros indicating available Google Test features (defined to 1 if
// the corresponding feature is supported; otherwise undefined):
//   GTEST_HAS_COMBINE      - the Combine() function (for value-parameterized
//                            tests)
//   GTEST_HAS_DEATH_TEST   - death tests
//   GTEST_HAS_PARAM_TEST   - value-parameterized tests
//   GTEST_HAS_TYPED_TEST   - typed tests
//   GTEST_HAS_TYPED_TEST_P - type-parameterized tests
118
119
120
//   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
121
//   GTEST_USES_SIMPLE_RE   - our own simple regex is used;
122
//                            the above two are mutually exclusive.
123
//   GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
shiqian's avatar
shiqian committed
124
125
//
// Macros for basic C++ coding:
shiqian's avatar
shiqian committed
126
//   GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
127
128
//   GTEST_ATTRIBUTE_UNUSED_  - declares that a class' instances or a
//                              variable don't have to be used.
129
//   GTEST_DISALLOW_ASSIGN_   - disables operator=.
shiqian's avatar
shiqian committed
130
131
//   GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
//   GTEST_MUST_USE_RESULT_   - declares that a function's result must be used.
shiqian's avatar
shiqian committed
132
133
134
135
//
// Synchronization:
//   Mutex, MutexLock, ThreadLocal, GetThreadCount()
//                  - synchronization primitives.
shiqian's avatar
shiqian committed
136
137
138
//   GTEST_IS_THREADSAFE - defined to 1 to indicate that the above
//                         synchronization primitives have real implementations
//                         and Google Test is thread-safe; or 0 otherwise.
shiqian's avatar
shiqian committed
139
140
//
// Template meta programming:
141
//   is_pointer     - as in TR1; needed on Symbian and IBM XL C/C++ only.
shiqian's avatar
shiqian committed
142
143
144
145
146
147
//
// Smart pointers:
//   scoped_ptr     - as in TR2.
//
// Regular expressions:
//   RE             - a simple regular expression class using the POSIX
148
149
150
//                    Extended Regular Expression syntax on UNIX-like
//                    platforms, or a reduced regular exception syntax on
//                    other platforms, including Windows.
shiqian's avatar
shiqian committed
151
152
//
// Logging:
shiqian's avatar
shiqian committed
153
//   GTEST_LOG_()   - logs messages at the specified severity level.
shiqian's avatar
shiqian committed
154
155
156
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.
//
157
158
159
160
// Stdout and stderr capturing:
//   CaptureStdout()     - starts capturing stdout.
//   GetCapturedStdout() - stops capturing stdout and returns the captured
//                         string.
shiqian's avatar
shiqian committed
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
//   CaptureStderr()     - starts capturing stderr.
//   GetCapturedStderr() - stops capturing stderr and returns the captured
//                         string.
//
// Integer types:
//   TypeWithSize   - maps an integer to a int type.
//   Int32, UInt32, Int64, UInt64, TimeInMillis
//                  - integers of known sizes.
//   BiggestInt     - the biggest signed integer type.
//
// Command-line utilities:
//   GTEST_FLAG()       - references a flag.
//   GTEST_DECLARE_*()  - declares a flag.
//   GTEST_DEFINE_*()   - defines a flag.
//   GetArgvs()         - returns the command line as a vector of strings.
//
// 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.

183
184
#include <ctype.h>   // for isspace, etc
#include <stddef.h>  // for ptrdiff_t
shiqian's avatar
shiqian committed
185
186
#include <stdlib.h>
#include <stdio.h>
187
#include <string.h>
188
#ifndef _WIN32_WCE
189
190
# include <sys/types.h>
# include <sys/stat.h>
191
#endif  // !_WIN32_WCE
192
193

#include <iostream>  // NOLINT
194
195
#include <sstream>  // NOLINT
#include <string>  // NOLINT
shiqian's avatar
shiqian committed
196

197
#define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
zhanyong.wan's avatar
zhanyong.wan committed
198
#define GTEST_FLAG_PREFIX_ "gtest_"
199
#define GTEST_FLAG_PREFIX_DASH_ "gtest-"
zhanyong.wan's avatar
zhanyong.wan committed
200
#define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
201
202
#define GTEST_NAME_ "Google Test"
#define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/"
shiqian's avatar
shiqian committed
203

shiqian's avatar
shiqian committed
204
205
206
// Determines the version of gcc that is used to compile this.
#ifdef __GNUC__
// 40302 means version 4.3.2.
207
# define GTEST_GCC_VER_ \
shiqian's avatar
shiqian committed
208
209
210
    (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__)
#endif  // __GNUC__

shiqian's avatar
shiqian committed
211
// Determines the platform on which Google Test is compiled.
212
#ifdef __CYGWIN__
213
# define GTEST_OS_CYGWIN 1
214
#elif defined __SYMBIAN32__
215
# define GTEST_OS_SYMBIAN 1
216
#elif defined _WIN32
217
218
219
220
221
222
223
224
# define GTEST_OS_WINDOWS 1
# ifdef _WIN32_WCE
#  define GTEST_OS_WINDOWS_MOBILE 1
# elif defined(__MINGW__) || defined(__MINGW32__)
#  define GTEST_OS_WINDOWS_MINGW 1
# else
#  define GTEST_OS_WINDOWS_DESKTOP 1
# endif  // _WIN32_WCE
shiqian's avatar
shiqian committed
225
#elif defined __APPLE__
226
# define GTEST_OS_MAC 1
shiqian's avatar
shiqian committed
227
#elif defined __linux__
228
# define GTEST_OS_LINUX 1
229
230
231
# ifdef ANDROID
#  define GTEST_OS_LINUX_ANDROID 1
# endif  // ANDROID
232
#elif defined __MVS__
233
# define GTEST_OS_ZOS 1
234
#elif defined(__sun) && defined(__SVR4)
235
# define GTEST_OS_SOLARIS 1
236
#elif defined(_AIX)
237
# define GTEST_OS_AIX 1
238
#elif defined __native_client__
239
# define GTEST_OS_NACL 1
240
#endif  // __CYGWIN__
shiqian's avatar
shiqian committed
241

242
243
244
245
246
247
248
// Brings in definitions for functions used in the testing::internal::posix
// namespace (read, write, close, chdir, isatty, stat). We do not currently
// use them on Windows Mobile.
#if !GTEST_OS_WINDOWS
// This assumes that non-Windows OSes provide unistd.h. For OSes where this
// is not the case, we need to include headers that provide the functions
// mentioned above.
249
250
# include <unistd.h>
# if !GTEST_OS_NACL
251
252
253
// TODO(vladl@google.com): Remove this condition when Native Client SDK adds
// strings.h (tracked in
// http://code.google.com/p/nativeclient/issues/detail?id=1175).
254
255
#  include <strings.h>  // Native Client doesn't provide strings.h.
# endif
256
#elif !GTEST_OS_WINDOWS_MOBILE
257
258
# include <direct.h>
# include <io.h>
259
260
261
262
#endif

// Defines this to true iff Google Test can use POSIX regular expressions.
#ifndef GTEST_HAS_POSIX_RE
263
# define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS)
264
265
266
#endif

#if GTEST_HAS_POSIX_RE
267
268
269
270
271

// 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>.
272
# include <regex.h>  // NOLINT
273

274
# define GTEST_USES_POSIX_RE 1
275

276
277
278
279
#elif GTEST_OS_WINDOWS

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

282
283
#else

284
285
// <regex.h> may not be available on this platform.  Use our own
// simple regex implementation instead.
286
# define GTEST_USES_SIMPLE_RE 1
287

288
#endif  // GTEST_HAS_POSIX_RE
289

290
291
292
#ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
293
# if defined(_MSC_VER) || defined(__BORLANDC__)
294
295
// MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS
// macro to enable exceptions, so we'll do the same.
shiqian's avatar
shiqian committed
296
// Assumes that exceptions are enabled by default.
297
298
299
300
301
#  ifndef _HAS_EXCEPTIONS
#   define _HAS_EXCEPTIONS 1
#  endif  // _HAS_EXCEPTIONS
#  define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
# elif defined(__GNUC__) && __EXCEPTIONS
302
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
303
304
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
305
306
307
// 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.
308
309
#  define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
310
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
311
312
#  define GTEST_HAS_EXCEPTIONS 1
# else
313
314
// For other compilers, we assume exceptions are disabled to be
// conservative.
315
316
#  define GTEST_HAS_EXCEPTIONS 0
# endif  // defined(_MSC_VER) || defined(__BORLANDC__)
317
#endif  // GTEST_HAS_EXCEPTIONS
shiqian's avatar
shiqian committed
318

319
320
321
#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.
322
# define GTEST_HAS_STD_STRING 1
323
324
#elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
325
# error "Google Test cannot be used where ::std::string isn't available."
326
#endif  // !defined(GTEST_HAS_STD_STRING)
shiqian's avatar
shiqian committed
327
328
329
330
331

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

332
# define GTEST_HAS_GLOBAL_STRING 0
shiqian's avatar
shiqian committed
333
334
335
336
337
338
339
340
341

#endif  // GTEST_HAS_GLOBAL_STRING

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

342
// Cygwin 1.7 and below doesn't support ::std::wstring.
343
344
345
346
// 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
347
348
349
350
351
352

#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.
353
# define GTEST_HAS_GLOBAL_WSTRING \
354
    (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING)
shiqian's avatar
shiqian committed
355
356
#endif  // GTEST_HAS_GLOBAL_WSTRING

shiqian's avatar
shiqian committed
357
358
359
360
361
// 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.

362
# ifdef _MSC_VER
shiqian's avatar
shiqian committed
363

364
365
366
367
368
#  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
369
370

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

373
374
375
376
377
#  ifdef __GXX_RTTI
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif  // __GXX_RTTI
shiqian's avatar
shiqian committed
378

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

383
384
385
386
387
#  ifdef __RTTI_ALL__
#   define GTEST_HAS_RTTI 1
#  else
#   define GTEST_HAS_RTTI 0
#  endif
388

389
# else
shiqian's avatar
shiqian committed
390

391
// For all other compilers, we assume RTTI is enabled.
392
#  define GTEST_HAS_RTTI 1
shiqian's avatar
shiqian committed
393

394
# endif  // _MSC_VER
shiqian's avatar
shiqian committed
395
396
397

#endif  // GTEST_HAS_RTTI

398
399
400
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
#if GTEST_HAS_RTTI
401
# include <typeinfo>
402
403
#endif

404
// Determines whether Google Test can use the pthreads library.
shiqian's avatar
shiqian committed
405
#ifndef GTEST_HAS_PTHREAD
406
407
408
409
410
// The user didn't tell us explicitly, so we assume pthreads support is
// available on Linux and Mac.
//
// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
// to your compiler flags.
411
# define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC)
shiqian's avatar
shiqian committed
412
413
#endif  // GTEST_HAS_PTHREAD

414
415
416
#if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
417
# include <pthread.h>  // NOLINT
418
419

// For timespec and nanosleep, used below.
420
# include <time.h>  // NOLINT
421
422
#endif

423
424
425
// Determines whether Google Test can use tr1/tuple.  You can define
// this macro to 0 to prevent Google Test from using tuple (any
// feature depending on tuple with be disabled in this mode).
426
#ifndef GTEST_HAS_TR1_TUPLE
427
// The user didn't tell us not to do it, so we assume it's OK.
428
# define GTEST_HAS_TR1_TUPLE 1
429
430
431
432
433
#endif  // GTEST_HAS_TR1_TUPLE

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

436
// We use our own TR1 tuple if we aren't sure the user has an
437
438
// implementation of it already.  At this time, GCC 4.0.0+ and MSVC
// 2010 are the only mainstream compilers that come with a TR1 tuple
439
440
// implementation.  NVIDIA's CUDA NVCC compiler pretends to be GCC by
// defining __GNUC__ and friends, but cannot compile GCC's tuple
441
442
// implementation.  MSVC 2008 (9.0) provides TR1 tuple in a 323 MB
// Feature Pack download, which we cannot assume the user has.
443
# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000)) \
444
    || _MSC_VER >= 1600
445
446
447
448
#  define GTEST_USE_OWN_TR1_TUPLE 0
# else
#  define GTEST_USE_OWN_TR1_TUPLE 1
# endif
449
450

#endif  // GTEST_USE_OWN_TR1_TUPLE
451

452
453
454
455
// To avoid conditional compilation everywhere, we make it
// gtest-port.h's responsibility to #include the header implementing
// tr1/tuple.
#if GTEST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
456

457
458
459
# if GTEST_USE_OWN_TR1_TUPLE
#  include "gtest/internal/gtest-tuple.h"
# elif GTEST_OS_SYMBIAN
zhanyong.wan's avatar
zhanyong.wan committed
460
461
462
463
464
465

// On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to
// use STLport's tuple implementation, which unfortunately doesn't
// work as the copy of STLport distributed with Symbian is incomplete.
// By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to
// use its own tuple implementation.
466
467
468
#  ifdef BOOST_HAS_TR1_TUPLE
#   undef BOOST_HAS_TR1_TUPLE
#  endif  // BOOST_HAS_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
469
470
471

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

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

479
#  if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
480
481
482
483
484
// Until version 4.3.2, gcc has a bug that causes <tr1/functional>,
// which is #included by <tr1/tuple>, to not compile when RTTI is
// disabled.  _TR1_FUNCTIONAL is the header guard for
// <tr1/functional>.  Hence the following #define is a hack to prevent
// <tr1/functional> from being included.
485
486
487
#   define _TR1_FUNCTIONAL 1
#   include <tr1/tuple>
#   undef _TR1_FUNCTIONAL  // Allows the user to #include
488
                        // <tr1/functional> if he chooses to.
489
490
491
#  else
#   include <tr1/tuple>  // NOLINT
#  endif  // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
492

493
# else
494
// If the compiler is not GCC 4.0+, we assume the user is using a
495
// spec-conforming TR1 implementation.
496
497
#  include <tuple>  // NOLINT
# endif  // GTEST_USE_OWN_TR1_TUPLE
zhanyong.wan's avatar
zhanyong.wan committed
498

499
500
#endif  // GTEST_HAS_TR1_TUPLE

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

508
509
510
511
512
# if GTEST_OS_LINUX && !defined(__ia64__)
#  define GTEST_HAS_CLONE 1
# else
#  define GTEST_HAS_CLONE 0
# endif  // GTEST_OS_LINUX && !defined(__ia64__)
513
514
515

#endif  // GTEST_HAS_CLONE

516
517
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
518
519
520
#ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
521
522
523
524
525
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN
#  define GTEST_HAS_STREAM_REDIRECTION 0
# else
#  define GTEST_HAS_STREAM_REDIRECTION 1
# endif  // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
526
#endif  // GTEST_HAS_STREAM_REDIRECTION
527

shiqian's avatar
shiqian committed
528
// Determines whether to support death tests.
529
530
531
// Google Test does not support death tests for VC 7.1 and earlier as
// abort() in a VC 7.1 application compiled as GUI in debug config
// pops up a dialog window that cannot be suppressed programmatically.
532
#if (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
533
534
     (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \
     GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX)
535
536
# define GTEST_HAS_DEATH_TEST 1
# include <vector>  // NOLINT
537
#endif
shiqian's avatar
shiqian committed
538

539
540
541
// We don't support MSVC 7.1 with exceptions disabled now.  Therefore
// all the compilers we care about are adequate for supporting
// value-parameterized tests.
zhanyong.wan's avatar
zhanyong.wan committed
542
#define GTEST_HAS_PARAM_TEST 1
543

544
545
// Determines whether to support type-driven tests.

546
547
548
549
// Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
// Sun Pro CC, and IBM Visual Age support.
#if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
    defined(__IBMCPP__)
550
551
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
552
#endif
553

554
// Determines whether to support Combine(). This only makes sense when
555
556
557
558
// value-parameterized tests are enabled.  The implementation doesn't
// work on Sun Studio since it doesn't understand templated conversion
// operators.
#if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC)
559
# define GTEST_HAS_COMBINE 1
560
#endif
561

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

566
567
// Determines whether test results can be streamed to a socket.
#if GTEST_OS_LINUX
568
# define GTEST_CAN_STREAM_RESULTS_ 1
569
570
#endif

shiqian's avatar
shiqian committed
571
572
573
574
575
576
577
578
579
580
581
// 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
582
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
shiqian's avatar
shiqian committed
583
#else
584
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default:  // NOLINT
shiqian's avatar
shiqian committed
585
586
#endif

587
// Use this annotation at the end of a struct/class definition to
shiqian's avatar
shiqian committed
588
589
590
591
592
593
// 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
594
//   } GTEST_ATTRIBUTE_UNUSED_;
595
596
597
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
598
#if defined(__GNUC__) && !defined(COMPILER_ICC)
599
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
600
#else
601
# define GTEST_ATTRIBUTE_UNUSED_
602
#endif
shiqian's avatar
shiqian committed
603

604
605
606
607
608
609
// A macro to disallow operator=
// This should be used in the private: declarations for a class.
#define GTEST_DISALLOW_ASSIGN_(type)\
  void operator=(type const &)

// A macro to disallow copy constructor and operator=
shiqian's avatar
shiqian committed
610
// This should be used in the private: declarations for a class.
shiqian's avatar
shiqian committed
611
#define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
612
613
  type(type const &);\
  GTEST_DISALLOW_ASSIGN_(type)
shiqian's avatar
shiqian committed
614
615
616
617
618

// 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
619
//   Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
shiqian's avatar
shiqian committed
620
#if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
621
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
shiqian's avatar
shiqian committed
622
#else
623
# define GTEST_MUST_USE_RESULT_
shiqian's avatar
shiqian committed
624
#endif  // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
shiqian's avatar
shiqian committed
625

626
627
628
629
630
631
// 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.

632
# if defined(_MSC_VER) || defined(__BORLANDC__)
633
// These two compilers are known to support SEH.
634
635
#  define GTEST_HAS_SEH 1
# else
636
// Assume no SEH.
637
638
#  define GTEST_HAS_SEH 0
# endif
639
640
641

#endif  // GTEST_HAS_SEH

642
643
#ifdef _MSC_VER

644
645
646
647
648
# if GTEST_LINKED_AS_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
#  define GTEST_API_ __declspec(dllexport)
# endif
649
650
651
652

#endif  // _MSC_VER

#ifndef GTEST_API_
653
# define GTEST_API_
654
655
#endif

shiqian's avatar
shiqian committed
656
657
658
659
660
661
662
663
namespace testing {

class Message;

namespace internal {

class String;

664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
// The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time
// expression is true. For example, you could use it to verify the
// size of a static array:
//
//   GTEST_COMPILE_ASSERT_(ARRAYSIZE(content_type_names) == CONTENT_NUM_TYPES,
//                         content_type_names_incorrect_size);
//
// or to make sure a struct is smaller than a certain size:
//
//   GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large);
//
// The second argument to the macro is the name of the variable. If
// the expression is false, most compilers will issue a warning/error
// containing the name of the variable.

template <bool>
struct CompileAssert {
};

#define GTEST_COMPILE_ASSERT_(expr, msg) \
  typedef ::testing::internal::CompileAssert<(bool(expr))> \
      msg[bool(expr) ? 1 : -1]

// Implementation details of GTEST_COMPILE_ASSERT_:
//
// - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1
//   elements (and thus is invalid) when the expression is false.
//
// - The simpler definition
//
//    #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1]
//
//   does not work, as gcc supports variable-length arrays whose sizes
//   are determined at run-time (this is gcc's extension and not part
//   of the C++ standard).  As a result, gcc fails to reject the
//   following code with the simple definition:
//
//     int foo;
//     GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is
//                                      // not a compile-time constant.
//
// - By using the type CompileAssert<(bool(expr))>, we ensures that
//   expr is a compile-time constant.  (Template arguments must be
//   determined at compile-time.)
//
// - The outter parentheses in CompileAssert<(bool(expr))> are necessary
//   to work around a bug in gcc 3.4.4 and 4.0.1.  If we had written
//
//     CompileAssert<bool(expr)>
//
//   instead, these compilers will refuse to compile
//
//     GTEST_COMPILE_ASSERT_(5 > 0, some_message);
//
//   (They seem to think the ">" in "5 > 0" marks the end of the
//   template argument list.)
//
// - The array size is (bool(expr) ? 1 : -1), instead of simply
//
//     ((expr) ? 1 : -1).
//
//   This is to avoid running into a bug in MS VC 7.1, which
//   causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1.

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

template <typename T>
struct StaticAssertTypeEqHelper<T, T> {};

#if GTEST_HAS_GLOBAL_STRING
typedef ::string string;
#else
typedef ::std::string string;
#endif  // GTEST_HAS_GLOBAL_STRING

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

749
750
// A helper for suppressing warnings on constant condition.  It just
// returns 'condition'.
751
GTEST_API_ bool IsTrue(bool condition);
752

shiqian's avatar
shiqian committed
753
754
755
756
757
758
759
// Defines scoped_ptr.

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

shiqian's avatar
shiqian committed
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
  explicit scoped_ptr(T* p = NULL) : ptr_(p) {}
  ~scoped_ptr() { reset(); }

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

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

  void reset(T* p = NULL) {
    if (p != ptr_) {
777
      if (IsTrue(sizeof(T) > 0)) {  // Makes sure T is a complete type.
shiqian's avatar
shiqian committed
778
779
780
781
782
783
784
785
        delete ptr_;
      }
      ptr_ = p;
    }
  }
 private:
  T* ptr_;

shiqian's avatar
shiqian committed
786
  GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr);
shiqian's avatar
shiqian committed
787
788
};

789
// Defines RE.
shiqian's avatar
shiqian committed
790

791
// A simple C++ wrapper for <regex.h>.  It uses the POSIX Extended
shiqian's avatar
shiqian committed
792
// Regular Expression syntax.
793
class GTEST_API_ RE {
shiqian's avatar
shiqian committed
794
 public:
795
796
797
798
  // 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
799
800
801
802
  // Constructs an RE from a string.
  RE(const ::std::string& regex) { Init(regex.c_str()); }  // NOLINT

#if GTEST_HAS_GLOBAL_STRING
803

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

shiqian's avatar
shiqian committed
806
807
808
809
810
811
812
813
#endif  // GTEST_HAS_GLOBAL_STRING

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

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

814
815
816
817
818
819
820
821
822
823
  // FullMatch(str, re) returns true iff regular expression re matches
  // the entire str.
  // PartialMatch(str, re) returns true iff regular expression re
  // matches a substring of str (including str itself).
  //
  // TODO(wan@google.com): make FullMatch() and PartialMatch() work
  // when str contains NUL characters.
  static bool FullMatch(const ::std::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
824
825
826
827
828
  static bool PartialMatch(const ::std::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }

#if GTEST_HAS_GLOBAL_STRING
829

830
831
832
  static bool FullMatch(const ::string& str, const RE& re) {
    return FullMatch(str.c_str(), re);
  }
shiqian's avatar
shiqian committed
833
834
835
  static bool PartialMatch(const ::string& str, const RE& re) {
    return PartialMatch(str.c_str(), re);
  }
836

shiqian's avatar
shiqian committed
837
838
#endif  // GTEST_HAS_GLOBAL_STRING

839
  static bool FullMatch(const char* str, const RE& re);
shiqian's avatar
shiqian committed
840
841
842
843
844
845
846
847
848
849
  static bool PartialMatch(const char* str, const RE& re);

 private:
  void Init(const char* regex);

  // We use a const char* instead of a string, as Google Test may be used
  // where string is not available.  We also do not use Google Test's own
  // String type here, in order to simplify dependencies between the
  // files.
  const char* pattern_;
850
  bool is_valid_;
851

852
#if GTEST_USES_POSIX_RE
853

854
855
  regex_t full_regex_;     // For FullMatch().
  regex_t partial_regex_;  // For PartialMatch().
856

857
#else  // GTEST_USES_SIMPLE_RE
858

859
  const char* full_pattern_;  // For FullMatch();
860

861
#endif
shiqian's avatar
shiqian committed
862

863
  GTEST_DISALLOW_ASSIGN_(RE);
864
};
shiqian's avatar
shiqian committed
865

866
867
868
869
870
871
872
873
874
875
// 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
876
// Defines logging utilities:
877
878
//   GTEST_LOG_(severity) - logs messages at the specified severity level. The
//                          message itself is streamed into the macro.
shiqian's avatar
shiqian committed
879
880
881
882
883
884
885
886
887
888
//   LogToStderr()  - directs all log messages to stderr.
//   FlushInfoLog() - flushes informational log messages.

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

889
890
891
// 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.
892
class GTEST_API_ GTestLog {
893
894
895
896
897
898
899
900
901
902
903
904
905
 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
906

907
908
909
#define GTEST_LOG_(severity) \
    ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \
                                  __FILE__, __LINE__).GetStream()
shiqian's avatar
shiqian committed
910
911
912
913

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

914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
// INTERNAL IMPLEMENTATION - DO NOT USE.
//
// GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition
// is not satisfied.
//  Synopsys:
//    GTEST_CHECK_(boolean_condition);
//     or
//    GTEST_CHECK_(boolean_condition) << "Additional message";
//
//    This checks the condition and if the condition is not satisfied
//    it prints message about the condition violation, including the
//    condition itself, plus additional message streamed into it, if any,
//    and then it aborts the program. It aborts the program irrespective of
//    whether it is built in the debug mode or not.
#define GTEST_CHECK_(condition) \
    GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
    if (::testing::internal::IsTrue(condition)) \
      ; \
    else \
      GTEST_LOG_(FATAL) << "Condition " #condition " failed. "

935
936
937
938
939
940
941
942
943
944
// 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

945
946
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
947
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
948
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
949
950
// const Foo*).  When you use ImplicitCast_, the compiler checks that
// the cast is safe.  Such explicit ImplicitCast_s are necessary in
951
952
953
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
954
// The syntax for using ImplicitCast_ is the same as for static_cast:
955
//
956
//   ImplicitCast_<ToType>(expr)
957
//
958
// ImplicitCast_ would have been part of the C++ standard library,
959
960
// but the proposal was submitted too late.  It will probably make
// its way into the language in the future.
961
962
963
964
//
// 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.
965
template<typename To>
966
inline To ImplicitCast_(To x) { return x; }
967
968

// When you upcast (that is, cast a pointer from type Foo to type
969
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
// 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.
985
986
987
988
989
990
//
// 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
991
992
993
994
995
996
  // Ensures that To is a sub-type of From *.  This test is here only
  // for compile-time type checking, and has no overhead in an
  // optimized build at run-time, as it will be optimized away
  // completely.
  if (false) {
    const To to = NULL;
997
    ::testing::internal::ImplicitCast_<From*>(to);
998
999
1000
1001
1002
1003
1004
1005
1006
  }

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

1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
// Downcasts the pointer of type Base to Derived.
// Derived must be a subclass of Base. The parameter MUST
// point to a class of type Derived, not any subclass of it.
// When RTTI is available, the function performs a runtime
// check to enforce this.
template <class Derived, class Base>
Derived* CheckedDowncastToActualType(Base* base) {
#if GTEST_HAS_RTTI
  GTEST_CHECK_(typeid(*base) == typeid(Derived));
  return dynamic_cast<Derived*>(base);  // NOLINT
#else
  return static_cast<Derived*>(base);  // Poor man's downcast.
1019
#endif
1020
1021
}

1022
#if GTEST_HAS_STREAM_REDIRECTION
1023

shiqian's avatar
shiqian committed
1024
// Defines the stderr capturer:
1025
1026
//   CaptureStdout     - starts capturing stdout.
//   GetCapturedStdout - stops capturing stdout and returns the captured string.
shiqian's avatar
shiqian committed
1027
1028
//   CaptureStderr     - starts capturing stderr.
//   GetCapturedStderr - stops capturing stderr and returns the captured string.
1029
//
zhanyong.wan's avatar
zhanyong.wan committed
1030
1031
1032
1033
GTEST_API_ void CaptureStdout();
GTEST_API_ String GetCapturedStdout();
GTEST_API_ void CaptureStderr();
GTEST_API_ String GetCapturedStderr();
1034

1035
#endif  // GTEST_HAS_STREAM_REDIRECTION
1036
1037


zhanyong.wan's avatar
zhanyong.wan committed
1038
#if GTEST_HAS_DEATH_TEST
shiqian's avatar
shiqian committed
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049

// A copy of all command line arguments.  Set by InitGoogleTest().
extern ::std::vector<String> g_argvs;

// GTEST_HAS_DEATH_TEST implies we have ::std::string.
const ::std::vector<String>& GetArgvs();

#endif  // GTEST_HAS_DEATH_TEST

// Defines synchronization primitives.

1050
1051
#if GTEST_HAS_PTHREAD

1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
// Sleeps for (roughly) n milli-seconds.  This function is only for
// testing Google Test's own constructs.  Don't use it in user tests,
// either directly or indirectly.
inline void SleepMilliseconds(int n) {
  const timespec time = {
    0,                  // 0 seconds.
    n * 1000L * 1000L,  // And n ms.
  };
  nanosleep(&time, NULL);
}

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

  // Notifies all threads created with this notification to start. Must
  // be called from the controller thread.
  void Notify() { notified_ = true; }

  // Blocks until the controller thread notifies. Must be called from a test
  // thread.
  void WaitForNotification() {
    while(!notified_) {
      SleepMilliseconds(10);
    }
  }

 private:
  volatile bool notified_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification);
};

1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
// As a C-function, ThreadFuncWithCLinkage cannot be templated itself.
// Consequently, it cannot select a correct instantiation of ThreadWithParam
// in order to call its Run(). Introducing ThreadWithParamBase as a
// non-templated base class for ThreadWithParam allows us to bypass this
// problem.
class ThreadWithParamBase {
 public:
  virtual ~ThreadWithParamBase() {}
  virtual void Run() = 0;
};

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

1113
// Helper class for testing Google Test's multi-threading constructs.
zhanyong.wan's avatar
zhanyong.wan committed
1114
// To use it, write:
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
//
//   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>
1126
class ThreadWithParam : public ThreadWithParamBase {
1127
1128
1129
 public:
  typedef void (*UserThreadFunc)(T);

zhanyong.wan's avatar
zhanyong.wan committed
1130
  ThreadWithParam(
1131
1132
1133
1134
      UserThreadFunc func, T param, Notification* thread_can_start)
      : func_(func),
        param_(param),
        thread_can_start_(thread_can_start),
zhanyong.wan's avatar
zhanyong.wan committed
1135
        finished_(false) {
1136
    ThreadWithParamBase* const base = this;
zhanyong.wan's avatar
zhanyong.wan committed
1137
1138
1139
    // The thread can be created only after all fields except thread_
    // have been initialized.
    GTEST_CHECK_POSIX_SUCCESS_(
1140
        pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base));
zhanyong.wan's avatar
zhanyong.wan committed
1141
1142
  }
  ~ThreadWithParam() { Join(); }
1143
1144
1145

  void Join() {
    if (!finished_) {
zhanyong.wan's avatar
zhanyong.wan committed
1146
      GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0));
1147
1148
1149
1150
      finished_ = true;
    }
  }

1151
  virtual void Run() {
1152
1153
1154
1155
1156
    if (thread_can_start_ != NULL)
      thread_can_start_->WaitForNotification();
    func_(param_);
  }

1157
 private:
1158
1159
1160
1161
1162
1163
  const UserThreadFunc func_;  // User-supplied thread function.
  const T param_;  // User-supplied parameter to the thread function.
  // When non-NULL, used to block execution until the controller thread
  // notifies.
  Notification* const thread_can_start_;
  bool finished_;  // true iff we know that the thread function has finished.
zhanyong.wan's avatar
zhanyong.wan committed
1164
1165
1166
  pthread_t thread_;  // The native thread object.

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam);
1167
1168
};

1169
1170
1171
// MutexBase and Mutex implement mutex on pthreads-based platforms. They
// are used in conjunction with class MutexLock:
//
1172
1173
1174
1175
//   Mutex mutex;
//   ...
//   MutexLock lock(&mutex);  // Acquires the mutex and releases it at the end
//                            // of the current scope.
1176
1177
//
// MutexBase implements behavior for both statically and dynamically
1178
1179
// allocated mutexes.  Do not use MutexBase directly.  Instead, write
// the following to define a static mutex:
1180
//
1181
//   GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
1182
//
1183
// You can forward declare a static mutex like this:
1184
//
1185
//   GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
1186
//
1187
// To create a dynamic mutex, just define an object of type Mutex.
1188
1189
class MutexBase {
 public:
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
  // Acquires this mutex.
  void Lock() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_));
    owner_ = pthread_self();
  }

  // Releases this mutex.
  void Unlock() {
    // We don't protect writing to owner_ here, as it's the caller's
    // responsibility to ensure that the current thread holds the
    // mutex when this is called.
    owner_ = 0;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_));
  }
1204
1205
1206

  // Does nothing if the current thread holds the mutex. Otherwise, crashes
  // with high probability.
1207
1208
1209
1210
  void AssertHeld() const {
    GTEST_CHECK_(owner_ == pthread_self())
        << "The current thread is not holding the mutex @" << this;
  }
1211

1212
1213
1214
1215
1216
  // 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.
1217
 public:
1218
1219
  pthread_mutex_t mutex_;  // The underlying pthread mutex.
  pthread_t owner_;  // The thread holding the mutex; 0 means no one holds it.
1220
1221
1222
};

// Forward-declares a static mutex.
1223
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
1224
1225
    extern ::testing::internal::MutexBase mutex

1226
// Defines and statically (i.e. at link time) initializes a static mutex.
1227
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
1228
1229
    ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, 0 }

1230
1231
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
1232
1233
class Mutex : public MutexBase {
 public:
1234
1235
1236
1237
1238
1239
1240
  Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL));
    owner_ = 0;
  }
  ~Mutex() {
    GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_));
  }
1241
1242
1243
1244
1245

 private:
  GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex);
};

1246
// We cannot name this class MutexLock as the ctor declaration would
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
// conflict with a macro named MutexLock, which is defined on some
// platforms.  Hence the typedef trick below.
class GTestMutexLock {
 public:
  explicit GTestMutexLock(MutexBase* mutex)
      : mutex_(mutex) { mutex_->Lock(); }

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

 private:
  MutexBase* const mutex_;

  GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock);
};

typedef GTestMutexLock MutexLock;

1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
// 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);
}

1281
1282
// Implements thread-local storage on pthreads-based systems.
//
1283
1284
//   // Thread 1
//   ThreadLocal<int> tl(100);  // 100 is the default value for each thread.
1285
//
1286
1287
1288
//   // Thread 2
//   tl.set(150);  // Changes the value for thread 2 only.
//   EXPECT_EQ(150, tl.get());
1289
//
1290
1291
1292
1293
//   // Thread 1
//   EXPECT_EQ(100, tl.get());  // In thread 1, tl has the original value.
//   tl.set(200);
//   EXPECT_EQ(200, tl.get());
1294
//
1295
1296
// The template type argument T must have a public copy constructor.
// In addition, the default ThreadLocal constructor requires T to have
zhanyong.wan's avatar
zhanyong.wan committed
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
// a public default constructor.
//
// An object managed for a thread by a ThreadLocal instance is deleted
// when the thread exits.  Or, if the ThreadLocal instance dies in
// that thread, when the ThreadLocal dies.  It's the user's
// responsibility to ensure that all other threads using a ThreadLocal
// have exited when it dies, or the per-thread objects for those
// threads will not be deleted.
//
// Google Test only uses global ThreadLocal objects.  That means they
// will die after main() has returned.  Therefore, no per-thread
// object managed by Google Test will be leaked as long as all threads
// using Google Test have exited when main() returns.
1310
1311
1312
template <typename T>
class ThreadLocal {
 public:
1313
1314
1315
1316
  ThreadLocal() : key_(CreateKey()),
                  default_() {}
  explicit ThreadLocal(const T& value) : key_(CreateKey()),
                                         default_(value) {}
1317
1318

  ~ThreadLocal() {
zhanyong.wan's avatar
zhanyong.wan committed
1319
1320
1321
1322
1323
    // 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.
1324
    GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_));
1325
1326
1327
1328
1329
1330
1331
1332
  }

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

 private:
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
  // Holds a value of type T.
  class ValueHolder : public ThreadLocalValueHolderBase {
   public:
    explicit ValueHolder(const T& value) : value_(value) {}

    T* pointer() { return &value_; }

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

1345
1346
  static pthread_key_t CreateKey() {
    pthread_key_t key;
zhanyong.wan's avatar
zhanyong.wan committed
1347
1348
    // When a thread exits, DeleteThreadLocalValue() will be called on
    // the object managed for that thread.
1349
1350
    GTEST_CHECK_POSIX_SUCCESS_(
        pthread_key_create(&key, &DeleteThreadLocalValue));
1351
1352
1353
1354
    return key;
  }

  T* GetOrCreateValue() const {
1355
1356
1357
1358
1359
    ThreadLocalValueHolderBase* const holder =
        static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_));
    if (holder != NULL) {
      return CheckedDowncastToActualType<ValueHolder>(holder)->pointer();
    }
1360

1361
1362
1363
1364
    ValueHolder* const new_holder = new ValueHolder(default_);
    ThreadLocalValueHolderBase* const holder_base = new_holder;
    GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base));
    return new_holder->pointer();
1365
1366
1367
1368
  }

  // A key pthreads uses for looking up per-thread values.
  const pthread_key_t key_;
1369
  const T default_;  // The default value for each thread.
1370
1371
1372
1373

  GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal);
};

1374
# define GTEST_IS_THREADSAFE 1
1375
1376
1377

#else  // GTEST_HAS_PTHREAD

shiqian's avatar
shiqian committed
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
// 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() {}
  void AssertHeld() const {}
};

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

1392
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
1393

shiqian's avatar
shiqian committed
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
class GTestMutexLock {
 public:
  explicit GTestMutexLock(Mutex*) {}  // NOLINT
};

typedef GTestMutexLock MutexLock;

template <typename T>
class ThreadLocal {
 public:
shiqian's avatar
shiqian committed
1404
1405
  ThreadLocal() : value_() {}
  explicit ThreadLocal(const T& value) : value_(value) {}
shiqian's avatar
shiqian committed
1406
1407
1408
1409
1410
1411
1412
1413
  T* pointer() { return &value_; }
  const T* pointer() const { return &value_; }
  const T& get() const { return value_; }
  void set(const T& value) { value_ = value; }
 private:
  T value_;
};

shiqian's avatar
shiqian committed
1414
1415
// The above synchronization primitives have dummy implementations.
// Therefore Google Test is not thread-safe.
1416
# define GTEST_IS_THREADSAFE 0
shiqian's avatar
shiqian committed
1417

1418
1419
1420
1421
#endif  // GTEST_HAS_PTHREAD

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

1424
// Passing non-POD classes through ellipsis (...) crashes the ARM
1425
1426
1427
1428
1429
1430
// compiler and generates a warning in Sun Studio.  The Nokia Symbian
// and the IBM XL C/C++ compiler try to instantiate a copy constructor
// for objects passed through ellipsis (...), failing for uncopyable
// objects.  We define this to ensure that only POD is passed through
// ellipsis on these systems.
#if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC)
1431
1432
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
1433
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
1434
#else
1435
# define GTEST_CAN_COMPARE_NULL 1
1436
#endif
shiqian's avatar
shiqian committed
1437

1438
1439
1440
1441
// 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.
1442
#if defined(__SYMBIAN32__) || defined(__IBMCPP__)
1443
# define GTEST_NEEDS_IS_POINTER_ 1
1444
#endif
shiqian's avatar
shiqian committed
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461

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

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

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

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

1462
#if GTEST_OS_WINDOWS
1463
1464
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
1465
1466
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt;
1467
#else
1468
1469
# define GTEST_PATH_SEP_ "/"
# define GTEST_HAS_ALT_PATH_SEP_ 0
1470
typedef long long BiggestInt;  // NOLINT
1471
1472
#endif  // GTEST_OS_WINDOWS

1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
// 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;
}
1498
1499
1500
inline bool IsXDigit(char ch) {
  return isxdigit(static_cast<unsigned char>(ch)) != 0;
}
1501
1502
1503
1504
1505
1506
1507
1508

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

1509
1510
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions.  These wrappers hide the differences between
1511
1512
1513
1514
// 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.

1515
1516
1517
1518
namespace posix {

// Functions with a different name on Windows.

zhanyong.wan's avatar
zhanyong.wan committed
1519
#if GTEST_OS_WINDOWS
1520

1521
typedef struct _stat StatStruct;
1522

1523
# ifdef __BORLANDC__
1524
1525
1526
1527
1528
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); }
1529
1530
# else  // !__BORLANDC__
#  if GTEST_OS_WINDOWS_MOBILE
1531
inline int IsATTY(int /* fd */) { return 0; }
1532
#  else
1533
inline int IsATTY(int fd) { return _isatty(fd); }
1534
#  endif  // GTEST_OS_WINDOWS_MOBILE
1535
1536
inline int StrCaseCmp(const char* s1, const char* s2) {
  return _stricmp(s1, s2);
1537
}
1538
inline char* StrDup(const char* src) { return _strdup(src); }
1539
# endif  // __BORLANDC__
1540

1541
# if GTEST_OS_WINDOWS_MOBILE
1542
1543
1544
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.
1545
# else
1546
1547
inline int FileNo(FILE* file) { return _fileno(file); }
inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); }
1548
1549
inline int RmDir(const char* dir) { return _rmdir(dir); }
inline bool IsDir(const StatStruct& st) {
1550
1551
  return (_S_IFDIR & st.st_mode) != 0;
}
1552
# endif  // GTEST_OS_WINDOWS_MOBILE
1553

shiqian's avatar
shiqian committed
1554
#else
1555

1556
typedef struct stat StatStruct;
1557

1558
1559
1560
1561
1562
1563
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);
}
1564
inline char* StrDup(const char* src) { return strdup(src); }
1565
1566
inline int RmDir(const char* dir) { return rmdir(dir); }
inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); }
1567

shiqian's avatar
shiqian committed
1568
1569
#endif  // GTEST_OS_WINDOWS

1570
1571
1572
1573
// Functions deprecated by MSVC 8.0.

#ifdef _MSC_VER
// Temporarily disable warning 4996 (deprecated function).
1574
1575
# pragma warning(push)
# pragma warning(disable:4996)
1576
1577
#endif

1578
1579
inline const char* StrNCpy(char* dest, const char* src, size_t n) {
  return strncpy(dest, src, n);
1580
}
1581
1582
1583
1584
1585

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

1586
#if !GTEST_OS_WINDOWS_MOBILE
1587
inline int ChDir(const char* dir) { return chdir(dir); }
1588
#endif
1589
1590
inline FILE* FOpen(const char* path, const char* mode) {
  return fopen(path, mode);
1591
}
1592
#if !GTEST_OS_WINDOWS_MOBILE
1593
1594
inline FILE *FReopen(const char* path, const char* mode, FILE* stream) {
  return freopen(path, mode, stream);
1595
}
1596
inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); }
1597
#endif
1598
inline int FClose(FILE* fp) { return fclose(fp); }
1599
#if !GTEST_OS_WINDOWS_MOBILE
1600
1601
inline int Read(int fd, void* buf, unsigned int count) {
  return static_cast<int>(read(fd, buf, count));
1602
}
1603
1604
inline int Write(int fd, const void* buf, unsigned int count) {
  return static_cast<int>(write(fd, buf, count));
1605
}
1606
1607
inline int Close(int fd) { return close(fd); }
inline const char* StrError(int errnum) { return strerror(errnum); }
1608
#endif
1609
inline const char* GetEnv(const char* name) {
1610
1611
#if GTEST_OS_WINDOWS_MOBILE
  // We are on Windows CE, which has no environment variables.
1612
  return NULL;
1613
#elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
1614
1615
1616
1617
  // Environment variables which we programmatically clear will be set to the
  // empty string rather than unset (NULL).  Handle that case.
  const char* const env = getenv(name);
  return (env != NULL && env[0] != '\0') ? env : NULL;
1618
#else
1619
  return getenv(name);
1620
1621
1622
1623
#endif
}

#ifdef _MSC_VER
1624
# pragma warning(pop)  // Restores the warning state.
1625
1626
#endif

1627
#if GTEST_OS_WINDOWS_MOBILE
1628
1629
1630
// 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.
1631
void Abort();
1632
#else
1633
inline void Abort() { abort(); }
1634
#endif  // GTEST_OS_WINDOWS_MOBILE
1635
1636
1637

}  // namespace posix

shiqian's avatar
shiqian committed
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
// 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:
1690

zhanyong.wan's avatar
zhanyong.wan committed
1691
#if GTEST_OS_WINDOWS
shiqian's avatar
shiqian committed
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
  typedef __int64 Int;
  typedef unsigned __int64 UInt;
#else
  typedef long long Int;  // NOLINT
  typedef unsigned long long UInt;  // NOLINT
#endif  // GTEST_OS_WINDOWS
};

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

// Utilities for command line flags and environment variables.

// Macro for referencing flags.
#define GTEST_FLAG(name) FLAGS_gtest_##name

// Macros for declaring flags.
1713
#define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1714
#define GTEST_DECLARE_int32_(name) \
1715
    GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1716
#define GTEST_DECLARE_string_(name) \
1717
    GTEST_API_ extern ::testing::internal::String GTEST_FLAG(name)
shiqian's avatar
shiqian committed
1718
1719

// Macros for defining flags.
shiqian's avatar
shiqian committed
1720
#define GTEST_DEFINE_bool_(name, default_val, doc) \
1721
    GTEST_API_ bool GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1722
#define GTEST_DEFINE_int32_(name, default_val, doc) \
1723
    GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1724
#define GTEST_DEFINE_string_(name, default_val, doc) \
1725
    GTEST_API_ ::testing::internal::String GTEST_FLAG(name) = (default_val)
shiqian's avatar
shiqian committed
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737

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

// Parses a bool/Int32/string from the environment variable
// corresponding to the given Google Test flag.
bool BoolFromGTestEnv(const char* flag, bool default_val);
zhanyong.wan's avatar
zhanyong.wan committed
1738
GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val);
shiqian's avatar
shiqian committed
1739
1740
1741
1742
1743
1744
const char* StringFromGTestEnv(const char* flag, const char* default_val);

}  // namespace internal
}  // namespace testing

#endif  // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_