/Unittests/googletest/include/gtest/internal/gtest-internal.h

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