1 // Copyright 2005, Google Inc. 2 // All rights reserved. 3 // 4 // Redistribution and use in source and binary forms, with or without 5 // modification, are permitted provided that the following conditions are 6 // met: 7 // 8 // * Redistributions of source code must retain the above copyright 9 // notice, this list of conditions and the following disclaimer. 10 // * Redistributions in binary form must reproduce the above 11 // copyright notice, this list of conditions and the following disclaimer 12 // in the documentation and/or other materials provided with the 13 // distribution. 14 // * Neither the name of Google Inc. nor the names of its 15 // contributors may be used to endorse or promote products derived from 16 // this software without specific prior written permission. 17 // 18 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29 // 30 // Authors: wan (at) google.com (Zhanyong Wan) 31 // 32 // Low-level types and utilities for porting Google Test to various 33 // platforms. They are subject to change without notice. DO NOT USE 34 // THEM IN USER CODE. 35 36 #ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_ 37 #define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_ 38 39 // The user can define the following macros in the build script to 40 // control Google Test's behavior. If the user doesn't define a macro 41 // in this list, Google Test will define it. 42 // 43 // GTEST_HAS_CLONE - Define it to 1/0 to indicate that clone(2) 44 // is/isn't available. 45 // GTEST_HAS_EXCEPTIONS - Define it to 1/0 to indicate that exceptions 46 // are enabled. 47 // GTEST_HAS_GLOBAL_STRING - Define it to 1/0 to indicate that ::string 48 // is/isn't available (some systems define 49 // ::string, which is different to std::string). 50 // GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string 51 // is/isn't available (some systems define 52 // ::wstring, which is different to std::wstring). 53 // GTEST_HAS_POSIX_RE - Define it to 1/0 to indicate that POSIX regular 54 // expressions are/aren't available. 55 // GTEST_HAS_PTHREAD - Define it to 1/0 to indicate that <pthread.h> 56 // is/isn't available. 57 // GTEST_HAS_RTTI - Define it to 1/0 to indicate that RTTI is/isn't 58 // enabled. 59 // GTEST_HAS_STD_WSTRING - Define it to 1/0 to indicate that 60 // std::wstring does/doesn't work (Google Test can 61 // 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 // GTEST_HAS_SEH - Define it to 1/0 to indicate whether the 65 // compiler supports Microsoft's "Structured 66 // Exception Handling". 67 // GTEST_HAS_STREAM_REDIRECTION 68 // - Define it to 1/0 to indicate whether the 69 // platform supports I/O stream redirection using 70 // dup() and dup2(). 71 // GTEST_USE_OWN_TR1_TUPLE - Define it to 1/0 to indicate whether Google 72 // Test's own tr1 tuple implementation should be 73 // used. Unused when the user sets 74 // GTEST_HAS_TR1_TUPLE to 0. 75 // GTEST_LINKED_AS_SHARED_LIBRARY 76 // - Define to 1 when compiling tests that use 77 // Google Test as a shared library (known as 78 // DLL on Windows). 79 // GTEST_CREATE_SHARED_LIBRARY 80 // - Define to 1 when compiling Google Test itself 81 // as a shared library. 82 83 // This header defines the following utilities: 84 // 85 // Macros indicating the current platform (defined to 1 if compiled on 86 // the given platform; otherwise undefined): 87 // GTEST_OS_AIX - IBM AIX 88 // GTEST_OS_CYGWIN - Cygwin 89 // GTEST_OS_HPUX - HP-UX 90 // GTEST_OS_LINUX - Linux 91 // GTEST_OS_LINUX_ANDROID - Google Android 92 // GTEST_OS_MAC - Mac OS X 93 // GTEST_OS_NACL - Google Native Client (NaCl) 94 // GTEST_OS_OPENBSD - OpenBSD 95 // GTEST_OS_QNX - QNX 96 // GTEST_OS_SOLARIS - Sun Solaris 97 // GTEST_OS_SYMBIAN - Symbian 98 // GTEST_OS_WINDOWS - Windows (Desktop, MinGW, or Mobile) 99 // GTEST_OS_WINDOWS_DESKTOP - Windows Desktop 100 // GTEST_OS_WINDOWS_MINGW - MinGW 101 // GTEST_OS_WINDOWS_MOBILE - Windows Mobile 102 // GTEST_OS_ZOS - z/OS 103 // 104 // Among the platforms, Cygwin, Linux, Max OS X, and Windows have the 105 // most stable support. Since core members of the Google Test project 106 // don't have access to other platforms, support for them may be less 107 // stable. If you notice any problems on your platform, please notify 108 // googletestframework (at) googlegroups.com (patches for fixing them are 109 // even more welcome!). 110 // 111 // Note that it is possible that none of the GTEST_OS_* macros are defined. 112 // 113 // Macros indicating available Google Test features (defined to 1 if 114 // the corresponding feature is supported; otherwise undefined): 115 // GTEST_HAS_COMBINE - the Combine() function (for value-parameterized 116 // tests) 117 // GTEST_HAS_DEATH_TEST - death tests 118 // GTEST_HAS_PARAM_TEST - value-parameterized tests 119 // GTEST_HAS_TYPED_TEST - typed tests 120 // GTEST_HAS_TYPED_TEST_P - type-parameterized tests 121 // GTEST_USES_POSIX_RE - enhanced POSIX regex is used. Do not confuse with 122 // GTEST_HAS_POSIX_RE (see above) which users can 123 // define themselves. 124 // GTEST_USES_SIMPLE_RE - our own simple regex is used; 125 // the above two are mutually exclusive. 126 // GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ(). 127 // 128 // Macros for basic C++ coding: 129 // GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning. 130 // GTEST_ATTRIBUTE_UNUSED_ - declares that a class' instances or a 131 // variable don't have to be used. 132 // GTEST_DISALLOW_ASSIGN_ - disables operator=. 133 // GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=. 134 // GTEST_MUST_USE_RESULT_ - declares that a function's result must be used. 135 // 136 // Synchronization: 137 // Mutex, MutexLock, ThreadLocal, GetThreadCount() 138 // - synchronization primitives. 139 // GTEST_IS_THREADSAFE - defined to 1 to indicate that the above 140 // synchronization primitives have real implementations 141 // and Google Test is thread-safe; or 0 otherwise. 142 // 143 // Template meta programming: 144 // is_pointer - as in TR1; needed on Symbian and IBM XL C/C++ only. 145 // IteratorTraits - partial implementation of std::iterator_traits, which 146 // is not available in libCstd when compiled with Sun C++. 147 // 148 // Smart pointers: 149 // scoped_ptr - as in TR2. 150 // 151 // Regular expressions: 152 // RE - a simple regular expression class using the POSIX 153 // Extended Regular Expression syntax on UNIX-like 154 // platforms, or a reduced regular exception syntax on 155 // other platforms, including Windows. 156 // 157 // Logging: 158 // GTEST_LOG_() - logs messages at the specified severity level. 159 // LogToStderr() - directs all log messages to stderr. 160 // FlushInfoLog() - flushes informational log messages. 161 // 162 // Stdout and stderr capturing: 163 // CaptureStdout() - starts capturing stdout. 164 // GetCapturedStdout() - stops capturing stdout and returns the captured 165 // string. 166 // CaptureStderr() - starts capturing stderr. 167 // GetCapturedStderr() - stops capturing stderr and returns the captured 168 // string. 169 // 170 // Integer types: 171 // TypeWithSize - maps an integer to a int type. 172 // Int32, UInt32, Int64, UInt64, TimeInMillis 173 // - integers of known sizes. 174 // BiggestInt - the biggest signed integer type. 175 // 176 // Command-line utilities: 177 // GTEST_FLAG() - references a flag. 178 // GTEST_DECLARE_*() - declares a flag. 179 // GTEST_DEFINE_*() - defines a flag. 180 // GetInjectableArgvs() - returns the command line as a vector of strings. 181 // 182 // Environment variable utilities: 183 // GetEnv() - gets the value of an environment variable. 184 // BoolFromGTestEnv() - parses a bool environment variable. 185 // Int32FromGTestEnv() - parses an Int32 environment variable. 186 // StringFromGTestEnv() - parses a string environment variable. 187 188 #include <ctype.h> // for isspace, etc 189 #include <stddef.h> // for ptrdiff_t 190 #include <stdlib.h> 191 #include <stdio.h> 192 #include <string.h> 193 #ifndef _WIN32_WCE 194 # include <sys/types.h> 195 # include <sys/stat.h> 196 #endif // !_WIN32_WCE 197 198 #include <iostream> // NOLINT 199 #include <sstream> // NOLINT 200 #include <string> // NOLINT 201 202 #define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com" 203 #define GTEST_FLAG_PREFIX_ "gtest_" 204 #define GTEST_FLAG_PREFIX_DASH_ "gtest-" 205 #define GTEST_FLAG_PREFIX_UPPER_ "GTEST_" 206 #define GTEST_NAME_ "Google Test" 207 #define GTEST_PROJECT_URL_ "http://code.google.com/p/googletest/" 208 209 // Determines the version of gcc that is used to compile this. 210 #ifdef __GNUC__ 211 // 40302 means version 4.3.2. 212 # define GTEST_GCC_VER_ \ 213 (__GNUC__*10000 + __GNUC_MINOR__*100 + __GNUC_PATCHLEVEL__) 214 #endif // __GNUC__ 215 216 // Determines the platform on which Google Test is compiled. 217 #ifdef __CYGWIN__ 218 # define GTEST_OS_CYGWIN 1 219 #elif defined __SYMBIAN32__ 220 # define GTEST_OS_SYMBIAN 1 221 #elif defined _WIN32 222 # define GTEST_OS_WINDOWS 1 223 # ifdef _WIN32_WCE 224 # define GTEST_OS_WINDOWS_MOBILE 1 225 # elif defined(__MINGW__) || defined(__MINGW32__) 226 # define GTEST_OS_WINDOWS_MINGW 1 227 # else 228 # define GTEST_OS_WINDOWS_DESKTOP 1 229 # endif // _WIN32_WCE 230 #elif defined __APPLE__ 231 # define GTEST_OS_MAC 1 232 #elif defined __linux__ 233 # define GTEST_OS_LINUX 1 234 # ifdef ANDROID 235 # define GTEST_OS_LINUX_ANDROID 1 236 # endif // ANDROID 237 #elif defined __MVS__ 238 # define GTEST_OS_ZOS 1 239 #elif defined(__sun) && defined(__SVR4) 240 # define GTEST_OS_SOLARIS 1 241 #elif defined(_AIX) 242 # define GTEST_OS_AIX 1 243 #elif defined(__hpux) 244 # define GTEST_OS_HPUX 1 245 #elif defined __native_client__ 246 # define GTEST_OS_NACL 1 247 #elif defined __OpenBSD__ 248 # define GTEST_OS_OPENBSD 1 249 #elif defined __QNX__ 250 # define GTEST_OS_QNX 1 251 #endif // __CYGWIN__ 252 253 // Brings in definitions for functions used in the testing::internal::posix 254 // namespace (read, write, close, chdir, isatty, stat). We do not currently 255 // use them on Windows Mobile. 256 #if !GTEST_OS_WINDOWS 257 // This assumes that non-Windows OSes provide unistd.h. For OSes where this 258 // is not the case, we need to include headers that provide the functions 259 // mentioned above. 260 # include <unistd.h> 261 # if !GTEST_OS_NACL 262 // TODO(vladl (at) google.com): Remove this condition when Native Client SDK adds 263 // strings.h (tracked in 264 // http://code.google.com/p/nativeclient/issues/detail?id=1175). 265 # include <strings.h> // Native Client doesn't provide strings.h. 266 # endif 267 #elif !GTEST_OS_WINDOWS_MOBILE 268 # include <direct.h> 269 # include <io.h> 270 #endif 271 272 // Defines this to true iff Google Test can use POSIX regular expressions. 273 #ifndef GTEST_HAS_POSIX_RE 274 # define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS) 275 #endif 276 277 #if GTEST_HAS_POSIX_RE 278 279 // On some platforms, <regex.h> needs someone to define size_t, and 280 // won't compile otherwise. We can #include it here as we already 281 // included <stdlib.h>, which is guaranteed to define size_t through 282 // <stddef.h>. 283 # include <regex.h> // NOLINT 284 285 # define GTEST_USES_POSIX_RE 1 286 287 #elif GTEST_OS_WINDOWS 288 289 // <regex.h> is not available on Windows. Use our own simple regex 290 // implementation instead. 291 # define GTEST_USES_SIMPLE_RE 1 292 293 #else 294 295 // <regex.h> may not be available on this platform. Use our own 296 // simple regex implementation instead. 297 # define GTEST_USES_SIMPLE_RE 1 298 299 #endif // GTEST_HAS_POSIX_RE 300 301 #ifndef GTEST_HAS_EXCEPTIONS 302 // The user didn't tell us whether exceptions are enabled, so we need 303 // to figure it out. 304 # if defined(_MSC_VER) || defined(__BORLANDC__) 305 // MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS 306 // macro to enable exceptions, so we'll do the same. 307 // Assumes that exceptions are enabled by default. 308 # ifndef _HAS_EXCEPTIONS 309 # define _HAS_EXCEPTIONS 1 310 # endif // _HAS_EXCEPTIONS 311 # define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS 312 # elif defined(__GNUC__) && __EXCEPTIONS 313 // gcc defines __EXCEPTIONS to 1 iff exceptions are enabled. 314 # define GTEST_HAS_EXCEPTIONS 1 315 # elif defined(__SUNPRO_CC) 316 // Sun Pro CC supports exceptions. However, there is no compile-time way of 317 // detecting whether they are enabled or not. Therefore, we assume that 318 // they are enabled unless the user tells us otherwise. 319 # define GTEST_HAS_EXCEPTIONS 1 320 # elif defined(__IBMCPP__) && __EXCEPTIONS 321 // xlC defines __EXCEPTIONS to 1 iff exceptions are enabled. 322 # define GTEST_HAS_EXCEPTIONS 1 323 # elif defined(__HP_aCC) 324 // Exception handling is in effect by default in HP aCC compiler. It has to 325 // be turned of by +noeh compiler option if desired. 326 # define GTEST_HAS_EXCEPTIONS 1 327 # else 328 // For other compilers, we assume exceptions are disabled to be 329 // conservative. 330 # define GTEST_HAS_EXCEPTIONS 0 331 # endif // defined(_MSC_VER) || defined(__BORLANDC__) 332 #endif // GTEST_HAS_EXCEPTIONS 333 334 #if !defined(GTEST_HAS_STD_STRING) 335 // Even though we don't use this macro any longer, we keep it in case 336 // some clients still depend on it. 337 # define GTEST_HAS_STD_STRING 1 338 #elif !GTEST_HAS_STD_STRING 339 // The user told us that ::std::string isn't available. 340 # error "Google Test cannot be used where ::std::string isn't available." 341 #endif // !defined(GTEST_HAS_STD_STRING) 342 343 #ifndef GTEST_HAS_GLOBAL_STRING 344 // The user didn't tell us whether ::string is available, so we need 345 // to figure it out. 346 347 # define GTEST_HAS_GLOBAL_STRING 0 348 349 #endif // GTEST_HAS_GLOBAL_STRING 350 351 #ifndef GTEST_HAS_STD_WSTRING 352 // The user didn't tell us whether ::std::wstring is available, so we need 353 // to figure it out. 354 // TODO(wan (at) google.com): uses autoconf to detect whether ::std::wstring 355 // is available. 356 357 // Cygwin 1.7 and below doesn't support ::std::wstring. 358 // Solaris' libc++ doesn't support it either. Android has 359 // no support for it at least as recent as Froyo (2.2). 360 # define GTEST_HAS_STD_WSTRING \ 361 (!(GTEST_OS_LINUX_ANDROID || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS)) 362 363 #endif // GTEST_HAS_STD_WSTRING 364 365 #ifndef GTEST_HAS_GLOBAL_WSTRING 366 // The user didn't tell us whether ::wstring is available, so we need 367 // to figure it out. 368 # define GTEST_HAS_GLOBAL_WSTRING \ 369 (GTEST_HAS_STD_WSTRING && GTEST_HAS_GLOBAL_STRING) 370 #endif // GTEST_HAS_GLOBAL_WSTRING 371 372 // Determines whether RTTI is available. 373 #ifndef GTEST_HAS_RTTI 374 // The user didn't tell us whether RTTI is enabled, so we need to 375 // figure it out. 376 377 # ifdef _MSC_VER 378 379 # ifdef _CPPRTTI // MSVC defines this macro iff RTTI is enabled. 380 # define GTEST_HAS_RTTI 1 381 # else 382 # define GTEST_HAS_RTTI 0 383 # endif 384 385 // Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled. 386 # elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302) 387 388 # ifdef __GXX_RTTI 389 # define GTEST_HAS_RTTI 1 390 # else 391 # define GTEST_HAS_RTTI 0 392 # endif // __GXX_RTTI 393 394 // Clang defines __GXX_RTTI starting with version 3.0, but its manual recommends 395 // using has_feature instead. has_feature(cxx_rtti) is supported since 2.7, the 396 // first version with C++ support. 397 # elif defined(__clang__) 398 399 # define GTEST_HAS_RTTI __has_feature(cxx_rtti) 400 401 // Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if 402 // both the typeid and dynamic_cast features are present. 403 # elif defined(__IBMCPP__) && (__IBMCPP__ >= 900) 404 405 # ifdef __RTTI_ALL__ 406 # define GTEST_HAS_RTTI 1 407 # else 408 # define GTEST_HAS_RTTI 0 409 # endif 410 411 # else 412 413 // For all other compilers, we assume RTTI is enabled. 414 # define GTEST_HAS_RTTI 1 415 416 # endif // _MSC_VER 417 418 #endif // GTEST_HAS_RTTI 419 420 // It's this header's responsibility to #include <typeinfo> when RTTI 421 // is enabled. 422 #if GTEST_HAS_RTTI 423 # include <typeinfo> 424 #endif 425 426 // Determines whether Google Test can use the pthreads library. 427 #ifndef GTEST_HAS_PTHREAD 428 // The user didn't tell us explicitly, so we assume pthreads support is 429 // available on Linux and Mac. 430 // 431 // To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0 432 // to your compiler flags. 433 # define GTEST_HAS_PTHREAD (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_HPUX \ 434 || GTEST_OS_QNX) 435 #endif // GTEST_HAS_PTHREAD 436 437 #if GTEST_HAS_PTHREAD 438 // gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is 439 // true. 440 # include <pthread.h> // NOLINT 441 442 // For timespec and nanosleep, used below. 443 # include <time.h> // NOLINT 444 #endif 445 446 // Determines whether Google Test can use tr1/tuple. You can define 447 // this macro to 0 to prevent Google Test from using tuple (any 448 // feature depending on tuple with be disabled in this mode). 449 #ifndef GTEST_HAS_TR1_TUPLE 450 // The user didn't tell us not to do it, so we assume it's OK. 451 # define GTEST_HAS_TR1_TUPLE 1 452 #endif // GTEST_HAS_TR1_TUPLE 453 454 // Determines whether Google Test's own tr1 tuple implementation 455 // should be used. 456 #ifndef GTEST_USE_OWN_TR1_TUPLE 457 // The user didn't tell us, so we need to figure it out. 458 459 // We use our own TR1 tuple if we aren't sure the user has an 460 // implementation of it already. At this time, GCC 4.0.0+ and MSVC 461 // 2010 are the only mainstream compilers that come with a TR1 tuple 462 // implementation. NVIDIA's CUDA NVCC compiler pretends to be GCC by 463 // defining __GNUC__ and friends, but cannot compile GCC's tuple 464 // implementation. MSVC 2008 (9.0) provides TR1 tuple in a 323 MB 465 // Feature Pack download, which we cannot assume the user has. 466 // QNX's QCC compiler is a modified GCC but it doesn't support TR1 tuple. 467 # if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \ 468 && !GTEST_OS_QNX) || _MSC_VER >= 1600 469 # define GTEST_USE_OWN_TR1_TUPLE 0 470 # else 471 # define GTEST_USE_OWN_TR1_TUPLE 1 472 # endif 473 474 #endif // GTEST_USE_OWN_TR1_TUPLE 475 476 // To avoid conditional compilation everywhere, we make it 477 // gtest-port.h's responsibility to #include the header implementing 478 // tr1/tuple. 479 #if GTEST_HAS_TR1_TUPLE 480 481 # if GTEST_USE_OWN_TR1_TUPLE 482 # include "gtest/internal/gtest-tuple.h" 483 # elif GTEST_OS_SYMBIAN 484 485 // On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to 486 // use STLport's tuple implementation, which unfortunately doesn't 487 // work as the copy of STLport distributed with Symbian is incomplete. 488 // By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to 489 // use its own tuple implementation. 490 # ifdef BOOST_HAS_TR1_TUPLE 491 # undef BOOST_HAS_TR1_TUPLE 492 # endif // BOOST_HAS_TR1_TUPLE 493 494 // This prevents <boost/tr1/detail/config.hpp>, which defines 495 // BOOST_HAS_TR1_TUPLE, from being #included by Boost's <tuple>. 496 # define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED 497 # include <tuple> 498 499 # elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000) 500 // GCC 4.0+ implements tr1/tuple in the <tr1/tuple> header. This does 501 // not conform to the TR1 spec, which requires the header to be <tuple>. 502 503 # if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302 504 // Until version 4.3.2, gcc has a bug that causes <tr1/functional>, 505 // which is #included by <tr1/tuple>, to not compile when RTTI is 506 // disabled. _TR1_FUNCTIONAL is the header guard for 507 // <tr1/functional>. Hence the following #define is a hack to prevent 508 // <tr1/functional> from being included. 509 # define _TR1_FUNCTIONAL 1 510 # include <tr1/tuple> 511 # undef _TR1_FUNCTIONAL // Allows the user to #include 512 // <tr1/functional> if he chooses to. 513 # else 514 # include <tr1/tuple> // NOLINT 515 # endif // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302 516 517 # else 518 // If the compiler is not GCC 4.0+, we assume the user is using a 519 // spec-conforming TR1 implementation. 520 # include <tuple> // NOLINT 521 # endif // GTEST_USE_OWN_TR1_TUPLE 522 523 #endif // GTEST_HAS_TR1_TUPLE 524 525 // Determines whether clone(2) is supported. 526 // Usually it will only be available on Linux, excluding 527 // Linux on the Itanium architecture. 528 // Also see http://linux.die.net/man/2/clone. 529 #ifndef GTEST_HAS_CLONE 530 // The user didn't tell us, so we need to figure it out. 531 532 # if GTEST_OS_LINUX && !defined(__ia64__) 533 # define GTEST_HAS_CLONE 1 534 # else 535 # define GTEST_HAS_CLONE 0 536 # endif // GTEST_OS_LINUX && !defined(__ia64__) 537 538 #endif // GTEST_HAS_CLONE 539 540 // Determines whether to support stream redirection. This is used to test 541 // output correctness and to implement death tests. 542 #ifndef GTEST_HAS_STREAM_REDIRECTION 543 // By default, we assume that stream redirection is supported on all 544 // platforms except known mobile ones. 545 # if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN 546 # define GTEST_HAS_STREAM_REDIRECTION 0 547 # else 548 # define GTEST_HAS_STREAM_REDIRECTION 1 549 # endif // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN 550 #endif // GTEST_HAS_STREAM_REDIRECTION 551 552 // Determines whether to support death tests. 553 // Google Test does not support death tests for VC 7.1 and earlier as 554 // abort() in a VC 7.1 application compiled as GUI in debug config 555 // pops up a dialog window that cannot be suppressed programmatically. 556 #if (GTEST_OS_LINUX || GTEST_OS_MAC || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \ 557 (GTEST_OS_WINDOWS_DESKTOP && _MSC_VER >= 1400) || \ 558 GTEST_OS_WINDOWS_MINGW || GTEST_OS_AIX || GTEST_OS_HPUX || \ 559 GTEST_OS_OPENBSD || GTEST_OS_QNX) 560 # define GTEST_HAS_DEATH_TEST 1 561 # include <vector> // NOLINT 562 #endif 563 564 // We don't support MSVC 7.1 with exceptions disabled now. Therefore 565 // all the compilers we care about are adequate for supporting 566 // value-parameterized tests. 567 #define GTEST_HAS_PARAM_TEST 1 568 569 // Determines whether to support type-driven tests. 570 571 // Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0, 572 // Sun Pro CC, IBM Visual Age, and HP aCC support. 573 #if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \ 574 defined(__IBMCPP__) || defined(__HP_aCC) 575 # define GTEST_HAS_TYPED_TEST 1 576 # define GTEST_HAS_TYPED_TEST_P 1 577 #endif 578 579 // Determines whether to support Combine(). This only makes sense when 580 // value-parameterized tests are enabled. The implementation doesn't 581 // work on Sun Studio since it doesn't understand templated conversion 582 // operators. 583 #if GTEST_HAS_PARAM_TEST && GTEST_HAS_TR1_TUPLE && !defined(__SUNPRO_CC) 584 # define GTEST_HAS_COMBINE 1 585 #endif 586 587 // Determines whether the system compiler uses UTF-16 for encoding wide strings. 588 #define GTEST_WIDE_STRING_USES_UTF16_ \ 589 (GTEST_OS_WINDOWS || GTEST_OS_CYGWIN || GTEST_OS_SYMBIAN || GTEST_OS_AIX) 590 591 // Determines whether test results can be streamed to a socket. 592 #if GTEST_OS_LINUX 593 # define GTEST_CAN_STREAM_RESULTS_ 1 594 #endif 595 596 // Defines some utility macros. 597 598 // The GNU compiler emits a warning if nested "if" statements are followed by 599 // an "else" statement and braces are not used to explicitly disambiguate the 600 // "else" binding. This leads to problems with code like: 601 // 602 // if (gate) 603 // ASSERT_*(condition) << "Some message"; 604 // 605 // The "switch (0) case 0:" idiom is used to suppress this. 606 #ifdef __INTEL_COMPILER 607 # define GTEST_AMBIGUOUS_ELSE_BLOCKER_ 608 #else 609 # define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default: // NOLINT 610 #endif 611 612 // Use this annotation at the end of a struct/class definition to 613 // prevent the compiler from optimizing away instances that are never 614 // used. This is useful when all interesting logic happens inside the 615 // c'tor and / or d'tor. Example: 616 // 617 // struct Foo { 618 // Foo() { ... } 619 // } GTEST_ATTRIBUTE_UNUSED_; 620 // 621 // Also use it after a variable or parameter declaration to tell the 622 // compiler the variable/parameter does not have to be used. 623 #if defined(__GNUC__) && !defined(COMPILER_ICC) 624 # define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused)) 625 #else 626 # define GTEST_ATTRIBUTE_UNUSED_ 627 #endif 628 629 // A macro to disallow operator= 630 // This should be used in the private: declarations for a class. 631 #define GTEST_DISALLOW_ASSIGN_(type)\ 632 void operator=(type const &) 633 634 // A macro to disallow copy constructor and operator= 635 // This should be used in the private: declarations for a class. 636 #define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\ 637 type(type const &);\ 638 GTEST_DISALLOW_ASSIGN_(type) 639 640 // Tell the compiler to warn about unused return values for functions declared 641 // with this macro. The macro should be used on function declarations 642 // following the argument list: 643 // 644 // Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_; 645 #if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC) 646 # define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result)) 647 #else 648 # define GTEST_MUST_USE_RESULT_ 649 #endif // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC 650 651 // Determine whether the compiler supports Microsoft's Structured Exception 652 // Handling. This is supported by several Windows compilers but generally 653 // does not exist on any other system. 654 #ifndef GTEST_HAS_SEH 655 // The user didn't tell us, so we need to figure it out. 656 657 # if defined(_MSC_VER) || defined(__BORLANDC__) 658 // These two compilers are known to support SEH. 659 # define GTEST_HAS_SEH 1 660 # else 661 // Assume no SEH. 662 # define GTEST_HAS_SEH 0 663 # endif 664 665 #endif // GTEST_HAS_SEH 666 667 #ifdef _MSC_VER 668 669 # if GTEST_LINKED_AS_SHARED_LIBRARY 670 # define GTEST_API_ __declspec(dllimport) 671 # elif GTEST_CREATE_SHARED_LIBRARY 672 # define GTEST_API_ __declspec(dllexport) 673 # endif 674 675 #endif // _MSC_VER 676 677 #ifndef GTEST_API_ 678 # define GTEST_API_ 679 #endif 680 681 #ifdef __GNUC__ 682 // Ask the compiler to never inline a given function. 683 # define GTEST_NO_INLINE_ __attribute__((noinline)) 684 #else 685 # define GTEST_NO_INLINE_ 686 #endif 687 688 // _LIBCPP_VERSION is defined by the libc++ library from the LLVM project. 689 #if defined(__GLIBCXX__) || defined(_LIBCPP_VERSION) 690 # define GTEST_HAS_CXXABI_H_ 1 691 #else 692 # define GTEST_HAS_CXXABI_H_ 0 693 #endif 694 695 namespace testing { 696 697 class Message; 698 699 namespace internal { 700 701 class String; 702 703 // The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time 704 // expression is true. For example, you could use it to verify the 705 // size of a static array: 706 // 707 // GTEST_COMPILE_ASSERT_(ARRAYSIZE(content_type_names) == CONTENT_NUM_TYPES, 708 // content_type_names_incorrect_size); 709 // 710 // or to make sure a struct is smaller than a certain size: 711 // 712 // GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large); 713 // 714 // The second argument to the macro is the name of the variable. If 715 // the expression is false, most compilers will issue a warning/error 716 // containing the name of the variable. 717 718 template <bool> 719 struct CompileAssert { 720 }; 721 722 #define GTEST_COMPILE_ASSERT_(expr, msg) \ 723 typedef ::testing::internal::CompileAssert<(bool(expr))> \ 724 msg[bool(expr) ? 1 : -1] 725 726 // Implementation details of GTEST_COMPILE_ASSERT_: 727 // 728 // - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1 729 // elements (and thus is invalid) when the expression is false. 730 // 731 // - The simpler definition 732 // 733 // #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1] 734 // 735 // does not work, as gcc supports variable-length arrays whose sizes 736 // are determined at run-time (this is gcc's extension and not part 737 // of the C++ standard). As a result, gcc fails to reject the 738 // following code with the simple definition: 739 // 740 // int foo; 741 // GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is 742 // // not a compile-time constant. 743 // 744 // - By using the type CompileAssert<(bool(expr))>, we ensures that 745 // expr is a compile-time constant. (Template arguments must be 746 // determined at compile-time.) 747 // 748 // - The outter parentheses in CompileAssert<(bool(expr))> are necessary 749 // to work around a bug in gcc 3.4.4 and 4.0.1. If we had written 750 // 751 // CompileAssert<bool(expr)> 752 // 753 // instead, these compilers will refuse to compile 754 // 755 // GTEST_COMPILE_ASSERT_(5 > 0, some_message); 756 // 757 // (They seem to think the ">" in "5 > 0" marks the end of the 758 // template argument list.) 759 // 760 // - The array size is (bool(expr) ? 1 : -1), instead of simply 761 // 762 // ((expr) ? 1 : -1). 763 // 764 // This is to avoid running into a bug in MS VC 7.1, which 765 // causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1. 766 767 // StaticAssertTypeEqHelper is used by StaticAssertTypeEq defined in gtest.h. 768 // 769 // This template is declared, but intentionally undefined. 770 template <typename T1, typename T2> 771 struct StaticAssertTypeEqHelper; 772 773 template <typename T> 774 struct StaticAssertTypeEqHelper<T, T> {}; 775 776 #if GTEST_HAS_GLOBAL_STRING 777 typedef ::string string; 778 #else 779 typedef ::std::string string; 780 #endif // GTEST_HAS_GLOBAL_STRING 781 782 #if GTEST_HAS_GLOBAL_WSTRING 783 typedef ::wstring wstring; 784 #elif GTEST_HAS_STD_WSTRING 785 typedef ::std::wstring wstring; 786 #endif // GTEST_HAS_GLOBAL_WSTRING 787 788 // A helper for suppressing warnings on constant condition. It just 789 // returns 'condition'. 790 GTEST_API_ bool IsTrue(bool condition); 791 792 // Defines scoped_ptr. 793 794 // This implementation of scoped_ptr is PARTIAL - it only contains 795 // enough stuff to satisfy Google Test's need. 796 template <typename T> 797 class scoped_ptr { 798 public: 799 typedef T element_type; 800 801 explicit scoped_ptr(T* p = NULL) : ptr_(p) {} 802 ~scoped_ptr() { reset(); } 803 804 T& operator*() const { return *ptr_; } 805 T* operator->() const { return ptr_; } 806 T* get() const { return ptr_; } 807 808 T* release() { 809 T* const ptr = ptr_; 810 ptr_ = NULL; 811 return ptr; 812 } 813 814 void reset(T* p = NULL) { 815 if (p != ptr_) { 816 if (IsTrue(sizeof(T) > 0)) { // Makes sure T is a complete type. 817 delete ptr_; 818 } 819 ptr_ = p; 820 } 821 } 822 823 private: 824 T* ptr_; 825 826 GTEST_DISALLOW_COPY_AND_ASSIGN_(scoped_ptr); 827 }; 828 829 // Defines RE. 830 831 // A simple C++ wrapper for <regex.h>. It uses the POSIX Extended 832 // Regular Expression syntax. 833 class GTEST_API_ RE { 834 public: 835 // A copy constructor is required by the Standard to initialize object 836 // references from r-values. 837 RE(const RE& other) { Init(other.pattern()); } 838 839 // Constructs an RE from a string. 840 RE(const ::std::string& regex) { Init(regex.c_str()); } // NOLINT 841 842 #if GTEST_HAS_GLOBAL_STRING 843 844 RE(const ::string& regex) { Init(regex.c_str()); } // NOLINT 845 846 #endif // GTEST_HAS_GLOBAL_STRING 847 848 RE(const char* regex) { Init(regex); } // NOLINT 849 ~RE(); 850 851 // Returns the string representation of the regex. 852 const char* pattern() const { return pattern_; } 853 854 // FullMatch(str, re) returns true iff regular expression re matches 855 // the entire str. 856 // PartialMatch(str, re) returns true iff regular expression re 857 // matches a substring of str (including str itself). 858 // 859 // TODO(wan (at) google.com): make FullMatch() and PartialMatch() work 860 // when str contains NUL characters. 861 static bool FullMatch(const ::std::string& str, const RE& re) { 862 return FullMatch(str.c_str(), re); 863 } 864 static bool PartialMatch(const ::std::string& str, const RE& re) { 865 return PartialMatch(str.c_str(), re); 866 } 867 868 #if GTEST_HAS_GLOBAL_STRING 869 870 static bool FullMatch(const ::string& str, const RE& re) { 871 return FullMatch(str.c_str(), re); 872 } 873 static bool PartialMatch(const ::string& str, const RE& re) { 874 return PartialMatch(str.c_str(), re); 875 } 876 877 #endif // GTEST_HAS_GLOBAL_STRING 878 879 static bool FullMatch(const char* str, const RE& re); 880 static bool PartialMatch(const char* str, const RE& re); 881 882 private: 883 void Init(const char* regex); 884 885 // We use a const char* instead of a string, as Google Test may be used 886 // where string is not available. We also do not use Google Test's own 887 // String type here, in order to simplify dependencies between the 888 // files. 889 const char* pattern_; 890 bool is_valid_; 891 892 #if GTEST_USES_POSIX_RE 893 894 regex_t full_regex_; // For FullMatch(). 895 regex_t partial_regex_; // For PartialMatch(). 896 897 #else // GTEST_USES_SIMPLE_RE 898 899 const char* full_pattern_; // For FullMatch(); 900 901 #endif 902 903 GTEST_DISALLOW_ASSIGN_(RE); 904 }; 905 906 // Formats a source file path and a line number as they would appear 907 // in an error message from the compiler used to compile this code. 908 GTEST_API_ ::std::string FormatFileLocation(const char* file, int line); 909 910 // Formats a file location for compiler-independent XML output. 911 // Although this function is not platform dependent, we put it next to 912 // FormatFileLocation in order to contrast the two functions. 913 GTEST_API_ ::std::string FormatCompilerIndependentFileLocation(const char* file, 914 int line); 915 916 // Defines logging utilities: 917 // GTEST_LOG_(severity) - logs messages at the specified severity level. The 918 // message itself is streamed into the macro. 919 // LogToStderr() - directs all log messages to stderr. 920 // FlushInfoLog() - flushes informational log messages. 921 922 enum GTestLogSeverity { 923 GTEST_INFO, 924 GTEST_WARNING, 925 GTEST_ERROR, 926 GTEST_FATAL 927 }; 928 929 // Formats log entry severity, provides a stream object for streaming the 930 // log message, and terminates the message with a newline when going out of 931 // scope. 932 class GTEST_API_ GTestLog { 933 public: 934 GTestLog(GTestLogSeverity severity, const char* file, int line); 935 936 // Flushes the buffers and, if severity is GTEST_FATAL, aborts the program. 937 ~GTestLog(); 938 939 ::std::ostream& GetStream() { return ::std::cerr; } 940 941 private: 942 const GTestLogSeverity severity_; 943 944 GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestLog); 945 }; 946 947 #define GTEST_LOG_(severity) \ 948 ::testing::internal::GTestLog(::testing::internal::GTEST_##severity, \ 949 __FILE__, __LINE__).GetStream() 950 951 inline void LogToStderr() {} 952 inline void FlushInfoLog() { fflush(NULL); } 953 954 // INTERNAL IMPLEMENTATION - DO NOT USE. 955 // 956 // GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition 957 // is not satisfied. 958 // Synopsys: 959 // GTEST_CHECK_(boolean_condition); 960 // or 961 // GTEST_CHECK_(boolean_condition) << "Additional message"; 962 // 963 // This checks the condition and if the condition is not satisfied 964 // it prints message about the condition violation, including the 965 // condition itself, plus additional message streamed into it, if any, 966 // and then it aborts the program. It aborts the program irrespective of 967 // whether it is built in the debug mode or not. 968 #define GTEST_CHECK_(condition) \ 969 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 970 if (::testing::internal::IsTrue(condition)) \ 971 ; \ 972 else \ 973 GTEST_LOG_(FATAL) << "Condition " #condition " failed. " 974 975 // An all-mode assert to verify that the given POSIX-style function 976 // call returns 0 (indicating success). Known limitation: this 977 // doesn't expand to a balanced 'if' statement, so enclose the macro 978 // in {} if you need to use it as the only statement in an 'if' 979 // branch. 980 #define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \ 981 if (const int gtest_error = (posix_call)) \ 982 GTEST_LOG_(FATAL) << #posix_call << "failed with error " \ 983 << gtest_error 984 985 // INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE. 986 // 987 // Use ImplicitCast_ as a safe version of static_cast for upcasting in 988 // the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a 989 // const Foo*). When you use ImplicitCast_, the compiler checks that 990 // the cast is safe. Such explicit ImplicitCast_s are necessary in 991 // surprisingly many situations where C++ demands an exact type match 992 // instead of an argument type convertable to a target type. 993 // 994 // The syntax for using ImplicitCast_ is the same as for static_cast: 995 // 996 // ImplicitCast_<ToType>(expr) 997 // 998 // ImplicitCast_ would have been part of the C++ standard library, 999 // but the proposal was submitted too late. It will probably make 1000 // its way into the language in the future. 1001 // 1002 // This relatively ugly name is intentional. It prevents clashes with 1003 // similar functions users may have (e.g., implicit_cast). The internal 1004 // namespace alone is not enough because the function can be found by ADL. 1005 template<typename To> 1006 inline To ImplicitCast_(To x) { return x; } 1007 1008 // When you upcast (that is, cast a pointer from type Foo to type 1009 // SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts 1010 // always succeed. When you downcast (that is, cast a pointer from 1011 // type Foo to type SubclassOfFoo), static_cast<> isn't safe, because 1012 // how do you know the pointer is really of type SubclassOfFoo? It 1013 // could be a bare Foo, or of type DifferentSubclassOfFoo. Thus, 1014 // when you downcast, you should use this macro. In debug mode, we 1015 // use dynamic_cast<> to double-check the downcast is legal (we die 1016 // if it's not). In normal mode, we do the efficient static_cast<> 1017 // instead. Thus, it's important to test in debug mode to make sure 1018 // the cast is legal! 1019 // This is the only place in the code we should use dynamic_cast<>. 1020 // In particular, you SHOULDN'T be using dynamic_cast<> in order to 1021 // do RTTI (eg code like this: 1022 // if (dynamic_cast<Subclass1>(foo)) HandleASubclass1Object(foo); 1023 // if (dynamic_cast<Subclass2>(foo)) HandleASubclass2Object(foo); 1024 // You should design the code some other way not to need this. 1025 // 1026 // This relatively ugly name is intentional. It prevents clashes with 1027 // similar functions users may have (e.g., down_cast). The internal 1028 // namespace alone is not enough because the function can be found by ADL. 1029 template<typename To, typename From> // use like this: DownCast_<T*>(foo); 1030 inline To DownCast_(From* f) { // so we only accept pointers 1031 // Ensures that To is a sub-type of From *. This test is here only 1032 // for compile-time type checking, and has no overhead in an 1033 // optimized build at run-time, as it will be optimized away 1034 // completely. 1035 if (false) { 1036 const To to = NULL; 1037 ::testing::internal::ImplicitCast_<From*>(to); 1038 } 1039 1040 #if GTEST_HAS_RTTI 1041 // RTTI: debug mode only! 1042 GTEST_CHECK_(f == NULL || dynamic_cast<To>(f) != NULL); 1043 #endif 1044 return static_cast<To>(f); 1045 } 1046 1047 // Downcasts the pointer of type Base to Derived. 1048 // Derived must be a subclass of Base. The parameter MUST 1049 // point to a class of type Derived, not any subclass of it. 1050 // When RTTI is available, the function performs a runtime 1051 // check to enforce this. 1052 template <class Derived, class Base> 1053 Derived* CheckedDowncastToActualType(Base* base) { 1054 #if GTEST_HAS_RTTI 1055 GTEST_CHECK_(typeid(*base) == typeid(Derived)); 1056 return dynamic_cast<Derived*>(base); // NOLINT 1057 #else 1058 return static_cast<Derived*>(base); // Poor man's downcast. 1059 #endif 1060 } 1061 1062 #if GTEST_HAS_STREAM_REDIRECTION 1063 1064 // Defines the stderr capturer: 1065 // CaptureStdout - starts capturing stdout. 1066 // GetCapturedStdout - stops capturing stdout and returns the captured string. 1067 // CaptureStderr - starts capturing stderr. 1068 // GetCapturedStderr - stops capturing stderr and returns the captured string. 1069 // 1070 GTEST_API_ void CaptureStdout(); 1071 GTEST_API_ String GetCapturedStdout(); 1072 GTEST_API_ void CaptureStderr(); 1073 GTEST_API_ String GetCapturedStderr(); 1074 1075 #endif // GTEST_HAS_STREAM_REDIRECTION 1076 1077 1078 #if GTEST_HAS_DEATH_TEST 1079 1080 const ::std::vector<testing::internal::string>& GetInjectableArgvs(); 1081 void SetInjectableArgvs(const ::std::vector<testing::internal::string>* 1082 new_argvs); 1083 1084 // A copy of all command line arguments. Set by InitGoogleTest(). 1085 extern ::std::vector<testing::internal::string> g_argvs; 1086 1087 #endif // GTEST_HAS_DEATH_TEST 1088 1089 // Defines synchronization primitives. 1090 1091 #if GTEST_HAS_PTHREAD 1092 1093 // Sleeps for (roughly) n milli-seconds. This function is only for 1094 // testing Google Test's own constructs. Don't use it in user tests, 1095 // either directly or indirectly. 1096 inline void SleepMilliseconds(int n) { 1097 const timespec time = { 1098 0, // 0 seconds. 1099 n * 1000L * 1000L, // And n ms. 1100 }; 1101 nanosleep(&time, NULL); 1102 } 1103 1104 // Allows a controller thread to pause execution of newly created 1105 // threads until notified. Instances of this class must be created 1106 // and destroyed in the controller thread. 1107 // 1108 // This class is only for testing Google Test's own constructs. Do not 1109 // use it in user tests, either directly or indirectly. 1110 class Notification { 1111 public: 1112 Notification() : notified_(false) { 1113 GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL)); 1114 } 1115 ~Notification() { 1116 pthread_mutex_destroy(&mutex_); 1117 } 1118 1119 // Notifies all threads created with this notification to start. Must 1120 // be called from the controller thread. 1121 void Notify() { 1122 pthread_mutex_lock(&mutex_); 1123 notified_ = true; 1124 pthread_mutex_unlock(&mutex_); 1125 } 1126 1127 // Blocks until the controller thread notifies. Must be called from a test 1128 // thread. 1129 void WaitForNotification() { 1130 for (;;) { 1131 pthread_mutex_lock(&mutex_); 1132 const bool notified = notified_; 1133 pthread_mutex_unlock(&mutex_); 1134 if (notified) 1135 break; 1136 SleepMilliseconds(10); 1137 } 1138 } 1139 1140 private: 1141 pthread_mutex_t mutex_; 1142 bool notified_; 1143 1144 GTEST_DISALLOW_COPY_AND_ASSIGN_(Notification); 1145 }; 1146 1147 // As a C-function, ThreadFuncWithCLinkage cannot be templated itself. 1148 // Consequently, it cannot select a correct instantiation of ThreadWithParam 1149 // in order to call its Run(). Introducing ThreadWithParamBase as a 1150 // non-templated base class for ThreadWithParam allows us to bypass this 1151 // problem. 1152 class ThreadWithParamBase { 1153 public: 1154 virtual ~ThreadWithParamBase() {} 1155 virtual void Run() = 0; 1156 }; 1157 1158 // pthread_create() accepts a pointer to a function type with the C linkage. 1159 // According to the Standard (7.5/1), function types with different linkages 1160 // are different even if they are otherwise identical. Some compilers (for 1161 // example, SunStudio) treat them as different types. Since class methods 1162 // cannot be defined with C-linkage we need to define a free C-function to 1163 // pass into pthread_create(). 1164 extern "C" inline void* ThreadFuncWithCLinkage(void* thread) { 1165 static_cast<ThreadWithParamBase*>(thread)->Run(); 1166 return NULL; 1167 } 1168 1169 // Helper class for testing Google Test's multi-threading constructs. 1170 // To use it, write: 1171 // 1172 // void ThreadFunc(int param) { /* Do things with param */ } 1173 // Notification thread_can_start; 1174 // ... 1175 // // The thread_can_start parameter is optional; you can supply NULL. 1176 // ThreadWithParam<int> thread(&ThreadFunc, 5, &thread_can_start); 1177 // thread_can_start.Notify(); 1178 // 1179 // These classes are only for testing Google Test's own constructs. Do 1180 // not use them in user tests, either directly or indirectly. 1181 template <typename T> 1182 class ThreadWithParam : public ThreadWithParamBase { 1183 public: 1184 typedef void (*UserThreadFunc)(T); 1185 1186 ThreadWithParam( 1187 UserThreadFunc func, T param, Notification* thread_can_start) 1188 : func_(func), 1189 param_(param), 1190 thread_can_start_(thread_can_start), 1191 finished_(false) { 1192 ThreadWithParamBase* const base = this; 1193 // The thread can be created only after all fields except thread_ 1194 // have been initialized. 1195 GTEST_CHECK_POSIX_SUCCESS_( 1196 pthread_create(&thread_, 0, &ThreadFuncWithCLinkage, base)); 1197 } 1198 ~ThreadWithParam() { Join(); } 1199 1200 void Join() { 1201 if (!finished_) { 1202 GTEST_CHECK_POSIX_SUCCESS_(pthread_join(thread_, 0)); 1203 finished_ = true; 1204 } 1205 } 1206 1207 virtual void Run() { 1208 if (thread_can_start_ != NULL) 1209 thread_can_start_->WaitForNotification(); 1210 func_(param_); 1211 } 1212 1213 private: 1214 const UserThreadFunc func_; // User-supplied thread function. 1215 const T param_; // User-supplied parameter to the thread function. 1216 // When non-NULL, used to block execution until the controller thread 1217 // notifies. 1218 Notification* const thread_can_start_; 1219 bool finished_; // true iff we know that the thread function has finished. 1220 pthread_t thread_; // The native thread object. 1221 1222 GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadWithParam); 1223 }; 1224 1225 // MutexBase and Mutex implement mutex on pthreads-based platforms. They 1226 // are used in conjunction with class MutexLock: 1227 // 1228 // Mutex mutex; 1229 // ... 1230 // MutexLock lock(&mutex); // Acquires the mutex and releases it at the end 1231 // // of the current scope. 1232 // 1233 // MutexBase implements behavior for both statically and dynamically 1234 // allocated mutexes. Do not use MutexBase directly. Instead, write 1235 // the following to define a static mutex: 1236 // 1237 // GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex); 1238 // 1239 // You can forward declare a static mutex like this: 1240 // 1241 // GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex); 1242 // 1243 // To create a dynamic mutex, just define an object of type Mutex. 1244 class MutexBase { 1245 public: 1246 // Acquires this mutex. 1247 void Lock() { 1248 GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_lock(&mutex_)); 1249 owner_ = pthread_self(); 1250 has_owner_ = true; 1251 } 1252 1253 // Releases this mutex. 1254 void Unlock() { 1255 // Since the lock is being released the owner_ field should no longer be 1256 // considered valid. We don't protect writing to has_owner_ here, as it's 1257 // the caller's responsibility to ensure that the current thread holds the 1258 // mutex when this is called. 1259 has_owner_ = false; 1260 GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_unlock(&mutex_)); 1261 } 1262 1263 // Does nothing if the current thread holds the mutex. Otherwise, crashes 1264 // with high probability. 1265 void AssertHeld() const { 1266 GTEST_CHECK_(has_owner_ && pthread_equal(owner_, pthread_self())) 1267 << "The current thread is not holding the mutex @" << this; 1268 } 1269 1270 // A static mutex may be used before main() is entered. It may even 1271 // be used before the dynamic initialization stage. Therefore we 1272 // must be able to initialize a static mutex object at link time. 1273 // This means MutexBase has to be a POD and its member variables 1274 // have to be public. 1275 public: 1276 pthread_mutex_t mutex_; // The underlying pthread mutex. 1277 // has_owner_ indicates whether the owner_ field below contains a valid thread 1278 // ID and is therefore safe to inspect (e.g., to use in pthread_equal()). All 1279 // accesses to the owner_ field should be protected by a check of this field. 1280 // An alternative might be to memset() owner_ to all zeros, but there's no 1281 // guarantee that a zero'd pthread_t is necessarily invalid or even different 1282 // from pthread_self(). 1283 bool has_owner_; 1284 pthread_t owner_; // The thread holding the mutex. 1285 }; 1286 1287 // Forward-declares a static mutex. 1288 # define GTEST_DECLARE_STATIC_MUTEX_(mutex) \ 1289 extern ::testing::internal::MutexBase mutex 1290 1291 // Defines and statically (i.e. at link time) initializes a static mutex. 1292 // The initialization list here does not explicitly initialize each field, 1293 // instead relying on default initialization for the unspecified fields. In 1294 // particular, the owner_ field (a pthread_t) is not explicitly initialized. 1295 // This allows initialization to work whether pthread_t is a scalar or struct. 1296 // The flag -Wmissing-field-initializers must not be specified for this to work. 1297 # define GTEST_DEFINE_STATIC_MUTEX_(mutex) \ 1298 ::testing::internal::MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER, false } 1299 1300 // The Mutex class can only be used for mutexes created at runtime. It 1301 // shares its API with MutexBase otherwise. 1302 class Mutex : public MutexBase { 1303 public: 1304 Mutex() { 1305 GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_init(&mutex_, NULL)); 1306 has_owner_ = false; 1307 } 1308 ~Mutex() { 1309 GTEST_CHECK_POSIX_SUCCESS_(pthread_mutex_destroy(&mutex_)); 1310 } 1311 1312 private: 1313 GTEST_DISALLOW_COPY_AND_ASSIGN_(Mutex); 1314 }; 1315 1316 // We cannot name this class MutexLock as the ctor declaration would 1317 // conflict with a macro named MutexLock, which is defined on some 1318 // platforms. Hence the typedef trick below. 1319 class GTestMutexLock { 1320 public: 1321 explicit GTestMutexLock(MutexBase* mutex) 1322 : mutex_(mutex) { mutex_->Lock(); } 1323 1324 ~GTestMutexLock() { mutex_->Unlock(); } 1325 1326 private: 1327 MutexBase* const mutex_; 1328 1329 GTEST_DISALLOW_COPY_AND_ASSIGN_(GTestMutexLock); 1330 }; 1331 1332 typedef GTestMutexLock MutexLock; 1333 1334 // Helpers for ThreadLocal. 1335 1336 // pthread_key_create() requires DeleteThreadLocalValue() to have 1337 // C-linkage. Therefore it cannot be templatized to access 1338 // ThreadLocal<T>. Hence the need for class 1339 // ThreadLocalValueHolderBase. 1340 class ThreadLocalValueHolderBase { 1341 public: 1342 virtual ~ThreadLocalValueHolderBase() {} 1343 }; 1344 1345 // Called by pthread to delete thread-local data stored by 1346 // pthread_setspecific(). 1347 extern "C" inline void DeleteThreadLocalValue(void* value_holder) { 1348 delete static_cast<ThreadLocalValueHolderBase*>(value_holder); 1349 } 1350 1351 // Implements thread-local storage on pthreads-based systems. 1352 // 1353 // // Thread 1 1354 // ThreadLocal<int> tl(100); // 100 is the default value for each thread. 1355 // 1356 // // Thread 2 1357 // tl.set(150); // Changes the value for thread 2 only. 1358 // EXPECT_EQ(150, tl.get()); 1359 // 1360 // // Thread 1 1361 // EXPECT_EQ(100, tl.get()); // In thread 1, tl has the original value. 1362 // tl.set(200); 1363 // EXPECT_EQ(200, tl.get()); 1364 // 1365 // The template type argument T must have a public copy constructor. 1366 // In addition, the default ThreadLocal constructor requires T to have 1367 // a public default constructor. 1368 // 1369 // An object managed for a thread by a ThreadLocal instance is deleted 1370 // when the thread exits. Or, if the ThreadLocal instance dies in 1371 // that thread, when the ThreadLocal dies. It's the user's 1372 // responsibility to ensure that all other threads using a ThreadLocal 1373 // have exited when it dies, or the per-thread objects for those 1374 // threads will not be deleted. 1375 // 1376 // Google Test only uses global ThreadLocal objects. That means they 1377 // will die after main() has returned. Therefore, no per-thread 1378 // object managed by Google Test will be leaked as long as all threads 1379 // using Google Test have exited when main() returns. 1380 template <typename T> 1381 class ThreadLocal { 1382 public: 1383 ThreadLocal() : key_(CreateKey()), 1384 default_() {} 1385 explicit ThreadLocal(const T& value) : key_(CreateKey()), 1386 default_(value) {} 1387 1388 ~ThreadLocal() { 1389 // Destroys the managed object for the current thread, if any. 1390 DeleteThreadLocalValue(pthread_getspecific(key_)); 1391 1392 // Releases resources associated with the key. This will *not* 1393 // delete managed objects for other threads. 1394 GTEST_CHECK_POSIX_SUCCESS_(pthread_key_delete(key_)); 1395 } 1396 1397 T* pointer() { return GetOrCreateValue(); } 1398 const T* pointer() const { return GetOrCreateValue(); } 1399 const T& get() const { return *pointer(); } 1400 void set(const T& value) { *pointer() = value; } 1401 1402 private: 1403 // Holds a value of type T. 1404 class ValueHolder : public ThreadLocalValueHolderBase { 1405 public: 1406 explicit ValueHolder(const T& value) : value_(value) {} 1407 1408 T* pointer() { return &value_; } 1409 1410 private: 1411 T value_; 1412 GTEST_DISALLOW_COPY_AND_ASSIGN_(ValueHolder); 1413 }; 1414 1415 static pthread_key_t CreateKey() { 1416 pthread_key_t key; 1417 // When a thread exits, DeleteThreadLocalValue() will be called on 1418 // the object managed for that thread. 1419 GTEST_CHECK_POSIX_SUCCESS_( 1420 pthread_key_create(&key, &DeleteThreadLocalValue)); 1421 return key; 1422 } 1423 1424 T* GetOrCreateValue() const { 1425 ThreadLocalValueHolderBase* const holder = 1426 static_cast<ThreadLocalValueHolderBase*>(pthread_getspecific(key_)); 1427 if (holder != NULL) { 1428 return CheckedDowncastToActualType<ValueHolder>(holder)->pointer(); 1429 } 1430 1431 ValueHolder* const new_holder = new ValueHolder(default_); 1432 ThreadLocalValueHolderBase* const holder_base = new_holder; 1433 GTEST_CHECK_POSIX_SUCCESS_(pthread_setspecific(key_, holder_base)); 1434 return new_holder->pointer(); 1435 } 1436 1437 // A key pthreads uses for looking up per-thread values. 1438 const pthread_key_t key_; 1439 const T default_; // The default value for each thread. 1440 1441 GTEST_DISALLOW_COPY_AND_ASSIGN_(ThreadLocal); 1442 }; 1443 1444 # define GTEST_IS_THREADSAFE 1 1445 1446 #else // GTEST_HAS_PTHREAD 1447 1448 // A dummy implementation of synchronization primitives (mutex, lock, 1449 // and thread-local variable). Necessary for compiling Google Test where 1450 // mutex is not supported - using Google Test in multiple threads is not 1451 // supported on such platforms. 1452 1453 class Mutex { 1454 public: 1455 Mutex() {} 1456 void Lock() {} 1457 void Unlock() {} 1458 void AssertHeld() const {} 1459 }; 1460 1461 # define GTEST_DECLARE_STATIC_MUTEX_(mutex) \ 1462 extern ::testing::internal::Mutex mutex 1463 1464 # define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex 1465 1466 class GTestMutexLock { 1467 public: 1468 explicit GTestMutexLock(Mutex*) {} // NOLINT 1469 }; 1470 1471 typedef GTestMutexLock MutexLock; 1472 1473 template <typename T> 1474 class ThreadLocal { 1475 public: 1476 ThreadLocal() : value_() {} 1477 explicit ThreadLocal(const T& value) : value_(value) {} 1478 T* pointer() { return &value_; } 1479 const T* pointer() const { return &value_; } 1480 const T& get() const { return value_; } 1481 void set(const T& value) { value_ = value; } 1482 private: 1483 T value_; 1484 }; 1485 1486 // The above synchronization primitives have dummy implementations. 1487 // Therefore Google Test is not thread-safe. 1488 # define GTEST_IS_THREADSAFE 0 1489 1490 #endif // GTEST_HAS_PTHREAD 1491 1492 // Returns the number of threads running in the process, or 0 to indicate that 1493 // we cannot detect it. 1494 GTEST_API_ size_t GetThreadCount(); 1495 1496 // Passing non-POD classes through ellipsis (...) crashes the ARM 1497 // compiler and generates a warning in Sun Studio. The Nokia Symbian 1498 // and the IBM XL C/C++ compiler try to instantiate a copy constructor 1499 // for objects passed through ellipsis (...), failing for uncopyable 1500 // objects. We define this to ensure that only POD is passed through 1501 // ellipsis on these systems. 1502 #if defined(__SYMBIAN32__) || defined(__IBMCPP__) || defined(__SUNPRO_CC) 1503 // We lose support for NULL detection where the compiler doesn't like 1504 // passing non-POD classes through ellipsis (...). 1505 # define GTEST_ELLIPSIS_NEEDS_POD_ 1 1506 #else 1507 # define GTEST_CAN_COMPARE_NULL 1 1508 #endif 1509 1510 // The Nokia Symbian and IBM XL C/C++ compilers cannot decide between 1511 // const T& and const T* in a function template. These compilers 1512 // _can_ decide between class template specializations for T and T*, 1513 // so a tr1::type_traits-like is_pointer works. 1514 #if defined(__SYMBIAN32__) || defined(__IBMCPP__) 1515 # define GTEST_NEEDS_IS_POINTER_ 1 1516 #endif 1517 1518 template <bool bool_value> 1519 struct bool_constant { 1520 typedef bool_constant<bool_value> type; 1521 static const bool value = bool_value; 1522 }; 1523 template <bool bool_value> const bool bool_constant<bool_value>::value; 1524 1525 typedef bool_constant<false> false_type; 1526 typedef bool_constant<true> true_type; 1527 1528 template <typename T> 1529 struct is_pointer : public false_type {}; 1530 1531 template <typename T> 1532 struct is_pointer<T*> : public true_type {}; 1533 1534 template <typename Iterator> 1535 struct IteratorTraits { 1536 typedef typename Iterator::value_type value_type; 1537 }; 1538 1539 template <typename T> 1540 struct IteratorTraits<T*> { 1541 typedef T value_type; 1542 }; 1543 1544 template <typename T> 1545 struct IteratorTraits<const T*> { 1546 typedef T value_type; 1547 }; 1548 1549 #if GTEST_OS_WINDOWS 1550 # define GTEST_PATH_SEP_ "\\" 1551 # define GTEST_HAS_ALT_PATH_SEP_ 1 1552 // The biggest signed integer type the compiler supports. 1553 typedef __int64 BiggestInt; 1554 #else 1555 # define GTEST_PATH_SEP_ "/" 1556 # define GTEST_HAS_ALT_PATH_SEP_ 0 1557 typedef long long BiggestInt; // NOLINT 1558 #endif // GTEST_OS_WINDOWS 1559 1560 // Utilities for char. 1561 1562 // isspace(int ch) and friends accept an unsigned char or EOF. char 1563 // may be signed, depending on the compiler (or compiler flags). 1564 // Therefore we need to cast a char to unsigned char before calling 1565 // isspace(), etc. 1566 1567 inline bool IsAlpha(char ch) { 1568 return isalpha(static_cast<unsigned char>(ch)) != 0; 1569 } 1570 inline bool IsAlNum(char ch) { 1571 return isalnum(static_cast<unsigned char>(ch)) != 0; 1572 } 1573 inline bool IsDigit(char ch) { 1574 return isdigit(static_cast<unsigned char>(ch)) != 0; 1575 } 1576 inline bool IsLower(char ch) { 1577 return islower(static_cast<unsigned char>(ch)) != 0; 1578 } 1579 inline bool IsSpace(char ch) { 1580 return isspace(static_cast<unsigned char>(ch)) != 0; 1581 } 1582 inline bool IsUpper(char ch) { 1583 return isupper(static_cast<unsigned char>(ch)) != 0; 1584 } 1585 inline bool IsXDigit(char ch) { 1586 return isxdigit(static_cast<unsigned char>(ch)) != 0; 1587 } 1588 1589 inline char ToLower(char ch) { 1590 return static_cast<char>(tolower(static_cast<unsigned char>(ch))); 1591 } 1592 inline char ToUpper(char ch) { 1593 return static_cast<char>(toupper(static_cast<unsigned char>(ch))); 1594 } 1595 1596 // The testing::internal::posix namespace holds wrappers for common 1597 // POSIX functions. These wrappers hide the differences between 1598 // Windows/MSVC and POSIX systems. Since some compilers define these 1599 // standard functions as macros, the wrapper cannot have the same name 1600 // as the wrapped function. 1601 1602 namespace posix { 1603 1604 // Functions with a different name on Windows. 1605 1606 #if GTEST_OS_WINDOWS 1607 1608 typedef struct _stat StatStruct; 1609 1610 # ifdef __BORLANDC__ 1611 inline int IsATTY(int fd) { return isatty(fd); } 1612 inline int StrCaseCmp(const char* s1, const char* s2) { 1613 return stricmp(s1, s2); 1614 } 1615 inline char* StrDup(const char* src) { return strdup(src); } 1616 # else // !__BORLANDC__ 1617 # if GTEST_OS_WINDOWS_MOBILE 1618 inline int IsATTY(int /* fd */) { return 0; } 1619 # else 1620 inline int IsATTY(int fd) { return _isatty(fd); } 1621 # endif // GTEST_OS_WINDOWS_MOBILE 1622 inline int StrCaseCmp(const char* s1, const char* s2) { 1623 return _stricmp(s1, s2); 1624 } 1625 inline char* StrDup(const char* src) { return _strdup(src); } 1626 # endif // __BORLANDC__ 1627 1628 # if GTEST_OS_WINDOWS_MOBILE 1629 inline int FileNo(FILE* file) { return reinterpret_cast<int>(_fileno(file)); } 1630 // Stat(), RmDir(), and IsDir() are not needed on Windows CE at this 1631 // time and thus not defined there. 1632 # else 1633 inline int FileNo(FILE* file) { return _fileno(file); } 1634 inline int Stat(const char* path, StatStruct* buf) { return _stat(path, buf); } 1635 inline int RmDir(const char* dir) { return _rmdir(dir); } 1636 inline bool IsDir(const StatStruct& st) { 1637 return (_S_IFDIR & st.st_mode) != 0; 1638 } 1639 # endif // GTEST_OS_WINDOWS_MOBILE 1640 1641 #else 1642 1643 typedef struct stat StatStruct; 1644 1645 inline int FileNo(FILE* file) { return fileno(file); } 1646 inline int IsATTY(int fd) { return isatty(fd); } 1647 inline int Stat(const char* path, StatStruct* buf) { return stat(path, buf); } 1648 inline int StrCaseCmp(const char* s1, const char* s2) { 1649 return strcasecmp(s1, s2); 1650 } 1651 inline char* StrDup(const char* src) { return strdup(src); } 1652 inline int RmDir(const char* dir) { return rmdir(dir); } 1653 inline bool IsDir(const StatStruct& st) { return S_ISDIR(st.st_mode); } 1654 1655 #endif // GTEST_OS_WINDOWS 1656 1657 // Functions deprecated by MSVC 8.0. 1658 1659 #ifdef _MSC_VER 1660 // Temporarily disable warning 4996 (deprecated function). 1661 # pragma warning(push) 1662 # pragma warning(disable:4996) 1663 #endif 1664 1665 inline const char* StrNCpy(char* dest, const char* src, size_t n) { 1666 return strncpy(dest, src, n); 1667 } 1668 1669 // ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and 1670 // StrError() aren't needed on Windows CE at this time and thus not 1671 // defined there. 1672 1673 #if !GTEST_OS_WINDOWS_MOBILE 1674 inline int ChDir(const char* dir) { return chdir(dir); } 1675 #endif 1676 inline FILE* FOpen(const char* path, const char* mode) { 1677 return fopen(path, mode); 1678 } 1679 #if !GTEST_OS_WINDOWS_MOBILE 1680 inline FILE *FReopen(const char* path, const char* mode, FILE* stream) { 1681 return freopen(path, mode, stream); 1682 } 1683 inline FILE* FDOpen(int fd, const char* mode) { return fdopen(fd, mode); } 1684 #endif 1685 inline int FClose(FILE* fp) { return fclose(fp); } 1686 #if !GTEST_OS_WINDOWS_MOBILE 1687 inline int Read(int fd, void* buf, unsigned int count) { 1688 return static_cast<int>(read(fd, buf, count)); 1689 } 1690 inline int Write(int fd, const void* buf, unsigned int count) { 1691 return static_cast<int>(write(fd, buf, count)); 1692 } 1693 inline int Close(int fd) { return close(fd); } 1694 inline const char* StrError(int errnum) { return strerror(errnum); } 1695 #endif 1696 inline const char* GetEnv(const char* name) { 1697 #if GTEST_OS_WINDOWS_MOBILE 1698 // We are on Windows CE, which has no environment variables. 1699 return NULL; 1700 #elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9) 1701 // Environment variables which we programmatically clear will be set to the 1702 // empty string rather than unset (NULL). Handle that case. 1703 const char* const env = getenv(name); 1704 return (env != NULL && env[0] != '\0') ? env : NULL; 1705 #else 1706 return getenv(name); 1707 #endif 1708 } 1709 1710 #ifdef _MSC_VER 1711 # pragma warning(pop) // Restores the warning state. 1712 #endif 1713 1714 #if GTEST_OS_WINDOWS_MOBILE 1715 // Windows CE has no C library. The abort() function is used in 1716 // several places in Google Test. This implementation provides a reasonable 1717 // imitation of standard behaviour. 1718 void Abort(); 1719 #else 1720 inline void Abort() { abort(); } 1721 #endif // GTEST_OS_WINDOWS_MOBILE 1722 1723 } // namespace posix 1724 1725 // MSVC "deprecates" snprintf and issues warnings wherever it is used. In 1726 // order to avoid these warnings, we need to use _snprintf or _snprintf_s on 1727 // MSVC-based platforms. We map the GTEST_SNPRINTF_ macro to the appropriate 1728 // function in order to achieve that. We use macro definition here because 1729 // snprintf is a variadic function. 1730 #if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE 1731 // MSVC 2005 and above support variadic macros. 1732 # define GTEST_SNPRINTF_(buffer, size, format, ...) \ 1733 _snprintf_s(buffer, size, size, format, __VA_ARGS__) 1734 #elif defined(_MSC_VER) 1735 // Windows CE does not define _snprintf_s and MSVC prior to 2005 doesn't 1736 // complain about _snprintf. 1737 # define GTEST_SNPRINTF_ _snprintf 1738 #else 1739 # define GTEST_SNPRINTF_ snprintf 1740 #endif 1741 1742 // The maximum number a BiggestInt can represent. This definition 1743 // works no matter BiggestInt is represented in one's complement or 1744 // two's complement. 1745 // 1746 // We cannot rely on numeric_limits in STL, as __int64 and long long 1747 // are not part of standard C++ and numeric_limits doesn't need to be 1748 // defined for them. 1749 const BiggestInt kMaxBiggestInt = 1750 ~(static_cast<BiggestInt>(1) << (8*sizeof(BiggestInt) - 1)); 1751 1752 // This template class serves as a compile-time function from size to 1753 // type. It maps a size in bytes to a primitive type with that 1754 // size. e.g. 1755 // 1756 // TypeWithSize<4>::UInt 1757 // 1758 // is typedef-ed to be unsigned int (unsigned integer made up of 4 1759 // bytes). 1760 // 1761 // Such functionality should belong to STL, but I cannot find it 1762 // there. 1763 // 1764 // Google Test uses this class in the implementation of floating-point 1765 // comparison. 1766 // 1767 // For now it only handles UInt (unsigned int) as that's all Google Test 1768 // needs. Other types can be easily added in the future if need 1769 // arises. 1770 template <size_t size> 1771 class TypeWithSize { 1772 public: 1773 // This prevents the user from using TypeWithSize<N> with incorrect 1774 // values of N. 1775 typedef void UInt; 1776 }; 1777 1778 // The specialization for size 4. 1779 template <> 1780 class TypeWithSize<4> { 1781 public: 1782 // unsigned int has size 4 in both gcc and MSVC. 1783 // 1784 // As base/basictypes.h doesn't compile on Windows, we cannot use 1785 // uint32, uint64, and etc here. 1786 typedef int Int; 1787 typedef unsigned int UInt; 1788 }; 1789 1790 // The specialization for size 8. 1791 template <> 1792 class TypeWithSize<8> { 1793 public: 1794 #if GTEST_OS_WINDOWS 1795 typedef __int64 Int; 1796 typedef unsigned __int64 UInt; 1797 #else 1798 typedef long long Int; // NOLINT 1799 typedef unsigned long long UInt; // NOLINT 1800 #endif // GTEST_OS_WINDOWS 1801 }; 1802 1803 // Integer types of known sizes. 1804 typedef TypeWithSize<4>::Int Int32; 1805 typedef TypeWithSize<4>::UInt UInt32; 1806 typedef TypeWithSize<8>::Int Int64; 1807 typedef TypeWithSize<8>::UInt UInt64; 1808 typedef TypeWithSize<8>::Int TimeInMillis; // Represents time in milliseconds. 1809 1810 // Utilities for command line flags and environment variables. 1811 1812 // Macro for referencing flags. 1813 #define GTEST_FLAG(name) FLAGS_gtest_##name 1814 1815 // Macros for declaring flags. 1816 #define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name) 1817 #define GTEST_DECLARE_int32_(name) \ 1818 GTEST_API_ extern ::testing::internal::Int32 GTEST_FLAG(name) 1819 #define GTEST_DECLARE_string_(name) \ 1820 GTEST_API_ extern ::testing::internal::String GTEST_FLAG(name) 1821 1822 // Macros for defining flags. 1823 #define GTEST_DEFINE_bool_(name, default_val, doc) \ 1824 GTEST_API_ bool GTEST_FLAG(name) = (default_val) 1825 #define GTEST_DEFINE_int32_(name, default_val, doc) \ 1826 GTEST_API_ ::testing::internal::Int32 GTEST_FLAG(name) = (default_val) 1827 #define GTEST_DEFINE_string_(name, default_val, doc) \ 1828 GTEST_API_ ::testing::internal::String GTEST_FLAG(name) = (default_val) 1829 1830 // Thread annotations 1831 #define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks) 1832 #define GTEST_LOCK_EXCLUDED_(locks) 1833 1834 // Parses 'str' for a 32-bit signed integer. If successful, writes the result 1835 // to *value and returns true; otherwise leaves *value unchanged and returns 1836 // false. 1837 // TODO(chandlerc): Find a better way to refactor flag and environment parsing 1838 // out of both gtest-port.cc and gtest.cc to avoid exporting this utility 1839 // function. 1840 bool ParseInt32(const Message& src_text, const char* str, Int32* value); 1841 1842 // Parses a bool/Int32/string from the environment variable 1843 // corresponding to the given Google Test flag. 1844 bool BoolFromGTestEnv(const char* flag, bool default_val); 1845 GTEST_API_ Int32 Int32FromGTestEnv(const char* flag, Int32 default_val); 1846 const char* StringFromGTestEnv(const char* flag, const char* default_val); 1847 1848 } // namespace internal 1849 } // namespace testing 1850 1851 #endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_ 1852