third-party/unittest/googletest/include/gtest/gtest_prod.h

   1 // Copyright 2006, 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 // Google C++ Testing and Mocking Framework definitions useful in production
  31 // code.
  32
  33 #ifndef GOOGLETEST_INCLUDE_GTEST_GTEST_PROD_H_
  34 #define GOOGLETEST_INCLUDE_GTEST_GTEST_PROD_H_
  35
  36 // When you need to test the private or protected members of a class,
  37 // use the FRIEND_TEST macro to declare your tests as friends of the
  38 // class.  For example:
  39 //
  40 // class MyClass {
  41 //  private:
  42 //   void PrivateMethod();
  43 //   FRIEND_TEST(MyClassTest, PrivateMethodWorks);
  44 // };
  45 //
  46 // class MyClassTest : public testing::Test {
  47 //   // ...
  48 // };
  49 //
  50 // TEST_F(MyClassTest, PrivateMethodWorks) {
  51 //   // Can call MyClass::PrivateMethod() here.
  52 // }
  53 //
  54 // Note: The test class must be in the same namespace as the class being tested.
  55 // For example, putting MyClassTest in an anonymous namespace will not work.
  56
  57 #define FRIEND_TEST(test_case_name, test_name) \
  58   friend class test_case_name##_##test_name##_Test
  59
  60 #endif  // GOOGLETEST_INCLUDE_GTEST_GTEST_PROD_H_