gtest-internal.h revision 94c22716d60ff5edf6a98a3c67e0faa001be1142
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 40b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#include "gtest/internal/gtest-port.h" 417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 42e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer#if GTEST_OS_LINUX 43b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# include <stdlib.h> 44b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# include <sys/types.h> 45b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# include <sys/wait.h> 46b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# 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 55b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#include "gtest/internal/gtest-string.h" 56b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#include "gtest/internal/gtest-filepath.h" 57b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#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 raw_os_ostream ros_; 1069c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin 1079c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskinpublic: 1089c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin convertible_fwd_ostream(std::ostream& os) 109955f9387516da03b51337b126bebb43567141173Benjamin Kramer : std::ostream(os.rdbuf()), ros_(*this) {} 1109c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin operator raw_ostream&() { return ros_; } 1119c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin}; 1129c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin} 1137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 1147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline void GTestStreamToHelper(std::ostream* os, const T& val) { 1159c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin llvm::convertible_fwd_ostream cos(*os); 1169c0c3bf1ec2feb861f19867d4091350010b23de6Jeffrey Yasskin cos << val; 1177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 1187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 119b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadclass ProtocolMessage; 120b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadnamespace proto2 { class Message; } 121b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmannamespace testing { 1237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 124b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Forward declarations. 1257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 126190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerclass AssertionResult; // Result of an assertion. 1277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass Message; // Represents a failure message. 1287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass Test; // Represents a test. 1297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestInfo; // Information about a test. 130190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerclass TestPartResult; // Result of a test part. 1317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass UnitTest; // A collection of test cases. 1327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 133b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 134b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad::std::string PrintToString(const T& value); 135b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmannamespace internal { 1377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanstruct TraceInfo; // Information about a trace point. 1397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass ScopedTrace; // Implements scoped trace. 1407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestInfoImpl; // Opaque implementation of TestInfo 1417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass UnitTestImpl; // Opaque implementation of UnitTest 1427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// How many times InitGoogleTest() has been called. 1447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanextern int g_init_gtest_count; 1457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The text used in failure messages to indicate the start of the 1477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// stack trace. 14857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ extern const char kStackTraceMarker[]; 1497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A secret type that Google Test users don't know about. It has no 1517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// definition on purpose. Therefore it's impossible to create a 1527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Secret object, which is what we want. 1537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass Secret; 1547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Two overloaded helpers for checking at compile time whether an 1567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// expression is a null pointer literal (i.e. NULL or any 0-valued 1577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compile-time integral constant). Their return values have 1587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// different sizes, so we can use sizeof() to test which version is 1597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// picked by the compiler. These helpers have no implementations, as 1607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// we only need their signatures. 1617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 1627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Given IsNullLiteralHelper(x), the compiler will pick the first 1637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// version if x can be implicitly converted to Secret*, and pick the 1647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// second version otherwise. Since Secret is a secret and incomplete 1657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// type, the only expression a user can write that has type Secret* is 1667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// a null pointer literal. Therefore, we know that x is a null 1677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// pointer literal if and only if the first version is picked by the 1687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiler. 1697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanchar IsNullLiteralHelper(Secret* p); 1707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanchar (&IsNullLiteralHelper(...))[2]; // NOLINT 1717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A compile-time bool constant that is true if and only if x is a 1737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// null pointer literal (i.e. NULL or any 0-valued compile-time 1747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// integral constant). 17557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer#ifdef GTEST_ELLIPSIS_NEEDS_POD_ 17657240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// We lose support for NULL detection where the compiler doesn't like 17757240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// passing non-POD classes through ellipsis (...). 178b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# define GTEST_IS_NULL_LITERAL_(x) false 1797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#else 180b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# define GTEST_IS_NULL_LITERAL_(x) \ 1817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman (sizeof(::testing::internal::IsNullLiteralHelper(x)) == 1) 18257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer#endif // GTEST_ELLIPSIS_NEEDS_POD_ 1837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Appends the user-supplied message to the Google-Test-generated message. 18557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ String AppendUserMessage(const String& gtest_msg, 18657240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const Message& user_msg); 1877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// A helper class for creating scoped traces in user programs. 18957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramerclass GTEST_API_ ScopedTrace { 1907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 1917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The c'tor pushes the given source file location and message onto 1927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // a trace stack maintained by Google Test. 1937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ScopedTrace(const char* file, int line, const Message& message); 1947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The d'tor pops the info pushed by the c'tor. 1967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 1977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Note that the d'tor is not virtual in order to be efficient. 1987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Don't inherit from ScopedTrace! 1997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ~ScopedTrace(); 2007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 2027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace); 2037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} GTEST_ATTRIBUTE_UNUSED_; // A ScopedTrace object does its job in its 2047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // c'tor and d'tor. Therefore it doesn't 2057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // need to be used otherwise. 2067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Converts a streamable value to a String. A NULL pointer is 2087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// converted to "(null)". When the input value is a ::string, 2097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ::std::string, ::wstring, or ::std::wstring object, each NUL 2107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// character in it is replaced with "\\0". 2117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Declared here but defined in gtest.h, so that it has access 2127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// to the definition of the Message class, required by the ARM 2137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// compiler. 2147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 2157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanString StreamableToString(const T& streamable); 2167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 217b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// The Symbian compiler has a bug that prevents it from selecting the 218b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// correct overload of FormatForComparisonFailureMessage (see below) 219b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// unless we pass the first argument by reference. If we do that, 220b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// however, Visual Age C++ 10.1 generates a compiler error. Therefore 221b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// we only apply the work-around for Symbian. 222b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#if defined(__SYMBIAN32__) 223b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# define GTEST_CREF_WORKAROUND_ const& 2247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#else 225b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# define GTEST_CREF_WORKAROUND_ 226b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#endif 2277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 228b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// When this operand is a const char* or char*, if the other operand 2297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// is a ::std::string or ::string, we print this operand as a C string 230b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// rather than a pointer (we do the same for wide strings); otherwise 231b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// we print it as a pointer to be safe. 2327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This internal macro is used to avoid duplicated code. 2347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_FORMAT_IMPL_(operand2_type, operand1_printer)\ 2357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForComparisonFailureMessage(\ 236b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad operand2_type::value_type* GTEST_CREF_WORKAROUND_ str, \ 237b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const operand2_type& /*operand2*/) {\ 2387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return operand1_printer(str);\ 2397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}\ 2407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String FormatForComparisonFailureMessage(\ 241b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const operand2_type::value_type* GTEST_CREF_WORKAROUND_ str, \ 242b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const operand2_type& /*operand2*/) {\ 2437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return operand1_printer(str);\ 2447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 2457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::std::string, String::ShowCStringQuoted) 2477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_STD_WSTRING 2487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::std::wstring, String::ShowWideCStringQuoted) 2497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_STD_WSTRING 2507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_GLOBAL_STRING 2527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::string, String::ShowCStringQuoted) 2537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_GLOBAL_STRING 2547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#if GTEST_HAS_GLOBAL_WSTRING 2557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanGTEST_FORMAT_IMPL_(::wstring, String::ShowWideCStringQuoted) 2567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_GLOBAL_WSTRING 2577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 2587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#undef GTEST_FORMAT_IMPL_ 2597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 260b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// The next four overloads handle the case where the operand being 261b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// printed is a char/wchar_t pointer and the other operand is not a 262b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// string/wstring object. In such cases, we just print the operand as 263b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// a pointer to be safe. 264b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_FORMAT_CHAR_PTR_IMPL_(CharType) \ 265b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad template <typename T> \ 266b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad String FormatForComparisonFailureMessage(CharType* GTEST_CREF_WORKAROUND_ p, \ 267b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const T&) { \ 268b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return PrintToString(static_cast<const void*>(p)); \ 269b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 270b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 271b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadGTEST_FORMAT_CHAR_PTR_IMPL_(char) 272b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadGTEST_FORMAT_CHAR_PTR_IMPL_(const char) 273b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadGTEST_FORMAT_CHAR_PTR_IMPL_(wchar_t) 274b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadGTEST_FORMAT_CHAR_PTR_IMPL_(const wchar_t) 275b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 276b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#undef GTEST_FORMAT_CHAR_PTR_IMPL_ 277b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 2787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Constructs and returns the message for an equality assertion 2797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure. 2807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 2817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The first four parameters are the expressions used in the assertion 2827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// and their values, as strings. For example, for ASSERT_EQ(foo, bar) 2837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// where foo is 5 and bar is 6, we have: 2847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 2857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// expected_expression: "foo" 2867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// actual_expression: "bar" 2877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// expected_value: "5" 2887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// actual_value: "6" 2897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 29094c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru// The ignoring_case parameter is true iff the assertion is a 2917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// *_STRCASEEQ*. When it's true, the string " (ignoring case)" will 2927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// be inserted into the message. 29357240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ AssertionResult EqFailure(const char* expected_expression, 29457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const char* actual_expression, 29557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const String& expected_value, 29657240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const String& actual_value, 29757240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer bool ignoring_case); 29857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer 29957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// Constructs a failure message for Boolean assertions such as EXPECT_TRUE. 30057240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ String GetBoolAssertionFailureMessage( 30157240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const AssertionResult& assertion_result, 30257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const char* expression_text, 30357240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const char* actual_predicate_value, 30457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer const char* expected_predicate_value); 3057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This template class represents an IEEE floating-point number 3077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// (either single-precision or double-precision, depending on the 3087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// template parameters). 3097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The purpose of this class is to do more sophisticated number 3117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// comparison. (Due to round-off error, etc, it's very unlikely that 3127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// two floating-points will be equal exactly. Hence a naive 3137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// comparison by the == operation often doesn't work.) 3147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Format of IEEE floating-point: 3167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The most-significant bit being the leftmost, an IEEE 3187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// floating-point looks like 3197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// sign_bit exponent_bits fraction_bits 3217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Here, sign_bit is a single bit that designates the sign of the 3237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// number. 3247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// For float, there are 8 exponent bits and 23 fraction bits. 3267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// For double, there are 11 exponent bits and 52 fraction bits. 3287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// More details can be found at 3307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// http://en.wikipedia.org/wiki/IEEE_floating-point_standard. 3317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Template parameter: 3337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 3347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// RawType: the raw floating-point type (either float or double) 3357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename RawType> 3367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass FloatingPoint { 3377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 3387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Defines the unsigned integer type that has the same size as the 3397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // floating point number. 3407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename TypeWithSize<sizeof(RawType)>::UInt Bits; 3417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Constants. 3437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // # of bits in a number. 3457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kBitCount = 8*sizeof(RawType); 3467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // # of fraction bits in a number. 3487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kFractionBitCount = 3497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman std::numeric_limits<RawType>::digits - 1; 3507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // # of exponent bits in a number. 3527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kExponentBitCount = kBitCount - 1 - kFractionBitCount; 3537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The mask for the sign bit. 3557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const Bits kSignBitMask = static_cast<Bits>(1) << (kBitCount - 1); 3567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The mask for the fraction bits. 3587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const Bits kFractionBitMask = 3597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ~static_cast<Bits>(0) >> (kExponentBitCount + 1); 3607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The mask for the exponent bits. 3627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const Bits kExponentBitMask = ~(kSignBitMask | kFractionBitMask); 3637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // How many ULP's (Units in the Last Place) we want to tolerate when 3657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // comparing two numbers. The larger the value, the more error we 3667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // allow. A 0 value means that two numbers must be exactly the same 3677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // to be considered equal. 3687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The maximum error of a single floating-point operation is 0.5 3707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // units in the last place. On Intel CPU's, all floating-point 3717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // calculations are done with 80-bit precision, while double has 64 3727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // bits. Therefore, 4 should be enough for ordinary use. 3737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // See the following article for more details on ULP: 3757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm. 3767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static const size_t kMaxUlps = 4; 3777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Constructs a FloatingPoint from a raw floating-point number. 3797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // On an Intel CPU, passing a non-normalized NAN (Not a Number) 3817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // around may change its bits, although the new value is guaranteed 3827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // to be also a NAN. Therefore, don't expect this constructor to 3837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // preserve the bits in x when x is a NAN. 384190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer explicit FloatingPoint(const RawType& x) { u_.value_ = x; } 3857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Static methods 3877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Reinterprets a bit pattern as a floating-point number. 3897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 3907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // This function is needed to test the AlmostEquals() method. 3917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static RawType ReinterpretBits(const Bits bits) { 3927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman FloatingPoint fp(0); 393190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer fp.u_.bits_ = bits; 394190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return fp.u_.value_; 3957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 3967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 3977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the floating-point number that represent positive infinity. 3987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static RawType Infinity() { 3997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return ReinterpretBits(kExponentBitMask); 4007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Non-static methods 4037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the bits that represents this number. 405190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const Bits &bits() const { return u_.bits_; } 4067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the exponent bits of this number. 408190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits exponent_bits() const { return kExponentBitMask & u_.bits_; } 4097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the fraction bits of this number. 411190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits fraction_bits() const { return kFractionBitMask & u_.bits_; } 4127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Returns the sign bit of this number. 414190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits sign_bit() const { return kSignBitMask & u_.bits_; } 4157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 41694c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru // Returns true iff this is NAN (not a number). 4177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool is_nan() const { 4187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // It's a NAN if the exponent bits are all ones and the fraction 4197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // bits are not entirely zeros. 4207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return (exponent_bits() == kExponentBitMask) && (fraction_bits() != 0); 4217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 42394c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru // Returns true iff this number is at most kMaxUlps ULP's away from 4247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // rhs. In particular, this function: 4257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // - returns false if either number is (or both are) NAN. 4277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // - treats really large numbers as almost equal to infinity. 4287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // - thinks +0.0 and -0.0 are 0 DLP's apart. 4297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool AlmostEquals(const FloatingPoint& rhs) const { 4307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The IEEE standard says that any comparison operation involving 4317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // a NAN must return false. 4327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (is_nan() || rhs.is_nan()) return false; 4337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 434190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return DistanceBetweenSignAndMagnitudeNumbers(u_.bits_, rhs.u_.bits_) 435190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer <= kMaxUlps; 4367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 439190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // The data type used to store the actual floating-point number. 440190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer union FloatingPointUnion { 441190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer RawType value_; // The raw floating-point number. 442190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer Bits bits_; // The bits that represent the number. 443190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer }; 444190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 4457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Converts an integer from the sign-and-magnitude representation to 4467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // the biased representation. More precisely, let N be 2 to the 4477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // power of (kBitCount - 1), an integer x is represented by the 4487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // unsigned number x + N. 4497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // For instance, 4517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // -N + 1 (the most negative number representable using 4537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sign-and-magnitude) is represented by 1; 4547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 0 is represented by N; and 4557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // N - 1 (the biggest number representable using 4567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sign-and-magnitude) is represented by 2N - 1. 4577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 4587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Read http://en.wikipedia.org/wiki/Signed_number_representations 4597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // for more details on signed number representations. 4607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static Bits SignAndMagnitudeToBiased(const Bits &sam) { 4617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (kSignBitMask & sam) { 4627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sam represents a negative number. 4637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return ~sam + 1; 4647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else { 4657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // sam represents a positive number. 4667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return kSignBitMask | sam; 4677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Given two numbers in the sign-and-magnitude representation, 4717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // returns the distance between them as an unsigned number. 4727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static Bits DistanceBetweenSignAndMagnitudeNumbers(const Bits &sam1, 4737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Bits &sam2) { 4747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Bits biased1 = SignAndMagnitudeToBiased(sam1); 4757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const Bits biased2 = SignAndMagnitudeToBiased(sam2); 4767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return (biased1 >= biased2) ? (biased1 - biased2) : (biased2 - biased1); 4777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 4787ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 479190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer FloatingPointUnion u_; 4807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 4817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Typedefs the instances of the FloatingPoint template class that we 4837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// care to use. 4847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef FloatingPoint<float> Float; 4857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef FloatingPoint<double> Double; 4867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// In order to catch the mistake of putting tests that use different 4887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test fixture classes in the same test case, we need to assign 4897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// unique IDs to fixture classes and compare them. The TypeId type is 4907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// used to hold such IDs. The user should treat TypeId as an opaque 4917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// type: the only operation allowed on TypeId values is to compare 4927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// them for equality using the == operator. 4937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef const void* TypeId; 4947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 4957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 4967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeIdHelper { 4977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 4987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // dummy_ must not have a const type. Otherwise an overly eager 4997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // compiler (e.g. MSVC 7.1 & 8.0) may try to merge 5007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // TypeIdHelper<T>::dummy_ for different Ts as an "optimization". 5017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool dummy_; 5027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 5037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 5057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanbool TypeIdHelper<T>::dummy_ = false; 5067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// GetTypeId<T>() returns the ID of type T. Different values will be 5087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// returned for different types. Calling the function twice with the 5097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// same type argument is guaranteed to return the same ID. 5107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <typename T> 5117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha BrukmanTypeId GetTypeId() { 5127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // The compiler is required to allocate a different 5137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // TypeIdHelper<T>::dummy_ variable for each T used to instantiate 5147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // the template. Therefore, the address of dummy_ is guaranteed to 5157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // be unique. 5167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return &(TypeIdHelper<T>::dummy_); 5177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 5187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Returns the type ID of ::testing::Test. Always call this instead 5207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// of GetTypeId< ::testing::Test>() to get the type ID of 5217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ::testing::Test, as the latter may give the wrong result due to a 5227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// suspected linker bug when compiling Google Test as a Mac OS X 5237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// framework. 52457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ TypeId GetTestTypeId(); 5257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Defines the abstract factory interface that creates instances 5277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// of a Test object. 5287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestFactoryBase { 5297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 5307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual ~TestFactoryBase() {} 5317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Creates a test instance to run. The instance is both created and destroyed 5337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // within TestInfoImpl::Run() 5347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual Test* CreateTest() = 0; 5357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman protected: 5377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestFactoryBase() {} 5387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 5407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_DISALLOW_COPY_AND_ASSIGN_(TestFactoryBase); 5417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 5427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// This class provides implementation of TeastFactoryBase interface. 5447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// It is used in TEST and TEST_F macros. 5457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <class TestClass> 5467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TestFactoryImpl : public TestFactoryBase { 5477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 5487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual Test* CreateTest() { return new TestClass; } 5497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 5507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 551e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer#if GTEST_OS_WINDOWS 5527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Predicate-formatters for implementing the HRESULT checking macros 5547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED} 5557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// We pass a long instead of HRESULT to avoid causing an 5567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// include dependency for the HRESULT type. 55757240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ AssertionResult IsHRESULTSuccess(const char* expr, 55857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer long hr); // NOLINT 55957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ AssertionResult IsHRESULTFailure(const char* expr, 56057240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer long hr); // NOLINT 5617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_OS_WINDOWS 5637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Types of SetUpTestCase() and TearDownTestCase() functions. 5657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef void (*SetUpTestCaseFunc)(); 5667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantypedef void (*TearDownTestCaseFunc)(); 5677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 5687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Creates a new TestInfo object and registers it with Google Test; 5697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// returns the created object. 5707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 5717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Arguments: 5727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 5737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// test_case_name: name of the test case 5747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// name: name of the test 575b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// type_param the name of the test's type parameter, or NULL if 576b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// this is not a typed or a type-parameterized test. 577b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// value_param text representation of the test's value parameter, 578b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// or NULL if this is not a type-parameterized test. 5797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// fixture_class_id: ID of the test fixture class 5807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// set_up_tc: pointer to the function that sets up the test case 5817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// tear_down_tc: pointer to the function that tears down the test case 5827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// factory: pointer to the factory that creates a test object. 5837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The newly created TestInfo instance will assume 5847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// ownership of the factory object. 58557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ TestInfo* MakeAndRegisterTestInfo( 5867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_case_name, const char* name, 587b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const char* type_param, 588b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const char* value_param, 5897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TypeId fixture_class_id, 5907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman SetUpTestCaseFunc set_up_tc, 5917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TearDownTestCaseFunc tear_down_tc, 5927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestFactoryBase* factory); 5937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 59457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// If *pstr starts with the given prefix, modifies *pstr to be right 59557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// past the prefix and returns true; otherwise leaves *pstr unchanged 59657240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// and returns false. None of pstr, *pstr, and prefix can be NULL. 597b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadGTEST_API_ bool SkipPrefix(const char* prefix, const char** pstr); 59857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer 599e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P 6007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// State of the definition of a type-parameterized test case. 60257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramerclass GTEST_API_ TypedTestCasePState { 6037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 6047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TypedTestCasePState() : registered_(false) {} 6057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Adds the given test name to defined_test_names_ and return true 6077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // if the test case hasn't been registered; otherwise aborts the 6087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // program. 6097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool AddTestName(const char* file, int line, const char* case_name, 6107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_name) { 6117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (registered_) { 6127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman fprintf(stderr, "%s Test %s must be defined before " 6137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman "REGISTER_TYPED_TEST_CASE_P(%s, ...).\n", 6147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman FormatFileLocation(file, line).c_str(), test_name, case_name); 615e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer fflush(stderr); 616190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer posix::Abort(); 6177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman defined_test_names_.insert(test_name); 6197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return true; 6207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Verifies that registered_tests match the test names in 6237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // defined_test_names_; returns registered_tests if successful, or 6247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // aborts the program otherwise. 6257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* VerifyRegisteredTestNames( 6267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* file, int line, const char* registered_tests); 6277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private: 6297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool registered_; 6307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::std::set<const char*> defined_test_names_; 6317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 6327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Skips to the first non-space char after the first comma in 'str'; 6347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// returns NULL if no comma is found in 'str'. 6357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline const char* SkipComma(const char* str) { 6367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* comma = strchr(str, ','); 6377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (comma == NULL) { 6387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return NULL; 6397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 640b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad while (IsSpace(*(++comma))) {} 6417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return comma; 6427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 6437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Returns the prefix of 'str' before the first comma in it; returns 6457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the entire string if it contains no comma. 6467ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmaninline String GetPrefixUntilComma(const char* str) { 6477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* comma = strchr(str, ','); 6487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return comma == NULL ? String(str) : String(str, comma - str); 6497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} 6507ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6517ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// TypeParameterizedTest<Fixture, TestSel, Types>::Register() 6527ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// registers a list of type-parameterized tests with Google Test. The 6537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// return value is insignificant - we just need to return something 6547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// such that we can call this function in a namespace scope. 6557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 6567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Implementation note: The GTEST_TEMPLATE_ macro declares a template 6577ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// template parameter. It's defined in gtest-type-util.h. 6587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, class TestSel, typename Types> 6597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTest { 6607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 6617ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // 'index' is the index of the test in the type list 'Types' 6627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // specified in INSTANTIATE_TYPED_TEST_CASE_P(Prefix, TestCase, 6637ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Types). Valid values for 'index' are [0, N - 1] where N is the 6647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // length of Types. 6657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool Register(const char* prefix, const char* case_name, 6667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_names, int index) { 6677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename Types::Head Type; 6687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef Fixture<Type> FixtureClass; 6697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename GTEST_BIND_(TestSel, Type) TestClass; 6707ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6717ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // First, registers the first type-parameterized test in the type 6727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // list. 6737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman MakeAndRegisterTestInfo( 6747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman String::Format("%s%s%s/%d", prefix, prefix[0] == '\0' ? "" : "/", 6757ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman case_name, index).c_str(), 6767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GetPrefixUntilComma(test_names).c_str(), 677b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad GetTypeName<Type>().c_str(), 678b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad NULL, // No value parameter. 6797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GetTypeId<FixtureClass>(), 6807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestClass::SetUpTestCase, 6817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TestClass::TearDownTestCase, 6827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman new TestFactoryImpl<TestClass>); 6837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Next, recurses (at compile time) with the tail of the type list. 6857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return TypeParameterizedTest<Fixture, TestSel, typename Types::Tail> 6867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::Register(prefix, case_name, test_names, index + 1); 6877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6887ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 6897ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 6907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The base case for the compile time recursion. 6917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, class TestSel> 6927ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTest<Fixture, TestSel, Types0> { 6937ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 6947ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool Register(const char* /*prefix*/, const char* /*case_name*/, 6957ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* /*test_names*/, int /*index*/) { 6967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return true; 6977ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 6987ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 6997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// TypeParameterizedTestCase<Fixture, Tests, Types>::Register() 7017ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// registers *all combinations* of 'Tests' and 'Types' with Google 7027ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Test. The return value is insignificant - we just need to return 7037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// something such that we can call this function in a namespace scope. 7047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, typename Tests, typename Types> 7057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTestCase { 7067ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 7077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman static bool Register(const char* prefix, const char* case_name, 7087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman const char* test_names) { 7097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman typedef typename Tests::Head Head; 7107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // First, register the first test in 'Test' for each type in 'Types'. 7127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman TypeParameterizedTest<Fixture, Head, Types>::Register( 7137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman prefix, case_name, test_names, 0); 7147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7157ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman // Next, recurses (at compile time) with the tail of the test list. 7167ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return TypeParameterizedTestCase<Fixture, typename Tests::Tail, Types> 7177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::Register(prefix, case_name, SkipComma(test_names)); 7187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 7197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 7207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The base case for the compile time recursion. 7227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmantemplate <GTEST_TEMPLATE_ Fixture, typename Types> 7237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass TypeParameterizedTestCase<Fixture, Templates0, Types> { 7247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public: 725190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer static bool Register(const char* /*prefix*/, const char* /*case_name*/, 726190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer const char* /*test_names*/) { 7277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman return true; 7287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } 7297ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman}; 7307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P 7327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 7337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Returns the current OS stack trace as a String. 7347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 7357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// The maximum number of stack frames to be included is specified by 7367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the gtest_stack_trace_depth flag. The skip_count parameter 7377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// specifies the number of top frames to be skipped, which doesn't 7387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// count against the number of frames to be included. 7397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// 7407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// For example, if Foo() calls Bar(), which in turn calls 7417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in 7427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't. 74357240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ String GetCurrentOsStackTraceExceptTop(UnitTest* unit_test, 74457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer int skip_count); 7457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 746190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Helpers for suppressing warnings on unreachable code or constant 747190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// condition. 7487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 749190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Always returns true. 75057240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin KramerGTEST_API_ bool AlwaysTrue(); 751e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer 752190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// Always returns false. 753190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramerinline bool AlwaysFalse() { return !AlwaysTrue(); } 754190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 755b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Helper for suppressing false warning from Clang on a const char* 756b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// variable declared in a conditional expression always being NULL in 757b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// the else branch. 758b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct GTEST_API_ ConstCharPtr { 759b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad ConstCharPtr(const char* str) : value(str) {} 760b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad operator bool() const { return true; } 761b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const char* value; 762b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 763b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 764190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// A simple Linear Congruential Generator for generating random 765190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// numbers with a uniform distribution. Unlike rand() and srand(), it 766190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// doesn't use global state (and therefore can't interfere with user 767190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// code). Unlike rand_r(), it's portable. An LCG isn't very random, 768190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer// but it's good enough for our purposes. 76957240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramerclass GTEST_API_ Random { 770190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer public: 771190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer static const UInt32 kMaxRange = 1u << 31; 772190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 773190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer explicit Random(UInt32 seed) : state_(seed) {} 774190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 775190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer void Reseed(UInt32 seed) { state_ = seed; } 776190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 777190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // Generates a random number from [0, range). Crashes if 'range' is 778190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer // 0 or greater than kMaxRange. 779190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer UInt32 Generate(UInt32 range); 780190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 781190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer private: 782190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer UInt32 state_; 783190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_DISALLOW_COPY_AND_ASSIGN_(Random); 784190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer}; 785190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer 786b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Defining a variable of type CompileAssertTypesEqual<T1, T2> will cause a 78794c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru// compiler error iff T1 and T2 are different types. 788b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T1, typename T2> 789b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct CompileAssertTypesEqual; 790b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 791b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 792b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct CompileAssertTypesEqual<T, T> { 793b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 794b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 795b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Removes the reference from a type if it is a reference type, 796b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// otherwise leaves it unchanged. This is the same as 797b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// tr1::remove_reference, which is not widely available yet. 798b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 799b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct RemoveReference { typedef T type; }; // NOLINT 800b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 801b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct RemoveReference<T&> { typedef T type; }; // NOLINT 802b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 803b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// A handy wrapper around RemoveReference that works when the argument 804b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// T depends on template parameters. 805b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_REMOVE_REFERENCE_(T) \ 806b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typename ::testing::internal::RemoveReference<T>::type 807b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 808b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Removes const from a type if it is a const type, otherwise leaves 809b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// it unchanged. This is the same as tr1::remove_const, which is not 810b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// widely available yet. 811b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 812b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct RemoveConst { typedef T type; }; // NOLINT 813b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 814b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct RemoveConst<const T> { typedef T type; }; // NOLINT 815b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 816b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// MSVC 8.0, Sun C++, and IBM XL C++ have a bug which causes the above 817b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// definition to fail to remove the const in 'const int[3]' and 'const 818b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// char[3][4]'. The following specialization works around the bug. 819b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// However, it causes trouble with GCC and thus needs to be 820b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// conditionally compiled. 821b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#if defined(_MSC_VER) || defined(__SUNPRO_CC) || defined(__IBMCPP__) 822b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, size_t N> 823b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct RemoveConst<const T[N]> { 824b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typedef typename RemoveConst<T>::type type[N]; 825b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 826b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#endif 827b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 828b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// A handy wrapper around RemoveConst that works when the argument 829b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// T depends on template parameters. 830b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_REMOVE_CONST_(T) \ 831b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typename ::testing::internal::RemoveConst<T>::type 832b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 833b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Turns const U&, U&, const U, and U all into U. 834b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_REMOVE_REFERENCE_AND_CONST_(T) \ 835b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad GTEST_REMOVE_CONST_(GTEST_REMOVE_REFERENCE_(T)) 836b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 837b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Adds reference to a type if it is not a reference type, 838b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// otherwise leaves it unchanged. This is the same as 839b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// tr1::add_reference, which is not widely available yet. 840b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 841b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct AddReference { typedef T& type; }; // NOLINT 842b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 843b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct AddReference<T&> { typedef T& type; }; // NOLINT 844b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 845b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// A handy wrapper around AddReference that works when the argument T 846b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// depends on template parameters. 847b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_ADD_REFERENCE_(T) \ 848b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typename ::testing::internal::AddReference<T>::type 849b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 850b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Adds a reference to const on top of T as necessary. For example, 851b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// it transforms 852b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// 853b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// char ==> const char& 854b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// const char ==> const char& 855b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// char& ==> const char& 856b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// const char& ==> const char& 857b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// 858b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// The argument T must depend on some template parameters. 859b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_REFERENCE_TO_CONST_(T) \ 860b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad GTEST_ADD_REFERENCE_(const GTEST_REMOVE_REFERENCE_(T)) 861b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 862b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// ImplicitlyConvertible<From, To>::value is a compile-time bool 86394c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru// constant that's true iff type From can be implicitly converted to 864b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// type To. 865b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename From, typename To> 866b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadclass ImplicitlyConvertible { 867b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad private: 868b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // We need the following helper functions only for their types. 869b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // They have no implementations. 870b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 871b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // MakeFrom() is an expression whose type is From. We cannot simply 872b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // use From(), as the type From may not have a public default 873b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // constructor. 874b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static From MakeFrom(); 875b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 876b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // These two functions are overloaded. Given an expression 877b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // Helper(x), the compiler will pick the first version if x can be 878b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // implicitly converted to type To; otherwise it will pick the 879b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // second version. 880b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // 881b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // The first version returns a value of size 1, and the second 882b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // version returns a value of size 2. Therefore, by checking the 883b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // size of Helper(x), which can be done at compile time, we can tell 884b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // which version of Helper() is used, and hence whether x can be 885b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // implicitly converted to type To. 886b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static char Helper(To); 887b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static char (&Helper(...))[2]; // NOLINT 888b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 889b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // We have to put the 'public' section after the 'private' section, 890b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // or MSVC refuses to compile the code. 891b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad public: 892b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // MSVC warns about implicitly converting from double to int for 893b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // possible loss of data, so we need to temporarily disable the 894b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // warning. 895b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#ifdef _MSC_VER 896b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# pragma warning(push) // Saves the current warning state. 897b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# pragma warning(disable:4244) // Temporarily disables warning 4244. 898b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 899b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static const bool value = 900b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad sizeof(Helper(ImplicitlyConvertible::MakeFrom())) == 1; 901b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad# pragma warning(pop) // Restores the warning state. 902b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#elif defined(__BORLANDC__) 903b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // C++Builder cannot use member overload resolution during template 904b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // instantiation. The simplest workaround is to use its C++0x type traits 905b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // functions (C++Builder 2009 and above only). 906b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static const bool value = __is_convertible(From, To); 907b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#else 908b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static const bool value = 909b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad sizeof(Helper(ImplicitlyConvertible::MakeFrom())) == 1; 910b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#endif // _MSV_VER 911b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 912b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename From, typename To> 913b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadconst bool ImplicitlyConvertible<From, To>::value; 914b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 915b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// IsAProtocolMessage<T>::value is a compile-time bool constant that's 91694c22716d60ff5edf6a98a3c67e0faa001be1142Sylvestre Ledru// true iff T is type ProtocolMessage, proto2::Message, or a subclass 917b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// of those. 918b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T> 919b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadstruct IsAProtocolMessage 920b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad : public bool_constant< 921b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad ImplicitlyConvertible<const T*, const ::ProtocolMessage*>::value || 922b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad ImplicitlyConvertible<const T*, const ::proto2::Message*>::value> { 923b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 924b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 925b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// When the compiler sees expression IsContainerTest<C>(0), if C is an 926b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// STL-style container class, the first overload of IsContainerTest 927b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// will be viable (since both C::iterator* and C::const_iterator* are 928b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// valid types and NULL can be implicitly converted to them). It will 929b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// be picked over the second overload as 'int' is a perfect match for 930b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// the type of argument 0. If C::iterator or C::const_iterator is not 931b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// a valid type, the first overload is not viable, and the second 932b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// overload will be picked. Therefore, we can determine whether C is 933b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// a container class by checking the type of IsContainerTest<C>(0). 934b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// The value of the expression is insignificant. 935b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// 936b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Note that we look for both C::iterator and C::const_iterator. The 937b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// reason is that C++ injects the name of a class as a member of the 938b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// class itself (e.g. you can refer to class iterator as either 939b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// 'iterator' or 'iterator::iterator'). If we look for C::iterator 940b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// only, for example, we would mistakenly think that a class named 941b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// iterator is an STL container. 942b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// 943b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Also note that the simpler approach of overloading 944b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// IsContainerTest(typename C::const_iterator*) and 945b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// IsContainerTest(...) doesn't work with Visual Age C++ and Sun C++. 946b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtypedef int IsContainer; 947b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <class C> 948b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadIsContainer IsContainerTest(int /* dummy */, 949b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typename C::iterator* /* it */ = NULL, 950b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typename C::const_iterator* /* const_it */ = NULL) { 951b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return 0; 952b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad} 953b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 954b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtypedef char IsNotContainer; 955b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <class C> 956b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadIsNotContainer IsContainerTest(long /* dummy */) { return '\0'; } 957b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 958b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// EnableIf<condition>::type is void when 'Cond' is true, and 959b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// undefined when 'Cond' is false. To use SFINAE to make a function 960b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// overload only apply when a particular expression is true, add 961b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// "typename EnableIf<expression>::type* = 0" as the last parameter. 962b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate<bool> struct EnableIf; 963b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate<> struct EnableIf<true> { typedef void type; }; // NOLINT 964b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 965b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Utilities for native arrays. 966b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 967b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// ArrayEq() compares two k-dimensional native arrays using the 968b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// elements' operator==, where k can be any integer >= 0. When k is 969b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// 0, ArrayEq() degenerates into comparing a single pair of values. 970b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 971b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U> 972b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadbool ArrayEq(const T* lhs, size_t size, const U* rhs); 973b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 974b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// This generic version is used when k is 0. 975b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U> 976b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadinline bool ArrayEq(const T& lhs, const U& rhs) { return lhs == rhs; } 977b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 978b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// This overload is used when k >= 1. 979b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U, size_t N> 980b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadinline bool ArrayEq(const T(&lhs)[N], const U(&rhs)[N]) { 981b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return internal::ArrayEq(lhs, N, rhs); 982b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad} 983b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 984b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// This helper reduces code bloat. If we instead put its logic inside 985b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// the previous ArrayEq() function, arrays with different sizes would 986b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// lead to different copies of the template code. 987b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U> 988b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadbool ArrayEq(const T* lhs, size_t size, const U* rhs) { 989b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad for (size_t i = 0; i != size; i++) { 990b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (!internal::ArrayEq(lhs[i], rhs[i])) 991b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return false; 992b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 993b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return true; 994b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad} 995b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 996b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Finds the first element in the iterator range [begin, end) that 997b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// equals elem. Element may be a native array type itself. 998b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename Iter, typename Element> 999b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay FoadIter ArrayAwareFind(Iter begin, Iter end, const Element& elem) { 1000b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad for (Iter it = begin; it != end; ++it) { 1001b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (internal::ArrayEq(*it, elem)) 1002b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return it; 1003b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1004b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return end; 1005b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad} 1006b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1007b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// CopyArray() copies a k-dimensional native array using the elements' 1008b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// operator=, where k can be any integer >= 0. When k is 0, 1009b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// CopyArray() degenerates into copying a single value. 1010b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1011b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U> 1012b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadvoid CopyArray(const T* from, size_t size, U* to); 1013b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1014b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// This generic version is used when k is 0. 1015b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U> 1016b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadinline void CopyArray(const T& from, U* to) { *to = from; } 1017b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1018b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// This overload is used when k >= 1. 1019b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U, size_t N> 1020b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadinline void CopyArray(const T(&from)[N], U(*to)[N]) { 1021b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad internal::CopyArray(from, N, *to); 1022b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad} 1023b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1024b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// This helper reduces code bloat. If we instead put its logic inside 1025b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// the previous CopyArray() function, arrays with different sizes 1026b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// would lead to different copies of the template code. 1027b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename T, typename U> 1028b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadvoid CopyArray(const T* from, size_t size, U* to) { 1029b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad for (size_t i = 0; i != size; i++) { 1030b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad internal::CopyArray(from[i], to + i); 1031b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1032b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad} 1033b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1034b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// The relation between an NativeArray object (see below) and the 1035b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// native array it represents. 1036b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadenum RelationToSource { 1037b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad kReference, // The NativeArray references the native array. 1038b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad kCopy // The NativeArray makes a copy of the native array and 1039b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // owns the copy. 1040b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 1041b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1042b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// Adapts a native array to a read-only STL-style container. Instead 1043b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// of the complete STL container concept, this adaptor only implements 1044b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// members useful for Google Mock's container matchers. New members 1045b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// should be added as needed. To simplify the implementation, we only 1046b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// support Element being a raw type (i.e. having no top-level const or 1047b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// reference modifier). It's the client's responsibility to satisfy 1048b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// this requirement. Element can be an array type itself (hence 1049b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad// multi-dimensional arrays are supported). 1050b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadtemplate <typename Element> 1051b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foadclass NativeArray { 1052b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad public: 1053b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // STL-style container typedefs. 1054b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typedef Element value_type; 1055b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typedef Element* iterator; 1056b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad typedef const Element* const_iterator; 1057b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1058b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // Constructs from a native array. 1059b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad NativeArray(const Element* array, size_t count, RelationToSource relation) { 1060b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad Init(array, count, relation); 1061b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1062b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1063b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // Copy constructor. 1064b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad NativeArray(const NativeArray& rhs) { 1065b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad Init(rhs.array_, rhs.size_, rhs.relation_to_source_); 1066b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1067b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1068b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad ~NativeArray() { 1069b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // Ensures that the user doesn't instantiate NativeArray with a 1070b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // const or reference type. 1071b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static_cast<void>(StaticAssertTypeEqHelper<Element, 1072b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad GTEST_REMOVE_REFERENCE_AND_CONST_(Element)>()); 1073b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (relation_to_source_ == kCopy) 1074b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad delete[] array_; 1075b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1076b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1077b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // STL-style container methods. 1078b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad size_t size() const { return size_; } 1079b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const_iterator begin() const { return array_; } 1080b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const_iterator end() const { return array_ + size_; } 1081b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad bool operator==(const NativeArray& rhs) const { 1082b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad return size() == rhs.size() && 1083b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad ArrayEq(begin(), size(), rhs.begin()); 1084b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1085b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1086b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad private: 1087b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // Initializes this object; makes a copy of the input array if 1088b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad // 'relation' is kCopy. 1089b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad void Init(const Element* array, size_t a_size, RelationToSource relation) { 1090b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (relation == kReference) { 1091b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad array_ = array; 1092b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } else { 1093b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad Element* const copy = new Element[a_size]; 1094b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad CopyArray(array, a_size, copy); 1095b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad array_ = copy; 1096b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1097b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad size_ = a_size; 1098b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad relation_to_source_ = relation; 1099b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad } 1100b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1101b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad const Element* array_; 1102b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad size_t size_; 1103b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad RelationToSource relation_to_source_; 1104b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 1105b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad GTEST_DISALLOW_ASSIGN_(NativeArray); 1106b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad}; 1107b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 11087ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} // namespace internal 11097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman} // namespace testing 11107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1111b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_MESSAGE_AT_(file, line, message, result_type) \ 1112b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad ::testing::internal::AssertHelper(result_type, file, line, message) \ 11137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman = ::testing::Message() 11147ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1115b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad#define GTEST_MESSAGE_(message, result_type) \ 1116b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad GTEST_MESSAGE_AT_(__FILE__, __LINE__, message, result_type) 1117b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad 11187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_FATAL_FAILURE_(message) \ 1119190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer return GTEST_MESSAGE_(message, ::testing::TestPartResult::kFatalFailure) 11207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 11217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_NONFATAL_FAILURE_(message) \ 1122190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_MESSAGE_(message, ::testing::TestPartResult::kNonFatalFailure) 11237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 11247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_SUCCESS_(message) \ 1125190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_MESSAGE_(message, ::testing::TestPartResult::kSuccess) 11267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 1127e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// Suppresses MSVC warnings 4072 (unreachable code) for the code following 1128e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// statement if it returns or throws (or doesn't return or throw in some 1129e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer// situations). 1130190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer#define GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement) \ 1131e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer if (::testing::internal::AlwaysTrue()) { statement; } 1132e4b9c93fc1b531fe0cfe25a042f6b81c1e7c15c0Benjamin Kramer 11337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_THROW_(statement, expected_exception, fail) \ 11347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 1135b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (::testing::internal::ConstCharPtr gtest_msg = "") { \ 11367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool gtest_caught_expected = false; \ 11377ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman try { \ 1138190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 11397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (expected_exception const&) { \ 11417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_caught_expected = true; \ 11427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (...) { \ 1144b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad gtest_msg.value = \ 1145b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad "Expected: " #statement " throws an exception of type " \ 1146b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad #expected_exception ".\n Actual: it throws a different type."; \ 11477ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ 11487ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11497ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (!gtest_caught_expected) { \ 1150b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad gtest_msg.value = \ 1151b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad "Expected: " #statement " throws an exception of type " \ 1152b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad #expected_exception ".\n Actual: it throws nothing."; \ 11537ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ 11547ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11557ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 11567ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__): \ 1157b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad fail(gtest_msg.value) 11587ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 11597ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_NO_THROW_(statement, fail) \ 11607ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 1161b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (::testing::internal::AlwaysTrue()) { \ 11627ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman try { \ 1163190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 11647ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11657ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (...) { \ 11667ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__); \ 11677ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11687ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 11697ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__): \ 1170b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad fail("Expected: " #statement " doesn't throw an exception.\n" \ 1171b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad " Actual: it throws.") 11727ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 11737ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_ANY_THROW_(statement, fail) \ 11747ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 1175b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (::testing::internal::AlwaysTrue()) { \ 11767ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman bool gtest_caught_any = false; \ 11777ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman try { \ 1178190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 11797ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11807ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman catch (...) { \ 11817ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman gtest_caught_any = true; \ 11827ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11837ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (!gtest_caught_any) { \ 11847ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__); \ 11857ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 11867ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 11877ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__): \ 1188b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad fail("Expected: " #statement " throws an exception.\n" \ 1189b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad " Actual: it doesn't.") 11907ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 11917ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 119257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// Implements Boolean test assertions such as EXPECT_TRUE. expression can be 119357240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// either a boolean expression or an AssertionResult. text is a textual 119457240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer// represenation of expression as it was passed into the EXPECT_TRUE. 119557240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer#define GTEST_TEST_BOOLEAN_(expression, text, actual, expected, fail) \ 11967ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 119757240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer if (const ::testing::AssertionResult gtest_ar_ = \ 119857240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer ::testing::AssertionResult(expression)) \ 11997ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ; \ 12007ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman else \ 120157240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer fail(::testing::internal::GetBoolAssertionFailureMessage(\ 120257240ff6e2252f8986f6e47e4010bc52fbae25d1Benjamin Kramer gtest_ar_, text, #actual, #expected).c_str()) 12037ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 12047ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_NO_FATAL_FAILURE_(statement, fail) \ 12057ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 1206b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad if (::testing::internal::AlwaysTrue()) { \ 12077ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker; \ 1208190f8ee25a6977ac6eb71b816498df42f17ad9a7Benjamin Kramer GTEST_SUPPRESS_UNREACHABLE_CODE_WARNING_BELOW_(statement); \ 12097ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman if (gtest_fatal_failure_checker.has_new_fatal_failure()) { \ 12107ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman goto GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__); \ 12117ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } \ 12127ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman } else \ 12137ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__): \ 1214b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad fail("Expected: " #statement " doesn't generate new fatal " \ 1215b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad "failures in the current thread.\n" \ 1216b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad " Actual: it does.") 12177ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 12187ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Expands to the name of the class that implements the given test. 12197ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \ 12207ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman test_case_name##_##test_name##_Test 12217ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 12227ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman// Helper macro for defining tests. 12237ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#define GTEST_TEST_(test_case_name, test_name, parent_class, parent_id)\ 12247ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanclass GTEST_TEST_CLASS_NAME_(test_case_name, test_name) : public parent_class {\ 12257ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman public:\ 12267ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\ 12277ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman private:\ 12287ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman virtual void TestBody();\ 1229b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad static ::testing::TestInfo* const test_info_ GTEST_ATTRIBUTE_UNUSED_;\ 12307ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_DISALLOW_COPY_AND_ASSIGN_(\ 12317ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\ 12327ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman};\ 12337ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman\ 12347ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman::testing::TestInfo* const GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\ 12357ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::test_info_ =\ 12367ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman ::testing::internal::MakeAndRegisterTestInfo(\ 1237b33f8e3e55932d0e15a686ef0c598da8dbc37acdJay Foad #test_case_name, #test_name, NULL, NULL, \ 12387ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman (parent_id), \ 12397ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman parent_class::SetUpTestCase, \ 12407ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman parent_class::TearDownTestCase, \ 12417ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman new ::testing::internal::TestFactoryImpl<\ 12427ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>);\ 12437ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukmanvoid GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody() 12447ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman 12457ae6ff442a26212a0cc4c1929b8b0a105dc988e4Misha Brukman#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 1246