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