gtest-internal.h revision 190f8ee25a6977ac6eb71b816498df42f17ad9a7
17ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Copyright 2005, Google Inc. 27ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// All rights reserved. 37ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 47ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Redistribution and use in source and binary forms, with or without 57ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// modification, are permitted provided that the following conditions are 67ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// met: 77ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 87ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// * Redistributions of source code must retain the above copyright 97ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// notice, this list of conditions and the following disclaimer. 107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// * Redistributions in binary form must reproduce the above 117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// copyright notice, this list of conditions and the following disclaimer 127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// in the documentation and/or other materials provided with the 137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// distribution. 147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// * Neither the name of Google Inc. nor the names of its 157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// contributors may be used to endorse or promote products derived from 167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// this software without specific prior written permission. 177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) 317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The Google C++ Testing Framework (Google Test) 337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This header file declares functions and macros used internally by 357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Google Test. They are subject to change without notice. 367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <gtest/internal/gtest-port.h> 417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 42e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer#if GTEST_OS_LINUX 437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <stdlib.h> 447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <sys/types.h> 457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <sys/wait.h> 467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <unistd.h> 477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_OS_LINUX 487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <ctype.h> 507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <string.h> 517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <iomanip> 527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <limits> 537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <set> 547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <gtest/internal/gtest-string.h> 567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <gtest/internal/gtest-filepath.h> 577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#include <gtest/internal/gtest-type-util.h> 587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 599c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin#include "llvm/Support/raw_os_ostream.h" 609c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin 617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Due to C++ preprocessor weirdness, we need double indirection to 627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// concatenate two tokens when one of them is __LINE__. Writing 637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// foo ## __LINE__ 657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// will result in the token foo__LINE__, instead of foo followed by 677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the current line number. For more details, see 687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// http://www.parashift.com/c++-faq-lite/misc-technical-issues.html#faq-39.6 697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_CONCAT_TOKEN_(foo, bar) GTEST_CONCAT_TOKEN_IMPL_(foo, bar) 707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_CONCAT_TOKEN_IMPL_(foo, bar) foo ## bar 717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Google Test defines the testing::Message class to allow construction of 737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test messages via the << operator. The idea is that anything 747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// streamable to std::ostream can be streamed to a testing::Message. 757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This allows a user to use his own types in Google Test assertions by 767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// overloading the << operator. 777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// util/gtl/stl_logging-inl.h overloads << for STL containers. These 797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// overloads cannot be defined in the std namespace, as that will be 807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// undefined behavior. Therefore, they are defined in the global 817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// namespace instead. 827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// C++'s symbol lookup rule (i.e. Koenig lookup) says that these 847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// overloads are visible in either the std namespace or the global 857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// namespace, but not other namespaces, including the testing 867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// namespace which Google Test's Message class is in. 877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// To allow STL containers (and other types that has a << operator 897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// defined in the global namespace) to be used in Google Test assertions, 907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// testing::Message must access the custom << operator from the global 917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// namespace. Hence this helper function. 927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Note: Jeffrey Yasskin suggested an alternative fix by "using 947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ::operator<<;" in the definition of Message's operator<<. That fix 957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// doesn't require a helper function, but unfortunately doesn't 967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compile with MSVC. 979c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin 989c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin// LLVM INTERNAL CHANGE: To allow operator<< to work with both 999c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin// std::ostreams and LLVM's raw_ostreams, we define a special 1009c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin// std::ostream with an implicit conversion to raw_ostream& and stream 1019c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin// to that. This causes the compiler to prefer std::ostream overloads 1029c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin// but still find raw_ostream& overloads. 1039c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskinnamespace llvm { 1049c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskinclass convertible_fwd_ostream : public std::ostream { 1059c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin std::ostream& os_; 1069c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin raw_os_ostream ros_; 1079c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin 1089c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskinpublic: 1099c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin convertible_fwd_ostream(std::ostream& os) 1109c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin : std::ostream(os.rdbuf()), os_(os), ros_(*this) {} 1119c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin operator raw_ostream&() { return ros_; } 1129c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin}; 1139c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin} 1147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 1157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline void GTestStreamToHelper(std::ostream* os, const T& val) { 1169c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin llvm::convertible_fwd_ostream cos(*os); 1179c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin cos << val; 1187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 1197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmannamespace testing { 1217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Forward declaration of classes. 1237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 124190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerclass AssertionResult; // Result of an assertion. 1257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass Message; // Represents a failure message. 1267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass Test; // Represents a test. 1277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestInfo; // Information about a test. 128190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerclass TestPartResult; // Result of a test part. 1297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass UnitTest; // A collection of test cases. 1307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmannamespace internal { 1327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanstruct TraceInfo; // Information about a trace point. 1347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass ScopedTrace; // Implements scoped trace. 1357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestInfoImpl; // Opaque implementation of TestInfo 1367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass UnitTestImpl; // Opaque implementation of UnitTest 137190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramertemplate <typename E> class Vector; // A generic vector. 1387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// How many times InitGoogleTest() has been called. 1407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanextern int g_init_gtest_count; 1417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The text used in failure messages to indicate the start of the 1437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// stack trace. 1447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanextern const char kStackTraceMarker[]; 1457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A secret type that Google Test users don't know about. It has no 1477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// definition on purpose. Therefore it's impossible to create a 1487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Secret object, which is what we want. 1497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass Secret; 1507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Two overloaded helpers for checking at compile time whether an 1527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// expression is a null pointer literal (i.e. NULL or any 0-valued 1537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compile-time integral constant). Their return values have 1547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// different sizes, so we can use sizeof() to test which version is 1557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// picked by the compiler. These helpers have no implementations, as 1567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// we only need their signatures. 1577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 1587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Given IsNullLiteralHelper(x), the compiler will pick the first 1597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// version if x can be implicitly converted to Secret*, and pick the 1607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// second version otherwise. Since Secret is a secret and incomplete 1617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// type, the only expression a user can write that has type Secret* is 1627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// a null pointer literal. Therefore, we know that x is a null 1637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// pointer literal if and only if the first version is picked by the 1647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiler. 1657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanchar IsNullLiteralHelper(Secret* p); 1667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanchar (&IsNullLiteralHelper(...))[2]; // NOLINT 1677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A compile-time bool constant that is true if and only if x is a 1697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// null pointer literal (i.e. NULL or any 0-valued compile-time 1707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// integral constant). 1717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#ifdef GTEST_ELLIPSIS_NEEDS_COPY_ 1727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Passing non-POD classes through ellipsis (...) crashes the ARM 1737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiler. The Nokia Symbian and the IBM XL C/C++ compiler try to 1747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// instantiate a copy constructor for objects passed through ellipsis 1757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (...), failing for uncopyable objects. Hence we define this to 1767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// false (and lose support for NULL detection). 1777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_IS_NULL_LITERAL_(x) false 1787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#else 1797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_IS_NULL_LITERAL_(x) \ 1807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman (sizeof(::testing::internal::IsNullLiteralHelper(x)) == 1) 1817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_ELLIPSIS_NEEDS_COPY_ 1827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Appends the user-supplied message to the Google-Test-generated message. 1847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString AppendUserMessage(const String& gtest_msg, 1857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Message& user_msg); 1867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A helper class for creating scoped traces in user programs. 1887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass ScopedTrace { 1897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 1907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The c'tor pushes the given source file location and message onto 1917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // a trace stack maintained by Google Test. 1927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ScopedTrace(const char* file, int line, const Message& message); 1937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The d'tor pops the info pushed by the c'tor. 1957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Note that the d'tor is not virtual in order to be efficient. 1977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Don't inherit from ScopedTrace! 1987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ~ScopedTrace(); 1997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 2017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace); 2027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} GTEST_ATTRIBUTE_UNUSED_; // A ScopedTrace object does its job in its 2037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // c'tor and d'tor. Therefore it doesn't 2047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // need to be used otherwise. 2057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Converts a streamable value to a String. A NULL pointer is 2077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// converted to "(null)". When the input value is a ::string, 2087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ::std::string, ::wstring, or ::std::wstring object, each NUL 2097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// character in it is replaced with "\\0". 2107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Declared here but defined in gtest.h, so that it has access 2117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// to the definition of the Message class, required by the ARM 2127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiler. 2137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 2147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString StreamableToString(const T& streamable); 2157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Formats a value to be used in a failure message. 2177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#ifdef GTEST_NEEDS_IS_POINTER_ 2197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// These are needed as the Nokia Symbian and IBM XL C/C++ compilers 2217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// cannot decide between const T& and const T* in a function template. 2227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// These compilers _can_ decide between class template specializations 2237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// for T and T*, so a tr1::type_traits-like is_pointer works, and we 2247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// can overload on that. 2257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This overload makes sure that all pointers (including 2277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// those to char or wchar_t) are printed as raw pointers. 2287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 229190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerinline String FormatValueForFailureMessage(internal::true_type /*dummy*/, 2307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman T* pointer) { 2317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return StreamableToString(static_cast<const void*>(pointer)); 2327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 235190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerinline String FormatValueForFailureMessage(internal::false_type /*dummy*/, 2367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const T& value) { 2377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return StreamableToString(value); 2387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 2417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForFailureMessage(const T& value) { 2427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return FormatValueForFailureMessage( 2437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typename internal::is_pointer<T>::type(), value); 2447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#else 2477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// These are needed as the above solution using is_pointer has the 2497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// limitation that T cannot be a type without external linkage, when 2507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiled using MSVC. 2517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 2537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForFailureMessage(const T& value) { 2547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return StreamableToString(value); 2557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This overload makes sure that all pointers (including 2587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// those to char or wchar_t) are printed as raw pointers. 2597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 2607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForFailureMessage(T* pointer) { 2617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return StreamableToString(static_cast<const void*>(pointer)); 2627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_NEEDS_IS_POINTER_ 2657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// These overloaded versions handle narrow and wide characters. 2677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString FormatForFailureMessage(char ch); 2687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString FormatForFailureMessage(wchar_t wchar); 2697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// When this operand is a const char* or char*, and the other operand 2717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// is a ::std::string or ::string, we print this operand as a C string 2727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// rather than a pointer. We do the same for wide strings. 2737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This internal macro is used to avoid duplicated code. 2757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_FORMAT_IMPL_(operand2_type, operand1_printer)\ 2767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForComparisonFailureMessage(\ 2777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman operand2_type::value_type* str, const operand2_type& /*operand2*/) {\ 2787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return operand1_printer(str);\ 2797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}\ 2807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForComparisonFailureMessage(\ 2817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const operand2_type::value_type* str, const operand2_type& /*operand2*/) {\ 2827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return operand1_printer(str);\ 2837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_STD_STRING 2867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::std::string, String::ShowCStringQuoted) 2877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_STD_STRING 2887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_STD_WSTRING 2897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::std::wstring, String::ShowWideCStringQuoted) 2907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_STD_WSTRING 2917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_GLOBAL_STRING 2937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::string, String::ShowCStringQuoted) 2947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_GLOBAL_STRING 2957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_GLOBAL_WSTRING 2967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::wstring, String::ShowWideCStringQuoted) 2977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_GLOBAL_WSTRING 2987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#undef GTEST_FORMAT_IMPL_ 3007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Constructs and returns the message for an equality assertion 3027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure. 3037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The first four parameters are the expressions used in the assertion 3057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// and their values, as strings. For example, for ASSERT_EQ(foo, bar) 3067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// where foo is 5 and bar is 6, we have: 3077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// expected_expression: "foo" 3097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// actual_expression: "bar" 3107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// expected_value: "5" 3117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// actual_value: "6" 3127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The ignoring_case parameter is true iff the assertion is a 3147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// *_STRCASEEQ*. When it's true, the string " (ignoring case)" will 3157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// be inserted into the message. 3167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanAssertionResult EqFailure(const char* expected_expression, 3177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* actual_expression, 3187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const String& expected_value, 3197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const String& actual_value, 3207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool ignoring_case); 3217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This template class represents an IEEE floating-point number 3247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (either single-precision or double-precision, depending on the 3257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// template parameters). 3267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The purpose of this class is to do more sophisticated number 3287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// comparison. (Due to round-off error, etc, it's very unlikely that 3297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// two floating-points will be equal exactly. Hence a naive 3307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// comparison by the == operation often doesn't work.) 3317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Format of IEEE floating-point: 3337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The most-significant bit being the leftmost, an IEEE 3357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// floating-point looks like 3367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// sign_bit exponent_bits fraction_bits 3387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Here, sign_bit is a single bit that designates the sign of the 3407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// number. 3417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// For float, there are 8 exponent bits and 23 fraction bits. 3437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// For double, there are 11 exponent bits and 52 fraction bits. 3457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// More details can be found at 3477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// http://en.wikipedia.org/wiki/IEEE_floating-point_standard. 3487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Template parameter: 3507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// RawType: the raw floating-point type (either float or double) 3527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename RawType> 3537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass FloatingPoint { 3547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 3557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Defines the unsigned integer type that has the same size as the 3567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // floating point number. 3577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename TypeWithSize<sizeof(RawType)>::UInt Bits; 3587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Constants. 3607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // # of bits in a number. 3627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kBitCount = 8*sizeof(RawType); 3637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // # of fraction bits in a number. 3657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kFractionBitCount = 3667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman std::numeric_limits<RawType>::digits - 1; 3677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // # of exponent bits in a number. 3697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kExponentBitCount = kBitCount - 1 - kFractionBitCount; 3707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The mask for the sign bit. 3727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const Bits kSignBitMask = static_cast<Bits>(1) << (kBitCount - 1); 3737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The mask for the fraction bits. 3757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const Bits kFractionBitMask = 3767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ~static_cast<Bits>(0) >> (kExponentBitCount + 1); 3777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The mask for the exponent bits. 3797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const Bits kExponentBitMask = ~(kSignBitMask | kFractionBitMask); 3807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // How many ULP's (Units in the Last Place) we want to tolerate when 3827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // comparing two numbers. The larger the value, the more error we 3837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // allow. A 0 value means that two numbers must be exactly the same 3847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // to be considered equal. 3857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The maximum error of a single floating-point operation is 0.5 3877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // units in the last place. On Intel CPU's, all floating-point 3887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // calculations are done with 80-bit precision, while double has 64 3897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // bits. Therefore, 4 should be enough for ordinary use. 3907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // See the following article for more details on ULP: 3927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm. 3937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kMaxUlps = 4; 3947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Constructs a FloatingPoint from a raw floating-point number. 3967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // On an Intel CPU, passing a non-normalized NAN (Not a Number) 3987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // around may change its bits, although the new value is guaranteed 3997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // to be also a NAN. Therefore, don't expect this constructor to 4007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // preserve the bits in x when x is a NAN. 401190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer explicit FloatingPoint(const RawType& x) { u_.value_ = x; } 4027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Static methods 4047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Reinterprets a bit pattern as a floating-point number. 4067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // This function is needed to test the AlmostEquals() method. 4087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static RawType ReinterpretBits(const Bits bits) { 4097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman FloatingPoint fp(0); 410190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer fp.u_.bits_ = bits; 411190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return fp.u_.value_; 4127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the floating-point number that represent positive infinity. 4157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static RawType Infinity() { 4167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return ReinterpretBits(kExponentBitMask); 4177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Non-static methods 4207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the bits that represents this number. 422190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const Bits &bits() const { return u_.bits_; } 4237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the exponent bits of this number. 425190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits exponent_bits() const { return kExponentBitMask & u_.bits_; } 4267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the fraction bits of this number. 428190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits fraction_bits() const { return kFractionBitMask & u_.bits_; } 4297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the sign bit of this number. 431190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits sign_bit() const { return kSignBitMask & u_.bits_; } 4327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this is NAN (not a number). 4347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool is_nan() const { 4357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // It's a NAN if the exponent bits are all ones and the fraction 4367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // bits are not entirely zeros. 4377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return (exponent_bits() == kExponentBitMask) && (fraction_bits() != 0); 4387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns true iff this number is at most kMaxUlps ULP's away from 4417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // rhs. In particular, this function: 4427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // - returns false if either number is (or both are) NAN. 4447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // - treats really large numbers as almost equal to infinity. 4457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // - thinks +0.0 and -0.0 are 0 DLP's apart. 4467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool AlmostEquals(const FloatingPoint& rhs) const { 4477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The IEEE standard says that any comparison operation involving 4487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // a NAN must return false. 4497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (is_nan() || rhs.is_nan()) return false; 4507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 451190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return DistanceBetweenSignAndMagnitudeNumbers(u_.bits_, rhs.u_.bits_) 452190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer <= kMaxUlps; 4537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 456190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // The data type used to store the actual floating-point number. 457190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer union FloatingPointUnion { 458190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer RawType value_; // The raw floating-point number. 459190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits bits_; // The bits that represent the number. 460190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer }; 461190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 4627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Converts an integer from the sign-and-magnitude representation to 4637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // the biased representation. More precisely, let N be 2 to the 4647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // power of (kBitCount - 1), an integer x is represented by the 4657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // unsigned number x + N. 4667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // For instance, 4687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // -N + 1 (the most negative number representable using 4707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sign-and-magnitude) is represented by 1; 4717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 0 is represented by N; and 4727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // N - 1 (the biggest number representable using 4737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sign-and-magnitude) is represented by 2N - 1. 4747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Read http://en.wikipedia.org/wiki/Signed_number_representations 4767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // for more details on signed number representations. 4777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static Bits SignAndMagnitudeToBiased(const Bits &sam) { 4787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (kSignBitMask & sam) { 4797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sam represents a negative number. 4807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return ~sam + 1; 4817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else { 4827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sam represents a positive number. 4837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return kSignBitMask | sam; 4847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Given two numbers in the sign-and-magnitude representation, 4887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // returns the distance between them as an unsigned number. 4897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static Bits DistanceBetweenSignAndMagnitudeNumbers(const Bits &sam1, 4907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Bits &sam2) { 4917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Bits biased1 = SignAndMagnitudeToBiased(sam1); 4927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Bits biased2 = SignAndMagnitudeToBiased(sam2); 4937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return (biased1 >= biased2) ? (biased1 - biased2) : (biased2 - biased1); 4947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 496190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer FloatingPointUnion u_; 4977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 4987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Typedefs the instances of the FloatingPoint template class that we 5007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// care to use. 5017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef FloatingPoint<float> Float; 5027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef FloatingPoint<double> Double; 5037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// In order to catch the mistake of putting tests that use different 5057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test fixture classes in the same test case, we need to assign 5067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// unique IDs to fixture classes and compare them. The TypeId type is 5077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// used to hold such IDs. The user should treat TypeId as an opaque 5087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// type: the only operation allowed on TypeId values is to compare 5097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// them for equality using the == operator. 5107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef const void* TypeId; 5117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 5137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeIdHelper { 5147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 5157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // dummy_ must not have a const type. Otherwise an overly eager 5167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // compiler (e.g. MSVC 7.1 & 8.0) may try to merge 5177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // TypeIdHelper<T>::dummy_ for different Ts as an "optimization". 5187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool dummy_; 5197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 5207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 5227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanbool TypeIdHelper<T>::dummy_ = false; 5237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// GetTypeId<T>() returns the ID of type T. Different values will be 5257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// returned for different types. Calling the function twice with the 5267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// same type argument is guaranteed to return the same ID. 5277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 5287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanTypeId GetTypeId() { 5297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The compiler is required to allocate a different 5307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // TypeIdHelper<T>::dummy_ variable for each T used to instantiate 5317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // the template. Therefore, the address of dummy_ is guaranteed to 5327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // be unique. 5337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return &(TypeIdHelper<T>::dummy_); 5347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 5357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Returns the type ID of ::testing::Test. Always call this instead 5377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// of GetTypeId< ::testing::Test>() to get the type ID of 5387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ::testing::Test, as the latter may give the wrong result due to a 5397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// suspected linker bug when compiling Google Test as a Mac OS X 5407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// framework. 5417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanTypeId GetTestTypeId(); 5427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Defines the abstract factory interface that creates instances 5447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// of a Test object. 5457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestFactoryBase { 5467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 5477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual ~TestFactoryBase() {} 5487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Creates a test instance to run. The instance is both created and destroyed 5507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // within TestInfoImpl::Run() 5517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual Test* CreateTest() = 0; 5527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman protected: 5547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestFactoryBase() {} 5557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 5577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_DISALLOW_COPY_AND_ASSIGN_(TestFactoryBase); 5587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 5597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This class provides implementation of TeastFactoryBase interface. 5617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// It is used in TEST and TEST_F macros. 5627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <class TestClass> 5637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestFactoryImpl : public TestFactoryBase { 5647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 5657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual Test* CreateTest() { return new TestClass; } 5667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 5677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 568e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer#if GTEST_OS_WINDOWS 5697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Predicate-formatters for implementing the HRESULT checking macros 5717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED} 5727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// We pass a long instead of HRESULT to avoid causing an 5737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// include dependency for the HRESULT type. 5747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanAssertionResult IsHRESULTSuccess(const char* expr, long hr); // NOLINT 5757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanAssertionResult IsHRESULTFailure(const char* expr, long hr); // NOLINT 5767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_OS_WINDOWS 5787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Formats a source file path and a line number as they would appear 5807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// in a compiler error message. 5817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatFileLocation(const char* file, int line) { 5827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* const file_name = file == NULL ? "unknown file" : file; 5837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (line < 0) { 5847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return String::Format("%s:", file_name); 5857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 5867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#ifdef _MSC_VER 5877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return String::Format("%s(%d):", file_name, line); 5887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#else 5897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return String::Format("%s:%d:", file_name, line); 5907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // _MSC_VER 5917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 5927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Types of SetUpTestCase() and TearDownTestCase() functions. 5947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef void (*SetUpTestCaseFunc)(); 5957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef void (*TearDownTestCaseFunc)(); 5967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Creates a new TestInfo object and registers it with Google Test; 5987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// returns the created object. 5997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 6007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Arguments: 6017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 6027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test_case_name: name of the test case 6037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// name: name of the test 6047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test_case_comment: a comment on the test case that will be included in 6057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the test output 6067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// comment: a comment on the test that will be included in the 6077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test output 6087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// fixture_class_id: ID of the test fixture class 6097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// set_up_tc: pointer to the function that sets up the test case 6107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// tear_down_tc: pointer to the function that tears down the test case 6117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// factory: pointer to the factory that creates a test object. 6127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The newly created TestInfo instance will assume 6137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ownership of the factory object. 6147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanTestInfo* MakeAndRegisterTestInfo( 6157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_case_name, const char* name, 6167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_case_comment, const char* comment, 6177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TypeId fixture_class_id, 6187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman SetUpTestCaseFunc set_up_tc, 6197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TearDownTestCaseFunc tear_down_tc, 6207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestFactoryBase* factory); 6217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 622e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P 6237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// State of the definition of a type-parameterized test case. 6257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypedTestCasePState { 6267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 6277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TypedTestCasePState() : registered_(false) {} 6287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Adds the given test name to defined_test_names_ and return true 6307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // if the test case hasn't been registered; otherwise aborts the 6317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // program. 6327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool AddTestName(const char* file, int line, const char* case_name, 6337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_name) { 6347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (registered_) { 6357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fprintf(stderr, "%s Test %s must be defined before " 6367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman "REGISTER_TYPED_TEST_CASE_P(%s, ...).\n", 6377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman FormatFileLocation(file, line).c_str(), test_name, case_name); 638e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer fflush(stderr); 639190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer posix::Abort(); 6407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman defined_test_names_.insert(test_name); 6427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return true; 6437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Verifies that registered_tests match the test names in 6467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // defined_test_names_; returns registered_tests if successful, or 6477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // aborts the program otherwise. 6487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* VerifyRegisteredTestNames( 6497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* file, int line, const char* registered_tests); 6507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 6527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool registered_; 6537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::std::set<const char*> defined_test_names_; 6547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 6557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Skips to the first non-space char after the first comma in 'str'; 6577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// returns NULL if no comma is found in 'str'. 6587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline const char* SkipComma(const char* str) { 6597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* comma = strchr(str, ','); 6607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (comma == NULL) { 6617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return NULL; 6627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman while (isspace(*(++comma))) {} 6647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return comma; 6657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 6667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Returns the prefix of 'str' before the first comma in it; returns 6687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the entire string if it contains no comma. 6697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String GetPrefixUntilComma(const char* str) { 6707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* comma = strchr(str, ','); 6717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return comma == NULL ? String(str) : String(str, comma - str); 6727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 6737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// TypeParameterizedTest<Fixture, TestSel, Types>::Register() 6757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// registers a list of type-parameterized tests with Google Test. The 6767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// return value is insignificant - we just need to return something 6777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// such that we can call this function in a namespace scope. 6787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 6797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Implementation note: The GTEST_TEMPLATE_ macro declares a template 6807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// template parameter. It's defined in gtest-type-util.h. 6817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, class TestSel, typename Types> 6827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTest { 6837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 6847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 'index' is the index of the test in the type list 'Types' 6857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // specified in INSTANTIATE_TYPED_TEST_CASE_P(Prefix, TestCase, 6867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Types). Valid values for 'index' are [0, N - 1] where N is the 6877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // length of Types. 6887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool Register(const char* prefix, const char* case_name, 6897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_names, int index) { 6907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename Types::Head Type; 6917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef Fixture<Type> FixtureClass; 6927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename GTEST_BIND_(TestSel, Type) TestClass; 6937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // First, registers the first type-parameterized test in the type 6957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // list. 6967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman MakeAndRegisterTestInfo( 6977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman String::Format("%s%s%s/%d", prefix, prefix[0] == '\0' ? "" : "/", 6987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman case_name, index).c_str(), 6997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GetPrefixUntilComma(test_names).c_str(), 7007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman String::Format("TypeParam = %s", GetTypeName<Type>().c_str()).c_str(), 7017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman "", 7027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GetTypeId<FixtureClass>(), 7037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestClass::SetUpTestCase, 7047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestClass::TearDownTestCase, 7057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman new TestFactoryImpl<TestClass>); 7067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Next, recurses (at compile time) with the tail of the type list. 7087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return TypeParameterizedTest<Fixture, TestSel, typename Types::Tail> 7097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::Register(prefix, case_name, test_names, index + 1); 7107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 7117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 7127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The base case for the compile time recursion. 7147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, class TestSel> 7157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTest<Fixture, TestSel, Types0> { 7167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 7177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool Register(const char* /*prefix*/, const char* /*case_name*/, 7187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* /*test_names*/, int /*index*/) { 7197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return true; 7207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 7217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 7227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// TypeParameterizedTestCase<Fixture, Tests, Types>::Register() 7247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// registers *all combinations* of 'Tests' and 'Types' with Google 7257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Test. The return value is insignificant - we just need to return 7267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// something such that we can call this function in a namespace scope. 7277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, typename Tests, typename Types> 7287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTestCase { 7297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 7307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool Register(const char* prefix, const char* case_name, 7317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_names) { 7327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename Tests::Head Head; 7337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // First, register the first test in 'Test' for each type in 'Types'. 7357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TypeParameterizedTest<Fixture, Head, Types>::Register( 7367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman prefix, case_name, test_names, 0); 7377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Next, recurses (at compile time) with the tail of the test list. 7397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return TypeParameterizedTestCase<Fixture, typename Tests::Tail, Types> 7407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::Register(prefix, case_name, SkipComma(test_names)); 7417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 7427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 7437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The base case for the compile time recursion. 7457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, typename Types> 7467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTestCase<Fixture, Templates0, Types> { 7477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 748190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer static bool Register(const char* /*prefix*/, const char* /*case_name*/, 749190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const char* /*test_names*/) { 7507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return true; 7517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 7527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 7537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P 7557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Returns the current OS stack trace as a String. 7577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 7587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The maximum number of stack frames to be included is specified by 7597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the gtest_stack_trace_depth flag. The skip_count parameter 7607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// specifies the number of top frames to be skipped, which doesn't 7617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// count against the number of frames to be included. 7627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 7637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// For example, if Foo() calls Bar(), which in turn calls 7647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in 7657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't. 7667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString GetCurrentOsStackTraceExceptTop(UnitTest* unit_test, int skip_count); 7677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 768190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Helpers for suppressing warnings on unreachable code or constant 769190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// condition. 7707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 771190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Always returns true. 772e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramerbool AlwaysTrue(); 773e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer 774190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Always returns false. 775190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerinline bool AlwaysFalse() { return !AlwaysTrue(); } 776190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 777190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// A simple Linear Congruential Generator for generating random 778190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// numbers with a uniform distribution. Unlike rand() and srand(), it 779190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// doesn't use global state (and therefore can't interfere with user 780190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// code). Unlike rand_r(), it's portable. An LCG isn't very random, 781190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// but it's good enough for our purposes. 782190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerclass Random { 783190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer public: 784190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer static const UInt32 kMaxRange = 1u << 31; 785190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 786190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer explicit Random(UInt32 seed) : state_(seed) {} 787190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 788190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer void Reseed(UInt32 seed) { state_ = seed; } 789190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 790190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // Generates a random number from [0, range). Crashes if 'range' is 791190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // 0 or greater than kMaxRange. 792190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer UInt32 Generate(UInt32 range); 793190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 794190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer private: 795190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer UInt32 state_; 796190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_DISALLOW_COPY_AND_ASSIGN_(Random); 797190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer}; 798190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 7997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} // namespace internal 8007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} // namespace testing 8017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_MESSAGE_(message, result_type) \ 8037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::testing::internal::AssertHelper(result_type, __FILE__, __LINE__, message) \ 8047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman = ::testing::Message() 8057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_FATAL_FAILURE_(message) \ 807190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return GTEST_MESSAGE_(message, ::testing::TestPartResult::kFatalFailure) 8087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_NONFATAL_FAILURE_(message) \ 810190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_MESSAGE_(message, ::testing::TestPartResult::kNonFatalFailure) 8117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_SUCCESS_(message) \ 813190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_MESSAGE_(message, ::testing::TestPartResult::kSuccess) 8147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 815e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// Suppresses MSVC warnings 4072 (unreachable code) for the code following 816e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// statement if it returns or throws (or doesn't return or throw in some 817e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// situations). 818190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer#define GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) \ 819e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer if (::testing::internal::AlwaysTrue()) { statement; } 820e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer 8217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_THROW_(statement, expected_exception, fail) \ 8227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 8237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (const char* gtest_msg = "") { \ 8247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool gtest_caught_expected = false; \ 8257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman try { \ 826190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 8277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (expected_exception const&) { \ 8297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_caught_expected = true; \ 8307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (...) { \ 8327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_msg = "Expected: " #statement " throws an exception of type " \ 8337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman #expected_exception ".\n Actual: it throws a different " \ 8347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman "type."; \ 8357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ 8367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (!gtest_caught_expected) { \ 8387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_msg = "Expected: " #statement " throws an exception of type " \ 8397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman #expected_exception ".\n Actual: it throws nothing."; \ 8407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ 8417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 8437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__): \ 8447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fail(gtest_msg) 8457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_NO_THROW_(statement, fail) \ 8477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 8487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (const char* gtest_msg = "") { \ 8497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman try { \ 850190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 8517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (...) { \ 8537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_msg = "Expected: " #statement " doesn't throw an exception.\n" \ 8547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman " Actual: it throws."; \ 8557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__); \ 8567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 8587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__): \ 8597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fail(gtest_msg) 8607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_ANY_THROW_(statement, fail) \ 8627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 8637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (const char* gtest_msg = "") { \ 8647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool gtest_caught_any = false; \ 8657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman try { \ 866190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 8677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (...) { \ 8697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_caught_any = true; \ 8707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (!gtest_caught_any) { \ 8727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_msg = "Expected: " #statement " throws an exception.\n" \ 8737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman " Actual: it doesn't."; \ 8747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__); \ 8757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 8777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__): \ 8787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fail(gtest_msg) 8797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_BOOLEAN_(boolexpr, booltext, actual, expected, fail) \ 8827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 883190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer if (::testing::internal::IsTrue(boolexpr)) \ 8847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ; \ 8857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman else \ 8867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fail("Value of: " booltext "\n Actual: " #actual "\nExpected: " #expected) 8877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 8887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_NO_FATAL_FAILURE_(statement, fail) \ 8897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 8907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (const char* gtest_msg = "") { \ 8917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker; \ 892190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 8937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (gtest_fatal_failure_checker.has_new_fatal_failure()) { \ 8947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_msg = "Expected: " #statement " doesn't generate new fatal " \ 8957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman "failures in the current thread.\n" \ 8967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman " Actual: it does."; \ 8977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__); \ 8987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 8997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 9007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__): \ 9017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fail(gtest_msg) 9027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 9037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Expands to the name of the class that implements the given test. 9047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \ 9057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman test_case_name##_##test_name##_Test 9067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 9077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Helper macro for defining tests. 9087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_(test_case_name, test_name, parent_class, parent_id)\ 9097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass GTEST_TEST_CLASS_NAME_(test_case_name, test_name) : public parent_class {\ 9107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public:\ 9117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\ 9127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private:\ 9137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual void TestBody();\ 9147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static ::testing::TestInfo* const test_info_;\ 9157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_DISALLOW_COPY_AND_ASSIGN_(\ 9167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\ 9177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman};\ 9187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman\ 9197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman::testing::TestInfo* const GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\ 9207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::test_info_ =\ 9217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::testing::internal::MakeAndRegisterTestInfo(\ 9227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman #test_case_name, #test_name, "", "", \ 9237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman (parent_id), \ 9247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman parent_class::SetUpTestCase, \ 9257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman parent_class::TearDownTestCase, \ 9267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman new ::testing::internal::TestFactoryImpl<\ 9277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>);\ 9287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanvoid GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody() 9297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 9307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 931