gmock-more-matchers.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120
  1. // Copyright 2013, 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. // Google Mock - a framework for writing C++ mock classes.
  30. //
  31. // This file implements some matchers that depend on gmock-matchers.h.
  32. //
  33. // Note that tests are implemented in gmock-matchers_test.cc rather than
  34. // gmock-more-matchers-test.cc.
  35. // IWYU pragma: private, include "gmock/gmock.h"
  36. // IWYU pragma: friend gmock/.*
  37. #ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MORE_MATCHERS_H_
  38. #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MORE_MATCHERS_H_
  39. #include <ostream>
  40. #include <string>
  41. #include "gmock/gmock-matchers.h"
  42. namespace testing {
  43. // Silence C4100 (unreferenced formal
  44. // parameter) for MSVC
  45. GTEST_DISABLE_MSC_WARNINGS_PUSH_(4100)
  46. #if defined(_MSC_VER) && (_MSC_VER == 1900)
  47. // and silence C4800 (C4800: 'int *const ': forcing value
  48. // to bool 'true' or 'false') for MSVC 14
  49. GTEST_DISABLE_MSC_WARNINGS_PUSH_(4800)
  50. #endif
  51. namespace internal {
  52. // Implements the polymorphic IsEmpty matcher, which
  53. // can be used as a Matcher<T> as long as T is either a container that defines
  54. // empty() and size() (e.g. std::vector or std::string), or a C-style string.
  55. class IsEmptyMatcher {
  56. public:
  57. // Matches anything that defines empty() and size().
  58. template <typename MatcheeContainerType>
  59. bool MatchAndExplain(const MatcheeContainerType& c,
  60. MatchResultListener* listener) const {
  61. if (c.empty()) {
  62. return true;
  63. }
  64. *listener << "whose size is " << c.size();
  65. return false;
  66. }
  67. // Matches C-style strings.
  68. bool MatchAndExplain(const char* s, MatchResultListener* listener) const {
  69. return MatchAndExplain(std::string(s), listener);
  70. }
  71. // Describes what this matcher matches.
  72. void DescribeTo(std::ostream* os) const { *os << "is empty"; }
  73. void DescribeNegationTo(std::ostream* os) const { *os << "isn't empty"; }
  74. };
  75. } // namespace internal
  76. // Creates a polymorphic matcher that matches an empty container or C-style
  77. // string. The container must support both size() and empty(), which all
  78. // STL-like containers provide.
  79. inline PolymorphicMatcher<internal::IsEmptyMatcher> IsEmpty() {
  80. return MakePolymorphicMatcher(internal::IsEmptyMatcher());
  81. }
  82. // Define a matcher that matches a value that evaluates in boolean
  83. // context to true. Useful for types that define "explicit operator
  84. // bool" operators and so can't be compared for equality with true
  85. // and false.
  86. MATCHER(IsTrue, negation ? "is false" : "is true") {
  87. return static_cast<bool>(arg);
  88. }
  89. // Define a matcher that matches a value that evaluates in boolean
  90. // context to false. Useful for types that define "explicit operator
  91. // bool" operators and so can't be compared for equality with true
  92. // and false.
  93. MATCHER(IsFalse, negation ? "is true" : "is false") {
  94. return !static_cast<bool>(arg);
  95. }
  96. #if defined(_MSC_VER) && (_MSC_VER == 1900)
  97. GTEST_DISABLE_MSC_WARNINGS_POP_() // 4800
  98. #endif
  99. GTEST_DISABLE_MSC_WARNINGS_POP_() // 4100
  100. } // namespace testing
  101. #endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MORE_MATCHERS_H_