2 $$ This is a Pump source file. Please use Pump to convert it to
3 $$ gmock-generated-function-mockers.h.
5 $var n = 10 $$ The maximum arity we support.
6 // Copyright 2007, Google Inc.
7 // All rights reserved.
9 // Redistribution and use in source and binary forms, with or without
10 // modification, are permitted provided that the following conditions are
13 // * Redistributions of source code must retain the above copyright
14 // notice, this list of conditions and the following disclaimer.
15 // * Redistributions in binary form must reproduce the above
16 // copyright notice, this list of conditions and the following disclaimer
17 // in the documentation and/or other materials provided with the
19 // * Neither the name of Google Inc. nor the names of its
20 // contributors may be used to endorse or promote products derived from
21 // this software without specific prior written permission.
23 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
24 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
25 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
26 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
27 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
28 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
29 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
30 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
31 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
32 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
33 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
35 // Author: wan@google.com (Zhanyong Wan)
37 // Google Mock - a framework for writing C++ mock classes.
39 // This file implements function mockers of various arities.
41 #ifndef GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_
42 #define GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_
44 #include <gmock/gmock-spec-builders.h>
45 #include <gmock/internal/gmock-internal-utils.h>
55 class FunctionMockerBase;
57 // Note: class FunctionMocker really belongs to the ::testing
58 // namespace. However if we define it in ::testing, MSVC will
59 // complain when classes in ::testing::internal declare it as a
60 // friend class template. To workaround this compiler bug, we define
61 // FunctionMocker in ::testing::internal and import it into ::testing.
69 $var typename_As = [[$for j [[, typename A$j]]]]
70 $var As = [[$for j, [[A$j]]]]
71 $var as = [[$for j, [[a$j]]]]
72 $var Aas = [[$for j, [[A$j a$j]]]]
73 $var ms = [[$for j, [[m$j]]]]
74 $var matchers = [[$for j, [[const Matcher<A$j>& m$j]]]]
75 template <typename R$typename_As>
76 class FunctionMocker<R($As)> : public
77 internal::FunctionMockerBase<R($As)> {
80 typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple;
82 MockSpec<F>& With($matchers) {
85 this->current_spec().SetMatchers(::std::tr1::make_tuple($ms));
88 return this->current_spec();
92 return InvokeWith(ArgumentTuple($as));
98 } // namespace internal
100 // The style guide prohibits "using" statements in a namespace scope
101 // inside a header file. However, the FunctionMocker class template
102 // is meant to be defined in the ::testing namespace. The following
103 // line is just a trick for working around a bug in MSVC 8.0, which
104 // cannot handle it if we define FunctionMocker in ::testing.
105 using internal::FunctionMocker;
107 // The result type of function type F.
108 // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!!
109 #define GMOCK_RESULT_(tn, F) tn ::testing::internal::Function<F>::Result
111 // The type of argument N of function type F.
112 // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!!
113 #define GMOCK_ARG_(tn, F, N) tn ::testing::internal::Function<F>::Argument##N
115 // The matcher type for argument N of function type F.
116 // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!!
117 #define GMOCK_MATCHER_(tn, F, N) const ::testing::Matcher<GMOCK_ARG_(tn, F, N)>&
119 // The variable for mocking the given method.
120 // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!!
121 #define GMOCK_MOCKER_(arity, constness, Method) \
122 GMOCK_CONCAT_TOKEN_(gmock##constness##arity##_##Method##_, __LINE__)
127 $var arg_as = [[$for j, \
128 [[GMOCK_ARG_(tn, F, $j) gmock_a$j]]]]
129 $var as = [[$for j, [[gmock_a$j]]]]
130 $var matcher_as = [[$for j, \
131 [[GMOCK_MATCHER_(tn, F, $j) gmock_a$j]]]]
132 // INTERNAL IMPLEMENTATION - DON'T USE IN USER CODE!!!
133 #define GMOCK_METHOD$i[[]]_(tn, constness, ct, Method, F) \
134 GMOCK_RESULT_(tn, F) ct Method($arg_as) constness { \
135 GMOCK_COMPILE_ASSERT_(::std::tr1::tuple_size< \
136 tn ::testing::internal::Function<F>::ArgumentTuple>::value == $i, \
137 this_method_does_not_take_$i[[]]_argument[[$if i != 1 [[s]]]]); \
138 GMOCK_MOCKER_($i, constness, Method).SetOwnerAndName(this, #Method); \
139 return GMOCK_MOCKER_($i, constness, Method).Invoke($as); \
141 ::testing::MockSpec<F>& \
142 gmock_##Method($matcher_as) constness { \
143 return GMOCK_MOCKER_($i, constness, Method).RegisterOwner(this).With($as); \
145 mutable ::testing::FunctionMocker<F> GMOCK_MOCKER_($i, constness, Method)
150 #define MOCK_METHOD$i(m, F) GMOCK_METHOD$i[[]]_(, , , m, F)
156 #define MOCK_CONST_METHOD$i(m, F) GMOCK_METHOD$i[[]]_(, const, , m, F)
162 #define MOCK_METHOD$i[[]]_T(m, F) GMOCK_METHOD$i[[]]_(typename, , , m, F)
168 #define MOCK_CONST_METHOD$i[[]]_T(m, F) [[]]
169 GMOCK_METHOD$i[[]]_(typename, const, , m, F)
175 #define MOCK_METHOD$i[[]]_WITH_CALLTYPE(ct, m, F) [[]]
176 GMOCK_METHOD$i[[]]_(, , ct, m, F)
182 #define MOCK_CONST_METHOD$i[[]]_WITH_CALLTYPE(ct, m, F) \
183 GMOCK_METHOD$i[[]]_(, const, ct, m, F)
189 #define MOCK_METHOD$i[[]]_T_WITH_CALLTYPE(ct, m, F) \
190 GMOCK_METHOD$i[[]]_(typename, , ct, m, F)
196 #define MOCK_CONST_METHOD$i[[]]_T_WITH_CALLTYPE(ct, m, F) \
197 GMOCK_METHOD$i[[]]_(typename, const, ct, m, F)
201 } // namespace testing
203 #endif // GMOCK_INCLUDE_GMOCK_GMOCK_GENERATED_FUNCTION_MOCKERS_H_