gtest-internal.h revision fbaaef999ba563838ebd00874ed8a1c01fbf286d
1// Copyright 2005, Google Inc. 2// All rights reserved. 3// 4// Redistribution and use in source and binary forms, with or without 5// modification, are permitted provided that the following conditions are 6// met: 7// 8// * Redistributions of source code must retain the above copyright 9// notice, this list of conditions and the following disclaimer. 10// * Redistributions in binary form must reproduce the above 11// copyright notice, this list of conditions and the following disclaimer 12// in the documentation and/or other materials provided with the 13// distribution. 14// * Neither the name of Google Inc. nor the names of its 15// contributors may be used to endorse or promote products derived from 16// this software without specific prior written permission. 17// 18// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29// 30// Authors: wan@google.com (Zhanyong Wan), eefacm@gmail.com (Sean Mcafee) 31// 32// The Google C++ Testing Framework (Google Test) 33// 34// This header file declares functions and macros used internally by 35// Google Test. They are subject to change without notice. 36 37#ifndef GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 38#define GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 39 40#include <gtest/internal/gtest-port.h> 41 42#if GTEST_OS_LINUX 43#include <stdlib.h> 44#include <sys/types.h> 45#include <sys/wait.h> 46#include <unistd.h> 47#endif // GTEST_OS_LINUX 48 49#include <ctype.h> 50#include <string.h> 51#include <iomanip> 52#include <limits> 53#include <set> 54 55#include <gtest/internal/gtest-string.h> 56#include <gtest/internal/gtest-filepath.h> 57#include <gtest/internal/gtest-type-util.h> 58 59// Due to C++ preprocessor weirdness, we need double indirection to 60// concatenate two tokens when one of them is __LINE__. Writing 61// 62// foo ## __LINE__ 63// 64// will result in the token foo__LINE__, instead of foo followed by 65// the current line number. For more details, see 66// http://www.parashift.com/c++-faq-lite/misc-technical-issues.html#faq-39.6 67#define GTEST_CONCAT_TOKEN_(foo, bar) GTEST_CONCAT_TOKEN_IMPL_(foo, bar) 68#define GTEST_CONCAT_TOKEN_IMPL_(foo, bar) foo ## bar 69 70// Google Test defines the testing::Message class to allow construction of 71// test messages via the << operator. The idea is that anything 72// streamable to std::ostream can be streamed to a testing::Message. 73// This allows a user to use his own types in Google Test assertions by 74// overloading the << operator. 75// 76// util/gtl/stl_logging-inl.h overloads << for STL containers. These 77// overloads cannot be defined in the std namespace, as that will be 78// undefined behavior. Therefore, they are defined in the global 79// namespace instead. 80// 81// C++'s symbol lookup rule (i.e. Koenig lookup) says that these 82// overloads are visible in either the std namespace or the global 83// namespace, but not other namespaces, including the testing 84// namespace which Google Test's Message class is in. 85// 86// To allow STL containers (and other types that has a << operator 87// defined in the global namespace) to be used in Google Test assertions, 88// testing::Message must access the custom << operator from the global 89// namespace. Hence this helper function. 90// 91// Note: Jeffrey Yasskin suggested an alternative fix by "using 92// ::operator<<;" in the definition of Message's operator<<. That fix 93// doesn't require a helper function, but unfortunately doesn't 94// compile with MSVC. 95template <typename T> 96inline void GTestStreamToHelper(std::ostream* os, const T& val) { 97 *os << val; 98} 99 100namespace testing { 101 102// Forward declaration of classes. 103 104class AssertionResult; // Result of an assertion. 105class Message; // Represents a failure message. 106class Test; // Represents a test. 107class TestInfo; // Information about a test. 108class TestPartResult; // Result of a test part. 109class UnitTest; // A collection of test cases. 110class UnitTestEventListenerInterface; // Listens to Google Test events. 111 112namespace internal { 113 114struct TraceInfo; // Information about a trace point. 115class ScopedTrace; // Implements scoped trace. 116class TestInfoImpl; // Opaque implementation of TestInfo 117class UnitTestImpl; // Opaque implementation of UnitTest 118template <typename E> class Vector; // A generic vector. 119 120// How many times InitGoogleTest() has been called. 121extern int g_init_gtest_count; 122 123// The text used in failure messages to indicate the start of the 124// stack trace. 125extern const char kStackTraceMarker[]; 126 127// A secret type that Google Test users don't know about. It has no 128// definition on purpose. Therefore it's impossible to create a 129// Secret object, which is what we want. 130class Secret; 131 132// Two overloaded helpers for checking at compile time whether an 133// expression is a null pointer literal (i.e. NULL or any 0-valued 134// compile-time integral constant). Their return values have 135// different sizes, so we can use sizeof() to test which version is 136// picked by the compiler. These helpers have no implementations, as 137// we only need their signatures. 138// 139// Given IsNullLiteralHelper(x), the compiler will pick the first 140// version if x can be implicitly converted to Secret*, and pick the 141// second version otherwise. Since Secret is a secret and incomplete 142// type, the only expression a user can write that has type Secret* is 143// a null pointer literal. Therefore, we know that x is a null 144// pointer literal if and only if the first version is picked by the 145// compiler. 146char IsNullLiteralHelper(Secret* p); 147char (&IsNullLiteralHelper(...))[2]; // NOLINT 148 149// A compile-time bool constant that is true if and only if x is a 150// null pointer literal (i.e. NULL or any 0-valued compile-time 151// integral constant). 152#ifdef GTEST_ELLIPSIS_NEEDS_COPY_ 153// Passing non-POD classes through ellipsis (...) crashes the ARM 154// compiler. The Nokia Symbian and the IBM XL C/C++ compiler try to 155// instantiate a copy constructor for objects passed through ellipsis 156// (...), failing for uncopyable objects. Hence we define this to 157// false (and lose support for NULL detection). 158#define GTEST_IS_NULL_LITERAL_(x) false 159#else 160#define GTEST_IS_NULL_LITERAL_(x) \ 161 (sizeof(::testing::internal::IsNullLiteralHelper(x)) == 1) 162#endif // GTEST_ELLIPSIS_NEEDS_COPY_ 163 164// Appends the user-supplied message to the Google-Test-generated message. 165String AppendUserMessage(const String& gtest_msg, 166 const Message& user_msg); 167 168// A helper class for creating scoped traces in user programs. 169class ScopedTrace { 170 public: 171 // The c'tor pushes the given source file location and message onto 172 // a trace stack maintained by Google Test. 173 ScopedTrace(const char* file, int line, const Message& message); 174 175 // The d'tor pops the info pushed by the c'tor. 176 // 177 // Note that the d'tor is not virtual in order to be efficient. 178 // Don't inherit from ScopedTrace! 179 ~ScopedTrace(); 180 181 private: 182 GTEST_DISALLOW_COPY_AND_ASSIGN_(ScopedTrace); 183} GTEST_ATTRIBUTE_UNUSED_; // A ScopedTrace object does its job in its 184 // c'tor and d'tor. Therefore it doesn't 185 // need to be used otherwise. 186 187// Converts a streamable value to a String. A NULL pointer is 188// converted to "(null)". When the input value is a ::string, 189// ::std::string, ::wstring, or ::std::wstring object, each NUL 190// character in it is replaced with "\\0". 191// Declared here but defined in gtest.h, so that it has access 192// to the definition of the Message class, required by the ARM 193// compiler. 194template <typename T> 195String StreamableToString(const T& streamable); 196 197// Formats a value to be used in a failure message. 198 199#ifdef GTEST_NEEDS_IS_POINTER_ 200 201// These are needed as the Nokia Symbian and IBM XL C/C++ compilers 202// cannot decide between const T& and const T* in a function template. 203// These compilers _can_ decide between class template specializations 204// for T and T*, so a tr1::type_traits-like is_pointer works, and we 205// can overload on that. 206 207// This overload makes sure that all pointers (including 208// those to char or wchar_t) are printed as raw pointers. 209template <typename T> 210inline String FormatValueForFailureMessage(internal::true_type /*dummy*/, 211 T* pointer) { 212 return StreamableToString(static_cast<const void*>(pointer)); 213} 214 215template <typename T> 216inline String FormatValueForFailureMessage(internal::false_type /*dummy*/, 217 const T& value) { 218 return StreamableToString(value); 219} 220 221template <typename T> 222inline String FormatForFailureMessage(const T& value) { 223 return FormatValueForFailureMessage( 224 typename internal::is_pointer<T>::type(), value); 225} 226 227#else 228 229// These are needed as the above solution using is_pointer has the 230// limitation that T cannot be a type without external linkage, when 231// compiled using MSVC. 232 233template <typename T> 234inline String FormatForFailureMessage(const T& value) { 235 return StreamableToString(value); 236} 237 238// This overload makes sure that all pointers (including 239// those to char or wchar_t) are printed as raw pointers. 240template <typename T> 241inline String FormatForFailureMessage(T* pointer) { 242 return StreamableToString(static_cast<const void*>(pointer)); 243} 244 245#endif // GTEST_NEEDS_IS_POINTER_ 246 247// These overloaded versions handle narrow and wide characters. 248String FormatForFailureMessage(char ch); 249String FormatForFailureMessage(wchar_t wchar); 250 251// When this operand is a const char* or char*, and the other operand 252// is a ::std::string or ::string, we print this operand as a C string 253// rather than a pointer. We do the same for wide strings. 254 255// This internal macro is used to avoid duplicated code. 256#define GTEST_FORMAT_IMPL_(operand2_type, operand1_printer)\ 257inline String FormatForComparisonFailureMessage(\ 258 operand2_type::value_type* str, const operand2_type& /*operand2*/) {\ 259 return operand1_printer(str);\ 260}\ 261inline String FormatForComparisonFailureMessage(\ 262 const operand2_type::value_type* str, const operand2_type& /*operand2*/) {\ 263 return operand1_printer(str);\ 264} 265 266#if GTEST_HAS_STD_STRING 267GTEST_FORMAT_IMPL_(::std::string, String::ShowCStringQuoted) 268#endif // GTEST_HAS_STD_STRING 269#if GTEST_HAS_STD_WSTRING 270GTEST_FORMAT_IMPL_(::std::wstring, String::ShowWideCStringQuoted) 271#endif // GTEST_HAS_STD_WSTRING 272 273#if GTEST_HAS_GLOBAL_STRING 274GTEST_FORMAT_IMPL_(::string, String::ShowCStringQuoted) 275#endif // GTEST_HAS_GLOBAL_STRING 276#if GTEST_HAS_GLOBAL_WSTRING 277GTEST_FORMAT_IMPL_(::wstring, String::ShowWideCStringQuoted) 278#endif // GTEST_HAS_GLOBAL_WSTRING 279 280#undef GTEST_FORMAT_IMPL_ 281 282// Constructs and returns the message for an equality assertion 283// (e.g. ASSERT_EQ, EXPECT_STREQ, etc) failure. 284// 285// The first four parameters are the expressions used in the assertion 286// and their values, as strings. For example, for ASSERT_EQ(foo, bar) 287// where foo is 5 and bar is 6, we have: 288// 289// expected_expression: "foo" 290// actual_expression: "bar" 291// expected_value: "5" 292// actual_value: "6" 293// 294// The ignoring_case parameter is true iff the assertion is a 295// *_STRCASEEQ*. When it's true, the string " (ignoring case)" will 296// be inserted into the message. 297AssertionResult EqFailure(const char* expected_expression, 298 const char* actual_expression, 299 const String& expected_value, 300 const String& actual_value, 301 bool ignoring_case); 302 303 304// This template class represents an IEEE floating-point number 305// (either single-precision or double-precision, depending on the 306// template parameters). 307// 308// The purpose of this class is to do more sophisticated number 309// comparison. (Due to round-off error, etc, it's very unlikely that 310// two floating-points will be equal exactly. Hence a naive 311// comparison by the == operation often doesn't work.) 312// 313// Format of IEEE floating-point: 314// 315// The most-significant bit being the leftmost, an IEEE 316// floating-point looks like 317// 318// sign_bit exponent_bits fraction_bits 319// 320// Here, sign_bit is a single bit that designates the sign of the 321// number. 322// 323// For float, there are 8 exponent bits and 23 fraction bits. 324// 325// For double, there are 11 exponent bits and 52 fraction bits. 326// 327// More details can be found at 328// http://en.wikipedia.org/wiki/IEEE_floating-point_standard. 329// 330// Template parameter: 331// 332// RawType: the raw floating-point type (either float or double) 333template <typename RawType> 334class FloatingPoint { 335 public: 336 // Defines the unsigned integer type that has the same size as the 337 // floating point number. 338 typedef typename TypeWithSize<sizeof(RawType)>::UInt Bits; 339 340 // Constants. 341 342 // # of bits in a number. 343 static const size_t kBitCount = 8*sizeof(RawType); 344 345 // # of fraction bits in a number. 346 static const size_t kFractionBitCount = 347 std::numeric_limits<RawType>::digits - 1; 348 349 // # of exponent bits in a number. 350 static const size_t kExponentBitCount = kBitCount - 1 - kFractionBitCount; 351 352 // The mask for the sign bit. 353 static const Bits kSignBitMask = static_cast<Bits>(1) << (kBitCount - 1); 354 355 // The mask for the fraction bits. 356 static const Bits kFractionBitMask = 357 ~static_cast<Bits>(0) >> (kExponentBitCount + 1); 358 359 // The mask for the exponent bits. 360 static const Bits kExponentBitMask = ~(kSignBitMask | kFractionBitMask); 361 362 // How many ULP's (Units in the Last Place) we want to tolerate when 363 // comparing two numbers. The larger the value, the more error we 364 // allow. A 0 value means that two numbers must be exactly the same 365 // to be considered equal. 366 // 367 // The maximum error of a single floating-point operation is 0.5 368 // units in the last place. On Intel CPU's, all floating-point 369 // calculations are done with 80-bit precision, while double has 64 370 // bits. Therefore, 4 should be enough for ordinary use. 371 // 372 // See the following article for more details on ULP: 373 // http://www.cygnus-software.com/papers/comparingfloats/comparingfloats.htm. 374 static const size_t kMaxUlps = 4; 375 376 // Constructs a FloatingPoint from a raw floating-point number. 377 // 378 // On an Intel CPU, passing a non-normalized NAN (Not a Number) 379 // around may change its bits, although the new value is guaranteed 380 // to be also a NAN. Therefore, don't expect this constructor to 381 // preserve the bits in x when x is a NAN. 382 explicit FloatingPoint(const RawType& x) { u_.value_ = x; } 383 384 // Static methods 385 386 // Reinterprets a bit pattern as a floating-point number. 387 // 388 // This function is needed to test the AlmostEquals() method. 389 static RawType ReinterpretBits(const Bits bits) { 390 FloatingPoint fp(0); 391 fp.u_.bits_ = bits; 392 return fp.u_.value_; 393 } 394 395 // Returns the floating-point number that represent positive infinity. 396 static RawType Infinity() { 397 return ReinterpretBits(kExponentBitMask); 398 } 399 400 // Non-static methods 401 402 // Returns the bits that represents this number. 403 const Bits &bits() const { return u_.bits_; } 404 405 // Returns the exponent bits of this number. 406 Bits exponent_bits() const { return kExponentBitMask & u_.bits_; } 407 408 // Returns the fraction bits of this number. 409 Bits fraction_bits() const { return kFractionBitMask & u_.bits_; } 410 411 // Returns the sign bit of this number. 412 Bits sign_bit() const { return kSignBitMask & u_.bits_; } 413 414 // Returns true iff this is NAN (not a number). 415 bool is_nan() const { 416 // It's a NAN if the exponent bits are all ones and the fraction 417 // bits are not entirely zeros. 418 return (exponent_bits() == kExponentBitMask) && (fraction_bits() != 0); 419 } 420 421 // Returns true iff this number is at most kMaxUlps ULP's away from 422 // rhs. In particular, this function: 423 // 424 // - returns false if either number is (or both are) NAN. 425 // - treats really large numbers as almost equal to infinity. 426 // - thinks +0.0 and -0.0 are 0 DLP's apart. 427 bool AlmostEquals(const FloatingPoint& rhs) const { 428 // The IEEE standard says that any comparison operation involving 429 // a NAN must return false. 430 if (is_nan() || rhs.is_nan()) return false; 431 432 return DistanceBetweenSignAndMagnitudeNumbers(u_.bits_, rhs.u_.bits_) 433 <= kMaxUlps; 434 } 435 436 private: 437 // The data type used to store the actual floating-point number. 438 union FloatingPointUnion { 439 RawType value_; // The raw floating-point number. 440 Bits bits_; // The bits that represent the number. 441 }; 442 443 // Converts an integer from the sign-and-magnitude representation to 444 // the biased representation. More precisely, let N be 2 to the 445 // power of (kBitCount - 1), an integer x is represented by the 446 // unsigned number x + N. 447 // 448 // For instance, 449 // 450 // -N + 1 (the most negative number representable using 451 // sign-and-magnitude) is represented by 1; 452 // 0 is represented by N; and 453 // N - 1 (the biggest number representable using 454 // sign-and-magnitude) is represented by 2N - 1. 455 // 456 // Read http://en.wikipedia.org/wiki/Signed_number_representations 457 // for more details on signed number representations. 458 static Bits SignAndMagnitudeToBiased(const Bits &sam) { 459 if (kSignBitMask & sam) { 460 // sam represents a negative number. 461 return ~sam + 1; 462 } else { 463 // sam represents a positive number. 464 return kSignBitMask | sam; 465 } 466 } 467 468 // Given two numbers in the sign-and-magnitude representation, 469 // returns the distance between them as an unsigned number. 470 static Bits DistanceBetweenSignAndMagnitudeNumbers(const Bits &sam1, 471 const Bits &sam2) { 472 const Bits biased1 = SignAndMagnitudeToBiased(sam1); 473 const Bits biased2 = SignAndMagnitudeToBiased(sam2); 474 return (biased1 >= biased2) ? (biased1 - biased2) : (biased2 - biased1); 475 } 476 477 FloatingPointUnion u_; 478}; 479 480// Typedefs the instances of the FloatingPoint template class that we 481// care to use. 482typedef FloatingPoint<float> Float; 483typedef FloatingPoint<double> Double; 484 485// In order to catch the mistake of putting tests that use different 486// test fixture classes in the same test case, we need to assign 487// unique IDs to fixture classes and compare them. The TypeId type is 488// used to hold such IDs. The user should treat TypeId as an opaque 489// type: the only operation allowed on TypeId values is to compare 490// them for equality using the == operator. 491typedef const void* TypeId; 492 493template <typename T> 494class TypeIdHelper { 495 public: 496 // dummy_ must not have a const type. Otherwise an overly eager 497 // compiler (e.g. MSVC 7.1 & 8.0) may try to merge 498 // TypeIdHelper<T>::dummy_ for different Ts as an "optimization". 499 static bool dummy_; 500}; 501 502template <typename T> 503bool TypeIdHelper<T>::dummy_ = false; 504 505// GetTypeId<T>() returns the ID of type T. Different values will be 506// returned for different types. Calling the function twice with the 507// same type argument is guaranteed to return the same ID. 508template <typename T> 509TypeId GetTypeId() { 510 // The compiler is required to allocate a different 511 // TypeIdHelper<T>::dummy_ variable for each T used to instantiate 512 // the template. Therefore, the address of dummy_ is guaranteed to 513 // be unique. 514 return &(TypeIdHelper<T>::dummy_); 515} 516 517// Returns the type ID of ::testing::Test. Always call this instead 518// of GetTypeId< ::testing::Test>() to get the type ID of 519// ::testing::Test, as the latter may give the wrong result due to a 520// suspected linker bug when compiling Google Test as a Mac OS X 521// framework. 522TypeId GetTestTypeId(); 523 524// Defines the abstract factory interface that creates instances 525// of a Test object. 526class TestFactoryBase { 527 public: 528 virtual ~TestFactoryBase() {} 529 530 // Creates a test instance to run. The instance is both created and destroyed 531 // within TestInfoImpl::Run() 532 virtual Test* CreateTest() = 0; 533 534 protected: 535 TestFactoryBase() {} 536 537 private: 538 GTEST_DISALLOW_COPY_AND_ASSIGN_(TestFactoryBase); 539}; 540 541// This class provides implementation of TeastFactoryBase interface. 542// It is used in TEST and TEST_F macros. 543template <class TestClass> 544class TestFactoryImpl : public TestFactoryBase { 545 public: 546 virtual Test* CreateTest() { return new TestClass; } 547}; 548 549#if GTEST_OS_WINDOWS 550 551// Predicate-formatters for implementing the HRESULT checking macros 552// {ASSERT|EXPECT}_HRESULT_{SUCCEEDED|FAILED} 553// We pass a long instead of HRESULT to avoid causing an 554// include dependency for the HRESULT type. 555AssertionResult IsHRESULTSuccess(const char* expr, long hr); // NOLINT 556AssertionResult IsHRESULTFailure(const char* expr, long hr); // NOLINT 557 558#endif // GTEST_OS_WINDOWS 559 560// Formats a source file path and a line number as they would appear 561// in a compiler error message. 562inline String FormatFileLocation(const char* file, int line) { 563 const char* const file_name = file == NULL ? "unknown file" : file; 564 if (line < 0) { 565 return String::Format("%s:", file_name); 566 } 567#ifdef _MSC_VER 568 return String::Format("%s(%d):", file_name, line); 569#else 570 return String::Format("%s:%d:", file_name, line); 571#endif // _MSC_VER 572} 573 574// Types of SetUpTestCase() and TearDownTestCase() functions. 575typedef void (*SetUpTestCaseFunc)(); 576typedef void (*TearDownTestCaseFunc)(); 577 578// Creates a new TestInfo object and registers it with Google Test; 579// returns the created object. 580// 581// Arguments: 582// 583// test_case_name: name of the test case 584// name: name of the test 585// test_case_comment: a comment on the test case that will be included in 586// the test output 587// comment: a comment on the test that will be included in the 588// test output 589// fixture_class_id: ID of the test fixture class 590// set_up_tc: pointer to the function that sets up the test case 591// tear_down_tc: pointer to the function that tears down the test case 592// factory: pointer to the factory that creates a test object. 593// The newly created TestInfo instance will assume 594// ownership of the factory object. 595TestInfo* MakeAndRegisterTestInfo( 596 const char* test_case_name, const char* name, 597 const char* test_case_comment, const char* comment, 598 TypeId fixture_class_id, 599 SetUpTestCaseFunc set_up_tc, 600 TearDownTestCaseFunc tear_down_tc, 601 TestFactoryBase* factory); 602 603#if GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P 604 605// State of the definition of a type-parameterized test case. 606class TypedTestCasePState { 607 public: 608 TypedTestCasePState() : registered_(false) {} 609 610 // Adds the given test name to defined_test_names_ and return true 611 // if the test case hasn't been registered; otherwise aborts the 612 // program. 613 bool AddTestName(const char* file, int line, const char* case_name, 614 const char* test_name) { 615 if (registered_) { 616 fprintf(stderr, "%s Test %s must be defined before " 617 "REGISTER_TYPED_TEST_CASE_P(%s, ...).\n", 618 FormatFileLocation(file, line).c_str(), test_name, case_name); 619 fflush(stderr); 620 posix::Abort(); 621 } 622 defined_test_names_.insert(test_name); 623 return true; 624 } 625 626 // Verifies that registered_tests match the test names in 627 // defined_test_names_; returns registered_tests if successful, or 628 // aborts the program otherwise. 629 const char* VerifyRegisteredTestNames( 630 const char* file, int line, const char* registered_tests); 631 632 private: 633 bool registered_; 634 ::std::set<const char*> defined_test_names_; 635}; 636 637// Skips to the first non-space char after the first comma in 'str'; 638// returns NULL if no comma is found in 'str'. 639inline const char* SkipComma(const char* str) { 640 const char* comma = strchr(str, ','); 641 if (comma == NULL) { 642 return NULL; 643 } 644 while (isspace(*(++comma))) {} 645 return comma; 646} 647 648// Returns the prefix of 'str' before the first comma in it; returns 649// the entire string if it contains no comma. 650inline String GetPrefixUntilComma(const char* str) { 651 const char* comma = strchr(str, ','); 652 return comma == NULL ? String(str) : String(str, comma - str); 653} 654 655// TypeParameterizedTest<Fixture, TestSel, Types>::Register() 656// registers a list of type-parameterized tests with Google Test. The 657// return value is insignificant - we just need to return something 658// such that we can call this function in a namespace scope. 659// 660// Implementation note: The GTEST_TEMPLATE_ macro declares a template 661// template parameter. It's defined in gtest-type-util.h. 662template <GTEST_TEMPLATE_ Fixture, class TestSel, typename Types> 663class TypeParameterizedTest { 664 public: 665 // 'index' is the index of the test in the type list 'Types' 666 // specified in INSTANTIATE_TYPED_TEST_CASE_P(Prefix, TestCase, 667 // Types). Valid values for 'index' are [0, N - 1] where N is the 668 // length of Types. 669 static bool Register(const char* prefix, const char* case_name, 670 const char* test_names, int index) { 671 typedef typename Types::Head Type; 672 typedef Fixture<Type> FixtureClass; 673 typedef typename GTEST_BIND_(TestSel, Type) TestClass; 674 675 // First, registers the first type-parameterized test in the type 676 // list. 677 MakeAndRegisterTestInfo( 678 String::Format("%s%s%s/%d", prefix, prefix[0] == '\0' ? "" : "/", 679 case_name, index).c_str(), 680 GetPrefixUntilComma(test_names).c_str(), 681 String::Format("TypeParam = %s", GetTypeName<Type>().c_str()).c_str(), 682 "", 683 GetTypeId<FixtureClass>(), 684 TestClass::SetUpTestCase, 685 TestClass::TearDownTestCase, 686 new TestFactoryImpl<TestClass>); 687 688 // Next, recurses (at compile time) with the tail of the type list. 689 return TypeParameterizedTest<Fixture, TestSel, typename Types::Tail> 690 ::Register(prefix, case_name, test_names, index + 1); 691 } 692}; 693 694// The base case for the compile time recursion. 695template <GTEST_TEMPLATE_ Fixture, class TestSel> 696class TypeParameterizedTest<Fixture, TestSel, Types0> { 697 public: 698 static bool Register(const char* /*prefix*/, const char* /*case_name*/, 699 const char* /*test_names*/, int /*index*/) { 700 return true; 701 } 702}; 703 704// TypeParameterizedTestCase<Fixture, Tests, Types>::Register() 705// registers *all combinations* of 'Tests' and 'Types' with Google 706// Test. The return value is insignificant - we just need to return 707// something such that we can call this function in a namespace scope. 708template <GTEST_TEMPLATE_ Fixture, typename Tests, typename Types> 709class TypeParameterizedTestCase { 710 public: 711 static bool Register(const char* prefix, const char* case_name, 712 const char* test_names) { 713 typedef typename Tests::Head Head; 714 715 // First, register the first test in 'Test' for each type in 'Types'. 716 TypeParameterizedTest<Fixture, Head, Types>::Register( 717 prefix, case_name, test_names, 0); 718 719 // Next, recurses (at compile time) with the tail of the test list. 720 return TypeParameterizedTestCase<Fixture, typename Tests::Tail, Types> 721 ::Register(prefix, case_name, SkipComma(test_names)); 722 } 723}; 724 725// The base case for the compile time recursion. 726template <GTEST_TEMPLATE_ Fixture, typename Types> 727class TypeParameterizedTestCase<Fixture, Templates0, Types> { 728 public: 729 static bool Register(const char* prefix, const char* case_name, 730 const char* test_names) { 731 return true; 732 } 733}; 734 735#endif // GTEST_HAS_TYPED_TEST || GTEST_HAS_TYPED_TEST_P 736 737// Returns the current OS stack trace as a String. 738// 739// The maximum number of stack frames to be included is specified by 740// the gtest_stack_trace_depth flag. The skip_count parameter 741// specifies the number of top frames to be skipped, which doesn't 742// count against the number of frames to be included. 743// 744// For example, if Foo() calls Bar(), which in turn calls 745// GetCurrentOsStackTraceExceptTop(..., 1), Foo() will be included in 746// the trace but Bar() and GetCurrentOsStackTraceExceptTop() won't. 747String GetCurrentOsStackTraceExceptTop(UnitTest* unit_test, int skip_count); 748 749// A helper for suppressing warnings on unreachable code in some macros. 750bool AlwaysTrue(); 751 752} // namespace internal 753} // namespace testing 754 755#define GTEST_MESSAGE_(message, result_type) \ 756 ::testing::internal::AssertHelper(result_type, __FILE__, __LINE__, message) \ 757 = ::testing::Message() 758 759#define GTEST_FATAL_FAILURE_(message) \ 760 return GTEST_MESSAGE_(message, ::testing::TPRT_FATAL_FAILURE) 761 762#define GTEST_NONFATAL_FAILURE_(message) \ 763 GTEST_MESSAGE_(message, ::testing::TPRT_NONFATAL_FAILURE) 764 765#define GTEST_SUCCESS_(message) \ 766 GTEST_MESSAGE_(message, ::testing::TPRT_SUCCESS) 767 768// Suppresses MSVC warnings 4072 (unreachable code) for the code following 769// statement if it returns or throws (or doesn't return or throw in some 770// situations). 771#define GTEST_HIDE_UNREACHABLE_CODE_(statement) \ 772 if (::testing::internal::AlwaysTrue()) { statement; } 773 774#define GTEST_TEST_THROW_(statement, expected_exception, fail) \ 775 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 776 if (const char* gtest_msg = "") { \ 777 bool gtest_caught_expected = false; \ 778 try { \ 779 GTEST_HIDE_UNREACHABLE_CODE_(statement); \ 780 } \ 781 catch (expected_exception const&) { \ 782 gtest_caught_expected = true; \ 783 } \ 784 catch (...) { \ 785 gtest_msg = "Expected: " #statement " throws an exception of type " \ 786 #expected_exception ".\n Actual: it throws a different " \ 787 "type."; \ 788 goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ 789 } \ 790 if (!gtest_caught_expected) { \ 791 gtest_msg = "Expected: " #statement " throws an exception of type " \ 792 #expected_exception ".\n Actual: it throws nothing."; \ 793 goto GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__); \ 794 } \ 795 } else \ 796 GTEST_CONCAT_TOKEN_(gtest_label_testthrow_, __LINE__): \ 797 fail(gtest_msg) 798 799#define GTEST_TEST_NO_THROW_(statement, fail) \ 800 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 801 if (const char* gtest_msg = "") { \ 802 try { \ 803 GTEST_HIDE_UNREACHABLE_CODE_(statement); \ 804 } \ 805 catch (...) { \ 806 gtest_msg = "Expected: " #statement " doesn't throw an exception.\n" \ 807 " Actual: it throws."; \ 808 goto GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__); \ 809 } \ 810 } else \ 811 GTEST_CONCAT_TOKEN_(gtest_label_testnothrow_, __LINE__): \ 812 fail(gtest_msg) 813 814#define GTEST_TEST_ANY_THROW_(statement, fail) \ 815 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 816 if (const char* gtest_msg = "") { \ 817 bool gtest_caught_any = false; \ 818 try { \ 819 GTEST_HIDE_UNREACHABLE_CODE_(statement); \ 820 } \ 821 catch (...) { \ 822 gtest_caught_any = true; \ 823 } \ 824 if (!gtest_caught_any) { \ 825 gtest_msg = "Expected: " #statement " throws an exception.\n" \ 826 " Actual: it doesn't."; \ 827 goto GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__); \ 828 } \ 829 } else \ 830 GTEST_CONCAT_TOKEN_(gtest_label_testanythrow_, __LINE__): \ 831 fail(gtest_msg) 832 833 834#define GTEST_TEST_BOOLEAN_(boolexpr, booltext, actual, expected, fail) \ 835 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 836 if (boolexpr) \ 837 ; \ 838 else \ 839 fail("Value of: " booltext "\n Actual: " #actual "\nExpected: " #expected) 840 841#define GTEST_TEST_NO_FATAL_FAILURE_(statement, fail) \ 842 GTEST_AMBIGUOUS_ELSE_BLOCKER_ \ 843 if (const char* gtest_msg = "") { \ 844 ::testing::internal::HasNewFatalFailureHelper gtest_fatal_failure_checker; \ 845 GTEST_HIDE_UNREACHABLE_CODE_(statement); \ 846 if (gtest_fatal_failure_checker.has_new_fatal_failure()) { \ 847 gtest_msg = "Expected: " #statement " doesn't generate new fatal " \ 848 "failures in the current thread.\n" \ 849 " Actual: it does."; \ 850 goto GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__); \ 851 } \ 852 } else \ 853 GTEST_CONCAT_TOKEN_(gtest_label_testnofatal_, __LINE__): \ 854 fail(gtest_msg) 855 856// Expands to the name of the class that implements the given test. 857#define GTEST_TEST_CLASS_NAME_(test_case_name, test_name) \ 858 test_case_name##_##test_name##_Test 859 860// Helper macro for defining tests. 861#define GTEST_TEST_(test_case_name, test_name, parent_class, parent_id)\ 862class GTEST_TEST_CLASS_NAME_(test_case_name, test_name) : public parent_class {\ 863 public:\ 864 GTEST_TEST_CLASS_NAME_(test_case_name, test_name)() {}\ 865 private:\ 866 virtual void TestBody();\ 867 static ::testing::TestInfo* const test_info_;\ 868 GTEST_DISALLOW_COPY_AND_ASSIGN_(\ 869 GTEST_TEST_CLASS_NAME_(test_case_name, test_name));\ 870};\ 871\ 872::testing::TestInfo* const GTEST_TEST_CLASS_NAME_(test_case_name, test_name)\ 873 ::test_info_ =\ 874 ::testing::internal::MakeAndRegisterTestInfo(\ 875 #test_case_name, #test_name, "", "", \ 876 (parent_id), \ 877 parent_class::SetUpTestCase, \ 878 parent_class::TearDownTestCase, \ 879 new ::testing::internal::TestFactoryImpl<\ 880 GTEST_TEST_CLASS_NAME_(test_case_name, test_name)>);\ 881void GTEST_TEST_CLASS_NAME_(test_case_name, test_name)::TestBody() 882 883#endif // GTEST_INCLUDE_GTEST_INTERNAL_GTEST_INTERNAL_H_ 884