123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659 |
- // Copyright 2007, Google Inc.
- // All rights reserved.
- //
- // Redistribution and use in source and binary forms, with or without
- // modification, are permitted provided that the following conditions are
- // met:
- //
- // * Redistributions of source code must retain the above copyright
- // notice, this list of conditions and the following disclaimer.
- // * Redistributions in binary form must reproduce the above
- // copyright notice, this list of conditions and the following disclaimer
- // in the documentation and/or other materials provided with the
- // distribution.
- // * Neither the name of Google Inc. nor the names of its
- // contributors may be used to endorse or promote products derived from
- // this software without specific prior written permission.
- //
- // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
- // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
- // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
- // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
- // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
- // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
- // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
- // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
- // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
- // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- // Google Mock - a framework for writing C++ mock classes.
- //
- // This file implements some commonly used variadic actions.
- // IWYU pragma: private, include "gmock/gmock.h"
- // IWYU pragma: friend gmock/.*
- #ifndef GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MORE_ACTIONS_H_
- #define GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MORE_ACTIONS_H_
- #include <memory>
- #include <utility>
- #include "gmock/gmock-actions.h"
- #include "gmock/internal/gmock-port.h"
- // Include any custom callback actions added by the local installation.
- #include "gmock/internal/custom/gmock-generated-actions.h"
- // Sometimes you want to give an action explicit template parameters
- // that cannot be inferred from its value parameters. ACTION() and
- // ACTION_P*() don't support that. ACTION_TEMPLATE() remedies that
- // and can be viewed as an extension to ACTION() and ACTION_P*().
- //
- // The syntax:
- //
- // ACTION_TEMPLATE(ActionName,
- // HAS_m_TEMPLATE_PARAMS(kind1, name1, ..., kind_m, name_m),
- // AND_n_VALUE_PARAMS(p1, ..., p_n)) { statements; }
- //
- // defines an action template that takes m explicit template
- // parameters and n value parameters. name_i is the name of the i-th
- // template parameter, and kind_i specifies whether it's a typename,
- // an integral constant, or a template. p_i is the name of the i-th
- // value parameter.
- //
- // Example:
- //
- // // DuplicateArg<k, T>(output) converts the k-th argument of the mock
- // // function to type T and copies it to *output.
- // ACTION_TEMPLATE(DuplicateArg,
- // HAS_2_TEMPLATE_PARAMS(int, k, typename, T),
- // AND_1_VALUE_PARAMS(output)) {
- // *output = T(::std::get<k>(args));
- // }
- // ...
- // int n;
- // EXPECT_CALL(mock, Foo(_, _))
- // .WillOnce(DuplicateArg<1, unsigned char>(&n));
- //
- // To create an instance of an action template, write:
- //
- // ActionName<t1, ..., t_m>(v1, ..., v_n)
- //
- // where the ts are the template arguments and the vs are the value
- // arguments. The value argument types are inferred by the compiler.
- // If you want to explicitly specify the value argument types, you can
- // provide additional template arguments:
- //
- // ActionName<t1, ..., t_m, u1, ..., u_k>(v1, ..., v_n)
- //
- // where u_i is the desired type of v_i.
- //
- // ACTION_TEMPLATE and ACTION/ACTION_P* can be overloaded on the
- // number of value parameters, but not on the number of template
- // parameters. Without the restriction, the meaning of the following
- // is unclear:
- //
- // OverloadedAction<int, bool>(x);
- //
- // Are we using a single-template-parameter action where 'bool' refers
- // to the type of x, or are we using a two-template-parameter action
- // where the compiler is asked to infer the type of x?
- //
- // Implementation notes:
- //
- // GMOCK_INTERNAL_*_HAS_m_TEMPLATE_PARAMS and
- // GMOCK_INTERNAL_*_AND_n_VALUE_PARAMS are internal macros for
- // implementing ACTION_TEMPLATE. The main trick we use is to create
- // new macro invocations when expanding a macro. For example, we have
- //
- // #define ACTION_TEMPLATE(name, template_params, value_params)
- // ... GMOCK_INTERNAL_DECL_##template_params ...
- //
- // which causes ACTION_TEMPLATE(..., HAS_1_TEMPLATE_PARAMS(typename, T), ...)
- // to expand to
- //
- // ... GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS(typename, T) ...
- //
- // Since GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS is a macro, the
- // preprocessor will continue to expand it to
- //
- // ... typename T ...
- //
- // This technique conforms to the C++ standard and is portable. It
- // allows us to implement action templates using O(N) code, where N is
- // the maximum number of template/value parameters supported. Without
- // using it, we'd have to devote O(N^2) amount of code to implement all
- // combinations of m and n.
- // Declares the template parameters.
- #define GMOCK_INTERNAL_DECL_HAS_1_TEMPLATE_PARAMS(kind0, name0) kind0 name0
- #define GMOCK_INTERNAL_DECL_HAS_2_TEMPLATE_PARAMS(kind0, name0, kind1, name1) \
- kind0 name0, kind1 name1
- #define GMOCK_INTERNAL_DECL_HAS_3_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \
- kind2, name2) \
- kind0 name0, kind1 name1, kind2 name2
- #define GMOCK_INTERNAL_DECL_HAS_4_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \
- kind2, name2, kind3, name3) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3
- #define GMOCK_INTERNAL_DECL_HAS_5_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4
- #define GMOCK_INTERNAL_DECL_HAS_6_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \
- kind2, name2, kind3, name3, \
- kind4, name4, kind5, name5) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4, kind5 name5
- #define GMOCK_INTERNAL_DECL_HAS_7_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4, \
- kind5 name5, kind6 name6
- #define GMOCK_INTERNAL_DECL_HAS_8_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6, kind7, name7) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4, \
- kind5 name5, kind6 name6, kind7 name7
- #define GMOCK_INTERNAL_DECL_HAS_9_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6, kind7, name7, kind8, name8) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4, \
- kind5 name5, kind6 name6, kind7 name7, kind8 name8
- #define GMOCK_INTERNAL_DECL_HAS_10_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6, kind7, name7, kind8, name8, kind9, name9) \
- kind0 name0, kind1 name1, kind2 name2, kind3 name3, kind4 name4, \
- kind5 name5, kind6 name6, kind7 name7, kind8 name8, kind9 name9
- // Lists the template parameters.
- #define GMOCK_INTERNAL_LIST_HAS_1_TEMPLATE_PARAMS(kind0, name0) name0
- #define GMOCK_INTERNAL_LIST_HAS_2_TEMPLATE_PARAMS(kind0, name0, kind1, name1) \
- name0, name1
- #define GMOCK_INTERNAL_LIST_HAS_3_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \
- kind2, name2) \
- name0, name1, name2
- #define GMOCK_INTERNAL_LIST_HAS_4_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \
- kind2, name2, kind3, name3) \
- name0, name1, name2, name3
- #define GMOCK_INTERNAL_LIST_HAS_5_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4) \
- name0, name1, name2, name3, name4
- #define GMOCK_INTERNAL_LIST_HAS_6_TEMPLATE_PARAMS(kind0, name0, kind1, name1, \
- kind2, name2, kind3, name3, \
- kind4, name4, kind5, name5) \
- name0, name1, name2, name3, name4, name5
- #define GMOCK_INTERNAL_LIST_HAS_7_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6) \
- name0, name1, name2, name3, name4, name5, name6
- #define GMOCK_INTERNAL_LIST_HAS_8_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6, kind7, name7) \
- name0, name1, name2, name3, name4, name5, name6, name7
- #define GMOCK_INTERNAL_LIST_HAS_9_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6, kind7, name7, kind8, name8) \
- name0, name1, name2, name3, name4, name5, name6, name7, name8
- #define GMOCK_INTERNAL_LIST_HAS_10_TEMPLATE_PARAMS( \
- kind0, name0, kind1, name1, kind2, name2, kind3, name3, kind4, name4, \
- kind5, name5, kind6, name6, kind7, name7, kind8, name8, kind9, name9) \
- name0, name1, name2, name3, name4, name5, name6, name7, name8, name9
- // Declares the types of value parameters.
- #define GMOCK_INTERNAL_DECL_TYPE_AND_0_VALUE_PARAMS()
- #define GMOCK_INTERNAL_DECL_TYPE_AND_1_VALUE_PARAMS(p0) , typename p0##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_2_VALUE_PARAMS(p0, p1) \
- , typename p0##_type, typename p1##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_3_VALUE_PARAMS(p0, p1, p2) \
- , typename p0##_type, typename p1##_type, typename p2##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_4_VALUE_PARAMS(p0, p1, p2, p3) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type, typename p4##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type, typename p4##_type, typename p5##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type, typename p4##_type, typename p5##_type, \
- typename p6##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6, p7) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type, typename p4##_type, typename p5##_type, \
- typename p6##_type, typename p7##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6, p7, p8) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type, typename p4##_type, typename p5##_type, \
- typename p6##_type, typename p7##_type, typename p8##_type
- #define GMOCK_INTERNAL_DECL_TYPE_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6, p7, p8, p9) \
- , typename p0##_type, typename p1##_type, typename p2##_type, \
- typename p3##_type, typename p4##_type, typename p5##_type, \
- typename p6##_type, typename p7##_type, typename p8##_type, \
- typename p9##_type
- // Initializes the value parameters.
- #define GMOCK_INTERNAL_INIT_AND_0_VALUE_PARAMS() ()
- #define GMOCK_INTERNAL_INIT_AND_1_VALUE_PARAMS(p0) \
- (p0##_type gmock_p0) : p0(::std::move(gmock_p0))
- #define GMOCK_INTERNAL_INIT_AND_2_VALUE_PARAMS(p0, p1) \
- (p0##_type gmock_p0, p1##_type gmock_p1) \
- : p0(::std::move(gmock_p0)), p1(::std::move(gmock_p1))
- #define GMOCK_INTERNAL_INIT_AND_3_VALUE_PARAMS(p0, p1, p2) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2))
- #define GMOCK_INTERNAL_INIT_AND_4_VALUE_PARAMS(p0, p1, p2, p3) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3))
- #define GMOCK_INTERNAL_INIT_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3, p4##_type gmock_p4) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3)), \
- p4(::std::move(gmock_p4))
- #define GMOCK_INTERNAL_INIT_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3)), \
- p4(::std::move(gmock_p4)), \
- p5(::std::move(gmock_p5))
- #define GMOCK_INTERNAL_INIT_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \
- p6##_type gmock_p6) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3)), \
- p4(::std::move(gmock_p4)), \
- p5(::std::move(gmock_p5)), \
- p6(::std::move(gmock_p6))
- #define GMOCK_INTERNAL_INIT_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \
- p6##_type gmock_p6, p7##_type gmock_p7) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3)), \
- p4(::std::move(gmock_p4)), \
- p5(::std::move(gmock_p5)), \
- p6(::std::move(gmock_p6)), \
- p7(::std::move(gmock_p7))
- #define GMOCK_INTERNAL_INIT_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, \
- p8) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \
- p6##_type gmock_p6, p7##_type gmock_p7, p8##_type gmock_p8) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3)), \
- p4(::std::move(gmock_p4)), \
- p5(::std::move(gmock_p5)), \
- p6(::std::move(gmock_p6)), \
- p7(::std::move(gmock_p7)), \
- p8(::std::move(gmock_p8))
- #define GMOCK_INTERNAL_INIT_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7, p8, p9) \
- (p0##_type gmock_p0, p1##_type gmock_p1, p2##_type gmock_p2, \
- p3##_type gmock_p3, p4##_type gmock_p4, p5##_type gmock_p5, \
- p6##_type gmock_p6, p7##_type gmock_p7, p8##_type gmock_p8, \
- p9##_type gmock_p9) \
- : p0(::std::move(gmock_p0)), \
- p1(::std::move(gmock_p1)), \
- p2(::std::move(gmock_p2)), \
- p3(::std::move(gmock_p3)), \
- p4(::std::move(gmock_p4)), \
- p5(::std::move(gmock_p5)), \
- p6(::std::move(gmock_p6)), \
- p7(::std::move(gmock_p7)), \
- p8(::std::move(gmock_p8)), \
- p9(::std::move(gmock_p9))
- // Defines the copy constructor
- #define GMOCK_INTERNAL_DEFN_COPY_AND_0_VALUE_PARAMS() \
- {} // Avoid https://gcc.gnu.org/bugzilla/show_bug.cgi?id=82134
- #define GMOCK_INTERNAL_DEFN_COPY_AND_1_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_2_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_3_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_4_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_5_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_6_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_7_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_8_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_9_VALUE_PARAMS(...) = default;
- #define GMOCK_INTERNAL_DEFN_COPY_AND_10_VALUE_PARAMS(...) = default;
- // Declares the fields for storing the value parameters.
- #define GMOCK_INTERNAL_DEFN_AND_0_VALUE_PARAMS()
- #define GMOCK_INTERNAL_DEFN_AND_1_VALUE_PARAMS(p0) p0##_type p0;
- #define GMOCK_INTERNAL_DEFN_AND_2_VALUE_PARAMS(p0, p1) \
- p0##_type p0; \
- p1##_type p1;
- #define GMOCK_INTERNAL_DEFN_AND_3_VALUE_PARAMS(p0, p1, p2) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2;
- #define GMOCK_INTERNAL_DEFN_AND_4_VALUE_PARAMS(p0, p1, p2, p3) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3;
- #define GMOCK_INTERNAL_DEFN_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3; \
- p4##_type p4;
- #define GMOCK_INTERNAL_DEFN_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3; \
- p4##_type p4; \
- p5##_type p5;
- #define GMOCK_INTERNAL_DEFN_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3; \
- p4##_type p4; \
- p5##_type p5; \
- p6##_type p6;
- #define GMOCK_INTERNAL_DEFN_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3; \
- p4##_type p4; \
- p5##_type p5; \
- p6##_type p6; \
- p7##_type p7;
- #define GMOCK_INTERNAL_DEFN_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, \
- p8) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3; \
- p4##_type p4; \
- p5##_type p5; \
- p6##_type p6; \
- p7##_type p7; \
- p8##_type p8;
- #define GMOCK_INTERNAL_DEFN_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7, p8, p9) \
- p0##_type p0; \
- p1##_type p1; \
- p2##_type p2; \
- p3##_type p3; \
- p4##_type p4; \
- p5##_type p5; \
- p6##_type p6; \
- p7##_type p7; \
- p8##_type p8; \
- p9##_type p9;
- // Lists the value parameters.
- #define GMOCK_INTERNAL_LIST_AND_0_VALUE_PARAMS()
- #define GMOCK_INTERNAL_LIST_AND_1_VALUE_PARAMS(p0) p0
- #define GMOCK_INTERNAL_LIST_AND_2_VALUE_PARAMS(p0, p1) p0, p1
- #define GMOCK_INTERNAL_LIST_AND_3_VALUE_PARAMS(p0, p1, p2) p0, p1, p2
- #define GMOCK_INTERNAL_LIST_AND_4_VALUE_PARAMS(p0, p1, p2, p3) p0, p1, p2, p3
- #define GMOCK_INTERNAL_LIST_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) \
- p0, p1, p2, p3, p4
- #define GMOCK_INTERNAL_LIST_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) \
- p0, p1, p2, p3, p4, p5
- #define GMOCK_INTERNAL_LIST_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6) \
- p0, p1, p2, p3, p4, p5, p6
- #define GMOCK_INTERNAL_LIST_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7) \
- p0, p1, p2, p3, p4, p5, p6, p7
- #define GMOCK_INTERNAL_LIST_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, \
- p8) \
- p0, p1, p2, p3, p4, p5, p6, p7, p8
- #define GMOCK_INTERNAL_LIST_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7, p8, p9) \
- p0, p1, p2, p3, p4, p5, p6, p7, p8, p9
- // Lists the value parameter types.
- #define GMOCK_INTERNAL_LIST_TYPE_AND_0_VALUE_PARAMS()
- #define GMOCK_INTERNAL_LIST_TYPE_AND_1_VALUE_PARAMS(p0) , p0##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_2_VALUE_PARAMS(p0, p1) \
- , p0##_type, p1##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_3_VALUE_PARAMS(p0, p1, p2) \
- , p0##_type, p1##_type, p2##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_4_VALUE_PARAMS(p0, p1, p2, p3) \
- , p0##_type, p1##_type, p2##_type, p3##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) \
- , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) \
- , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6) \
- , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type, p6##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6, p7) \
- , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type, \
- p6##_type, p7##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6, p7, p8) \
- , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type, \
- p6##_type, p7##_type, p8##_type
- #define GMOCK_INTERNAL_LIST_TYPE_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, \
- p6, p7, p8, p9) \
- , p0##_type, p1##_type, p2##_type, p3##_type, p4##_type, p5##_type, \
- p6##_type, p7##_type, p8##_type, p9##_type
- // Declares the value parameters.
- #define GMOCK_INTERNAL_DECL_AND_0_VALUE_PARAMS()
- #define GMOCK_INTERNAL_DECL_AND_1_VALUE_PARAMS(p0) p0##_type p0
- #define GMOCK_INTERNAL_DECL_AND_2_VALUE_PARAMS(p0, p1) \
- p0##_type p0, p1##_type p1
- #define GMOCK_INTERNAL_DECL_AND_3_VALUE_PARAMS(p0, p1, p2) \
- p0##_type p0, p1##_type p1, p2##_type p2
- #define GMOCK_INTERNAL_DECL_AND_4_VALUE_PARAMS(p0, p1, p2, p3) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3
- #define GMOCK_INTERNAL_DECL_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4
- #define GMOCK_INTERNAL_DECL_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \
- p5##_type p5
- #define GMOCK_INTERNAL_DECL_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \
- p5##_type p5, p6##_type p6
- #define GMOCK_INTERNAL_DECL_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \
- p5##_type p5, p6##_type p6, p7##_type p7
- #define GMOCK_INTERNAL_DECL_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, p7, \
- p8) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \
- p5##_type p5, p6##_type p6, p7##_type p7, p8##_type p8
- #define GMOCK_INTERNAL_DECL_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7, p8, p9) \
- p0##_type p0, p1##_type p1, p2##_type p2, p3##_type p3, p4##_type p4, \
- p5##_type p5, p6##_type p6, p7##_type p7, p8##_type p8, p9##_type p9
- // The suffix of the class template implementing the action template.
- #define GMOCK_INTERNAL_COUNT_AND_0_VALUE_PARAMS()
- #define GMOCK_INTERNAL_COUNT_AND_1_VALUE_PARAMS(p0) P
- #define GMOCK_INTERNAL_COUNT_AND_2_VALUE_PARAMS(p0, p1) P2
- #define GMOCK_INTERNAL_COUNT_AND_3_VALUE_PARAMS(p0, p1, p2) P3
- #define GMOCK_INTERNAL_COUNT_AND_4_VALUE_PARAMS(p0, p1, p2, p3) P4
- #define GMOCK_INTERNAL_COUNT_AND_5_VALUE_PARAMS(p0, p1, p2, p3, p4) P5
- #define GMOCK_INTERNAL_COUNT_AND_6_VALUE_PARAMS(p0, p1, p2, p3, p4, p5) P6
- #define GMOCK_INTERNAL_COUNT_AND_7_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6) P7
- #define GMOCK_INTERNAL_COUNT_AND_8_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7) \
- P8
- #define GMOCK_INTERNAL_COUNT_AND_9_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7, p8) \
- P9
- #define GMOCK_INTERNAL_COUNT_AND_10_VALUE_PARAMS(p0, p1, p2, p3, p4, p5, p6, \
- p7, p8, p9) \
- P10
- // The name of the class template implementing the action template.
- #define GMOCK_ACTION_CLASS_(name, value_params) \
- GTEST_CONCAT_TOKEN_(name##Action, GMOCK_INTERNAL_COUNT_##value_params)
- #define ACTION_TEMPLATE(name, template_params, value_params) \
- template <GMOCK_INTERNAL_DECL_##template_params \
- GMOCK_INTERNAL_DECL_TYPE_##value_params> \
- class GMOCK_ACTION_CLASS_(name, value_params) { \
- public: \
- explicit GMOCK_ACTION_CLASS_(name, value_params)( \
- GMOCK_INTERNAL_DECL_##value_params) \
- GMOCK_PP_IF(GMOCK_PP_IS_EMPTY(GMOCK_INTERNAL_COUNT_##value_params), \
- = default; \
- , \
- : impl_(std::make_shared<gmock_Impl>( \
- GMOCK_INTERNAL_LIST_##value_params)){}) \
- GMOCK_ACTION_CLASS_(name, value_params)(const GMOCK_ACTION_CLASS_( \
- name, value_params) &) noexcept GMOCK_INTERNAL_DEFN_COPY_ \
- ##value_params \
- GMOCK_ACTION_CLASS_(name, value_params)(GMOCK_ACTION_CLASS_( \
- name, value_params) &&) noexcept GMOCK_INTERNAL_DEFN_COPY_ \
- ##value_params template <typename F> \
- operator ::testing::Action<F>() const { \
- return GMOCK_PP_IF( \
- GMOCK_PP_IS_EMPTY(GMOCK_INTERNAL_COUNT_##value_params), \
- (::testing::internal::MakeAction<F, gmock_Impl>()), \
- (::testing::internal::MakeAction<F>(impl_))); \
- } \
- \
- private: \
- class gmock_Impl { \
- public: \
- explicit gmock_Impl GMOCK_INTERNAL_INIT_##value_params {} \
- template <typename function_type, typename return_type, \
- typename args_type, GMOCK_ACTION_TEMPLATE_ARGS_NAMES_> \
- return_type gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_) const; \
- GMOCK_INTERNAL_DEFN_##value_params \
- }; \
- GMOCK_PP_IF(GMOCK_PP_IS_EMPTY(GMOCK_INTERNAL_COUNT_##value_params), , \
- std::shared_ptr<const gmock_Impl> impl_;) \
- }; \
- template <GMOCK_INTERNAL_DECL_##template_params \
- GMOCK_INTERNAL_DECL_TYPE_##value_params> \
- GMOCK_ACTION_CLASS_( \
- name, value_params)<GMOCK_INTERNAL_LIST_##template_params \
- GMOCK_INTERNAL_LIST_TYPE_##value_params> \
- name(GMOCK_INTERNAL_DECL_##value_params) GTEST_MUST_USE_RESULT_; \
- template <GMOCK_INTERNAL_DECL_##template_params \
- GMOCK_INTERNAL_DECL_TYPE_##value_params> \
- inline GMOCK_ACTION_CLASS_( \
- name, value_params)<GMOCK_INTERNAL_LIST_##template_params \
- GMOCK_INTERNAL_LIST_TYPE_##value_params> \
- name(GMOCK_INTERNAL_DECL_##value_params) { \
- return GMOCK_ACTION_CLASS_( \
- name, value_params)<GMOCK_INTERNAL_LIST_##template_params \
- GMOCK_INTERNAL_LIST_TYPE_##value_params>( \
- GMOCK_INTERNAL_LIST_##value_params); \
- } \
- template <GMOCK_INTERNAL_DECL_##template_params \
- GMOCK_INTERNAL_DECL_TYPE_##value_params> \
- template <typename function_type, typename return_type, typename args_type, \
- GMOCK_ACTION_TEMPLATE_ARGS_NAMES_> \
- return_type GMOCK_ACTION_CLASS_( \
- name, value_params)<GMOCK_INTERNAL_LIST_##template_params \
- GMOCK_INTERNAL_LIST_TYPE_##value_params>:: \
- gmock_Impl::gmock_PerformImpl(GMOCK_ACTION_ARG_TYPES_AND_NAMES_UNUSED_) \
- const
- namespace testing {
- // The ACTION*() macros trigger warning C4100 (unreferenced formal
- // parameter) in MSVC with -W4. Unfortunately they cannot be fixed in
- // the macro definition, as the warnings are generated when the macro
- // is expanded and macro expansion cannot contain #pragma. Therefore
- // we suppress them here.
- GTEST_DISABLE_MSC_WARNINGS_PUSH_(4100)
- namespace internal {
- // internal::InvokeArgument - a helper for InvokeArgument action.
- // The basic overloads are provided here for generic functors.
- // Overloads for other custom-callables are provided in the
- // internal/custom/gmock-generated-actions.h header.
- template <typename F, typename... Args>
- auto InvokeArgument(F &&f,
- Args... args) -> decltype(std::forward<F>(f)(args...)) {
- return std::forward<F>(f)(args...);
- }
- template <std::size_t index, typename... Params>
- struct InvokeArgumentAction {
- template <typename... Args,
- typename = typename std::enable_if<(index < sizeof...(Args))>::type>
- auto operator()(Args &&...args) const -> decltype(internal::InvokeArgument(
- std::get<index>(std::forward_as_tuple(std::forward<Args>(args)...)),
- std::declval<const Params &>()...)) {
- internal::FlatTuple<Args &&...> args_tuple(FlatTupleConstructTag{},
- std::forward<Args>(args)...);
- return params.Apply([&](const Params &...unpacked_params) {
- auto &&callable = std::move(args_tuple.template Get<index>());
- return internal::InvokeArgument(
- std::forward<decltype(callable)>(callable), unpacked_params...);
- });
- }
- internal::FlatTuple<Params...> params;
- };
- } // namespace internal
- // The InvokeArgument<N>(a1, a2, ..., a_k) action invokes the N-th
- // (0-based) argument, which must be a k-ary callable, of the mock
- // function, with arguments a1, a2, ..., a_k.
- //
- // Notes:
- //
- // 1. The arguments are passed by value by default. If you need to
- // pass an argument by reference, wrap it inside std::ref(). For
- // example,
- //
- // InvokeArgument<1>(5, string("Hello"), std::ref(foo))
- //
- // passes 5 and string("Hello") by value, and passes foo by
- // reference.
- //
- // 2. If the callable takes an argument by reference but std::ref() is
- // not used, it will receive the reference to a copy of the value,
- // instead of the original value. For example, when the 0-th
- // argument of the mock function takes a const string&, the action
- //
- // InvokeArgument<0>(string("Hello"))
- //
- // makes a copy of the temporary string("Hello") object and passes a
- // reference of the copy, instead of the original temporary object,
- // to the callable. This makes it easy for a user to define an
- // InvokeArgument action from temporary values and have it performed
- // later.
- template <std::size_t index, typename... Params>
- internal::InvokeArgumentAction<index, typename std::decay<Params>::type...>
- InvokeArgument(Params &&...params) {
- return {internal::FlatTuple<typename std::decay<Params>::type...>(
- internal::FlatTupleConstructTag{}, std::forward<Params>(params)...)};
- }
- GTEST_DISABLE_MSC_WARNINGS_POP_() // 4100
- } // namespace testing
- #endif // GOOGLEMOCK_INCLUDE_GMOCK_GMOCK_MORE_ACTIONS_H_
|