1*481dde66SAndroid Build Coastguard Worker // Copyright 2007, Google Inc. 2*481dde66SAndroid Build Coastguard Worker // All rights reserved. 3*481dde66SAndroid Build Coastguard Worker // 4*481dde66SAndroid Build Coastguard Worker // Redistribution and use in source and binary forms, with or without 5*481dde66SAndroid Build Coastguard Worker // modification, are permitted provided that the following conditions are 6*481dde66SAndroid Build Coastguard Worker // met: 7*481dde66SAndroid Build Coastguard Worker // 8*481dde66SAndroid Build Coastguard Worker // * Redistributions of source code must retain the above copyright 9*481dde66SAndroid Build Coastguard Worker // notice, this list of conditions and the following disclaimer. 10*481dde66SAndroid Build Coastguard Worker // * Redistributions in binary form must reproduce the above 11*481dde66SAndroid Build Coastguard Worker // copyright notice, this list of conditions and the following disclaimer 12*481dde66SAndroid Build Coastguard Worker // in the documentation and/or other materials provided with the 13*481dde66SAndroid Build Coastguard Worker // distribution. 14*481dde66SAndroid Build Coastguard Worker // * Neither the name of Google Inc. nor the names of its 15*481dde66SAndroid Build Coastguard Worker // contributors may be used to endorse or promote products derived from 16*481dde66SAndroid Build Coastguard Worker // this software without specific prior written permission. 17*481dde66SAndroid Build Coastguard Worker // 18*481dde66SAndroid Build Coastguard Worker // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 19*481dde66SAndroid Build Coastguard Worker // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 20*481dde66SAndroid Build Coastguard Worker // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 21*481dde66SAndroid Build Coastguard Worker // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 22*481dde66SAndroid Build Coastguard Worker // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 23*481dde66SAndroid Build Coastguard Worker // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 24*481dde66SAndroid Build Coastguard Worker // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 25*481dde66SAndroid Build Coastguard Worker // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 26*481dde66SAndroid Build Coastguard Worker // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 27*481dde66SAndroid Build Coastguard Worker // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 28*481dde66SAndroid Build Coastguard Worker // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 29*481dde66SAndroid Build Coastguard Worker 30*481dde66SAndroid Build Coastguard Worker // Google Mock - a framework for writing C++ mock classes. 31*481dde66SAndroid Build Coastguard Worker // 32*481dde66SAndroid Build Coastguard Worker // The ACTION* family of macros can be used in a namespace scope to 33*481dde66SAndroid Build Coastguard Worker // define custom actions easily. The syntax: 34*481dde66SAndroid Build Coastguard Worker // 35*481dde66SAndroid Build Coastguard Worker // ACTION(name) { statements; } 36*481dde66SAndroid Build Coastguard Worker // 37*481dde66SAndroid Build Coastguard Worker // will define an action with the given name that executes the 38*481dde66SAndroid Build Coastguard Worker // statements. The value returned by the statements will be used as 39*481dde66SAndroid Build Coastguard Worker // the return value of the action. Inside the statements, you can 40*481dde66SAndroid Build Coastguard Worker // refer to the K-th (0-based) argument of the mock function by 41*481dde66SAndroid Build Coastguard Worker // 'argK', and refer to its type by 'argK_type'. For example: 42*481dde66SAndroid Build Coastguard Worker // 43*481dde66SAndroid Build Coastguard Worker // ACTION(IncrementArg1) { 44*481dde66SAndroid Build Coastguard Worker // arg1_type temp = arg1; 45*481dde66SAndroid Build Coastguard Worker // return ++(*temp); 46*481dde66SAndroid Build Coastguard Worker // } 47*481dde66SAndroid Build Coastguard Worker // 48*481dde66SAndroid Build Coastguard Worker // allows you to write 49*481dde66SAndroid Build Coastguard Worker // 50*481dde66SAndroid Build Coastguard Worker // ...WillOnce(IncrementArg1()); 51*481dde66SAndroid Build Coastguard Worker // 52*481dde66SAndroid Build Coastguard Worker // You can also refer to the entire argument tuple and its type by 53*481dde66SAndroid Build Coastguard Worker // 'args' and 'args_type', and refer to the mock function type and its 54*481dde66SAndroid Build Coastguard Worker // return type by 'function_type' and 'return_type'. 55*481dde66SAndroid Build Coastguard Worker // 56*481dde66SAndroid Build Coastguard Worker // Note that you don't need to specify the types of the mock function 57*481dde66SAndroid Build Coastguard Worker // arguments. However rest assured that your code is still type-safe: 58*481dde66SAndroid Build Coastguard Worker // you'll get a compiler error if *arg1 doesn't support the ++ 59*481dde66SAndroid Build Coastguard Worker // operator, or if the type of ++(*arg1) isn't compatible with the 60*481dde66SAndroid Build Coastguard Worker // mock function's return type, for example. 61*481dde66SAndroid Build Coastguard Worker // 62*481dde66SAndroid Build Coastguard Worker // Sometimes you'll want to parameterize the action. For that you can use 63*481dde66SAndroid Build Coastguard Worker // another macro: 64*481dde66SAndroid Build Coastguard Worker // 65*481dde66SAndroid Build Coastguard Worker // ACTION_P(name, param_name) { statements; } 66*481dde66SAndroid Build Coastguard Worker // 67*481dde66SAndroid Build Coastguard Worker // For example: 68*481dde66SAndroid Build Coastguard Worker // 69*481dde66SAndroid Build Coastguard Worker // ACTION_P(Add, n) { return arg0 + n; } 70*481dde66SAndroid Build Coastguard Worker // 71*481dde66SAndroid Build Coastguard Worker // will allow you to write: 72*481dde66SAndroid Build Coastguard Worker // 73*481dde66SAndroid Build Coastguard Worker // ...WillOnce(Add(5)); 74*481dde66SAndroid Build Coastguard Worker // 75*481dde66SAndroid Build Coastguard Worker // Note that you don't need to provide the type of the parameter 76*481dde66SAndroid Build Coastguard Worker // either. If you need to reference the type of a parameter named 77*481dde66SAndroid Build Coastguard Worker // 'foo', you can write 'foo_type'. For example, in the body of 78*481dde66SAndroid Build Coastguard Worker // ACTION_P(Add, n) above, you can write 'n_type' to refer to the type 79*481dde66SAndroid Build Coastguard Worker // of 'n'. 80*481dde66SAndroid Build Coastguard Worker // 81*481dde66SAndroid Build Coastguard Worker // We also provide ACTION_P2, ACTION_P3, ..., up to ACTION_P10 to support 82*481dde66SAndroid Build Coastguard Worker // multi-parameter actions. 83*481dde66SAndroid Build Coastguard Worker // 84*481dde66SAndroid Build Coastguard Worker // For the purpose of typing, you can view 85*481dde66SAndroid Build Coastguard Worker // 86*481dde66SAndroid Build Coastguard Worker // ACTION_Pk(Foo, p1, ..., pk) { ... } 87*481dde66SAndroid Build Coastguard Worker // 88*481dde66SAndroid Build Coastguard Worker // as shorthand for 89*481dde66SAndroid Build Coastguard Worker // 90*481dde66SAndroid Build Coastguard Worker // template <typename p1_type, ..., typename pk_type> 91*481dde66SAndroid Build Coastguard Worker // FooActionPk<p1_type, ..., pk_type> Foo(p1_type p1, ..., pk_type pk) { ... } 92*481dde66SAndroid Build Coastguard Worker // 93*481dde66SAndroid Build Coastguard Worker // In particular, you can provide the template type arguments 94*481dde66SAndroid Build Coastguard Worker // explicitly when invoking Foo(), as in Foo<long, bool>(5, false); 95*481dde66SAndroid Build Coastguard Worker // although usually you can rely on the compiler to infer the types 96*481dde66SAndroid Build Coastguard Worker // for you automatically. You can assign the result of expression 97*481dde66SAndroid Build Coastguard Worker // Foo(p1, ..., pk) to a variable of type FooActionPk<p1_type, ..., 98*481dde66SAndroid Build Coastguard Worker // pk_type>. This can be useful when composing actions. 99*481dde66SAndroid Build Coastguard Worker // 100*481dde66SAndroid Build Coastguard Worker // You can also overload actions with different numbers of parameters: 101*481dde66SAndroid Build Coastguard Worker // 102*481dde66SAndroid Build Coastguard Worker // ACTION_P(Plus, a) { ... } 103*481dde66SAndroid Build Coastguard Worker // ACTION_P2(Plus, a, b) { ... } 104*481dde66SAndroid Build Coastguard Worker // 105*481dde66SAndroid Build Coastguard Worker // While it's tempting to always use the ACTION* macros when defining 106*481dde66SAndroid Build Coastguard Worker // a new action, you should also consider implementing ActionInterface 107*481dde66SAndroid Build Coastguard Worker // or using MakePolymorphicAction() instead, especially if you need to 108*481dde66SAndroid Build Coastguard Worker // use the action a lot. While these approaches require more work, 109*481dde66SAndroid Build Coastguard Worker // they give you more control on the types of the mock function 110*481dde66SAndroid Build Coastguard Worker // arguments and the action parameters, which in general leads to 111*481dde66SAndroid Build Coastguard Worker // better compiler error messages that pay off in the long run. They 112*481dde66SAndroid Build Coastguard Worker // also allow overloading actions based on parameter types (as opposed 113*481dde66SAndroid Build Coastguard Worker // to just based on the number of parameters). 114*481dde66SAndroid Build Coastguard Worker // 115*481dde66SAndroid Build Coastguard Worker // CAVEAT: 116*481dde66SAndroid Build Coastguard Worker // 117*481dde66SAndroid Build Coastguard Worker // ACTION*() can only be used in a namespace scope as templates cannot be 118*481dde66SAndroid Build Coastguard Worker // declared inside of a local class. 119*481dde66SAndroid Build Coastguard Worker // Users can, however, define any local functors (e.g. a lambda) that 120*481dde66SAndroid Build Coastguard Worker // can be used as actions. 121*481dde66SAndroid Build Coastguard Worker // 122*481dde66SAndroid Build Coastguard Worker // MORE INFORMATION: 123*481dde66SAndroid Build Coastguard Worker // 124*481dde66SAndroid Build Coastguard Worker // To learn more about using these macros, please search for 'ACTION' on 125*481dde66SAndroid Build Coastguard Worker // https://github.com/google/googletest/blob/main/docs/gmock_cook_book.md 126*481dde66SAndroid Build Coastguard Worker 127*481dde66SAndroid Build Coastguard Worker // IWYU pragma: private, include "gmock/gmock.h" 128*481dde66SAndroid Build Coastguard Worker // IWYU pragma: friend gmock/.* 129*481dde66SAndroid Build Coastguard Worker 130*481dde66SAndroid Build Coastguard Worker #ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ 131*481dde66SAndroid Build Coastguard Worker #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ 132*481dde66SAndroid Build Coastguard Worker 133*481dde66SAndroid Build Coastguard Worker #ifndef _WIN32_WCE 134*481dde66SAndroid Build Coastguard Worker #include <errno.h> 135*481dde66SAndroid Build Coastguard Worker #endif 136*481dde66SAndroid Build Coastguard Worker 137*481dde66SAndroid Build Coastguard Worker #include <algorithm> 138*481dde66SAndroid Build Coastguard Worker #include <exception> 139*481dde66SAndroid Build Coastguard Worker #include <functional> 140*481dde66SAndroid Build Coastguard Worker #include <memory> 141*481dde66SAndroid Build Coastguard Worker #include <string> 142*481dde66SAndroid Build Coastguard Worker #include <tuple> 143*481dde66SAndroid Build Coastguard Worker #include <type_traits> 144*481dde66SAndroid Build Coastguard Worker #include <utility> 145*481dde66SAndroid Build Coastguard Worker 146*481dde66SAndroid Build Coastguard Worker #include "gmock/internal/gmock-internal-utils.h" 147*481dde66SAndroid Build Coastguard Worker #include "gmock/internal/gmock-port.h" 148*481dde66SAndroid Build Coastguard Worker #include "gmock/internal/gmock-pp.h" 149*481dde66SAndroid Build Coastguard Worker 150*481dde66SAndroid Build Coastguard Worker GTEST_DISABLE_MSC_WARNINGS_PUSH_(4100) 151*481dde66SAndroid Build Coastguard Worker 152*481dde66SAndroid Build Coastguard Worker namespace testing { 153*481dde66SAndroid Build Coastguard Worker 154*481dde66SAndroid Build Coastguard Worker // To implement an action Foo, define: 155*481dde66SAndroid Build Coastguard Worker // 1. a class FooAction that implements the ActionInterface interface, and 156*481dde66SAndroid Build Coastguard Worker // 2. a factory function that creates an Action object from a 157*481dde66SAndroid Build Coastguard Worker // const FooAction*. 158*481dde66SAndroid Build Coastguard Worker // 159*481dde66SAndroid Build Coastguard Worker // The two-level delegation design follows that of Matcher, providing 160*481dde66SAndroid Build Coastguard Worker // consistency for extension developers. It also eases ownership 161*481dde66SAndroid Build Coastguard Worker // management as Action objects can now be copied like plain values. 162*481dde66SAndroid Build Coastguard Worker 163*481dde66SAndroid Build Coastguard Worker namespace internal { 164*481dde66SAndroid Build Coastguard Worker 165*481dde66SAndroid Build Coastguard Worker // BuiltInDefaultValueGetter<T, true>::Get() returns a 166*481dde66SAndroid Build Coastguard Worker // default-constructed T value. BuiltInDefaultValueGetter<T, 167*481dde66SAndroid Build Coastguard Worker // false>::Get() crashes with an error. 168*481dde66SAndroid Build Coastguard Worker // 169*481dde66SAndroid Build Coastguard Worker // This primary template is used when kDefaultConstructible is true. 170*481dde66SAndroid Build Coastguard Worker template <typename T, bool kDefaultConstructible> 171*481dde66SAndroid Build Coastguard Worker struct BuiltInDefaultValueGetter { GetBuiltInDefaultValueGetter172*481dde66SAndroid Build Coastguard Worker static T Get() { return T(); } 173*481dde66SAndroid Build Coastguard Worker }; 174*481dde66SAndroid Build Coastguard Worker template <typename T> 175*481dde66SAndroid Build Coastguard Worker struct BuiltInDefaultValueGetter<T, false> { 176*481dde66SAndroid Build Coastguard Worker static T Get() { 177*481dde66SAndroid Build Coastguard Worker Assert(false, __FILE__, __LINE__, 178*481dde66SAndroid Build Coastguard Worker "Default action undefined for the function return type."); 179*481dde66SAndroid Build Coastguard Worker #if defined(__GNUC__) || defined(__clang__) 180*481dde66SAndroid Build Coastguard Worker __builtin_unreachable(); 181*481dde66SAndroid Build Coastguard Worker #elif defined(_MSC_VER) 182*481dde66SAndroid Build Coastguard Worker __assume(0); 183*481dde66SAndroid Build Coastguard Worker #else 184*481dde66SAndroid Build Coastguard Worker return Invalid<T>(); 185*481dde66SAndroid Build Coastguard Worker // The above statement will never be reached, but is required in 186*481dde66SAndroid Build Coastguard Worker // order for this function to compile. 187*481dde66SAndroid Build Coastguard Worker #endif 188*481dde66SAndroid Build Coastguard Worker } 189*481dde66SAndroid Build Coastguard Worker }; 190*481dde66SAndroid Build Coastguard Worker 191*481dde66SAndroid Build Coastguard Worker // BuiltInDefaultValue<T>::Get() returns the "built-in" default value 192*481dde66SAndroid Build Coastguard Worker // for type T, which is NULL when T is a raw pointer type, 0 when T is 193*481dde66SAndroid Build Coastguard Worker // a numeric type, false when T is bool, or "" when T is string or 194*481dde66SAndroid Build Coastguard Worker // std::string. In addition, in C++11 and above, it turns a 195*481dde66SAndroid Build Coastguard Worker // default-constructed T value if T is default constructible. For any 196*481dde66SAndroid Build Coastguard Worker // other type T, the built-in default T value is undefined, and the 197*481dde66SAndroid Build Coastguard Worker // function will abort the process. 198*481dde66SAndroid Build Coastguard Worker template <typename T> 199*481dde66SAndroid Build Coastguard Worker class BuiltInDefaultValue { 200*481dde66SAndroid Build Coastguard Worker public: 201*481dde66SAndroid Build Coastguard Worker // This function returns true if and only if type T has a built-in default 202*481dde66SAndroid Build Coastguard Worker // value. 203*481dde66SAndroid Build Coastguard Worker static bool Exists() { return ::std::is_default_constructible<T>::value; } 204*481dde66SAndroid Build Coastguard Worker 205*481dde66SAndroid Build Coastguard Worker static T Get() { 206*481dde66SAndroid Build Coastguard Worker return BuiltInDefaultValueGetter< 207*481dde66SAndroid Build Coastguard Worker T, ::std::is_default_constructible<T>::value>::Get(); 208*481dde66SAndroid Build Coastguard Worker } 209*481dde66SAndroid Build Coastguard Worker }; 210*481dde66SAndroid Build Coastguard Worker 211*481dde66SAndroid Build Coastguard Worker // This partial specialization says that we use the same built-in 212*481dde66SAndroid Build Coastguard Worker // default value for T and const T. 213*481dde66SAndroid Build Coastguard Worker template <typename T> 214*481dde66SAndroid Build Coastguard Worker class BuiltInDefaultValue<const T> { 215*481dde66SAndroid Build Coastguard Worker public: 216*481dde66SAndroid Build Coastguard Worker static bool Exists() { return BuiltInDefaultValue<T>::Exists(); } 217*481dde66SAndroid Build Coastguard Worker static T Get() { return BuiltInDefaultValue<T>::Get(); } 218*481dde66SAndroid Build Coastguard Worker }; 219*481dde66SAndroid Build Coastguard Worker 220*481dde66SAndroid Build Coastguard Worker // This partial specialization defines the default values for pointer 221*481dde66SAndroid Build Coastguard Worker // types. 222*481dde66SAndroid Build Coastguard Worker template <typename T> 223*481dde66SAndroid Build Coastguard Worker class BuiltInDefaultValue<T*> { 224*481dde66SAndroid Build Coastguard Worker public: 225*481dde66SAndroid Build Coastguard Worker static bool Exists() { return true; } 226*481dde66SAndroid Build Coastguard Worker static T* Get() { return nullptr; } 227*481dde66SAndroid Build Coastguard Worker }; 228*481dde66SAndroid Build Coastguard Worker 229*481dde66SAndroid Build Coastguard Worker // The following specializations define the default values for 230*481dde66SAndroid Build Coastguard Worker // specific types we care about. 231*481dde66SAndroid Build Coastguard Worker #define GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(type, value) \ 232*481dde66SAndroid Build Coastguard Worker template <> \ 233*481dde66SAndroid Build Coastguard Worker class BuiltInDefaultValue<type> { \ 234*481dde66SAndroid Build Coastguard Worker public: \ 235*481dde66SAndroid Build Coastguard Worker static bool Exists() { return true; } \ 236*481dde66SAndroid Build Coastguard Worker static type Get() { return value; } \ 237*481dde66SAndroid Build Coastguard Worker } 238*481dde66SAndroid Build Coastguard Worker 239*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(void, ); // NOLINT 240*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(::std::string, ""); 241*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(bool, false); 242*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned char, '\0'); 243*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed char, '\0'); 244*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(char, '\0'); 245*481dde66SAndroid Build Coastguard Worker 246*481dde66SAndroid Build Coastguard Worker // There's no need for a default action for signed wchar_t, as that 247*481dde66SAndroid Build Coastguard Worker // type is the same as wchar_t for gcc, and invalid for MSVC. 248*481dde66SAndroid Build Coastguard Worker // 249*481dde66SAndroid Build Coastguard Worker // There's also no need for a default action for unsigned wchar_t, as 250*481dde66SAndroid Build Coastguard Worker // that type is the same as unsigned int for gcc, and invalid for 251*481dde66SAndroid Build Coastguard Worker // MSVC. 252*481dde66SAndroid Build Coastguard Worker #if GMOCK_WCHAR_T_IS_NATIVE_ 253*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(wchar_t, 0U); // NOLINT 254*481dde66SAndroid Build Coastguard Worker #endif 255*481dde66SAndroid Build Coastguard Worker 256*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned short, 0U); // NOLINT 257*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed short, 0); // NOLINT 258*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned int, 0U); 259*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed int, 0); 260*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned long, 0UL); // NOLINT 261*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed long, 0L); // NOLINT 262*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(unsigned long long, 0); // NOLINT 263*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(signed long long, 0); // NOLINT 264*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(float, 0); 265*481dde66SAndroid Build Coastguard Worker GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_(double, 0); 266*481dde66SAndroid Build Coastguard Worker 267*481dde66SAndroid Build Coastguard Worker #undef GMOCK_DEFINE_DEFAULT_ACTION_FOR_RETURN_TYPE_ 268*481dde66SAndroid Build Coastguard Worker 269*481dde66SAndroid Build Coastguard Worker // Partial implementations of metaprogramming types from the standard library 270*481dde66SAndroid Build Coastguard Worker // not available in C++11. 271*481dde66SAndroid Build Coastguard Worker 272*481dde66SAndroid Build Coastguard Worker template <typename P> 273*481dde66SAndroid Build Coastguard Worker struct negation 274*481dde66SAndroid Build Coastguard Worker // NOLINTNEXTLINE 275*481dde66SAndroid Build Coastguard Worker : std::integral_constant<bool, bool(!P::value)> {}; 276*481dde66SAndroid Build Coastguard Worker 277*481dde66SAndroid Build Coastguard Worker // Base case: with zero predicates the answer is always true. 278*481dde66SAndroid Build Coastguard Worker template <typename...> 279*481dde66SAndroid Build Coastguard Worker struct conjunction : std::true_type {}; 280*481dde66SAndroid Build Coastguard Worker 281*481dde66SAndroid Build Coastguard Worker // With a single predicate, the answer is that predicate. 282*481dde66SAndroid Build Coastguard Worker template <typename P1> 283*481dde66SAndroid Build Coastguard Worker struct conjunction<P1> : P1 {}; 284*481dde66SAndroid Build Coastguard Worker 285*481dde66SAndroid Build Coastguard Worker // With multiple predicates the answer is the first predicate if that is false, 286*481dde66SAndroid Build Coastguard Worker // and we recurse otherwise. 287*481dde66SAndroid Build Coastguard Worker template <typename P1, typename... Ps> 288*481dde66SAndroid Build Coastguard Worker struct conjunction<P1, Ps...> 289*481dde66SAndroid Build Coastguard Worker : std::conditional<bool(P1::value), conjunction<Ps...>, P1>::type {}; 290*481dde66SAndroid Build Coastguard Worker 291*481dde66SAndroid Build Coastguard Worker template <typename...> 292*481dde66SAndroid Build Coastguard Worker struct disjunction : std::false_type {}; 293*481dde66SAndroid Build Coastguard Worker 294*481dde66SAndroid Build Coastguard Worker template <typename P1> 295*481dde66SAndroid Build Coastguard Worker struct disjunction<P1> : P1 {}; 296*481dde66SAndroid Build Coastguard Worker 297*481dde66SAndroid Build Coastguard Worker template <typename P1, typename... Ps> 298*481dde66SAndroid Build Coastguard Worker struct disjunction<P1, Ps...> 299*481dde66SAndroid Build Coastguard Worker // NOLINTNEXTLINE 300*481dde66SAndroid Build Coastguard Worker : std::conditional<!bool(P1::value), disjunction<Ps...>, P1>::type {}; 301*481dde66SAndroid Build Coastguard Worker 302*481dde66SAndroid Build Coastguard Worker template <typename...> 303*481dde66SAndroid Build Coastguard Worker using void_t = void; 304*481dde66SAndroid Build Coastguard Worker 305*481dde66SAndroid Build Coastguard Worker // Detects whether an expression of type `From` can be implicitly converted to 306*481dde66SAndroid Build Coastguard Worker // `To` according to [conv]. In C++17, [conv]/3 defines this as follows: 307*481dde66SAndroid Build Coastguard Worker // 308*481dde66SAndroid Build Coastguard Worker // An expression e can be implicitly converted to a type T if and only if 309*481dde66SAndroid Build Coastguard Worker // the declaration T t=e; is well-formed, for some invented temporary 310*481dde66SAndroid Build Coastguard Worker // variable t ([dcl.init]). 311*481dde66SAndroid Build Coastguard Worker // 312*481dde66SAndroid Build Coastguard Worker // [conv]/2 implies we can use function argument passing to detect whether this 313*481dde66SAndroid Build Coastguard Worker // initialization is valid. 314*481dde66SAndroid Build Coastguard Worker // 315*481dde66SAndroid Build Coastguard Worker // Note that this is distinct from is_convertible, which requires this be valid: 316*481dde66SAndroid Build Coastguard Worker // 317*481dde66SAndroid Build Coastguard Worker // To test() { 318*481dde66SAndroid Build Coastguard Worker // return declval<From>(); 319*481dde66SAndroid Build Coastguard Worker // } 320*481dde66SAndroid Build Coastguard Worker // 321*481dde66SAndroid Build Coastguard Worker // In particular, is_convertible doesn't give the correct answer when `To` and 322*481dde66SAndroid Build Coastguard Worker // `From` are the same non-moveable type since `declval<From>` will be an rvalue 323*481dde66SAndroid Build Coastguard Worker // reference, defeating the guaranteed copy elision that would otherwise make 324*481dde66SAndroid Build Coastguard Worker // this function work. 325*481dde66SAndroid Build Coastguard Worker // 326*481dde66SAndroid Build Coastguard Worker // REQUIRES: `From` is not cv void. 327*481dde66SAndroid Build Coastguard Worker template <typename From, typename To> 328*481dde66SAndroid Build Coastguard Worker struct is_implicitly_convertible { 329*481dde66SAndroid Build Coastguard Worker private: 330*481dde66SAndroid Build Coastguard Worker // A function that accepts a parameter of type T. This can be called with type 331*481dde66SAndroid Build Coastguard Worker // U successfully only if U is implicitly convertible to T. 332*481dde66SAndroid Build Coastguard Worker template <typename T> 333*481dde66SAndroid Build Coastguard Worker static void Accept(T); 334*481dde66SAndroid Build Coastguard Worker 335*481dde66SAndroid Build Coastguard Worker // A function that creates a value of type T. 336*481dde66SAndroid Build Coastguard Worker template <typename T> 337*481dde66SAndroid Build Coastguard Worker static T Make(); 338*481dde66SAndroid Build Coastguard Worker 339*481dde66SAndroid Build Coastguard Worker // An overload be selected when implicit conversion from T to To is possible. 340*481dde66SAndroid Build Coastguard Worker template <typename T, typename = decltype(Accept<To>(Make<T>()))> 341*481dde66SAndroid Build Coastguard Worker static std::true_type TestImplicitConversion(int); 342*481dde66SAndroid Build Coastguard Worker 343*481dde66SAndroid Build Coastguard Worker // A fallback overload selected in all other cases. 344*481dde66SAndroid Build Coastguard Worker template <typename T> 345*481dde66SAndroid Build Coastguard Worker static std::false_type TestImplicitConversion(...); 346*481dde66SAndroid Build Coastguard Worker 347*481dde66SAndroid Build Coastguard Worker public: 348*481dde66SAndroid Build Coastguard Worker using type = decltype(TestImplicitConversion<From>(0)); 349*481dde66SAndroid Build Coastguard Worker static constexpr bool value = type::value; 350*481dde66SAndroid Build Coastguard Worker }; 351*481dde66SAndroid Build Coastguard Worker 352*481dde66SAndroid Build Coastguard Worker // Like std::invoke_result_t from C++17, but works only for objects with call 353*481dde66SAndroid Build Coastguard Worker // operators (not e.g. member function pointers, which we don't need specific 354*481dde66SAndroid Build Coastguard Worker // support for in OnceAction because std::function deals with them). 355*481dde66SAndroid Build Coastguard Worker template <typename F, typename... Args> 356*481dde66SAndroid Build Coastguard Worker using call_result_t = decltype(std::declval<F>()(std::declval<Args>()...)); 357*481dde66SAndroid Build Coastguard Worker 358*481dde66SAndroid Build Coastguard Worker template <typename Void, typename R, typename F, typename... Args> 359*481dde66SAndroid Build Coastguard Worker struct is_callable_r_impl : std::false_type {}; 360*481dde66SAndroid Build Coastguard Worker 361*481dde66SAndroid Build Coastguard Worker // Specialize the struct for those template arguments where call_result_t is 362*481dde66SAndroid Build Coastguard Worker // well-formed. When it's not, the generic template above is chosen, resulting 363*481dde66SAndroid Build Coastguard Worker // in std::false_type. 364*481dde66SAndroid Build Coastguard Worker template <typename R, typename F, typename... Args> 365*481dde66SAndroid Build Coastguard Worker struct is_callable_r_impl<void_t<call_result_t<F, Args...>>, R, F, Args...> 366*481dde66SAndroid Build Coastguard Worker : std::conditional< 367*481dde66SAndroid Build Coastguard Worker std::is_void<R>::value, // 368*481dde66SAndroid Build Coastguard Worker std::true_type, // 369*481dde66SAndroid Build Coastguard Worker is_implicitly_convertible<call_result_t<F, Args...>, R>>::type {}; 370*481dde66SAndroid Build Coastguard Worker 371*481dde66SAndroid Build Coastguard Worker // Like std::is_invocable_r from C++17, but works only for objects with call 372*481dde66SAndroid Build Coastguard Worker // operators. See the note on call_result_t. 373*481dde66SAndroid Build Coastguard Worker template <typename R, typename F, typename... Args> 374*481dde66SAndroid Build Coastguard Worker using is_callable_r = is_callable_r_impl<void, R, F, Args...>; 375*481dde66SAndroid Build Coastguard Worker 376*481dde66SAndroid Build Coastguard Worker // Like std::as_const from C++17. 377*481dde66SAndroid Build Coastguard Worker template <typename T> 378*481dde66SAndroid Build Coastguard Worker typename std::add_const<T>::type& as_const(T& t) { 379*481dde66SAndroid Build Coastguard Worker return t; 380*481dde66SAndroid Build Coastguard Worker } 381*481dde66SAndroid Build Coastguard Worker 382*481dde66SAndroid Build Coastguard Worker } // namespace internal 383*481dde66SAndroid Build Coastguard Worker 384*481dde66SAndroid Build Coastguard Worker // Specialized for function types below. 385*481dde66SAndroid Build Coastguard Worker template <typename F> 386*481dde66SAndroid Build Coastguard Worker class OnceAction; 387*481dde66SAndroid Build Coastguard Worker 388*481dde66SAndroid Build Coastguard Worker // An action that can only be used once. 389*481dde66SAndroid Build Coastguard Worker // 390*481dde66SAndroid Build Coastguard Worker // This is accepted by WillOnce, which doesn't require the underlying action to 391*481dde66SAndroid Build Coastguard Worker // be copy-constructible (only move-constructible), and promises to invoke it as 392*481dde66SAndroid Build Coastguard Worker // an rvalue reference. This allows the action to work with move-only types like 393*481dde66SAndroid Build Coastguard Worker // std::move_only_function in a type-safe manner. 394*481dde66SAndroid Build Coastguard Worker // 395*481dde66SAndroid Build Coastguard Worker // For example: 396*481dde66SAndroid Build Coastguard Worker // 397*481dde66SAndroid Build Coastguard Worker // // Assume we have some API that needs to accept a unique pointer to some 398*481dde66SAndroid Build Coastguard Worker // // non-copyable object Foo. 399*481dde66SAndroid Build Coastguard Worker // void AcceptUniquePointer(std::unique_ptr<Foo> foo); 400*481dde66SAndroid Build Coastguard Worker // 401*481dde66SAndroid Build Coastguard Worker // // We can define an action that provides a Foo to that API. Because It 402*481dde66SAndroid Build Coastguard Worker // // has to give away its unique pointer, it must not be called more than 403*481dde66SAndroid Build Coastguard Worker // // once, so its call operator is &&-qualified. 404*481dde66SAndroid Build Coastguard Worker // struct ProvideFoo { 405*481dde66SAndroid Build Coastguard Worker // std::unique_ptr<Foo> foo; 406*481dde66SAndroid Build Coastguard Worker // 407*481dde66SAndroid Build Coastguard Worker // void operator()() && { 408*481dde66SAndroid Build Coastguard Worker // AcceptUniquePointer(std::move(Foo)); 409*481dde66SAndroid Build Coastguard Worker // } 410*481dde66SAndroid Build Coastguard Worker // }; 411*481dde66SAndroid Build Coastguard Worker // 412*481dde66SAndroid Build Coastguard Worker // // This action can be used with WillOnce. 413*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Call) 414*481dde66SAndroid Build Coastguard Worker // .WillOnce(ProvideFoo{std::make_unique<Foo>(...)}); 415*481dde66SAndroid Build Coastguard Worker // 416*481dde66SAndroid Build Coastguard Worker // // But a call to WillRepeatedly will fail to compile. This is correct, 417*481dde66SAndroid Build Coastguard Worker // // since the action cannot correctly be used repeatedly. 418*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Call) 419*481dde66SAndroid Build Coastguard Worker // .WillRepeatedly(ProvideFoo{std::make_unique<Foo>(...)}); 420*481dde66SAndroid Build Coastguard Worker // 421*481dde66SAndroid Build Coastguard Worker // A less-contrived example would be an action that returns an arbitrary type, 422*481dde66SAndroid Build Coastguard Worker // whose &&-qualified call operator is capable of dealing with move-only types. 423*481dde66SAndroid Build Coastguard Worker template <typename Result, typename... Args> 424*481dde66SAndroid Build Coastguard Worker class OnceAction<Result(Args...)> final { 425*481dde66SAndroid Build Coastguard Worker private: 426*481dde66SAndroid Build Coastguard Worker // True iff we can use the given callable type (or lvalue reference) directly 427*481dde66SAndroid Build Coastguard Worker // via StdFunctionAdaptor. 428*481dde66SAndroid Build Coastguard Worker template <typename Callable> 429*481dde66SAndroid Build Coastguard Worker using IsDirectlyCompatible = internal::conjunction< 430*481dde66SAndroid Build Coastguard Worker // It must be possible to capture the callable in StdFunctionAdaptor. 431*481dde66SAndroid Build Coastguard Worker std::is_constructible<typename std::decay<Callable>::type, Callable>, 432*481dde66SAndroid Build Coastguard Worker // The callable must be compatible with our signature. 433*481dde66SAndroid Build Coastguard Worker internal::is_callable_r<Result, typename std::decay<Callable>::type, 434*481dde66SAndroid Build Coastguard Worker Args...>>; 435*481dde66SAndroid Build Coastguard Worker 436*481dde66SAndroid Build Coastguard Worker // True iff we can use the given callable type via StdFunctionAdaptor once we 437*481dde66SAndroid Build Coastguard Worker // ignore incoming arguments. 438*481dde66SAndroid Build Coastguard Worker template <typename Callable> 439*481dde66SAndroid Build Coastguard Worker using IsCompatibleAfterIgnoringArguments = internal::conjunction< 440*481dde66SAndroid Build Coastguard Worker // It must be possible to capture the callable in a lambda. 441*481dde66SAndroid Build Coastguard Worker std::is_constructible<typename std::decay<Callable>::type, Callable>, 442*481dde66SAndroid Build Coastguard Worker // The callable must be invocable with zero arguments, returning something 443*481dde66SAndroid Build Coastguard Worker // convertible to Result. 444*481dde66SAndroid Build Coastguard Worker internal::is_callable_r<Result, typename std::decay<Callable>::type>>; 445*481dde66SAndroid Build Coastguard Worker 446*481dde66SAndroid Build Coastguard Worker public: 447*481dde66SAndroid Build Coastguard Worker // Construct from a callable that is directly compatible with our mocked 448*481dde66SAndroid Build Coastguard Worker // signature: it accepts our function type's arguments and returns something 449*481dde66SAndroid Build Coastguard Worker // convertible to our result type. 450*481dde66SAndroid Build Coastguard Worker template <typename Callable, 451*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 452*481dde66SAndroid Build Coastguard Worker internal::conjunction< 453*481dde66SAndroid Build Coastguard Worker // Teach clang on macOS that we're not talking about a 454*481dde66SAndroid Build Coastguard Worker // copy/move constructor here. Otherwise it gets confused 455*481dde66SAndroid Build Coastguard Worker // when checking the is_constructible requirement of our 456*481dde66SAndroid Build Coastguard Worker // traits above. 457*481dde66SAndroid Build Coastguard Worker internal::negation<std::is_same< 458*481dde66SAndroid Build Coastguard Worker OnceAction, typename std::decay<Callable>::type>>, 459*481dde66SAndroid Build Coastguard Worker IsDirectlyCompatible<Callable>> // 460*481dde66SAndroid Build Coastguard Worker ::value, 461*481dde66SAndroid Build Coastguard Worker int>::type = 0> 462*481dde66SAndroid Build Coastguard Worker OnceAction(Callable&& callable) // NOLINT 463*481dde66SAndroid Build Coastguard Worker : function_(StdFunctionAdaptor<typename std::decay<Callable>::type>( 464*481dde66SAndroid Build Coastguard Worker {}, std::forward<Callable>(callable))) {} 465*481dde66SAndroid Build Coastguard Worker 466*481dde66SAndroid Build Coastguard Worker // As above, but for a callable that ignores the mocked function's arguments. 467*481dde66SAndroid Build Coastguard Worker template <typename Callable, 468*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 469*481dde66SAndroid Build Coastguard Worker internal::conjunction< 470*481dde66SAndroid Build Coastguard Worker // Teach clang on macOS that we're not talking about a 471*481dde66SAndroid Build Coastguard Worker // copy/move constructor here. Otherwise it gets confused 472*481dde66SAndroid Build Coastguard Worker // when checking the is_constructible requirement of our 473*481dde66SAndroid Build Coastguard Worker // traits above. 474*481dde66SAndroid Build Coastguard Worker internal::negation<std::is_same< 475*481dde66SAndroid Build Coastguard Worker OnceAction, typename std::decay<Callable>::type>>, 476*481dde66SAndroid Build Coastguard Worker // Exclude callables for which the overload above works. 477*481dde66SAndroid Build Coastguard Worker // We'd rather provide the arguments if possible. 478*481dde66SAndroid Build Coastguard Worker internal::negation<IsDirectlyCompatible<Callable>>, 479*481dde66SAndroid Build Coastguard Worker IsCompatibleAfterIgnoringArguments<Callable>>::value, 480*481dde66SAndroid Build Coastguard Worker int>::type = 0> 481*481dde66SAndroid Build Coastguard Worker OnceAction(Callable&& callable) // NOLINT 482*481dde66SAndroid Build Coastguard Worker // Call the constructor above with a callable 483*481dde66SAndroid Build Coastguard Worker // that ignores the input arguments. 484*481dde66SAndroid Build Coastguard Worker : OnceAction(IgnoreIncomingArguments<typename std::decay<Callable>::type>{ 485*481dde66SAndroid Build Coastguard Worker std::forward<Callable>(callable)}) {} 486*481dde66SAndroid Build Coastguard Worker 487*481dde66SAndroid Build Coastguard Worker // We are naturally copyable because we store only an std::function, but 488*481dde66SAndroid Build Coastguard Worker // semantically we should not be copyable. 489*481dde66SAndroid Build Coastguard Worker OnceAction(const OnceAction&) = delete; 490*481dde66SAndroid Build Coastguard Worker OnceAction& operator=(const OnceAction&) = delete; 491*481dde66SAndroid Build Coastguard Worker OnceAction(OnceAction&&) = default; 492*481dde66SAndroid Build Coastguard Worker 493*481dde66SAndroid Build Coastguard Worker // Invoke the underlying action callable with which we were constructed, 494*481dde66SAndroid Build Coastguard Worker // handing it the supplied arguments. 495*481dde66SAndroid Build Coastguard Worker Result Call(Args... args) && { 496*481dde66SAndroid Build Coastguard Worker return function_(std::forward<Args>(args)...); 497*481dde66SAndroid Build Coastguard Worker } 498*481dde66SAndroid Build Coastguard Worker 499*481dde66SAndroid Build Coastguard Worker private: 500*481dde66SAndroid Build Coastguard Worker // An adaptor that wraps a callable that is compatible with our signature and 501*481dde66SAndroid Build Coastguard Worker // being invoked as an rvalue reference so that it can be used as an 502*481dde66SAndroid Build Coastguard Worker // StdFunctionAdaptor. This throws away type safety, but that's fine because 503*481dde66SAndroid Build Coastguard Worker // this is only used by WillOnce, which we know calls at most once. 504*481dde66SAndroid Build Coastguard Worker // 505*481dde66SAndroid Build Coastguard Worker // Once we have something like std::move_only_function from C++23, we can do 506*481dde66SAndroid Build Coastguard Worker // away with this. 507*481dde66SAndroid Build Coastguard Worker template <typename Callable> 508*481dde66SAndroid Build Coastguard Worker class StdFunctionAdaptor final { 509*481dde66SAndroid Build Coastguard Worker public: 510*481dde66SAndroid Build Coastguard Worker // A tag indicating that the (otherwise universal) constructor is accepting 511*481dde66SAndroid Build Coastguard Worker // the callable itself, instead of e.g. stealing calls for the move 512*481dde66SAndroid Build Coastguard Worker // constructor. 513*481dde66SAndroid Build Coastguard Worker struct CallableTag final {}; 514*481dde66SAndroid Build Coastguard Worker 515*481dde66SAndroid Build Coastguard Worker template <typename F> 516*481dde66SAndroid Build Coastguard Worker explicit StdFunctionAdaptor(CallableTag, F&& callable) 517*481dde66SAndroid Build Coastguard Worker : callable_(std::make_shared<Callable>(std::forward<F>(callable))) {} 518*481dde66SAndroid Build Coastguard Worker 519*481dde66SAndroid Build Coastguard Worker // Rather than explicitly returning Result, we return whatever the wrapped 520*481dde66SAndroid Build Coastguard Worker // callable returns. This allows for compatibility with existing uses like 521*481dde66SAndroid Build Coastguard Worker // the following, when the mocked function returns void: 522*481dde66SAndroid Build Coastguard Worker // 523*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock_fn_, Call) 524*481dde66SAndroid Build Coastguard Worker // .WillOnce([&] { 525*481dde66SAndroid Build Coastguard Worker // [...] 526*481dde66SAndroid Build Coastguard Worker // return 0; 527*481dde66SAndroid Build Coastguard Worker // }); 528*481dde66SAndroid Build Coastguard Worker // 529*481dde66SAndroid Build Coastguard Worker // Such a callable can be turned into std::function<void()>. If we use an 530*481dde66SAndroid Build Coastguard Worker // explicit return type of Result here then it *doesn't* work with 531*481dde66SAndroid Build Coastguard Worker // std::function, because we'll get a "void function should not return a 532*481dde66SAndroid Build Coastguard Worker // value" error. 533*481dde66SAndroid Build Coastguard Worker // 534*481dde66SAndroid Build Coastguard Worker // We need not worry about incompatible result types because the SFINAE on 535*481dde66SAndroid Build Coastguard Worker // OnceAction already checks this for us. std::is_invocable_r_v itself makes 536*481dde66SAndroid Build Coastguard Worker // the same allowance for void result types. 537*481dde66SAndroid Build Coastguard Worker template <typename... ArgRefs> 538*481dde66SAndroid Build Coastguard Worker internal::call_result_t<Callable, ArgRefs...> operator()( 539*481dde66SAndroid Build Coastguard Worker ArgRefs&&... args) const { 540*481dde66SAndroid Build Coastguard Worker return std::move(*callable_)(std::forward<ArgRefs>(args)...); 541*481dde66SAndroid Build Coastguard Worker } 542*481dde66SAndroid Build Coastguard Worker 543*481dde66SAndroid Build Coastguard Worker private: 544*481dde66SAndroid Build Coastguard Worker // We must put the callable on the heap so that we are copyable, which 545*481dde66SAndroid Build Coastguard Worker // std::function needs. 546*481dde66SAndroid Build Coastguard Worker std::shared_ptr<Callable> callable_; 547*481dde66SAndroid Build Coastguard Worker }; 548*481dde66SAndroid Build Coastguard Worker 549*481dde66SAndroid Build Coastguard Worker // An adaptor that makes a callable that accepts zero arguments callable with 550*481dde66SAndroid Build Coastguard Worker // our mocked arguments. 551*481dde66SAndroid Build Coastguard Worker template <typename Callable> 552*481dde66SAndroid Build Coastguard Worker struct IgnoreIncomingArguments { 553*481dde66SAndroid Build Coastguard Worker internal::call_result_t<Callable> operator()(Args&&...) { 554*481dde66SAndroid Build Coastguard Worker return std::move(callable)(); 555*481dde66SAndroid Build Coastguard Worker } 556*481dde66SAndroid Build Coastguard Worker 557*481dde66SAndroid Build Coastguard Worker Callable callable; 558*481dde66SAndroid Build Coastguard Worker }; 559*481dde66SAndroid Build Coastguard Worker 560*481dde66SAndroid Build Coastguard Worker std::function<Result(Args...)> function_; 561*481dde66SAndroid Build Coastguard Worker }; 562*481dde66SAndroid Build Coastguard Worker 563*481dde66SAndroid Build Coastguard Worker // When an unexpected function call is encountered, Google Mock will 564*481dde66SAndroid Build Coastguard Worker // let it return a default value if the user has specified one for its 565*481dde66SAndroid Build Coastguard Worker // return type, or if the return type has a built-in default value; 566*481dde66SAndroid Build Coastguard Worker // otherwise Google Mock won't know what value to return and will have 567*481dde66SAndroid Build Coastguard Worker // to abort the process. 568*481dde66SAndroid Build Coastguard Worker // 569*481dde66SAndroid Build Coastguard Worker // The DefaultValue<T> class allows a user to specify the 570*481dde66SAndroid Build Coastguard Worker // default value for a type T that is both copyable and publicly 571*481dde66SAndroid Build Coastguard Worker // destructible (i.e. anything that can be used as a function return 572*481dde66SAndroid Build Coastguard Worker // type). The usage is: 573*481dde66SAndroid Build Coastguard Worker // 574*481dde66SAndroid Build Coastguard Worker // // Sets the default value for type T to be foo. 575*481dde66SAndroid Build Coastguard Worker // DefaultValue<T>::Set(foo); 576*481dde66SAndroid Build Coastguard Worker template <typename T> 577*481dde66SAndroid Build Coastguard Worker class DefaultValue { 578*481dde66SAndroid Build Coastguard Worker public: 579*481dde66SAndroid Build Coastguard Worker // Sets the default value for type T; requires T to be 580*481dde66SAndroid Build Coastguard Worker // copy-constructable and have a public destructor. 581*481dde66SAndroid Build Coastguard Worker static void Set(T x) { 582*481dde66SAndroid Build Coastguard Worker delete producer_; 583*481dde66SAndroid Build Coastguard Worker producer_ = new FixedValueProducer(x); 584*481dde66SAndroid Build Coastguard Worker } 585*481dde66SAndroid Build Coastguard Worker 586*481dde66SAndroid Build Coastguard Worker // Provides a factory function to be called to generate the default value. 587*481dde66SAndroid Build Coastguard Worker // This method can be used even if T is only move-constructible, but it is not 588*481dde66SAndroid Build Coastguard Worker // limited to that case. 589*481dde66SAndroid Build Coastguard Worker typedef T (*FactoryFunction)(); 590*481dde66SAndroid Build Coastguard Worker static void SetFactory(FactoryFunction factory) { 591*481dde66SAndroid Build Coastguard Worker delete producer_; 592*481dde66SAndroid Build Coastguard Worker producer_ = new FactoryValueProducer(factory); 593*481dde66SAndroid Build Coastguard Worker } 594*481dde66SAndroid Build Coastguard Worker 595*481dde66SAndroid Build Coastguard Worker // Unsets the default value for type T. 596*481dde66SAndroid Build Coastguard Worker static void Clear() { 597*481dde66SAndroid Build Coastguard Worker delete producer_; 598*481dde66SAndroid Build Coastguard Worker producer_ = nullptr; 599*481dde66SAndroid Build Coastguard Worker } 600*481dde66SAndroid Build Coastguard Worker 601*481dde66SAndroid Build Coastguard Worker // Returns true if and only if the user has set the default value for type T. 602*481dde66SAndroid Build Coastguard Worker static bool IsSet() { return producer_ != nullptr; } 603*481dde66SAndroid Build Coastguard Worker 604*481dde66SAndroid Build Coastguard Worker // Returns true if T has a default return value set by the user or there 605*481dde66SAndroid Build Coastguard Worker // exists a built-in default value. 606*481dde66SAndroid Build Coastguard Worker static bool Exists() { 607*481dde66SAndroid Build Coastguard Worker return IsSet() || internal::BuiltInDefaultValue<T>::Exists(); 608*481dde66SAndroid Build Coastguard Worker } 609*481dde66SAndroid Build Coastguard Worker 610*481dde66SAndroid Build Coastguard Worker // Returns the default value for type T if the user has set one; 611*481dde66SAndroid Build Coastguard Worker // otherwise returns the built-in default value. Requires that Exists() 612*481dde66SAndroid Build Coastguard Worker // is true, which ensures that the return value is well-defined. 613*481dde66SAndroid Build Coastguard Worker static T Get() { 614*481dde66SAndroid Build Coastguard Worker return producer_ == nullptr ? internal::BuiltInDefaultValue<T>::Get() 615*481dde66SAndroid Build Coastguard Worker : producer_->Produce(); 616*481dde66SAndroid Build Coastguard Worker } 617*481dde66SAndroid Build Coastguard Worker 618*481dde66SAndroid Build Coastguard Worker private: 619*481dde66SAndroid Build Coastguard Worker class ValueProducer { 620*481dde66SAndroid Build Coastguard Worker public: 621*481dde66SAndroid Build Coastguard Worker virtual ~ValueProducer() = default; 622*481dde66SAndroid Build Coastguard Worker virtual T Produce() = 0; 623*481dde66SAndroid Build Coastguard Worker }; 624*481dde66SAndroid Build Coastguard Worker 625*481dde66SAndroid Build Coastguard Worker class FixedValueProducer : public ValueProducer { 626*481dde66SAndroid Build Coastguard Worker public: 627*481dde66SAndroid Build Coastguard Worker explicit FixedValueProducer(T value) : value_(value) {} 628*481dde66SAndroid Build Coastguard Worker T Produce() override { return value_; } 629*481dde66SAndroid Build Coastguard Worker 630*481dde66SAndroid Build Coastguard Worker private: 631*481dde66SAndroid Build Coastguard Worker const T value_; 632*481dde66SAndroid Build Coastguard Worker FixedValueProducer(const FixedValueProducer&) = delete; 633*481dde66SAndroid Build Coastguard Worker FixedValueProducer& operator=(const FixedValueProducer&) = delete; 634*481dde66SAndroid Build Coastguard Worker }; 635*481dde66SAndroid Build Coastguard Worker 636*481dde66SAndroid Build Coastguard Worker class FactoryValueProducer : public ValueProducer { 637*481dde66SAndroid Build Coastguard Worker public: 638*481dde66SAndroid Build Coastguard Worker explicit FactoryValueProducer(FactoryFunction factory) 639*481dde66SAndroid Build Coastguard Worker : factory_(factory) {} 640*481dde66SAndroid Build Coastguard Worker T Produce() override { return factory_(); } 641*481dde66SAndroid Build Coastguard Worker 642*481dde66SAndroid Build Coastguard Worker private: 643*481dde66SAndroid Build Coastguard Worker const FactoryFunction factory_; 644*481dde66SAndroid Build Coastguard Worker FactoryValueProducer(const FactoryValueProducer&) = delete; 645*481dde66SAndroid Build Coastguard Worker FactoryValueProducer& operator=(const FactoryValueProducer&) = delete; 646*481dde66SAndroid Build Coastguard Worker }; 647*481dde66SAndroid Build Coastguard Worker 648*481dde66SAndroid Build Coastguard Worker static ValueProducer* producer_; 649*481dde66SAndroid Build Coastguard Worker }; 650*481dde66SAndroid Build Coastguard Worker 651*481dde66SAndroid Build Coastguard Worker // This partial specialization allows a user to set default values for 652*481dde66SAndroid Build Coastguard Worker // reference types. 653*481dde66SAndroid Build Coastguard Worker template <typename T> 654*481dde66SAndroid Build Coastguard Worker class DefaultValue<T&> { 655*481dde66SAndroid Build Coastguard Worker public: 656*481dde66SAndroid Build Coastguard Worker // Sets the default value for type T&. 657*481dde66SAndroid Build Coastguard Worker static void Set(T& x) { // NOLINT 658*481dde66SAndroid Build Coastguard Worker address_ = &x; 659*481dde66SAndroid Build Coastguard Worker } 660*481dde66SAndroid Build Coastguard Worker 661*481dde66SAndroid Build Coastguard Worker // Unsets the default value for type T&. 662*481dde66SAndroid Build Coastguard Worker static void Clear() { address_ = nullptr; } 663*481dde66SAndroid Build Coastguard Worker 664*481dde66SAndroid Build Coastguard Worker // Returns true if and only if the user has set the default value for type T&. 665*481dde66SAndroid Build Coastguard Worker static bool IsSet() { return address_ != nullptr; } 666*481dde66SAndroid Build Coastguard Worker 667*481dde66SAndroid Build Coastguard Worker // Returns true if T has a default return value set by the user or there 668*481dde66SAndroid Build Coastguard Worker // exists a built-in default value. 669*481dde66SAndroid Build Coastguard Worker static bool Exists() { 670*481dde66SAndroid Build Coastguard Worker return IsSet() || internal::BuiltInDefaultValue<T&>::Exists(); 671*481dde66SAndroid Build Coastguard Worker } 672*481dde66SAndroid Build Coastguard Worker 673*481dde66SAndroid Build Coastguard Worker // Returns the default value for type T& if the user has set one; 674*481dde66SAndroid Build Coastguard Worker // otherwise returns the built-in default value if there is one; 675*481dde66SAndroid Build Coastguard Worker // otherwise aborts the process. 676*481dde66SAndroid Build Coastguard Worker static T& Get() { 677*481dde66SAndroid Build Coastguard Worker return address_ == nullptr ? internal::BuiltInDefaultValue<T&>::Get() 678*481dde66SAndroid Build Coastguard Worker : *address_; 679*481dde66SAndroid Build Coastguard Worker } 680*481dde66SAndroid Build Coastguard Worker 681*481dde66SAndroid Build Coastguard Worker private: 682*481dde66SAndroid Build Coastguard Worker static T* address_; 683*481dde66SAndroid Build Coastguard Worker }; 684*481dde66SAndroid Build Coastguard Worker 685*481dde66SAndroid Build Coastguard Worker // This specialization allows DefaultValue<void>::Get() to 686*481dde66SAndroid Build Coastguard Worker // compile. 687*481dde66SAndroid Build Coastguard Worker template <> 688*481dde66SAndroid Build Coastguard Worker class DefaultValue<void> { 689*481dde66SAndroid Build Coastguard Worker public: 690*481dde66SAndroid Build Coastguard Worker static bool Exists() { return true; } 691*481dde66SAndroid Build Coastguard Worker static void Get() {} 692*481dde66SAndroid Build Coastguard Worker }; 693*481dde66SAndroid Build Coastguard Worker 694*481dde66SAndroid Build Coastguard Worker // Points to the user-set default value for type T. 695*481dde66SAndroid Build Coastguard Worker template <typename T> 696*481dde66SAndroid Build Coastguard Worker typename DefaultValue<T>::ValueProducer* DefaultValue<T>::producer_ = nullptr; 697*481dde66SAndroid Build Coastguard Worker 698*481dde66SAndroid Build Coastguard Worker // Points to the user-set default value for type T&. 699*481dde66SAndroid Build Coastguard Worker template <typename T> 700*481dde66SAndroid Build Coastguard Worker T* DefaultValue<T&>::address_ = nullptr; 701*481dde66SAndroid Build Coastguard Worker 702*481dde66SAndroid Build Coastguard Worker // Implement this interface to define an action for function type F. 703*481dde66SAndroid Build Coastguard Worker template <typename F> 704*481dde66SAndroid Build Coastguard Worker class ActionInterface { 705*481dde66SAndroid Build Coastguard Worker public: 706*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::Result Result; 707*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple; 708*481dde66SAndroid Build Coastguard Worker 709*481dde66SAndroid Build Coastguard Worker ActionInterface() = default; 710*481dde66SAndroid Build Coastguard Worker virtual ~ActionInterface() = default; 711*481dde66SAndroid Build Coastguard Worker 712*481dde66SAndroid Build Coastguard Worker // Performs the action. This method is not const, as in general an 713*481dde66SAndroid Build Coastguard Worker // action can have side effects and be stateful. For example, a 714*481dde66SAndroid Build Coastguard Worker // get-the-next-element-from-the-collection action will need to 715*481dde66SAndroid Build Coastguard Worker // remember the current element. 716*481dde66SAndroid Build Coastguard Worker virtual Result Perform(const ArgumentTuple& args) = 0; 717*481dde66SAndroid Build Coastguard Worker 718*481dde66SAndroid Build Coastguard Worker private: 719*481dde66SAndroid Build Coastguard Worker ActionInterface(const ActionInterface&) = delete; 720*481dde66SAndroid Build Coastguard Worker ActionInterface& operator=(const ActionInterface&) = delete; 721*481dde66SAndroid Build Coastguard Worker }; 722*481dde66SAndroid Build Coastguard Worker 723*481dde66SAndroid Build Coastguard Worker template <typename F> 724*481dde66SAndroid Build Coastguard Worker class Action; 725*481dde66SAndroid Build Coastguard Worker 726*481dde66SAndroid Build Coastguard Worker // An Action<R(Args...)> is a copyable and IMMUTABLE (except by assignment) 727*481dde66SAndroid Build Coastguard Worker // object that represents an action to be taken when a mock function of type 728*481dde66SAndroid Build Coastguard Worker // R(Args...) is called. The implementation of Action<T> is just a 729*481dde66SAndroid Build Coastguard Worker // std::shared_ptr to const ActionInterface<T>. Don't inherit from Action! You 730*481dde66SAndroid Build Coastguard Worker // can view an object implementing ActionInterface<F> as a concrete action 731*481dde66SAndroid Build Coastguard Worker // (including its current state), and an Action<F> object as a handle to it. 732*481dde66SAndroid Build Coastguard Worker template <typename R, typename... Args> 733*481dde66SAndroid Build Coastguard Worker class Action<R(Args...)> { 734*481dde66SAndroid Build Coastguard Worker private: 735*481dde66SAndroid Build Coastguard Worker using F = R(Args...); 736*481dde66SAndroid Build Coastguard Worker 737*481dde66SAndroid Build Coastguard Worker // Adapter class to allow constructing Action from a legacy ActionInterface. 738*481dde66SAndroid Build Coastguard Worker // New code should create Actions from functors instead. 739*481dde66SAndroid Build Coastguard Worker struct ActionAdapter { 740*481dde66SAndroid Build Coastguard Worker // Adapter must be copyable to satisfy std::function requirements. 741*481dde66SAndroid Build Coastguard Worker ::std::shared_ptr<ActionInterface<F>> impl_; 742*481dde66SAndroid Build Coastguard Worker 743*481dde66SAndroid Build Coastguard Worker template <typename... InArgs> 744*481dde66SAndroid Build Coastguard Worker typename internal::Function<F>::Result operator()(InArgs&&... args) { 745*481dde66SAndroid Build Coastguard Worker return impl_->Perform( 746*481dde66SAndroid Build Coastguard Worker ::std::forward_as_tuple(::std::forward<InArgs>(args)...)); 747*481dde66SAndroid Build Coastguard Worker } 748*481dde66SAndroid Build Coastguard Worker }; 749*481dde66SAndroid Build Coastguard Worker 750*481dde66SAndroid Build Coastguard Worker template <typename G> 751*481dde66SAndroid Build Coastguard Worker using IsCompatibleFunctor = std::is_constructible<std::function<F>, G>; 752*481dde66SAndroid Build Coastguard Worker 753*481dde66SAndroid Build Coastguard Worker public: 754*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::Result Result; 755*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple; 756*481dde66SAndroid Build Coastguard Worker 757*481dde66SAndroid Build Coastguard Worker // Constructs a null Action. Needed for storing Action objects in 758*481dde66SAndroid Build Coastguard Worker // STL containers. 759*481dde66SAndroid Build Coastguard Worker Action() = default; 760*481dde66SAndroid Build Coastguard Worker 761*481dde66SAndroid Build Coastguard Worker // Construct an Action from a specified callable. 762*481dde66SAndroid Build Coastguard Worker // This cannot take std::function directly, because then Action would not be 763*481dde66SAndroid Build Coastguard Worker // directly constructible from lambda (it would require two conversions). 764*481dde66SAndroid Build Coastguard Worker template < 765*481dde66SAndroid Build Coastguard Worker typename G, 766*481dde66SAndroid Build Coastguard Worker typename = typename std::enable_if<internal::disjunction< 767*481dde66SAndroid Build Coastguard Worker IsCompatibleFunctor<G>, std::is_constructible<std::function<Result()>, 768*481dde66SAndroid Build Coastguard Worker G>>::value>::type> 769*481dde66SAndroid Build Coastguard Worker Action(G&& fun) { // NOLINT 770*481dde66SAndroid Build Coastguard Worker Init(::std::forward<G>(fun), IsCompatibleFunctor<G>()); 771*481dde66SAndroid Build Coastguard Worker } 772*481dde66SAndroid Build Coastguard Worker 773*481dde66SAndroid Build Coastguard Worker // Constructs an Action from its implementation. 774*481dde66SAndroid Build Coastguard Worker explicit Action(ActionInterface<F>* impl) 775*481dde66SAndroid Build Coastguard Worker : fun_(ActionAdapter{::std::shared_ptr<ActionInterface<F>>(impl)}) {} 776*481dde66SAndroid Build Coastguard Worker 777*481dde66SAndroid Build Coastguard Worker // This constructor allows us to turn an Action<Func> object into an 778*481dde66SAndroid Build Coastguard Worker // Action<F>, as long as F's arguments can be implicitly converted 779*481dde66SAndroid Build Coastguard Worker // to Func's and Func's return type can be implicitly converted to F's. 780*481dde66SAndroid Build Coastguard Worker template <typename Func> 781*481dde66SAndroid Build Coastguard Worker Action(const Action<Func>& action) // NOLINT 782*481dde66SAndroid Build Coastguard Worker : fun_(action.fun_) {} 783*481dde66SAndroid Build Coastguard Worker 784*481dde66SAndroid Build Coastguard Worker // Returns true if and only if this is the DoDefault() action. 785*481dde66SAndroid Build Coastguard Worker bool IsDoDefault() const { return fun_ == nullptr; } 786*481dde66SAndroid Build Coastguard Worker 787*481dde66SAndroid Build Coastguard Worker // Performs the action. Note that this method is const even though 788*481dde66SAndroid Build Coastguard Worker // the corresponding method in ActionInterface is not. The reason 789*481dde66SAndroid Build Coastguard Worker // is that a const Action<F> means that it cannot be re-bound to 790*481dde66SAndroid Build Coastguard Worker // another concrete action, not that the concrete action it binds to 791*481dde66SAndroid Build Coastguard Worker // cannot change state. (Think of the difference between a const 792*481dde66SAndroid Build Coastguard Worker // pointer and a pointer to const.) 793*481dde66SAndroid Build Coastguard Worker Result Perform(ArgumentTuple args) const { 794*481dde66SAndroid Build Coastguard Worker if (IsDoDefault()) { 795*481dde66SAndroid Build Coastguard Worker internal::IllegalDoDefault(__FILE__, __LINE__); 796*481dde66SAndroid Build Coastguard Worker } 797*481dde66SAndroid Build Coastguard Worker return internal::Apply(fun_, ::std::move(args)); 798*481dde66SAndroid Build Coastguard Worker } 799*481dde66SAndroid Build Coastguard Worker 800*481dde66SAndroid Build Coastguard Worker // An action can be used as a OnceAction, since it's obviously safe to call it 801*481dde66SAndroid Build Coastguard Worker // once. 802*481dde66SAndroid Build Coastguard Worker operator OnceAction<F>() const { // NOLINT 803*481dde66SAndroid Build Coastguard Worker // Return a OnceAction-compatible callable that calls Perform with the 804*481dde66SAndroid Build Coastguard Worker // arguments it is provided. We could instead just return fun_, but then 805*481dde66SAndroid Build Coastguard Worker // we'd need to handle the IsDoDefault() case separately. 806*481dde66SAndroid Build Coastguard Worker struct OA { 807*481dde66SAndroid Build Coastguard Worker Action<F> action; 808*481dde66SAndroid Build Coastguard Worker 809*481dde66SAndroid Build Coastguard Worker R operator()(Args... args) && { 810*481dde66SAndroid Build Coastguard Worker return action.Perform( 811*481dde66SAndroid Build Coastguard Worker std::forward_as_tuple(std::forward<Args>(args)...)); 812*481dde66SAndroid Build Coastguard Worker } 813*481dde66SAndroid Build Coastguard Worker }; 814*481dde66SAndroid Build Coastguard Worker 815*481dde66SAndroid Build Coastguard Worker return OA{*this}; 816*481dde66SAndroid Build Coastguard Worker } 817*481dde66SAndroid Build Coastguard Worker 818*481dde66SAndroid Build Coastguard Worker private: 819*481dde66SAndroid Build Coastguard Worker template <typename G> 820*481dde66SAndroid Build Coastguard Worker friend class Action; 821*481dde66SAndroid Build Coastguard Worker 822*481dde66SAndroid Build Coastguard Worker template <typename G> 823*481dde66SAndroid Build Coastguard Worker void Init(G&& g, ::std::true_type) { 824*481dde66SAndroid Build Coastguard Worker fun_ = ::std::forward<G>(g); 825*481dde66SAndroid Build Coastguard Worker } 826*481dde66SAndroid Build Coastguard Worker 827*481dde66SAndroid Build Coastguard Worker template <typename G> 828*481dde66SAndroid Build Coastguard Worker void Init(G&& g, ::std::false_type) { 829*481dde66SAndroid Build Coastguard Worker fun_ = IgnoreArgs<typename ::std::decay<G>::type>{::std::forward<G>(g)}; 830*481dde66SAndroid Build Coastguard Worker } 831*481dde66SAndroid Build Coastguard Worker 832*481dde66SAndroid Build Coastguard Worker template <typename FunctionImpl> 833*481dde66SAndroid Build Coastguard Worker struct IgnoreArgs { 834*481dde66SAndroid Build Coastguard Worker template <typename... InArgs> 835*481dde66SAndroid Build Coastguard Worker Result operator()(const InArgs&...) const { 836*481dde66SAndroid Build Coastguard Worker return function_impl(); 837*481dde66SAndroid Build Coastguard Worker } 838*481dde66SAndroid Build Coastguard Worker 839*481dde66SAndroid Build Coastguard Worker FunctionImpl function_impl; 840*481dde66SAndroid Build Coastguard Worker }; 841*481dde66SAndroid Build Coastguard Worker 842*481dde66SAndroid Build Coastguard Worker // fun_ is an empty function if and only if this is the DoDefault() action. 843*481dde66SAndroid Build Coastguard Worker ::std::function<F> fun_; 844*481dde66SAndroid Build Coastguard Worker }; 845*481dde66SAndroid Build Coastguard Worker 846*481dde66SAndroid Build Coastguard Worker // The PolymorphicAction class template makes it easy to implement a 847*481dde66SAndroid Build Coastguard Worker // polymorphic action (i.e. an action that can be used in mock 848*481dde66SAndroid Build Coastguard Worker // functions of than one type, e.g. Return()). 849*481dde66SAndroid Build Coastguard Worker // 850*481dde66SAndroid Build Coastguard Worker // To define a polymorphic action, a user first provides a COPYABLE 851*481dde66SAndroid Build Coastguard Worker // implementation class that has a Perform() method template: 852*481dde66SAndroid Build Coastguard Worker // 853*481dde66SAndroid Build Coastguard Worker // class FooAction { 854*481dde66SAndroid Build Coastguard Worker // public: 855*481dde66SAndroid Build Coastguard Worker // template <typename Result, typename ArgumentTuple> 856*481dde66SAndroid Build Coastguard Worker // Result Perform(const ArgumentTuple& args) const { 857*481dde66SAndroid Build Coastguard Worker // // Processes the arguments and returns a result, using 858*481dde66SAndroid Build Coastguard Worker // // std::get<N>(args) to get the N-th (0-based) argument in the tuple. 859*481dde66SAndroid Build Coastguard Worker // } 860*481dde66SAndroid Build Coastguard Worker // ... 861*481dde66SAndroid Build Coastguard Worker // }; 862*481dde66SAndroid Build Coastguard Worker // 863*481dde66SAndroid Build Coastguard Worker // Then the user creates the polymorphic action using 864*481dde66SAndroid Build Coastguard Worker // MakePolymorphicAction(object) where object has type FooAction. See 865*481dde66SAndroid Build Coastguard Worker // the definition of Return(void) and SetArgumentPointee<N>(value) for 866*481dde66SAndroid Build Coastguard Worker // complete examples. 867*481dde66SAndroid Build Coastguard Worker template <typename Impl> 868*481dde66SAndroid Build Coastguard Worker class PolymorphicAction { 869*481dde66SAndroid Build Coastguard Worker public: 870*481dde66SAndroid Build Coastguard Worker explicit PolymorphicAction(const Impl& impl) : impl_(impl) {} 871*481dde66SAndroid Build Coastguard Worker 872*481dde66SAndroid Build Coastguard Worker template <typename F> 873*481dde66SAndroid Build Coastguard Worker operator Action<F>() const { 874*481dde66SAndroid Build Coastguard Worker return Action<F>(new MonomorphicImpl<F>(impl_)); 875*481dde66SAndroid Build Coastguard Worker } 876*481dde66SAndroid Build Coastguard Worker 877*481dde66SAndroid Build Coastguard Worker private: 878*481dde66SAndroid Build Coastguard Worker template <typename F> 879*481dde66SAndroid Build Coastguard Worker class MonomorphicImpl : public ActionInterface<F> { 880*481dde66SAndroid Build Coastguard Worker public: 881*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::Result Result; 882*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple; 883*481dde66SAndroid Build Coastguard Worker 884*481dde66SAndroid Build Coastguard Worker explicit MonomorphicImpl(const Impl& impl) : impl_(impl) {} 885*481dde66SAndroid Build Coastguard Worker 886*481dde66SAndroid Build Coastguard Worker Result Perform(const ArgumentTuple& args) override { 887*481dde66SAndroid Build Coastguard Worker return impl_.template Perform<Result>(args); 888*481dde66SAndroid Build Coastguard Worker } 889*481dde66SAndroid Build Coastguard Worker 890*481dde66SAndroid Build Coastguard Worker private: 891*481dde66SAndroid Build Coastguard Worker Impl impl_; 892*481dde66SAndroid Build Coastguard Worker }; 893*481dde66SAndroid Build Coastguard Worker 894*481dde66SAndroid Build Coastguard Worker Impl impl_; 895*481dde66SAndroid Build Coastguard Worker }; 896*481dde66SAndroid Build Coastguard Worker 897*481dde66SAndroid Build Coastguard Worker // Creates an Action from its implementation and returns it. The 898*481dde66SAndroid Build Coastguard Worker // created Action object owns the implementation. 899*481dde66SAndroid Build Coastguard Worker template <typename F> 900*481dde66SAndroid Build Coastguard Worker Action<F> MakeAction(ActionInterface<F>* impl) { 901*481dde66SAndroid Build Coastguard Worker return Action<F>(impl); 902*481dde66SAndroid Build Coastguard Worker } 903*481dde66SAndroid Build Coastguard Worker 904*481dde66SAndroid Build Coastguard Worker // Creates a polymorphic action from its implementation. This is 905*481dde66SAndroid Build Coastguard Worker // easier to use than the PolymorphicAction<Impl> constructor as it 906*481dde66SAndroid Build Coastguard Worker // doesn't require you to explicitly write the template argument, e.g. 907*481dde66SAndroid Build Coastguard Worker // 908*481dde66SAndroid Build Coastguard Worker // MakePolymorphicAction(foo); 909*481dde66SAndroid Build Coastguard Worker // vs 910*481dde66SAndroid Build Coastguard Worker // PolymorphicAction<TypeOfFoo>(foo); 911*481dde66SAndroid Build Coastguard Worker template <typename Impl> 912*481dde66SAndroid Build Coastguard Worker inline PolymorphicAction<Impl> MakePolymorphicAction(const Impl& impl) { 913*481dde66SAndroid Build Coastguard Worker return PolymorphicAction<Impl>(impl); 914*481dde66SAndroid Build Coastguard Worker } 915*481dde66SAndroid Build Coastguard Worker 916*481dde66SAndroid Build Coastguard Worker namespace internal { 917*481dde66SAndroid Build Coastguard Worker 918*481dde66SAndroid Build Coastguard Worker // Helper struct to specialize ReturnAction to execute a move instead of a copy 919*481dde66SAndroid Build Coastguard Worker // on return. Useful for move-only types, but could be used on any type. 920*481dde66SAndroid Build Coastguard Worker template <typename T> 921*481dde66SAndroid Build Coastguard Worker struct ByMoveWrapper { 922*481dde66SAndroid Build Coastguard Worker explicit ByMoveWrapper(T value) : payload(std::move(value)) {} 923*481dde66SAndroid Build Coastguard Worker T payload; 924*481dde66SAndroid Build Coastguard Worker }; 925*481dde66SAndroid Build Coastguard Worker 926*481dde66SAndroid Build Coastguard Worker // The general implementation of Return(R). Specializations follow below. 927*481dde66SAndroid Build Coastguard Worker template <typename R> 928*481dde66SAndroid Build Coastguard Worker class ReturnAction final { 929*481dde66SAndroid Build Coastguard Worker public: 930*481dde66SAndroid Build Coastguard Worker explicit ReturnAction(R value) : value_(std::move(value)) {} 931*481dde66SAndroid Build Coastguard Worker 932*481dde66SAndroid Build Coastguard Worker template <typename U, typename... Args, 933*481dde66SAndroid Build Coastguard Worker typename = typename std::enable_if<conjunction< 934*481dde66SAndroid Build Coastguard Worker // See the requirements documented on Return. 935*481dde66SAndroid Build Coastguard Worker negation<std::is_same<void, U>>, // 936*481dde66SAndroid Build Coastguard Worker negation<std::is_reference<U>>, // 937*481dde66SAndroid Build Coastguard Worker std::is_convertible<R, U>, // 938*481dde66SAndroid Build Coastguard Worker std::is_move_constructible<U>>::value>::type> 939*481dde66SAndroid Build Coastguard Worker operator OnceAction<U(Args...)>() && { // NOLINT 940*481dde66SAndroid Build Coastguard Worker return Impl<U>(std::move(value_)); 941*481dde66SAndroid Build Coastguard Worker } 942*481dde66SAndroid Build Coastguard Worker 943*481dde66SAndroid Build Coastguard Worker template <typename U, typename... Args, 944*481dde66SAndroid Build Coastguard Worker typename = typename std::enable_if<conjunction< 945*481dde66SAndroid Build Coastguard Worker // See the requirements documented on Return. 946*481dde66SAndroid Build Coastguard Worker negation<std::is_same<void, U>>, // 947*481dde66SAndroid Build Coastguard Worker negation<std::is_reference<U>>, // 948*481dde66SAndroid Build Coastguard Worker std::is_convertible<const R&, U>, // 949*481dde66SAndroid Build Coastguard Worker std::is_copy_constructible<U>>::value>::type> 950*481dde66SAndroid Build Coastguard Worker operator Action<U(Args...)>() const { // NOLINT 951*481dde66SAndroid Build Coastguard Worker return Impl<U>(value_); 952*481dde66SAndroid Build Coastguard Worker } 953*481dde66SAndroid Build Coastguard Worker 954*481dde66SAndroid Build Coastguard Worker private: 955*481dde66SAndroid Build Coastguard Worker // Implements the Return(x) action for a mock function that returns type U. 956*481dde66SAndroid Build Coastguard Worker template <typename U> 957*481dde66SAndroid Build Coastguard Worker class Impl final { 958*481dde66SAndroid Build Coastguard Worker public: 959*481dde66SAndroid Build Coastguard Worker // The constructor used when the return value is allowed to move from the 960*481dde66SAndroid Build Coastguard Worker // input value (i.e. we are converting to OnceAction). 961*481dde66SAndroid Build Coastguard Worker explicit Impl(R&& input_value) 962*481dde66SAndroid Build Coastguard Worker : state_(new State(std::move(input_value))) {} 963*481dde66SAndroid Build Coastguard Worker 964*481dde66SAndroid Build Coastguard Worker // The constructor used when the return value is not allowed to move from 965*481dde66SAndroid Build Coastguard Worker // the input value (i.e. we are converting to Action). 966*481dde66SAndroid Build Coastguard Worker explicit Impl(const R& input_value) : state_(new State(input_value)) {} 967*481dde66SAndroid Build Coastguard Worker 968*481dde66SAndroid Build Coastguard Worker U operator()() && { return std::move(state_->value); } 969*481dde66SAndroid Build Coastguard Worker U operator()() const& { return state_->value; } 970*481dde66SAndroid Build Coastguard Worker 971*481dde66SAndroid Build Coastguard Worker private: 972*481dde66SAndroid Build Coastguard Worker // We put our state on the heap so that the compiler-generated copy/move 973*481dde66SAndroid Build Coastguard Worker // constructors work correctly even when U is a reference-like type. This is 974*481dde66SAndroid Build Coastguard Worker // necessary only because we eagerly create State::value (see the note on 975*481dde66SAndroid Build Coastguard Worker // that symbol for details). If we instead had only the input value as a 976*481dde66SAndroid Build Coastguard Worker // member then the default constructors would work fine. 977*481dde66SAndroid Build Coastguard Worker // 978*481dde66SAndroid Build Coastguard Worker // For example, when R is std::string and U is std::string_view, value is a 979*481dde66SAndroid Build Coastguard Worker // reference to the string backed by input_value. The copy constructor would 980*481dde66SAndroid Build Coastguard Worker // copy both, so that we wind up with a new input_value object (with the 981*481dde66SAndroid Build Coastguard Worker // same contents) and a reference to the *old* input_value object rather 982*481dde66SAndroid Build Coastguard Worker // than the new one. 983*481dde66SAndroid Build Coastguard Worker struct State { 984*481dde66SAndroid Build Coastguard Worker explicit State(const R& input_value_in) 985*481dde66SAndroid Build Coastguard Worker : input_value(input_value_in), 986*481dde66SAndroid Build Coastguard Worker // Make an implicit conversion to Result before initializing the U 987*481dde66SAndroid Build Coastguard Worker // object we store, avoiding calling any explicit constructor of U 988*481dde66SAndroid Build Coastguard Worker // from R. 989*481dde66SAndroid Build Coastguard Worker // 990*481dde66SAndroid Build Coastguard Worker // This simulates the language rules: a function with return type U 991*481dde66SAndroid Build Coastguard Worker // that does `return R()` requires R to be implicitly convertible to 992*481dde66SAndroid Build Coastguard Worker // U, and uses that path for the conversion, even U Result has an 993*481dde66SAndroid Build Coastguard Worker // explicit constructor from R. 994*481dde66SAndroid Build Coastguard Worker value(ImplicitCast_<U>(internal::as_const(input_value))) {} 995*481dde66SAndroid Build Coastguard Worker 996*481dde66SAndroid Build Coastguard Worker // As above, but for the case where we're moving from the ReturnAction 997*481dde66SAndroid Build Coastguard Worker // object because it's being used as a OnceAction. 998*481dde66SAndroid Build Coastguard Worker explicit State(R&& input_value_in) 999*481dde66SAndroid Build Coastguard Worker : input_value(std::move(input_value_in)), 1000*481dde66SAndroid Build Coastguard Worker // For the same reason as above we make an implicit conversion to U 1001*481dde66SAndroid Build Coastguard Worker // before initializing the value. 1002*481dde66SAndroid Build Coastguard Worker // 1003*481dde66SAndroid Build Coastguard Worker // Unlike above we provide the input value as an rvalue to the 1004*481dde66SAndroid Build Coastguard Worker // implicit conversion because this is a OnceAction: it's fine if it 1005*481dde66SAndroid Build Coastguard Worker // wants to consume the input value. 1006*481dde66SAndroid Build Coastguard Worker value(ImplicitCast_<U>(std::move(input_value))) {} 1007*481dde66SAndroid Build Coastguard Worker 1008*481dde66SAndroid Build Coastguard Worker // A copy of the value originally provided by the user. We retain this in 1009*481dde66SAndroid Build Coastguard Worker // addition to the value of the mock function's result type below in case 1010*481dde66SAndroid Build Coastguard Worker // the latter is a reference-like type. See the std::string_view example 1011*481dde66SAndroid Build Coastguard Worker // in the documentation on Return. 1012*481dde66SAndroid Build Coastguard Worker R input_value; 1013*481dde66SAndroid Build Coastguard Worker 1014*481dde66SAndroid Build Coastguard Worker // The value we actually return, as the type returned by the mock function 1015*481dde66SAndroid Build Coastguard Worker // itself. 1016*481dde66SAndroid Build Coastguard Worker // 1017*481dde66SAndroid Build Coastguard Worker // We eagerly initialize this here, rather than lazily doing the implicit 1018*481dde66SAndroid Build Coastguard Worker // conversion automatically each time Perform is called, for historical 1019*481dde66SAndroid Build Coastguard Worker // reasons: in 2009-11, commit a070cbd91c (Google changelist 13540126) 1020*481dde66SAndroid Build Coastguard Worker // made the Action<U()> conversion operator eagerly convert the R value to 1021*481dde66SAndroid Build Coastguard Worker // U, but without keeping the R alive. This broke the use case discussed 1022*481dde66SAndroid Build Coastguard Worker // in the documentation for Return, making reference-like types such as 1023*481dde66SAndroid Build Coastguard Worker // std::string_view not safe to use as U where the input type R is a 1024*481dde66SAndroid Build Coastguard Worker // value-like type such as std::string. 1025*481dde66SAndroid Build Coastguard Worker // 1026*481dde66SAndroid Build Coastguard Worker // The example the commit gave was not very clear, nor was the issue 1027*481dde66SAndroid Build Coastguard Worker // thread (https://github.com/google/googlemock/issues/86), but it seems 1028*481dde66SAndroid Build Coastguard Worker // the worry was about reference-like input types R that flatten to a 1029*481dde66SAndroid Build Coastguard Worker // value-like type U when being implicitly converted. An example of this 1030*481dde66SAndroid Build Coastguard Worker // is std::vector<bool>::reference, which is often a proxy type with an 1031*481dde66SAndroid Build Coastguard Worker // reference to the underlying vector: 1032*481dde66SAndroid Build Coastguard Worker // 1033*481dde66SAndroid Build Coastguard Worker // // Helper method: have the mock function return bools according 1034*481dde66SAndroid Build Coastguard Worker // // to the supplied script. 1035*481dde66SAndroid Build Coastguard Worker // void SetActions(MockFunction<bool(size_t)>& mock, 1036*481dde66SAndroid Build Coastguard Worker // const std::vector<bool>& script) { 1037*481dde66SAndroid Build Coastguard Worker // for (size_t i = 0; i < script.size(); ++i) { 1038*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Call(i)).WillOnce(Return(script[i])); 1039*481dde66SAndroid Build Coastguard Worker // } 1040*481dde66SAndroid Build Coastguard Worker // } 1041*481dde66SAndroid Build Coastguard Worker // 1042*481dde66SAndroid Build Coastguard Worker // TEST(Foo, Bar) { 1043*481dde66SAndroid Build Coastguard Worker // // Set actions using a temporary vector, whose operator[] 1044*481dde66SAndroid Build Coastguard Worker // // returns proxy objects that references that will be 1045*481dde66SAndroid Build Coastguard Worker // // dangling once the call to SetActions finishes and the 1046*481dde66SAndroid Build Coastguard Worker // // vector is destroyed. 1047*481dde66SAndroid Build Coastguard Worker // MockFunction<bool(size_t)> mock; 1048*481dde66SAndroid Build Coastguard Worker // SetActions(mock, {false, true}); 1049*481dde66SAndroid Build Coastguard Worker // 1050*481dde66SAndroid Build Coastguard Worker // EXPECT_FALSE(mock.AsStdFunction()(0)); 1051*481dde66SAndroid Build Coastguard Worker // EXPECT_TRUE(mock.AsStdFunction()(1)); 1052*481dde66SAndroid Build Coastguard Worker // } 1053*481dde66SAndroid Build Coastguard Worker // 1054*481dde66SAndroid Build Coastguard Worker // This eager conversion helps with a simple case like this, but doesn't 1055*481dde66SAndroid Build Coastguard Worker // fully make these types work in general. For example the following still 1056*481dde66SAndroid Build Coastguard Worker // uses a dangling reference: 1057*481dde66SAndroid Build Coastguard Worker // 1058*481dde66SAndroid Build Coastguard Worker // TEST(Foo, Baz) { 1059*481dde66SAndroid Build Coastguard Worker // MockFunction<std::vector<std::string>()> mock; 1060*481dde66SAndroid Build Coastguard Worker // 1061*481dde66SAndroid Build Coastguard Worker // // Return the same vector twice, and then the empty vector 1062*481dde66SAndroid Build Coastguard Worker // // thereafter. 1063*481dde66SAndroid Build Coastguard Worker // auto action = Return(std::initializer_list<std::string>{ 1064*481dde66SAndroid Build Coastguard Worker // "taco", "burrito", 1065*481dde66SAndroid Build Coastguard Worker // }); 1066*481dde66SAndroid Build Coastguard Worker // 1067*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Call) 1068*481dde66SAndroid Build Coastguard Worker // .WillOnce(action) 1069*481dde66SAndroid Build Coastguard Worker // .WillOnce(action) 1070*481dde66SAndroid Build Coastguard Worker // .WillRepeatedly(Return(std::vector<std::string>{})); 1071*481dde66SAndroid Build Coastguard Worker // 1072*481dde66SAndroid Build Coastguard Worker // EXPECT_THAT(mock.AsStdFunction()(), 1073*481dde66SAndroid Build Coastguard Worker // ElementsAre("taco", "burrito")); 1074*481dde66SAndroid Build Coastguard Worker // EXPECT_THAT(mock.AsStdFunction()(), 1075*481dde66SAndroid Build Coastguard Worker // ElementsAre("taco", "burrito")); 1076*481dde66SAndroid Build Coastguard Worker // EXPECT_THAT(mock.AsStdFunction()(), IsEmpty()); 1077*481dde66SAndroid Build Coastguard Worker // } 1078*481dde66SAndroid Build Coastguard Worker // 1079*481dde66SAndroid Build Coastguard Worker U value; 1080*481dde66SAndroid Build Coastguard Worker }; 1081*481dde66SAndroid Build Coastguard Worker 1082*481dde66SAndroid Build Coastguard Worker const std::shared_ptr<State> state_; 1083*481dde66SAndroid Build Coastguard Worker }; 1084*481dde66SAndroid Build Coastguard Worker 1085*481dde66SAndroid Build Coastguard Worker R value_; 1086*481dde66SAndroid Build Coastguard Worker }; 1087*481dde66SAndroid Build Coastguard Worker 1088*481dde66SAndroid Build Coastguard Worker // A specialization of ReturnAction<R> when R is ByMoveWrapper<T> for some T. 1089*481dde66SAndroid Build Coastguard Worker // 1090*481dde66SAndroid Build Coastguard Worker // This version applies the type system-defeating hack of moving from T even in 1091*481dde66SAndroid Build Coastguard Worker // the const call operator, checking at runtime that it isn't called more than 1092*481dde66SAndroid Build Coastguard Worker // once, since the user has declared their intent to do so by using ByMove. 1093*481dde66SAndroid Build Coastguard Worker template <typename T> 1094*481dde66SAndroid Build Coastguard Worker class ReturnAction<ByMoveWrapper<T>> final { 1095*481dde66SAndroid Build Coastguard Worker public: 1096*481dde66SAndroid Build Coastguard Worker explicit ReturnAction(ByMoveWrapper<T> wrapper) 1097*481dde66SAndroid Build Coastguard Worker : state_(new State(std::move(wrapper.payload))) {} 1098*481dde66SAndroid Build Coastguard Worker 1099*481dde66SAndroid Build Coastguard Worker T operator()() const { 1100*481dde66SAndroid Build Coastguard Worker GTEST_CHECK_(!state_->called) 1101*481dde66SAndroid Build Coastguard Worker << "A ByMove() action must be performed at most once."; 1102*481dde66SAndroid Build Coastguard Worker 1103*481dde66SAndroid Build Coastguard Worker state_->called = true; 1104*481dde66SAndroid Build Coastguard Worker return std::move(state_->value); 1105*481dde66SAndroid Build Coastguard Worker } 1106*481dde66SAndroid Build Coastguard Worker 1107*481dde66SAndroid Build Coastguard Worker private: 1108*481dde66SAndroid Build Coastguard Worker // We store our state on the heap so that we are copyable as required by 1109*481dde66SAndroid Build Coastguard Worker // Action, despite the fact that we are stateful and T may not be copyable. 1110*481dde66SAndroid Build Coastguard Worker struct State { 1111*481dde66SAndroid Build Coastguard Worker explicit State(T&& value_in) : value(std::move(value_in)) {} 1112*481dde66SAndroid Build Coastguard Worker 1113*481dde66SAndroid Build Coastguard Worker T value; 1114*481dde66SAndroid Build Coastguard Worker bool called = false; 1115*481dde66SAndroid Build Coastguard Worker }; 1116*481dde66SAndroid Build Coastguard Worker 1117*481dde66SAndroid Build Coastguard Worker const std::shared_ptr<State> state_; 1118*481dde66SAndroid Build Coastguard Worker }; 1119*481dde66SAndroid Build Coastguard Worker 1120*481dde66SAndroid Build Coastguard Worker // Implements the ReturnNull() action. 1121*481dde66SAndroid Build Coastguard Worker class ReturnNullAction { 1122*481dde66SAndroid Build Coastguard Worker public: 1123*481dde66SAndroid Build Coastguard Worker // Allows ReturnNull() to be used in any pointer-returning function. In C++11 1124*481dde66SAndroid Build Coastguard Worker // this is enforced by returning nullptr, and in non-C++11 by asserting a 1125*481dde66SAndroid Build Coastguard Worker // pointer type on compile time. 1126*481dde66SAndroid Build Coastguard Worker template <typename Result, typename ArgumentTuple> 1127*481dde66SAndroid Build Coastguard Worker static Result Perform(const ArgumentTuple&) { 1128*481dde66SAndroid Build Coastguard Worker return nullptr; 1129*481dde66SAndroid Build Coastguard Worker } 1130*481dde66SAndroid Build Coastguard Worker }; 1131*481dde66SAndroid Build Coastguard Worker 1132*481dde66SAndroid Build Coastguard Worker // Implements the Return() action. 1133*481dde66SAndroid Build Coastguard Worker class ReturnVoidAction { 1134*481dde66SAndroid Build Coastguard Worker public: 1135*481dde66SAndroid Build Coastguard Worker // Allows Return() to be used in any void-returning function. 1136*481dde66SAndroid Build Coastguard Worker template <typename Result, typename ArgumentTuple> 1137*481dde66SAndroid Build Coastguard Worker static void Perform(const ArgumentTuple&) { 1138*481dde66SAndroid Build Coastguard Worker static_assert(std::is_void<Result>::value, "Result should be void."); 1139*481dde66SAndroid Build Coastguard Worker } 1140*481dde66SAndroid Build Coastguard Worker }; 1141*481dde66SAndroid Build Coastguard Worker 1142*481dde66SAndroid Build Coastguard Worker // Implements the polymorphic ReturnRef(x) action, which can be used 1143*481dde66SAndroid Build Coastguard Worker // in any function that returns a reference to the type of x, 1144*481dde66SAndroid Build Coastguard Worker // regardless of the argument types. 1145*481dde66SAndroid Build Coastguard Worker template <typename T> 1146*481dde66SAndroid Build Coastguard Worker class ReturnRefAction { 1147*481dde66SAndroid Build Coastguard Worker public: 1148*481dde66SAndroid Build Coastguard Worker // Constructs a ReturnRefAction object from the reference to be returned. 1149*481dde66SAndroid Build Coastguard Worker explicit ReturnRefAction(T& ref) : ref_(ref) {} // NOLINT 1150*481dde66SAndroid Build Coastguard Worker 1151*481dde66SAndroid Build Coastguard Worker // This template type conversion operator allows ReturnRef(x) to be 1152*481dde66SAndroid Build Coastguard Worker // used in ANY function that returns a reference to x's type. 1153*481dde66SAndroid Build Coastguard Worker template <typename F> 1154*481dde66SAndroid Build Coastguard Worker operator Action<F>() const { 1155*481dde66SAndroid Build Coastguard Worker typedef typename Function<F>::Result Result; 1156*481dde66SAndroid Build Coastguard Worker // Asserts that the function return type is a reference. This 1157*481dde66SAndroid Build Coastguard Worker // catches the user error of using ReturnRef(x) when Return(x) 1158*481dde66SAndroid Build Coastguard Worker // should be used, and generates some helpful error message. 1159*481dde66SAndroid Build Coastguard Worker static_assert(std::is_reference<Result>::value, 1160*481dde66SAndroid Build Coastguard Worker "use Return instead of ReturnRef to return a value"); 1161*481dde66SAndroid Build Coastguard Worker return Action<F>(new Impl<F>(ref_)); 1162*481dde66SAndroid Build Coastguard Worker } 1163*481dde66SAndroid Build Coastguard Worker 1164*481dde66SAndroid Build Coastguard Worker private: 1165*481dde66SAndroid Build Coastguard Worker // Implements the ReturnRef(x) action for a particular function type F. 1166*481dde66SAndroid Build Coastguard Worker template <typename F> 1167*481dde66SAndroid Build Coastguard Worker class Impl : public ActionInterface<F> { 1168*481dde66SAndroid Build Coastguard Worker public: 1169*481dde66SAndroid Build Coastguard Worker typedef typename Function<F>::Result Result; 1170*481dde66SAndroid Build Coastguard Worker typedef typename Function<F>::ArgumentTuple ArgumentTuple; 1171*481dde66SAndroid Build Coastguard Worker 1172*481dde66SAndroid Build Coastguard Worker explicit Impl(T& ref) : ref_(ref) {} // NOLINT 1173*481dde66SAndroid Build Coastguard Worker 1174*481dde66SAndroid Build Coastguard Worker Result Perform(const ArgumentTuple&) override { return ref_; } 1175*481dde66SAndroid Build Coastguard Worker 1176*481dde66SAndroid Build Coastguard Worker private: 1177*481dde66SAndroid Build Coastguard Worker T& ref_; 1178*481dde66SAndroid Build Coastguard Worker }; 1179*481dde66SAndroid Build Coastguard Worker 1180*481dde66SAndroid Build Coastguard Worker T& ref_; 1181*481dde66SAndroid Build Coastguard Worker }; 1182*481dde66SAndroid Build Coastguard Worker 1183*481dde66SAndroid Build Coastguard Worker // Implements the polymorphic ReturnRefOfCopy(x) action, which can be 1184*481dde66SAndroid Build Coastguard Worker // used in any function that returns a reference to the type of x, 1185*481dde66SAndroid Build Coastguard Worker // regardless of the argument types. 1186*481dde66SAndroid Build Coastguard Worker template <typename T> 1187*481dde66SAndroid Build Coastguard Worker class ReturnRefOfCopyAction { 1188*481dde66SAndroid Build Coastguard Worker public: 1189*481dde66SAndroid Build Coastguard Worker // Constructs a ReturnRefOfCopyAction object from the reference to 1190*481dde66SAndroid Build Coastguard Worker // be returned. 1191*481dde66SAndroid Build Coastguard Worker explicit ReturnRefOfCopyAction(const T& value) : value_(value) {} // NOLINT 1192*481dde66SAndroid Build Coastguard Worker 1193*481dde66SAndroid Build Coastguard Worker // This template type conversion operator allows ReturnRefOfCopy(x) to be 1194*481dde66SAndroid Build Coastguard Worker // used in ANY function that returns a reference to x's type. 1195*481dde66SAndroid Build Coastguard Worker template <typename F> 1196*481dde66SAndroid Build Coastguard Worker operator Action<F>() const { 1197*481dde66SAndroid Build Coastguard Worker typedef typename Function<F>::Result Result; 1198*481dde66SAndroid Build Coastguard Worker // Asserts that the function return type is a reference. This 1199*481dde66SAndroid Build Coastguard Worker // catches the user error of using ReturnRefOfCopy(x) when Return(x) 1200*481dde66SAndroid Build Coastguard Worker // should be used, and generates some helpful error message. 1201*481dde66SAndroid Build Coastguard Worker static_assert(std::is_reference<Result>::value, 1202*481dde66SAndroid Build Coastguard Worker "use Return instead of ReturnRefOfCopy to return a value"); 1203*481dde66SAndroid Build Coastguard Worker return Action<F>(new Impl<F>(value_)); 1204*481dde66SAndroid Build Coastguard Worker } 1205*481dde66SAndroid Build Coastguard Worker 1206*481dde66SAndroid Build Coastguard Worker private: 1207*481dde66SAndroid Build Coastguard Worker // Implements the ReturnRefOfCopy(x) action for a particular function type F. 1208*481dde66SAndroid Build Coastguard Worker template <typename F> 1209*481dde66SAndroid Build Coastguard Worker class Impl : public ActionInterface<F> { 1210*481dde66SAndroid Build Coastguard Worker public: 1211*481dde66SAndroid Build Coastguard Worker typedef typename Function<F>::Result Result; 1212*481dde66SAndroid Build Coastguard Worker typedef typename Function<F>::ArgumentTuple ArgumentTuple; 1213*481dde66SAndroid Build Coastguard Worker 1214*481dde66SAndroid Build Coastguard Worker explicit Impl(const T& value) : value_(value) {} // NOLINT 1215*481dde66SAndroid Build Coastguard Worker 1216*481dde66SAndroid Build Coastguard Worker Result Perform(const ArgumentTuple&) override { return value_; } 1217*481dde66SAndroid Build Coastguard Worker 1218*481dde66SAndroid Build Coastguard Worker private: 1219*481dde66SAndroid Build Coastguard Worker T value_; 1220*481dde66SAndroid Build Coastguard Worker }; 1221*481dde66SAndroid Build Coastguard Worker 1222*481dde66SAndroid Build Coastguard Worker const T value_; 1223*481dde66SAndroid Build Coastguard Worker }; 1224*481dde66SAndroid Build Coastguard Worker 1225*481dde66SAndroid Build Coastguard Worker // Implements the polymorphic ReturnRoundRobin(v) action, which can be 1226*481dde66SAndroid Build Coastguard Worker // used in any function that returns the element_type of v. 1227*481dde66SAndroid Build Coastguard Worker template <typename T> 1228*481dde66SAndroid Build Coastguard Worker class ReturnRoundRobinAction { 1229*481dde66SAndroid Build Coastguard Worker public: 1230*481dde66SAndroid Build Coastguard Worker explicit ReturnRoundRobinAction(std::vector<T> values) { 1231*481dde66SAndroid Build Coastguard Worker GTEST_CHECK_(!values.empty()) 1232*481dde66SAndroid Build Coastguard Worker << "ReturnRoundRobin requires at least one element."; 1233*481dde66SAndroid Build Coastguard Worker state_->values = std::move(values); 1234*481dde66SAndroid Build Coastguard Worker } 1235*481dde66SAndroid Build Coastguard Worker 1236*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1237*481dde66SAndroid Build Coastguard Worker T operator()(Args&&...) const { 1238*481dde66SAndroid Build Coastguard Worker return state_->Next(); 1239*481dde66SAndroid Build Coastguard Worker } 1240*481dde66SAndroid Build Coastguard Worker 1241*481dde66SAndroid Build Coastguard Worker private: 1242*481dde66SAndroid Build Coastguard Worker struct State { 1243*481dde66SAndroid Build Coastguard Worker T Next() { 1244*481dde66SAndroid Build Coastguard Worker T ret_val = values[i++]; 1245*481dde66SAndroid Build Coastguard Worker if (i == values.size()) i = 0; 1246*481dde66SAndroid Build Coastguard Worker return ret_val; 1247*481dde66SAndroid Build Coastguard Worker } 1248*481dde66SAndroid Build Coastguard Worker 1249*481dde66SAndroid Build Coastguard Worker std::vector<T> values; 1250*481dde66SAndroid Build Coastguard Worker size_t i = 0; 1251*481dde66SAndroid Build Coastguard Worker }; 1252*481dde66SAndroid Build Coastguard Worker std::shared_ptr<State> state_ = std::make_shared<State>(); 1253*481dde66SAndroid Build Coastguard Worker }; 1254*481dde66SAndroid Build Coastguard Worker 1255*481dde66SAndroid Build Coastguard Worker // Implements the polymorphic DoDefault() action. 1256*481dde66SAndroid Build Coastguard Worker class DoDefaultAction { 1257*481dde66SAndroid Build Coastguard Worker public: 1258*481dde66SAndroid Build Coastguard Worker // This template type conversion operator allows DoDefault() to be 1259*481dde66SAndroid Build Coastguard Worker // used in any function. 1260*481dde66SAndroid Build Coastguard Worker template <typename F> 1261*481dde66SAndroid Build Coastguard Worker operator Action<F>() const { 1262*481dde66SAndroid Build Coastguard Worker return Action<F>(); 1263*481dde66SAndroid Build Coastguard Worker } // NOLINT 1264*481dde66SAndroid Build Coastguard Worker }; 1265*481dde66SAndroid Build Coastguard Worker 1266*481dde66SAndroid Build Coastguard Worker // Implements the Assign action to set a given pointer referent to a 1267*481dde66SAndroid Build Coastguard Worker // particular value. 1268*481dde66SAndroid Build Coastguard Worker template <typename T1, typename T2> 1269*481dde66SAndroid Build Coastguard Worker class AssignAction { 1270*481dde66SAndroid Build Coastguard Worker public: 1271*481dde66SAndroid Build Coastguard Worker AssignAction(T1* ptr, T2 value) : ptr_(ptr), value_(value) {} 1272*481dde66SAndroid Build Coastguard Worker 1273*481dde66SAndroid Build Coastguard Worker template <typename Result, typename ArgumentTuple> 1274*481dde66SAndroid Build Coastguard Worker void Perform(const ArgumentTuple& /* args */) const { 1275*481dde66SAndroid Build Coastguard Worker *ptr_ = value_; 1276*481dde66SAndroid Build Coastguard Worker } 1277*481dde66SAndroid Build Coastguard Worker 1278*481dde66SAndroid Build Coastguard Worker private: 1279*481dde66SAndroid Build Coastguard Worker T1* const ptr_; 1280*481dde66SAndroid Build Coastguard Worker const T2 value_; 1281*481dde66SAndroid Build Coastguard Worker }; 1282*481dde66SAndroid Build Coastguard Worker 1283*481dde66SAndroid Build Coastguard Worker #ifndef GTEST_OS_WINDOWS_MOBILE 1284*481dde66SAndroid Build Coastguard Worker 1285*481dde66SAndroid Build Coastguard Worker // Implements the SetErrnoAndReturn action to simulate return from 1286*481dde66SAndroid Build Coastguard Worker // various system calls and libc functions. 1287*481dde66SAndroid Build Coastguard Worker template <typename T> 1288*481dde66SAndroid Build Coastguard Worker class SetErrnoAndReturnAction { 1289*481dde66SAndroid Build Coastguard Worker public: 1290*481dde66SAndroid Build Coastguard Worker SetErrnoAndReturnAction(int errno_value, T result) 1291*481dde66SAndroid Build Coastguard Worker : errno_(errno_value), result_(result) {} 1292*481dde66SAndroid Build Coastguard Worker template <typename Result, typename ArgumentTuple> 1293*481dde66SAndroid Build Coastguard Worker Result Perform(const ArgumentTuple& /* args */) const { 1294*481dde66SAndroid Build Coastguard Worker errno = errno_; 1295*481dde66SAndroid Build Coastguard Worker return result_; 1296*481dde66SAndroid Build Coastguard Worker } 1297*481dde66SAndroid Build Coastguard Worker 1298*481dde66SAndroid Build Coastguard Worker private: 1299*481dde66SAndroid Build Coastguard Worker const int errno_; 1300*481dde66SAndroid Build Coastguard Worker const T result_; 1301*481dde66SAndroid Build Coastguard Worker }; 1302*481dde66SAndroid Build Coastguard Worker 1303*481dde66SAndroid Build Coastguard Worker #endif // !GTEST_OS_WINDOWS_MOBILE 1304*481dde66SAndroid Build Coastguard Worker 1305*481dde66SAndroid Build Coastguard Worker // Implements the SetArgumentPointee<N>(x) action for any function 1306*481dde66SAndroid Build Coastguard Worker // whose N-th argument (0-based) is a pointer to x's type. 1307*481dde66SAndroid Build Coastguard Worker template <size_t N, typename A, typename = void> 1308*481dde66SAndroid Build Coastguard Worker struct SetArgumentPointeeAction { 1309*481dde66SAndroid Build Coastguard Worker A value; 1310*481dde66SAndroid Build Coastguard Worker 1311*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1312*481dde66SAndroid Build Coastguard Worker void operator()(const Args&... args) const { 1313*481dde66SAndroid Build Coastguard Worker *::std::get<N>(std::tie(args...)) = value; 1314*481dde66SAndroid Build Coastguard Worker } 1315*481dde66SAndroid Build Coastguard Worker }; 1316*481dde66SAndroid Build Coastguard Worker 1317*481dde66SAndroid Build Coastguard Worker // Implements the Invoke(object_ptr, &Class::Method) action. 1318*481dde66SAndroid Build Coastguard Worker template <class Class, typename MethodPtr> 1319*481dde66SAndroid Build Coastguard Worker struct InvokeMethodAction { 1320*481dde66SAndroid Build Coastguard Worker Class* const obj_ptr; 1321*481dde66SAndroid Build Coastguard Worker const MethodPtr method_ptr; 1322*481dde66SAndroid Build Coastguard Worker 1323*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1324*481dde66SAndroid Build Coastguard Worker auto operator()(Args&&... args) const 1325*481dde66SAndroid Build Coastguard Worker -> decltype((obj_ptr->*method_ptr)(std::forward<Args>(args)...)) { 1326*481dde66SAndroid Build Coastguard Worker return (obj_ptr->*method_ptr)(std::forward<Args>(args)...); 1327*481dde66SAndroid Build Coastguard Worker } 1328*481dde66SAndroid Build Coastguard Worker }; 1329*481dde66SAndroid Build Coastguard Worker 1330*481dde66SAndroid Build Coastguard Worker // Implements the InvokeWithoutArgs(f) action. The template argument 1331*481dde66SAndroid Build Coastguard Worker // FunctionImpl is the implementation type of f, which can be either a 1332*481dde66SAndroid Build Coastguard Worker // function pointer or a functor. InvokeWithoutArgs(f) can be used as an 1333*481dde66SAndroid Build Coastguard Worker // Action<F> as long as f's type is compatible with F. 1334*481dde66SAndroid Build Coastguard Worker template <typename FunctionImpl> 1335*481dde66SAndroid Build Coastguard Worker struct InvokeWithoutArgsAction { 1336*481dde66SAndroid Build Coastguard Worker FunctionImpl function_impl; 1337*481dde66SAndroid Build Coastguard Worker 1338*481dde66SAndroid Build Coastguard Worker // Allows InvokeWithoutArgs(f) to be used as any action whose type is 1339*481dde66SAndroid Build Coastguard Worker // compatible with f. 1340*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1341*481dde66SAndroid Build Coastguard Worker auto operator()(const Args&...) -> decltype(function_impl()) { 1342*481dde66SAndroid Build Coastguard Worker return function_impl(); 1343*481dde66SAndroid Build Coastguard Worker } 1344*481dde66SAndroid Build Coastguard Worker }; 1345*481dde66SAndroid Build Coastguard Worker 1346*481dde66SAndroid Build Coastguard Worker // Implements the InvokeWithoutArgs(object_ptr, &Class::Method) action. 1347*481dde66SAndroid Build Coastguard Worker template <class Class, typename MethodPtr> 1348*481dde66SAndroid Build Coastguard Worker struct InvokeMethodWithoutArgsAction { 1349*481dde66SAndroid Build Coastguard Worker Class* const obj_ptr; 1350*481dde66SAndroid Build Coastguard Worker const MethodPtr method_ptr; 1351*481dde66SAndroid Build Coastguard Worker 1352*481dde66SAndroid Build Coastguard Worker using ReturnType = 1353*481dde66SAndroid Build Coastguard Worker decltype((std::declval<Class*>()->*std::declval<MethodPtr>())()); 1354*481dde66SAndroid Build Coastguard Worker 1355*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1356*481dde66SAndroid Build Coastguard Worker ReturnType operator()(const Args&...) const { 1357*481dde66SAndroid Build Coastguard Worker return (obj_ptr->*method_ptr)(); 1358*481dde66SAndroid Build Coastguard Worker } 1359*481dde66SAndroid Build Coastguard Worker }; 1360*481dde66SAndroid Build Coastguard Worker 1361*481dde66SAndroid Build Coastguard Worker // Implements the IgnoreResult(action) action. 1362*481dde66SAndroid Build Coastguard Worker template <typename A> 1363*481dde66SAndroid Build Coastguard Worker class IgnoreResultAction { 1364*481dde66SAndroid Build Coastguard Worker public: 1365*481dde66SAndroid Build Coastguard Worker explicit IgnoreResultAction(const A& action) : action_(action) {} 1366*481dde66SAndroid Build Coastguard Worker 1367*481dde66SAndroid Build Coastguard Worker template <typename F> 1368*481dde66SAndroid Build Coastguard Worker operator Action<F>() const { 1369*481dde66SAndroid Build Coastguard Worker // Assert statement belongs here because this is the best place to verify 1370*481dde66SAndroid Build Coastguard Worker // conditions on F. It produces the clearest error messages 1371*481dde66SAndroid Build Coastguard Worker // in most compilers. 1372*481dde66SAndroid Build Coastguard Worker // Impl really belongs in this scope as a local class but can't 1373*481dde66SAndroid Build Coastguard Worker // because MSVC produces duplicate symbols in different translation units 1374*481dde66SAndroid Build Coastguard Worker // in this case. Until MS fixes that bug we put Impl into the class scope 1375*481dde66SAndroid Build Coastguard Worker // and put the typedef both here (for use in assert statement) and 1376*481dde66SAndroid Build Coastguard Worker // in the Impl class. But both definitions must be the same. 1377*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::Result Result; 1378*481dde66SAndroid Build Coastguard Worker 1379*481dde66SAndroid Build Coastguard Worker // Asserts at compile time that F returns void. 1380*481dde66SAndroid Build Coastguard Worker static_assert(std::is_void<Result>::value, "Result type should be void."); 1381*481dde66SAndroid Build Coastguard Worker 1382*481dde66SAndroid Build Coastguard Worker return Action<F>(new Impl<F>(action_)); 1383*481dde66SAndroid Build Coastguard Worker } 1384*481dde66SAndroid Build Coastguard Worker 1385*481dde66SAndroid Build Coastguard Worker private: 1386*481dde66SAndroid Build Coastguard Worker template <typename F> 1387*481dde66SAndroid Build Coastguard Worker class Impl : public ActionInterface<F> { 1388*481dde66SAndroid Build Coastguard Worker public: 1389*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::Result Result; 1390*481dde66SAndroid Build Coastguard Worker typedef typename internal::Function<F>::ArgumentTuple ArgumentTuple; 1391*481dde66SAndroid Build Coastguard Worker 1392*481dde66SAndroid Build Coastguard Worker explicit Impl(const A& action) : action_(action) {} 1393*481dde66SAndroid Build Coastguard Worker 1394*481dde66SAndroid Build Coastguard Worker void Perform(const ArgumentTuple& args) override { 1395*481dde66SAndroid Build Coastguard Worker // Performs the action and ignores its result. 1396*481dde66SAndroid Build Coastguard Worker action_.Perform(args); 1397*481dde66SAndroid Build Coastguard Worker } 1398*481dde66SAndroid Build Coastguard Worker 1399*481dde66SAndroid Build Coastguard Worker private: 1400*481dde66SAndroid Build Coastguard Worker // Type OriginalFunction is the same as F except that its return 1401*481dde66SAndroid Build Coastguard Worker // type is IgnoredValue. 1402*481dde66SAndroid Build Coastguard Worker typedef 1403*481dde66SAndroid Build Coastguard Worker typename internal::Function<F>::MakeResultIgnoredValue OriginalFunction; 1404*481dde66SAndroid Build Coastguard Worker 1405*481dde66SAndroid Build Coastguard Worker const Action<OriginalFunction> action_; 1406*481dde66SAndroid Build Coastguard Worker }; 1407*481dde66SAndroid Build Coastguard Worker 1408*481dde66SAndroid Build Coastguard Worker const A action_; 1409*481dde66SAndroid Build Coastguard Worker }; 1410*481dde66SAndroid Build Coastguard Worker 1411*481dde66SAndroid Build Coastguard Worker template <typename InnerAction, size_t... I> 1412*481dde66SAndroid Build Coastguard Worker struct WithArgsAction { 1413*481dde66SAndroid Build Coastguard Worker InnerAction inner_action; 1414*481dde66SAndroid Build Coastguard Worker 1415*481dde66SAndroid Build Coastguard Worker // The signature of the function as seen by the inner action, given an out 1416*481dde66SAndroid Build Coastguard Worker // action with the given result and argument types. 1417*481dde66SAndroid Build Coastguard Worker template <typename R, typename... Args> 1418*481dde66SAndroid Build Coastguard Worker using InnerSignature = 1419*481dde66SAndroid Build Coastguard Worker R(typename std::tuple_element<I, std::tuple<Args...>>::type...); 1420*481dde66SAndroid Build Coastguard Worker 1421*481dde66SAndroid Build Coastguard Worker // Rather than a call operator, we must define conversion operators to 1422*481dde66SAndroid Build Coastguard Worker // particular action types. This is necessary for embedded actions like 1423*481dde66SAndroid Build Coastguard Worker // DoDefault(), which rely on an action conversion operators rather than 1424*481dde66SAndroid Build Coastguard Worker // providing a call operator because even with a particular set of arguments 1425*481dde66SAndroid Build Coastguard Worker // they don't have a fixed return type. 1426*481dde66SAndroid Build Coastguard Worker 1427*481dde66SAndroid Build Coastguard Worker template < 1428*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1429*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1430*481dde66SAndroid Build Coastguard Worker std::is_convertible<InnerAction, 1431*481dde66SAndroid Build Coastguard Worker // Unfortunately we can't use the InnerSignature 1432*481dde66SAndroid Build Coastguard Worker // alias here; MSVC complains about the I 1433*481dde66SAndroid Build Coastguard Worker // parameter pack not being expanded (error C3520) 1434*481dde66SAndroid Build Coastguard Worker // despite it being expanded in the type alias. 1435*481dde66SAndroid Build Coastguard Worker // TupleElement is also an MSVC workaround. 1436*481dde66SAndroid Build Coastguard Worker // See its definition for details. 1437*481dde66SAndroid Build Coastguard Worker OnceAction<R(internal::TupleElement< 1438*481dde66SAndroid Build Coastguard Worker I, std::tuple<Args...>>...)>>::value, 1439*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1440*481dde66SAndroid Build Coastguard Worker operator OnceAction<R(Args...)>() && { // NOLINT 1441*481dde66SAndroid Build Coastguard Worker struct OA { 1442*481dde66SAndroid Build Coastguard Worker OnceAction<InnerSignature<R, Args...>> inner_action; 1443*481dde66SAndroid Build Coastguard Worker 1444*481dde66SAndroid Build Coastguard Worker R operator()(Args&&... args) && { 1445*481dde66SAndroid Build Coastguard Worker return std::move(inner_action) 1446*481dde66SAndroid Build Coastguard Worker .Call(std::get<I>( 1447*481dde66SAndroid Build Coastguard Worker std::forward_as_tuple(std::forward<Args>(args)...))...); 1448*481dde66SAndroid Build Coastguard Worker } 1449*481dde66SAndroid Build Coastguard Worker }; 1450*481dde66SAndroid Build Coastguard Worker 1451*481dde66SAndroid Build Coastguard Worker return OA{std::move(inner_action)}; 1452*481dde66SAndroid Build Coastguard Worker } 1453*481dde66SAndroid Build Coastguard Worker 1454*481dde66SAndroid Build Coastguard Worker template < 1455*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1456*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1457*481dde66SAndroid Build Coastguard Worker std::is_convertible<const InnerAction&, 1458*481dde66SAndroid Build Coastguard Worker // Unfortunately we can't use the InnerSignature 1459*481dde66SAndroid Build Coastguard Worker // alias here; MSVC complains about the I 1460*481dde66SAndroid Build Coastguard Worker // parameter pack not being expanded (error C3520) 1461*481dde66SAndroid Build Coastguard Worker // despite it being expanded in the type alias. 1462*481dde66SAndroid Build Coastguard Worker // TupleElement is also an MSVC workaround. 1463*481dde66SAndroid Build Coastguard Worker // See its definition for details. 1464*481dde66SAndroid Build Coastguard Worker Action<R(internal::TupleElement< 1465*481dde66SAndroid Build Coastguard Worker I, std::tuple<Args...>>...)>>::value, 1466*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1467*481dde66SAndroid Build Coastguard Worker operator Action<R(Args...)>() const { // NOLINT 1468*481dde66SAndroid Build Coastguard Worker Action<InnerSignature<R, Args...>> converted(inner_action); 1469*481dde66SAndroid Build Coastguard Worker 1470*481dde66SAndroid Build Coastguard Worker return [converted](Args&&... args) -> R { 1471*481dde66SAndroid Build Coastguard Worker return converted.Perform(std::forward_as_tuple( 1472*481dde66SAndroid Build Coastguard Worker std::get<I>(std::forward_as_tuple(std::forward<Args>(args)...))...)); 1473*481dde66SAndroid Build Coastguard Worker }; 1474*481dde66SAndroid Build Coastguard Worker } 1475*481dde66SAndroid Build Coastguard Worker }; 1476*481dde66SAndroid Build Coastguard Worker 1477*481dde66SAndroid Build Coastguard Worker template <typename... Actions> 1478*481dde66SAndroid Build Coastguard Worker class DoAllAction; 1479*481dde66SAndroid Build Coastguard Worker 1480*481dde66SAndroid Build Coastguard Worker // Base case: only a single action. 1481*481dde66SAndroid Build Coastguard Worker template <typename FinalAction> 1482*481dde66SAndroid Build Coastguard Worker class DoAllAction<FinalAction> { 1483*481dde66SAndroid Build Coastguard Worker public: 1484*481dde66SAndroid Build Coastguard Worker struct UserConstructorTag {}; 1485*481dde66SAndroid Build Coastguard Worker 1486*481dde66SAndroid Build Coastguard Worker template <typename T> 1487*481dde66SAndroid Build Coastguard Worker explicit DoAllAction(UserConstructorTag, T&& action) 1488*481dde66SAndroid Build Coastguard Worker : final_action_(std::forward<T>(action)) {} 1489*481dde66SAndroid Build Coastguard Worker 1490*481dde66SAndroid Build Coastguard Worker // Rather than a call operator, we must define conversion operators to 1491*481dde66SAndroid Build Coastguard Worker // particular action types. This is necessary for embedded actions like 1492*481dde66SAndroid Build Coastguard Worker // DoDefault(), which rely on an action conversion operators rather than 1493*481dde66SAndroid Build Coastguard Worker // providing a call operator because even with a particular set of arguments 1494*481dde66SAndroid Build Coastguard Worker // they don't have a fixed return type. 1495*481dde66SAndroid Build Coastguard Worker 1496*481dde66SAndroid Build Coastguard Worker // We support conversion to OnceAction whenever the sub-action does. 1497*481dde66SAndroid Build Coastguard Worker template <typename R, typename... Args, 1498*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1499*481dde66SAndroid Build Coastguard Worker std::is_convertible<FinalAction, OnceAction<R(Args...)>>::value, 1500*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1501*481dde66SAndroid Build Coastguard Worker operator OnceAction<R(Args...)>() && { // NOLINT 1502*481dde66SAndroid Build Coastguard Worker return std::move(final_action_); 1503*481dde66SAndroid Build Coastguard Worker } 1504*481dde66SAndroid Build Coastguard Worker 1505*481dde66SAndroid Build Coastguard Worker // We also support conversion to OnceAction whenever the sub-action supports 1506*481dde66SAndroid Build Coastguard Worker // conversion to Action (since any Action can also be a OnceAction). 1507*481dde66SAndroid Build Coastguard Worker template < 1508*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1509*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1510*481dde66SAndroid Build Coastguard Worker conjunction< 1511*481dde66SAndroid Build Coastguard Worker negation< 1512*481dde66SAndroid Build Coastguard Worker std::is_convertible<FinalAction, OnceAction<R(Args...)>>>, 1513*481dde66SAndroid Build Coastguard Worker std::is_convertible<FinalAction, Action<R(Args...)>>>::value, 1514*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1515*481dde66SAndroid Build Coastguard Worker operator OnceAction<R(Args...)>() && { // NOLINT 1516*481dde66SAndroid Build Coastguard Worker return Action<R(Args...)>(std::move(final_action_)); 1517*481dde66SAndroid Build Coastguard Worker } 1518*481dde66SAndroid Build Coastguard Worker 1519*481dde66SAndroid Build Coastguard Worker // We support conversion to Action whenever the sub-action does. 1520*481dde66SAndroid Build Coastguard Worker template < 1521*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1522*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1523*481dde66SAndroid Build Coastguard Worker std::is_convertible<const FinalAction&, Action<R(Args...)>>::value, 1524*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1525*481dde66SAndroid Build Coastguard Worker operator Action<R(Args...)>() const { // NOLINT 1526*481dde66SAndroid Build Coastguard Worker return final_action_; 1527*481dde66SAndroid Build Coastguard Worker } 1528*481dde66SAndroid Build Coastguard Worker 1529*481dde66SAndroid Build Coastguard Worker private: 1530*481dde66SAndroid Build Coastguard Worker FinalAction final_action_; 1531*481dde66SAndroid Build Coastguard Worker }; 1532*481dde66SAndroid Build Coastguard Worker 1533*481dde66SAndroid Build Coastguard Worker // Recursive case: support N actions by calling the initial action and then 1534*481dde66SAndroid Build Coastguard Worker // calling through to the base class containing N-1 actions. 1535*481dde66SAndroid Build Coastguard Worker template <typename InitialAction, typename... OtherActions> 1536*481dde66SAndroid Build Coastguard Worker class DoAllAction<InitialAction, OtherActions...> 1537*481dde66SAndroid Build Coastguard Worker : private DoAllAction<OtherActions...> { 1538*481dde66SAndroid Build Coastguard Worker private: 1539*481dde66SAndroid Build Coastguard Worker using Base = DoAllAction<OtherActions...>; 1540*481dde66SAndroid Build Coastguard Worker 1541*481dde66SAndroid Build Coastguard Worker // The type of reference that should be provided to an initial action for a 1542*481dde66SAndroid Build Coastguard Worker // mocked function parameter of type T. 1543*481dde66SAndroid Build Coastguard Worker // 1544*481dde66SAndroid Build Coastguard Worker // There are two quirks here: 1545*481dde66SAndroid Build Coastguard Worker // 1546*481dde66SAndroid Build Coastguard Worker // * Unlike most forwarding functions, we pass scalars through by value. 1547*481dde66SAndroid Build Coastguard Worker // This isn't strictly necessary because an lvalue reference would work 1548*481dde66SAndroid Build Coastguard Worker // fine too and be consistent with other non-reference types, but it's 1549*481dde66SAndroid Build Coastguard Worker // perhaps less surprising. 1550*481dde66SAndroid Build Coastguard Worker // 1551*481dde66SAndroid Build Coastguard Worker // For example if the mocked function has signature void(int), then it 1552*481dde66SAndroid Build Coastguard Worker // might seem surprising for the user's initial action to need to be 1553*481dde66SAndroid Build Coastguard Worker // convertible to Action<void(const int&)>. This is perhaps less 1554*481dde66SAndroid Build Coastguard Worker // surprising for a non-scalar type where there may be a performance 1555*481dde66SAndroid Build Coastguard Worker // impact, or it might even be impossible, to pass by value. 1556*481dde66SAndroid Build Coastguard Worker // 1557*481dde66SAndroid Build Coastguard Worker // * More surprisingly, `const T&` is often not a const reference type. 1558*481dde66SAndroid Build Coastguard Worker // By the reference collapsing rules in C++17 [dcl.ref]/6, if T refers to 1559*481dde66SAndroid Build Coastguard Worker // U& or U&& for some non-scalar type U, then InitialActionArgType<T> is 1560*481dde66SAndroid Build Coastguard Worker // U&. In other words, we may hand over a non-const reference. 1561*481dde66SAndroid Build Coastguard Worker // 1562*481dde66SAndroid Build Coastguard Worker // So for example, given some non-scalar type Obj we have the following 1563*481dde66SAndroid Build Coastguard Worker // mappings: 1564*481dde66SAndroid Build Coastguard Worker // 1565*481dde66SAndroid Build Coastguard Worker // T InitialActionArgType<T> 1566*481dde66SAndroid Build Coastguard Worker // ------- ----------------------- 1567*481dde66SAndroid Build Coastguard Worker // Obj const Obj& 1568*481dde66SAndroid Build Coastguard Worker // Obj& Obj& 1569*481dde66SAndroid Build Coastguard Worker // Obj&& Obj& 1570*481dde66SAndroid Build Coastguard Worker // const Obj const Obj& 1571*481dde66SAndroid Build Coastguard Worker // const Obj& const Obj& 1572*481dde66SAndroid Build Coastguard Worker // const Obj&& const Obj& 1573*481dde66SAndroid Build Coastguard Worker // 1574*481dde66SAndroid Build Coastguard Worker // In other words, the initial actions get a mutable view of an non-scalar 1575*481dde66SAndroid Build Coastguard Worker // argument if and only if the mock function itself accepts a non-const 1576*481dde66SAndroid Build Coastguard Worker // reference type. They are never given an rvalue reference to an 1577*481dde66SAndroid Build Coastguard Worker // non-scalar type. 1578*481dde66SAndroid Build Coastguard Worker // 1579*481dde66SAndroid Build Coastguard Worker // This situation makes sense if you imagine use with a matcher that is 1580*481dde66SAndroid Build Coastguard Worker // designed to write through a reference. For example, if the caller wants 1581*481dde66SAndroid Build Coastguard Worker // to fill in a reference argument and then return a canned value: 1582*481dde66SAndroid Build Coastguard Worker // 1583*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Call) 1584*481dde66SAndroid Build Coastguard Worker // .WillOnce(DoAll(SetArgReferee<0>(17), Return(19))); 1585*481dde66SAndroid Build Coastguard Worker // 1586*481dde66SAndroid Build Coastguard Worker template <typename T> 1587*481dde66SAndroid Build Coastguard Worker using InitialActionArgType = 1588*481dde66SAndroid Build Coastguard Worker typename std::conditional<std::is_scalar<T>::value, T, const T&>::type; 1589*481dde66SAndroid Build Coastguard Worker 1590*481dde66SAndroid Build Coastguard Worker public: 1591*481dde66SAndroid Build Coastguard Worker struct UserConstructorTag {}; 1592*481dde66SAndroid Build Coastguard Worker 1593*481dde66SAndroid Build Coastguard Worker template <typename T, typename... U> 1594*481dde66SAndroid Build Coastguard Worker explicit DoAllAction(UserConstructorTag, T&& initial_action, 1595*481dde66SAndroid Build Coastguard Worker U&&... other_actions) 1596*481dde66SAndroid Build Coastguard Worker : Base({}, std::forward<U>(other_actions)...), 1597*481dde66SAndroid Build Coastguard Worker initial_action_(std::forward<T>(initial_action)) {} 1598*481dde66SAndroid Build Coastguard Worker 1599*481dde66SAndroid Build Coastguard Worker // We support conversion to OnceAction whenever both the initial action and 1600*481dde66SAndroid Build Coastguard Worker // the rest support conversion to OnceAction. 1601*481dde66SAndroid Build Coastguard Worker template < 1602*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1603*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1604*481dde66SAndroid Build Coastguard Worker conjunction<std::is_convertible< 1605*481dde66SAndroid Build Coastguard Worker InitialAction, 1606*481dde66SAndroid Build Coastguard Worker OnceAction<void(InitialActionArgType<Args>...)>>, 1607*481dde66SAndroid Build Coastguard Worker std::is_convertible<Base, OnceAction<R(Args...)>>>::value, 1608*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1609*481dde66SAndroid Build Coastguard Worker operator OnceAction<R(Args...)>() && { // NOLINT 1610*481dde66SAndroid Build Coastguard Worker // Return an action that first calls the initial action with arguments 1611*481dde66SAndroid Build Coastguard Worker // filtered through InitialActionArgType, then forwards arguments directly 1612*481dde66SAndroid Build Coastguard Worker // to the base class to deal with the remaining actions. 1613*481dde66SAndroid Build Coastguard Worker struct OA { 1614*481dde66SAndroid Build Coastguard Worker OnceAction<void(InitialActionArgType<Args>...)> initial_action; 1615*481dde66SAndroid Build Coastguard Worker OnceAction<R(Args...)> remaining_actions; 1616*481dde66SAndroid Build Coastguard Worker 1617*481dde66SAndroid Build Coastguard Worker R operator()(Args... args) && { 1618*481dde66SAndroid Build Coastguard Worker std::move(initial_action) 1619*481dde66SAndroid Build Coastguard Worker .Call(static_cast<InitialActionArgType<Args>>(args)...); 1620*481dde66SAndroid Build Coastguard Worker 1621*481dde66SAndroid Build Coastguard Worker return std::move(remaining_actions).Call(std::forward<Args>(args)...); 1622*481dde66SAndroid Build Coastguard Worker } 1623*481dde66SAndroid Build Coastguard Worker }; 1624*481dde66SAndroid Build Coastguard Worker 1625*481dde66SAndroid Build Coastguard Worker return OA{ 1626*481dde66SAndroid Build Coastguard Worker std::move(initial_action_), 1627*481dde66SAndroid Build Coastguard Worker std::move(static_cast<Base&>(*this)), 1628*481dde66SAndroid Build Coastguard Worker }; 1629*481dde66SAndroid Build Coastguard Worker } 1630*481dde66SAndroid Build Coastguard Worker 1631*481dde66SAndroid Build Coastguard Worker // We also support conversion to OnceAction whenever the initial action 1632*481dde66SAndroid Build Coastguard Worker // supports conversion to Action (since any Action can also be a OnceAction). 1633*481dde66SAndroid Build Coastguard Worker // 1634*481dde66SAndroid Build Coastguard Worker // The remaining sub-actions must also be compatible, but we don't need to 1635*481dde66SAndroid Build Coastguard Worker // special case them because the base class deals with them. 1636*481dde66SAndroid Build Coastguard Worker template < 1637*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1638*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1639*481dde66SAndroid Build Coastguard Worker conjunction< 1640*481dde66SAndroid Build Coastguard Worker negation<std::is_convertible< 1641*481dde66SAndroid Build Coastguard Worker InitialAction, 1642*481dde66SAndroid Build Coastguard Worker OnceAction<void(InitialActionArgType<Args>...)>>>, 1643*481dde66SAndroid Build Coastguard Worker std::is_convertible<InitialAction, 1644*481dde66SAndroid Build Coastguard Worker Action<void(InitialActionArgType<Args>...)>>, 1645*481dde66SAndroid Build Coastguard Worker std::is_convertible<Base, OnceAction<R(Args...)>>>::value, 1646*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1647*481dde66SAndroid Build Coastguard Worker operator OnceAction<R(Args...)>() && { // NOLINT 1648*481dde66SAndroid Build Coastguard Worker return DoAll( 1649*481dde66SAndroid Build Coastguard Worker Action<void(InitialActionArgType<Args>...)>(std::move(initial_action_)), 1650*481dde66SAndroid Build Coastguard Worker std::move(static_cast<Base&>(*this))); 1651*481dde66SAndroid Build Coastguard Worker } 1652*481dde66SAndroid Build Coastguard Worker 1653*481dde66SAndroid Build Coastguard Worker // We support conversion to Action whenever both the initial action and the 1654*481dde66SAndroid Build Coastguard Worker // rest support conversion to Action. 1655*481dde66SAndroid Build Coastguard Worker template < 1656*481dde66SAndroid Build Coastguard Worker typename R, typename... Args, 1657*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 1658*481dde66SAndroid Build Coastguard Worker conjunction< 1659*481dde66SAndroid Build Coastguard Worker std::is_convertible<const InitialAction&, 1660*481dde66SAndroid Build Coastguard Worker Action<void(InitialActionArgType<Args>...)>>, 1661*481dde66SAndroid Build Coastguard Worker std::is_convertible<const Base&, Action<R(Args...)>>>::value, 1662*481dde66SAndroid Build Coastguard Worker int>::type = 0> 1663*481dde66SAndroid Build Coastguard Worker operator Action<R(Args...)>() const { // NOLINT 1664*481dde66SAndroid Build Coastguard Worker // Return an action that first calls the initial action with arguments 1665*481dde66SAndroid Build Coastguard Worker // filtered through InitialActionArgType, then forwards arguments directly 1666*481dde66SAndroid Build Coastguard Worker // to the base class to deal with the remaining actions. 1667*481dde66SAndroid Build Coastguard Worker struct OA { 1668*481dde66SAndroid Build Coastguard Worker Action<void(InitialActionArgType<Args>...)> initial_action; 1669*481dde66SAndroid Build Coastguard Worker Action<R(Args...)> remaining_actions; 1670*481dde66SAndroid Build Coastguard Worker 1671*481dde66SAndroid Build Coastguard Worker R operator()(Args... args) const { 1672*481dde66SAndroid Build Coastguard Worker initial_action.Perform(std::forward_as_tuple( 1673*481dde66SAndroid Build Coastguard Worker static_cast<InitialActionArgType<Args>>(args)...)); 1674*481dde66SAndroid Build Coastguard Worker 1675*481dde66SAndroid Build Coastguard Worker return remaining_actions.Perform( 1676*481dde66SAndroid Build Coastguard Worker std::forward_as_tuple(std::forward<Args>(args)...)); 1677*481dde66SAndroid Build Coastguard Worker } 1678*481dde66SAndroid Build Coastguard Worker }; 1679*481dde66SAndroid Build Coastguard Worker 1680*481dde66SAndroid Build Coastguard Worker return OA{ 1681*481dde66SAndroid Build Coastguard Worker initial_action_, 1682*481dde66SAndroid Build Coastguard Worker static_cast<const Base&>(*this), 1683*481dde66SAndroid Build Coastguard Worker }; 1684*481dde66SAndroid Build Coastguard Worker } 1685*481dde66SAndroid Build Coastguard Worker 1686*481dde66SAndroid Build Coastguard Worker private: 1687*481dde66SAndroid Build Coastguard Worker InitialAction initial_action_; 1688*481dde66SAndroid Build Coastguard Worker }; 1689*481dde66SAndroid Build Coastguard Worker 1690*481dde66SAndroid Build Coastguard Worker template <typename T, typename... Params> 1691*481dde66SAndroid Build Coastguard Worker struct ReturnNewAction { 1692*481dde66SAndroid Build Coastguard Worker T* operator()() const { 1693*481dde66SAndroid Build Coastguard Worker return internal::Apply( 1694*481dde66SAndroid Build Coastguard Worker [](const Params&... unpacked_params) { 1695*481dde66SAndroid Build Coastguard Worker return new T(unpacked_params...); 1696*481dde66SAndroid Build Coastguard Worker }, 1697*481dde66SAndroid Build Coastguard Worker params); 1698*481dde66SAndroid Build Coastguard Worker } 1699*481dde66SAndroid Build Coastguard Worker std::tuple<Params...> params; 1700*481dde66SAndroid Build Coastguard Worker }; 1701*481dde66SAndroid Build Coastguard Worker 1702*481dde66SAndroid Build Coastguard Worker template <size_t k> 1703*481dde66SAndroid Build Coastguard Worker struct ReturnArgAction { 1704*481dde66SAndroid Build Coastguard Worker template <typename... Args, 1705*481dde66SAndroid Build Coastguard Worker typename = typename std::enable_if<(k < sizeof...(Args))>::type> 1706*481dde66SAndroid Build Coastguard Worker auto operator()(Args&&... args) const 1707*481dde66SAndroid Build Coastguard Worker -> decltype(std::get<k>( 1708*481dde66SAndroid Build Coastguard Worker std::forward_as_tuple(std::forward<Args>(args)...))) { 1709*481dde66SAndroid Build Coastguard Worker return std::get<k>(std::forward_as_tuple(std::forward<Args>(args)...)); 1710*481dde66SAndroid Build Coastguard Worker } 1711*481dde66SAndroid Build Coastguard Worker }; 1712*481dde66SAndroid Build Coastguard Worker 1713*481dde66SAndroid Build Coastguard Worker template <size_t k, typename Ptr> 1714*481dde66SAndroid Build Coastguard Worker struct SaveArgAction { 1715*481dde66SAndroid Build Coastguard Worker Ptr pointer; 1716*481dde66SAndroid Build Coastguard Worker 1717*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1718*481dde66SAndroid Build Coastguard Worker void operator()(const Args&... args) const { 1719*481dde66SAndroid Build Coastguard Worker *pointer = std::get<k>(std::tie(args...)); 1720*481dde66SAndroid Build Coastguard Worker } 1721*481dde66SAndroid Build Coastguard Worker }; 1722*481dde66SAndroid Build Coastguard Worker 1723*481dde66SAndroid Build Coastguard Worker template <size_t k, typename Ptr> 1724*481dde66SAndroid Build Coastguard Worker struct SaveArgPointeeAction { 1725*481dde66SAndroid Build Coastguard Worker Ptr pointer; 1726*481dde66SAndroid Build Coastguard Worker 1727*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1728*481dde66SAndroid Build Coastguard Worker void operator()(const Args&... args) const { 1729*481dde66SAndroid Build Coastguard Worker *pointer = *std::get<k>(std::tie(args...)); 1730*481dde66SAndroid Build Coastguard Worker } 1731*481dde66SAndroid Build Coastguard Worker }; 1732*481dde66SAndroid Build Coastguard Worker 1733*481dde66SAndroid Build Coastguard Worker template <size_t k, typename T> 1734*481dde66SAndroid Build Coastguard Worker struct SetArgRefereeAction { 1735*481dde66SAndroid Build Coastguard Worker T value; 1736*481dde66SAndroid Build Coastguard Worker 1737*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1738*481dde66SAndroid Build Coastguard Worker void operator()(Args&&... args) const { 1739*481dde66SAndroid Build Coastguard Worker using argk_type = 1740*481dde66SAndroid Build Coastguard Worker typename ::std::tuple_element<k, std::tuple<Args...>>::type; 1741*481dde66SAndroid Build Coastguard Worker static_assert(std::is_lvalue_reference<argk_type>::value, 1742*481dde66SAndroid Build Coastguard Worker "Argument must be a reference type."); 1743*481dde66SAndroid Build Coastguard Worker std::get<k>(std::tie(args...)) = value; 1744*481dde66SAndroid Build Coastguard Worker } 1745*481dde66SAndroid Build Coastguard Worker }; 1746*481dde66SAndroid Build Coastguard Worker 1747*481dde66SAndroid Build Coastguard Worker template <size_t k, typename I1, typename I2> 1748*481dde66SAndroid Build Coastguard Worker struct SetArrayArgumentAction { 1749*481dde66SAndroid Build Coastguard Worker I1 first; 1750*481dde66SAndroid Build Coastguard Worker I2 last; 1751*481dde66SAndroid Build Coastguard Worker 1752*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1753*481dde66SAndroid Build Coastguard Worker void operator()(const Args&... args) const { 1754*481dde66SAndroid Build Coastguard Worker auto value = std::get<k>(std::tie(args...)); 1755*481dde66SAndroid Build Coastguard Worker for (auto it = first; it != last; ++it, (void)++value) { 1756*481dde66SAndroid Build Coastguard Worker *value = *it; 1757*481dde66SAndroid Build Coastguard Worker } 1758*481dde66SAndroid Build Coastguard Worker } 1759*481dde66SAndroid Build Coastguard Worker }; 1760*481dde66SAndroid Build Coastguard Worker 1761*481dde66SAndroid Build Coastguard Worker template <size_t k> 1762*481dde66SAndroid Build Coastguard Worker struct DeleteArgAction { 1763*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1764*481dde66SAndroid Build Coastguard Worker void operator()(const Args&... args) const { 1765*481dde66SAndroid Build Coastguard Worker delete std::get<k>(std::tie(args...)); 1766*481dde66SAndroid Build Coastguard Worker } 1767*481dde66SAndroid Build Coastguard Worker }; 1768*481dde66SAndroid Build Coastguard Worker 1769*481dde66SAndroid Build Coastguard Worker template <typename Ptr> 1770*481dde66SAndroid Build Coastguard Worker struct ReturnPointeeAction { 1771*481dde66SAndroid Build Coastguard Worker Ptr pointer; 1772*481dde66SAndroid Build Coastguard Worker template <typename... Args> 1773*481dde66SAndroid Build Coastguard Worker auto operator()(const Args&...) const -> decltype(*pointer) { 1774*481dde66SAndroid Build Coastguard Worker return *pointer; 1775*481dde66SAndroid Build Coastguard Worker } 1776*481dde66SAndroid Build Coastguard Worker }; 1777*481dde66SAndroid Build Coastguard Worker 1778*481dde66SAndroid Build Coastguard Worker #if GTEST_HAS_EXCEPTIONS 1779*481dde66SAndroid Build Coastguard Worker template <typename T> 1780*481dde66SAndroid Build Coastguard Worker struct ThrowAction { 1781*481dde66SAndroid Build Coastguard Worker T exception; 1782*481dde66SAndroid Build Coastguard Worker // We use a conversion operator to adapt to any return type. 1783*481dde66SAndroid Build Coastguard Worker template <typename R, typename... Args> 1784*481dde66SAndroid Build Coastguard Worker operator Action<R(Args...)>() const { // NOLINT 1785*481dde66SAndroid Build Coastguard Worker T copy = exception; 1786*481dde66SAndroid Build Coastguard Worker return [copy](Args...) -> R { throw copy; }; 1787*481dde66SAndroid Build Coastguard Worker } 1788*481dde66SAndroid Build Coastguard Worker }; 1789*481dde66SAndroid Build Coastguard Worker struct RethrowAction { 1790*481dde66SAndroid Build Coastguard Worker std::exception_ptr exception; 1791*481dde66SAndroid Build Coastguard Worker template <typename R, typename... Args> 1792*481dde66SAndroid Build Coastguard Worker operator Action<R(Args...)>() const { // NOLINT 1793*481dde66SAndroid Build Coastguard Worker return [ex = exception](Args...) -> R { std::rethrow_exception(ex); }; 1794*481dde66SAndroid Build Coastguard Worker } 1795*481dde66SAndroid Build Coastguard Worker }; 1796*481dde66SAndroid Build Coastguard Worker #endif // GTEST_HAS_EXCEPTIONS 1797*481dde66SAndroid Build Coastguard Worker 1798*481dde66SAndroid Build Coastguard Worker } // namespace internal 1799*481dde66SAndroid Build Coastguard Worker 1800*481dde66SAndroid Build Coastguard Worker // An Unused object can be implicitly constructed from ANY value. 1801*481dde66SAndroid Build Coastguard Worker // This is handy when defining actions that ignore some or all of the 1802*481dde66SAndroid Build Coastguard Worker // mock function arguments. For example, given 1803*481dde66SAndroid Build Coastguard Worker // 1804*481dde66SAndroid Build Coastguard Worker // MOCK_METHOD3(Foo, double(const string& label, double x, double y)); 1805*481dde66SAndroid Build Coastguard Worker // MOCK_METHOD3(Bar, double(int index, double x, double y)); 1806*481dde66SAndroid Build Coastguard Worker // 1807*481dde66SAndroid Build Coastguard Worker // instead of 1808*481dde66SAndroid Build Coastguard Worker // 1809*481dde66SAndroid Build Coastguard Worker // double DistanceToOriginWithLabel(const string& label, double x, double y) { 1810*481dde66SAndroid Build Coastguard Worker // return sqrt(x*x + y*y); 1811*481dde66SAndroid Build Coastguard Worker // } 1812*481dde66SAndroid Build Coastguard Worker // double DistanceToOriginWithIndex(int index, double x, double y) { 1813*481dde66SAndroid Build Coastguard Worker // return sqrt(x*x + y*y); 1814*481dde66SAndroid Build Coastguard Worker // } 1815*481dde66SAndroid Build Coastguard Worker // ... 1816*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Foo("abc", _, _)) 1817*481dde66SAndroid Build Coastguard Worker // .WillOnce(Invoke(DistanceToOriginWithLabel)); 1818*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Bar(5, _, _)) 1819*481dde66SAndroid Build Coastguard Worker // .WillOnce(Invoke(DistanceToOriginWithIndex)); 1820*481dde66SAndroid Build Coastguard Worker // 1821*481dde66SAndroid Build Coastguard Worker // you could write 1822*481dde66SAndroid Build Coastguard Worker // 1823*481dde66SAndroid Build Coastguard Worker // // We can declare any uninteresting argument as Unused. 1824*481dde66SAndroid Build Coastguard Worker // double DistanceToOrigin(Unused, double x, double y) { 1825*481dde66SAndroid Build Coastguard Worker // return sqrt(x*x + y*y); 1826*481dde66SAndroid Build Coastguard Worker // } 1827*481dde66SAndroid Build Coastguard Worker // ... 1828*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Foo("abc", _, _)).WillOnce(Invoke(DistanceToOrigin)); 1829*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Bar(5, _, _)).WillOnce(Invoke(DistanceToOrigin)); 1830*481dde66SAndroid Build Coastguard Worker typedef internal::IgnoredValue Unused; 1831*481dde66SAndroid Build Coastguard Worker 1832*481dde66SAndroid Build Coastguard Worker // Creates an action that does actions a1, a2, ..., sequentially in 1833*481dde66SAndroid Build Coastguard Worker // each invocation. All but the last action will have a readonly view of the 1834*481dde66SAndroid Build Coastguard Worker // arguments. 1835*481dde66SAndroid Build Coastguard Worker template <typename... Action> 1836*481dde66SAndroid Build Coastguard Worker internal::DoAllAction<typename std::decay<Action>::type...> DoAll( 1837*481dde66SAndroid Build Coastguard Worker Action&&... action) { 1838*481dde66SAndroid Build Coastguard Worker return internal::DoAllAction<typename std::decay<Action>::type...>( 1839*481dde66SAndroid Build Coastguard Worker {}, std::forward<Action>(action)...); 1840*481dde66SAndroid Build Coastguard Worker } 1841*481dde66SAndroid Build Coastguard Worker 1842*481dde66SAndroid Build Coastguard Worker // WithArg<k>(an_action) creates an action that passes the k-th 1843*481dde66SAndroid Build Coastguard Worker // (0-based) argument of the mock function to an_action and performs 1844*481dde66SAndroid Build Coastguard Worker // it. It adapts an action accepting one argument to one that accepts 1845*481dde66SAndroid Build Coastguard Worker // multiple arguments. For convenience, we also provide 1846*481dde66SAndroid Build Coastguard Worker // WithArgs<k>(an_action) (defined below) as a synonym. 1847*481dde66SAndroid Build Coastguard Worker template <size_t k, typename InnerAction> 1848*481dde66SAndroid Build Coastguard Worker internal::WithArgsAction<typename std::decay<InnerAction>::type, k> WithArg( 1849*481dde66SAndroid Build Coastguard Worker InnerAction&& action) { 1850*481dde66SAndroid Build Coastguard Worker return {std::forward<InnerAction>(action)}; 1851*481dde66SAndroid Build Coastguard Worker } 1852*481dde66SAndroid Build Coastguard Worker 1853*481dde66SAndroid Build Coastguard Worker // WithArgs<N1, N2, ..., Nk>(an_action) creates an action that passes 1854*481dde66SAndroid Build Coastguard Worker // the selected arguments of the mock function to an_action and 1855*481dde66SAndroid Build Coastguard Worker // performs it. It serves as an adaptor between actions with 1856*481dde66SAndroid Build Coastguard Worker // different argument lists. 1857*481dde66SAndroid Build Coastguard Worker template <size_t k, size_t... ks, typename InnerAction> 1858*481dde66SAndroid Build Coastguard Worker internal::WithArgsAction<typename std::decay<InnerAction>::type, k, ks...> 1859*481dde66SAndroid Build Coastguard Worker WithArgs(InnerAction&& action) { 1860*481dde66SAndroid Build Coastguard Worker return {std::forward<InnerAction>(action)}; 1861*481dde66SAndroid Build Coastguard Worker } 1862*481dde66SAndroid Build Coastguard Worker 1863*481dde66SAndroid Build Coastguard Worker // WithoutArgs(inner_action) can be used in a mock function with a 1864*481dde66SAndroid Build Coastguard Worker // non-empty argument list to perform inner_action, which takes no 1865*481dde66SAndroid Build Coastguard Worker // argument. In other words, it adapts an action accepting no 1866*481dde66SAndroid Build Coastguard Worker // argument to one that accepts (and ignores) arguments. 1867*481dde66SAndroid Build Coastguard Worker template <typename InnerAction> 1868*481dde66SAndroid Build Coastguard Worker internal::WithArgsAction<typename std::decay<InnerAction>::type> WithoutArgs( 1869*481dde66SAndroid Build Coastguard Worker InnerAction&& action) { 1870*481dde66SAndroid Build Coastguard Worker return {std::forward<InnerAction>(action)}; 1871*481dde66SAndroid Build Coastguard Worker } 1872*481dde66SAndroid Build Coastguard Worker 1873*481dde66SAndroid Build Coastguard Worker // Creates an action that returns a value. 1874*481dde66SAndroid Build Coastguard Worker // 1875*481dde66SAndroid Build Coastguard Worker // The returned type can be used with a mock function returning a non-void, 1876*481dde66SAndroid Build Coastguard Worker // non-reference type U as follows: 1877*481dde66SAndroid Build Coastguard Worker // 1878*481dde66SAndroid Build Coastguard Worker // * If R is convertible to U and U is move-constructible, then the action can 1879*481dde66SAndroid Build Coastguard Worker // be used with WillOnce. 1880*481dde66SAndroid Build Coastguard Worker // 1881*481dde66SAndroid Build Coastguard Worker // * If const R& is convertible to U and U is copy-constructible, then the 1882*481dde66SAndroid Build Coastguard Worker // action can be used with both WillOnce and WillRepeatedly. 1883*481dde66SAndroid Build Coastguard Worker // 1884*481dde66SAndroid Build Coastguard Worker // The mock expectation contains the R value from which the U return value is 1885*481dde66SAndroid Build Coastguard Worker // constructed (a move/copy of the argument to Return). This means that the R 1886*481dde66SAndroid Build Coastguard Worker // value will survive at least until the mock object's expectations are cleared 1887*481dde66SAndroid Build Coastguard Worker // or the mock object is destroyed, meaning that U can safely be a 1888*481dde66SAndroid Build Coastguard Worker // reference-like type such as std::string_view: 1889*481dde66SAndroid Build Coastguard Worker // 1890*481dde66SAndroid Build Coastguard Worker // // The mock function returns a view of a copy of the string fed to 1891*481dde66SAndroid Build Coastguard Worker // // Return. The view is valid even after the action is performed. 1892*481dde66SAndroid Build Coastguard Worker // MockFunction<std::string_view()> mock; 1893*481dde66SAndroid Build Coastguard Worker // EXPECT_CALL(mock, Call).WillOnce(Return(std::string("taco"))); 1894*481dde66SAndroid Build Coastguard Worker // const std::string_view result = mock.AsStdFunction()(); 1895*481dde66SAndroid Build Coastguard Worker // EXPECT_EQ("taco", result); 1896*481dde66SAndroid Build Coastguard Worker // 1897*481dde66SAndroid Build Coastguard Worker template <typename R> 1898*481dde66SAndroid Build Coastguard Worker internal::ReturnAction<R> Return(R value) { 1899*481dde66SAndroid Build Coastguard Worker return internal::ReturnAction<R>(std::move(value)); 1900*481dde66SAndroid Build Coastguard Worker } 1901*481dde66SAndroid Build Coastguard Worker 1902*481dde66SAndroid Build Coastguard Worker // Creates an action that returns NULL. 1903*481dde66SAndroid Build Coastguard Worker inline PolymorphicAction<internal::ReturnNullAction> ReturnNull() { 1904*481dde66SAndroid Build Coastguard Worker return MakePolymorphicAction(internal::ReturnNullAction()); 1905*481dde66SAndroid Build Coastguard Worker } 1906*481dde66SAndroid Build Coastguard Worker 1907*481dde66SAndroid Build Coastguard Worker // Creates an action that returns from a void function. 1908*481dde66SAndroid Build Coastguard Worker inline PolymorphicAction<internal::ReturnVoidAction> Return() { 1909*481dde66SAndroid Build Coastguard Worker return MakePolymorphicAction(internal::ReturnVoidAction()); 1910*481dde66SAndroid Build Coastguard Worker } 1911*481dde66SAndroid Build Coastguard Worker 1912*481dde66SAndroid Build Coastguard Worker // Creates an action that returns the reference to a variable. 1913*481dde66SAndroid Build Coastguard Worker template <typename R> 1914*481dde66SAndroid Build Coastguard Worker inline internal::ReturnRefAction<R> ReturnRef(R& x) { // NOLINT 1915*481dde66SAndroid Build Coastguard Worker return internal::ReturnRefAction<R>(x); 1916*481dde66SAndroid Build Coastguard Worker } 1917*481dde66SAndroid Build Coastguard Worker 1918*481dde66SAndroid Build Coastguard Worker // Prevent using ReturnRef on reference to temporary. 1919*481dde66SAndroid Build Coastguard Worker template <typename R, R* = nullptr> 1920*481dde66SAndroid Build Coastguard Worker internal::ReturnRefAction<R> ReturnRef(R&&) = delete; 1921*481dde66SAndroid Build Coastguard Worker 1922*481dde66SAndroid Build Coastguard Worker // Creates an action that returns the reference to a copy of the 1923*481dde66SAndroid Build Coastguard Worker // argument. The copy is created when the action is constructed and 1924*481dde66SAndroid Build Coastguard Worker // lives as long as the action. 1925*481dde66SAndroid Build Coastguard Worker template <typename R> 1926*481dde66SAndroid Build Coastguard Worker inline internal::ReturnRefOfCopyAction<R> ReturnRefOfCopy(const R& x) { 1927*481dde66SAndroid Build Coastguard Worker return internal::ReturnRefOfCopyAction<R>(x); 1928*481dde66SAndroid Build Coastguard Worker } 1929*481dde66SAndroid Build Coastguard Worker 1930*481dde66SAndroid Build Coastguard Worker // DEPRECATED: use Return(x) directly with WillOnce. 1931*481dde66SAndroid Build Coastguard Worker // 1932*481dde66SAndroid Build Coastguard Worker // Modifies the parent action (a Return() action) to perform a move of the 1933*481dde66SAndroid Build Coastguard Worker // argument instead of a copy. 1934*481dde66SAndroid Build Coastguard Worker // Return(ByMove()) actions can only be executed once and will assert this 1935*481dde66SAndroid Build Coastguard Worker // invariant. 1936*481dde66SAndroid Build Coastguard Worker template <typename R> 1937*481dde66SAndroid Build Coastguard Worker internal::ByMoveWrapper<R> ByMove(R x) { 1938*481dde66SAndroid Build Coastguard Worker return internal::ByMoveWrapper<R>(std::move(x)); 1939*481dde66SAndroid Build Coastguard Worker } 1940*481dde66SAndroid Build Coastguard Worker 1941*481dde66SAndroid Build Coastguard Worker // Creates an action that returns an element of `vals`. Calling this action will 1942*481dde66SAndroid Build Coastguard Worker // repeatedly return the next value from `vals` until it reaches the end and 1943*481dde66SAndroid Build Coastguard Worker // will restart from the beginning. 1944*481dde66SAndroid Build Coastguard Worker template <typename T> 1945*481dde66SAndroid Build Coastguard Worker internal::ReturnRoundRobinAction<T> ReturnRoundRobin(std::vector<T> vals) { 1946*481dde66SAndroid Build Coastguard Worker return internal::ReturnRoundRobinAction<T>(std::move(vals)); 1947*481dde66SAndroid Build Coastguard Worker } 1948*481dde66SAndroid Build Coastguard Worker 1949*481dde66SAndroid Build Coastguard Worker // Creates an action that returns an element of `vals`. Calling this action will 1950*481dde66SAndroid Build Coastguard Worker // repeatedly return the next value from `vals` until it reaches the end and 1951*481dde66SAndroid Build Coastguard Worker // will restart from the beginning. 1952*481dde66SAndroid Build Coastguard Worker template <typename T> 1953*481dde66SAndroid Build Coastguard Worker internal::ReturnRoundRobinAction<T> ReturnRoundRobin( 1954*481dde66SAndroid Build Coastguard Worker std::initializer_list<T> vals) { 1955*481dde66SAndroid Build Coastguard Worker return internal::ReturnRoundRobinAction<T>(std::vector<T>(vals)); 1956*481dde66SAndroid Build Coastguard Worker } 1957*481dde66SAndroid Build Coastguard Worker 1958*481dde66SAndroid Build Coastguard Worker // Creates an action that does the default action for the give mock function. 1959*481dde66SAndroid Build Coastguard Worker inline internal::DoDefaultAction DoDefault() { 1960*481dde66SAndroid Build Coastguard Worker return internal::DoDefaultAction(); 1961*481dde66SAndroid Build Coastguard Worker } 1962*481dde66SAndroid Build Coastguard Worker 1963*481dde66SAndroid Build Coastguard Worker // Creates an action that sets the variable pointed by the N-th 1964*481dde66SAndroid Build Coastguard Worker // (0-based) function argument to 'value'. 1965*481dde66SAndroid Build Coastguard Worker template <size_t N, typename T> 1966*481dde66SAndroid Build Coastguard Worker internal::SetArgumentPointeeAction<N, T> SetArgPointee(T value) { 1967*481dde66SAndroid Build Coastguard Worker return {std::move(value)}; 1968*481dde66SAndroid Build Coastguard Worker } 1969*481dde66SAndroid Build Coastguard Worker 1970*481dde66SAndroid Build Coastguard Worker // The following version is DEPRECATED. 1971*481dde66SAndroid Build Coastguard Worker template <size_t N, typename T> 1972*481dde66SAndroid Build Coastguard Worker internal::SetArgumentPointeeAction<N, T> SetArgumentPointee(T value) { 1973*481dde66SAndroid Build Coastguard Worker return {std::move(value)}; 1974*481dde66SAndroid Build Coastguard Worker } 1975*481dde66SAndroid Build Coastguard Worker 1976*481dde66SAndroid Build Coastguard Worker // Creates an action that sets a pointer referent to a given value. 1977*481dde66SAndroid Build Coastguard Worker template <typename T1, typename T2> 1978*481dde66SAndroid Build Coastguard Worker PolymorphicAction<internal::AssignAction<T1, T2>> Assign(T1* ptr, T2 val) { 1979*481dde66SAndroid Build Coastguard Worker return MakePolymorphicAction(internal::AssignAction<T1, T2>(ptr, val)); 1980*481dde66SAndroid Build Coastguard Worker } 1981*481dde66SAndroid Build Coastguard Worker 1982*481dde66SAndroid Build Coastguard Worker #ifndef GTEST_OS_WINDOWS_MOBILE 1983*481dde66SAndroid Build Coastguard Worker 1984*481dde66SAndroid Build Coastguard Worker // Creates an action that sets errno and returns the appropriate error. 1985*481dde66SAndroid Build Coastguard Worker template <typename T> 1986*481dde66SAndroid Build Coastguard Worker PolymorphicAction<internal::SetErrnoAndReturnAction<T>> SetErrnoAndReturn( 1987*481dde66SAndroid Build Coastguard Worker int errval, T result) { 1988*481dde66SAndroid Build Coastguard Worker return MakePolymorphicAction( 1989*481dde66SAndroid Build Coastguard Worker internal::SetErrnoAndReturnAction<T>(errval, result)); 1990*481dde66SAndroid Build Coastguard Worker } 1991*481dde66SAndroid Build Coastguard Worker 1992*481dde66SAndroid Build Coastguard Worker #endif // !GTEST_OS_WINDOWS_MOBILE 1993*481dde66SAndroid Build Coastguard Worker 1994*481dde66SAndroid Build Coastguard Worker // Various overloads for Invoke(). 1995*481dde66SAndroid Build Coastguard Worker 1996*481dde66SAndroid Build Coastguard Worker // Legacy function. 1997*481dde66SAndroid Build Coastguard Worker // Actions can now be implicitly constructed from callables. No need to create 1998*481dde66SAndroid Build Coastguard Worker // wrapper objects. 1999*481dde66SAndroid Build Coastguard Worker // This function exists for backwards compatibility. 2000*481dde66SAndroid Build Coastguard Worker template <typename FunctionImpl> 2001*481dde66SAndroid Build Coastguard Worker typename std::decay<FunctionImpl>::type Invoke(FunctionImpl&& function_impl) { 2002*481dde66SAndroid Build Coastguard Worker return std::forward<FunctionImpl>(function_impl); 2003*481dde66SAndroid Build Coastguard Worker } 2004*481dde66SAndroid Build Coastguard Worker 2005*481dde66SAndroid Build Coastguard Worker // Creates an action that invokes the given method on the given object 2006*481dde66SAndroid Build Coastguard Worker // with the mock function's arguments. 2007*481dde66SAndroid Build Coastguard Worker template <class Class, typename MethodPtr> 2008*481dde66SAndroid Build Coastguard Worker internal::InvokeMethodAction<Class, MethodPtr> Invoke(Class* obj_ptr, 2009*481dde66SAndroid Build Coastguard Worker MethodPtr method_ptr) { 2010*481dde66SAndroid Build Coastguard Worker return {obj_ptr, method_ptr}; 2011*481dde66SAndroid Build Coastguard Worker } 2012*481dde66SAndroid Build Coastguard Worker 2013*481dde66SAndroid Build Coastguard Worker // Creates an action that invokes 'function_impl' with no argument. 2014*481dde66SAndroid Build Coastguard Worker template <typename FunctionImpl> 2015*481dde66SAndroid Build Coastguard Worker internal::InvokeWithoutArgsAction<typename std::decay<FunctionImpl>::type> 2016*481dde66SAndroid Build Coastguard Worker InvokeWithoutArgs(FunctionImpl function_impl) { 2017*481dde66SAndroid Build Coastguard Worker return {std::move(function_impl)}; 2018*481dde66SAndroid Build Coastguard Worker } 2019*481dde66SAndroid Build Coastguard Worker 2020*481dde66SAndroid Build Coastguard Worker // Creates an action that invokes the given method on the given object 2021*481dde66SAndroid Build Coastguard Worker // with no argument. 2022*481dde66SAndroid Build Coastguard Worker template <class Class, typename MethodPtr> 2023*481dde66SAndroid Build Coastguard Worker internal::InvokeMethodWithoutArgsAction<Class, MethodPtr> InvokeWithoutArgs( 2024*481dde66SAndroid Build Coastguard Worker Class* obj_ptr, MethodPtr method_ptr) { 2025*481dde66SAndroid Build Coastguard Worker return {obj_ptr, method_ptr}; 2026*481dde66SAndroid Build Coastguard Worker } 2027*481dde66SAndroid Build Coastguard Worker 2028*481dde66SAndroid Build Coastguard Worker // Creates an action that performs an_action and throws away its 2029*481dde66SAndroid Build Coastguard Worker // result. In other words, it changes the return type of an_action to 2030*481dde66SAndroid Build Coastguard Worker // void. an_action MUST NOT return void, or the code won't compile. 2031*481dde66SAndroid Build Coastguard Worker template <typename A> 2032*481dde66SAndroid Build Coastguard Worker inline internal::IgnoreResultAction<A> IgnoreResult(const A& an_action) { 2033*481dde66SAndroid Build Coastguard Worker return internal::IgnoreResultAction<A>(an_action); 2034*481dde66SAndroid Build Coastguard Worker } 2035*481dde66SAndroid Build Coastguard Worker 2036*481dde66SAndroid Build Coastguard Worker // Creates a reference wrapper for the given L-value. If necessary, 2037*481dde66SAndroid Build Coastguard Worker // you can explicitly specify the type of the reference. For example, 2038*481dde66SAndroid Build Coastguard Worker // suppose 'derived' is an object of type Derived, ByRef(derived) 2039*481dde66SAndroid Build Coastguard Worker // would wrap a Derived&. If you want to wrap a const Base& instead, 2040*481dde66SAndroid Build Coastguard Worker // where Base is a base class of Derived, just write: 2041*481dde66SAndroid Build Coastguard Worker // 2042*481dde66SAndroid Build Coastguard Worker // ByRef<const Base>(derived) 2043*481dde66SAndroid Build Coastguard Worker // 2044*481dde66SAndroid Build Coastguard Worker // N.B. ByRef is redundant with std::ref, std::cref and std::reference_wrapper. 2045*481dde66SAndroid Build Coastguard Worker // However, it may still be used for consistency with ByMove(). 2046*481dde66SAndroid Build Coastguard Worker template <typename T> 2047*481dde66SAndroid Build Coastguard Worker inline ::std::reference_wrapper<T> ByRef(T& l_value) { // NOLINT 2048*481dde66SAndroid Build Coastguard Worker return ::std::reference_wrapper<T>(l_value); 2049*481dde66SAndroid Build Coastguard Worker } 2050*481dde66SAndroid Build Coastguard Worker 2051*481dde66SAndroid Build Coastguard Worker // The ReturnNew<T>(a1, a2, ..., a_k) action returns a pointer to a new 2052*481dde66SAndroid Build Coastguard Worker // instance of type T, constructed on the heap with constructor arguments 2053*481dde66SAndroid Build Coastguard Worker // a1, a2, ..., and a_k. The caller assumes ownership of the returned value. 2054*481dde66SAndroid Build Coastguard Worker template <typename T, typename... Params> 2055*481dde66SAndroid Build Coastguard Worker internal::ReturnNewAction<T, typename std::decay<Params>::type...> ReturnNew( 2056*481dde66SAndroid Build Coastguard Worker Params&&... params) { 2057*481dde66SAndroid Build Coastguard Worker return {std::forward_as_tuple(std::forward<Params>(params)...)}; 2058*481dde66SAndroid Build Coastguard Worker } 2059*481dde66SAndroid Build Coastguard Worker 2060*481dde66SAndroid Build Coastguard Worker // Action ReturnArg<k>() returns the k-th argument of the mock function. 2061*481dde66SAndroid Build Coastguard Worker template <size_t k> 2062*481dde66SAndroid Build Coastguard Worker internal::ReturnArgAction<k> ReturnArg() { 2063*481dde66SAndroid Build Coastguard Worker return {}; 2064*481dde66SAndroid Build Coastguard Worker } 2065*481dde66SAndroid Build Coastguard Worker 2066*481dde66SAndroid Build Coastguard Worker // Action SaveArg<k>(pointer) saves the k-th (0-based) argument of the 2067*481dde66SAndroid Build Coastguard Worker // mock function to *pointer. 2068*481dde66SAndroid Build Coastguard Worker template <size_t k, typename Ptr> 2069*481dde66SAndroid Build Coastguard Worker internal::SaveArgAction<k, Ptr> SaveArg(Ptr pointer) { 2070*481dde66SAndroid Build Coastguard Worker return {pointer}; 2071*481dde66SAndroid Build Coastguard Worker } 2072*481dde66SAndroid Build Coastguard Worker 2073*481dde66SAndroid Build Coastguard Worker // Action SaveArgPointee<k>(pointer) saves the value pointed to 2074*481dde66SAndroid Build Coastguard Worker // by the k-th (0-based) argument of the mock function to *pointer. 2075*481dde66SAndroid Build Coastguard Worker template <size_t k, typename Ptr> 2076*481dde66SAndroid Build Coastguard Worker internal::SaveArgPointeeAction<k, Ptr> SaveArgPointee(Ptr pointer) { 2077*481dde66SAndroid Build Coastguard Worker return {pointer}; 2078*481dde66SAndroid Build Coastguard Worker } 2079*481dde66SAndroid Build Coastguard Worker 2080*481dde66SAndroid Build Coastguard Worker // Action SetArgReferee<k>(value) assigns 'value' to the variable 2081*481dde66SAndroid Build Coastguard Worker // referenced by the k-th (0-based) argument of the mock function. 2082*481dde66SAndroid Build Coastguard Worker template <size_t k, typename T> 2083*481dde66SAndroid Build Coastguard Worker internal::SetArgRefereeAction<k, typename std::decay<T>::type> SetArgReferee( 2084*481dde66SAndroid Build Coastguard Worker T&& value) { 2085*481dde66SAndroid Build Coastguard Worker return {std::forward<T>(value)}; 2086*481dde66SAndroid Build Coastguard Worker } 2087*481dde66SAndroid Build Coastguard Worker 2088*481dde66SAndroid Build Coastguard Worker // Action SetArrayArgument<k>(first, last) copies the elements in 2089*481dde66SAndroid Build Coastguard Worker // source range [first, last) to the array pointed to by the k-th 2090*481dde66SAndroid Build Coastguard Worker // (0-based) argument, which can be either a pointer or an 2091*481dde66SAndroid Build Coastguard Worker // iterator. The action does not take ownership of the elements in the 2092*481dde66SAndroid Build Coastguard Worker // source range. 2093*481dde66SAndroid Build Coastguard Worker template <size_t k, typename I1, typename I2> 2094*481dde66SAndroid Build Coastguard Worker internal::SetArrayArgumentAction<k, I1, I2> SetArrayArgument(I1 first, 2095*481dde66SAndroid Build Coastguard Worker I2 last) { 2096*481dde66SAndroid Build Coastguard Worker return {first, last}; 2097*481dde66SAndroid Build Coastguard Worker } 2098*481dde66SAndroid Build Coastguard Worker 2099*481dde66SAndroid Build Coastguard Worker // Action DeleteArg<k>() deletes the k-th (0-based) argument of the mock 2100*481dde66SAndroid Build Coastguard Worker // function. 2101*481dde66SAndroid Build Coastguard Worker template <size_t k> 2102*481dde66SAndroid Build Coastguard Worker internal::DeleteArgAction<k> DeleteArg() { 2103*481dde66SAndroid Build Coastguard Worker return {}; 2104*481dde66SAndroid Build Coastguard Worker } 2105*481dde66SAndroid Build Coastguard Worker 2106*481dde66SAndroid Build Coastguard Worker // This action returns the value pointed to by 'pointer'. 2107*481dde66SAndroid Build Coastguard Worker template <typename Ptr> 2108*481dde66SAndroid Build Coastguard Worker internal::ReturnPointeeAction<Ptr> ReturnPointee(Ptr pointer) { 2109*481dde66SAndroid Build Coastguard Worker return {pointer}; 2110*481dde66SAndroid Build Coastguard Worker } 2111*481dde66SAndroid Build Coastguard Worker 2112*481dde66SAndroid Build Coastguard Worker #if GTEST_HAS_EXCEPTIONS 2113*481dde66SAndroid Build Coastguard Worker // Action Throw(exception) can be used in a mock function of any type 2114*481dde66SAndroid Build Coastguard Worker // to throw the given exception. Any copyable value can be thrown, 2115*481dde66SAndroid Build Coastguard Worker // except for std::exception_ptr, which is likely a mistake if 2116*481dde66SAndroid Build Coastguard Worker // thrown directly. 2117*481dde66SAndroid Build Coastguard Worker template <typename T> 2118*481dde66SAndroid Build Coastguard Worker typename std::enable_if< 2119*481dde66SAndroid Build Coastguard Worker !std::is_base_of<std::exception_ptr, typename std::decay<T>::type>::value, 2120*481dde66SAndroid Build Coastguard Worker internal::ThrowAction<typename std::decay<T>::type>>::type 2121*481dde66SAndroid Build Coastguard Worker Throw(T&& exception) { 2122*481dde66SAndroid Build Coastguard Worker return {std::forward<T>(exception)}; 2123*481dde66SAndroid Build Coastguard Worker } 2124*481dde66SAndroid Build Coastguard Worker // Action Rethrow(exception_ptr) can be used in a mock function of any type 2125*481dde66SAndroid Build Coastguard Worker // to rethrow any exception_ptr. Note that the same object is thrown each time. 2126*481dde66SAndroid Build Coastguard Worker inline internal::RethrowAction Rethrow(std::exception_ptr exception) { 2127*481dde66SAndroid Build Coastguard Worker return {std::move(exception)}; 2128*481dde66SAndroid Build Coastguard Worker } 2129*481dde66SAndroid Build Coastguard Worker #endif // GTEST_HAS_EXCEPTIONS 2130*481dde66SAndroid Build Coastguard Worker 2131*481dde66SAndroid Build Coastguard Worker namespace internal { 2132*481dde66SAndroid Build Coastguard Worker 2133*481dde66SAndroid Build Coastguard Worker // A macro from the ACTION* family (defined later in gmock-generated-actions.h) 2134*481dde66SAndroid Build Coastguard Worker // defines an action that can be used in a mock function. Typically, 2135*481dde66SAndroid Build Coastguard Worker // these actions only care about a subset of the arguments of the mock 2136*481dde66SAndroid Build Coastguard Worker // function. For example, if such an action only uses the second 2137*481dde66SAndroid Build Coastguard Worker // argument, it can be used in any mock function that takes >= 2 2138*481dde66SAndroid Build Coastguard Worker // arguments where the type of the second argument is compatible. 2139*481dde66SAndroid Build Coastguard Worker // 2140*481dde66SAndroid Build Coastguard Worker // Therefore, the action implementation must be prepared to take more 2141*481dde66SAndroid Build Coastguard Worker // arguments than it needs. The ExcessiveArg type is used to 2142*481dde66SAndroid Build Coastguard Worker // represent those excessive arguments. In order to keep the compiler 2143*481dde66SAndroid Build Coastguard Worker // error messages tractable, we define it in the testing namespace 2144*481dde66SAndroid Build Coastguard Worker // instead of testing::internal. However, this is an INTERNAL TYPE 2145*481dde66SAndroid Build Coastguard Worker // and subject to change without notice, so a user MUST NOT USE THIS 2146*481dde66SAndroid Build Coastguard Worker // TYPE DIRECTLY. 2147*481dde66SAndroid Build Coastguard Worker struct ExcessiveArg {}; 2148*481dde66SAndroid Build Coastguard Worker 2149*481dde66SAndroid Build Coastguard Worker // Builds an implementation of an Action<> for some particular signature, using 2150*481dde66SAndroid Build Coastguard Worker // a class defined by an ACTION* macro. 2151*481dde66SAndroid Build Coastguard Worker template <typename F, typename Impl> 2152*481dde66SAndroid Build Coastguard Worker struct ActionImpl; 2153*481dde66SAndroid Build Coastguard Worker 2154*481dde66SAndroid Build Coastguard Worker template <typename Impl> 2155*481dde66SAndroid Build Coastguard Worker struct ImplBase { 2156*481dde66SAndroid Build Coastguard Worker struct Holder { 2157*481dde66SAndroid Build Coastguard Worker // Allows each copy of the Action<> to get to the Impl. 2158*481dde66SAndroid Build Coastguard Worker explicit operator const Impl&() const { return *ptr; } 2159*481dde66SAndroid Build Coastguard Worker std::shared_ptr<Impl> ptr; 2160*481dde66SAndroid Build Coastguard Worker }; 2161*481dde66SAndroid Build Coastguard Worker using type = typename std::conditional<std::is_constructible<Impl>::value, 2162*481dde66SAndroid Build Coastguard Worker Impl, Holder>::type; 2163*481dde66SAndroid Build Coastguard Worker }; 2164*481dde66SAndroid Build Coastguard Worker 2165*481dde66SAndroid Build Coastguard Worker template <typename R, typename... Args, typename Impl> 2166*481dde66SAndroid Build Coastguard Worker struct ActionImpl<R(Args...), Impl> : ImplBase<Impl>::type { 2167*481dde66SAndroid Build Coastguard Worker using Base = typename ImplBase<Impl>::type; 2168*481dde66SAndroid Build Coastguard Worker using function_type = R(Args...); 2169*481dde66SAndroid Build Coastguard Worker using args_type = std::tuple<Args...>; 2170*481dde66SAndroid Build Coastguard Worker 2171*481dde66SAndroid Build Coastguard Worker ActionImpl() = default; // Only defined if appropriate for Base. 2172*481dde66SAndroid Build Coastguard Worker explicit ActionImpl(std::shared_ptr<Impl> impl) : Base{std::move(impl)} {} 2173*481dde66SAndroid Build Coastguard Worker 2174*481dde66SAndroid Build Coastguard Worker R operator()(Args&&... arg) const { 2175*481dde66SAndroid Build Coastguard Worker static constexpr size_t kMaxArgs = 2176*481dde66SAndroid Build Coastguard Worker sizeof...(Args) <= 10 ? sizeof...(Args) : 10; 2177*481dde66SAndroid Build Coastguard Worker return Apply(std::make_index_sequence<kMaxArgs>{}, 2178*481dde66SAndroid Build Coastguard Worker std::make_index_sequence<10 - kMaxArgs>{}, 2179*481dde66SAndroid Build Coastguard Worker args_type{std::forward<Args>(arg)...}); 2180*481dde66SAndroid Build Coastguard Worker } 2181*481dde66SAndroid Build Coastguard Worker 2182*481dde66SAndroid Build Coastguard Worker template <std::size_t... arg_id, std::size_t... excess_id> 2183*481dde66SAndroid Build Coastguard Worker R Apply(std::index_sequence<arg_id...>, std::index_sequence<excess_id...>, 2184*481dde66SAndroid Build Coastguard Worker const args_type& args) const { 2185*481dde66SAndroid Build Coastguard Worker // Impl need not be specific to the signature of action being implemented; 2186*481dde66SAndroid Build Coastguard Worker // only the implementing function body needs to have all of the specific 2187*481dde66SAndroid Build Coastguard Worker // types instantiated. Up to 10 of the args that are provided by the 2188*481dde66SAndroid Build Coastguard Worker // args_type get passed, followed by a dummy of unspecified type for the 2189*481dde66SAndroid Build Coastguard Worker // remainder up to 10 explicit args. 2190*481dde66SAndroid Build Coastguard Worker static constexpr ExcessiveArg kExcessArg{}; 2191*481dde66SAndroid Build Coastguard Worker return static_cast<const Impl&>(*this) 2192*481dde66SAndroid Build Coastguard Worker .template gmock_PerformImpl< 2193*481dde66SAndroid Build Coastguard Worker /*function_type=*/function_type, /*return_type=*/R, 2194*481dde66SAndroid Build Coastguard Worker /*args_type=*/args_type, 2195*481dde66SAndroid Build Coastguard Worker /*argN_type=*/ 2196*481dde66SAndroid Build Coastguard Worker typename std::tuple_element<arg_id, args_type>::type...>( 2197*481dde66SAndroid Build Coastguard Worker /*args=*/args, std::get<arg_id>(args)..., 2198*481dde66SAndroid Build Coastguard Worker ((void)excess_id, kExcessArg)...); 2199*481dde66SAndroid Build Coastguard Worker } 2200*481dde66SAndroid Build Coastguard Worker }; 2201*481dde66SAndroid Build Coastguard Worker 2202*481dde66SAndroid Build Coastguard Worker // Stores a default-constructed Impl as part of the Action<>'s 2203*481dde66SAndroid Build Coastguard Worker // std::function<>. The Impl should be trivial to copy. 2204*481dde66SAndroid Build Coastguard Worker template <typename F, typename Impl> 2205*481dde66SAndroid Build Coastguard Worker ::testing::Action<F> MakeAction() { 2206*481dde66SAndroid Build Coastguard Worker return ::testing::Action<F>(ActionImpl<F, Impl>()); 2207*481dde66SAndroid Build Coastguard Worker } 2208*481dde66SAndroid Build Coastguard Worker 2209*481dde66SAndroid Build Coastguard Worker // Stores just the one given instance of Impl. 2210*481dde66SAndroid Build Coastguard Worker template <typename F, typename Impl> 2211*481dde66SAndroid Build Coastguard Worker ::testing::Action<F> MakeAction(std::shared_ptr<Impl> impl) { 2212*481dde66SAndroid Build Coastguard Worker return ::testing::Action<F>(ActionImpl<F, Impl>(std::move(impl))); 2213*481dde66SAndroid Build Coastguard Worker } 2214*481dde66SAndroid Build Coastguard Worker 2215*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_ARG_UNUSED(i, data, el) \ 2216*481dde66SAndroid Build Coastguard Worker , GTEST_INTERNAL_ATTRIBUTE_MAYBE_UNUSED const arg##i##_type& arg##i 2217*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_ \ 2218*481dde66SAndroid Build Coastguard Worker GTEST_INTERNAL_ATTRIBUTE_MAYBE_UNUSED const args_type& args GMOCK_PP_REPEAT( \ 2219*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ARG_UNUSED, , 10) 2220*481dde66SAndroid Build Coastguard Worker 2221*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_ARG(i, data, el) , const arg##i##_type& arg##i 2222*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_ARG_TYPES_AND_NAMES_ \ 2223*481dde66SAndroid Build Coastguard Worker const args_type& args GMOCK_PP_REPEAT(GMOCK_INTERNAL_ARG, , 10) 2224*481dde66SAndroid Build Coastguard Worker 2225*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_TEMPLATE_ARG(i, data, el) , typename arg##i##_type 2226*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_TEMPLATE_ARGS_NAMES_ \ 2227*481dde66SAndroid Build Coastguard Worker GMOCK_PP_TAIL(GMOCK_PP_REPEAT(GMOCK_INTERNAL_TEMPLATE_ARG, , 10)) 2228*481dde66SAndroid Build Coastguard Worker 2229*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_TYPENAME_PARAM(i, data, param) , typename param##_type 2230*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_TYPENAME_PARAMS_(params) \ 2231*481dde66SAndroid Build Coastguard Worker GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_TYPENAME_PARAM, , params)) 2232*481dde66SAndroid Build Coastguard Worker 2233*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_TYPE_PARAM(i, data, param) , param##_type 2234*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_TYPE_PARAMS_(params) \ 2235*481dde66SAndroid Build Coastguard Worker GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_TYPE_PARAM, , params)) 2236*481dde66SAndroid Build Coastguard Worker 2237*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_TYPE_GVALUE_PARAM(i, data, param) \ 2238*481dde66SAndroid Build Coastguard Worker , param##_type gmock_p##i 2239*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params) \ 2240*481dde66SAndroid Build Coastguard Worker GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_TYPE_GVALUE_PARAM, , params)) 2241*481dde66SAndroid Build Coastguard Worker 2242*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_GVALUE_PARAM(i, data, param) \ 2243*481dde66SAndroid Build Coastguard Worker , std::forward<param##_type>(gmock_p##i) 2244*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_GVALUE_PARAMS_(params) \ 2245*481dde66SAndroid Build Coastguard Worker GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_GVALUE_PARAM, , params)) 2246*481dde66SAndroid Build Coastguard Worker 2247*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_INIT_PARAM(i, data, param) \ 2248*481dde66SAndroid Build Coastguard Worker , param(::std::forward<param##_type>(gmock_p##i)) 2249*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_INIT_PARAMS_(params) \ 2250*481dde66SAndroid Build Coastguard Worker GMOCK_PP_TAIL(GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_INIT_PARAM, , params)) 2251*481dde66SAndroid Build Coastguard Worker 2252*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_FIELD_PARAM(i, data, param) param##_type param; 2253*481dde66SAndroid Build Coastguard Worker #define GMOCK_ACTION_FIELD_PARAMS_(params) \ 2254*481dde66SAndroid Build Coastguard Worker GMOCK_PP_FOR_EACH(GMOCK_INTERNAL_FIELD_PARAM, , params) 2255*481dde66SAndroid Build Coastguard Worker 2256*481dde66SAndroid Build Coastguard Worker #define GMOCK_INTERNAL_ACTION(name, full_name, params) \ 2257*481dde66SAndroid Build Coastguard Worker template <GMOCK_ACTION_TYPENAME_PARAMS_(params)> \ 2258*481dde66SAndroid Build Coastguard Worker class full_name { \ 2259*481dde66SAndroid Build Coastguard Worker public: \ 2260*481dde66SAndroid Build Coastguard Worker explicit full_name(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ 2261*481dde66SAndroid Build Coastguard Worker : impl_(std::make_shared<gmock_Impl>( \ 2262*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_GVALUE_PARAMS_(params))) {} \ 2263*481dde66SAndroid Build Coastguard Worker full_name(const full_name&) = default; \ 2264*481dde66SAndroid Build Coastguard Worker full_name(full_name&&) noexcept = default; \ 2265*481dde66SAndroid Build Coastguard Worker template <typename F> \ 2266*481dde66SAndroid Build Coastguard Worker operator ::testing::Action<F>() const { \ 2267*481dde66SAndroid Build Coastguard Worker return ::testing::internal::MakeAction<F>(impl_); \ 2268*481dde66SAndroid Build Coastguard Worker } \ 2269*481dde66SAndroid Build Coastguard Worker \ 2270*481dde66SAndroid Build Coastguard Worker private: \ 2271*481dde66SAndroid Build Coastguard Worker class gmock_Impl { \ 2272*481dde66SAndroid Build Coastguard Worker public: \ 2273*481dde66SAndroid Build Coastguard Worker explicit gmock_Impl(GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) \ 2274*481dde66SAndroid Build Coastguard Worker : GMOCK_ACTION_INIT_PARAMS_(params) {} \ 2275*481dde66SAndroid Build Coastguard Worker template <typename function_type, typename return_type, \ 2276*481dde66SAndroid Build Coastguard Worker typename args_type, GMOCK_ACTION_TEMPLATE_ARGS_NAMES_> \ 2277*481dde66SAndroid Build Coastguard Worker return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ 2278*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_FIELD_PARAMS_(params) \ 2279*481dde66SAndroid Build Coastguard Worker }; \ 2280*481dde66SAndroid Build Coastguard Worker std::shared_ptr<const gmock_Impl> impl_; \ 2281*481dde66SAndroid Build Coastguard Worker }; \ 2282*481dde66SAndroid Build Coastguard Worker template <GMOCK_ACTION_TYPENAME_PARAMS_(params)> \ 2283*481dde66SAndroid Build Coastguard Worker inline full_name<GMOCK_ACTION_TYPE_PARAMS_(params)> name( \ 2284*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) GTEST_MUST_USE_RESULT_; \ 2285*481dde66SAndroid Build Coastguard Worker template <GMOCK_ACTION_TYPENAME_PARAMS_(params)> \ 2286*481dde66SAndroid Build Coastguard Worker inline full_name<GMOCK_ACTION_TYPE_PARAMS_(params)> name( \ 2287*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_TYPE_GVALUE_PARAMS_(params)) { \ 2288*481dde66SAndroid Build Coastguard Worker return full_name<GMOCK_ACTION_TYPE_PARAMS_(params)>( \ 2289*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_GVALUE_PARAMS_(params)); \ 2290*481dde66SAndroid Build Coastguard Worker } \ 2291*481dde66SAndroid Build Coastguard Worker template <GMOCK_ACTION_TYPENAME_PARAMS_(params)> \ 2292*481dde66SAndroid Build Coastguard Worker template <typename function_type, typename return_type, typename args_type, \ 2293*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_TEMPLATE_ARGS_NAMES_> \ 2294*481dde66SAndroid Build Coastguard Worker return_type \ 2295*481dde66SAndroid Build Coastguard Worker full_name<GMOCK_ACTION_TYPE_PARAMS_(params)>::gmock_Impl::gmock_PerformImpl( \ 2296*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const 2297*481dde66SAndroid Build Coastguard Worker 2298*481dde66SAndroid Build Coastguard Worker } // namespace internal 2299*481dde66SAndroid Build Coastguard Worker 2300*481dde66SAndroid Build Coastguard Worker // Similar to GMOCK_INTERNAL_ACTION, but no bound parameters are stored. 2301*481dde66SAndroid Build Coastguard Worker #define ACTION(name) \ 2302*481dde66SAndroid Build Coastguard Worker class name##Action { \ 2303*481dde66SAndroid Build Coastguard Worker public: \ 2304*481dde66SAndroid Build Coastguard Worker explicit name##Action() noexcept {} \ 2305*481dde66SAndroid Build Coastguard Worker name##Action(const name##Action&) noexcept {} \ 2306*481dde66SAndroid Build Coastguard Worker template <typename F> \ 2307*481dde66SAndroid Build Coastguard Worker operator ::testing::Action<F>() const { \ 2308*481dde66SAndroid Build Coastguard Worker return ::testing::internal::MakeAction<F, gmock_Impl>(); \ 2309*481dde66SAndroid Build Coastguard Worker } \ 2310*481dde66SAndroid Build Coastguard Worker \ 2311*481dde66SAndroid Build Coastguard Worker private: \ 2312*481dde66SAndroid Build Coastguard Worker class gmock_Impl { \ 2313*481dde66SAndroid Build Coastguard Worker public: \ 2314*481dde66SAndroid Build Coastguard Worker template <typename function_type, typename return_type, \ 2315*481dde66SAndroid Build Coastguard Worker typename args_type, GMOCK_ACTION_TEMPLATE_ARGS_NAMES_> \ 2316*481dde66SAndroid Build Coastguard Worker return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \ 2317*481dde66SAndroid Build Coastguard Worker }; \ 2318*481dde66SAndroid Build Coastguard Worker }; \ 2319*481dde66SAndroid Build Coastguard Worker inline name##Action name() GTEST_MUST_USE_RESULT_; \ 2320*481dde66SAndroid Build Coastguard Worker inline name##Action name() { return name##Action(); } \ 2321*481dde66SAndroid Build Coastguard Worker template <typename function_type, typename return_type, typename args_type, \ 2322*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_TEMPLATE_ARGS_NAMES_> \ 2323*481dde66SAndroid Build Coastguard Worker return_type name##Action::gmock_Impl::gmock_PerformImpl( \ 2324*481dde66SAndroid Build Coastguard Worker GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) const 2325*481dde66SAndroid Build Coastguard Worker 2326*481dde66SAndroid Build Coastguard Worker #define ACTION_P(name, ...) \ 2327*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP, (__VA_ARGS__)) 2328*481dde66SAndroid Build Coastguard Worker 2329*481dde66SAndroid Build Coastguard Worker #define ACTION_P2(name, ...) \ 2330*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP2, (__VA_ARGS__)) 2331*481dde66SAndroid Build Coastguard Worker 2332*481dde66SAndroid Build Coastguard Worker #define ACTION_P3(name, ...) \ 2333*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP3, (__VA_ARGS__)) 2334*481dde66SAndroid Build Coastguard Worker 2335*481dde66SAndroid Build Coastguard Worker #define ACTION_P4(name, ...) \ 2336*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP4, (__VA_ARGS__)) 2337*481dde66SAndroid Build Coastguard Worker 2338*481dde66SAndroid Build Coastguard Worker #define ACTION_P5(name, ...) \ 2339*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP5, (__VA_ARGS__)) 2340*481dde66SAndroid Build Coastguard Worker 2341*481dde66SAndroid Build Coastguard Worker #define ACTION_P6(name, ...) \ 2342*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP6, (__VA_ARGS__)) 2343*481dde66SAndroid Build Coastguard Worker 2344*481dde66SAndroid Build Coastguard Worker #define ACTION_P7(name, ...) \ 2345*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP7, (__VA_ARGS__)) 2346*481dde66SAndroid Build Coastguard Worker 2347*481dde66SAndroid Build Coastguard Worker #define ACTION_P8(name, ...) \ 2348*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP8, (__VA_ARGS__)) 2349*481dde66SAndroid Build Coastguard Worker 2350*481dde66SAndroid Build Coastguard Worker #define ACTION_P9(name, ...) \ 2351*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP9, (__VA_ARGS__)) 2352*481dde66SAndroid Build Coastguard Worker 2353*481dde66SAndroid Build Coastguard Worker #define ACTION_P10(name, ...) \ 2354*481dde66SAndroid Build Coastguard Worker GMOCK_INTERNAL_ACTION(name, name##ActionP10, (__VA_ARGS__)) 2355*481dde66SAndroid Build Coastguard Worker 2356*481dde66SAndroid Build Coastguard Worker } // namespace testing 2357*481dde66SAndroid Build Coastguard Worker 2358*481dde66SAndroid Build Coastguard Worker GTEST_DISABLE_MSC_WARNINGS_POP_() // 4100 2359*481dde66SAndroid Build Coastguard Worker 2360*481dde66SAndroid Build Coastguard Worker #endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_ACTIONS_H_ 2361