| 1 |
// Copyright 2007, 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 Mock - a framework for writing C++ mock classes. |
| 31 |
// |
| 32 |
// This file implements MOCK_METHOD. |
| 33 |
|
| 34 |
// GOOGLETEST_CM0002 DO NOT DELETE |
| 35 |
|
| 36 |
// IWYU pragma: private, include "gmock/gmock.h" |
| 37 |
// IWYU pragma: friend gmock/.* |
| 38 |
|
| 39 |
#ifndef THIRD_PARTY_GOOGLETEST_GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ // NOLINT |
| 40 |
#define THIRD_PARTY_GOOGLETEST_GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ // NOLINT |
| 41 |
|
| 42 |
#include "gmock/gmock-generated-function-mockers.h" // NOLINT |
| 43 |
#include "gmock/internal/gmock-pp.h" |
| 44 |
|
| 45 |
#define MOCK_METHOD(...) \ |
| 46 |
GMOCK_PP_VARIADIC_CALL(GMOCK_INTERNAL_MOCK_METHOD_ARG_, __VA_ARGS__) |
| 47 |
|
| 48 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_1(...) \ |
| 49 |
GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) |
| 50 |
|
| 51 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_2(...) \ |
| 52 |
GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) |
| 53 |
|
| 54 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_3(_Ret, _MethodName, _Args) \ |
| 55 |
GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, ()) |
| 56 |
|
| 57 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_4(_Ret, _MethodName, _Args, _Spec) \ |
| 58 |
GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Args); \ |
| 59 |
GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Spec); \ |
| 60 |
GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE( \ |
| 61 |
GMOCK_PP_NARG0 _Args, GMOCK_INTERNAL_SIGNATURE(_Ret, _Args)); \ |
| 62 |
GMOCK_INTERNAL_ASSERT_VALID_SPEC(_Spec) \ |
| 63 |
GMOCK_INTERNAL_MOCK_METHOD_IMPL( \ |
| 64 |
GMOCK_PP_NARG0 _Args, _MethodName, GMOCK_INTERNAL_HAS_CONST(_Spec), \ |
| 65 |
GMOCK_INTERNAL_HAS_OVERRIDE(_Spec), GMOCK_INTERNAL_HAS_FINAL(_Spec), \ |
| 66 |
GMOCK_INTERNAL_HAS_NOEXCEPT(_Spec), GMOCK_INTERNAL_GET_CALLTYPE(_Spec), \ |
| 67 |
(GMOCK_INTERNAL_SIGNATURE(_Ret, _Args))) |
| 68 |
|
| 69 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_5(...) \ |
| 70 |
GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) |
| 71 |
|
| 72 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_6(...) \ |
| 73 |
GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) |
| 74 |
|
| 75 |
#define GMOCK_INTERNAL_MOCK_METHOD_ARG_7(...) \ |
| 76 |
GMOCK_INTERNAL_WRONG_ARITY(__VA_ARGS__) |
| 77 |
|
| 78 |
#define GMOCK_INTERNAL_WRONG_ARITY(...) \ |
| 79 |
static_assert( \ |
| 80 |
false, \ |
| 81 |
"MOCK_METHOD must be called with 3 or 4 arguments. _Ret, " \ |
| 82 |
"_MethodName, _Args and optionally _Spec. _Args and _Spec must be " \ |
| 83 |
"enclosed in parentheses. If _Ret is a type with unprotected commas, " \ |
| 84 |
"it must also be enclosed in parentheses.") |
| 85 |
|
| 86 |
#define GMOCK_INTERNAL_ASSERT_PARENTHESIS(_Tuple) \ |
| 87 |
static_assert( \ |
| 88 |
GMOCK_PP_IS_ENCLOSED_PARENS(_Tuple), \ |
| 89 |
GMOCK_PP_STRINGIZE(_Tuple) " should be enclosed in parentheses.") |
| 90 |
|
| 91 |
#define GMOCK_INTERNAL_ASSERT_VALID_SIGNATURE(_N, ...) \ |
| 92 |
static_assert( \ |
| 93 |
std::is_function<__VA_ARGS__>::value, \ |
| 94 |
"Signature must be a function type, maybe return type contains " \ |
| 95 |
"unprotected comma."); \ |
| 96 |
static_assert( \ |
| 97 |
::testing::tuple_size<typename ::testing::internal::Function< \ |
| 98 |
__VA_ARGS__>::ArgumentTuple>::value == _N, \ |
| 99 |
"This method does not take " GMOCK_PP_STRINGIZE( \ |
| 100 |
_N) " arguments. Parenthesize all types with unproctected commas.") |
| 101 |
|
| 102 |
#define GMOCK_INTERNAL_ASSERT_VALID_SPEC(_Spec) \ |
| 103 |
GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT, ~, _Spec) |
| 104 |
|
| 105 |
#define GMOCK_INTERNAL_MOCK_METHOD_IMPL(_N, _MethodName, _Constness, \ |
| 106 |
_Override, _Final, _Noexcept, \ |
| 107 |
_CallType, _Signature) \ |
| 108 |
typename ::testing::internal::Function<GMOCK_PP_REMOVE_PARENS( \ |
| 109 |
_Signature)>::Result \ |
| 110 |
GMOCK_INTERNAL_EXPAND(_CallType) \ |
| 111 |
_MethodName(GMOCK_PP_REPEAT(GMOCK_INTERNAL_PARAMETER, _Signature, _N)) \ |
| 112 |
GMOCK_PP_IF(_Constness, const, ) GMOCK_PP_IF(_Noexcept, noexcept, ) \ |
| 113 |
GMOCK_PP_IF(_Override, override, ) \ |
| 114 |
GMOCK_PP_IF(_Final, final, ) { \ |
| 115 |
GMOCK_MOCKER_(_N, _Constness, _MethodName) \ |
| 116 |
.SetOwnerAndName(this, #_MethodName); \ |
| 117 |
return GMOCK_MOCKER_(_N, _Constness, _MethodName) \ |
| 118 |
.Invoke(GMOCK_PP_REPEAT(GMOCK_INTERNAL_FORWARD_ARG, _Signature, _N)); \ |
| 119 |
} \ |
| 120 |
::testing::MockSpec<GMOCK_PP_REMOVE_PARENS(_Signature)> gmock_##_MethodName( \ |
| 121 |
GMOCK_PP_REPEAT(GMOCK_INTERNAL_MATCHER_PARAMETER, _Signature, _N)) \ |
| 122 |
GMOCK_PP_IF(_Constness, const, ) { \ |
| 123 |
GMOCK_MOCKER_(_N, _Constness, _MethodName).RegisterOwner(this); \ |
| 124 |
return GMOCK_MOCKER_(_N, _Constness, _MethodName) \ |
| 125 |
.With(GMOCK_PP_REPEAT(GMOCK_INTERNAL_MATCHER_ARGUMENT, , _N)); \ |
| 126 |
} \ |
| 127 |
::testing::MockSpec<GMOCK_PP_REMOVE_PARENS(_Signature)> gmock_##_MethodName( \ |
| 128 |
const ::testing::internal::WithoutMatchers&, \ |
| 129 |
GMOCK_PP_IF(_Constness, const, )::testing::internal::Function< \ |
| 130 |
GMOCK_PP_REMOVE_PARENS(_Signature)>*) \ |
| 131 |
const GMOCK_PP_IF(_Noexcept, noexcept, ) { \ |
| 132 |
return GMOCK_PP_CAT(::testing::internal::AdjustConstness_, \ |
| 133 |
GMOCK_PP_IF(_Constness, const, ))(this) \ |
| 134 |
->gmock_##_MethodName(GMOCK_PP_REPEAT( \ |
| 135 |
GMOCK_INTERNAL_A_MATCHER_ARGUMENT, _Signature, _N)); \ |
| 136 |
} \ |
| 137 |
mutable ::testing::FunctionMocker<GMOCK_PP_REMOVE_PARENS(_Signature)> \ |
| 138 |
GMOCK_MOCKER_(_N, _Constness, _MethodName) |
| 139 |
|
| 140 |
#define GMOCK_INTERNAL_EXPAND(...) __VA_ARGS__ |
| 141 |
|
| 142 |
// Five Valid modifiers. |
| 143 |
#define GMOCK_INTERNAL_HAS_CONST(_Tuple) \ |
| 144 |
GMOCK_PP_HAS_COMMA(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_CONST, ~, _Tuple)) |
| 145 |
|
| 146 |
#define GMOCK_INTERNAL_HAS_OVERRIDE(_Tuple) \ |
| 147 |
GMOCK_PP_HAS_COMMA( \ |
| 148 |
GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_OVERRIDE, ~, _Tuple)) |
| 149 |
|
| 150 |
#define GMOCK_INTERNAL_HAS_FINAL(_Tuple) \ |
| 151 |
GMOCK_PP_HAS_COMMA(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_FINAL, ~, _Tuple)) |
| 152 |
|
| 153 |
#define GMOCK_INTERNAL_HAS_NOEXCEPT(_Tuple) \ |
| 154 |
GMOCK_PP_HAS_COMMA( \ |
| 155 |
GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_DETECT_NOEXCEPT, ~, _Tuple)) |
| 156 |
|
| 157 |
#define GMOCK_INTERNAL_GET_CALLTYPE(_Tuple) \ |
| 158 |
GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GET_CALLTYPE_IMPL, ~, _Tuple) |
| 159 |
|
| 160 |
#define GMOCK_INTERNAL_ASSERT_VALID_SPEC_ELEMENT(_i, _, _elem) \ |
| 161 |
static_assert( \ |
| 162 |
(GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem)) + \ |
| 163 |
GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_OVERRIDE(_i, _, _elem)) + \ |
| 164 |
GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_FINAL(_i, _, _elem)) + \ |
| 165 |
GMOCK_PP_HAS_COMMA(GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem)) + \ |
| 166 |
GMOCK_INTERNAL_IS_CALLTYPE(_elem)) == 1, \ |
| 167 |
GMOCK_PP_STRINGIZE( \ |
| 168 |
_elem) " cannot be recognized as a valid specification modifier."); |
| 169 |
|
| 170 |
// Modifiers implementation. |
| 171 |
#define GMOCK_INTERNAL_DETECT_CONST(_i, _, _elem) \ |
| 172 |
GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_CONST_I_, _elem) |
| 173 |
|
| 174 |
#define GMOCK_INTERNAL_DETECT_CONST_I_const , |
| 175 |
|
| 176 |
#define GMOCK_INTERNAL_DETECT_OVERRIDE(_i, _, _elem) \ |
| 177 |
GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_OVERRIDE_I_, _elem) |
| 178 |
|
| 179 |
#define GMOCK_INTERNAL_DETECT_OVERRIDE_I_override , |
| 180 |
|
| 181 |
#define GMOCK_INTERNAL_DETECT_FINAL(_i, _, _elem) \ |
| 182 |
GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_FINAL_I_, _elem) |
| 183 |
|
| 184 |
#define GMOCK_INTERNAL_DETECT_FINAL_I_final , |
| 185 |
|
| 186 |
// TODO(iserna): Maybe noexcept should accept an argument here as well. |
| 187 |
#define GMOCK_INTERNAL_DETECT_NOEXCEPT(_i, _, _elem) \ |
| 188 |
GMOCK_PP_CAT(GMOCK_INTERNAL_DETECT_NOEXCEPT_I_, _elem) |
| 189 |
|
| 190 |
#define GMOCK_INTERNAL_DETECT_NOEXCEPT_I_noexcept , |
| 191 |
|
| 192 |
#define GMOCK_INTERNAL_GET_CALLTYPE_IMPL(_i, _, _elem) \ |
| 193 |
GMOCK_PP_IF(GMOCK_INTERNAL_IS_CALLTYPE(_elem), \ |
| 194 |
GMOCK_INTERNAL_GET_VALUE_CALLTYPE, GMOCK_PP_EMPTY) \ |
| 195 |
(_elem) |
| 196 |
|
| 197 |
// TODO(iserna): GMOCK_INTERNAL_IS_CALLTYPE and |
| 198 |
// GMOCK_INTERNAL_GET_VALUE_CALLTYPE needed more expansions to work on windows |
| 199 |
// maybe they can be simplified somehow. |
| 200 |
#define GMOCK_INTERNAL_IS_CALLTYPE(_arg) \ |
| 201 |
GMOCK_INTERNAL_IS_CALLTYPE_I( \ |
| 202 |
GMOCK_PP_CAT(GMOCK_INTERNAL_IS_CALLTYPE_HELPER_, _arg)) |
| 203 |
#define GMOCK_INTERNAL_IS_CALLTYPE_I(_arg) GMOCK_PP_IS_ENCLOSED_PARENS(_arg) |
| 204 |
|
| 205 |
#define GMOCK_INTERNAL_GET_VALUE_CALLTYPE(_arg) \ |
| 206 |
GMOCK_INTERNAL_GET_VALUE_CALLTYPE_I( \ |
| 207 |
GMOCK_PP_CAT(GMOCK_INTERNAL_IS_CALLTYPE_HELPER_, _arg)) |
| 208 |
#define GMOCK_INTERNAL_GET_VALUE_CALLTYPE_I(_arg) \ |
| 209 |
GMOCK_PP_CAT(GMOCK_PP_IDENTITY, _arg) |
| 210 |
|
| 211 |
#define GMOCK_INTERNAL_IS_CALLTYPE_HELPER_Calltype |
| 212 |
|
| 213 |
#define GMOCK_INTERNAL_SIGNATURE(_Ret, _Args) \ |
| 214 |
GMOCK_PP_IF(GMOCK_PP_IS_BEGIN_PARENS(_Ret), GMOCK_PP_REMOVE_PARENS, \ |
| 215 |
GMOCK_PP_IDENTITY) \ |
| 216 |
(_Ret)(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GET_TYPE, _, _Args)) |
| 217 |
|
| 218 |
#define GMOCK_INTERNAL_GET_TYPE(_i, _, _elem) \ |
| 219 |
GMOCK_PP_COMMA_IF(_i) \ |
| 220 |
GMOCK_PP_IF(GMOCK_PP_IS_BEGIN_PARENS(_elem), GMOCK_PP_REMOVE_PARENS, \ |
| 221 |
GMOCK_PP_IDENTITY) \ |
| 222 |
(_elem) |
| 223 |
|
| 224 |
#define GMOCK_INTERNAL_PARAMETER(_i, _Signature, _) \ |
| 225 |
GMOCK_PP_COMMA_IF(_i) \ |
| 226 |
GMOCK_INTERNAL_ARG_O(typename, GMOCK_PP_INC(_i), \ |
| 227 |
GMOCK_PP_REMOVE_PARENS(_Signature)) \ |
| 228 |
gmock_a##_i |
| 229 |
|
| 230 |
#define GMOCK_INTERNAL_FORWARD_ARG(_i, _Signature, _) \ |
| 231 |
GMOCK_PP_COMMA_IF(_i) \ |
| 232 |
::std::forward<GMOCK_INTERNAL_ARG_O(typename, GMOCK_PP_INC(_i), \ |
| 233 |
GMOCK_PP_REMOVE_PARENS(_Signature))>( \ |
| 234 |
gmock_a##_i) |
| 235 |
|
| 236 |
#define GMOCK_INTERNAL_MATCHER_PARAMETER(_i, _Signature, _) \ |
| 237 |
GMOCK_PP_COMMA_IF(_i) \ |
| 238 |
GMOCK_INTERNAL_MATCHER_O(typename, GMOCK_PP_INC(_i), \ |
| 239 |
GMOCK_PP_REMOVE_PARENS(_Signature)) \ |
| 240 |
gmock_a##_i |
| 241 |
|
| 242 |
#define GMOCK_INTERNAL_MATCHER_ARGUMENT(_i, _1, _2) \ |
| 243 |
GMOCK_PP_COMMA_IF(_i) \ |
| 244 |
gmock_a##_i |
| 245 |
|
| 246 |
#define GMOCK_INTERNAL_A_MATCHER_ARGUMENT(_i, _Signature, _) \ |
| 247 |
GMOCK_PP_COMMA_IF(_i) \ |
| 248 |
::testing::A<GMOCK_INTERNAL_ARG_O(typename, GMOCK_PP_INC(_i), \ |
| 249 |
GMOCK_PP_REMOVE_PARENS(_Signature))>() |
| 250 |
|
| 251 |
#define GMOCK_INTERNAL_ARG_O(_tn, _i, ...) GMOCK_ARG_(_tn, _i, __VA_ARGS__) |
| 252 |
|
| 253 |
#define GMOCK_INTERNAL_MATCHER_O(_tn, _i, ...) \ |
| 254 |
GMOCK_MATCHER_(_tn, _i, __VA_ARGS__) |
| 255 |
|
| 256 |
#endif // THIRD_PARTY_GOOGLETEST_GOOGLEMOCK_INCLUDE_GMOCK_INTERNAL_GMOCK_FUNCTION_MOCKER_H_ |