2008-07-03 22:38:12 +00:00
// Copyright 2005, Google Inc.
// All rights reserved.
//
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are
// met:
//
// * Redistributions of source code must retain the above copyright
// notice, this list of conditions and the following disclaimer.
// * Redistributions in binary form must reproduce the above
// copyright notice, this list of conditions and the following disclaimer
// in the documentation and/or other materials provided with the
// distribution.
// * Neither the name of Google Inc. nor the names of its
// contributors may be used to endorse or promote products derived from
// this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// Authors: wan@google.com (Zhanyong Wan)
//
// Low-level types and utilities for porting Google Test to various
2014-01-12 18:51:09 +00:00
// platforms. All macros ending with _ and symbols defined in an
// internal namespace are subject to change without notice. Code
// outside Google Test MUST NOT USE THEM DIRECTLY. Macros that don't
// end with _ are part of Google Test's public API and can be used by
// code outside Google Test.
2013-02-28 23:46:07 +00:00
//
// This file is fundamental to Google Test. All other Google Test source
// files are expected to #include this. Therefore, it cannot #include
// any other Google Test header.
2008-07-03 22:38:12 +00:00
# ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
# define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_
2014-01-12 18:51:09 +00:00
// Environment-describing macros
// -----------------------------
//
// Google Test can be used in many different environments. Macros in
// this section tell Google Test what kind of environment it is being
// used in, such that Google Test can provide environment-specific
// features and implementations.
//
// Google Test tries to automatically detect the properties of its
// environment, so users usually don't need to worry about these
// macros. However, the automatic detection is not perfect.
// Sometimes it's necessary for a user to define some of the following
// macros in the build script to override Google Test's decisions.
//
// If the user doesn't define a macro in the list, Google Test will
// provide a default definition. After this header is #included, all
// macros in this list will be defined to either 1 or 0.
//
// Notes to maintainers:
// - Each macro here is a user-tweakable knob; do not grow the list
// lightly.
// - Use #if to key off these macros. Don't use #ifdef or "#if
// defined(...)", which will not work as these macros are ALWAYS
// defined.
2008-07-03 22:38:12 +00:00
//
2008-12-02 23:35:18 +00:00
// GTEST_HAS_CLONE - Define it to 1/0 to indicate that clone(2)
// is/isn't available.
2010-02-03 02:27:02 +00:00
// GTEST_HAS_EXCEPTIONS - Define it to 1/0 to indicate that exceptions
// are enabled.
2008-07-03 22:38:12 +00:00
// GTEST_HAS_GLOBAL_STRING - Define it to 1/0 to indicate that ::string
// is/isn't available (some systems define
// ::string, which is different to std::string).
// GTEST_HAS_GLOBAL_WSTRING - Define it to 1/0 to indicate that ::string
// is/isn't available (some systems define
// ::wstring, which is different to std::wstring).
2010-07-22 21:07:19 +00:00
// GTEST_HAS_POSIX_RE - Define it to 1/0 to indicate that POSIX regular
// expressions are/aren't available.
2008-10-11 07:20:02 +00:00
// GTEST_HAS_PTHREAD - Define it to 1/0 to indicate that <pthread.h>
// is/isn't available.
2008-12-02 23:35:18 +00:00
// GTEST_HAS_RTTI - Define it to 1/0 to indicate that RTTI is/isn't
// enabled.
// GTEST_HAS_STD_WSTRING - Define it to 1/0 to indicate that
// std::wstring does/doesn't work (Google Test can
// be used where std::wstring is unavailable).
2009-06-17 21:06:27 +00:00
// GTEST_HAS_TR1_TUPLE - Define it to 1/0 to indicate tr1::tuple
2008-11-20 01:40:35 +00:00
// is/isn't available.
2009-04-25 04:42:30 +00:00
// GTEST_HAS_SEH - Define it to 1/0 to indicate whether the
// compiler supports Microsoft's "Structured
// Exception Handling".
2010-08-31 18:21:13 +00:00
// GTEST_HAS_STREAM_REDIRECTION
// - Define it to 1/0 to indicate whether the
// platform supports I/O stream redirection using
// dup() and dup2().
2009-06-17 21:06:27 +00:00
// GTEST_USE_OWN_TR1_TUPLE - Define it to 1/0 to indicate whether Google
// Test's own tr1 tuple implementation should be
// used. Unused when the user sets
// GTEST_HAS_TR1_TUPLE to 0.
2012-08-14 15:20:28 +00:00
// GTEST_LANG_CXX11 - Define it to 1/0 to indicate that Google Test
// is building in C++11/C++98 mode.
2010-03-05 21:21:06 +00:00
// GTEST_LINKED_AS_SHARED_LIBRARY
// - Define to 1 when compiling tests that use
// Google Test as a shared library (known as
// DLL on Windows).
// GTEST_CREATE_SHARED_LIBRARY
// - Define to 1 when compiling Google Test itself
// as a shared library.
2008-07-03 22:38:12 +00:00
2014-01-12 18:51:09 +00:00
// Platform-indicating macros
// --------------------------
//
// Macros indicating the platform on which Google Test is being used
// (a macro is defined to 1 if compiled on the given platform;
// otherwise UNDEFINED -- it's never defined to 0.). Google Test
// defines these macros automatically. Code outside Google Test MUST
// NOT define them.
2008-07-03 22:38:12 +00:00
//
2010-03-17 18:22:59 +00:00
// GTEST_OS_AIX - IBM AIX
2009-02-23 23:21:55 +00:00
// GTEST_OS_CYGWIN - Cygwin
2015-01-22 00:58:35 +00:00
// GTEST_OS_FREEBSD - FreeBSD
2017-08-29 19:45:26 +00:00
// GTEST_OS_FUCHSIA - Fuchsia
2011-04-07 18:36:50 +00:00
// GTEST_OS_HPUX - HP-UX
2009-02-23 23:21:55 +00:00
// GTEST_OS_LINUX - Linux
2011-03-11 23:05:00 +00:00
// GTEST_OS_LINUX_ANDROID - Google Android
2009-02-23 23:21:55 +00:00
// GTEST_OS_MAC - Mac OS X
2012-07-09 13:22:29 +00:00
// GTEST_OS_IOS - iOS
2010-11-30 22:10:12 +00:00
// GTEST_OS_NACL - Google Native Client (NaCl)
2017-05-06 02:09:32 +00:00
// GTEST_OS_NETBSD - NetBSD
2011-05-03 01:58:34 +00:00
// GTEST_OS_OPENBSD - OpenBSD
2011-06-20 21:43:18 +00:00
// GTEST_OS_QNX - QNX
2009-02-23 23:21:55 +00:00
// GTEST_OS_SOLARIS - Sun Solaris
// GTEST_OS_SYMBIAN - Symbian
2009-09-24 21:15:59 +00:00
// GTEST_OS_WINDOWS - Windows (Desktop, MinGW, or Mobile)
// GTEST_OS_WINDOWS_DESKTOP - Windows Desktop
// GTEST_OS_WINDOWS_MINGW - MinGW
2010-01-28 21:50:29 +00:00
// GTEST_OS_WINDOWS_MOBILE - Windows Mobile
2014-05-15 19:42:15 +00:00
// GTEST_OS_WINDOWS_PHONE - Windows Phone
// GTEST_OS_WINDOWS_RT - Windows Store App/WinRT
2009-02-23 23:21:55 +00:00
// GTEST_OS_ZOS - z/OS
2008-11-10 18:27:46 +00:00
//
2008-11-17 22:57:44 +00:00
// Among the platforms, Cygwin, Linux, Max OS X, and Windows have the
// most stable support. Since core members of the Google Test project
// don't have access to other platforms, support for them may be less
// stable. If you notice any problems on your platform, please notify
// googletestframework@googlegroups.com (patches for fixing them are
// even more welcome!).
//
2014-01-12 18:51:09 +00:00
// It is possible that none of the GTEST_OS_* macros are defined.
// Feature-indicating macros
// -------------------------
//
// Macros indicating which Google Test features are available (a macro
// is defined to 1 if the corresponding feature is supported;
// otherwise UNDEFINED -- it's never defined to 0.). Google Test
// defines these macros automatically. Code outside Google Test MUST
// NOT define them.
//
// These macros are public so that portable tests can be written.
// Such tests typically surround code using a feature with an #if
// which controls that code. For example:
//
// #if GTEST_HAS_DEATH_TEST
// EXPECT_DEATH(DoSomethingDeadly());
// #endif
2008-07-03 22:38:12 +00:00
//
2009-02-23 23:21:55 +00:00
// GTEST_HAS_COMBINE - the Combine() function (for value-parameterized
// tests)
// GTEST_HAS_DEATH_TEST - death tests
// GTEST_HAS_TYPED_TEST - typed tests
// GTEST_HAS_TYPED_TEST_P - type-parameterized tests
2014-01-12 18:51:09 +00:00
// GTEST_IS_THREADSAFE - Google Test is thread-safe.
2010-07-22 21:07:19 +00:00
// GTEST_USES_POSIX_RE - enhanced POSIX regex is used. Do not confuse with
// GTEST_HAS_POSIX_RE (see above) which users can
// define themselves.
2009-02-23 23:21:55 +00:00
// GTEST_USES_SIMPLE_RE - our own simple regex is used;
2009-01-29 01:28:52 +00:00
// the above two are mutually exclusive.
2010-03-17 18:22:59 +00:00
// GTEST_CAN_COMPARE_NULL - accepts untyped NULL in EXPECT_EQ().
2014-01-12 18:51:09 +00:00
// Misc public macros
// ------------------
//
// GTEST_FLAG(flag_name) - references the variable corresponding to
// the given Google Test flag.
// Internal utilities
// ------------------
//
// The following macros and utilities are for Google Test's INTERNAL
// use only. Code outside Google Test MUST NOT USE THEM DIRECTLY.
2008-07-03 22:38:12 +00:00
//
// Macros for basic C++ coding:
2008-10-11 07:20:02 +00:00
// GTEST_AMBIGUOUS_ELSE_BLOCKER_ - for disabling a gcc warning.
2009-04-03 00:11:11 +00:00
// GTEST_ATTRIBUTE_UNUSED_ - declares that a class' instances or a
// variable don't have to be used.
2009-12-23 00:09:23 +00:00
// GTEST_DISALLOW_ASSIGN_ - disables operator=.
2008-10-11 07:20:02 +00:00
// GTEST_DISALLOW_COPY_AND_ASSIGN_ - disables copy ctor and operator=.
// GTEST_MUST_USE_RESULT_ - declares that a function's result must be used.
2014-01-29 07:29:19 +00:00
// GTEST_INTENTIONAL_CONST_COND_PUSH_ - start code section where MSVC C4127 is
// suppressed (constant conditional).
// GTEST_INTENTIONAL_CONST_COND_POP_ - finish code section where MSVC C4127
// is suppressed.
2008-07-03 22:38:12 +00:00
//
2014-01-29 06:34:44 +00:00
// C++11 feature wrappers:
//
2014-11-17 00:55:43 +00:00
// testing::internal::move - portability wrapper for std::move.
2014-01-29 06:34:44 +00:00
//
2008-07-03 22:38:12 +00:00
// Synchronization:
// Mutex, MutexLock, ThreadLocal, GetThreadCount()
2014-01-12 18:51:09 +00:00
// - synchronization primitives.
2008-07-03 22:38:12 +00:00
//
// Template meta programming:
2008-11-10 18:27:46 +00:00
// is_pointer - as in TR1; needed on Symbian and IBM XL C/C++ only.
2011-04-12 18:24:59 +00:00
// IteratorTraits - partial implementation of std::iterator_traits, which
// is not available in libCstd when compiled with Sun C++.
2008-07-03 22:38:12 +00:00
//
// Smart pointers:
// scoped_ptr - as in TR2.
//
// Regular expressions:
// RE - a simple regular expression class using the POSIX
2010-08-31 18:21:13 +00:00
// Extended Regular Expression syntax on UNIX-like
// platforms, or a reduced regular exception syntax on
// other platforms, including Windows.
2008-07-03 22:38:12 +00:00
//
// Logging:
2008-10-11 07:20:02 +00:00
// GTEST_LOG_() - logs messages at the specified severity level.
2008-07-03 22:38:12 +00:00
// LogToStderr() - directs all log messages to stderr.
// FlushInfoLog() - flushes informational log messages.
//
2010-01-27 22:27:30 +00:00
// Stdout and stderr capturing:
// CaptureStdout() - starts capturing stdout.
// GetCapturedStdout() - stops capturing stdout and returns the captured
// string.
2008-07-03 22:38:12 +00:00
// CaptureStderr() - starts capturing stderr.
// GetCapturedStderr() - stops capturing stderr and returns the captured
// string.
//
// Integer types:
// TypeWithSize - maps an integer to a int type.
// Int32, UInt32, Int64, UInt64, TimeInMillis
// - integers of known sizes.
// BiggestInt - the biggest signed integer type.
//
// Command-line utilities:
// GTEST_DECLARE_*() - declares a flag.
// GTEST_DEFINE_*() - defines a flag.
2011-10-05 05:51:10 +00:00
// GetInjectableArgvs() - returns the command line as a vector of strings.
2008-07-03 22:38:12 +00:00
//
// Environment variable utilities:
// GetEnv() - gets the value of an environment variable.
// BoolFromGTestEnv() - parses a bool environment variable.
// Int32FromGTestEnv() - parses an Int32 environment variable.
// StringFromGTestEnv() - parses a string environment variable.
2010-08-31 18:21:13 +00:00
# include <ctype.h> // for isspace, etc
# include <stddef.h> // for ptrdiff_t
2008-07-03 22:38:12 +00:00
# include <stdlib.h>
# include <stdio.h>
2009-03-26 19:03:47 +00:00
# include <string.h>
2009-06-19 17:23:54 +00:00
# ifndef _WIN32_WCE
2011-02-22 22:08:59 +00:00
# include <sys / types.h>
# include <sys / stat.h>
2009-06-19 17:23:54 +00:00
# endif // !_WIN32_WCE
2009-03-26 19:03:47 +00:00
2012-07-09 13:22:29 +00:00
# if defined __APPLE__
# include <AvailabilityMacros.h>
# include <TargetConditionals.h>
# endif
2014-05-15 19:42:15 +00:00
# include <algorithm> // NOLINT
2009-03-26 19:03:47 +00:00
# include <iostream> // NOLINT
2009-12-23 00:09:23 +00:00
# include <sstream> // NOLINT
# include <string> // NOLINT
2014-01-29 06:34:44 +00:00
# include <utility>
2015-07-24 20:43:09 +00:00
# include <vector> // NOLINT
2008-07-03 22:38:12 +00:00
2015-07-14 19:56:37 +00:00
# include "gtest/internal/gtest-port-arch.h"
# include "gtest/internal/custom/gtest-port.h"
# if !defined(GTEST_DEV_EMAIL_)
# define GTEST_DEV_EMAIL_ "googletestframework@@googlegroups.com"
# define GTEST_FLAG_PREFIX_ "gtest_"
# define GTEST_FLAG_PREFIX_DASH_ "gtest-"
# define GTEST_FLAG_PREFIX_UPPER_ "GTEST_"
# define GTEST_NAME_ "Google Test"
2015-12-23 08:49:14 +00:00
# define GTEST_PROJECT_URL_ "https: //github.com/google/googletest/"
2015-07-14 19:56:37 +00:00
# endif // !defined(GTEST_DEV_EMAIL_)
2008-07-03 22:38:12 +00:00
2015-07-27 21:18:24 +00:00
# if !defined(GTEST_INIT_GOOGLE_TEST_NAME_)
# define GTEST_INIT_GOOGLE_TEST_NAME_ "testing::InitGoogleTest"
# endif // !defined(GTEST_INIT_GOOGLE_TEST_NAME_)
2008-09-26 16:08:30 +00:00
// Determines the version of gcc that is used to compile this.
# ifdef __GNUC__
// 40302 means version 4.3.2.
2011-02-22 22:08:59 +00:00
# define GTEST_GCC_VER_ \
2008-09-26 16:08:30 +00:00
( __GNUC__ * 10000 + __GNUC_MINOR__ * 100 + __GNUC_PATCHLEVEL__ )
# endif // __GNUC__
2014-05-15 19:42:15 +00:00
// Macros for disabling Microsoft Visual C++ warnings.
//
// GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800 4385)
// /* code that triggers warnings C4800 and C4385 */
// GTEST_DISABLE_MSC_WARNINGS_POP_()
# if _MSC_VER >= 1500
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings) \
__pragma ( warning ( push ) ) \
__pragma ( warning ( disable : warnings ) )
# define GTEST_DISABLE_MSC_WARNINGS_POP_() \
__pragma ( warning ( pop ) )
# else
// Older versions of MSVC don't have __pragma.
# define GTEST_DISABLE_MSC_WARNINGS_PUSH_(warnings)
# define GTEST_DISABLE_MSC_WARNINGS_POP_()
# endif
2012-08-14 15:20:28 +00:00
# ifndef GTEST_LANG_CXX11
// gcc and clang define __GXX_EXPERIMENTAL_CXX0X__ when
// -std={c,gnu}++{0x,11} is passed. The C++11 standard specifies a
// value for __cplusplus, and recent versions of clang, gcc, and
// probably other compilers set that too in C++11 mode.
2017-05-03 10:30:11 +00:00
# if __GXX_EXPERIMENTAL_CXX0X__ || __cplusplus >= 201103L || _MSC_VER >= 1900
2012-08-14 15:20:28 +00:00
// Compiling in at least C++11 mode.
# define GTEST_LANG_CXX11 1
# else
# define GTEST_LANG_CXX11 0
# endif
# endif
2014-11-17 00:27:28 +00:00
// Distinct from C++11 language support, some environments don't provide
// proper C++11 library support. Notably, it's possible to build in
// C++11 mode when targeting Mac OS X 10.6, which has an old libstdc++
// with no C++11 support.
//
// libstdc++ has sufficient C++11 support as of GCC 4.6.0, __GLIBCXX__
// 20110325, but maintenance releases in the 4.4 and 4.5 series followed
// this date, so check for those versions by their date stamps.
// https://gcc.gnu.org/onlinedocs/libstdc++/manual/abi.html#abi.versioning
# if GTEST_LANG_CXX11 && \
( ! defined ( __GLIBCXX__ ) | | ( \
__GLIBCXX__ > = 20110325ul & & /* GCC >= 4.6.0 */ \
/* Blacklist of patch releases of older branches: */ \
__GLIBCXX__ ! = 20110416ul & & /* GCC 4.4.6 */ \
__GLIBCXX__ ! = 20120313ul & & /* GCC 4.4.7 */ \
__GLIBCXX__ ! = 20110428ul & & /* GCC 4.5.3 */ \
__GLIBCXX__ ! = 20120702ul ) ) /* GCC 4.5.4 */
# define GTEST_STDLIB_CXX11 1
# endif
// Only use C++11 library features if the library provides them.
# if GTEST_STDLIB_CXX11
# define GTEST_HAS_STD_BEGIN_AND_END_ 1
# define GTEST_HAS_STD_FORWARD_LIST_ 1
2017-05-03 10:30:11 +00:00
# if !defined(_MSC_VER) || (_MSC_FULL_VER >= 190023824) // works only with VS2015U2 and better
# define GTEST_HAS_STD_FUNCTION_ 1
# endif
2013-12-04 23:44:22 +00:00
# define GTEST_HAS_STD_INITIALIZER_LIST_ 1
2014-11-17 00:27:28 +00:00
# define GTEST_HAS_STD_MOVE_ 1
2015-07-27 23:49:18 +00:00
# define GTEST_HAS_STD_SHARED_PTR_ 1
2015-10-12 21:57:51 +00:00
# define GTEST_HAS_STD_TYPE_TRAITS_ 1
# define GTEST_HAS_STD_UNIQUE_PTR_ 1
2017-05-03 10:30:11 +00:00
# define GTEST_HAS_UNORDERED_MAP_ 1
# define GTEST_HAS_UNORDERED_SET_ 1
2013-12-04 23:44:22 +00:00
# endif
2014-01-12 19:59:41 +00:00
// C++11 specifies that <tuple> provides std::tuple.
// Some platforms still might not have it, however.
# if GTEST_LANG_CXX11
# define GTEST_HAS_STD_TUPLE_ 1
# if defined(__clang__)
// Inspired by http://clang.llvm.org/docs/LanguageExtensions.html#__has_include
# if defined(__has_include) && !__has_include(<tuple>)
# undef GTEST_HAS_STD_TUPLE_
# endif
# elif defined(_MSC_VER)
// Inspired by boost/config/stdlib/dinkumware.hpp
# if defined(_CPPLIB_VER) && _CPPLIB_VER < 520
# undef GTEST_HAS_STD_TUPLE_
# endif
# elif defined(__GLIBCXX__)
// Inspired by boost/config/stdlib/libstdcpp3.hpp,
// http://gcc.gnu.org/gcc-4.2/changes.html and
// http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt01ch01.html#manual.intro.status.standard.200x
# if __GNUC__ < 4 || (__GNUC__ == 4 && __GNUC_MINOR__ < 2)
# undef GTEST_HAS_STD_TUPLE_
# endif
# endif
# endif
2010-07-22 21:07:19 +00:00
// Brings in definitions for functions used in the testing::internal::posix
// namespace (read, write, close, chdir, isatty, stat). We do not currently
// use them on Windows Mobile.
2014-03-24 21:58:25 +00:00
# if GTEST_OS_WINDOWS
# if !GTEST_OS_WINDOWS_MOBILE
# include <direct.h>
# include <io.h>
# endif
// In order to avoid having to include <windows.h>, use forward declaration
2016-09-04 21:57:49 +00:00
# if GTEST_OS_WINDOWS_MINGW && !defined(__MINGW64_VERSION_MAJOR)
2016-02-20 03:06:12 +00:00
// MinGW defined _CRITICAL_SECTION and _RTL_CRITICAL_SECTION as two
// separate (equivalent) structs, instead of using typedef
typedef struct _CRITICAL_SECTION GTEST_CRITICAL_SECTION ;
# else
// Assume CRITICAL_SECTION is a typedef of _RTL_CRITICAL_SECTION.
2014-03-24 21:58:25 +00:00
// This assumption is verified by
// WindowsTypesTest.CRITICAL_SECTIONIs_RTL_CRITICAL_SECTION.
2016-02-20 03:06:12 +00:00
typedef struct _RTL_CRITICAL_SECTION GTEST_CRITICAL_SECTION ;
# endif
2014-03-24 21:58:25 +00:00
# else
2010-07-22 21:07:19 +00:00
// This assumes that non-Windows OSes provide unistd.h. For OSes where this
// is not the case, we need to include headers that provide the functions
// mentioned above.
2011-02-22 22:08:59 +00:00
# include <unistd.h>
2012-08-14 15:20:28 +00:00
# include <strings.h>
2014-03-24 21:58:25 +00:00
# endif // GTEST_OS_WINDOWS
2010-07-22 21:07:19 +00:00
2012-09-19 17:58:01 +00:00
# if GTEST_OS_LINUX_ANDROID
// Used to define __ANDROID_API__ matching the target NDK API level.
# include <android / api-level.h> // NOLINT
# endif
2010-07-22 21:07:19 +00:00
// Defines this to true iff Google Test can use POSIX regular expressions.
# ifndef GTEST_HAS_POSIX_RE
2012-09-19 17:58:01 +00:00
# if GTEST_OS_LINUX_ANDROID
// On Android, <regex.h> is only available starting with Gingerbread.
# define GTEST_HAS_POSIX_RE (__ANDROID_API__ >= 9)
# else
# define GTEST_HAS_POSIX_RE (!GTEST_OS_WINDOWS)
# endif
2010-07-22 21:07:19 +00:00
# endif
2015-07-14 19:56:37 +00:00
# if GTEST_USES_PCRE
// The appropriate headers have already been included.
# elif GTEST_HAS_POSIX_RE
2009-01-29 01:28:52 +00:00
// On some platforms, <regex.h> needs someone to define size_t, and
// won't compile otherwise. We can #include it here as we already
// included <stdlib.h>, which is guaranteed to define size_t through
// <stddef.h>.
2011-02-22 22:08:59 +00:00
# include <regex.h> // NOLINT
2009-03-26 19:03:47 +00:00
2011-02-22 22:08:59 +00:00
# define GTEST_USES_POSIX_RE 1
2009-01-29 01:28:52 +00:00
2009-03-26 19:03:47 +00:00
# elif GTEST_OS_WINDOWS
// <regex.h> is not available on Windows. Use our own simple regex
// implementation instead.
2011-02-22 22:08:59 +00:00
# define GTEST_USES_SIMPLE_RE 1
2009-03-26 19:03:47 +00:00
2009-01-29 01:28:52 +00:00
# else
2009-03-06 01:20:15 +00:00
// <regex.h> may not be available on this platform. Use our own
// simple regex implementation instead.
2011-02-22 22:08:59 +00:00
# define GTEST_USES_SIMPLE_RE 1
2009-01-29 01:28:52 +00:00
2015-07-14 19:56:37 +00:00
# endif // GTEST_USES_PCRE
2009-01-29 01:28:52 +00:00
2010-02-03 02:27:02 +00:00
# ifndef GTEST_HAS_EXCEPTIONS
// The user didn't tell us whether exceptions are enabled, so we need
// to figure it out.
2011-02-22 22:08:59 +00:00
# if defined(_MSC_VER) || defined(__BORLANDC__)
2009-04-28 00:28:09 +00:00
// MSVC's and C++Builder's implementations of the STL use the _HAS_EXCEPTIONS
// macro to enable exceptions, so we'll do the same.
2008-07-03 22:38:12 +00:00
// Assumes that exceptions are enabled by default.
2011-02-22 22:08:59 +00:00
# ifndef _HAS_EXCEPTIONS
# define _HAS_EXCEPTIONS 1
# endif // _HAS_EXCEPTIONS
# define GTEST_HAS_EXCEPTIONS _HAS_EXCEPTIONS
2015-01-08 03:34:16 +00:00
# elif defined(__clang__)
2015-01-14 06:35:05 +00:00
// clang defines __EXCEPTIONS iff exceptions are enabled before clang 220714,
// but iff cleanups are enabled after that. In Obj-C++ files, there can be
// cleanups for ObjC exceptions which also need cleanups, even if C++ exceptions
// are disabled. clang has __has_feature(cxx_exceptions) which checks for C++
// exceptions starting at clang r206352, but which checked for cleanups prior to
// that. To reliably check for C++ exception availability with clang, check for
// __EXCEPTIONS && __has_feature(cxx_exceptions).
2015-01-22 00:58:35 +00:00
# define GTEST_HAS_EXCEPTIONS (__EXCEPTIONS && __has_feature(cxx_exceptions))
2011-02-22 22:08:59 +00:00
# elif defined(__GNUC__) && __EXCEPTIONS
2010-02-03 02:27:02 +00:00
// gcc defines __EXCEPTIONS to 1 iff exceptions are enabled.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_EXCEPTIONS 1
# elif defined(__SUNPRO_CC)
2010-02-03 02:27:02 +00:00
// Sun Pro CC supports exceptions. However, there is no compile-time way of
// detecting whether they are enabled or not. Therefore, we assume that
// they are enabled unless the user tells us otherwise.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_EXCEPTIONS 1
# elif defined(__IBMCPP__) && __EXCEPTIONS
2010-03-17 18:22:59 +00:00
// xlC defines __EXCEPTIONS to 1 iff exceptions are enabled.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_EXCEPTIONS 1
2011-04-07 18:36:50 +00:00
# elif defined(__HP_aCC)
// Exception handling is in effect by default in HP aCC compiler. It has to
// be turned of by +noeh compiler option if desired.
# define GTEST_HAS_EXCEPTIONS 1
2011-02-22 22:08:59 +00:00
# else
2010-02-03 02:27:02 +00:00
// For other compilers, we assume exceptions are disabled to be
// conservative.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_EXCEPTIONS 0
# endif // defined(_MSC_VER) || defined(__BORLANDC__)
2010-02-03 02:27:02 +00:00
# endif // GTEST_HAS_EXCEPTIONS
2008-07-03 22:38:12 +00:00
2009-12-16 23:34:59 +00:00
# if !defined(GTEST_HAS_STD_STRING)
// Even though we don't use this macro any longer, we keep it in case
// some clients still depend on it.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_STD_STRING 1
2009-12-16 23:34:59 +00:00
# elif !GTEST_HAS_STD_STRING
// The user told us that ::std::string isn't available.
2011-02-22 22:08:59 +00:00
# error "Google Test cannot be used where ::std::string isn't available."
2009-12-16 23:34:59 +00:00
# endif // !defined(GTEST_HAS_STD_STRING)
2008-07-03 22:38:12 +00:00
# ifndef GTEST_HAS_GLOBAL_STRING
// The user didn't tell us whether ::string is available, so we need
// to figure it out.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_GLOBAL_STRING 0
2008-07-03 22:38:12 +00:00
# endif // GTEST_HAS_GLOBAL_STRING
# ifndef GTEST_HAS_STD_WSTRING
// The user didn't tell us whether ::std::wstring is available, so we need
// to figure it out.
// TODO(wan@google.com): uses autoconf to detect whether ::std::wstring
// is available.
2010-07-22 21:07:19 +00:00
// Cygwin 1.7 and below doesn't support ::std::wstring.
2011-03-11 23:05:00 +00:00
// Solaris' libc++ doesn't support it either. Android has
// no support for it at least as recent as Froyo (2.2).
# define GTEST_HAS_STD_WSTRING \
( ! ( GTEST_OS_LINUX_ANDROID | | GTEST_OS_CYGWIN | | GTEST_OS_SOLARIS ) )
2008-07-03 22:38:12 +00:00
# endif // GTEST_HAS_STD_WSTRING
# ifndef GTEST_HAS_GLOBAL_WSTRING
// The user didn't tell us whether ::wstring is available, so we need
// to figure it out.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_GLOBAL_WSTRING \
2009-01-21 00:32:01 +00:00
( GTEST_HAS_STD_WSTRING & & GTEST_HAS_GLOBAL_STRING )
2008-07-03 22:38:12 +00:00
# endif // GTEST_HAS_GLOBAL_WSTRING
2008-09-26 16:08:30 +00:00
// Determines whether RTTI is available.
# ifndef GTEST_HAS_RTTI
// The user didn't tell us whether RTTI is enabled, so we need to
// figure it out.
2011-02-22 22:08:59 +00:00
# ifdef _MSC_VER
2008-09-26 16:08:30 +00:00
2011-02-22 22:08:59 +00:00
# ifdef _CPPRTTI // MSVC defines this macro iff RTTI is enabled.
# define GTEST_HAS_RTTI 1
# else
# define GTEST_HAS_RTTI 0
# endif
2008-09-26 16:08:30 +00:00
// Starting with version 4.3.2, gcc defines __GXX_RTTI iff RTTI is enabled.
2011-02-22 22:08:59 +00:00
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40302)
2010-03-26 05:35:42 +00:00
2011-02-22 22:08:59 +00:00
# ifdef __GXX_RTTI
2012-09-19 17:58:01 +00:00
// When building against STLport with the Android NDK and with
// -frtti -fno-exceptions, the build fails at link time with undefined
// references to __cxa_bad_typeid. Note sure if STL or toolchain bug,
// so disable RTTI when detected.
# if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR) && \
! defined ( __EXCEPTIONS )
# define GTEST_HAS_RTTI 0
# else
# define GTEST_HAS_RTTI 1
# endif // GTEST_OS_LINUX_ANDROID && __STLPORT_MAJOR && !__EXCEPTIONS
2011-02-22 22:08:59 +00:00
# else
# define GTEST_HAS_RTTI 0
# endif // __GXX_RTTI
2008-09-26 16:08:30 +00:00
2012-05-02 18:09:59 +00:00
// Clang defines __GXX_RTTI starting with version 3.0, but its manual recommends
// using has_feature instead. has_feature(cxx_rtti) is supported since 2.7, the
// first version with C++ support.
# elif defined(__clang__)
# define GTEST_HAS_RTTI __has_feature(cxx_rtti)
2010-03-26 05:35:42 +00:00
// Starting with version 9.0 IBM Visual Age defines __RTTI_ALL__ to 1 if
// both the typeid and dynamic_cast features are present.
2011-02-22 22:08:59 +00:00
# elif defined(__IBMCPP__) && (__IBMCPP__ >= 900)
2010-03-25 18:57:09 +00:00
2011-02-22 22:08:59 +00:00
# ifdef __RTTI_ALL__
# define GTEST_HAS_RTTI 1
# else
# define GTEST_HAS_RTTI 0
# endif
2010-03-25 18:57:09 +00:00
2011-02-22 22:08:59 +00:00
# else
2008-09-26 16:08:30 +00:00
2010-03-26 05:35:42 +00:00
// For all other compilers, we assume RTTI is enabled.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_RTTI 1
2008-09-26 16:08:30 +00:00
2011-02-22 22:08:59 +00:00
# endif // _MSC_VER
2008-09-26 16:08:30 +00:00
# endif // GTEST_HAS_RTTI
2010-03-23 15:58:37 +00:00
// It's this header's responsibility to #include <typeinfo> when RTTI
// is enabled.
# if GTEST_HAS_RTTI
2011-02-22 22:08:59 +00:00
# include <typeinfo>
2010-03-23 15:58:37 +00:00
# endif
2010-02-24 17:19:25 +00:00
// Determines whether Google Test can use the pthreads library.
2008-10-11 07:20:02 +00:00
# ifndef GTEST_HAS_PTHREAD
2015-02-14 02:26:43 +00:00
// The user didn't tell us explicitly, so we make reasonable assumptions about
// which platforms have pthreads support.
2010-02-24 17:19:25 +00:00
//
// To disable threading support in Google Test, add -DGTEST_HAS_PTHREAD=0
// to your compiler flags.
2017-08-29 19:45:26 +00:00
# define GTEST_HAS_PTHREAD \
( GTEST_OS_LINUX | | GTEST_OS_MAC | | GTEST_OS_HPUX | | GTEST_OS_QNX | | \
GTEST_OS_FREEBSD | | GTEST_OS_NACL | | GTEST_OS_NETBSD | | GTEST_OS_FUCHSIA )
2008-10-11 07:20:02 +00:00
# endif // GTEST_HAS_PTHREAD
2010-07-12 19:17:22 +00:00
# if GTEST_HAS_PTHREAD
// gtest-port.h guarantees to #include <pthread.h> when GTEST_HAS_PTHREAD is
// true.
2011-02-22 22:08:59 +00:00
# include <pthread.h> // NOLINT
2010-07-22 21:07:19 +00:00
// For timespec and nanosleep, used below.
2011-02-22 22:08:59 +00:00
# include <time.h> // NOLINT
2010-07-12 19:17:22 +00:00
# endif
2015-07-17 23:08:48 +00:00
// Determines if hash_map/hash_set are available.
// Only used for testing against those containers.
# if !defined(GTEST_HAS_HASH_MAP_)
2017-03-02 00:44:47 +00:00
# if defined(_MSC_VER) && (_MSC_VER < 1900)
2015-07-17 23:08:48 +00:00
# define GTEST_HAS_HASH_MAP_ 1 // Indicates that hash_map is available.
# define GTEST_HAS_HASH_SET_ 1 // Indicates that hash_set is available.
# endif // _MSC_VER
# endif // !defined(GTEST_HAS_HASH_MAP_)
2009-06-17 21:06:27 +00:00
// Determines whether Google Test can use tr1/tuple. You can define
// this macro to 0 to prevent Google Test from using tuple (any
// feature depending on tuple with be disabled in this mode).
2008-11-20 01:40:35 +00:00
# ifndef GTEST_HAS_TR1_TUPLE
2012-09-19 17:58:01 +00:00
# if GTEST_OS_LINUX_ANDROID && defined(_STLPORT_MAJOR)
// STLport, provided with the Android NDK, has neither <tr1/tuple> or <tuple>.
# define GTEST_HAS_TR1_TUPLE 0
2017-12-07 17:20:25 +00:00
# elif defined(_MSC_VER) && (_MSC_VER >= 1910)
// Prevent `warning C4996: 'std::tr1': warning STL4002: The non-Standard std::tr1 namespace and TR1-only machinery are deprecated and will be REMOVED.`
# define GTEST_HAS_TR1_TUPLE 0
2012-09-19 17:58:01 +00:00
# else
2009-06-17 21:06:27 +00:00
// The user didn't tell us not to do it, so we assume it's OK.
2012-09-19 17:58:01 +00:00
# define GTEST_HAS_TR1_TUPLE 1
# endif
2009-06-17 21:06:27 +00:00
# endif // GTEST_HAS_TR1_TUPLE
// Determines whether Google Test's own tr1 tuple implementation
// should be used.
# ifndef GTEST_USE_OWN_TR1_TUPLE
2008-11-20 01:40:35 +00:00
// The user didn't tell us, so we need to figure it out.
2010-01-27 22:27:30 +00:00
// We use our own TR1 tuple if we aren't sure the user has an
2012-08-14 15:20:28 +00:00
// implementation of it already. At this time, libstdc++ 4.0.0+ and
// MSVC 2010 are the only mainstream standard libraries that come
// with a TR1 tuple implementation. NVIDIA's CUDA NVCC compiler
// pretends to be GCC by defining __GNUC__ and friends, but cannot
// compile GCC's tuple implementation. MSVC 2008 (9.0) provides TR1
// tuple in a 323 MB Feature Pack download, which we cannot assume the
// user has. QNX's QCC compiler is a modified GCC but it doesn't
// support TR1 tuple. libc++ only provides std::tuple, in C++11 mode,
// and it can be used with some compilers that define __GNUC__.
2011-06-20 21:43:18 +00:00
# if (defined(__GNUC__) && !defined(__CUDACC__) && (GTEST_GCC_VER_ >= 40000) \
2017-05-03 10:30:11 +00:00
& & ! GTEST_OS_QNX & & ! defined ( _LIBCPP_VERSION ) ) \
| | ( _MSC_VER > = 1600 & & _MSC_VER < 1900 )
2012-08-14 15:20:28 +00:00
# define GTEST_ENV_HAS_TR1_TUPLE_ 1
# endif
2012-12-03 18:52:06 +00:00
// C++11 specifies that <tuple> provides std::tuple. Use that if gtest is used
// in C++11 mode and libstdc++ isn't very old (binaries targeting OS X 10.6
// can build with clang but need to use gcc4.2's libstdc++).
# if GTEST_LANG_CXX11 && (!defined(__GLIBCXX__) || __GLIBCXX__ > 20110325)
2012-08-14 15:20:28 +00:00
# define GTEST_ENV_HAS_STD_TUPLE_ 1
# endif
# if GTEST_ENV_HAS_TR1_TUPLE_ || GTEST_ENV_HAS_STD_TUPLE_
2011-02-22 22:08:59 +00:00
# define GTEST_USE_OWN_TR1_TUPLE 0
# else
# define GTEST_USE_OWN_TR1_TUPLE 1
# endif
2009-06-17 21:06:27 +00:00
# endif // GTEST_USE_OWN_TR1_TUPLE
2008-11-20 01:40:35 +00:00
2008-12-09 00:54:04 +00:00
// To avoid conditional compilation everywhere, we make it
// gtest-port.h's responsibility to #include the header implementing
2014-04-02 20:26:07 +00:00
// tuple.
2014-05-15 19:42:15 +00:00
# if GTEST_HAS_STD_TUPLE_
# include <tuple> // IWYU pragma: export
2014-04-02 20:26:07 +00:00
# define GTEST_TUPLE_NAMESPACE_ ::std
2014-05-15 19:42:15 +00:00
# endif // GTEST_HAS_STD_TUPLE_
2014-04-02 20:26:07 +00:00
2014-05-15 19:42:15 +00:00
// We include tr1::tuple even if std::tuple is available to define printers for
// them.
2008-12-09 00:54:04 +00:00
# if GTEST_HAS_TR1_TUPLE
2014-04-02 20:26:07 +00:00
# ifndef GTEST_TUPLE_NAMESPACE_
# define GTEST_TUPLE_NAMESPACE_ ::std::tr1
# endif // GTEST_TUPLE_NAMESPACE_
2009-06-09 05:52:03 +00:00
2011-02-22 22:08:59 +00:00
# if GTEST_USE_OWN_TR1_TUPLE
2014-05-15 19:42:15 +00:00
# include "gtest / internal / gtest-tuple.h" // IWYU pragma: export // NOLINT
2012-08-14 15:20:28 +00:00
# elif GTEST_ENV_HAS_STD_TUPLE_
# include <tuple>
// C++11 puts its tuple into the ::std namespace rather than
// ::std::tr1. gtest expects tuple to live in ::std::tr1, so put it there.
// This causes undefined behavior, but supported compilers react in
// the way we intend.
namespace std {
namespace tr1 {
using : : std : : get ;
using : : std : : make_tuple ;
using : : std : : tuple ;
using : : std : : tuple_element ;
using : : std : : tuple_size ;
}
}
2011-02-22 22:08:59 +00:00
# elif GTEST_OS_SYMBIAN
2009-06-09 05:52:03 +00:00
// On Symbian, BOOST_HAS_TR1_TUPLE causes Boost's TR1 tuple library to
// use STLport's tuple implementation, which unfortunately doesn't
// work as the copy of STLport distributed with Symbian is incomplete.
// By making sure BOOST_HAS_TR1_TUPLE is undefined, we force Boost to
// use its own tuple implementation.
2011-02-22 22:08:59 +00:00
# ifdef BOOST_HAS_TR1_TUPLE
# undef BOOST_HAS_TR1_TUPLE
# endif // BOOST_HAS_TR1_TUPLE
2009-06-09 05:52:03 +00:00
// This prevents <boost/tr1/detail/config.hpp>, which defines
// BOOST_HAS_TR1_TUPLE, from being #included by Boost's <tuple>.
2011-02-22 22:08:59 +00:00
# define BOOST_TR1_DETAIL_CONFIG_HPP_INCLUDED
2014-05-15 19:42:15 +00:00
# include <tuple> // IWYU pragma: export // NOLINT
2009-06-09 05:52:03 +00:00
2011-02-22 22:08:59 +00:00
# elif defined(__GNUC__) && (GTEST_GCC_VER_ >= 40000)
2009-05-05 19:31:00 +00:00
// GCC 4.0+ implements tr1/tuple in the <tr1/tuple> header. This does
// not conform to the TR1 spec, which requires the header to be <tuple>.
2009-06-11 03:33:05 +00:00
2011-02-22 22:08:59 +00:00
# if !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
2009-06-11 03:33:05 +00:00
// Until version 4.3.2, gcc has a bug that causes <tr1/functional>,
// which is #included by <tr1/tuple>, to not compile when RTTI is
// disabled. _TR1_FUNCTIONAL is the header guard for
// <tr1/functional>. Hence the following #define is a hack to prevent
// <tr1/functional> from being included.
2011-02-22 22:08:59 +00:00
# define _TR1_FUNCTIONAL 1
# include <tr1 / tuple>
# undef _TR1_FUNCTIONAL // Allows the user to #include
2017-09-27 12:31:13 +00:00
// <tr1/functional> if they choose to.
2011-02-22 22:08:59 +00:00
# else
# include <tr1 / tuple> // NOLINT
# endif // !GTEST_HAS_RTTI && GTEST_GCC_VER_ < 40302
2009-06-11 03:33:05 +00:00
2011-02-22 22:08:59 +00:00
# else
2009-05-05 19:31:00 +00:00
// If the compiler is not GCC 4.0+, we assume the user is using a
2008-12-09 00:54:04 +00:00
// spec-conforming TR1 implementation.
2014-05-15 19:42:15 +00:00
# include <tuple> // IWYU pragma: export // NOLINT
2011-02-22 22:08:59 +00:00
# endif // GTEST_USE_OWN_TR1_TUPLE
2009-06-09 05:52:03 +00:00
2008-12-09 00:54:04 +00:00
# endif // GTEST_HAS_TR1_TUPLE
2008-12-02 23:35:18 +00:00
// Determines whether clone(2) is supported.
// Usually it will only be available on Linux, excluding
// Linux on the Itanium architecture.
// Also see http://linux.die.net/man/2/clone.
# ifndef GTEST_HAS_CLONE
// The user didn't tell us, so we need to figure it out.
2011-02-22 22:08:59 +00:00
# if GTEST_OS_LINUX && !defined(__ia64__)
2012-09-19 17:58:01 +00:00
# if GTEST_OS_LINUX_ANDROID
2016-11-01 13:32:25 +00:00
// On Android, clone() became available at different API levels for each 32-bit
// architecture.
# if defined(__LP64__) || \
( defined ( __arm__ ) & & __ANDROID_API__ > = 9 ) | | \
( defined ( __mips__ ) & & __ANDROID_API__ > = 12 ) | | \
( defined ( __i386__ ) & & __ANDROID_API__ > = 17 )
2012-09-19 17:58:01 +00:00
# define GTEST_HAS_CLONE 1
# else
# define GTEST_HAS_CLONE 0
# endif
# else
# define GTEST_HAS_CLONE 1
# endif
2011-02-22 22:08:59 +00:00
# else
# define GTEST_HAS_CLONE 0
# endif // GTEST_OS_LINUX && !defined(__ia64__)
2008-12-02 23:35:18 +00:00
# endif // GTEST_HAS_CLONE
2010-01-28 21:50:29 +00:00
// Determines whether to support stream redirection. This is used to test
// output correctness and to implement death tests.
2010-08-31 18:21:13 +00:00
# ifndef GTEST_HAS_STREAM_REDIRECTION
// By default, we assume that stream redirection is supported on all
// platforms except known mobile ones.
2014-05-15 19:42:15 +00:00
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_SYMBIAN || \
GTEST_OS_WINDOWS_PHONE | | GTEST_OS_WINDOWS_RT
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_STREAM_REDIRECTION 0
# else
# define GTEST_HAS_STREAM_REDIRECTION 1
# endif // !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_SYMBIAN
2010-08-31 18:21:13 +00:00
# endif // GTEST_HAS_STREAM_REDIRECTION
2010-01-28 21:50:29 +00:00
2008-07-03 22:38:12 +00:00
// Determines whether to support death tests.
2009-12-16 23:34:59 +00:00
// Google Test does not support death tests for VC 7.1 and earlier as
// abort() in a VC 7.1 application compiled as GUI in debug config
// pops up a dialog window that cannot be suppressed programmatically.
2012-07-09 13:22:29 +00:00
# if (GTEST_OS_LINUX || GTEST_OS_CYGWIN || GTEST_OS_SOLARIS || \
2014-11-17 02:38:21 +00:00
( GTEST_OS_MAC & & ! GTEST_OS_IOS ) | | \
2010-03-23 19:53:07 +00:00
( GTEST_OS_WINDOWS_DESKTOP & & _MSC_VER > = 1400 ) | | \
2011-05-03 01:58:34 +00:00
GTEST_OS_WINDOWS_MINGW | | GTEST_OS_AIX | | GTEST_OS_HPUX | | \
2017-05-06 02:09:32 +00:00
GTEST_OS_OPENBSD | | GTEST_OS_QNX | | GTEST_OS_FREEBSD | | GTEST_OS_NETBSD )
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_DEATH_TEST 1
2009-03-17 21:03:35 +00:00
# endif
2008-07-03 22:38:12 +00:00
2008-09-08 17:55:52 +00:00
// Determines whether to support type-driven tests.
2010-03-17 18:22:59 +00:00
// Typed tests need <typeinfo> and variadic macros, which GCC, VC++ 8.0,
2011-04-07 18:36:50 +00:00
// Sun Pro CC, IBM Visual Age, and HP aCC support.
2010-03-17 18:22:59 +00:00
# if defined(__GNUC__) || (_MSC_VER >= 1400) || defined(__SUNPRO_CC) || \
2011-04-07 18:36:50 +00:00
defined ( __IBMCPP__ ) | | defined ( __HP_aCC )
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_TYPED_TEST 1
# define GTEST_HAS_TYPED_TEST_P 1
2010-02-03 02:27:02 +00:00
# endif
2008-09-08 17:55:52 +00:00
2017-09-04 17:38:35 +00:00
// Determines whether to support Combine().
// The implementation doesn't work on Sun Studio since it doesn't
// understand templated conversion operators.
2018-01-02 17:55:44 +00:00
# if (GTEST_HAS_TR1_TUPLE || GTEST_HAS_STD_TUPLE_) && !defined(__SUNPRO_CC)
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_COMBINE 1
2010-03-23 15:58:37 +00:00
# endif
2008-11-20 01:40:35 +00:00
2008-08-25 23:11:54 +00:00
// Determines whether the system compiler uses UTF-16 for encoding wide strings.
2009-02-23 23:21:55 +00:00
# define GTEST_WIDE_STRING_USES_UTF16_ \
2010-03-17 18:22:59 +00:00
( GTEST_OS_WINDOWS | | GTEST_OS_CYGWIN | | GTEST_OS_SYMBIAN | | GTEST_OS_AIX )
2008-08-25 23:11:54 +00:00
2010-08-19 22:16:00 +00:00
// Determines whether test results can be streamed to a socket.
# if GTEST_OS_LINUX
2011-02-22 22:08:59 +00:00
# define GTEST_CAN_STREAM_RESULTS_ 1
2010-08-19 22:16:00 +00:00
# endif
2008-07-03 22:38:12 +00:00
// Defines some utility macros.
// The GNU compiler emits a warning if nested "if" statements are followed by
// an "else" statement and braces are not used to explicitly disambiguate the
// "else" binding. This leads to problems with code like:
//
// if (gate)
// ASSERT_*(condition) << "Some message";
//
// The "switch (0) case 0:" idiom is used to suppress this.
# ifdef __INTEL_COMPILER
2011-02-22 22:08:59 +00:00
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_
2008-07-03 22:38:12 +00:00
# else
2011-02-22 22:08:59 +00:00
# define GTEST_AMBIGUOUS_ELSE_BLOCKER_ switch (0) case 0: default: // NOLINT
2008-07-03 22:38:12 +00:00
# endif
2009-04-03 00:11:11 +00:00
// Use this annotation at the end of a struct/class definition to
2008-07-03 22:38:12 +00:00
// prevent the compiler from optimizing away instances that are never
// used. This is useful when all interesting logic happens inside the
// c'tor and / or d'tor. Example:
//
// struct Foo {
// Foo() { ... }
2008-10-11 07:20:02 +00:00
// } GTEST_ATTRIBUTE_UNUSED_;
2009-04-03 00:11:11 +00:00
//
// Also use it after a variable or parameter declaration to tell the
// compiler the variable/parameter does not have to be used.
2008-08-01 19:04:48 +00:00
# if defined(__GNUC__) && !defined(COMPILER_ICC)
2011-02-22 22:08:59 +00:00
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
2014-11-17 02:11:23 +00:00
# elif defined(__clang__)
# if __has_attribute(unused)
# define GTEST_ATTRIBUTE_UNUSED_ __attribute__ ((unused))
# endif
# endif
# ifndef GTEST_ATTRIBUTE_UNUSED_
2011-02-22 22:08:59 +00:00
# define GTEST_ATTRIBUTE_UNUSED_
2008-08-01 19:04:48 +00:00
# endif
2008-07-03 22:38:12 +00:00
2016-12-22 01:40:58 +00:00
// Use this annotation before a function that takes a printf format string.
# if defined(__GNUC__) && !defined(COMPILER_ICC)
# if defined(__MINGW_PRINTF_FORMAT)
// MinGW has two different printf implementations. Ensure the format macro
// matches the selected implementation. See
// https://sourceforge.net/p/mingw-w64/wiki2/gnu%20printf/.
# define GTEST_ATTRIBUTE_PRINTF_(string_index, first_to_check) \
__attribute__ ( ( __format__ ( __MINGW_PRINTF_FORMAT , string_index , \
first_to_check ) ) )
# else
# define GTEST_ATTRIBUTE_PRINTF_(string_index, first_to_check) \
__attribute__ ( ( __format__ ( __printf__ , string_index , first_to_check ) ) )
# endif
# else
# define GTEST_ATTRIBUTE_PRINTF_(string_index, first_to_check)
# endif
2009-12-23 00:09:23 +00:00
// A macro to disallow operator=
// This should be used in the private: declarations for a class.
# define GTEST_DISALLOW_ASSIGN_(type)\
void operator = ( type const & )
// A macro to disallow copy constructor and operator=
2008-07-03 22:38:12 +00:00
// This should be used in the private: declarations for a class.
2008-10-11 07:20:02 +00:00
# define GTEST_DISALLOW_COPY_AND_ASSIGN_(type)\
2009-12-23 00:09:23 +00:00
type ( type const & ) ; \
GTEST_DISALLOW_ASSIGN_ ( type )
2008-07-03 22:38:12 +00:00
// Tell the compiler to warn about unused return values for functions declared
// with this macro. The macro should be used on function declarations
// following the argument list:
//
2008-10-11 07:20:02 +00:00
// Sprocket* AllocateSprocket() GTEST_MUST_USE_RESULT_;
2008-09-26 16:08:30 +00:00
# if defined(__GNUC__) && (GTEST_GCC_VER_ >= 30400) && !defined(COMPILER_ICC)
2011-02-22 22:08:59 +00:00
# define GTEST_MUST_USE_RESULT_ __attribute__ ((warn_unused_result))
2008-07-03 22:38:12 +00:00
# else
2011-02-22 22:08:59 +00:00
# define GTEST_MUST_USE_RESULT_
2008-09-26 16:08:30 +00:00
# endif // __GNUC__ && (GTEST_GCC_VER_ >= 30400) && !COMPILER_ICC
2008-07-03 22:38:12 +00:00
2014-01-29 07:29:19 +00:00
// MS C++ compiler emits warning when a conditional expression is compile time
// constant. In some contexts this warning is false positive and needs to be
// suppressed. Use the following two macros in such cases:
//
2014-05-15 19:42:15 +00:00
// GTEST_INTENTIONAL_CONST_COND_PUSH_()
2014-01-29 07:29:19 +00:00
// while (true) {
2014-05-15 19:42:15 +00:00
// GTEST_INTENTIONAL_CONST_COND_POP_()
2014-01-29 07:29:19 +00:00
// }
2014-05-15 19:42:15 +00:00
# define GTEST_INTENTIONAL_CONST_COND_PUSH_() \
GTEST_DISABLE_MSC_WARNINGS_PUSH_ ( 4127 )
# define GTEST_INTENTIONAL_CONST_COND_POP_() \
GTEST_DISABLE_MSC_WARNINGS_POP_ ( )
2014-01-29 07:29:19 +00:00
2009-04-25 04:42:30 +00:00
// Determine whether the compiler supports Microsoft's Structured Exception
// Handling. This is supported by several Windows compilers but generally
// does not exist on any other system.
# ifndef GTEST_HAS_SEH
// The user didn't tell us, so we need to figure it out.
2011-02-22 22:08:59 +00:00
# if defined(_MSC_VER) || defined(__BORLANDC__)
2009-04-25 04:42:30 +00:00
// These two compilers are known to support SEH.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_SEH 1
# else
2009-04-25 04:42:30 +00:00
// Assume no SEH.
2011-02-22 22:08:59 +00:00
# define GTEST_HAS_SEH 0
# endif
2009-04-25 04:42:30 +00:00
2014-03-24 21:58:25 +00:00
# define GTEST_IS_THREADSAFE \
2015-07-14 19:56:37 +00:00
( GTEST_HAS_MUTEX_AND_THREAD_LOCAL_ \
2014-06-18 21:31:01 +00:00
| | ( GTEST_OS_WINDOWS & & ! GTEST_OS_WINDOWS_PHONE & & ! GTEST_OS_WINDOWS_RT ) \
| | GTEST_HAS_PTHREAD )
2014-03-24 21:58:25 +00:00
2009-04-25 04:42:30 +00:00
# endif // GTEST_HAS_SEH
2017-05-04 09:47:19 +00:00
// GTEST_API_ qualifies all symbols that must be exported. The definitions below
// are guarded by #ifndef to give embedders a chance to define GTEST_API_ in
// gtest/internal/custom/gtest-port.h
# ifndef GTEST_API_
2010-03-05 21:21:06 +00:00
# ifdef _MSC_VER
2011-02-22 22:08:59 +00:00
# if GTEST_LINKED_AS_SHARED_LIBRARY
# define GTEST_API_ __declspec(dllimport)
# elif GTEST_CREATE_SHARED_LIBRARY
# define GTEST_API_ __declspec(dllexport)
# endif
2015-10-05 21:27:17 +00:00
# elif __GNUC__ >= 4 || defined(__clang__)
# define GTEST_API_ __attribute__((visibility ("default")))
# endif // _MSC_VER
2010-03-05 21:21:06 +00:00
2017-05-04 09:47:19 +00:00
# endif // GTEST_API_
2010-03-05 21:21:06 +00:00
# ifndef GTEST_API_
2011-02-22 22:08:59 +00:00
# define GTEST_API_
2017-05-04 09:47:19 +00:00
# endif // GTEST_API_
2010-03-05 21:21:06 +00:00
2011-04-15 19:50:39 +00:00
# ifdef __GNUC__
2011-04-14 19:36:05 +00:00
// Ask the compiler to never inline a given function.
2011-04-15 19:50:39 +00:00
# define GTEST_NO_INLINE_ __attribute__((noinline))
2011-04-14 19:36:05 +00:00
# else
2011-04-15 19:50:39 +00:00
# define GTEST_NO_INLINE_
# endif
2011-04-14 19:36:05 +00:00
2011-08-16 00:47:22 +00:00
// _LIBCPP_VERSION is defined by the libc++ library from the LLVM project.
# if defined(__GLIBCXX__) || defined(_LIBCPP_VERSION)
# define GTEST_HAS_CXXABI_H_ 1
# else
# define GTEST_HAS_CXXABI_H_ 0
# endif
2013-12-03 22:38:22 +00:00
// A function level attribute to disable checking for use of uninitialized
// memory when built with MemorySanitizer.
# if defined(__clang__)
# if __has_feature(memory_sanitizer)
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_ \
__attribute__ ( ( no_sanitize_memory ) )
# else
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
2014-01-29 06:34:44 +00:00
# endif // __has_feature(memory_sanitizer)
2013-12-03 22:38:22 +00:00
# else
# define GTEST_ATTRIBUTE_NO_SANITIZE_MEMORY_
2014-01-29 06:34:44 +00:00
# endif // __clang__
// A function level attribute to disable AddressSanitizer instrumentation.
# if defined(__clang__)
# if __has_feature(address_sanitizer)
# define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_ \
__attribute__ ( ( no_sanitize_address ) )
# else
# define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
# endif // __has_feature(address_sanitizer)
# else
# define GTEST_ATTRIBUTE_NO_SANITIZE_ADDRESS_
# endif // __clang__
2013-12-03 22:38:22 +00:00
2014-03-12 22:55:56 +00:00
// A function level attribute to disable ThreadSanitizer instrumentation.
# if defined(__clang__)
# if __has_feature(thread_sanitizer)
# define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_ \
__attribute__ ( ( no_sanitize_thread ) )
# else
# define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
# endif // __has_feature(thread_sanitizer)
# else
# define GTEST_ATTRIBUTE_NO_SANITIZE_THREAD_
# endif // __clang__
2008-07-03 22:38:12 +00:00
namespace testing {
class Message ;
2014-05-15 19:42:15 +00:00
# if defined(GTEST_TUPLE_NAMESPACE_)
2014-04-02 20:26:07 +00:00
// Import tuple and friends into the ::testing namespace.
// It is part of our interface, having them in ::testing allows us to change
// their types as needed.
using GTEST_TUPLE_NAMESPACE_ : : get ;
using GTEST_TUPLE_NAMESPACE_ : : make_tuple ;
using GTEST_TUPLE_NAMESPACE_ : : tuple ;
using GTEST_TUPLE_NAMESPACE_ : : tuple_size ;
using GTEST_TUPLE_NAMESPACE_ : : tuple_element ;
2014-05-15 19:42:15 +00:00
# endif // defined(GTEST_TUPLE_NAMESPACE_)
2014-04-02 20:26:07 +00:00
2008-07-03 22:38:12 +00:00
namespace internal {
2013-02-28 23:46:07 +00:00
// A secret type that Google Test users don't know about. It has no
// definition on purpose. Therefore it's impossible to create a
// Secret object, which is what we want.
class Secret ;
2010-05-10 17:11:58 +00:00
// The GTEST_COMPILE_ASSERT_ macro can be used to verify that a compile time
// expression is true. For example, you could use it to verify the
// size of a static array:
//
2013-12-03 23:15:40 +00:00
// GTEST_COMPILE_ASSERT_(GTEST_ARRAY_SIZE_(names) == NUM_NAMES,
// names_incorrect_size);
2010-05-10 17:11:58 +00:00
//
// or to make sure a struct is smaller than a certain size:
//
// GTEST_COMPILE_ASSERT_(sizeof(foo) < 128, foo_too_large);
//
// The second argument to the macro is the name of the variable. If
// the expression is false, most compilers will issue a warning/error
// containing the name of the variable.
2014-11-17 02:11:23 +00:00
# if GTEST_LANG_CXX11
# define GTEST_COMPILE_ASSERT_(expr, msg) static_assert(expr, #msg)
# else // !GTEST_LANG_CXX11
2010-05-10 17:11:58 +00:00
template < bool >
2014-11-17 02:11:23 +00:00
struct CompileAssert {
2010-05-10 17:11:58 +00:00
} ;
2014-11-17 02:11:23 +00:00
# define GTEST_COMPILE_ASSERT_(expr, msg) \
2013-02-28 23:52:42 +00:00
typedef : : testing : : internal : : CompileAssert < ( static_cast < bool > ( expr ) ) > \
msg [ static_cast < bool > ( expr ) ? 1 : - 1 ] GTEST_ATTRIBUTE_UNUSED_
2014-11-17 02:11:23 +00:00
# endif // !GTEST_LANG_CXX11
2010-05-10 17:11:58 +00:00
// Implementation details of GTEST_COMPILE_ASSERT_:
//
2014-11-17 02:11:23 +00:00
// (In C++11, we simply use static_assert instead of the following)
//
2010-05-10 17:11:58 +00:00
// - GTEST_COMPILE_ASSERT_ works by defining an array type that has -1
// elements (and thus is invalid) when the expression is false.
//
// - The simpler definition
//
// #define GTEST_COMPILE_ASSERT_(expr, msg) typedef char msg[(expr) ? 1 : -1]
//
// does not work, as gcc supports variable-length arrays whose sizes
// are determined at run-time (this is gcc's extension and not part
// of the C++ standard). As a result, gcc fails to reject the
// following code with the simple definition:
//
// int foo;
// GTEST_COMPILE_ASSERT_(foo, msg); // not supposed to compile as foo is
// // not a compile-time constant.
//
// - By using the type CompileAssert<(bool(expr))>, we ensures that
// expr is a compile-time constant. (Template arguments must be
// determined at compile-time.)
//
// - The outter parentheses in CompileAssert<(bool(expr))> are necessary
// to work around a bug in gcc 3.4.4 and 4.0.1. If we had written
//
// CompileAssert<bool(expr)>
//
// instead, these compilers will refuse to compile
//
// GTEST_COMPILE_ASSERT_(5 > 0, some_message);
//
// (They seem to think the ">" in "5 > 0" marks the end of the
// template argument list.)
//
// - The array size is (bool(expr) ? 1 : -1), instead of simply
//
// ((expr) ? 1 : -1).
//
// This is to avoid running into a bug in MS VC 7.1, which
// causes ((0.0) ? 1 : -1) to incorrectly evaluate to 1.
// StaticAssertTypeEqHelper is used by StaticAssertTypeEq defined in gtest.h.
//
// This template is declared, but intentionally undefined.
template < typename T1 , typename T2 >
struct StaticAssertTypeEqHelper ;
template < typename T >
2014-05-15 19:42:15 +00:00
struct StaticAssertTypeEqHelper < T , T > {
enum { value = true } ;
} ;
2010-05-10 17:11:58 +00:00
2013-12-03 23:15:40 +00:00
// Evaluates to the number of elements in 'array'.
# define GTEST_ARRAY_SIZE_(array) (sizeof(array) / sizeof(array[0]))
2010-05-10 17:11:58 +00:00
# if GTEST_HAS_GLOBAL_STRING
typedef : : string string ;
# else
typedef : : std : : string string ;
# endif // GTEST_HAS_GLOBAL_STRING
# if GTEST_HAS_GLOBAL_WSTRING
typedef : : wstring wstring ;
# elif GTEST_HAS_STD_WSTRING
typedef : : std : : wstring wstring ;
# endif // GTEST_HAS_GLOBAL_WSTRING
2009-09-30 20:23:50 +00:00
// A helper for suppressing warnings on constant condition. It just
// returns 'condition'.
2010-03-05 21:21:06 +00:00
GTEST_API_ bool IsTrue ( bool condition ) ;
2009-09-30 20:23:50 +00:00
2008-07-03 22:38:12 +00:00
// Defines scoped_ptr.
// This implementation of scoped_ptr is PARTIAL - it only contains
// enough stuff to satisfy Google Test's need.
template < typename T >
class scoped_ptr {
public :
2009-11-17 23:34:56 +00:00
typedef T element_type ;
2008-07-03 22:38:12 +00:00
explicit scoped_ptr ( T * p = NULL ) : ptr_ ( p ) { }
~ scoped_ptr ( ) { reset ( ) ; }
T & operator * ( ) const { return * ptr_ ; }
T * operator - > ( ) const { return ptr_ ; }
T * get ( ) const { return ptr_ ; }
T * release ( ) {
T * const ptr = ptr_ ;
ptr_ = NULL ;
return ptr ;
}
void reset ( T * p = NULL ) {
if ( p ! = ptr_ ) {
2009-09-30 20:23:50 +00:00
if ( IsTrue ( sizeof ( T ) > 0 ) ) { // Makes sure T is a complete type.
2008-07-03 22:38:12 +00:00
delete ptr_ ;
}
ptr_ = p ;
}
}
2011-11-04 17:56:23 +00:00
2014-05-15 19:42:15 +00:00
friend void swap ( scoped_ptr & a , scoped_ptr & b ) {
using std : : swap ;
swap ( a . ptr_ , b . ptr_ ) ;
}
2008-07-03 22:38:12 +00:00
private :
T * ptr_ ;
2008-10-11 07:20:02 +00:00
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( scoped_ptr ) ;
2008-07-03 22:38:12 +00:00
} ;
2008-11-20 01:40:35 +00:00
// Defines RE.
2008-07-03 22:38:12 +00:00
2010-03-17 18:22:59 +00:00
// A simple C++ wrapper for <regex.h>. It uses the POSIX Extended
2008-07-03 22:38:12 +00:00
// Regular Expression syntax.
2010-03-05 21:21:06 +00:00
class GTEST_API_ RE {
2008-07-03 22:38:12 +00:00
public :
2010-03-17 18:22:59 +00:00
// A copy constructor is required by the Standard to initialize object
// references from r-values.
RE ( const RE & other ) { Init ( other . pattern ( ) ) ; }
2008-07-03 22:38:12 +00:00
// Constructs an RE from a string.
RE ( const : : std : : string & regex ) { Init ( regex . c_str ( ) ) ; } // NOLINT
# if GTEST_HAS_GLOBAL_STRING
2011-02-22 22:08:59 +00:00
2008-07-03 22:38:12 +00:00
RE ( const : : string & regex ) { Init ( regex . c_str ( ) ) ; } // NOLINT
2011-02-22 22:08:59 +00:00
2008-07-03 22:38:12 +00:00
# endif // GTEST_HAS_GLOBAL_STRING
RE ( const char * regex ) { Init ( regex ) ; } // NOLINT
~ RE ( ) ;
// Returns the string representation of the regex.
const char * pattern ( ) const { return pattern_ ; }
2008-11-20 01:40:35 +00:00
// FullMatch(str, re) returns true iff regular expression re matches
// the entire str.
// PartialMatch(str, re) returns true iff regular expression re
// matches a substring of str (including str itself).
//
// TODO(wan@google.com): make FullMatch() and PartialMatch() work
// when str contains NUL characters.
static bool FullMatch ( const : : std : : string & str , const RE & re ) {
return FullMatch ( str . c_str ( ) , re ) ;
}
2008-07-03 22:38:12 +00:00
static bool PartialMatch ( const : : std : : string & str , const RE & re ) {
return PartialMatch ( str . c_str ( ) , re ) ;
}
# if GTEST_HAS_GLOBAL_STRING
2011-02-22 22:08:59 +00:00
2008-11-20 01:40:35 +00:00
static bool FullMatch ( const : : string & str , const RE & re ) {
return FullMatch ( str . c_str ( ) , re ) ;
}
2008-07-03 22:38:12 +00:00
static bool PartialMatch ( const : : string & str , const RE & re ) {
return PartialMatch ( str . c_str ( ) , re ) ;
}
2011-02-22 22:08:59 +00:00
2008-07-03 22:38:12 +00:00
# endif // GTEST_HAS_GLOBAL_STRING
2008-11-20 01:40:35 +00:00
static bool FullMatch ( const char * str , const RE & re ) ;
2008-07-03 22:38:12 +00:00
static bool PartialMatch ( const char * str , const RE & re ) ;
private :
void Init ( const char * regex ) ;
2012-11-15 15:47:38 +00:00
// We use a const char* instead of an std::string, as Google Test used to be
// used where std::string is not available. TODO(wan@google.com): change to
// std::string.
2008-07-03 22:38:12 +00:00
const char * pattern_ ;
2009-01-29 01:28:52 +00:00
bool is_valid_ ;
2011-02-22 22:08:59 +00:00
2009-01-29 01:28:52 +00:00
# if GTEST_USES_POSIX_RE
2011-02-22 22:08:59 +00:00
2008-11-20 01:40:35 +00:00
regex_t full_regex_ ; // For FullMatch().
regex_t partial_regex_ ; // For PartialMatch().
2011-02-22 22:08:59 +00:00
2009-01-29 01:28:52 +00:00
# else // GTEST_USES_SIMPLE_RE
2011-02-22 22:08:59 +00:00
2009-01-29 01:28:52 +00:00
const char * full_pattern_ ; // For FullMatch();
2011-02-22 22:08:59 +00:00
2009-01-29 01:28:52 +00:00
# endif
2008-07-03 22:38:12 +00:00
2010-03-17 18:22:59 +00:00
GTEST_DISALLOW_ASSIGN_ ( RE ) ;
2009-01-29 01:28:52 +00:00
} ;
2008-07-03 22:38:12 +00:00
2011-02-02 10:07:04 +00:00
// Formats a source file path and a line number as they would appear
// in an error message from the compiler used to compile this code.
GTEST_API_ : : std : : string FormatFileLocation ( const char * file , int line ) ;
// Formats a file location for compiler-independent XML output.
// Although this function is not platform dependent, we put it next to
// FormatFileLocation in order to contrast the two functions.
GTEST_API_ : : std : : string FormatCompilerIndependentFileLocation ( const char * file ,
int line ) ;
2008-07-03 22:38:12 +00:00
// Defines logging utilities:
2009-09-16 06:59:17 +00:00
// GTEST_LOG_(severity) - logs messages at the specified severity level. The
// message itself is streamed into the macro.
2008-07-03 22:38:12 +00:00
// LogToStderr() - directs all log messages to stderr.
// FlushInfoLog() - flushes informational log messages.
enum GTestLogSeverity {
GTEST_INFO ,
GTEST_WARNING ,
GTEST_ERROR ,
GTEST_FATAL
} ;
2009-09-16 06:59:17 +00:00
// Formats log entry severity, provides a stream object for streaming the
// log message, and terminates the message with a newline when going out of
// scope.
2010-03-05 21:21:06 +00:00
class GTEST_API_ GTestLog {
2009-09-16 06:59:17 +00:00
public :
GTestLog ( GTestLogSeverity severity , const char * file , int line ) ;
// Flushes the buffers and, if severity is GTEST_FATAL, aborts the program.
~ GTestLog ( ) ;
: : std : : ostream & GetStream ( ) { return : : std : : cerr ; }
private :
const GTestLogSeverity severity_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( GTestLog ) ;
} ;
2008-07-03 22:38:12 +00:00
2015-07-14 19:56:37 +00:00
# if !defined(GTEST_LOG_)
# define GTEST_LOG_(severity) \
2009-09-16 06:59:17 +00:00
: : testing : : internal : : GTestLog ( : : testing : : internal : : GTEST_ # # severity , \
__FILE__ , __LINE__ ) . GetStream ( )
2008-07-03 22:38:12 +00:00
inline void LogToStderr ( ) { }
inline void FlushInfoLog ( ) { fflush ( NULL ) ; }
2015-07-14 19:56:37 +00:00
# endif // !defined(GTEST_LOG_)
# if !defined(GTEST_CHECK_)
2010-02-24 17:19:25 +00:00
// INTERNAL IMPLEMENTATION - DO NOT USE.
//
// GTEST_CHECK_ is an all-mode assert. It aborts the program if the condition
// is not satisfied.
// Synopsys:
// GTEST_CHECK_(boolean_condition);
// or
// GTEST_CHECK_(boolean_condition) << "Additional message";
//
// This checks the condition and if the condition is not satisfied
// it prints message about the condition violation, including the
// condition itself, plus additional message streamed into it, if any,
// and then it aborts the program. It aborts the program irrespective of
// whether it is built in the debug mode or not.
2015-07-14 19:56:37 +00:00
# define GTEST_CHECK_(condition) \
2010-02-24 17:19:25 +00:00
GTEST_AMBIGUOUS_ELSE_BLOCKER_ \
if ( : : testing : : internal : : IsTrue ( condition ) ) \
; \
else \
GTEST_LOG_ ( FATAL ) < < " Condition " # condition " failed. "
2015-07-14 19:56:37 +00:00
# endif // !defined(GTEST_CHECK_)
2010-02-24 17:19:25 +00:00
2010-02-25 21:40:08 +00:00
// An all-mode assert to verify that the given POSIX-style function
// call returns 0 (indicating success). Known limitation: this
// doesn't expand to a balanced 'if' statement, so enclose the macro
// in {} if you need to use it as the only statement in an 'if'
// branch.
# define GTEST_CHECK_POSIX_SUCCESS_(posix_call) \
if ( const int gtest_error = ( posix_call ) ) \
GTEST_LOG_ ( FATAL ) < < # posix_call < < " failed with error " \
< < gtest_error
2014-11-17 00:55:43 +00:00
# if GTEST_HAS_STD_MOVE_
using std : : move ;
2014-11-17 01:13:37 +00:00
# else // GTEST_HAS_STD_MOVE_
2014-11-17 00:55:43 +00:00
template < typename T >
const T & move ( const T & t ) {
return t ;
}
# endif // GTEST_HAS_STD_MOVE_
2010-03-23 15:58:37 +00:00
// INTERNAL IMPLEMENTATION - DO NOT USE IN USER CODE.
//
2011-01-29 16:15:40 +00:00
// Use ImplicitCast_ as a safe version of static_cast for upcasting in
2010-05-10 17:11:58 +00:00
// the type hierarchy (e.g. casting a Foo* to a SuperclassOfFoo* or a
2011-01-29 16:15:40 +00:00
// const Foo*). When you use ImplicitCast_, the compiler checks that
// the cast is safe. Such explicit ImplicitCast_s are necessary in
2010-05-10 17:11:58 +00:00
// surprisingly many situations where C++ demands an exact type match
// instead of an argument type convertable to a target type.
//
2011-01-29 16:15:40 +00:00
// The syntax for using ImplicitCast_ is the same as for static_cast:
2010-05-10 17:11:58 +00:00
//
2011-01-29 16:15:40 +00:00
// ImplicitCast_<ToType>(expr)
2010-05-10 17:11:58 +00:00
//
2011-01-29 16:15:40 +00:00
// ImplicitCast_ would have been part of the C++ standard library,
2010-05-10 17:11:58 +00:00
// but the proposal was submitted too late. It will probably make
// its way into the language in the future.
2011-01-29 16:15:40 +00:00
//
// This relatively ugly name is intentional. It prevents clashes with
// similar functions users may have (e.g., implicit_cast). The internal
// namespace alone is not enough because the function can be found by ADL.
2010-05-10 17:11:58 +00:00
template < typename To >
2015-07-24 20:12:16 +00:00
inline To ImplicitCast_ ( To x ) { return x ; }
2010-05-10 17:11:58 +00:00
// When you upcast (that is, cast a pointer from type Foo to type
2011-01-29 16:15:40 +00:00
// SuperclassOfFoo), it's fine to use ImplicitCast_<>, since upcasts
2010-05-10 17:11:58 +00:00
// always succeed. When you downcast (that is, cast a pointer from
// type Foo to type SubclassOfFoo), static_cast<> isn't safe, because
// how do you know the pointer is really of type SubclassOfFoo? It
// could be a bare Foo, or of type DifferentSubclassOfFoo. Thus,
// when you downcast, you should use this macro. In debug mode, we
// use dynamic_cast<> to double-check the downcast is legal (we die
// if it's not). In normal mode, we do the efficient static_cast<>
// instead. Thus, it's important to test in debug mode to make sure
// the cast is legal!
// This is the only place in the code we should use dynamic_cast<>.
// In particular, you SHOULDN'T be using dynamic_cast<> in order to
// do RTTI (eg code like this:
// if (dynamic_cast<Subclass1>(foo)) HandleASubclass1Object(foo);
// if (dynamic_cast<Subclass2>(foo)) HandleASubclass2Object(foo);
// You should design the code some other way not to need this.
2011-01-29 16:15:40 +00:00
//
// This relatively ugly name is intentional. It prevents clashes with
// similar functions users may have (e.g., down_cast). The internal
// namespace alone is not enough because the function can be found by ADL.
template < typename To , typename From > // use like this: DownCast_<T*>(foo);
inline To DownCast_ ( From * f ) { // so we only accept pointers
2010-05-10 17:11:58 +00:00
// Ensures that To is a sub-type of From *. This test is here only
// for compile-time type checking, and has no overhead in an
// optimized build at run-time, as it will be optimized away
// completely.
2014-05-15 19:42:15 +00:00
GTEST_INTENTIONAL_CONST_COND_PUSH_ ( )
2010-05-10 17:11:58 +00:00
if ( false ) {
2014-05-15 19:42:15 +00:00
GTEST_INTENTIONAL_CONST_COND_POP_ ( )
2010-05-10 17:11:58 +00:00
const To to = NULL ;
2011-01-29 16:15:40 +00:00
: : testing : : internal : : ImplicitCast_ < From * > ( to ) ;
2010-05-10 17:11:58 +00:00
}
# if GTEST_HAS_RTTI
// RTTI: debug mode only!
GTEST_CHECK_ ( f = = NULL | | dynamic_cast < To > ( f ) ! = NULL ) ;
# endif
return static_cast < To > ( f ) ;
}
2010-03-23 15:58:37 +00:00
// Downcasts the pointer of type Base to Derived.
// Derived must be a subclass of Base. The parameter MUST
// point to a class of type Derived, not any subclass of it.
// When RTTI is available, the function performs a runtime
// check to enforce this.
template < class Derived , class Base >
Derived * CheckedDowncastToActualType ( Base * base ) {
# if GTEST_HAS_RTTI
GTEST_CHECK_ ( typeid ( * base ) = = typeid ( Derived ) ) ;
2015-07-14 19:56:37 +00:00
# endif
# if GTEST_HAS_DOWNCAST_
return : : down_cast < Derived * > ( base ) ;
# elif GTEST_HAS_RTTI
2010-03-23 15:58:37 +00:00
return dynamic_cast < Derived * > ( base ) ; // NOLINT
# else
return static_cast < Derived * > ( base ) ; // Poor man's downcast.
2010-03-25 18:36:31 +00:00
# endif
2010-03-23 15:58:37 +00:00
}
2010-08-31 18:21:13 +00:00
# if GTEST_HAS_STREAM_REDIRECTION
2010-01-27 22:27:30 +00:00
2008-07-03 22:38:12 +00:00
// Defines the stderr capturer:
2010-01-27 22:27:30 +00:00
// CaptureStdout - starts capturing stdout.
// GetCapturedStdout - stops capturing stdout and returns the captured string.
2008-07-03 22:38:12 +00:00
// CaptureStderr - starts capturing stderr.
// GetCapturedStderr - stops capturing stderr and returns the captured string.
2010-01-27 22:27:30 +00:00
//
2010-03-22 21:23:51 +00:00
GTEST_API_ void CaptureStdout ( ) ;
2012-11-15 15:47:38 +00:00
GTEST_API_ std : : string GetCapturedStdout ( ) ;
2010-03-22 21:23:51 +00:00
GTEST_API_ void CaptureStderr ( ) ;
2012-11-15 15:47:38 +00:00
GTEST_API_ std : : string GetCapturedStderr ( ) ;
2009-03-06 01:20:15 +00:00
2010-08-31 18:21:13 +00:00
# endif // GTEST_HAS_STREAM_REDIRECTION
2010-01-27 22:27:30 +00:00
2015-07-17 21:56:19 +00:00
// Returns the size (in bytes) of a file.
GTEST_API_ size_t GetFileSize ( FILE * file ) ;
// Reads the entire content of a file as a string.
GTEST_API_ std : : string ReadEntireFile ( FILE * file ) ;
2010-01-27 22:27:30 +00:00
2015-07-24 20:43:09 +00:00
// All command line arguments.
GTEST_API_ const : : std : : vector < testing : : internal : : string > & GetArgvs ( ) ;
2009-02-23 23:21:55 +00:00
# if GTEST_HAS_DEATH_TEST
2008-07-03 22:38:12 +00:00
2011-10-05 05:51:10 +00:00
const : : std : : vector < testing : : internal : : string > & GetInjectableArgvs ( ) ;
void SetInjectableArgvs ( const : : std : : vector < testing : : internal : : string > *
new_argvs ) ;
2008-07-03 22:38:12 +00:00
# endif // GTEST_HAS_DEATH_TEST
// Defines synchronization primitives.
2014-03-24 21:58:25 +00:00
# if GTEST_IS_THREADSAFE
# if GTEST_HAS_PTHREAD
// Sleeps for (roughly) n milliseconds. This function is only for testing
// Google Test's own constructs. Don't use it in user tests, either
// directly or indirectly.
2010-03-04 22:15:53 +00:00
inline void SleepMilliseconds ( int n ) {
const timespec time = {
0 , // 0 seconds.
n * 1000L * 1000L , // And n ms.
} ;
nanosleep ( & time , NULL ) ;
}
2014-03-24 21:58:25 +00:00
# endif // GTEST_HAS_PTHREAD
2010-03-04 22:15:53 +00:00
2015-07-14 19:56:37 +00:00
# if GTEST_HAS_NOTIFICATION_
// Notification has already been imported into the namespace.
// Nothing to do here.
2014-03-24 21:58:25 +00:00
# elif GTEST_HAS_PTHREAD
2010-03-04 22:15:53 +00:00
// Allows a controller thread to pause execution of newly created
// threads until notified. Instances of this class must be created
// and destroyed in the controller thread.
//
// This class is only for testing Google Test's own constructs. Do not
// use it in user tests, either directly or indirectly.
class Notification {
public :
2012-01-27 21:26:58 +00:00
Notification ( ) : notified_ ( false ) {
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_mutex_init ( & mutex_ , NULL ) ) ;
}
~ Notification ( ) {
pthread_mutex_destroy ( & mutex_ ) ;
}
2010-03-04 22:15:53 +00:00
// Notifies all threads created with this notification to start. Must
// be called from the controller thread.
2012-01-27 21:26:58 +00:00
void Notify ( ) {
pthread_mutex_lock ( & mutex_ ) ;
notified_ = true ;
pthread_mutex_unlock ( & mutex_ ) ;
}
2010-03-04 22:15:53 +00:00
// Blocks until the controller thread notifies. Must be called from a test
// thread.
void WaitForNotification ( ) {
2012-01-27 21:26:58 +00:00
for ( ; ; ) {
pthread_mutex_lock ( & mutex_ ) ;
const bool notified = notified_ ;
pthread_mutex_unlock ( & mutex_ ) ;
if ( notified )
break ;
2010-03-04 22:15:53 +00:00
SleepMilliseconds ( 10 ) ;
}
}
private :
2012-01-27 21:26:58 +00:00
pthread_mutex_t mutex_ ;
bool notified_ ;
2010-03-04 22:15:53 +00:00
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( Notification ) ;
} ;
2014-06-18 21:31:01 +00:00
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
2014-03-24 21:58:25 +00:00
GTEST_API_ void SleepMilliseconds ( int n ) ;
// Provides leak-safe Windows kernel handle ownership.
// Used in death tests and in threading support.
class GTEST_API_ AutoHandle {
public :
// Assume that Win32 HANDLE type is equivalent to void*. Doing so allows us to
// avoid including <windows.h> in this header file. Including <windows.h> is
// undesirable because it defines a lot of symbols and macros that tend to
// conflict with client code. This assumption is verified by
// WindowsTypesTest.HANDLEIsVoidStar.
typedef void * Handle ;
AutoHandle ( ) ;
explicit AutoHandle ( Handle handle ) ;
~ AutoHandle ( ) ;
Handle Get ( ) const ;
void Reset ( ) ;
void Reset ( Handle handle ) ;
private :
// Returns true iff the handle is a valid handle object that can be closed.
bool IsCloseable ( ) const ;
Handle handle_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( AutoHandle ) ;
} ;
// Allows a controller thread to pause execution of newly created
// threads until notified. Instances of this class must be created
// and destroyed in the controller thread.
//
// This class is only for testing Google Test's own constructs. Do not
// use it in user tests, either directly or indirectly.
class GTEST_API_ Notification {
public :
Notification ( ) ;
void Notify ( ) ;
void WaitForNotification ( ) ;
private :
AutoHandle event_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( Notification ) ;
} ;
2015-07-14 19:56:37 +00:00
# endif // GTEST_HAS_NOTIFICATION_
2014-03-24 21:58:25 +00:00
// On MinGW, we can have both GTEST_OS_WINDOWS and GTEST_HAS_PTHREAD
// defined, but we don't want to use MinGW's pthreads implementation, which
// has conformance problems with some versions of the POSIX standard.
# if GTEST_HAS_PTHREAD && !GTEST_OS_WINDOWS_MINGW
2010-03-17 18:22:59 +00:00
// As a C-function, ThreadFuncWithCLinkage cannot be templated itself.
// Consequently, it cannot select a correct instantiation of ThreadWithParam
// in order to call its Run(). Introducing ThreadWithParamBase as a
// non-templated base class for ThreadWithParam allows us to bypass this
// problem.
class ThreadWithParamBase {
public :
virtual ~ ThreadWithParamBase ( ) { }
virtual void Run ( ) = 0 ;
} ;
// pthread_create() accepts a pointer to a function type with the C linkage.
// According to the Standard (7.5/1), function types with different linkages
// are different even if they are otherwise identical. Some compilers (for
// example, SunStudio) treat them as different types. Since class methods
// cannot be defined with C-linkage we need to define a free C-function to
// pass into pthread_create().
extern " C " inline void * ThreadFuncWithCLinkage ( void * thread ) {
static_cast < ThreadWithParamBase * > ( thread ) - > Run ( ) ;
return NULL ;
}
2010-03-04 22:15:53 +00:00
// Helper class for testing Google Test's multi-threading constructs.
2010-03-04 22:33:46 +00:00
// To use it, write:
2010-03-04 22:15:53 +00:00
//
// void ThreadFunc(int param) { /* Do things with param */ }
// Notification thread_can_start;
// ...
// // The thread_can_start parameter is optional; you can supply NULL.
// ThreadWithParam<int> thread(&ThreadFunc, 5, &thread_can_start);
// thread_can_start.Notify();
//
// These classes are only for testing Google Test's own constructs. Do
// not use them in user tests, either directly or indirectly.
template < typename T >
2010-03-17 18:22:59 +00:00
class ThreadWithParam : public ThreadWithParamBase {
2010-03-04 22:15:53 +00:00
public :
2014-03-24 21:58:25 +00:00
typedef void UserThreadFunc ( T ) ;
2010-03-04 22:15:53 +00:00
2014-03-24 21:58:25 +00:00
ThreadWithParam ( UserThreadFunc * func , T param , Notification * thread_can_start )
2010-03-04 22:15:53 +00:00
: func_ ( func ) ,
param_ ( param ) ,
thread_can_start_ ( thread_can_start ) ,
2010-03-04 22:33:46 +00:00
finished_ ( false ) {
2010-03-23 15:58:37 +00:00
ThreadWithParamBase * const base = this ;
2010-03-04 22:33:46 +00:00
// The thread can be created only after all fields except thread_
// have been initialized.
GTEST_CHECK_POSIX_SUCCESS_ (
2010-03-23 15:58:37 +00:00
pthread_create ( & thread_ , 0 , & ThreadFuncWithCLinkage , base ) ) ;
2010-03-04 22:33:46 +00:00
}
~ ThreadWithParam ( ) { Join ( ) ; }
2010-03-04 22:15:53 +00:00
void Join ( ) {
if ( ! finished_ ) {
2010-03-04 22:33:46 +00:00
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_join ( thread_ , 0 ) ) ;
2010-03-04 22:15:53 +00:00
finished_ = true ;
}
}
2010-03-17 18:22:59 +00:00
virtual void Run ( ) {
2010-03-04 22:15:53 +00:00
if ( thread_can_start_ ! = NULL )
thread_can_start_ - > WaitForNotification ( ) ;
func_ ( param_ ) ;
}
2010-03-17 18:22:59 +00:00
private :
2014-03-24 21:58:25 +00:00
UserThreadFunc * const func_ ; // User-supplied thread function.
2010-03-04 22:15:53 +00:00
const T param_ ; // User-supplied parameter to the thread function.
// When non-NULL, used to block execution until the controller thread
// notifies.
Notification * const thread_can_start_ ;
bool finished_ ; // true iff we know that the thread function has finished.
2010-03-04 22:33:46 +00:00
pthread_t thread_ ; // The native thread object.
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ThreadWithParam ) ;
2010-03-04 22:15:53 +00:00
} ;
2015-07-14 19:56:37 +00:00
# endif // !GTEST_OS_WINDOWS && GTEST_HAS_PTHREAD ||
// GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
# if GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
// Mutex and ThreadLocal have already been imported into the namespace.
// Nothing to do here.
2014-03-24 21:58:25 +00:00
2014-06-18 21:31:01 +00:00
# elif GTEST_OS_WINDOWS && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
2010-03-04 22:15:53 +00:00
2014-03-24 21:58:25 +00:00
// Mutex implements mutex on Windows platforms. It is used in conjunction
// with class MutexLock:
2010-02-24 17:19:25 +00:00
//
2010-02-25 21:40:08 +00:00
// Mutex mutex;
// ...
2014-03-24 21:58:25 +00:00
// MutexLock lock(&mutex); // Acquires the mutex and releases it at the
// // end of the current scope.
2010-02-24 17:19:25 +00:00
//
2014-03-24 21:58:25 +00:00
// A static Mutex *must* be defined or declared using one of the following
// macros:
2010-02-25 21:40:08 +00:00
// GTEST_DEFINE_STATIC_MUTEX_(g_some_mutex);
2014-03-24 21:58:25 +00:00
// GTEST_DECLARE_STATIC_MUTEX_(g_some_mutex);
//
// (A non-static Mutex is defined/declared in the usual way).
class GTEST_API_ Mutex {
public :
enum MutexType { kStatic = 0 , kDynamic = 1 } ;
// We rely on kStaticMutex being 0 as it is to what the linker initializes
// type_ in static mutexes. critical_section_ will be initialized lazily
// in ThreadSafeLazyInit().
enum StaticConstructorSelector { kStaticMutex = 0 } ;
// This constructor intentionally does nothing. It relies on type_ being
// statically initialized to 0 (effectively setting it to kStatic) and on
// ThreadSafeLazyInit() to lazily initialize the rest of the members.
explicit Mutex ( StaticConstructorSelector /*dummy*/ ) { }
Mutex ( ) ;
~ Mutex ( ) ;
void Lock ( ) ;
void Unlock ( ) ;
// Does nothing if the current thread holds the mutex. Otherwise, crashes
// with high probability.
void AssertHeld ( ) ;
private :
// Initializes owner_thread_id_ and critical_section_ in static mutexes.
void ThreadSafeLazyInit ( ) ;
// Per http://blogs.msdn.com/b/oldnewthing/archive/2004/02/23/78395.aspx,
// we assume that 0 is an invalid value for thread IDs.
unsigned int owner_thread_id_ ;
// For static mutexes, we rely on these members being initialized to zeros
// by the linker.
MutexType type_ ;
long critical_section_init_phase_ ; // NOLINT
2016-02-20 03:06:12 +00:00
GTEST_CRITICAL_SECTION * critical_section_ ;
2014-03-24 21:58:25 +00:00
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( Mutex ) ;
} ;
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
extern : : testing : : internal : : Mutex mutex
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
: : testing : : internal : : Mutex mutex ( : : testing : : internal : : Mutex : : kStaticMutex )
// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)". Hence the typedef trick below.
class GTestMutexLock {
public :
explicit GTestMutexLock ( Mutex * mutex )
: mutex_ ( mutex ) { mutex_ - > Lock ( ) ; }
~ GTestMutexLock ( ) { mutex_ - > Unlock ( ) ; }
private :
Mutex * const mutex_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( GTestMutexLock ) ;
} ;
typedef GTestMutexLock MutexLock ;
// Base class for ValueHolder<T>. Allows a caller to hold and delete a value
// without knowing its type.
class ThreadLocalValueHolderBase {
public :
virtual ~ ThreadLocalValueHolderBase ( ) { }
} ;
// Provides a way for a thread to send notifications to a ThreadLocal
// regardless of its parameter type.
class ThreadLocalBase {
public :
// Creates a new ValueHolder<T> object holding a default value passed to
// this ThreadLocal<T>'s constructor and returns it. It is the caller's
// responsibility not to call this when the ThreadLocal<T> instance already
// has a value on the current thread.
virtual ThreadLocalValueHolderBase * NewValueForCurrentThread ( ) const = 0 ;
protected :
ThreadLocalBase ( ) { }
virtual ~ ThreadLocalBase ( ) { }
private :
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ThreadLocalBase ) ;
} ;
// Maps a thread to a set of ThreadLocals that have values instantiated on that
// thread and notifies them when the thread exits. A ThreadLocal instance is
// expected to persist until all threads it has values on have terminated.
class GTEST_API_ ThreadLocalRegistry {
public :
// Registers thread_local_instance as having value on the current thread.
// Returns a value that can be used to identify the thread from other threads.
static ThreadLocalValueHolderBase * GetValueOnCurrentThread (
const ThreadLocalBase * thread_local_instance ) ;
// Invoked when a ThreadLocal instance is destroyed.
static void OnThreadLocalDestroyed (
const ThreadLocalBase * thread_local_instance ) ;
} ;
class GTEST_API_ ThreadWithParamBase {
public :
void Join ( ) ;
protected :
class Runnable {
public :
virtual ~ Runnable ( ) { }
virtual void Run ( ) = 0 ;
} ;
ThreadWithParamBase ( Runnable * runnable , Notification * thread_can_start ) ;
virtual ~ ThreadWithParamBase ( ) ;
private :
AutoHandle thread_ ;
} ;
// Helper class for testing Google Test's multi-threading constructs.
template < typename T >
class ThreadWithParam : public ThreadWithParamBase {
public :
typedef void UserThreadFunc ( T ) ;
ThreadWithParam ( UserThreadFunc * func , T param , Notification * thread_can_start )
: ThreadWithParamBase ( new RunnableImpl ( func , param ) , thread_can_start ) {
}
virtual ~ ThreadWithParam ( ) { }
private :
class RunnableImpl : public Runnable {
public :
RunnableImpl ( UserThreadFunc * func , T param )
: func_ ( func ) ,
param_ ( param ) {
}
virtual ~ RunnableImpl ( ) { }
virtual void Run ( ) {
func_ ( param_ ) ;
}
private :
UserThreadFunc * const func_ ;
const T param_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( RunnableImpl ) ;
} ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ThreadWithParam ) ;
} ;
// Implements thread-local storage on Windows systems.
//
// // Thread 1
// ThreadLocal<int> tl(100); // 100 is the default value for each thread.
2010-02-24 17:19:25 +00:00
//
2014-03-24 21:58:25 +00:00
// // Thread 2
// tl.set(150); // Changes the value for thread 2 only.
// EXPECT_EQ(150, tl.get());
2010-02-24 17:19:25 +00:00
//
2014-03-24 21:58:25 +00:00
// // Thread 1
// EXPECT_EQ(100, tl.get()); // In thread 1, tl has the original value.
// tl.set(200);
// EXPECT_EQ(200, tl.get());
//
// The template type argument T must have a public copy constructor.
// In addition, the default ThreadLocal constructor requires T to have
// a public default constructor.
//
// The users of a TheadLocal instance have to make sure that all but one
// threads (including the main one) using that instance have exited before
// destroying it. Otherwise, the per-thread objects managed for them by the
// ThreadLocal instance are not guaranteed to be destroyed on all platforms.
2010-02-24 17:19:25 +00:00
//
2014-03-24 21:58:25 +00:00
// Google Test only uses global ThreadLocal objects. That means they
// will die after main() has returned. Therefore, no per-thread
// object managed by Google Test will be leaked as long as all threads
// using Google Test have exited when main() returns.
template < typename T >
class ThreadLocal : public ThreadLocalBase {
public :
2015-07-19 22:33:19 +00:00
ThreadLocal ( ) : default_factory_ ( new DefaultValueHolderFactory ( ) ) { }
explicit ThreadLocal ( const T & value )
: default_factory_ ( new InstanceValueHolderFactory ( value ) ) { }
2014-03-24 21:58:25 +00:00
~ ThreadLocal ( ) { ThreadLocalRegistry : : OnThreadLocalDestroyed ( this ) ; }
T * pointer ( ) { return GetOrCreateValue ( ) ; }
const T * pointer ( ) const { return GetOrCreateValue ( ) ; }
const T & get ( ) const { return * pointer ( ) ; }
void set ( const T & value ) { * pointer ( ) = value ; }
private :
// Holds a value of T. Can be deleted via its base class without the caller
// knowing the type of T.
class ValueHolder : public ThreadLocalValueHolderBase {
public :
2015-07-19 22:33:19 +00:00
ValueHolder ( ) : value_ ( ) { }
2014-03-24 21:58:25 +00:00
explicit ValueHolder ( const T & value ) : value_ ( value ) { }
T * pointer ( ) { return & value_ ; }
private :
T value_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ValueHolder ) ;
} ;
T * GetOrCreateValue ( ) const {
return static_cast < ValueHolder * > (
ThreadLocalRegistry : : GetValueOnCurrentThread ( this ) ) - > pointer ( ) ;
}
virtual ThreadLocalValueHolderBase * NewValueForCurrentThread ( ) const {
2015-07-19 22:33:19 +00:00
return default_factory_ - > MakeNewHolder ( ) ;
2014-03-24 21:58:25 +00:00
}
2015-07-19 22:33:19 +00:00
class ValueHolderFactory {
public :
ValueHolderFactory ( ) { }
virtual ~ ValueHolderFactory ( ) { }
virtual ValueHolder * MakeNewHolder ( ) const = 0 ;
private :
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ValueHolderFactory ) ;
} ;
class DefaultValueHolderFactory : public ValueHolderFactory {
public :
DefaultValueHolderFactory ( ) { }
virtual ValueHolder * MakeNewHolder ( ) const { return new ValueHolder ( ) ; }
private :
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( DefaultValueHolderFactory ) ;
} ;
class InstanceValueHolderFactory : public ValueHolderFactory {
public :
explicit InstanceValueHolderFactory ( const T & value ) : value_ ( value ) { }
virtual ValueHolder * MakeNewHolder ( ) const {
return new ValueHolder ( value_ ) ;
}
private :
const T value_ ; // The value for each thread.
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( InstanceValueHolderFactory ) ;
} ;
scoped_ptr < ValueHolderFactory > default_factory_ ;
2014-03-24 21:58:25 +00:00
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ThreadLocal ) ;
} ;
# elif GTEST_HAS_PTHREAD
// MutexBase and Mutex implement mutex on pthreads-based platforms.
2010-02-24 17:19:25 +00:00
class MutexBase {
public :
2010-02-25 21:40:08 +00:00
// Acquires this mutex.
void Lock ( ) {
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_mutex_lock ( & mutex_ ) ) ;
owner_ = pthread_self ( ) ;
2012-04-02 17:41:03 +00:00
has_owner_ = true ;
2010-02-25 21:40:08 +00:00
}
// Releases this mutex.
void Unlock ( ) {
2012-04-02 17:41:03 +00:00
// Since the lock is being released the owner_ field should no longer be
// considered valid. We don't protect writing to has_owner_ here, as it's
// the caller's responsibility to ensure that the current thread holds the
2010-02-25 21:40:08 +00:00
// mutex when this is called.
2012-04-02 17:41:03 +00:00
has_owner_ = false ;
2010-02-25 21:40:08 +00:00
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_mutex_unlock ( & mutex_ ) ) ;
}
2010-02-24 17:19:25 +00:00
// Does nothing if the current thread holds the mutex. Otherwise, crashes
// with high probability.
2010-02-25 21:40:08 +00:00
void AssertHeld ( ) const {
2012-04-02 17:41:03 +00:00
GTEST_CHECK_ ( has_owner_ & & pthread_equal ( owner_ , pthread_self ( ) ) )
2010-02-25 21:40:08 +00:00
< < " The current thread is not holding the mutex @ " < < this ;
}
2010-02-24 17:19:25 +00:00
2010-02-25 21:40:08 +00:00
// A static mutex may be used before main() is entered. It may even
// be used before the dynamic initialization stage. Therefore we
// must be able to initialize a static mutex object at link time.
// This means MutexBase has to be a POD and its member variables
// have to be public.
2010-02-24 17:19:25 +00:00
public :
2010-02-25 21:40:08 +00:00
pthread_mutex_t mutex_ ; // The underlying pthread mutex.
2012-04-02 17:41:03 +00:00
// has_owner_ indicates whether the owner_ field below contains a valid thread
// ID and is therefore safe to inspect (e.g., to use in pthread_equal()). All
// accesses to the owner_ field should be protected by a check of this field.
// An alternative might be to memset() owner_ to all zeros, but there's no
// guarantee that a zero'd pthread_t is necessarily invalid or even different
// from pthread_self().
bool has_owner_ ;
pthread_t owner_ ; // The thread holding the mutex.
2010-02-24 17:19:25 +00:00
} ;
// Forward-declares a static mutex.
2014-03-24 21:58:25 +00:00
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
extern : : testing : : internal : : MutexBase mutex
2010-02-24 17:19:25 +00:00
2010-02-25 21:40:08 +00:00
// Defines and statically (i.e. at link time) initializes a static mutex.
2014-03-24 21:58:25 +00:00
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) \
2015-11-24 18:45:16 +00:00
: : testing : : internal : : MutexBase mutex = { PTHREAD_MUTEX_INITIALIZER , false , pthread_t ( ) }
2010-02-24 17:19:25 +00:00
2010-02-25 21:40:08 +00:00
// The Mutex class can only be used for mutexes created at runtime. It
// shares its API with MutexBase otherwise.
2010-02-24 17:19:25 +00:00
class Mutex : public MutexBase {
public :
2010-02-25 21:40:08 +00:00
Mutex ( ) {
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_mutex_init ( & mutex_ , NULL ) ) ;
2012-04-02 17:41:03 +00:00
has_owner_ = false ;
2010-02-25 21:40:08 +00:00
}
~ Mutex ( ) {
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_mutex_destroy ( & mutex_ ) ) ;
}
2010-02-24 17:19:25 +00:00
private :
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( Mutex ) ;
} ;
2014-03-24 21:58:25 +00:00
// We cannot name this class MutexLock because the ctor declaration would
2010-02-24 17:19:25 +00:00
// conflict with a macro named MutexLock, which is defined on some
2014-03-24 21:58:25 +00:00
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)". Hence the typedef trick below.
2010-02-24 17:19:25 +00:00
class GTestMutexLock {
public :
explicit GTestMutexLock ( MutexBase * mutex )
: mutex_ ( mutex ) { mutex_ - > Lock ( ) ; }
~ GTestMutexLock ( ) { mutex_ - > Unlock ( ) ; }
private :
MutexBase * const mutex_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( GTestMutexLock ) ;
} ;
typedef GTestMutexLock MutexLock ;
2010-03-23 15:58:37 +00:00
// Helpers for ThreadLocal.
// pthread_key_create() requires DeleteThreadLocalValue() to have
// C-linkage. Therefore it cannot be templatized to access
// ThreadLocal<T>. Hence the need for class
// ThreadLocalValueHolderBase.
class ThreadLocalValueHolderBase {
public :
virtual ~ ThreadLocalValueHolderBase ( ) { }
} ;
// Called by pthread to delete thread-local data stored by
// pthread_setspecific().
extern " C " inline void DeleteThreadLocalValue ( void * value_holder ) {
delete static_cast < ThreadLocalValueHolderBase * > ( value_holder ) ;
}
2010-02-24 17:19:25 +00:00
// Implements thread-local storage on pthreads-based systems.
template < typename T >
2017-10-17 18:01:39 +00:00
class GTEST_API_ ThreadLocal {
2010-02-24 17:19:25 +00:00
public :
2015-07-19 22:33:19 +00:00
ThreadLocal ( )
: key_ ( CreateKey ( ) ) , default_factory_ ( new DefaultValueHolderFactory ( ) ) { }
explicit ThreadLocal ( const T & value )
: key_ ( CreateKey ( ) ) ,
default_factory_ ( new InstanceValueHolderFactory ( value ) ) { }
2010-02-24 17:19:25 +00:00
~ ThreadLocal ( ) {
2010-03-26 20:23:06 +00:00
// Destroys the managed object for the current thread, if any.
DeleteThreadLocalValue ( pthread_getspecific ( key_ ) ) ;
// Releases resources associated with the key. This will *not*
// delete managed objects for other threads.
2010-02-25 21:40:08 +00:00
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_key_delete ( key_ ) ) ;
2010-02-24 17:19:25 +00:00
}
T * pointer ( ) { return GetOrCreateValue ( ) ; }
const T * pointer ( ) const { return GetOrCreateValue ( ) ; }
const T & get ( ) const { return * pointer ( ) ; }
void set ( const T & value ) { * pointer ( ) = value ; }
private :
2010-03-23 15:58:37 +00:00
// Holds a value of type T.
class ValueHolder : public ThreadLocalValueHolderBase {
public :
2015-07-19 22:33:19 +00:00
ValueHolder ( ) : value_ ( ) { }
2010-03-23 15:58:37 +00:00
explicit ValueHolder ( const T & value ) : value_ ( value ) { }
T * pointer ( ) { return & value_ ; }
private :
T value_ ;
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ValueHolder ) ;
} ;
2010-02-24 17:19:25 +00:00
static pthread_key_t CreateKey ( ) {
pthread_key_t key ;
2010-03-26 20:23:06 +00:00
// When a thread exits, DeleteThreadLocalValue() will be called on
// the object managed for that thread.
2010-03-23 15:58:37 +00:00
GTEST_CHECK_POSIX_SUCCESS_ (
pthread_key_create ( & key , & DeleteThreadLocalValue ) ) ;
2010-02-24 17:19:25 +00:00
return key ;
}
T * GetOrCreateValue ( ) const {
2010-03-23 15:58:37 +00:00
ThreadLocalValueHolderBase * const holder =
static_cast < ThreadLocalValueHolderBase * > ( pthread_getspecific ( key_ ) ) ;
if ( holder ! = NULL ) {
return CheckedDowncastToActualType < ValueHolder > ( holder ) - > pointer ( ) ;
}
2010-02-25 21:40:08 +00:00
2015-07-19 22:33:19 +00:00
ValueHolder * const new_holder = default_factory_ - > MakeNewHolder ( ) ;
2010-03-23 15:58:37 +00:00
ThreadLocalValueHolderBase * const holder_base = new_holder ;
GTEST_CHECK_POSIX_SUCCESS_ ( pthread_setspecific ( key_ , holder_base ) ) ;
return new_holder - > pointer ( ) ;
2010-02-24 17:19:25 +00:00
}
2015-07-19 22:33:19 +00:00
class ValueHolderFactory {
public :
ValueHolderFactory ( ) { }
virtual ~ ValueHolderFactory ( ) { }
virtual ValueHolder * MakeNewHolder ( ) const = 0 ;
private :
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ValueHolderFactory ) ;
} ;
class DefaultValueHolderFactory : public ValueHolderFactory {
public :
DefaultValueHolderFactory ( ) { }
virtual ValueHolder * MakeNewHolder ( ) const { return new ValueHolder ( ) ; }
private :
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( DefaultValueHolderFactory ) ;
} ;
class InstanceValueHolderFactory : public ValueHolderFactory {
public :
explicit InstanceValueHolderFactory ( const T & value ) : value_ ( value ) { }
virtual ValueHolder * MakeNewHolder ( ) const {
return new ValueHolder ( value_ ) ;
}
private :
const T value_ ; // The value for each thread.
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( InstanceValueHolderFactory ) ;
} ;
2010-02-24 17:19:25 +00:00
// A key pthreads uses for looking up per-thread values.
const pthread_key_t key_ ;
2015-07-19 22:33:19 +00:00
scoped_ptr < ValueHolderFactory > default_factory_ ;
2010-02-24 17:19:25 +00:00
GTEST_DISALLOW_COPY_AND_ASSIGN_ ( ThreadLocal ) ;
} ;
2015-07-14 19:56:37 +00:00
# endif // GTEST_HAS_MUTEX_AND_THREAD_LOCAL_
2010-02-24 17:19:25 +00:00
2014-03-24 21:58:25 +00:00
# else // GTEST_IS_THREADSAFE
2010-02-24 17:19:25 +00:00
2008-07-03 22:38:12 +00:00
// A dummy implementation of synchronization primitives (mutex, lock,
// and thread-local variable). Necessary for compiling Google Test where
// mutex is not supported - using Google Test in multiple threads is not
// supported on such platforms.
class Mutex {
public :
Mutex ( ) { }
2011-10-24 23:36:46 +00:00
void Lock ( ) { }
void Unlock ( ) { }
2008-07-03 22:38:12 +00:00
void AssertHeld ( ) const { }
} ;
2011-02-22 22:08:59 +00:00
# define GTEST_DECLARE_STATIC_MUTEX_(mutex) \
2010-02-24 17:19:25 +00:00
extern : : testing : : internal : : Mutex mutex
2011-02-22 22:08:59 +00:00
# define GTEST_DEFINE_STATIC_MUTEX_(mutex) ::testing::internal::Mutex mutex
2010-02-24 17:19:25 +00:00
2014-03-24 21:58:25 +00:00
// We cannot name this class MutexLock because the ctor declaration would
// conflict with a macro named MutexLock, which is defined on some
// platforms. That macro is used as a defensive measure to prevent against
// inadvertent misuses of MutexLock like "MutexLock(&mu)" rather than
// "MutexLock l(&mu)". Hence the typedef trick below.
2008-07-03 22:38:12 +00:00
class GTestMutexLock {
public :
explicit GTestMutexLock ( Mutex * ) { } // NOLINT
} ;
typedef GTestMutexLock MutexLock ;
template < typename T >
2017-10-17 18:01:39 +00:00
class GTEST_API_ ThreadLocal {
2008-07-03 22:38:12 +00:00
public :
2008-10-11 07:20:02 +00:00
ThreadLocal ( ) : value_ ( ) { }
explicit ThreadLocal ( const T & value ) : value_ ( value ) { }
2008-07-03 22:38:12 +00:00
T * pointer ( ) { return & value_ ; }
const T * pointer ( ) const { return & value_ ; }
const T & get ( ) const { return value_ ; }
void set ( const T & value ) { value_ = value ; }
private :
T value_ ;
} ;
2014-03-24 21:58:25 +00:00
# endif // GTEST_IS_THREADSAFE
2010-02-24 17:19:25 +00:00
// Returns the number of threads running in the process, or 0 to indicate that
// we cannot detect it.
2010-03-22 21:23:51 +00:00
GTEST_API_ size_t GetThreadCount ( ) ;
2010-02-24 17:19:25 +00:00
2008-11-10 18:27:46 +00:00
// Passing non-POD classes through ellipsis (...) crashes the ARM
2016-10-17 17:42:18 +00:00
// compiler and generates a warning in Sun Studio before 12u4. The Nokia Symbian
2009-12-07 20:45:16 +00:00
// and the IBM XL C/C++ compiler try to instantiate a copy constructor
// for objects passed through ellipsis (...), failing for uncopyable
// objects. We define this to ensure that only POD is passed through
// ellipsis on these systems.
2016-10-17 17:42:18 +00:00
# if defined(__SYMBIAN32__) || defined(__IBMCPP__) || \
( defined ( __SUNPRO_CC ) & & __SUNPRO_CC < 0x5130 )
2010-03-17 18:22:59 +00:00
// We lose support for NULL detection where the compiler doesn't like
// passing non-POD classes through ellipsis (...).
2011-02-22 22:08:59 +00:00
# define GTEST_ELLIPSIS_NEEDS_POD_ 1
2010-03-17 18:22:59 +00:00
# else
2011-02-22 22:08:59 +00:00
# define GTEST_CAN_COMPARE_NULL 1
2009-12-07 20:45:16 +00:00
# endif
2008-07-03 22:38:12 +00:00
2008-11-10 18:27:46 +00:00
// The Nokia Symbian and IBM XL C/C++ compilers cannot decide between
// const T& and const T* in a function template. These compilers
// _can_ decide between class template specializations for T and T*,
// so a tr1::type_traits-like is_pointer works.
2009-12-07 20:45:16 +00:00
# if defined(__SYMBIAN32__) || defined(__IBMCPP__)
2011-02-22 22:08:59 +00:00
# define GTEST_NEEDS_IS_POINTER_ 1
2009-12-07 20:45:16 +00:00
# endif
2008-07-03 22:38:12 +00:00
template < bool bool_value >
struct bool_constant {
typedef bool_constant < bool_value > type ;
static const bool value = bool_value ;
} ;
template < bool bool_value > const bool bool_constant < bool_value > : : value ;
typedef bool_constant < false > false_type ;
typedef bool_constant < true > true_type ;
2017-08-09 17:07:22 +00:00
template < typename T , typename U >
struct is_same : public false_type { } ;
template < typename T >
struct is_same < T , T > : public true_type { } ;
2008-07-03 22:38:12 +00:00
template < typename T >
struct is_pointer : public false_type { } ;
template < typename T >
struct is_pointer < T * > : public true_type { } ;
2011-04-12 18:24:59 +00:00
template < typename Iterator >
struct IteratorTraits {
typedef typename Iterator : : value_type value_type ;
} ;
template < typename T >
struct IteratorTraits < T * > {
typedef T value_type ;
} ;
template < typename T >
struct IteratorTraits < const T * > {
typedef T value_type ;
} ;
2009-03-11 22:18:52 +00:00
# if GTEST_OS_WINDOWS
2011-02-22 22:08:59 +00:00
# define GTEST_PATH_SEP_ "\\"
# define GTEST_HAS_ALT_PATH_SEP_ 1
2009-03-26 19:03:47 +00:00
// The biggest signed integer type the compiler supports.
typedef __int64 BiggestInt ;
2009-03-11 22:18:52 +00:00
# else
2011-02-22 22:08:59 +00:00
# define GTEST_PATH_SEP_ " / "
# define GTEST_HAS_ALT_PATH_SEP_ 0
2009-03-26 19:03:47 +00:00
typedef long long BiggestInt ; // NOLINT
2009-03-11 22:18:52 +00:00
# endif // GTEST_OS_WINDOWS
2010-08-31 18:21:13 +00:00
// Utilities for char.
// isspace(int ch) and friends accept an unsigned char or EOF. char
// may be signed, depending on the compiler (or compiler flags).
// Therefore we need to cast a char to unsigned char before calling
// isspace(), etc.
inline bool IsAlpha ( char ch ) {
return isalpha ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
inline bool IsAlNum ( char ch ) {
return isalnum ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
inline bool IsDigit ( char ch ) {
return isdigit ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
inline bool IsLower ( char ch ) {
return islower ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
inline bool IsSpace ( char ch ) {
return isspace ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
inline bool IsUpper ( char ch ) {
return isupper ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
2010-12-02 23:28:38 +00:00
inline bool IsXDigit ( char ch ) {
return isxdigit ( static_cast < unsigned char > ( ch ) ) ! = 0 ;
}
2012-06-07 20:34:34 +00:00
inline bool IsXDigit ( wchar_t ch ) {
const unsigned char low_byte = static_cast < unsigned char > ( ch ) ;
return ch = = low_byte & & isxdigit ( low_byte ) ! = 0 ;
}
2010-08-31 18:21:13 +00:00
inline char ToLower ( char ch ) {
return static_cast < char > ( tolower ( static_cast < unsigned char > ( ch ) ) ) ;
}
inline char ToUpper ( char ch ) {
return static_cast < char > ( toupper ( static_cast < unsigned char > ( ch ) ) ) ;
}
2014-11-17 02:28:09 +00:00
inline std : : string StripTrailingSpaces ( std : : string str ) {
std : : string : : iterator it = str . end ( ) ;
while ( it ! = str . begin ( ) & & IsSpace ( * - - it ) )
it = str . erase ( it ) ;
return str ;
}
2009-03-26 19:03:47 +00:00
// The testing::internal::posix namespace holds wrappers for common
// POSIX functions. These wrappers hide the differences between
2009-04-24 00:26:25 +00:00
// Windows/MSVC and POSIX systems. Since some compilers define these
// standard functions as macros, the wrapper cannot have the same name
// as the wrapped function.
2009-03-26 19:03:47 +00:00
namespace posix {
// Functions with a different name on Windows.
2009-02-23 23:21:55 +00:00
# if GTEST_OS_WINDOWS
2009-03-26 19:03:47 +00:00
2009-04-24 00:26:25 +00:00
typedef struct _stat StatStruct ;
2009-03-26 19:03:47 +00:00
2011-02-22 22:08:59 +00:00
# ifdef __BORLANDC__
2009-04-28 00:28:09 +00:00
inline int IsATTY ( int fd ) { return isatty ( fd ) ; }
inline int StrCaseCmp ( const char * s1 , const char * s2 ) {
return stricmp ( s1 , s2 ) ;
}
inline char * StrDup ( const char * src ) { return strdup ( src ) ; }
2011-02-22 22:08:59 +00:00
# else // !__BORLANDC__
# if GTEST_OS_WINDOWS_MOBILE
2009-06-19 17:23:54 +00:00
inline int IsATTY ( int /* fd */ ) { return 0 ; }
2011-02-22 22:08:59 +00:00
# else
2009-04-24 00:26:25 +00:00
inline int IsATTY ( int fd ) { return _isatty ( fd ) ; }
2011-02-22 22:08:59 +00:00
# endif // GTEST_OS_WINDOWS_MOBILE
2009-04-24 00:26:25 +00:00
inline int StrCaseCmp ( const char * s1 , const char * s2 ) {
return _stricmp ( s1 , s2 ) ;
2009-03-26 19:03:47 +00:00
}
2009-04-24 00:26:25 +00:00
inline char * StrDup ( const char * src ) { return _strdup ( src ) ; }
2011-02-22 22:08:59 +00:00
# endif // __BORLANDC__
2009-04-28 00:28:09 +00:00
2011-02-22 22:08:59 +00:00
# if GTEST_OS_WINDOWS_MOBILE
2009-06-19 17:23:54 +00:00
inline int FileNo ( FILE * file ) { return reinterpret_cast < int > ( _fileno ( file ) ) ; }
// Stat(), RmDir(), and IsDir() are not needed on Windows CE at this
// time and thus not defined there.
2011-02-22 22:08:59 +00:00
# else
2009-04-28 00:28:09 +00:00
inline int FileNo ( FILE * file ) { return _fileno ( file ) ; }
inline int Stat ( const char * path , StatStruct * buf ) { return _stat ( path , buf ) ; }
2009-04-24 00:26:25 +00:00
inline int RmDir ( const char * dir ) { return _rmdir ( dir ) ; }
inline bool IsDir ( const StatStruct & st ) {
2009-03-26 19:03:47 +00:00
return ( _S_IFDIR & st . st_mode ) ! = 0 ;
}
2011-02-22 22:08:59 +00:00
# endif // GTEST_OS_WINDOWS_MOBILE
2009-03-26 19:03:47 +00:00
2008-07-03 22:38:12 +00:00
# else
2009-03-26 19:03:47 +00:00
2009-04-24 00:26:25 +00:00
typedef struct stat StatStruct ;
2009-03-26 19:03:47 +00:00
2009-04-24 00:26:25 +00:00
inline int FileNo ( FILE * file ) { return fileno ( file ) ; }
inline int IsATTY ( int fd ) { return isatty ( fd ) ; }
inline int Stat ( const char * path , StatStruct * buf ) { return stat ( path , buf ) ; }
inline int StrCaseCmp ( const char * s1 , const char * s2 ) {
return strcasecmp ( s1 , s2 ) ;
}
2009-04-28 00:28:09 +00:00
inline char * StrDup ( const char * src ) { return strdup ( src ) ; }
2009-04-24 00:26:25 +00:00
inline int RmDir ( const char * dir ) { return rmdir ( dir ) ; }
inline bool IsDir ( const StatStruct & st ) { return S_ISDIR ( st . st_mode ) ; }
2009-03-26 19:03:47 +00:00
2008-07-03 22:38:12 +00:00
# endif // GTEST_OS_WINDOWS
2009-03-26 19:03:47 +00:00
// Functions deprecated by MSVC 8.0.
2014-05-15 19:42:15 +00:00
GTEST_DISABLE_MSC_WARNINGS_PUSH_ ( 4996 /* deprecated function */ )
2009-03-26 19:03:47 +00:00
2009-04-24 00:26:25 +00:00
inline const char * StrNCpy ( char * dest , const char * src , size_t n ) {
return strncpy ( dest , src , n ) ;
2009-03-26 19:03:47 +00:00
}
2009-06-19 17:23:54 +00:00
// ChDir(), FReopen(), FDOpen(), Read(), Write(), Close(), and
// StrError() aren't needed on Windows CE at this time and thus not
// defined there.
2014-05-15 19:42:15 +00:00
# if !GTEST_OS_WINDOWS_MOBILE && !GTEST_OS_WINDOWS_PHONE && !GTEST_OS_WINDOWS_RT
2009-04-24 00:26:25 +00:00
inline int ChDir ( const char * dir ) { return chdir ( dir ) ; }
2009-06-19 17:23:54 +00:00
# endif
2009-04-24 00:26:25 +00:00
inline FILE * FOpen ( const char * path , const char * mode ) {
return fopen ( path , mode ) ;
2009-03-26 19:03:47 +00:00
}
2009-09-24 21:15:59 +00:00
# if !GTEST_OS_WINDOWS_MOBILE
2009-04-24 00:26:25 +00:00
inline FILE * FReopen ( const char * path , const char * mode , FILE * stream ) {
return freopen ( path , mode , stream ) ;
2009-03-26 19:03:47 +00:00
}
2009-04-24 00:26:25 +00:00
inline FILE * FDOpen ( int fd , const char * mode ) { return fdopen ( fd , mode ) ; }
2009-06-19 17:23:54 +00:00
# endif
2009-04-24 00:26:25 +00:00
inline int FClose ( FILE * fp ) { return fclose ( fp ) ; }
2009-09-24 21:15:59 +00:00
# if !GTEST_OS_WINDOWS_MOBILE
2009-04-24 00:26:25 +00:00
inline int Read ( int fd , void * buf , unsigned int count ) {
return static_cast < int > ( read ( fd , buf , count ) ) ;
2009-03-26 19:03:47 +00:00
}
2009-04-24 00:26:25 +00:00
inline int Write ( int fd , const void * buf , unsigned int count ) {
return static_cast < int > ( write ( fd , buf , count ) ) ;
2009-03-26 19:03:47 +00:00
}
2009-04-24 00:26:25 +00:00
inline int Close ( int fd ) { return close ( fd ) ; }
inline const char * StrError ( int errnum ) { return strerror ( errnum ) ; }
2009-06-19 17:23:54 +00:00
# endif
2009-04-24 00:26:25 +00:00
inline const char * GetEnv ( const char * name ) {
2016-11-11 03:21:56 +00:00
# if GTEST_OS_WINDOWS_MOBILE || GTEST_OS_WINDOWS_PHONE || GTEST_OS_WINDOWS_RT
2009-09-24 21:15:59 +00:00
// We are on Windows CE, which has no environment variables.
2014-11-17 02:56:14 +00:00
static_cast < void > ( name ) ; // To prevent 'unused argument' warning.
2009-03-26 19:03:47 +00:00
return NULL ;
2010-02-03 02:27:02 +00:00
# elif defined(__BORLANDC__) || defined(__SunOS_5_8) || defined(__SunOS_5_9)
2009-04-28 00:28:09 +00:00
// Environment variables which we programmatically clear will be set to the
// empty string rather than unset (NULL). Handle that case.
const char * const env = getenv ( name ) ;
return ( env ! = NULL & & env [ 0 ] ! = ' \0 ' ) ? env : NULL ;
2009-03-26 19:03:47 +00:00
# else
2009-04-24 00:26:25 +00:00
return getenv ( name ) ;
2009-03-26 19:03:47 +00:00
# endif
}
2014-05-15 19:42:15 +00:00
GTEST_DISABLE_MSC_WARNINGS_POP_ ( )
2009-03-26 19:03:47 +00:00
2009-09-24 21:15:59 +00:00
# if GTEST_OS_WINDOWS_MOBILE
2009-03-26 19:03:47 +00:00
// Windows CE has no C library. The abort() function is used in
// several places in Google Test. This implementation provides a reasonable
// imitation of standard behaviour.
2009-04-24 00:26:25 +00:00
void Abort ( ) ;
2009-03-26 19:03:47 +00:00
# else
2009-04-24 00:26:25 +00:00
inline void Abort ( ) { abort ( ) ; }
2009-09-24 21:15:59 +00:00
# endif // GTEST_OS_WINDOWS_MOBILE
2009-03-26 19:03:47 +00:00
} // namespace posix
2011-09-26 17:54:02 +00:00
// MSVC "deprecates" snprintf and issues warnings wherever it is used. In
// order to avoid these warnings, we need to use _snprintf or _snprintf_s on
// MSVC-based platforms. We map the GTEST_SNPRINTF_ macro to the appropriate
// function in order to achieve that. We use macro definition here because
// snprintf is a variadic function.
# if _MSC_VER >= 1400 && !GTEST_OS_WINDOWS_MOBILE
// MSVC 2005 and above support variadic macros.
# define GTEST_SNPRINTF_(buffer, size, format, ...) \
_snprintf_s ( buffer , size , size , format , __VA_ARGS__ )
# elif defined(_MSC_VER)
// Windows CE does not define _snprintf_s and MSVC prior to 2005 doesn't
// complain about _snprintf.
# define GTEST_SNPRINTF_ _snprintf
# else
# define GTEST_SNPRINTF_ snprintf
# endif
2008-07-03 22:38:12 +00:00
// The maximum number a BiggestInt can represent. This definition
// works no matter BiggestInt is represented in one's complement or
// two's complement.
//
// We cannot rely on numeric_limits in STL, as __int64 and long long
// are not part of standard C++ and numeric_limits doesn't need to be
// defined for them.
const BiggestInt kMaxBiggestInt =
~ ( static_cast < BiggestInt > ( 1 ) < < ( 8 * sizeof ( BiggestInt ) - 1 ) ) ;
// This template class serves as a compile-time function from size to
// type. It maps a size in bytes to a primitive type with that
// size. e.g.
//
// TypeWithSize<4>::UInt
//
// is typedef-ed to be unsigned int (unsigned integer made up of 4
// bytes).
//
// Such functionality should belong to STL, but I cannot find it
// there.
//
// Google Test uses this class in the implementation of floating-point
// comparison.
//
// For now it only handles UInt (unsigned int) as that's all Google Test
// needs. Other types can be easily added in the future if need
// arises.
template < size_t size >
class TypeWithSize {
public :
// This prevents the user from using TypeWithSize<N> with incorrect
// values of N.
typedef void UInt ;
} ;
// The specialization for size 4.
template < >
class TypeWithSize < 4 > {
public :
// unsigned int has size 4 in both gcc and MSVC.
//
// As base/basictypes.h doesn't compile on Windows, we cannot use
// uint32, uint64, and etc here.
typedef int Int ;
typedef unsigned int UInt ;
} ;
// The specialization for size 8.
template < >
class TypeWithSize < 8 > {
public :
2009-02-23 23:21:55 +00:00
# if GTEST_OS_WINDOWS
2008-07-03 22:38:12 +00:00
typedef __int64 Int ;
typedef unsigned __int64 UInt ;
# else
typedef long long Int ; // NOLINT
typedef unsigned long long UInt ; // NOLINT
# endif // GTEST_OS_WINDOWS
} ;
// Integer types of known sizes.
typedef TypeWithSize < 4 > : : Int Int32 ;
typedef TypeWithSize < 4 > : : UInt UInt32 ;
typedef TypeWithSize < 8 > : : Int Int64 ;
typedef TypeWithSize < 8 > : : UInt UInt64 ;
typedef TypeWithSize < 8 > : : Int TimeInMillis ; // Represents time in milliseconds.
// Utilities for command line flags and environment variables.
// Macro for referencing flags.
2015-07-14 19:56:37 +00:00
# if !defined(GTEST_FLAG)
# define GTEST_FLAG(name) FLAGS_gtest_##name
# endif // !defined(GTEST_FLAG)
2008-07-03 22:38:12 +00:00
2015-07-19 21:50:45 +00:00
# if !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)
# define GTEST_USE_OWN_FLAGFILE_FLAG_ 1
# endif // !defined(GTEST_USE_OWN_FLAGFILE_FLAG_)
2015-07-14 19:56:37 +00:00
# if !defined(GTEST_DECLARE_bool_)
2015-07-14 22:44:39 +00:00
# define GTEST_FLAG_SAVER_ ::testing::internal::GTestFlagSaver
2008-07-03 22:38:12 +00:00
// Macros for declaring flags.
2015-07-14 19:56:37 +00:00
# define GTEST_DECLARE_bool_(name) GTEST_API_ extern bool GTEST_FLAG(name)
# define GTEST_DECLARE_int32_(name) \
2010-03-05 21:21:06 +00:00
GTEST_API_ extern : : testing : : internal : : Int32 GTEST_FLAG ( name )
2008-10-11 07:20:02 +00:00
# define GTEST_DECLARE_string_(name) \
2012-11-15 15:47:38 +00:00
GTEST_API_ extern : : std : : string GTEST_FLAG ( name )
2008-07-03 22:38:12 +00:00
// Macros for defining flags.
2008-10-11 07:20:02 +00:00
# define GTEST_DEFINE_bool_(name, default_val, doc) \
2010-03-05 21:21:06 +00:00
GTEST_API_ bool GTEST_FLAG ( name ) = ( default_val )
2008-10-11 07:20:02 +00:00
# define GTEST_DEFINE_int32_(name, default_val, doc) \
2010-03-05 21:21:06 +00:00
GTEST_API_ : : testing : : internal : : Int32 GTEST_FLAG ( name ) = ( default_val )
2008-10-11 07:20:02 +00:00
# define GTEST_DEFINE_string_(name, default_val, doc) \
2012-11-15 15:47:38 +00:00
GTEST_API_ : : std : : string GTEST_FLAG ( name ) = ( default_val )
2008-07-03 22:38:12 +00:00
2015-07-14 19:56:37 +00:00
# endif // !defined(GTEST_DECLARE_bool_)
2011-10-24 21:13:56 +00:00
// Thread annotations
2015-07-14 19:56:37 +00:00
# if !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
# define GTEST_EXCLUSIVE_LOCK_REQUIRED_(locks)
# define GTEST_LOCK_EXCLUDED_(locks)
# endif // !defined(GTEST_EXCLUSIVE_LOCK_REQUIRED_)
2011-10-24 21:13:56 +00:00
2008-07-03 22:38:12 +00:00
// Parses 'str' for a 32-bit signed integer. If successful, writes the result
// to *value and returns true; otherwise leaves *value unchanged and returns
// false.
// TODO(chandlerc): Find a better way to refactor flag and environment parsing
// out of both gtest-port.cc and gtest.cc to avoid exporting this utility
// function.
bool ParseInt32 ( const Message & src_text , const char * str , Int32 * value ) ;
// Parses a bool/Int32/string from the environment variable
// corresponding to the given Google Test flag.
bool BoolFromGTestEnv ( const char * flag , bool default_val ) ;
2010-03-22 21:23:51 +00:00
GTEST_API_ Int32 Int32FromGTestEnv ( const char * flag , Int32 default_val ) ;
2016-02-26 22:26:23 +00:00
std : : string StringFromGTestEnv ( const char * flag , const char * default_val ) ;
2008-07-03 22:38:12 +00:00
} // namespace internal
2017-05-02 18:16:11 +00:00
2008-07-03 22:38:12 +00:00
} // namespace testing
# endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_PORT_H_